README angepasst

This commit is contained in:
2026-08-13 09:35:32 +02:00
parent 1533dd7c55
commit 20521febd5
6 changed files with 104 additions and 39 deletions
+25 -4
View File
@@ -1,4 +1,25 @@
Verfügbare Parameter:
user (Username, case-insensitive)
speed (je höher, desto langsamer)
bg (HEX-Code der Hintergrundfarbe)
# Ninji Leaderboard Ticker URL-Parameter
Der Ticker lässt sich flexibel über URL-Parameter anpassen, um ihn perfekt in dein Stream-Overlay (z. B. OBS Studio per Browser-Source) einzubinden.
### Verfügbare Parameter
| Parameter | Beschreibung | Standardwert | Beispiel |
| :--- | :--- | :--- | :--- |
| `user` | Twitch- bzw. Spielername, für den die Daten geladen und das Highlight (Fett/Rahmen) aktiviert werden. | `kaizobrothers` | `?user=kaizobrothers` |
| `speed` | Basis-Geschwindigkeit des Tickers in Sekunden (Referenzwert für 10 Karten). Skaliert automatisch mit der Anzahl der Karten, damit die Laufgeschwindigkeit konstant bleibt. | `20` | `?speed=15` |
| `bg` | Hintergrundfarbe der Seite (ideal für Chroma-Keying). Akzeptiert Hex-Codes (mit oder ohne `#`). | `00ff00` (Grün) | `?bg=1e1b4b` oder `?bg=000000` |
| `framecolor` | Farbe des harten Rahmens für das Highlight der Spielerkarte. | `000000` (Schwarz) | `?framecolor=ffffff` |
| `fix` | Fixiert die Karte des aktuellen Users fest auf einer Seite. Der Rest des Leaderboards scrollt dazwischen durch. | *Keine* (scrollt mit) | `?fix=left` oder `?fix=right` |
| `fixdivision` | Fixiert die Divisions-Karte fest auf einer Seite. | *Keine* (scrollt mit) | `?fixdivision=left` oder `?fixdivision=right` |
| `showdivision` | Zeigt das Divisions-Icon zusätzlich bei *jeder einzelnen* Spielerkarte an. | `false` | `?showdivision=true` |
| `showtimes` | Steuert, ob die Einzeltzeiten (P1 & P2) angezeigt werden (`true`) oder ob nur die Gesamtzeit zu sehen ist (`false`). | `true` | `?showtimes=false` |
| `fontsize` | Legt die Schriftgröße fest (skaliert Icons automatisch proportional mit). | `0.9rem` | `?fontsize=14px` oder `?fontsize=1rem` |
| `height` | Steuert den inneren vertikalen Abstand (Padding) der Karten, um die Höhe des Tickers anzupassen. | `6px` | `?height=4px` oder `?height=10px` |
### Kombinationsbeispiel
Ein kompletter Link für ein Overlay mit grünem Hintergrund, fixiertem User links, fixierter Division rechts, ausgeblendeten Zwischenzeiten und angepasster Schriftgröße:
```text
https://overlay.kaizobrothers.de/ninjiclassic.html?user=kaizobrothers&bg=00ff00&framecolor=000000&fix=left&fixdivision=right&showtimes=false&fontsize=14px