update version

Update README.md

.eslintrc.cjs

@@ -1,14 +1,11 @@
 module.exports = {
   env: { browser: true, es2020: true },
-  extends: [
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:react-hooks/recommended"],
-    'eslint:recommended',
+  parser: "@typescript-eslint/parser",
-    'plugin:@typescript-eslint/recommended',
+  parserOptions: { ecmaVersion: "latest", sourceType: "module" },
-    'plugin:react-hooks/recommended',
+  plugins: ["react-refresh"],
-  ],
-  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

@@ -17,6 +17,10 @@ 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]

.github/dependabot.yml

@@ -8,3 +8,4 @@ updates:
     directory: "/" # Location of package manifests
     schedule:
       interval: "monthly"
+    target-branch: "dev"

.github/workflows/deploy.yml

@@ -25,7 +25,7 @@ jobs:
         run: npm run build
 
       - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
+        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,73 +1,61 @@
-# Teamspeak5-OBS-Overlay
+# TeamSpeak5-OBS-Overlay
 
-This is an overlay for OBS to show the current talking clients in your Teamspeak 5 Channel.  
+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 Teamspeak 5.
+This App uses the new "Remote Apps" feature of TeamSpeak5.
 
-This overlay uses the [Teamspeak 5 Remote App API](https://github.com/DerTyp7/react-ts5-remote-app-api).
+This overlay uses the [TeamSpeak5 Remote App API](https://github.com/DerTyp7/react-ts5-remote-app-api).
 
 ![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/d0ab06f2-1a36-479d-826f-bd4bd3d405b7)
 
-- [Teamspeak5-OBS-Overlay](#teamspeak5-obs-overlay)
+- [TeamSpeak5-OBS-Overlay](#teamspeak5-obs-overlay)
-  - [Setup](#setup)
+  - [Usage](#usage)
-    - [Customization (Parameters)](#customization-parameters)
+    - [Quick instructions](#quick-instructions)
-  - [Setup (Developer)](#setup-developer)
+    - [Detailed instructions](#detailed-instructions)
   - [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)
+    - [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 `ts5-overlay-{version}.html` of the latest release from [here](https://github.com/DerTyp7/ts5-obs-overlay/releases/latest)
+### Quick instructions
-   ![image](https://github.com/DerTyp7/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 `ts5-overlay-{version}.html`
+1. Open this link in your Browser: [https://dertyp7.github.io/ts5-obs-overlay/#/generate](https://dertyp7.github.io/ts5-obs-overlay/#/generate)
-2. Go into the Teamspeak 5 Settings and enable "Remote Apps"  
+2. Follow the instructions on the website
+3. Accept overlay inside TeamSpeak5  
+   ![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/aa83b07d-3dea-461f-9487-f9e6a299f2f3)
+
+### Detailed instructions
+
+Try this instruction if you have problems with the quick instructions above.
+
+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. Go into the TeamSpeak5 Settings and enable "Remote Apps"  
    ![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/b31bc553-fde2-46ab-b07c-d3c81339cc7d)
 
-3. Add a new Browser Source to your OBS Scene  
+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)
 
-4. Tick the checkbox "Local File" and select the downloaded `ts5-overlay-{version}.html`  
+5. Enter the in step 1 generated URL into the URL field of the Browser Source
-    4.1. Set the width and height to your desired size (e.g. 1920x1080 OR 1280x720)  
+   ![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/e8fd4a1b-be70-4123-8d28-4dc7ebc8c2bd)
-   ![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/5ad8ce69-645b-45e7-acc3-ce7ba8d7f8ab)
 
-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)  
+6. Set the width and height to your desired size. Recommended is a width of 1000px and the height is determined of how many clients are expected (play around with these values)
+
+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)
 
-### 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  
-   ![image](https://github.com/DerTyp7/ts5-obs-overlay/assets/76851529/87985b4c-4397-4681-9635-239d1e382c24)
-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&parameter2=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
+### 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.
 
@@ -77,3 +65,18 @@ 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

@@ -3,6 +3,9 @@
   <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" />
+    <link rel="icon" href="/logo.svg" type="image/x-icon" />
     <title>TS5-OBS-Overlay</title>
   </head>
   <body>

package.json

@@ -1,7 +1,27 @@
 {
   "name": "ts5-obs-overlay",
-  "private": true,
+  "private": false,
-  "version": "1.2.3",
+  "version": "2.0.9",
+  "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,26 +30,24 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@types/node": "^20.4.5",
+    "@types/node": "^20.8.3",
-    "jest": "^29.6.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "react-router-dom": "^6.14.2",
+    "react-router-dom": "^6.18.0",
     "react-ts5-remote-app-api": "^1.1.1",
-    "sass": "^1.64.1"
+    "sass": "^1.68.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.2",
-    "@types/react": "^18.2.14",
+    "@types/react": "^18.2.35",
-    "@types/react-dom": "^18.2.7",
+    "@types/react-dom": "^18.2.14",
-    "@typescript-eslint/eslint-plugin": "^6.2.0",
+    "@typescript-eslint/eslint-plugin": "^6.7.4",
-    "@typescript-eslint/parser": "^6.2.1",
+    "@typescript-eslint/parser": "^6.9.1",
     "@vitejs/plugin-react-swc": "^3.0.0",
-    "eslint": "^8.45.0",
+    "eslint": "^8.53.0",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.3",
-    "typescript": "^5.1.6",
+    "typescript": "^5.2.2",
-    "vite": "^4.4.7",
+    "vite": "^4.5.0"
-    "vite-plugin-singlefile": "^0.13.5"
   }
 }

public/logo.svg

@@ -0,0 +1,23 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
+ "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
+ width="307.000000pt" height="339.000000pt" viewBox="0 0 307.000000 339.000000"
+ preserveAspectRatio="xMidYMid meet">
+
+<g transform="translate(0.000000,339.000000) scale(0.100000,-0.100000)"
+fill="#008080" stroke="none">
+<path d="M1297 3382 c-3 -4 -7 -61 -11 -127 -20 -341 -120 -616 -370 -1010
+-158 -251 -306 -436 -331 -415 -7 6 -18 52 -24 103 -22 170 -77 377 -101 377
+-5 0 -21 -38 -35 -86 -27 -89 -79 -213 -212 -504 -201 -438 -244 -657 -180
+-901 52 -198 102 -290 232 -427 137 -145 345 -310 474 -376 l34 -18 -5 24 c-3
+12 -18 63 -32 113 -64 213 -19 418 154 701 106 173 164 314 194 474 16 82 30
+120 45 120 13 0 55 -59 94 -131 45 -83 81 -198 102 -329 9 -57 18 -106 20
+-108 7 -7 122 231 144 298 34 104 49 202 63 403 6 103 15 186 20 185 4 -2 79
+-72 167 -155 257 -247 392 -414 501 -625 97 -187 102 -205 107 -413 6 -223 -1
+-265 -73 -418 -31 -65 -53 -121 -50 -124 7 -7 188 122 295 212 210 176 368
+383 455 598 149 370 117 760 -98 1193 -110 220 -245 417 -434 633 l-39 45 -7
+-183 c-5 -106 -14 -203 -22 -230 -14 -46 -80 -144 -99 -145 -14 -1 -59 92
+-101 209 -121 342 -331 651 -579 854 -130 107 -287 203 -298 183z"/>
+</g>
+</svg>

src/App.tsx

@@ -1,38 +1,26 @@
-/* eslint-disable react-hooks/exhaustive-deps */
 import "@styles/App.scss";
 
-import { useSearchParams } from "react-router-dom";
+import { Navigate, Route, Routes, useSearchParams } from "react-router-dom";
-import useTSRemoteApp, { IClient } from "react-ts5-remote-app-api";
 import Viewer from "./Viewer";
+import Generator from "./Generator";
 
 export default function App() {
   const [searchParams] = useSearchParams();
-  const { clients, activeConnectionId, currentChannel } = useTSRemoteApp({
-    remoteAppPort: parseInt(searchParams.get("remoteAppPort") ?? "5899"),
-    auth: {
-      identifier: "de.tealfire.obs",
-      version: "1.2.3",
-      name: "TS5 OBS Overlay",
-      description: "A OBS overlay for TS5 by DerTyp876",
-    },
-    logging: true,
-  });
 
   return (
-    <div className="App">
+    <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}
-        clients={
-          clients.map((client) => {
-            if (client.channel?.id === currentChannel?.id && client.channel.connection.id === activeConnectionId) {
-              return client;
-            }
-          }) as IClient[]
-        }
-        channel={currentChannel}
           />
-    </div>
+        }
+      />
+      <Route path="/generate" element={<Generator />} />
+    </Routes>
   );
 }

src/Generator.tsx

@@ -0,0 +1,126 @@
+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);
+    url.hash = "";
+
+    url.searchParams.set("remoteAppPort", remoteAppPort.toString());
+    url.searchParams.set("showChannelName", showChannelName.toString());
+    url.searchParams.set("hideNonTalking", hideNonTalking.toString());
+    url.searchParams.set("clientLimit", clientLimit.toString());
+
+    // url.hash function always sets the hash to the end of the URL, so we have to replace the question mark with a hash
+    // gh-pages needs the hash to be between the base URL and the search params
+    setOutputUrl(url.toString().replace("?", "#/?"));
+  }
+
+  // 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="https://github.com/DerTyp7/ts5-obs-overlay#detailed-instructions">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 "@styles/Viewer.scss";
-import { IChannel, IClient } from "react-ts5-remote-app-api";
+import useTSRemoteApp, { IClient } from "react-ts5-remote-app-api";
 
 export default function Viewer({
-  clients,
+  remoteAppPort = 5899,
-  channel,
   showChannelName = false,
   hideNonTalking = false,
   clientLimit = 0,
 }: {
-  clients: IClient[] | undefined;
+  remoteAppPort?: number;
-  channel: IChannel | undefined;
   showChannelName?: boolean;
   hideNonTalking?: boolean;
   clientLimit?: number;
 }) {
+  const { clients, activeConnectionId, currentChannel } = useTSRemoteApp({
+    remoteAppPort: remoteAppPort,
+    auth: {
+      identifier: "de.tealfire.obs",
+      version: "2.0.9",
+      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 (
+          if (hideNonTalking && (client.properties.inputMuted || client.properties.outputMuted || client.talkStatus == 0)) {
-            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
+                    <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" />
-                      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/main.tsx

@@ -1,11 +1,11 @@
 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, HashRouter } from "react-router-dom";
 
-ReactDOM.createRoot(document.getElementById("root") as HTMLElement).render(
+ReactDOM.createRoot(document.getElementById("root")!).render(
-  <BrowserRouter>
+  <HashRouter>
     <App />
-  </BrowserRouter>
+  </HashRouter>
 );

src/styles/Generator.scss

@@ -0,0 +1,271 @@
+// 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;
+        h1 {
+          font-size: 2rem;
+        }
+        .client {
+          svg {
+            width: 2rem;
+          }
+
+          p {
+            font-size: 2rem;
+          }
+        }
+      }
+    }
+  }
+
+  // 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,32 @@
+//* 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: 0.5rem;
-  padding: 1rem;
+
+  h1 {
+    font-size: 5vw;
+  }
+
+  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 +36,17 @@
     align-items: center;
     margin: 0.5rem 0;
 
+    // icon styles
     svg {
-      width: 2.8rem;
+      width: 5vw;
-      height: 2.8rem;
+      aspect-ratio: 1/1;
       margin-right: 0.5rem;
+      filter: drop-shadow(0 0 0.75rem rgba(15, 15, 15, 0.1));
     }
-    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
+    // client name styles
-      white-space: nowrap;
+    p {
-      overflow: hidden;
+      font-size: 5vw;
-      text-overflow: ellipsis;
-      max-width: 20ch;
     }
   }
 }

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/
@@ -21,5 +20,5 @@ export default defineConfig({
     outDir: 'dist',
     emptyOutDir: true,
   },
-  plugins: [react(), viteSingleFile({ useRecommendedBuildConfig: false })],
+  plugins: [react()],
 })