update starter docs

Author: FireDragonGameStudio

Assets/SimpleWebRTC/README.md

@@ -10,6 +10,7 @@ SimpleWebRTC is a Unity-based WebRTC wrapper that facilitates peer-to-peer audio
 - Data channel communication
 - Logging and debugging tools
 - Usage with Photon Fusion 2
+- Usage with [SimpleWebRTC Web Client](https://github.com/FireDragonGameStudio/SimpleWebRTC-Web)
 
 ## Tutorial video
 A tutorial YouTube video can be found here: [https://www.youtube.com/watch?v=-CwJTgt_Z3M](https://www.youtube.com/watch?v=-CwJTgt_Z3M)
@@ -35,7 +36,7 @@ A tutorial YouTube video can be found here: [https://www.youtube.com/watch?v=-Cw
 ## Manual Installation
 1. Clone the repository:
    ```sh
-   git clone https://github.com/yourusername/simplewebrtc.git
+   git clone https://github.com/firedragongamestudio/simplewebrtc.git
    ```
 2. Open the Unity project in the Unity Editor.
 3. Ensure that the required dependencies (such as `TextMeshPro`, `Unity WebRTC` and `NativeWebSocket`) are installed.
@@ -52,6 +53,15 @@ The `WebRTCConnection` component manages the WebRTC connection and can be attach
 3. Use the `_Generic` scripts and `PhotonSignalServer` to setup the WebRTC connection.
 4. A tutorial/explanation YouTube video can be found here: [https://www.youtube.com/watch?v=z1F_cqfdU6o](https://www.youtube.com/watch?v=z1F_cqfdU6o)
 
+### WebRTC Web Client
+1. Make sure your WebSocket signaling server is reachable, up and running.
+2. Checkout the [SimpleWebRTC Web Client](https://github.com/FireDragonGameStudio/SimpleWebRTC-Web)
+3. Run `npm install` in the web client directory, to get everything ready
+4. Start the web client either locally (`npm run dev` or `npx vite`) or deploy it to a webspace
+5. (Optional) Start your Unity application and make sure the WebRTC logic is up and running.
+6. Connect all clients to your WebSocket signaling server and wait until the signaling procedure is completed.
+7. Stream your video, audio and/or data to every connected client.
+
 ### Public Properties
 | Property | Type | Description |
 |----------|------|-------------|

Assets/SimpleWebRTC/Runtime/Starter-Documentation.txt

@@ -1,3 +1,5 @@
+![simple-webrtc-logo](https://github.com/user-attachments/assets/4a243ff7-8260-4277-8d7a-844f67ffdcff)
+
 # SimpleWebRTC
 SimpleWebRTC is a Unity-based WebRTC wrapper that facilitates peer-to-peer audio, video, and data communication over WebRTC using Unitys WebRTC package [https://docs.unity3d.com/Packages/[email protected]/manual/index.html](https://docs.unity3d.com/Packages/[email protected]/manual/index.html). It leverages NativeWebSocket [https://github.com/endel/NativeWebSocket](https://github.com/endel/NativeWebSocket) for signaling and supports both video and audio streaming.
 
@@ -8,6 +10,7 @@ SimpleWebRTC is a Unity-based WebRTC wrapper that facilitates peer-to-peer audio
 - Data channel communication
 - Logging and debugging tools
 - Usage with Photon Fusion 2
+- Usage with [SimpleWebRTC Web Client](https://github.com/FireDragonGameStudio/SimpleWebRTC-Web)
 
 ## Tutorial video
 A tutorial YouTube video can be found here: [https://www.youtube.com/watch?v=-CwJTgt_Z3M](https://www.youtube.com/watch?v=-CwJTgt_Z3M)
@@ -22,10 +25,18 @@ A tutorial YouTube video can be found here: [https://www.youtube.com/watch?v=-Cw
 2. Make sure, that the required dependencies are installed (`TextMeshPro`, `Unity WebRTC`, `NativeWebSocket`).
 3. Import the package into your Unity project.
 
+## Installation using Unity Package Manager
+1. Create a new Unity project
+2. Open the Package Manager, click on the + sign in the upper left/right corner
+3. Select "Add package from git URL"
+4. Enter URL: `https://github.com/endel/NativeWebSocket.git#upm` and click in Install
+5. After the installation finished, click on the + sign in the upper left/right corner again
+6. Enter URL `https://github.com/FireDragonGameStudio/SimpleWebRTC.git?path=/Assets/SimpleWebRTC` and click on Install
+
 ## Manual Installation
 1. Clone the repository:
    ```sh
-   git clone https://github.com/yourusername/simplewebrtc.git
+   git clone https://github.com/firedragongamestudio/simplewebrtc.git
    ```
 2. Open the Unity project in the Unity Editor.
 3. Ensure that the required dependencies (such as `TextMeshPro`, `Unity WebRTC` and `NativeWebSocket`) are installed.
@@ -34,12 +45,23 @@ A tutorial YouTube video can be found here: [https://www.youtube.com/watch?v=-Cw
 ### WebRTCConnection Component
 The `WebRTCConnection` component manages the WebRTC connection and can be attached to a GameObject in Unity.
 
+![image](https://github.com/user-attachments/assets/e13c49e9-c9dc-4a5c-9200-94efd4800b1c)
+
 ### Photon Fusion 2 Integration
 1. Install Photon Fusion 2 from Unity AssetStore -> [Photon Fusion 2](https://assetstore.unity.com/packages/tools/network/photon-fusion-267958)
 2. Import the Photon Fusion sample scene via Unity Package Manager.
 3. Use the `_Generic` scripts and `PhotonSignalServer` to setup the WebRTC connection.
 4. A tutorial/explanation YouTube video can be found here: [https://www.youtube.com/watch?v=z1F_cqfdU6o](https://www.youtube.com/watch?v=z1F_cqfdU6o)
 
+### WebRTC Web Client
+1. Make sure your WebSocket signaling server is reachable, up and running.
+2. Checkout the [SimpleWebRTC Web Client](https://github.com/FireDragonGameStudio/SimpleWebRTC-Web)
+3. Run `npm install` in the web client directory, to get everything ready
+4. Start the web client either locally (`npm run dev` or `npx vite`) or deploy it to a webspace
+5. (Optional) Start your Unity application and make sure the WebRTC logic is up and running.
+6. Connect all clients to your WebSocket signaling server and wait until the signaling procedure is completed.
+7. Stream your video, audio and/or data to every connected client.
+
 ### Public Properties
 | Property | Type | Description |
 |----------|------|-------------|
@@ -91,6 +113,7 @@ Following sample scenes are included in the pacakge:
 * *WebRTC-SingleClient-STUNConnection*: Testing STUN connection for a single client. Works standalone and can be deployed to clients. Make sure to set the `LocalPeerId` for each client individually.
 * *WebRTC-SingleClient-wLobby-STUNConnection*: A simple Lobby example for handling multiple STUN WebRTC clients. `SimpleLobbyManager.cs` shows an example, how to use **SimpleWebRTC** via C#.
 * *WebRTC-MultipleClients-STUNConnection*: Shows how multiple clients can be connected via peer-to-peer connections and share data, video and audio transmissions.
+* *WebRTC-SingleClient-STUNConnection-PhotonFusion*: Testing STUN connection for a single client using Photon Fusion 2 as signaling server. Works standalone and can be deployed to clients. Make sure to set the `LocalPeerId` for each client individually.
 
 ## Example code
 ```csharp

Packages/packages-lock.json

@@ -16,6 +16,14 @@
       },
       "url": "https://packages.unity.com"
     },
+    "com.unity.asset-store-tools": {
+      "version": "file:com.unity.asset-store-tools",
+      "depth": 0,
+      "source": "embedded",
+      "dependencies": {
+        "com.unity.nuget.newtonsoft-json": "3.2.1"
+      }
+    },
     "com.unity.burst": {
       "version": "1.8.21",
       "depth": 2,
@@ -107,6 +115,13 @@
       "dependencies": {},
       "url": "https://packages.unity.com"
     },
+    "com.unity.nuget.newtonsoft-json": {
+      "version": "3.2.1",
+      "depth": 1,
+      "source": "registry",
+      "dependencies": {},
+      "url": "https://packages.unity.com"
+    },
     "com.unity.render-pipelines.core": {
       "version": "17.1.0",
       "depth": 1,