Skip to content

Commit 07c0b01

Browse files
update docs and scripting define for publishing
1 parent 7f5f849 commit 07c0b01

File tree

3 files changed

+33
-5
lines changed

3 files changed

+33
-5
lines changed

Assets/SimpleWebRTC/README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ SimpleWebRTC is a Unity-based WebRTC wrapper that facilitates peer-to-peer audio
77
- WebRTC peer-to-peer connection management
88
- WebSocket-based signaling
99
- Video and audio streaming
10+
- Immersive video streaming (360° monoscopic or stereo over-under)
1011
- Data channel communication
1112
- Logging and debugging tools
1213
- Usage with Photon Fusion 2
@@ -18,7 +19,7 @@ A tutorial YouTube video can be found here: [https://www.youtube.com/watch?v=-Cw
1819

1920
## Simple Installation
2021
1. Make sure, that the required dependencies are installed (`TextMeshPro`, `Unity WebRTC`, `NativeWebSocket`).
21-
2. Go to the Unity AssetStore page: [https://assetstore.unity.com/packages/slug/309727](https://assetstore.unity.com/packages/slug/309727)
22+
2. Go to the Unity AssetStore page: [https://assetstore.unity.com/packages/tools/network/simplewebrtc-309727](https://assetstore.unity.com/packages/tools/network/simplewebrtc-309727)
2223
4. Install the package via Unity AssetStore.
2324

2425
## Installation using the releases page
@@ -34,6 +35,13 @@ A tutorial YouTube video can be found here: [https://www.youtube.com/watch?v=-Cw
3435
5. After the installation finished, click on the + sign in the upper left/right corner again
3536
6. Enter URL `https://github.com/FireDragonGameStudio/SimpleWebRTC.git?path=/Assets/SimpleWebRTC` and click on Install
3637

38+
## Installation using Unity Package Manager with preinstalled Meta Voice SDK package
39+
1. Create a new Unity project
40+
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.
41+
3. Open the Package Manager, click on the + sign in the upper left/right corner
42+
4. Select "Add package from git URL"
43+
5. Enter URL `https://github.com/FireDragonGameStudio/SimpleWebRTC.git?path=/Assets/SimpleWebRTC` and click on Install
44+
3745
## Manual Installation
3846
1. Clone the repository:
3947
```sh
@@ -117,13 +125,15 @@ The `WebRTCConnection` component includes several configurable parameters:
117125
Modify these values in the Unity Inspector or directly in the script.
118126

119127
## Example
120-
Following sample scenes are included in the pacakge:
128+
Following sample scenes are included in the package (available at Samples tab in package manager):
121129
* *WebSocket-TestConnection*: For testing the wecksocket connection separately.
122130
* *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.
123131
* *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#.
124132
* *WebRTC-MultipleClients-STUNConnection*: Shows how multiple clients can be connected via peer-to-peer connections and share data, video and audio transmissions.
125133
* *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.
126134
* *WebRTC-SingleClient-STUNConnection-VisualScripting*: Using Unity Visual Scripting with SimpleWebRTC. Works with all SimpleWebRTC features and can be deployed to clients.
135+
* *WebRTC-SingleClient-STUNConnection-ImmersiveSpectator-Sender*: A simple example for a possible video sender, which can be every 3D application.
136+
* *WebRTC-SingleClient-STUNConnection-ImmersiveSpectator-Receiver*: The receiver sample for the video sender. This will most likely targeted at an XR device.
127137

128138
## Example code
129139
```csharp
@@ -138,6 +148,10 @@ connection.SendDataChannelMessage("Hello Peer!"); // Send a message over the dat
138148
## License
139149
This project is licensed under the MIT License.
140150

151+
## Sponsoring
152+
[![Patreon](https://github.com/user-attachments/assets/b5a0f0c0-1227-4dbe-9f2c-10e8c3e7dd41)](https://www.patreon.com/c/WaveLabs)
153+
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/J3J31EWWJB)
154+
141155
## Contributions
142156
Contributions are welcome! Feel free to submit pull requests or report issues.
143157

Assets/SimpleWebRTC/Runtime/Starter-Documentation.txt

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ SimpleWebRTC is a Unity-based WebRTC wrapper that facilitates peer-to-peer audio
77
- WebRTC peer-to-peer connection management
88
- WebSocket-based signaling
99
- Video and audio streaming
10+
- Immersive video streaming (360° monoscopic or stereo over-under)
1011
- Data channel communication
1112
- Logging and debugging tools
1213
- Usage with Photon Fusion 2
@@ -18,7 +19,7 @@ A tutorial YouTube video can be found here: [https://www.youtube.com/watch?v=-Cw
1819

1920
## Simple Installation
2021
1. Make sure, that the required dependencies are installed (`TextMeshPro`, `Unity WebRTC`, `NativeWebSocket`).
21-
2. Go to the Unity AssetStore page: [https://assetstore.unity.com/packages/slug/309727](https://assetstore.unity.com/packages/slug/309727)
22+
2. Go to the Unity AssetStore page: [https://assetstore.unity.com/packages/tools/network/simplewebrtc-309727](https://assetstore.unity.com/packages/tools/network/simplewebrtc-309727)
2223
4. Install the package via Unity AssetStore.
2324

2425
## Installation using the releases page
@@ -34,6 +35,13 @@ A tutorial YouTube video can be found here: [https://www.youtube.com/watch?v=-Cw
3435
5. After the installation finished, click on the + sign in the upper left/right corner again
3536
6. Enter URL `https://github.com/FireDragonGameStudio/SimpleWebRTC.git?path=/Assets/SimpleWebRTC` and click on Install
3637

38+
## Installation using Unity Package Manager with preinstalled Meta Voice SDK package
39+
1. Create a new Unity project
40+
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.
41+
3. Open the Package Manager, click on the + sign in the upper left/right corner
42+
4. Select "Add package from git URL"
43+
5. Enter URL `https://github.com/FireDragonGameStudio/SimpleWebRTC.git?path=/Assets/SimpleWebRTC` and click on Install
44+
3745
## Manual Installation
3846
1. Clone the repository:
3947
```sh
@@ -117,13 +125,15 @@ The `WebRTCConnection` component includes several configurable parameters:
117125
Modify these values in the Unity Inspector or directly in the script.
118126

119127
## Example
120-
Following sample scenes are included in the pacakge:
128+
Following sample scenes are included in the package (available at Samples tab in package manager):
121129
* *WebSocket-TestConnection*: For testing the wecksocket connection separately.
122130
* *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.
123131
* *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#.
124132
* *WebRTC-MultipleClients-STUNConnection*: Shows how multiple clients can be connected via peer-to-peer connections and share data, video and audio transmissions.
125133
* *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.
126134
* *WebRTC-SingleClient-STUNConnection-VisualScripting*: Using Unity Visual Scripting with SimpleWebRTC. Works with all SimpleWebRTC features and can be deployed to clients.
135+
* *WebRTC-SingleClient-STUNConnection-ImmersiveSpectator-Sender*: A simple example for a possible video sender, which can be every 3D application.
136+
* *WebRTC-SingleClient-STUNConnection-ImmersiveSpectator-Receiver*: The receiver sample for the video sender. This will most likely targeted at an XR device.
127137

128138
## Example code
129139
```csharp
@@ -138,6 +148,10 @@ connection.SendDataChannelMessage("Hello Peer!"); // Send a message over the dat
138148
## License
139149
This project is licensed under the MIT License.
140150

151+
## Sponsoring
152+
[![Patreon](https://github.com/user-attachments/assets/b5a0f0c0-1227-4dbe-9f2c-10e8c3e7dd41)](https://www.patreon.com/c/WaveLabs)
153+
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/J3J31EWWJB)
154+
141155
## Contributions
142156
Contributions are welcome! Feel free to submit pull requests or report issues.
143157

ProjectSettings/ProjectSettings.asset

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -831,7 +831,7 @@ PlayerSettings:
831831
webEnableSubmoduleStrippingCompatibility: 0
832832
scriptingDefineSymbols:
833833
Android:
834-
Standalone:
834+
Standalone: UNITY_ASTOOLS_EXPERIMENTAL
835835
iPhone:
836836
additionalCompilerArguments: {}
837837
platformArchitecture: {}

0 commit comments

Comments
 (0)