From 5c8d9721b2ca0df27f094bb0941b3181fd77eb8f Mon Sep 17 00:00:00 2001 From: Janis Date: Sat, 7 Oct 2023 17:06:25 +0200 Subject: [PATCH] add quick instructions --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 203fb56..555a3b3 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ This overlay uses the [Teamspeak 5 Remote App API](https://github.com/DerTyp7/re - [Teamspeak5-OBS-Overlay](#teamspeak5-obs-overlay) - [Usage](#usage) + - [Quick instructions (online usage only)](#quick-instructions-online-usage-only) + - [Instructions](#instructions) - [Settings (Parameters)](#settings-parameters) - [Are you using the **online** version (recommended version)?](#are-you-using-the-online-version-recommended-version) - [Are you using the **offline** version?](#are-you-using-the-offline-version) @@ -19,6 +21,15 @@ This overlay uses the [Teamspeak 5 Remote App API](https://github.com/DerTyp7/re ## Usage +### Quick instructions (online usage only) + +1. Go into the Teamspeak 5 Settings and enable "Remote Apps" +2. Add a new Browser Source to your OBS Scene and enter `https://dertyp7.github.io/ts5-obs-overlay/` as URL +3. Set the width and height to your desired size (e.g. 1920x1080 OR 1280x720) +4. You should now receive a notification in Teamspeak 5 that the app is allowed to connect to your Teamspeak 5 client. Allow it. + +### Instructions + 1. Go into the Teamspeak 5 Settings and enable "Remote Apps" ![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/b31bc553-fde2-46ab-b07c-d3c81339cc7d)