mirror of
https://github.com/DerTyp7/teamspeak-obs-overlay.git
synced 2025-10-29 12:52:09 +01:00
Update readme.md
This commit is contained in:
42
readme.md
42
readme.md
@@ -1,19 +1,39 @@
|
||||
# A OBS-Overlay for TeamSpeak5
|
||||

|
||||
|
||||
|
||||
>**_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
|
||||

|
||||
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
|
||||

|
||||
|
||||
## Troubleshooting
|
||||
5. Open your OBS Studio
|
||||
6. Add a new **browser source** to your scene
|
||||

|
||||
|
||||
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)
|
||||

|
||||
|
||||
11. Now connect to a TeamSpeak server and check if it works. You may need to **accept** the remote app in your TeamSpeak notifications.
|
||||

|
||||
|
||||
## 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.
|
||||
|
||||
Reference in New Issue
Block a user