mirror of
https://github.com/DerTyp7/teamspeak-obs-overlay.git
synced 2026-07-31 08:39:04 +02:00
Compare commits
132 Commits
gh-pages
...
dependabot
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
94014e86e9 | ||
|
|
aaa770be2b | ||
|
|
9de39752f3 | ||
|
|
2499582f66 | ||
|
|
ad26dd62ad | ||
|
|
0a026baa9b | ||
|
|
a2b8f3620a | ||
|
|
06b940b7c9 | ||
|
|
c75d81eb43 | ||
|
|
529d1acbb6 | ||
|
|
e7e295cad1 | ||
|
|
10e8752bca | ||
|
|
6eb5785bfd | ||
|
|
6c912c37e4 | ||
|
|
d37c7326c3 | ||
|
|
4c1a6f92b9 | ||
|
|
1f3868fc3a | ||
|
|
632b2ad1ef | ||
|
|
9519a19b5c | ||
|
|
a438f81c72 | ||
|
|
6b3d44796f | ||
|
|
c272df6397 | ||
|
|
1eae9e0017 | ||
|
|
94c5a822fe | ||
|
|
509ca975bd | ||
|
|
43f3c4f4ac | ||
|
|
171a64da44 | ||
|
|
01aaf66e55 | ||
|
|
0e456bee91 | ||
|
|
6bc2994a91 | ||
|
|
716d306a87 | ||
|
|
cf0f472c70 | ||
|
|
3159a86e8f | ||
|
|
71fb6c565e | ||
|
|
254d29fe6d | ||
|
|
13f621f17b | ||
|
|
337c39935c | ||
|
|
d3cc20d58b | ||
|
|
cf5c0ae705 | ||
|
|
69db8c5bcc | ||
|
|
fd2863b355 | ||
|
|
8ffbe023eb | ||
|
|
a9edeec900 | ||
|
|
3e5ec1862e | ||
|
|
34ffedc294 | ||
|
|
6d7ee8905b | ||
|
|
442e8f05e6 | ||
|
|
f30cd26393 | ||
|
|
f0761c40b7 | ||
|
|
ef442f10e0 | ||
|
|
ce7bd90362 | ||
|
|
61f6651a57 | ||
|
|
1d9b6de814 | ||
|
|
751fad72f4 | ||
|
|
4eb61d3b96 | ||
|
|
7fd2e2aafa | ||
|
|
33786d7366 | ||
|
|
1a5b231d1e | ||
|
|
232bca2bbc | ||
|
|
0b74390d2e | ||
|
|
d16e80a48d | ||
|
|
c5009271c4 | ||
|
|
e9f3fa28f9 | ||
|
|
8b23a8cca7 | ||
|
|
87dd069dec | ||
|
|
1a5f0b8e6e | ||
|
|
8db32153d2 | ||
|
|
b1da52ad1d | ||
|
|
dbc2bd422d | ||
|
|
86d2eb4c50 | ||
|
|
63bef6e11d | ||
|
|
e65eb5b3c4 | ||
|
|
e847dde41d | ||
|
|
5f0ca2c209 | ||
|
|
a4f64c3781 | ||
|
|
9870fdcdb4 | ||
|
|
ce7aee8481 | ||
|
|
5ef2facfec | ||
| bbd10af0dc | |||
|
|
e2a8472cf9 | ||
|
|
ed78b23bb1 | ||
|
|
58fa81eb71 | ||
|
|
3a75c91bbd | ||
|
|
fa64de9666 | ||
|
|
847cb76bca | ||
|
|
6a7dd4455e | ||
|
|
61678b3ed4 | ||
|
|
fea7f03d20 | ||
|
|
7551dd421c | ||
|
|
18b4c0c67d | ||
|
|
e75116d6c9 | ||
|
|
176cdc79ed | ||
|
|
6ca724bd77 | ||
|
|
3bd6c60987 | ||
|
|
eb73c51ee1 | ||
|
|
945c3ec582 | ||
|
|
2c24379bbb | ||
|
|
d67a243c5d | ||
|
|
3174145067 | ||
|
|
c40b33de2b | ||
|
|
7974a08b24 | ||
|
|
ab38a1b1fe | ||
|
|
bb7d2d61c6 | ||
|
|
81eed1e0ab | ||
|
|
d75e11f3cd | ||
|
|
c5a8f484b7 | ||
|
|
c5b801d3d5 | ||
|
|
c86618f78f | ||
|
|
2f1e91c199 | ||
|
|
59594125a5 | ||
|
|
32108d7a99 | ||
|
|
5c8d9721b2 | ||
|
|
24f3e6dd88 | ||
|
|
3461e2be0a | ||
|
|
456d09d647 | ||
|
|
09d24b2acd | ||
|
|
389033e795 | ||
|
|
76ee50e262 | ||
|
|
2fb3c47e33 | ||
|
|
7676e72ca1 | ||
|
|
7bd7786465 | ||
|
|
e27cd40234 | ||
|
|
13080ca9d1 | ||
|
|
a74ae8988f | ||
|
|
31b564d676 | ||
|
|
c9c31a3e64 | ||
|
|
295153e702 | ||
|
|
db770ab2b1 | ||
|
|
9d3a30462c | ||
|
|
dbb171ef11 | ||
|
|
66e8f699e3 | ||
|
|
c8a44d5a5d |
11
.eslintrc.cjs
Normal file
11
.eslintrc.cjs
Normal file
@@ -0,0 +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"],
|
||||||
|
rules: {
|
||||||
|
"react-refresh/only-export-components": "warn",
|
||||||
|
"react-hooks/exhaustive-deps": "ignore",
|
||||||
|
},
|
||||||
|
};
|
||||||
27
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
27
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -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]
|
||||||
11
.github/dependabot.yml
vendored
Normal file
11
.github/dependabot.yml
vendored
Normal file
@@ -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"
|
||||||
31
.github/workflows/deploy.yml
vendored
Normal file
31
.github/workflows/deploy.yml
vendored
Normal file
@@ -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
|
||||||
24
.gitignore
vendored
Normal file
24
.gitignore
vendored
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# Logs
|
||||||
|
logs
|
||||||
|
*.log
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
pnpm-debug.log*
|
||||||
|
lerna-debug.log*
|
||||||
|
|
||||||
|
node_modules
|
||||||
|
dist
|
||||||
|
dist-ssr
|
||||||
|
*.local
|
||||||
|
|
||||||
|
# Editor directories and files
|
||||||
|
.vscode/*
|
||||||
|
!.vscode/extensions.json
|
||||||
|
.idea
|
||||||
|
.DS_Store
|
||||||
|
*.suo
|
||||||
|
*.ntvs*
|
||||||
|
*.njsproj
|
||||||
|
*.sln
|
||||||
|
*.sw?
|
||||||
7
.prettierrc
Normal file
7
.prettierrc
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
{
|
||||||
|
"tabWidth": 2,
|
||||||
|
"useTabs": false,
|
||||||
|
"printWidth": 180,
|
||||||
|
"singleQuote": false,
|
||||||
|
"semi": true
|
||||||
|
}
|
||||||
82
README.md
Normal file
82
README.md
Normal file
@@ -0,0 +1,82 @@
|
|||||||
|
# TeamSpeak5-OBS-Overlay
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
This overlay uses the [TeamSpeak Remote App API](https://github.com/DerTyp7/react-teamspeak-remote-app-api).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
- [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)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Quick instructions
|
||||||
|
|
||||||
|
1. Open this link in your Browser: [https://ts5-overlay.tealfire.de/#/generate](https://ts5-overlay.tealfire.de/#/generate)
|
||||||
|
2. Follow the instructions on the website
|
||||||
|
3. Accept overlay inside TeamSpeak5
|
||||||
|

|
||||||
|
|
||||||
|
### Detailed instructions
|
||||||
|
|
||||||
|
Try this instruction if you have problems with the quick instructions above.
|
||||||
|
|
||||||
|
1. Open this link in your Browser: [https://ts5-overlay.tealfire.de/#/generate](https://ts5-overlay.tealfire.de/#/generate)
|
||||||
|
|
||||||
|
2. Follow the instructions on the website
|
||||||
|
|
||||||
|
3. Go into the TeamSpeak5 Settings and enable "Remote Apps"
|
||||||
|

|
||||||
|
|
||||||
|
4. Add a new Browser Source to your OBS Scene
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
5. Enter the in step 1 generated URL into the URL field of the Browser Source
|
||||||
|

|
||||||
|
|
||||||
|
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)
|
||||||
|

|
||||||
|
|
||||||
|
## 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.
|
||||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -5,12 +5,11 @@
|
|||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<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="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" />
|
<meta name="author" content="DerTyp7" />
|
||||||
<link rel="icon" href="./logo.svg" type="image/x-icon" />
|
<link rel="icon" href="/logo.svg" type="image/x-icon" />
|
||||||
<title>TS5-OBS-Overlay</title>
|
<title>TS5-OBS-Overlay</title>
|
||||||
<script type="module" crossorigin src="./assets/index-DXas0TfE.js"></script>
|
|
||||||
<link rel="stylesheet" crossorigin href="./assets/index-MKACXyL3.css">
|
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<div id="root"></div>
|
<div id="root"></div>
|
||||||
|
<script type="module" src="/src/main.tsx"></script>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
3939
package-lock.json
generated
Normal file
3939
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
56
package.json
Normal file
56
package.json
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
{
|
||||||
|
"name": "teamspeak-obs-overlay",
|
||||||
|
"private": false,
|
||||||
|
"version": "2.2.0",
|
||||||
|
"description": "Overlay for OBS to show the current talking clients in your TeamSpeak Channel",
|
||||||
|
"author": "DerTyp7",
|
||||||
|
"homepage": "https://dertyp7.github.io/teamspeak-obs-overlay/#",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/DerTyp7/teamspeak-obs-overlay"
|
||||||
|
},
|
||||||
|
"keywords": [
|
||||||
|
"ts5",
|
||||||
|
"ts6",
|
||||||
|
"teamspeak6",
|
||||||
|
"teamspeak",
|
||||||
|
"teamspeak5",
|
||||||
|
"overlay",
|
||||||
|
"remote app",
|
||||||
|
"obs",
|
||||||
|
"typescript",
|
||||||
|
"react",
|
||||||
|
"vite"
|
||||||
|
],
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://github.com/DerTyp7/teamspeak-obs-overlay/issues"
|
||||||
|
},
|
||||||
|
"type": "module",
|
||||||
|
"scripts": {
|
||||||
|
"dev": "vite",
|
||||||
|
"build": "tsc && vite build",
|
||||||
|
"lint": "eslint src --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
|
||||||
|
"preview": "vite preview"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@types/node": "^22.10.10",
|
||||||
|
"react": "^19.0.0",
|
||||||
|
"react-dom": "^19.0.0",
|
||||||
|
"react-router-dom": "^7.1.3",
|
||||||
|
"react-teamspeak-remote-app-api": "^2.0.0",
|
||||||
|
"sass": "^1.83.4"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/jest": "^29.5.14",
|
||||||
|
"@types/react": "^19.0.8",
|
||||||
|
"@types/react-dom": "^19.0.3",
|
||||||
|
"@typescript-eslint/eslint-plugin": "^8.21.0",
|
||||||
|
"@typescript-eslint/parser": "^8.21.0",
|
||||||
|
"@vitejs/plugin-react-swc": "^3.7.2",
|
||||||
|
"eslint": "^9.18.0",
|
||||||
|
"eslint-plugin-react-hooks": "^5.1.0",
|
||||||
|
"eslint-plugin-react-refresh": "^0.4.18",
|
||||||
|
"typescript": "^5.7.3",
|
||||||
|
"vite": "^6.0.11"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Before Width: | Height: | Size: 2.1 MiB After Width: | Height: | Size: 2.1 MiB |
|
Before Width: | Height: | Size: 1.3 KiB After Width: | Height: | Size: 1.3 KiB |
26
src/App.tsx
Normal file
26
src/App.tsx
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
import "@styles/App.scss";
|
||||||
|
|
||||||
|
import { Route, Routes, useSearchParams } from "react-router-dom";
|
||||||
|
import Viewer from "./Viewer";
|
||||||
|
import Generator from "./Generator";
|
||||||
|
|
||||||
|
export default function App() {
|
||||||
|
const [searchParams] = useSearchParams();
|
||||||
|
|
||||||
|
return (
|
||||||
|
<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}
|
||||||
|
/>
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
<Route path="/generate" element={<Generator />} />
|
||||||
|
</Routes>
|
||||||
|
);
|
||||||
|
}
|
||||||
126
src/Generator.tsx
Normal file
126
src/Generator.tsx
Normal file
@@ -0,0 +1,126 @@
|
|||||||
|
import { 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>TeamSpeak-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>
|
||||||
|
);
|
||||||
|
}
|
||||||
169
src/Viewer.tsx
Normal file
169
src/Viewer.tsx
Normal file
@@ -0,0 +1,169 @@
|
|||||||
|
import "@styles/Viewer.scss";
|
||||||
|
import useTSRemoteApp, { IClient } from "react-teamspeak-remote-app-api";
|
||||||
|
|
||||||
|
export default function Viewer({
|
||||||
|
remoteAppPort = 5899,
|
||||||
|
showChannelName = false,
|
||||||
|
hideNonTalking = false,
|
||||||
|
clientLimit = 0,
|
||||||
|
}: {
|
||||||
|
remoteAppPort?: number;
|
||||||
|
showChannelName?: boolean;
|
||||||
|
hideNonTalking?: boolean;
|
||||||
|
clientLimit?: number;
|
||||||
|
}) {
|
||||||
|
const { clients, activeConnectionId, currentChannel } = useTSRemoteApp({
|
||||||
|
remoteAppPort: remoteAppPort,
|
||||||
|
auth: {
|
||||||
|
identifier: "de.tealfire.obs",
|
||||||
|
version: "2.2.0",
|
||||||
|
name: "TeamSpeak OBS Overlay",
|
||||||
|
description: "A OBS overlay for TeamSpeak 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 && currentChannel ? (
|
||||||
|
<div className="channelNameContainer">
|
||||||
|
<h1>{currentChannel?.properties.name}</h1>
|
||||||
|
</div>
|
||||||
|
) : null}
|
||||||
|
{currentClients?.map((client, i) => {
|
||||||
|
//* Client limit
|
||||||
|
if (clientLimit != 0 && i >= clientLimit) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (client) {
|
||||||
|
//* Non-talking client
|
||||||
|
if (hideNonTalking && (client.properties.inputMuted || client.properties.outputMuted || client.talkStatus == 0)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
//* Normal client
|
||||||
|
return (
|
||||||
|
<div className="client" key={`${client.id}-${client.channel?.connection.id}`}>
|
||||||
|
{client.properties.outputHardware == false ? (
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128">
|
||||||
|
<title>muted_hardware_output</title>
|
||||||
|
<g id="muted_hardware_output.svg">
|
||||||
|
<path
|
||||||
|
d="M116.62,39a4.78,4.78,0,0,1-1.59.3l-6.29,3.63a45.42,45.42,0,0,1-13.33,57.64,49.4,49.4,0,0,1-5.82,3.62c-1.06.57-2.2.92-3.19,1.49-1.7,1-2.77,2.13-2.77,4.18a4.57,4.57,0,0,0,4.54,4.54,5.33,5.33,0,0,0,1.84-.35,54.49,54.49,0,0,0,26.94-75c-.12,0-.22,0-.34,0M88.18,13.58a4.57,4.57,0,0,0-4.54,4.54c0,2.06,1.06,3.19,2.77,4.18,1,.57,2.13.92,3.19,1.49a49.4,49.4,0,0,1,5.82,3.62,45.68,45.68,0,0,1,8.19,7.78l7-4a2.63,2.63,0,0,1,1.11-.34A54.31,54.31,0,0,0,90,13.94a5.33,5.33,0,0,0-1.84-.35"
|
||||||
|
fill="#d8d8d8"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M59.46,71.4,32.77,86.81l19,19a4.51,4.51,0,0,0,3.19,1.35,4.57,4.57,0,0,0,4.54-4.54V71.4M54.92,20.88a4.51,4.51,0,0,0-3.19,1.35L28.12,45.85H9.54A4.57,4.57,0,0,0,5,50.38V77.62a4.57,4.57,0,0,0,4.54,4.54H22.26l37.2-21.48V25.42a4.57,4.57,0,0,0-4.54-4.54"
|
||||||
|
fill="#d8d8d8"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M85.11,56.6l-7.87,4.54A10,10,0,0,1,77.62,64c0,8.58-8.23,7.09-8.23,12.48A4.53,4.53,0,0,0,73.93,81a4,4,0,0,0,1.77-.35A18.13,18.13,0,0,0,86.69,64a18.34,18.34,0,0,0-1.59-7.4M73.93,47a4.52,4.52,0,0,0-4.54,4.54,3.92,3.92,0,0,0,1.08,2.8l8.76-5.06a16.14,16.14,0,0,0-3.52-1.93A4,4,0,0,0,73.93,47"
|
||||||
|
fill="#d8d8d8"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M100.87,47.49,93,52a27.15,27.15,0,0,1-8.36,33.87A36.79,36.79,0,0,1,79.25,89a4.54,4.54,0,0,0,1.84,8.72,5.24,5.24,0,0,0,1.77-.35,36.34,36.34,0,0,0,18-49.91M81,30.25A4.54,4.54,0,0,0,79.25,39a36.82,36.82,0,0,1,5.39,3.12,27,27,0,0,1,2.86,2.4l8.14-4.7A35.37,35.37,0,0,0,82.86,30.6,5.31,5.31,0,0,0,81,30.25"
|
||||||
|
fill="#d8d8d8"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M126.57,43.71,10.42,110.77a2.88,2.88,0,0,1-3.93-1.05L4.33,106A2.88,2.88,0,0,1,5.38,102L121.53,35A2.88,2.88,0,0,1,125.46,36l2.16,3.75A2.88,2.88,0,0,1,126.57,43.71Z"
|
||||||
|
fill="#c9070a"
|
||||||
|
/>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
) : client.properties.inputHardware == false ? (
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128">
|
||||||
|
<title>muted_hardware_input</title>
|
||||||
|
<g id="muted_hardware_input.svg">
|
||||||
|
<path
|
||||||
|
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" />
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
) : client.properties.outputMuted ? (
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128">
|
||||||
|
<title>muted_output</title>
|
||||||
|
<g id="muted_output">
|
||||||
|
<path
|
||||||
|
d="M116.62,39a4.78,4.78,0,0,1-1.59.3l-6.29,3.63a45.42,45.42,0,0,1-13.33,57.64,49.4,49.4,0,0,1-5.82,3.62c-1.06.57-2.2.92-3.19,1.49-1.7,1-2.77,2.13-2.77,4.18a4.57,4.57,0,0,0,4.54,4.54,5.33,5.33,0,0,0,1.84-.35,54.49,54.49,0,0,0,26.94-75c-.12,0-.22,0-.34,0M88.18,13.58a4.57,4.57,0,0,0-4.54,4.54c0,2.06,1.06,3.19,2.77,4.18,1,.57,2.13.92,3.19,1.49a49.4,49.4,0,0,1,5.82,3.62,45.68,45.68,0,0,1,8.19,7.78l7-4a2.63,2.63,0,0,1,1.11-.34A54.31,54.31,0,0,0,90,13.94a5.33,5.33,0,0,0-1.84-.35"
|
||||||
|
fill="#c9070a"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M59.46,71.4,32.77,86.81l19,19a4.51,4.51,0,0,0,3.19,1.35,4.57,4.57,0,0,0,4.54-4.54V71.4M54.92,20.88a4.51,4.51,0,0,0-3.19,1.35L28.11,45.85H9.53A4.57,4.57,0,0,0,5,50.38V77.62a4.57,4.57,0,0,0,4.54,4.54H22.25l37.2-21.48V25.42a4.57,4.57,0,0,0-4.54-4.54"
|
||||||
|
fill="#c9070a"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M85.1,56.6l-7.87,4.54A10,10,0,0,1,77.61,64c0,8.58-8.23,7.09-8.23,12.48A4.53,4.53,0,0,0,73.92,81a4,4,0,0,0,1.77-.35A18.13,18.13,0,0,0,86.69,64a18.34,18.34,0,0,0-1.59-7.4M73.92,47a4.52,4.52,0,0,0-4.54,4.54,3.92,3.92,0,0,0,1.08,2.8l8.76-5.06a16.14,16.14,0,0,0-3.52-1.93A4,4,0,0,0,73.92,47"
|
||||||
|
fill="#c9070a"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M100.87,47.49,93,52a27.15,27.15,0,0,1-8.36,33.87A36.79,36.79,0,0,1,79.24,89a4.54,4.54,0,0,0,1.84,8.72,5.24,5.24,0,0,0,1.77-.35,36.34,36.34,0,0,0,18-49.91M81,30.25A4.54,4.54,0,0,0,79.24,39a36.82,36.82,0,0,1,5.39,3.12,27,27,0,0,1,2.86,2.4l8.14-4.7A35.37,35.37,0,0,0,82.86,30.6,5.31,5.31,0,0,0,81,30.25"
|
||||||
|
fill="#c9070a"
|
||||||
|
/>
|
||||||
|
<path
|
||||||
|
d="M126.57,43.71,10.42,110.77a2.88,2.88,0,0,1-3.93-1.05L4.33,106A2.88,2.88,0,0,1,5.38,102L121.53,35A2.88,2.88,0,0,1,125.46,36l2.16,3.75A2.88,2.88,0,0,1,126.57,43.71Z"
|
||||||
|
fill="#c9070a"
|
||||||
|
/>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
) : client.properties.inputMuted ? (
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128">
|
||||||
|
<title>muted_input</title>
|
||||||
|
<g id="muted_input.svg">
|
||||||
|
<path
|
||||||
|
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="#c9070a"
|
||||||
|
/>
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
) : client.talkStatus == 1 ? (
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128">
|
||||||
|
<title>player_on_v2</title>
|
||||||
|
<g id="player_on_v2.svg">
|
||||||
|
<path d="M64,128a64,64,0,1,1,64-64A64,64,0,0,1,64,128Z" fill="#00b4df" />
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
) : (
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128">
|
||||||
|
<title>player_off_v2</title>
|
||||||
|
<g id="player_off_v2.svg">
|
||||||
|
<path d="M64,128a64,64,0,1,1,64-64A64,64,0,0,1,64,128Z" fill="#3e4f5e" />
|
||||||
|
</g>
|
||||||
|
</svg>
|
||||||
|
)}
|
||||||
|
<p>{client.properties.nickname}</p>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
return <div key={Math.random()}></div>;
|
||||||
|
}
|
||||||
|
})}
|
||||||
|
{currentChannel == null ? (
|
||||||
|
<>
|
||||||
|
<h4>Overlay couldn't connect to the client:</h4>
|
||||||
|
<br />
|
||||||
|
<br />
|
||||||
|
<h5>1. Make sure to accept the overlay in your TeamSpeak-Client via the notifications</h5>
|
||||||
|
<br />
|
||||||
|
<h5>2. Enable remote apps inside the the TeamSpeak-Settings</h5>
|
||||||
|
<br />
|
||||||
|
<h5>3. Make sure to match the configuration port with the port in the TeamSpeak remote app settings</h5>
|
||||||
|
<br />
|
||||||
|
<h5>4. Refresh this page/BrowserSource (Select BrowserSource & click "Refresh" in OBS)</h5>
|
||||||
|
<br />
|
||||||
|
<h6>If non of this worked refer to the GitHub and write an issue with your problem</h6>
|
||||||
|
</>
|
||||||
|
) : (
|
||||||
|
""
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
10
src/main.tsx
Normal file
10
src/main.tsx
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
import ReactDOM from "react-dom/client";
|
||||||
|
import App from "./App.tsx";
|
||||||
|
import "@styles/index.scss";
|
||||||
|
import { HashRouter } from "react-router-dom";
|
||||||
|
|
||||||
|
ReactDOM.createRoot(document.getElementById("root")!).render(
|
||||||
|
<HashRouter>
|
||||||
|
<App />
|
||||||
|
</HashRouter>
|
||||||
|
);
|
||||||
271
src/styles/Generator.scss
Normal file
271
src/styles/Generator.scss
Normal file
@@ -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;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
52
src/styles/Viewer.scss
Normal file
52
src/styles/Viewer.scss
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
//* 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;
|
||||||
|
padding: 0.5rem;
|
||||||
|
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
|
||||||
|
.client {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: row;
|
||||||
|
gap: 0 0;
|
||||||
|
align-items: center;
|
||||||
|
margin: 0.5rem 0;
|
||||||
|
|
||||||
|
// icon styles
|
||||||
|
svg {
|
||||||
|
width: 5vw;
|
||||||
|
aspect-ratio: 1/1;
|
||||||
|
margin-right: 0.5rem;
|
||||||
|
filter: drop-shadow(0 0 0.75rem rgba(15, 15, 15, 0.1));
|
||||||
|
}
|
||||||
|
|
||||||
|
// client name styles
|
||||||
|
p {
|
||||||
|
font-size: 5vw;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
109
src/styles/index.scss
Normal file
109
src/styles/index.scss
Normal file
@@ -0,0 +1,109 @@
|
|||||||
|
// Reset styles for all elements
|
||||||
|
* {
|
||||||
|
font-family: Arial, Helvetica, sans-serif;
|
||||||
|
font-weight: bold;
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
|
||||||
|
h5 {
|
||||||
|
font-size: 1rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
h6 {
|
||||||
|
font-size: 0.9rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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;
|
||||||
|
}
|
||||||
|
}
|
||||||
31
src/utils/logger.tsx
Normal file
31
src/utils/logger.tsx
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
export default class Logger {
|
||||||
|
// Log message to the console
|
||||||
|
public static log(message: string, data: object | null = null): void {
|
||||||
|
console.log(`[Log] %c${message}`.trim(), "color: gray", data ?? "");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Log warning to the console
|
||||||
|
public static warn(message: string, data: object | null = null): void {
|
||||||
|
console.warn(`%c${message}`.trim(), data ?? "");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Log error to the console
|
||||||
|
public static error(message: string, data: object | null = null): void {
|
||||||
|
console.error(`%c${message}`.trim(), data ?? "");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Log message received from the websocket to the console
|
||||||
|
public static wsReceived(data: object, message: string | undefined = undefined): void {
|
||||||
|
console.log(`%c[WS Recieved] ${message ?? ""}`.trim(), "color: #8258c7", data);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Log message sent to the websocket to the console
|
||||||
|
public static wsSent(data: object, message: string | undefined = undefined): void {
|
||||||
|
console.log(`%c[WS Sent] ${message ?? ""}`.trim(), "color: #4eb570", data);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Log message to the console with a timestamp
|
||||||
|
public static ts(message: string, data: object | null = null): void {
|
||||||
|
console.log(`%c[TS] ${message}`.trim(), "color: #2e6bc7", data ?? "");
|
||||||
|
}
|
||||||
|
}
|
||||||
1
src/vite-env.d.ts
vendored
Normal file
1
src/vite-env.d.ts
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
/// <reference types="vite/client" />
|
||||||
37
tsconfig.json
Normal file
37
tsconfig.json
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "ES2020",
|
||||||
|
"useDefineForClassFields": true,
|
||||||
|
"lib": ["ES2020", "DOM", "DOM.Iterable"],
|
||||||
|
"module": "ESNext",
|
||||||
|
"skipLibCheck": true,
|
||||||
|
|
||||||
|
"baseUrl": ".",
|
||||||
|
"paths": {
|
||||||
|
"@/*": ["src/*"],
|
||||||
|
"@components/*": ["src/components/*"],
|
||||||
|
"@assets/*": ["src/assets/*"],
|
||||||
|
"@styles/*": ["src/styles/*"],
|
||||||
|
"@utils/*": ["src/utils/*"],
|
||||||
|
"@interfaces/*": ["src/interfaces/*"],
|
||||||
|
"@handlers/*": ["src/handlers/*"]
|
||||||
|
},
|
||||||
|
|
||||||
|
/* Bundler mode */
|
||||||
|
"moduleResolution": "Node",
|
||||||
|
"allowSyntheticDefaultImports": true,
|
||||||
|
"allowImportingTsExtensions": true,
|
||||||
|
"resolveJsonModule": true,
|
||||||
|
"isolatedModules": true,
|
||||||
|
"noEmit": true,
|
||||||
|
"jsx": "react-jsx",
|
||||||
|
|
||||||
|
/* Linting */
|
||||||
|
"strict": true,
|
||||||
|
"noUnusedLocals": false,
|
||||||
|
"noUnusedParameters": true,
|
||||||
|
"noFallthroughCasesInSwitch": true
|
||||||
|
},
|
||||||
|
"include": ["src"],
|
||||||
|
"references": [{ "path": "./tsconfig.node.json" }]
|
||||||
|
}
|
||||||
10
tsconfig.node.json
Normal file
10
tsconfig.node.json
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"composite": true,
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"module": "ESNext",
|
||||||
|
"moduleResolution": "bundler",
|
||||||
|
"allowSyntheticDefaultImports": true
|
||||||
|
},
|
||||||
|
"include": ["vite.config.ts"]
|
||||||
|
}
|
||||||
24
vite.config.ts
Normal file
24
vite.config.ts
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
import { defineConfig } from 'vite'
|
||||||
|
import react from '@vitejs/plugin-react-swc'
|
||||||
|
import path from 'path';
|
||||||
|
|
||||||
|
// https://vitejs.dev/config/
|
||||||
|
export default defineConfig({
|
||||||
|
base: "./",
|
||||||
|
resolve: {
|
||||||
|
alias: {
|
||||||
|
'@': path.resolve(__dirname, './src'),
|
||||||
|
'@assets': path.resolve(__dirname, './src/assets'),
|
||||||
|
'@components': path.resolve(__dirname, './src/components'),
|
||||||
|
'@handlers': path.resolve(__dirname, './src/handlers'),
|
||||||
|
'@interfaces': path.resolve(__dirname, './src/interfaces'),
|
||||||
|
'@utils': path.resolve(__dirname, './src/utils'),
|
||||||
|
'@styles': path.resolve(__dirname, './src/styles'),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
build: {
|
||||||
|
outDir: 'dist',
|
||||||
|
emptyOutDir: true,
|
||||||
|
},
|
||||||
|
plugins: [react()],
|
||||||
|
})
|
||||||
Reference in New Issue
Block a user