Skip to content

Commit 69c9a11

Browse files
Update README.md
add manual instructions for web client
1 parent f3ab707 commit 69c9a11

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ SimpleWebRTC is a Unity-based WebRTC wrapper that facilitates peer-to-peer audio
1010
- Data channel communication
1111
- Logging and debugging tools
1212
- Usage with Photon Fusion 2
13+
- Usage with [SimpleWebRTC Web Client](https://github.com/FireDragonGameStudio/SimpleWebRTC-Web)
1314

1415
## Tutorial video
1516
A tutorial YouTube video can be found here: [https://www.youtube.com/watch?v=-CwJTgt_Z3M](https://www.youtube.com/watch?v=-CwJTgt_Z3M)
@@ -52,6 +53,15 @@ The `WebRTCConnection` component manages the WebRTC connection and can be attach
5253
3. Use the `_Generic` scripts and `PhotonSignalServer` to setup the WebRTC connection.
5354
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)
5455

56+
### WebRTC Web Client
57+
1. Make sure your WebSocket signaling server is reachable, up and running.
58+
2. Checkout the [SimpleWebRTC Web Client](https://github.com/FireDragonGameStudio/SimpleWebRTC-Web)
59+
3. Run `npm install` in the web client directory, to get everything ready
60+
4. Start the web client either locally (`npm run dev` or `npx vite`) or deploy it to a webspace
61+
5. (Optional) Start your Unity application and make sure the WebRTC logic is up and running.
62+
6. Connect all clients to your WebSocket signaling server and wait until the signaling procedure is completed.
63+
7. Stream your video, audio and/or data to every connected client.
64+
5565
### Public Properties
5666
| Property | Type | Description |
5767
|----------|------|-------------|

0 commit comments

Comments
 (0)