Merge pull request #88 from DerTyp7/dev

Implement generator to simplify customization

.eslintrc.cjs

@@ -1,14 +1,11 @@
 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'],
+  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',
+    "react-refresh/only-export-components": "warn",
+    "react-hooks/exhaustive-deps": "ignore",
   },
-}
+};

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+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.
+
+**Do you use the local or online version?**
+- [x] Online version with URL: `https://dertyp7.github.io/ts5-obs-overlay`
+- [ ] The version named below locally downloaded on my device
+
+**Your environment:**
+ - OS: [e.g. Windows 11]
+ - OBS version: [e.g. 29.1.3]
+ - Overlay version [e.g. v1.1.0]

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# 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"
+    target-branch: "dev"

.github/workflows/deploy.yml

@@ -0,0 +1,31 @@
+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.9.3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./dist

.prettierrc

@@ -1,5 +1,7 @@
 {
   "tabWidth": 2,
   "useTabs": false,
-  "printWidth": 120
+  "printWidth": 180,
+  "singleQuote": false,
+  "semi": true
 }

README.md

@@ -1,61 +1,82 @@
-# Teamspeak5-OBS-Overlay
+# TeamSpeak5-OBS-Overlay
 
-This is a 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 is an overlay for OBS to show the current talking clients in your TeamSpeak5 Channel.  
+This App uses the new "Remote Apps" feature of TeamSpeak5.
 
-![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/d0ab06f2-1a36-479d-826f-bd4bd3d405b7)
+This overlay uses the [TeamSpeak5 Remote App API](https://github.com/DerTyp7/react-ts5-remote-app-api).
 
-- [Teamspeak5-OBS-Overlay](#teamspeak5-obs-overlay)
-  - [Setup](#setup)
-    - [Customization (Parameters)](#customization-parameters)
+![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/d0ab06f2-1a36-479d-826f-bd4bd3d405b7)
+
+- [TeamSpeak5-OBS-Overlay](#teamspeak5-obs-overlay)
+  - [Usage](#usage)
+    - [Quick instructions](#quick-instructions)
+    - [Detailed instructions](#detailed-instructions)
+  - [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)
 
-## Setup
+## Usage
 
-1. Download the `index.html` of the latest release from [here](https://github.com/DerTyp876/ts5-obs-overlay/releases/tag/v1.0.0)
-   ![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/04dc3a66-c493-429b-b4ae-44bade473ad6)  
-   1.1. (optional) You can rename the file. Just remember using the new file name in the future instead of `index.html`
-2. Go into the Teamspeak 5 Settings and enable "Remote Apps"  
-   ![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/b31bc553-fde2-46ab-b07c-d3c81339cc7d)
+### Quick instructions
 
-3. Add a new Browser Source to your OBS Scene  
-   ![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/0198b468-bb96-4b65-bdd4-3d6bb3ef7d25)  
-   ![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/58ad399f-5344-456f-b243-6e267b489fd5)
+1. Open this link in your Browser: [https://dertyp7.github.io/ts5-obs-overlay/generate](https://dertyp7.github.io/ts5-obs-overlay/generate)
+2. Follow the instructions on the website
+3. Accept overlay inside TeamSpeak5  
+   ![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/40faa435-e128-415f-98eb-a9e8809e8f65)
 
-4. Tick the checkbox "Local File" and select the downloaded `index.html`  
-    4.1. Set the width and height to your desired size (e.g. 1920x1080 OR 1280x720)  
-   ![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/5ad8ce69-645b-45e7-acc3-ce7ba8d7f8ab)
+### Detailed instructions
 
-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)  
-   ![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/40faa435-e128-415f-98eb-a9e8809e8f65)
+Try this instruction if you have problems with the quick instructions above.
 
-### Customization (Parameters)
+1. Open this link in your Browser: [https://dertyp7.github.io/ts5-obs-overlay/generate](https://dertyp7.github.io/ts5-obs-overlay/generate)
 
-You can customize the overlay by adding parameters to the URL of the Browser Source.
+2. Follow the instructions on the website
 
-1. Open your Browser Source settings
-2. **Untick** the checkbox "Local File"
-3. Add `file://` to the beginning of the URL  
-   ![image](https://github.com/DerTyp876/ts5-obs-overlay/assets/76851529/87985b4c-4397-4681-9635-239d1e382c24)
-4. Start adding parameters like discribed below
+3. Go into the TeamSpeak5 Settings and enable "Remote Apps"  
+   ![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/b31bc553-fde2-46ab-b07c-d3c81339cc7d)
 
-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 `&`.
+4. Add a new Browser Source to your OBS Scene  
+   ![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/0198b468-bb96-4b65-bdd4-3d6bb3ef7d25)  
+   ![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/58ad399f-5344-456f-b243-6e267b489fd5)
 
-Like this: `file://C:/Users/.../index.html?parameter1=value1&parameter2=value2`  
-Real example: `file://C:/Users/.../index.html?remoteAppPort=5899&hideNonTalking=true&clientLimit=5`
+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)
 
-This is a list of all available parameters (all parameters are optional):
+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)
 
-| 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`         |
+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)
+
+## Common Issues
+
+### The overlay is empty, but i'm connected to a TeamSpeak5 server
+
+**Fix 1**  
+Make sure you accepted the notification in your TeamSpeak Client.
+
+**Fix 2**  
+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
+
+### OBS doesn't show the latest version of the overlay
+
+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.

index.html

@@ -1,12 +1,17 @@
 <!DOCTYPE html>
 <html lang="en">
-	<head>
-		<meta charset="UTF-8" />
-		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
-		<title>TS5-OBS-Overlay</title>
-	</head>
-	<body>
-		<div id="root"></div>
-		<script type="module" src="/src/main.tsx"></script>
-	</body>
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta
+      name="description"
+      content="An OBS overlay for TeamSpeak5, so your audience can see who is talking. https://github.com/DerTyp7/ts5-obs-overlay"
+    />
+    <meta name="author" content="DerTyp7" />
+    <title>TS5-OBS-Overlay</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
 </html>

package.json

@@ -1,7 +1,27 @@
 {
   "name": "ts5-obs-overlay",
-  "private": true,
-  "version": "0.0.0",
+  "private": false,
+  "version": "2.0.0",
+  "description": "Overlay for OBS to show the current talking clients in your Teamspeak 5 Channel",
+  "author": "DerTyp7",
+  "homepage": "https://dertyp7.github.io/ts5-obs-overlay",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DerTyp7/ts5-obs-overlay"
+  },
+  "keywords": [
+    "ts5",
+    "teamspeak",
+    "overlay",
+    "remote app",
+    "obs",
+    "typescript",
+    "react",
+    "vite"
+  ],
+  "bugs": {
+    "url": "https://github.com/DerTyp7/ts5-obs-overlay/issues"
+  },
   "type": "module",
   "scripts": {
     "dev": "vite",
@@ -10,25 +30,24 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@types/node": "^20.3.2",
-    "jest": "^29.5.0",
+    "@types/node": "^20.8.3",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "react-router-dom": "^6.14.0",
-    "sass": "^1.62.1"
+    "react-router-dom": "^6.18.0",
+    "react-ts5-remote-app-api": "^1.1.1",
+    "sass": "^1.68.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.2",
-    "@types/react": "^18.0.37",
-    "@types/react-dom": "^18.0.11",
-    "@typescript-eslint/eslint-plugin": "^5.59.0",
-    "@typescript-eslint/parser": "^5.59.0",
+    "@types/react": "^18.2.35",
+    "@types/react-dom": "^18.2.14",
+    "@typescript-eslint/eslint-plugin": "^6.7.4",
+    "@typescript-eslint/parser": "^6.9.1",
     "@vitejs/plugin-react-swc": "^3.0.0",
-    "eslint": "^8.38.0",
+    "eslint": "^8.53.0",
     "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-react-refresh": "^0.3.4",
-    "typescript": "^5.0.2",
-    "vite": "^4.3.9",
-    "vite-plugin-singlefile": "^0.13.5"
+    "eslint-plugin-react-refresh": "^0.4.3",
+    "typescript": "^5.2.2",
+    "vite": "^4.5.0"
   }
 }

src/App.tsx

@@ -1,73 +1,27 @@
-/* eslint-disable react-hooks/exhaustive-deps */
 import "@styles/App.scss";
-import { IChannel, IClient, IConnection, ITS5ConnectionHandler } from "@interfaces/teamspeak";
-import { useEffect, useState } from "react";
+
+import { Navigate, Route, Routes, useSearchParams } from "react-router-dom";
 import Viewer from "./Viewer";
-import { useSearchParams } from "react-router-dom";
-import { TS5ConnectionHandler } from "@handlers/teamspeak/connectionHandler";
+import Generator from "./Generator";
 
 export default function App() {
   const [searchParams] = useSearchParams();
 
-  const [clients, setClients] = useState<IClient[]>([]);
-  const [channels, setChannels] = useState<IChannel[]>([]);
-  const [connections, setConnections] = useState<IConnection[]>([]);
-  const [activeConnectionId, setActiveConnectionId] = useState<number>(1);
-
-  const [currentConnection, setCurrentConnection] = useState<IConnection | undefined>(undefined);
-  const [currentChannel, setCurrentChannel] = useState<IChannel | undefined>(undefined);
-  const [currentClient, setCurrentClient] = useState<IClient | undefined>(undefined);
-
-  function setCurrentStates() {
-    const currentConnection = connections.find((connection) => connection.id === activeConnectionId);
-    setCurrentConnection(currentConnection);
-
-    if (currentConnection) {
-      const currentClient = clients.find((client) => client.id === currentConnection.clientId);
-      setCurrentClient(currentClient);
-      if (currentClient) {
-        const currentChannel = channels.find((channel) => channel.id === currentClient.channel?.id);
-        setCurrentChannel(currentChannel);
-        if (currentChannel) {
-          return currentChannel;
-        }
-      }
-    }
-  }
-
-  useEffect(() => {
-    const remoteAppPort = searchParams.get("remoteAppPort");
-
-    console.log(searchParams.get("hideNonTalking"));
-    const tsConnection: ITS5ConnectionHandler = new TS5ConnectionHandler(
-      parseInt(remoteAppPort ?? "5899"),
-      setConnections,
-      setChannels,
-      setClients,
-      setActiveConnectionId
-    );
-    tsConnection.connect();
-  }, []);
-
-  useEffect(() => {
-    setCurrentStates();
-  }, [clients, channels, connections, activeConnectionId]);
-
   return (
-    <div className="App">
-      <Viewer
-        showChannelName={searchParams.get("showChannelName") === "true"}
-        hideNonTalking={searchParams.get("hideNonTalking") === "true"}
-        clientLimit={searchParams.get("clientLimit") ? parseInt(searchParams.get("clientLimit") ?? "0") : 0}
-        clients={
-          clients.map((client) => {
-            if (client.channel?.id === currentChannel?.id && client.channel.connection.id === activeConnectionId) {
-              return client;
-            }
-          }) as IClient[]
+    <Routes>
+      <Route
+        path="/"
+        element={
+          <Viewer
+            remoteAppPort={parseInt(searchParams.get("remoteAppPort") ?? "5899")}
+            showChannelName={searchParams.get("showChannelName") === "true"}
+            hideNonTalking={searchParams.get("hideNonTalking") === "true"}
+            clientLimit={searchParams.get("clientLimit") ? parseInt(searchParams.get("clientLimit") ?? "0") : 0}
+          />
         }
-        channel={currentChannel}
       />
-    </div>
+      <Route path="/generate" element={<Generator />} />
+      <Route path="*" element={<Navigate to="/generate" replace />} />
+    </Routes>
   );
 }

src/Generator.tsx

@@ -0,0 +1,122 @@
+import React, { ChangeEvent, useRef, useState, useEffect } from "react";
+import "@styles/Generator.scss";
+import Viewer from "./Viewer";
+
+export default function Generator() {
+  // State variables
+  const [outputUrl, setOutputUrl] = useState(() => new URL(window.location.href).toString());
+  const copiedTooltipRef = useRef<HTMLDivElement>(null);
+
+  const [remoteAppPort, setRemoteAppPort] = useState(5899);
+  const [showChannelName, setShowChannelName] = useState(true);
+  const [hideNonTalking, setHideNonTalking] = useState(false);
+  const [clientLimit, setClientLimit] = useState(0);
+
+  // Effect to generate URL when dependencies change
+  useEffect(() => {
+    generateUrl();
+  }, [remoteAppPort, showChannelName, hideNonTalking, clientLimit]);
+
+  // Function to generate the output URL
+  function generateUrl() {
+    const url = new URL(window.location.href.replace("/generate", ""));
+    url.searchParams.set("remoteAppPort", remoteAppPort.toString());
+    url.searchParams.set("showChannelName", showChannelName.toString());
+    url.searchParams.set("hideNonTalking", hideNonTalking.toString());
+    url.searchParams.set("clientLimit", clientLimit.toString());
+
+    setOutputUrl(url.toString());
+  }
+
+  // Function to copy URL to clipboard
+  function copy() {
+    navigator.clipboard.writeText(outputUrl);
+
+    if (copiedTooltipRef.current) {
+      copiedTooltipRef.current.style.animation = "tooltipAnimation 200ms";
+      copiedTooltipRef.current.style.opacity = "1";
+
+      setTimeout(() => {
+        if (copiedTooltipRef.current) {
+          copiedTooltipRef.current.style.opacity = "0";
+          copiedTooltipRef.current.style.animation = "";
+        }
+      }, 1000);
+    }
+  }
+
+  return (
+    <div className="generator">
+      {/* Header */}
+      <div className="headline">
+        <h1>TS5-OBS-Overlay Generator</h1>
+        <h4>by DerTyp7</h4>
+      </div>
+
+      {/* Instructions */}
+      <div className="instructions">
+        <p>1. Customize your settings</p>
+        <p>2. Copy the generated URL</p>
+        <p>3. Paste the URL into the BrowserSource URL field in OBS</p>
+        <a href="#">Click here for detailed instructions</a>
+      </div>
+
+      {/* Output Section */}
+      <div className="output">
+        <p className="url">
+          <code>{outputUrl}</code>
+        </p>
+        <button onClick={copy} className="copy">
+          Copy
+        </button>
+        <div ref={copiedTooltipRef} className="copiedTooltip">
+          Copied!
+        </div>
+      </div>
+
+      {/* Generator Content */}
+      <div className="generatorContent">
+        {/* Configurations */}
+        <div className="configurations">
+          <h2>Configurations</h2>
+
+          <div className="options">
+            {/* Option Sections */}
+            <section>
+              {/* Show Channel Name Option */}
+              <div className="option" onClick={() => setShowChannelName(!showChannelName)}>
+                <input type="checkbox" checked={showChannelName} />
+                <label>Show channel name</label>
+              </div>
+
+              {/* Hide Non-Talking Clients Option */}
+              <div className="option" onClick={() => setHideNonTalking(!hideNonTalking)}>
+                <input type="checkbox" checked={hideNonTalking} />
+                <label>Hide non talking clients</label>
+              </div>
+            </section>
+
+            <section>
+              {/* Client Limit Option */}
+              <div className="option">
+                <input type="number" value={clientLimit} min={0} onChange={(e: ChangeEvent<HTMLInputElement>) => setClientLimit(parseInt(e.target.value))} />
+                <label>Client Limit</label>
+              </div>
+
+              {/* RemoteApp-Port Option */}
+              <div className="option">
+                <input type="number" value={remoteAppPort} min={0} onChange={(e: ChangeEvent<HTMLInputElement>) => setRemoteAppPort(parseInt(e.target.value))} />
+                <label>RemoteApp-Port</label>
+              </div>
+            </section>
+          </div>
+        </div>
+
+        {/* Preview */}
+        <div className="preview">
+          <Viewer remoteAppPort={remoteAppPort} showChannelName={showChannelName} hideNonTalking={hideNonTalking} clientLimit={clientLimit} />
+        </div>
+      </div>
+    </div>
+  );
+}

src/Viewer.tsx

@@ -1,27 +1,42 @@
-import { IChannel, IClient } from "@interfaces/teamspeak";
 import "@styles/Viewer.scss";
+import useTSRemoteApp, { IClient } from "react-ts5-remote-app-api";
 
 export default function Viewer({
-  clients,
-  channel,
+  remoteAppPort = 5899,
   showChannelName = false,
   hideNonTalking = false,
   clientLimit = 0,
 }: {
-  clients: IClient[] | undefined;
-  channel: IChannel | undefined;
+  remoteAppPort?: number;
   showChannelName?: boolean;
   hideNonTalking?: boolean;
   clientLimit?: number;
 }) {
+  const { clients, activeConnectionId, currentChannel } = useTSRemoteApp({
+    remoteAppPort: remoteAppPort,
+    auth: {
+      identifier: "de.tealfire.obs",
+      version: "2.0.0",
+      name: "TS5 OBS Overlay",
+      description: "A OBS overlay for TS5 by DerTyp7",
+    },
+    logging: true,
+  });
+
+  const currentClients = clients.map((client) => {
+    if (client.channel?.id === currentChannel?.id && client.channel.connection.id === activeConnectionId) {
+      return client;
+    }
+  }) as IClient[];
+
   return (
     <div className="viewer">
       {showChannelName ? (
         <div className="channelNameContainer">
-          <h3>{channel?.properties.name}</h3>
+          <h1>{currentChannel?.properties.name}</h1>
         </div>
       ) : null}
-      {clients?.map((client, i) => {
+      {currentClients?.map((client, i) => {
         //* Client limit
         if (clientLimit != 0 && i >= clientLimit) {
           return null;
@@ -29,10 +44,7 @@ export default function Viewer({
 
         if (client) {
           //* Non-talking client
-          if (
-            hideNonTalking &&
-            (client.properties.inputMuted || client.properties.outputMuted || client.talkStatus == 0)
-          ) {
+          if (hideNonTalking && (client.properties.inputMuted || client.properties.outputMuted || client.talkStatus == 0)) {
             return null;
           }
 
@@ -73,16 +85,7 @@ export default function Viewer({
                       d="M88.62,54.15V64A24.69,24.69,0,0,1,64,88.62a25.26,25.26,0,0,1-8.38-1.46l-7.39,7.39A34,34,0,0,0,64,98.46,34.5,34.5,0,0,0,98.46,64V54.15a4.92,4.92,0,1,1,9.85,0V64a44.31,44.31,0,0,1-39.38,44v10.15H88.62a4.92,4.92,0,0,1,0,9.85H39.38a4.92,4.92,0,1,1,0-9.85H59.08V108A43.3,43.3,0,0,1,41,101.77L21.46,121.31a2.46,2.46,0,0,1-3.54,0L11.62,115a2.46,2.46,0,0,1,0-3.54l94.92-94.92a2.46,2.46,0,0,1,3.54,0l6.31,6.31a2.46,2.46,0,0,1,0,3.54ZM22.92,80.46A43.3,43.3,0,0,1,19.69,64V54.15a4.92,4.92,0,1,1,9.85,0V64a35.94,35.94,0,0,0,1.15,8.69ZM39.38,64V24.62a24.62,24.62,0,0,1,47.77-8.38Z"
                       fill="#d8d8d8"
                     />
-                    <rect
-                      x="-5.93"
-                      y="61.89"
-                      width="139.87"
-                      height="14.02"
-                      rx="2.87"
-                      ry="2.87"
-                      transform="translate(-29.97 65.43) rotate(-45)"
-                      fill="#c9070a"
-                    />
+                    <rect x="-5.93" y="61.89" width="139.87" height="14.02" rx="2.87" ry="2.87" transform="translate(-29.97 65.43) rotate(-45)" fill="#c9070a" />
                   </g>
                 </svg>
               ) : client.properties.outputMuted ? (

src/handlers/teamspeak/connectionHandler.ts

@@ -1,132 +0,0 @@
-import { IAuthSenderPayload, IChannel, IClient, IConnection, ITS5ConnectionHandler, ITS5DataHandler, ITS5MessageHandler } from "@interfaces/teamspeak";
-import { TS5DataHandler } from "./dataHandler";
-import { TS5MessageHandler } from "./messageHandler";
-import Logger from "@/utils/logger";
-
-
-// Establish connection to TS5 client
-// Main class
-export class TS5ConnectionHandler implements ITS5ConnectionHandler {
-  ws: WebSocket; // Websocket connection to TS5 client
-  authenticated = false; // Is the connection authenticated?
-  remoteAppPort: number; // Port of TS5 client
-  dataHandler: ITS5DataHandler; // Handles data/lists and states
-  messageHandler: ITS5MessageHandler; // Handles messages received from TS5 client
-
-  constructor(
-    // Port of TS5 client
-    remoteAppPort: number,
-
-    // State setters for dataHandler
-    setConnections: React.Dispatch<React.SetStateAction<IConnection[]>>,
-    setChannels: React.Dispatch<React.SetStateAction<IChannel[]>>,
-    setClients: React.Dispatch<React.SetStateAction<IClient[]>>,
-    setActiveConnectionStateId: React.Dispatch<React.SetStateAction<number>>,
-  ) {
-
-
-    // Create websocket connection to TS5 client
-    this.remoteAppPort = remoteAppPort;
-    this.ws = new WebSocket(`ws://localhost:${this.remoteAppPort}`);
-
-    // Create dataHandler and messageHandler
-    this.dataHandler = new TS5DataHandler(setConnections, setChannels, setClients);
-    this.messageHandler = new TS5MessageHandler(this.ws, this.dataHandler, setActiveConnectionStateId);
-  }
-
-  reconnect() {
-    Logger.log("Reconnecting...")
-    this.ws.close();
-
-    this.ws = new WebSocket(`ws://localhost:${this.remoteAppPort}`);
-
-    this.dataHandler.clearAll();
-    this.authenticated = false;
-    this.connect();
-  }
-
-  // Connect to TS5 client
-  connect() {
-    Logger.log('Connecting to TS5 client...');
-
-    // Create authentication payload
-    const initalPayload: IAuthSenderPayload = {
-      type: "auth",
-      payload: {
-        identifier: "de.tealfire.obs",
-        version: "1.0.0",
-        name: "TS5 OBS Overlay",
-        description: "A OBS overlay for TS5 by DerTyp876",
-        content: {
-          apiKey: localStorage.getItem("apiKey") ?? "",
-        },
-      },
-    };
-
-    this.ws.onopen = () => {
-      // Send authentication payload to TS5 client
-      this.ws.send(JSON.stringify(initalPayload));
-      Logger.wsSent(initalPayload);
-    };
-
-    this.ws.onclose = (event) => {
-      Logger.log("WebSocket connection closed", event);
-
-      // If the connection was closed before authentication, remove the API key from local storage
-      // OBS weirdly caches the localstorage and is very stubborn about clearing it (even when clicken "Clear Cache")
-      if (!this.authenticated) {
-        Logger.log("WebSocket connection closed before authentication");
-        localStorage.removeItem("apiKey");
-      }
-
-      setTimeout(() => {
-        this.reconnect();
-      }, 2000);
-    };
-
-    // Handle messages received from TS5 client
-    // See TS5MessageHandler class
-    this.ws.onmessage = (event) => {
-      const data = JSON.parse(event.data);
-
-      Logger.wsReceived(data)
-
-      switch (data.type) {
-        case "auth":
-          this.messageHandler.handleAuthMessage(data);
-          this.authenticated = true;
-          break;
-        case "clientMoved":
-          this.messageHandler.handleClientMovedMessage(data);
-          break;
-        case "clientPropertiesUpdated":
-          this.messageHandler.handleClientPropertiesUpdatedMessage(data);
-          break;
-        case "talkStatusChanged":
-          this.messageHandler.handleTalkStatusChangedMessage(data);
-          break;
-        case "serverPropertiesUpdated":
-          this.messageHandler.handleServerPropertiesUpdatedMessage(data);
-          break;
-        case "connectStatusChanged":
-          this.messageHandler.handleConnectStatusChangedMessage(data);
-          break;
-        case "clientSelfPropertyUpdated":
-          this.messageHandler.handleClientSelfPropertyUpdatedMessage(data);
-          break;
-        case "channels":
-          this.messageHandler.handleChannelsMessage(data);
-          break;
-        default:
-          Logger.log(`No handler for event type: ${data.type}`);
-          break;
-      }
-    };
-  }
-}
-
-
-
-
-
-

src/handlers/teamspeak/dataHandler.ts

@@ -1,205 +0,0 @@
-import Logger from "@/utils/logger";
-import { IConnection, IChannel, IClient, ITS5DataHandler } from "@interfaces/teamspeak";
-
-
-/**
- * Handles data received from TS5 client (list of connections, channels and clients)
- * Updates the states of App.tsx
- */
-export class TS5DataHandler implements ITS5DataHandler {
-  // Local lists of connections, channels and clients
-  // These lists are used to keep track of the data, independent of the App.tsx state
-  localConnections: IConnection[];
-  localChannels: IChannel[];
-  localClients: IClient[];
-
-  // State setters for App.tsx
-  setConnections: React.Dispatch<React.SetStateAction<IConnection[]>>;
-  setChannels: React.Dispatch<React.SetStateAction<IChannel[]>>;
-  setClients: React.Dispatch<React.SetStateAction<IClient[]>>;
-
-  constructor(
-    // State setters for App.tsx
-    setConnections: React.Dispatch<React.SetStateAction<IConnection[]>>,
-    setChannels: React.Dispatch<React.SetStateAction<IChannel[]>>,
-    setClients: React.Dispatch<React.SetStateAction<IClient[]>>
-  ) {
-    this.setConnections = setConnections;
-    this.setChannels = setChannels;
-    this.setClients = setClients;
-
-    this.localConnections = [];
-    this.localChannels = [];
-    this.localClients = [];
-  }
-
-  // Update App.tsx states
-  private updateConnectionsState() {
-    this.setConnections([...this.localConnections]);
-  }
-
-  private updateChannelsState() {
-    this.setChannels([...this.localChannels]);
-  }
-
-  private updateClientsState() {
-    this.setClients([...this.localClients]);
-  }
-
-  // Clear all data
-  clearAll() {
-    this.localConnections = [];
-    this.localChannels = [];
-    this.localClients = [];
-
-    this.updateConnectionsState();
-    this.updateChannelsState();
-    this.updateClientsState();
-  }
-
-  // Add data to local lists and update states
-  addConnection(connection: IConnection) {
-    Logger.log("Adding connection...", connection)
-
-    const existingConnection: IConnection | undefined = this.localConnections.find((localConnection: IConnection) => localConnection.id === connection.id);
-
-    if (existingConnection == undefined) {
-      this.localConnections.push(connection);
-      this.updateConnectionsState();
-      Logger.log("Connection added")
-    } else {
-      Logger.log("Connection already exists")
-    }
-  }
-
-  addChannel(channel: IChannel) {
-    Logger.log("Adding channel...", channel)
-    const existingChannel: IChannel | undefined = this.localChannels.find((localChannel: IChannel) => localChannel.id === channel.id && localChannel.connection.id === channel.connection.id);
-
-    if (existingChannel == undefined) {
-      this.localChannels.push(channel);
-      this.updateChannelsState();
-      Logger.log("Channel added")
-    } else {
-      Logger.log("Channel already exists")
-    }
-  }
-
-  addClient(client: IClient) {
-    Logger.log("Adding client...", client)
-    const existingClient: IClient | undefined = this.localClients.find((localClient: IClient) => localClient.id === client.id && localClient.channel?.connection.id === client.channel?.connection.id);
-
-    if (existingClient == undefined) {
-      this.localClients.push(client);
-      this.updateClientsState();
-      Logger.log("Client added")
-    } else {
-      Logger.log("Client already exists")
-    }
-  }
-
-  // Update data in local lists and update states
-  updateConnection(connection: IConnection) {
-    Logger.log("Updating connection...", connection)
-    const existingConnection: IConnection | undefined = this.localConnections.find((localConnection: IConnection) => localConnection.id === connection.id);
-
-    if (existingConnection !== undefined) {
-      this.localConnections[this.localConnections.indexOf(existingConnection)] = connection;
-      this.updateConnectionsState();
-      Logger.log("Connection updated")
-    } else {
-      Logger.log("Connection does not exist")
-    }
-  }
-
-  updateChannel(channel: IChannel) {
-    Logger.log("Updating channel...", channel)
-    const existingChannel: IChannel | undefined = this.localChannels.find((localChannel: IChannel) => localChannel.id === channel.id && localChannel.connection.id === channel.connection.id);
-
-    if (existingChannel !== undefined) {
-      this.localChannels[this.localChannels.indexOf(existingChannel)] = channel;
-      this.updateChannelsState();
-      Logger.log("Channel updated")
-    } else {
-      Logger.log("Channel does not exist")
-    }
-  }
-
-  updateClient(client: IClient) {
-    Logger.log("Updating client...", client)
-    const existingClient: IClient | undefined = this.localClients.find((localClient: IClient) => localClient.id === client.id && localClient.channel?.connection.id === client.channel?.connection.id);
-
-    if (existingClient !== undefined) {
-      this.localClients[this.localClients.indexOf(existingClient)] = client;
-      this.updateClientsState();
-      Logger.log("Client updated")
-    } else {
-      Logger.log("Client does not exist")
-    }
-  }
-
-  // Remove data from local lists and update states
-  removeConnection(connection: IConnection) {
-    Logger.log("Removing connection...", connection)
-    const existingConnection: IConnection | undefined = this.localConnections.find((localConnection: IConnection) => localConnection.id === connection.id);
-
-    if (existingConnection !== undefined) {
-      this.localConnections.splice(this.localConnections.indexOf(existingConnection), 1);
-
-      // Remove all channels and clients associated with the connection
-      this.localChannels = this.localChannels.filter((localChannel: IChannel) => localChannel.connection.id !== connection.id);
-      this.localClients = this.localClients.filter((localClient: IClient) => localClient.channel?.connection.id !== connection.id);
-
-      this.updateChannelsState();
-      this.updateClientsState();
-      this.updateConnectionsState();
-      Logger.log("Connection removed")
-    } else {
-      Logger.log("Connection does not exist")
-    }
-  }
-
-  removeChannel(channel: IChannel) {
-    Logger.log("Removing channel...", channel)
-    const existingChannel: IChannel | undefined = this.localChannels.find((localChannel: IChannel) => localChannel.id === channel.id && localChannel.connection.id === channel.connection.id);
-
-    if (existingChannel !== undefined) {
-      this.localChannels.splice(this.localChannels.indexOf(existingChannel), 1);
-
-      // Remove all clients associated with the channel
-      this.localClients = this.localClients.filter((localClient: IClient) => localClient.channel?.id !== channel.id);
-
-      this.updateClientsState();
-      this.updateChannelsState();
-      Logger.log("Channel removed")
-    } else {
-      Logger.log("Channel does not exist")
-    }
-  }
-
-  removeClient(client: IClient) {
-    Logger.log("Removing client...", client)
-    const existingClient: IClient | undefined = this.localClients.find((localClient: IClient) => localClient.id === client.id && localClient.channel?.connection.id === client.channel?.connection.id);
-
-    if (existingClient !== undefined) {
-      this.localClients.splice(this.localClients.indexOf(existingClient), 1);
-      this.updateClientsState();
-      Logger.log("Client removed")
-    } else {
-      Logger.log("Client does not exist")
-    }
-  }
-
-  // Helper functions
-  getConnectionById(id: number): IConnection | undefined {
-    return this.localConnections.find((connection: IConnection) => connection.id === id);
-  }
-
-  getChannelById(id: number, connectionId: number): IChannel | undefined {
-    return this.localChannels.find((channel: IChannel) => channel.id === id && channel.connection?.id === connectionId);
-  }
-
-  getClientById(id: number, connectionId: number): IClient | undefined {
-    return this.localClients.find((client: IClient) => client.id === id && client.channel?.connection.id === connectionId);
-  }
-}

src/handlers/teamspeak/messageHandler.ts

@@ -1,197 +0,0 @@
-import Logger from "@/utils/logger";
-import { IChannelInfos, IConnection, IChannel, IAuthMessage, IClientInfo, IClientMovedMessage, IClient, IClientPropertiesUpdatedMessage, ITalkStatusChangedMessage, IClientSelfPropertyUpdatedMessage, IServerPropertiesUpdatedMessage, IConnectStatusChangedMessage, IChannelsMessage, ITS5MessageHandler, ITS5DataHandler } from "@interfaces/teamspeak";
-
-// Handle incoming messages from TS5 client
-export class TS5MessageHandler implements ITS5MessageHandler {
-  ws: WebSocket;
-  dataHandler: ITS5DataHandler;
-
-  setActiveConnectionStateId: React.Dispatch<React.SetStateAction<number>>;
-  activeConnectionId = 0;
-
-  constructor(ws: WebSocket, dataHandler: ITS5DataHandler, setActiveConnectionStateId: React.Dispatch<React.SetStateAction<number>>) {
-    this.ws = ws;
-    this.dataHandler = dataHandler;
-    this.setActiveConnectionStateId = setActiveConnectionStateId;
-  }
-
-  setActiveConnection(connectionId: number) {
-    this.activeConnectionId = connectionId;
-    this.setActiveConnectionStateId(connectionId);
-  }
-
-  parseChannelInfos(channelInfos: IChannelInfos, connection: IConnection) {
-    channelInfos.rootChannels.forEach((channel: IChannel) => {
-      this.dataHandler.addChannel({ ...channel, connection: connection });
-
-      if (channelInfos) {
-        if (channelInfos.subChannels !== null && channel.id in channelInfos.subChannels) {
-          channelInfos.subChannels[channel.id].forEach((subChannel: IChannel) => {
-            this.dataHandler.addChannel({ ...subChannel, connection: connection });
-          });
-        }
-      }
-    });
-  }
-
-  // This message is sent by the TS5 server when the client is connected
-  // It contains the initial data
-  handleAuthMessage(data: IAuthMessage) {
-    localStorage.setItem("apiKey", data.payload.apiKey);
-
-    // Process auth payload and add initial data
-    data.payload.connections.forEach((connection: IConnection) => {
-      this.dataHandler.addConnection(connection);
-
-      // Add channels
-      if (connection.channelInfos !== undefined) {
-        this.parseChannelInfos(connection.channelInfos, connection);
-      }
-
-      // Add clients
-      connection.clientInfos?.forEach((clientInfo: IClientInfo) => {
-        const clientChannel: IChannel | undefined = this.dataHandler.getChannelById(clientInfo.channelId, connection.id);
-
-        if (clientChannel !== undefined) {
-          this.dataHandler.addClient({
-            id: clientInfo.id,
-            talkStatus: 0,
-            channel: { ...clientChannel, connection: connection },
-            properties: clientInfo.properties,
-          });
-        }
-      });
-    });
-  }
-
-  // This message is sent by the TS5 server when a client moves a channel OR joins/leaves the server
-  handleClientMovedMessage(data: IClientMovedMessage) {
-    const client: IClient | undefined = this.dataHandler.getClientById(data.payload.clientId, data.payload.connectionId);
-
-
-    //* This gets called when we are connecting to the server and the new clients get loaded
-    if (+data.payload.oldChannelId == 0) { // Create new client(when connecting to server)
-      //set timout to wait for channels to be created
-      setTimeout(() => {
-        const newChannel = this.dataHandler.getChannelById(data.payload.newChannelId, data.payload.connectionId);
-        if (newChannel !== undefined) {
-          this.dataHandler.addClient(
-            {
-              id: data.payload.clientId,
-              talkStatus: 0,
-              channel: newChannel,
-              properties: data.payload.properties,
-            });
-          Logger.ts(`New Client found (${data.payload.connectionId} - ${data.payload.clientId} - ${data.payload.properties.nickname})`)
-        }
-      }, 2000);
-
-    } else {//* This gets called when a client moves a channel OR joins/leaves the server
-      const newChannel: IChannel | undefined = this.dataHandler.getChannelById(data.payload.newChannelId, data.payload.connectionId);
-
-      if (newChannel === undefined || newChannel.id === 0) {
-        Logger.ts(`Client left (${data.payload.connectionId} - ${data.payload.clientId} - ${data.payload.properties.nickname})`)
-        if (client !== undefined) {
-          this.dataHandler.removeClient(client);
-        }
-        return;
-      }
-
-      if (client !== undefined) { // Client already exists
-        Logger.ts(`Client moved (${client.channel.connection.id} - ${client.id} - ${client.properties.nickname})`)
-
-        this.dataHandler.updateClient({
-          ...client,
-          channel: newChannel,
-        });
-
-      } else { // Client does not exist
-        // Client joined
-        Logger.ts(`Client joined (${data.payload.connectionId} - ${data.payload.clientId} - ${data.payload.properties.nickname})`)
-
-        this.dataHandler.addClient(
-          {
-            id: data.payload.clientId,
-            talkStatus: 0,
-            channel: newChannel,
-            properties: data.payload.properties,
-          }
-        );
-      }
-    }
-  }
-
-  handleClientPropertiesUpdatedMessage(data: IClientPropertiesUpdatedMessage) {
-    const client: IClient | undefined = this.dataHandler.getClientById(data.payload.clientId, data.payload.connectionId);
-
-    if (client !== undefined) {
-      this.dataHandler.updateClient({
-        ...client,
-        properties: data.payload.properties,
-      });
-    }
-  }
-
-  handleTalkStatusChangedMessage(data: ITalkStatusChangedMessage) {
-    const client: IClient | undefined = this.dataHandler.getClientById(data.payload.clientId, data.payload.connectionId);
-
-    if (client !== undefined) {
-      this.dataHandler.updateClient({
-        ...client,
-        talkStatus: data.payload.status,
-      });
-    }
-
-    // console.log(this.dataHandler.localConnections)
-    // console.log(this.dataHandler.localChannels)
-    // console.log(this.dataHandler.localClients)
-
-  }
-  handleClientSelfPropertyUpdatedMessage(data: IClientSelfPropertyUpdatedMessage) {
-    const connection: IConnection | undefined = this.dataHandler.getConnectionById(this.activeConnectionId);
-
-    if (data.payload.flag == "inputHardware" || connection == undefined) { // sadly thats the only way to detect if a server is active or not
-      this.setActiveConnection(data.payload.connectionId);
-    }
-  }
-
-  handleServerPropertiesUpdatedMessage(data: IServerPropertiesUpdatedMessage) {
-    const connection: IConnection | undefined = this.dataHandler.getConnectionById(data.payload.connectionId);
-
-    if (connection !== undefined) { // Update existing connection
-      this.dataHandler.updateConnection({
-        ...connection,
-        properties: data.payload.properties,
-      });
-    }
-  }
-
-  handleConnectStatusChangedMessage(data: IConnectStatusChangedMessage) {
-    if (data.payload.status === 0) { // Disconnected from server
-      const connection: IConnection | undefined = this.dataHandler.getConnectionById(data.payload.connectionId);
-
-      if (connection !== undefined) {
-        this.dataHandler.removeConnection(connection);
-      }
-    }
-
-    // Status 1-3 are the connection steps (connecting, authenticating, etc.) (i guess)
-
-    if (data.payload.status === 4) { // Connected to server
-      this.dataHandler.addConnection({
-        id: data.payload.connectionId,
-        clientId: data.payload.info.clientId,
-      });
-    }
-  }
-
-  handleChannelsMessage(data: IChannelsMessage) {
-    // Wait a bit for the connection to be added
-    setTimeout(() => {
-      const connection: IConnection | undefined = this.dataHandler.getConnectionById(data.payload.connectionId);
-      if (connection !== undefined) {
-        this.parseChannelInfos(data.payload.info, connection);
-      }
-    }, 1000);
-  }
-}

src/interfaces/teamspeak.ts

@@ -1,341 +0,0 @@
-// Classes
-export interface ITS5ConnectionHandler {
-  ws: WebSocket;
-  authenticated: boolean;
-  remoteAppPort: number;
-  dataHandler: ITS5DataHandler;
-  messageHandler: ITS5MessageHandler;
-  reconnect(): void;
-  connect(): void;
-}
-
-export interface ITS5DataHandler {
-  localConnections: IConnection[];
-  localChannels: IChannel[];
-  localClients: IClient[];
-  setConnections: React.Dispatch<React.SetStateAction<IConnection[]>>;
-  setChannels: React.Dispatch<React.SetStateAction<IChannel[]>>;
-  setClients: React.Dispatch<React.SetStateAction<IClient[]>>;
-  clearAll(): void;
-  addConnection(connection: IConnection): void;
-  addChannel(channel: IChannel): void;
-  addClient(client: IClient): void;
-  updateConnection(connection: IConnection): void;
-  updateChannel(channel: IChannel): void;
-  updateClient(client: IClient): void;
-  removeConnection(connection: IConnection): void;
-  removeChannel(channel: IChannel): void;
-  removeClient(client: IClient): void;
-  getConnectionById(id: number): IConnection | undefined;
-  getChannelById(id: number, connectionId: number): IChannel | undefined;
-  getClientById(id: number, connectionId: number): IClient | undefined;
-}
-
-export interface ITS5MessageHandler {
-  ws: WebSocket;
-  dataHandler: ITS5DataHandler;
-  setActiveConnectionStateId: React.Dispatch<React.SetStateAction<number>>;
-  activeConnectionId: number;
-  setActiveConnection(connectionId: number): void;
-  parseChannelInfos(channelInfos: IChannelInfos, connection: IConnection): void;
-  handleAuthMessage(data: IAuthMessage): void;
-  handleClientMovedMessage(data: IClientMovedMessage): void;
-  handleClientPropertiesUpdatedMessage(data: IClientPropertiesUpdatedMessage): void;
-  handleTalkStatusChangedMessage(data: ITalkStatusChangedMessage): void;
-  handleClientSelfPropertyUpdatedMessage(data: IClientSelfPropertyUpdatedMessage): void;
-  handleServerPropertiesUpdatedMessage(data: IServerPropertiesUpdatedMessage): void;
-  handleConnectStatusChangedMessage(data: IConnectStatusChangedMessage): void;
-  handleChannelsMessage(data: IChannelsMessage): void;
-}
-
-// Remote App
-export interface IAuthSenderPayload {
-  type: "auth";
-  payload: {
-    identifier: string;
-    version: string;
-    name: string;
-    description: string;
-    content: {
-      apiKey: string;
-    };
-  };
-}
-
-export interface IClient {
-  id: number;
-  talkStatus: number;
-  channel: IChannel;
-  properties: IClientProperties;
-}
-
-export interface IChannel {
-  id: number;
-  connection: IConnection;
-  order: string;
-  parentId: string;
-  properties: IChannelProperties;
-}
-
-export interface IConnection {
-  channelInfos?: IChannelInfos;
-  clientId: number;
-  clientInfos?: IClientInfo[];
-  id: number;
-  properties?: IServerProperties;
-}
-
-
-export interface IChannelProperties {
-  bannerGfxUrl: string;
-  bannerMode: number;
-  codec: number;
-  codecIsUnencrypted: boolean;
-  codecLatencyFactor: number;
-  codecQuality: number;
-  deleteDelay: number;
-  description: string;
-  flagAreSubscribed: boolean;
-  flagDefault: boolean;
-  flagMaxclientsUnlimited: boolean;
-  flagMaxfamilyclientsInherited: boolean;
-  flagMaxfamilyclientsUnlimited: boolean;
-  flagPassword: boolean;
-  flagPermanent: boolean;
-  flagSemiPermanent: boolean;
-  forcedSilence: boolean;
-  iconId: number;
-  maxclients: number;
-  maxfamilyclients: number;
-  name: string;
-  namePhonetic: string;
-  neededTalkPower: number;
-  order: string;
-  permissionHints: number;
-  storageQuota: number;
-  topic: string;
-  uniqueIdentifier: string;
-}
-
-
-export interface IChannelInfos {
-  rootChannels: IChannel[];
-  subChannels: { [key: number]: IChannel[] };
-}
-
-export interface IClientInfo {
-  channelId: number;
-  id: number;
-  properties: IClientProperties;
-}
-
-export interface IClientProperties {
-  away: boolean;
-  awayMessage: string;
-  badges: string;
-  channelGroupId: string;
-  channelGroupInheritedChannelId: string;
-  country: string;
-  created: number;
-  databaseId: string;
-  defaultChannel: string;
-  defaultChannelPassword: string;
-  defaultToken: string;
-  description: string;
-  flagAvatar: string;
-  flagTalking: boolean;
-  iconId: number;
-  idleTime: number;
-  inputDeactivated: boolean;
-  inputHardware: boolean;
-  inputMuted: boolean;
-  integrations: string;
-  isChannelCommander: boolean;
-  isMuted: boolean;
-  isPrioritySpeaker: boolean;
-  isRecording: boolean;
-  isTalker: boolean;
-  lastConnected: number;
-  metaData: string;
-  monthBytesDownloaded: number;
-  monthBytesUploaded: number;
-  myteamspeakAvatar: string;
-  myteamspeakId: string;
-  neededServerQueryViewPower: number;
-  nickname: string;
-  nicknamePhonetic: string;
-  outputHardware: boolean;
-  outputMuted: boolean;
-  outputOnlyMuted: boolean;
-  permissionHints: number;
-  platform: string;
-  serverGroups: string;
-  serverPassword: string;
-  signedBadges: string;
-  talkPower: number;
-  talkRequest: number;
-  talkRequestMsg: string;
-  totalBytesDownloaded: number;
-  totalBytesUploaded: number;
-  totalConnections: number;
-  type: number;
-  uniqueIdentifier: string;
-  unreadMessages: number;
-  userTag: string;
-  version: string;
-  volumeModificator: number;
-}
-
-export interface IServerProperties {
-  antiFloodPointsNeededCommandBlock: number;
-  antiFloodPointsNeededIpBlock: number;
-  antiFloodPointsNeededPluginBlock: number;
-  antiFloodPointsTickReduce: number;
-  askForPrivilegeKeyAfterNickname: boolean;
-  askForPrivilegeKeyForChannelCreation: boolean;
-  askForPrivilegeKeyForModify: boolean;
-  awayMessage: string;
-  badges: string;
-  channelGroupId: string;
-  channelGroupInheritedChannelId: string;
-  clientType: number;
-  connectionBandwidthReceived: number;
-  connectionBandwidthSent: number;
-  connectionClientIp: string;
-  connectionConnectedTime: number;
-  connectionFiletransferBandwidthReceived: number;
-  connectionFiletransferBandwidthSent: number;
-  connectionPacketloss: number;
-  connectionPing: number;
-  connectionPacketsReceived: number;
-  connectionPacketsSent: number;
-  connectionPort: number;
-  connectionQueryBandwidthReceived: number;
-  connectionQueryBandwidthSent: number;
-  connectionServerIp: string;
-  connectionServerPort: number;
-  connectionThrottleBandwidthReceived: number;
-  connectionThrottleBandwidthSent: number;
-  country: string;
-  created: number;
-  defaultChannel: string;
-  defaultChannelPassword: string;
-  defaultServerGroup: string;
-  defaultToken: string;
-  flagAvatar: string;
-  iconId: number;
-  inputHardware: boolean;
-  inputMuted: boolean;
-  isChannelCommander: boolean;
-  isMuted: boolean;
-  isPrioritySpeaker: boolean;
-  isRecording: boolean;
-  isTalker: boolean;
-  isTts: boolean;
-  metaData: string;
-  monthBytesDownloaded: number;
-  monthBytesUploaded: number;
-  myteamspeakAvatar: string;
-  myteamspeakId: string;
-  neededServerQueryViewPower: number;
-  nickname: string;
-  nicknamePhonetic: string;
-  outputHardware: boolean;
-  outputMuted: boolean;
-  outputOnlyMuted: boolean;
-  permissionHints: number;
-  platform: string;
-  serverPassword: string;
-  signedBadges: string;
-  talkPower: number;
-  talkRequest: number;
-  talkRequestMsg: string;
-  totalBytesDownloaded: number;
-  totalBytesUploaded: number;
-  totalConnections: number;
-  type: number;
-  uniqueIdentifier: string;
-  unreadMessages: number;
-  userTag: string;
-  version: string;
-  volumeModificator: number;
-}
-
-
-export interface IClientPropertiesUpdatedMessage {
-  type: "clientPropertiesUpdated";
-  payload: {
-    clientId: number;
-    connectionId: number;
-    properties: IClientProperties;
-  };
-}
-
-export interface IClientMovedMessage {
-  type: "clientMoved";
-  payload: {
-    properties: IClientProperties;
-    clientId: number;
-    connectionId: number;
-    newChannelId: number;
-    oldChannelId: number;
-    type: number;
-    visibility: number;
-  };
-}
-
-export interface ITalkStatusChangedMessage {
-  type: "talkStatusChanged";
-  payload: {
-    clientId: number;
-    connectionId: number;
-    isWhisper: boolean;
-    status: number;
-  };
-}
-
-export interface IClientSelfPropertyUpdatedMessage {
-  type: "clientSelfPropertyUpdated";
-  payload: {
-    connectionId: number;
-    flag: string;
-    newValue: boolean;
-    oldValue: boolean;
-  };
-}
-
-export interface IAuthMessage {
-  type: "auth";
-  payload: {
-    apiKey: string;
-    connections: IConnection[];
-  };
-}
-
-export interface IServerPropertiesUpdatedMessage {
-  type: "serverPropertiesUpdated";
-  payload: {
-    connectionId: number;
-    properties: IServerProperties;
-  };
-}
-
-export interface IConnectStatusChangedMessage {
-  type: "connectStatusChanged";
-  payload: {
-    connectionId: number;
-    error: number;
-    info: {
-      clientId: number;
-    }
-    status: number;
-  };
-}
-
-export interface IChannelsMessage {
-  type: "channels";
-  payload: {
-    connectionId: number;
-    info: IChannelInfos
-  }
-}

src/main.tsx

@@ -1,10 +1,10 @@
 import React from "react";
 import ReactDOM from "react-dom/client";
-import { BrowserRouter } from "react-router-dom";
 import App from "./App.tsx";
 import "@styles/index.scss";
+import { BrowserRouter } from "react-router-dom";
 
-ReactDOM.createRoot(document.getElementById("root") as HTMLElement).render(
+ReactDOM.createRoot(document.getElementById("root")!).render(
   <BrowserRouter>
     <App />
   </BrowserRouter>

src/styles/Generator.scss

@@ -0,0 +1,259 @@
+// Breakpoints
+$breakpoint-1: 1200px;
+$breakpoint-2: 790px;
+$breakpoint-3: 600px;
+
+// Tooltip animation keyframes
+@keyframes tooltipAnimation {
+  0% {
+    opacity: 0;
+    transform: translateY(-10px);
+  }
+  100% {
+    opacity: 1;
+    transform: translateY(0);
+  }
+}
+
+.generator {
+  background-color: #232528;
+  color: #fff;
+  width: 100%;
+  display: flex;
+  height: 100%;
+  flex-direction: column;
+  align-items: center;
+  gap: 50px;
+  padding: 50px 0;
+
+  .headline {
+    text-align: center;
+    letter-spacing: 1.8px;
+  }
+
+  .instructions {
+    border-bottom: 2px solid #75797773;
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    justify-content: center;
+    gap: 10px 50px;
+    flex-wrap: wrap;
+    padding-bottom: 10px;
+
+    p,
+    a {
+      font-size: 0.8rem;
+    }
+
+    p {
+      color: #b4b4b4;
+    }
+  }
+
+  .output {
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    justify-content: center;
+    column-gap: 20px;
+    position: relative;
+    height: 50px;
+
+    .url {
+      white-space: nowrap;
+      overflow: auto;
+      font-weight: bold;
+      width: 500px;
+      padding: 5px 10px;
+      background-color: #313136;
+      border-radius: 5px;
+      text-align: center;
+    }
+
+    .copy {
+      padding: 5px 10px;
+      border: 2px solid #31f39973;
+      transition: all 100ms ease-in-out;
+
+      &:hover {
+        border-color: #42d486;
+        background-color: transparent;
+        color: #fff;
+      }
+    }
+
+    .copiedTooltip {
+      opacity: 0;
+      position: absolute;
+      right: -90px;
+      background-color: #31f399;
+      color: #202024;
+      padding: 5px 10px;
+      border-radius: 5px;
+      font-size: 0.8rem;
+      font-weight: bold;
+    }
+  }
+
+  .generatorContent {
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    justify-content: center;
+    padding: 0 50px;
+    gap: 30px;
+    width: 100%;
+
+    .configurations {
+      display: flex;
+      flex-direction: column;
+      align-items: center;
+      height: 100%;
+      flex: 1;
+      gap: 50px;
+
+      .options {
+        display: flex;
+        flex-direction: row;
+        align-items: center;
+        gap: 100px;
+        user-select: none;
+
+        section {
+          display: flex;
+          flex-direction: column;
+          align-items: center;
+          justify-content: left;
+          gap: 10px;
+        }
+
+        .option {
+          display: flex;
+          flex-direction: row;
+          align-items: center;
+          justify-content: left;
+          column-gap: 10px;
+          width: 100%;
+
+          input {
+            -webkit-appearance: none;
+            -moz-appearance: none;
+            appearance: none;
+            width: 20px;
+            height: 20px;
+            border: 2px solid #31f399;
+            border-radius: 5px;
+            background-color: #202024;
+            outline: none;
+            transition: all 200ms ease-in-out;
+            position: relative;
+            color: #fff;
+            text-align: center;
+
+            &::-webkit-outer-spin-button,
+            &::-webkit-inner-spin-button {
+              -webkit-appearance: none;
+              margin: 0;
+            }
+
+            // Cross when checked styles
+            &:checked {
+              &:after {
+                content: "";
+                position: absolute;
+                width: 10px;
+                height: 2px;
+                background-color: #31f399;
+                transform: rotate(45deg);
+              }
+              &:before {
+                content: "";
+                position: absolute;
+                width: 10px;
+                height: 2px;
+                background-color: #31f399;
+                transform: rotate(-45deg);
+              }
+
+              &:after,
+              &:before {
+                top: 7px;
+                left: 3px;
+              }
+            }
+            cursor: pointer;
+          }
+
+          input[type="number"] {
+            width: 50px;
+            height: 25px;
+            cursor: text;
+            -moz-appearance: textfield;
+            appearance: textfield;
+          }
+
+          label {
+            cursor: pointer;
+          }
+        }
+      }
+    }
+
+    // Preview styles
+    .preview {
+      flex: 1;
+      border: 2px solid #31f39973;
+
+      // Viewer styles (see src/styles/Viewer.scss)
+      .viewer {
+        background-image: url("/images/viewer_example_background.png");
+        background-repeat: no-repeat;
+        background-size: cover;
+        min-height: 500px;
+      }
+    }
+  }
+
+  // Responsive styles
+  @media screen and (max-width: $breakpoint-1) {
+    .generatorContent {
+      flex-direction: column;
+
+      .preview {
+        width: 80%;
+      }
+    }
+  }
+
+  @media screen and (max-width: $breakpoint-2) {
+    .output {
+      .url {
+        width: 300px;
+      }
+    }
+
+    .generatorContent {
+      .preview {
+        width: 100%;
+      }
+    }
+  }
+
+  @media screen and (max-width: $breakpoint-3) {
+    .output {
+      .url {
+        width: 200px;
+      }
+
+      .generatorContent {
+        .configurations {
+          .options {
+            flex-direction: column;
+            gap: 30px;
+          }
+        }
+      }
+    }
+  }
+}

src/styles/Viewer.scss

@@ -1,22 +1,28 @@
+//* Viewer styles
+// this file contains styles for the viewer component
+// styles for the viewer component should not be modified somewhere else
+
 .viewer {
   display: flex;
   flex-direction: column;
-  gap: 0 0;
-  padding: 1rem;
+  padding: 0.5rem;
+
+  h1,
+  p {
+    background-color: #2f313680;
+    padding: 0.25rem 0.5rem;
+    border-radius: 0.25rem;
+    white-space: nowrap;
+    overflow: hidden;
+    text-overflow: ellipsis;
+    max-width: 20ch;
+    user-select: none;
+  }
 
   .channelNameContainer {
     display: flex;
     align-items: center;
     margin-bottom: 20px;
-    h3 {
-      font-size: 1.7rem;
-      font-weight: 500;
-      margin: 0;
-      background-color: rgba(47, 49, 54, 0.5);
-      padding: 0.25rem 0.5rem;
-      border-radius: 0.25rem;
-      color: white;
-    }
   }
 
   .client {
@@ -26,23 +32,16 @@
     align-items: center;
     margin: 0.5rem 0;
 
+    // icon styles
     svg {
-      width: 2.8rem;
-      height: 2.8rem;
+      width: 2.1rem;
+      aspect-ratio: 1/1;
       margin-right: 0.5rem;
     }
-    p {
-      margin: 0;
-      color: white;
-      background-color: rgba(47, 49, 54, 0.5);
-      padding: 0.25rem 0.5rem;
-      border-radius: 0.25rem;
 
-      // ellipsis after 22 characters
-      white-space: nowrap;
-      overflow: hidden;
-      text-overflow: ellipsis;
-      max-width: 20ch;
+    // client name styles
+    p {
+      font-size: 1.4rem;
     }
   }
 }

src/styles/index.scss

@@ -1,5 +1,101 @@
+// Reset styles for all elements
 * {
   font-family: Arial, Helvetica, sans-serif;
   font-weight: bold;
-  font-size: 3rem;
+  font-size: 1rem;
+  margin: 0;
+  padding: 0;
+  box-sizing: border-box;
+}
+
+// Set up basic styles for the entire page
+body,
+html {
+  min-height: 100vh;
+  min-width: 100%;
+  display: flex;
+  overflow-x: hidden;
+  color: #fff;
+}
+
+// Ensure the root element takes up the full viewport
+#root {
+  height: 100%;
+  min-width: 100%;
+}
+
+// Headline styles
+h1 {
+  font-size: 1.8rem;
+}
+
+h2 {
+  font-size: 1.5rem;
+}
+
+h3 {
+  font-size: 1.2rem;
+}
+
+h4 {
+  font-size: 1.1rem;
+}
+
+// Common styles for heading elements
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+  font-weight: bold;
+}
+
+// Text styles
+a {
+  color: #3abe78;
+  font-weight: bold;
+  text-decoration: none;
+  transition: all 100ms ease-in-out;
+
+  &:hover {
+    color: #31f399;
+  }
+}
+
+// Button styles
+button {
+  background-color: #202024;
+  color: #fff;
+  font-weight: bold;
+  border: 2px solid #31f399;
+  border-radius: 5px;
+  padding: 10px 20px;
+  cursor: pointer;
+  transition: all 300ms ease-in-out;
+
+  &:hover {
+    background-color: #42d486;
+    color: #202024;
+  }
+}
+
+// Custom dark-themed scrollbar
+::-webkit-scrollbar {
+  width: 5px;
+  height: 5px;
+}
+
+::-webkit-scrollbar-track {
+  background: #363638;
+  border-radius: 10px;
+}
+
+::-webkit-scrollbar-thumb {
+  background: #31f39973;
+  border-radius: 10px;
+
+  &:hover {
+    background: #48ee95;
+  }
 }

tsconfig.json

@@ -18,7 +18,8 @@
     },
 
     /* Bundler mode */
-    "moduleResolution": "bundler",
+    "moduleResolution": "Node",
+    "allowSyntheticDefaultImports": true,
     "allowImportingTsExtensions": true,
     "resolveJsonModule": true,
     "isolatedModules": true,

vite.config.ts

@@ -1,6 +1,5 @@
 import { defineConfig } from 'vite'
 import react from '@vitejs/plugin-react-swc'
-import { viteSingleFile } from "vite-plugin-singlefile"
 import path from 'path';
 
 // https://vitejs.dev/config/
@@ -17,5 +16,9 @@ export default defineConfig({
       '@styles': path.resolve(__dirname, './src/styles'),
     },
   },
-  plugins: [react(), viteSingleFile({ useRecommendedBuildConfig: false })],
+  build: {
+    outDir: 'dist',
+    emptyOutDir: true,
+  },
+  plugins: [react()],
 })