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. It leverages WebSockets for signaling and supports both video and audio streaming.

Simple Installation

1. Make sure, that the required dependencies are installed (TextMeshPro, Unity WebRTC, NativeWebSocket (https://github.com/endel/NativeWebSocket)).
2. Go to the Unity AssetStore page: https://assetstore.unity.com/packages/slug/309727
3. Install the package via Unity AssetStore.

Installation using the releases page

1. Got to the releases page and download the latest release from https://github.com/FireDragonGameStudio/SimpleWebRTC/releases
2. Make sure, that the required dependencies are installed (TextMeshPro, Unity WebRTC, NativeWebSocket (https://github.com/endel/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#upm and click on Install

Installation using Unity Package Manager with preinstalled Meta Voice SDK package

1. Create a new Unity project
2. The Meta Voice SDK already has the NativeWebSocket package integrated, so there is no need to install it manually. SimpleWebRTC will automatically try to use the NativeWebSocket package provided by Meta.
3. Open the Package Manager, click on the + sign in the upper left/right corner
4. Select "Add package from git URL"
5. Enter URL https://github.com/FireDragonGameStudio/SimpleWebRTC.git?path=/Assets/SimpleWebRTC and click on Install

Manual Installation

1. Clone the repository: git clone https://github.com/FireDragonGameStudio/SimpleWebRTC
2. Open the Unity project in the Unity Editor.
3. Ensure that the required dependencies (such as TextMeshPro, Unity WebRTC and NativeWebSocket) are installed.

Usage of WebRTCConnection Component

The WebRTCConnection component manages the WebRTC connection and can be attached to a GameObject in Unity.

Following sample scenes are included in the pacakge:

* WebSocket-TestConnection: For testing the wecksocket connection separately.
* 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. Works standalone and can be deployed to clients. Make sure to set the LocalPeerId for each client individually.
* WebRTC-SingleClient-STUNConnection-VisualScripting: Using Unity Visual Scripting with SimpleWebRTC. Works with all SimpleWebRTC features and can be deployed to clients.
* WebRTC-SingleClient-STUNConnection-ImmersiveSpectator-Sender: A simple example for a possible video sender, which can be every 3D application.
* WebRTC-SingleClient-STUNConnection-ImmersiveSpectator-Receiver: The receiver sample for the video sender. This will most likely targeted at an XR device.

Photon Fusion 2 Integration

1. Install Photon Fusion 2 from Unity AssetStore -> Photon Fusion 2
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

WebRTC Web Client

1. Make sure your WebSocket signaling server is reachable, up and running.
2. Checkout the SimpleWebRTC Web Client
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.

Support for Unity Visual Scripting

1. Make sure Unity Visual Scripting package is imported.
2. Import SimpleWebRTC Visual Scripting samples.
3. Regenerate Nodes under Edit/Project Settings/Visual Scripting.
4. Mind to add the WebRTCConnectionVisualScriptingEvents component to your WebRTCConnection GameObject.
5. Add your WebRTCConnection GameObject to the scene variables of your graph - look at the sample scene for an example.

Example code

WebRTCConnection connection = gameObject.GetComponent();

connection.Connect(); // Establish WebSocket connection

// after a WebRTC peer-to-peer connection is established
connection.StartVideoTransmission(); // Begin video streaming
connection.SendDataChannelMessage("Hello Peer!"); // Send a message over the data channel

For further information check https://github.com/FireDragonGameStudio/SimpleWebRTC