diff --git a/.eslintrc.cjs b/.eslintrc.cjs deleted file mode 100644 index 4020bcb..0000000 --- a/.eslintrc.cjs +++ /dev/null @@ -1,14 +0,0 @@ -module.exports = { - env: { browser: true, es2020: true }, - extends: [ - 'eslint:recommended', - 'plugin:@typescript-eslint/recommended', - 'plugin:react-hooks/recommended', - ], - parser: '@typescript-eslint/parser', - parserOptions: { ecmaVersion: 'latest', sourceType: 'module' }, - plugins: ['react-refresh'], - rules: { - 'react-refresh/only-export-components': 'warn', - }, -} diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 50917e4..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: Bug report -about: Something isn't working for you -title: '' -labels: bug -assignees: '' - ---- - -> Screenshots are welcome -## Describe the bug -A clear and concise description of what the bug is. - -## To Reproduce -Example or explanation to reproduce the issue. - -## Expected behavior -A clear and concise description of what you expected to happen. - -**Your environment:** - - OS: [e.g. Windows 11] - - OBS version: [e.g. 29.1.3] - - Overlay version [e.g. v1.1.0] diff --git a/.github/dependabot.yml b/.github/dependabot.yml deleted file mode 100644 index be2ad5b..0000000 --- a/.github/dependabot.yml +++ /dev/null @@ -1,10 +0,0 @@ -# To get started with Dependabot version updates, you'll need to specify which -# package ecosystems to update and where the package manifests are located. -# Please see the documentation for all configuration options: -# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates -version: 2 -updates: - - package-ecosystem: "npm" # See documentation for possible values - directory: "/" # Location of package manifests - schedule: - interval: "monthly" diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml deleted file mode 100644 index de50d6a..0000000 --- a/.github/workflows/deploy.yml +++ /dev/null @@ -1,31 +0,0 @@ -name: Deploy to GitHub Pages on Release - -on: - release: - types: - - created - -jobs: - deploy: - runs-on: ubuntu-latest - - steps: - - name: Checkout code - uses: actions/checkout@v2 - - - name: Setup Node.js - uses: actions/setup-node@v2 - with: - node-version: '18' - - - name: Install dependencies - run: npm install - - - name: Build - run: npm run build - - - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v3 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./dist diff --git a/.gitignore b/.gitignore deleted file mode 100644 index a547bf3..0000000 --- a/.gitignore +++ /dev/null @@ -1,24 +0,0 @@ -# Logs -logs -*.log -npm-debug.log* -yarn-debug.log* -yarn-error.log* -pnpm-debug.log* -lerna-debug.log* - -node_modules -dist -dist-ssr -*.local - -# Editor directories and files -.vscode/* -!.vscode/extensions.json -.idea -.DS_Store -*.suo -*.ntvs* -*.njsproj -*.sln -*.sw? diff --git a/src/styles/App.scss b/.nojekyll similarity index 100% rename from src/styles/App.scss rename to .nojekyll diff --git a/.prettierrc b/.prettierrc deleted file mode 100644 index 054d599..0000000 --- a/.prettierrc +++ /dev/null @@ -1,5 +0,0 @@ -{ - "tabWidth": 2, - "useTabs": false, - "printWidth": 120 -} diff --git a/README.md b/README.md deleted file mode 100644 index 950fbcd..0000000 --- a/README.md +++ /dev/null @@ -1,79 +0,0 @@ -# Teamspeak5-OBS-Overlay - -This is an overlay for OBS to show the current talking clients in your Teamspeak 5 Channel. -This App uses the new "Remote Apps" feature of Teamspeak 5. - -This overlay uses the [Teamspeak 5 Remote App API](https://github.com/DerTyp7/react-ts5-remote-app-api). - - - -- [Teamspeak5-OBS-Overlay](#teamspeak5-obs-overlay) - - [Setup](#setup) - - [Customization (Parameters)](#customization-parameters) - - [Setup (Developer)](#setup-developer) - - [Common Issues](#common-issues) - - [The overlay is empty, but i'm connected to a Teamspeak 5 server](#the-overlay-is-empty-but-im-connected-to-a-teamspeak-5-server) - -## Setup - -1. Download the `ts5-overlay-{version}.html` of the latest release from [here](https://github.com/DerTyp7/ts5-obs-overlay/releases/latest) -  - 1.1. (optional) You can rename the file. Just remember using the new file name in the future instead of `ts5-overlay-{version}.html` -2. Go into the Teamspeak 5 Settings and enable "Remote Apps" -  - -3. Add a new Browser Source to your OBS Scene -  -  - -4. Tick the checkbox "Local File" and select the downloaded `ts5-overlay-{version}.html` - 4.1. Set the width and height to your desired size (e.g. 1920x1080 OR 1280x720) -  - -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) -  - -### 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/.../ts5-overlay-{version}.html?parameter1=value1¶meter2=value2` -Real example: `file://C:/Users/.../ts5-overlay-{version}.html?remoteAppPort=5899&hideNonTalking=true&clientLimit=5` - -This is a list of all available parameters (all parameters are optional): - -| Parameter | Description | Type | Default | -| ----------------- | ---------------------------------------- | ------- | --------------- | -| `remoteAppPort` | The port of the Teamspeak 5 remote app | number | `5899` | -| `hideNonTalking` | Hide all non-talking clients | boolean | `false` | -| `clientLimit` | Count of how many client should be shown | number | `0` (unlimited) | -| `showChannelName` | Display the channel name | boolean | `false` | - -## 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 Teamspeak 5 server - -Sadly TeamSpeak5 does not give us any information about the current active server tab. -So we try currently use a workaround, where the active server tab is determined by looking on which server the your hardware input was unmuted the latest, since the non-active server tabs in TS5 usually mute the client’s microphone. - -However this workaround is not 100% accurate and can fail in some cases. - -Possible fixes: - -- Unmute and mute yourself in the active server tab (Just a normal unmute and mute, not the hardware mute) -- Reconnect to the TS5 server while the overlay is open diff --git a/index.html b/index.html index e8f0d21..c906aa8 100644 --- a/index.html +++ b/index.html @@ -4,9 +4,83 @@