Update readme.md

This commit is contained in:
Janis
2022-10-25 20:36:30 +02:00
committed by GitHub
parent 2e974c60ca
commit 33468da498

View File

@@ -1,19 +1,39 @@
# A OBS-Overlay for TeamSpeak5
![Unbenannt](https://user-images.githubusercontent.com/76851529/197853533-7d97fa33-407b-42b4-9677-18ef7f17ceb5.png)
>**_WARNING:_** This overlay works only if you are connected to **one** server only.
> If you were connected to multiple servers and the overlay crashed, try disconnecting from **all** servers and reconnecting to **only one**.
## Setup
1. Download this project
2. Open your TeamSpeak5 client and go to
1. Download this project optionally as archive
![image](https://user-images.githubusercontent.com/76851529/197848843-4a36593c-0e14-46d4-9b6b-bd17b399a49c.png)
2. Extract the archive and move the folder to where you want it to be
3. Open your TeamSpeak5 client and go to
`settings -> Remote Apps`
3. Enable the "Remote Apps" feature
4. Open your OBS Studio
5. Add a new **browser source** to your scene
6. When your in the properties of your new browser source, enable the checkbox "Local file"
7. Click "Browse" next to the newly apperared "Local file" field
8. Now select the in step 1 downloaded `overlay.html`
9. Set the "Width" to `2000` and the "Height" to `1000` (This is just my own preference. If you have better values use them)
10. Now connect to a TeamSpeak server and see if it works. You may have to accept the remote app in your TeamSpeak notifications.
4. Enable the "Remote Apps" feature
![image](https://user-images.githubusercontent.com/76851529/197849050-d4e28b8e-c150-4462-8871-f77ec672ee49.png)
## Troubleshooting
5. Open your OBS Studio
6. Add a new **browser source** to your scene
![image](https://user-images.githubusercontent.com/76851529/197849644-9396fb9c-4943-4cb2-a511-062ffcd60404.png)
7. In the properties of your new browser source, select the Local File check box.
8. Click "Browse" next to the newly apperared "Local file" field
9. Now select the in step 1 downloaded `overlay.html`
10. Set the "Width" to `2000` and the "Height" to `1000` (This is just my own preference. If you have better values use them)
![image](https://user-images.githubusercontent.com/76851529/197849886-679b200b-6d42-439e-bce6-44c6df67ffcc.png)
11. Now connect to a TeamSpeak server and check if it works. You may need to **accept** the remote app in your TeamSpeak notifications.
![image](https://user-images.githubusercontent.com/76851529/197850151-ad057277-fe3d-427e-b21b-1d2b4875c70b.png)
## Troubleshooting
### Restart the overlay
- **Option 1:**
- Disconnect from all TeamSpeak servers and reconnect to just one.
- **Option 2:**
- Restart TeamSpeak5.
- **Option3:**
1. Open OBS Studio
2. Go open the properties of your browser source
3. On the bottom of the properties press the "Refresh cache of current page" button.