improve unity release

Author: endel

.github/workflows/unity-upm-release.yml

@@ -43,9 +43,10 @@ jobs:
           cp src/NativeWebSocket/IWebSocket.cs upm-package/WebSocket/
           cp src/NativeWebSocket/WebSocketTypes.cs upm-package/WebSocket/
 
-          # Unity-specific files (WebSocket.cs has #if !UNITY_WEBGL guard,
-          # WebSocketWebGL.cs + WebSocketFactoryWebGL.cs have #if UNITY_WEBGL guard)
-          cp integrations/Unity/WebSocket.cs upm-package/WebSocket/
+          # Wrap core WebSocket.cs with Unity conditional compilation guard
+          { echo '#if !UNITY_WEBGL || UNITY_EDITOR'; echo ''; cat src/NativeWebSocket/WebSocket.cs; echo ''; echo '#endif'; } > upm-package/WebSocket/WebSocket.cs
+
+          # Unity-specific files (WebGL platform support)
           cp integrations/Unity/WebSocketWebGL.cs upm-package/WebSocket/
           cp integrations/Unity/WebSocketFactoryWebGL.cs upm-package/WebSocket/
           cp integrations/Unity/WebSocket.jslib upm-package/WebSocket/
@@ -81,8 +82,10 @@ jobs:
         cp src/NativeWebSocket/IWebSocket.cs upm-package/Assets/WebSocket/
         cp src/NativeWebSocket/WebSocketTypes.cs upm-package/Assets/WebSocket/
 
+        # Wrap core WebSocket.cs with Unity conditional compilation guard
+        { echo '#if !UNITY_WEBGL || UNITY_EDITOR'; echo ''; cat src/NativeWebSocket/WebSocket.cs; echo ''; echo '#endif'; } > upm-package/Assets/WebSocket/WebSocket.cs
+
         # Unity-specific files
-        cp integrations/Unity/WebSocket.cs upm-package/Assets/WebSocket/
         cp integrations/Unity/WebSocketWebGL.cs upm-package/Assets/WebSocket/
         cp integrations/Unity/WebSocketFactoryWebGL.cs upm-package/Assets/WebSocket/
         cp integrations/Unity/WebSocket.jslib upm-package/Assets/WebSocket/

README.md

@@ -16,15 +16,20 @@ Used in [Colyseus Unity SDK](https://github.com/colyseus/colyseus-unity-sdk).
 
 *Requires Unity 2019.1+ with .NET 4.x+ Runtime*
 
+> **Note:** Do not copy the raw source files from this repository directly into
+> your Unity project. The core `WebSocket.cs` requires a build-time
+> transformation to add WebGL conditional compilation guards. Use one of the
+> install methods below instead.
+
 **Via UPM (Unity Package Manager):**
 1. Open Unity
 2. Open Package Manager Window
 3. Click Add Package From Git URL
-4. Enter URL: `https://github.com/endel/NativeWebSocket.git#upm`
+4. Enter URL: `https://github.com/endel/NativeWebSocket.git#upm-2.0`
 
-**Manually:**
-1. [Download this project](https://github.com/endel/NativeWebSocket/archive/master.zip)
-2. Copy the sources from `NativeWebSocket/Assets/WebSocket` into your `Assets` directory.
+**Via .unitypackage:**
+1. Download `NativeWebSocket.unitypackage` from the [Releases](https://github.com/endel/NativeWebSocket/releases) page
+2. In Unity, go to Assets > Import Package > Custom Package and select the downloaded file
 
 ## MonoGame / .NET
 
@@ -60,6 +65,8 @@ public class Connection : MonoBehaviour
 
     async void Start()
     {
+        Application.runInBackground = true; // Recommended for WebGL
+
         websocket = new WebSocket("ws://localhost:3000");
 
         websocket.OnOpen += () => Debug.Log("Connection open!");
@@ -93,6 +100,11 @@ public class Connection : MonoBehaviour
 }
 ```
 
+**WebGL note:** Unity pauses the game loop when the browser tab loses focus, which
+stops all WebSocket send/receive callbacks. To keep the connection active in the
+background, set `Application.runInBackground = true` in your script or enable
+**Run In Background** in Player Settings > Resolution and Presentation.
+
 ## MonoGame
 
 Add the `WebSocketGameComponent` to your game. This installs a

examples/Unity/Connection.cs

@@ -25,6 +25,8 @@ public class Connection : MonoBehaviour
 
     async void Start()
     {
+        Application.runInBackground = true;
+
         websocket = new WebSocket("ws://localhost:3000");
 
         websocket.OnOpen += () =>