diff --git a/README.md b/README.md index 434f09e..46e30a5 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,9 @@ This App uses the new "Remote Apps" feature of Teamspeak 5. ![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/d0ab06f2-1a36-479d-826f-bd4bd3d405b7) - - - [Teamspeak5-OBS-Overlay](#teamspeak5-obs-overlay) - [Setup](#setup) + - [Customization (Parameters)](#customization-parameters) - [Setup (Developer)](#setup-developer) ## Setup @@ -19,15 +18,36 @@ This App uses the new "Remote Apps" feature of Teamspeak 5. ![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/b31bc553-fde2-46ab-b07c-d3c81339cc7d) 3. Add a new Browser Source to your OBS Scene - ![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/0198b468-bb96-4b65-bdd4-3d6bb3ef7d25) - ![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/58ad399f-5344-456f-b243-6e267b489fd5) + ![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/0198b468-bb96-4b65-bdd4-3d6bb3ef7d25) + ![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/58ad399f-5344-456f-b243-6e267b489fd5) 4. Tick the checkbox "Local File" and select the downloaded `index.html` - 4.1. Set the width and height to your desired size (e.g. 1920x1080 OR 1280x720) + 4.1. Set the width and height to your desired size (e.g. 1920x1080 OR 1280x720) ![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/5ad8ce69-645b-45e7-acc3-ce7ba8d7f8ab) 5. You should now receive a notification in Teamspeak 5 that the app is allowed to connect to your Teamspeak 5 client. Allow it. (If you don't get a notification, restart Teamspeak 5 and OBS -> try again) -![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/40faa435-e128-415f-98eb-a9e8809e8f65) + ![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/40faa435-e128-415f-98eb-a9e8809e8f65) + +### Customization (Parameters) + +You can customize the overlay by adding parameters to the URL of the Browser Source. + +1. Open your Browser Source settings +2. **Untick** the checkbox "Local File" +3. Add `file://` to the beginning of the URL +4. Start adding parameters like discribed below + +Start by adding a `?` to the end of the URL and then add the parameters. +To add multiple parameters, you have to seperate them with a `&`. + +Like this: `file://C:/Users/.../index.html?parameter1=value1¶meter2=value2` +Real example: `file://C:/Users/.../index.html?remoteAppPort=5899` + +This is a list of all available parameters (all parameters are optional): + +| Parameter | Description | Default | +| --------------- | -------------------------------------- | ------- | +| `remoteAppPort` | The port of the Teamspeak 5 remote app | `5899` | ## Setup (Developer)