diff --git a/README.md b/README.md index 4981403..cc5e403 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,10 @@ This overlay uses the [TeamSpeak5 Remote App API](https://github.com/DerTyp7/rea - [Usage](#usage) - [Quick instructions](#quick-instructions) - [Detailed instructions](#detailed-instructions) - - [Setup (Developer)](#setup-developer) - [Common Issues](#common-issues) - [The overlay is empty, but i'm connected to a TeamSpeak5 server](#the-overlay-is-empty-but-im-connected-to-a-teamspeak5-server) - [OBS doesn't show the latest version of the overlay](#obs-doesnt-show-the-latest-version-of-the-overlay) + - [Setup (Developer)](#setup-developer) ## Usage @@ -41,19 +41,13 @@ Try this instruction if you have problems with the quick instructions above. ![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/58ad399f-5344-456f-b243-6e267b489fd5) 5. Enter the in step 1 generated URL into the URL field of the Browser Source -![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/50b755f9-d4b4-469f-9136-e2b18f226547) + ![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/50b755f9-d4b4-469f-9136-e2b18f226547) 6. Set the width and height to your desired size. Recommended is a ratio of 1:1 or 1:2 (e.g. 1500x3000 OR 1000x2000) 7. You should now receive a notification in TeamSpeak5 that the app is allowed to connect to your TeamSpeak5 client. Allow it. (If you don't get a notification, restart TeamSpeak5 and OBS -> try again) ![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/40faa435-e128-415f-98eb-a9e8809e8f65) -## Setup (Developer) - -1. Clone this repository -2. Run `npm install` -3. To start the development server run `npm run dev` - ## Common Issues ### The overlay is empty, but i'm connected to a TeamSpeak5 server @@ -76,3 +70,13 @@ Possible fixes: This can happen if the OBS Browser Source is caching the overlay. To fix this, open the Browser Source settings and click on "Refresh cache of current page". + +## Setup (Developer) + +1. Clone this repository +2. Run `npm install` +3. To start the development server run `npm run dev` + +> **Note:** Pull requests are welcome, but please be consistent with the code style. +> This project uses [Prettier](https://prettier.io/) to format the code. +> Pull requests always in the `dev` branch.