ZeasyAlexandClaude Opus 5.5
d00550aa37
Raid-Scout, Auswertung, VOD-Kapitel, Community-Gedaechtnis, Punkteshop und Recap samt Platzhaltern, Spezifikationen und Konfiguration. Der Hub schickt am Chat zusaetzlich die Sendezeit mit, fuer die Uhrzeit im Pult. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
100 lines
4.3 KiB
Markdown
100 lines
4.3 KiB
Markdown
# abdulive-toolkit
|
||
|
||
Werkzeugkasten für den Twitch-Kanal **abdulive_**. Ein Monorepo mit mehreren
|
||
kleinen Diensten, die sich einen gemeinsamen Kern teilen: Twitch-Auth,
|
||
Helix-Client, EventSub/IRC-Ingest und eine SQLite-Datenbank.
|
||
|
||
TypeScript auf Node 24, **ohne Laufzeitabhängigkeiten und ohne Build-Schritt** —
|
||
Node führt die `.ts`-Dateien direkt aus, SQLite und WebSocket sind eingebaut.
|
||
Betrieb über Docker Compose.
|
||
|
||
Zielgröße des Kanals: ~5–30 gleichzeitige Zuschauer. Alles hier ist auf diese
|
||
Phase optimiert — nicht auf Skalierung, sondern auf **Wachstum und Bindung**.
|
||
|
||
## Was es gibt
|
||
|
||
| Teil | Ordner | Zweck |
|
||
|------|--------|-------|
|
||
| Hub | `apps/hub` | Läuft zentral im LXC: Chat, Overlay für OBS, Pult, Kanalpunkte, Discord, Go-Live-Ping |
|
||
| Overlay und Pult | `apps/overlay-server` + `apps/overlay-web` | Browser-Sources für OBS, Pult am Handy und Tablet |
|
||
| Go-Live-Ping | `apps/broadcaster` | Stream-Start → Discord |
|
||
| Ingest | `apps/ingest` | Läuft auf dem Stream-PC: OBS-Anbindung, `!clip`, 9:16-Render mit Untertiteln |
|
||
|
||
Die früher geplanten Werkzeuge (Raid-Scout, Auswertung, VOD-Kapitel,
|
||
Community-Gedächtnis, Punkteshop, Recap) sind gestrichen und mit ihren
|
||
Spezifikationen entfernt.
|
||
|
||
## Doku
|
||
|
||
- [`docs/00-overview.md`](docs/00-overview.md) — Was hier gebaut wird und warum
|
||
- [`docs/01-architecture.md`](docs/01-architecture.md) — Aufbau, Datenfluss, Prozesse
|
||
- [`docs/02-twitch-integration.md`](docs/02-twitch-integration.md) — Auth, Scopes, EventSub, Rate Limits
|
||
- [`docs/03-data-model.md`](docs/03-data-model.md) — Datenbankschema
|
||
- [`docs/04-roadmap.md`](docs/04-roadmap.md) — Reihenfolge und Meilensteine
|
||
- [`docs/05-setup.md`](docs/05-setup.md) — Lokal einrichten
|
||
- [`docs/06-hebel-analyse.md`](docs/06-hebel-analyse.md) — **Womit anfangen und warum**
|
||
- [`docs/07-mvp-plan.md`](docs/07-mvp-plan.md) — **MVP „Clip-Knopf": Umfang, Scheiben, Zeitplan**
|
||
- [`docs/handoff.md`](docs/handoff.md) — **Übergabe: Stand, Fallstricke, wo weitermachen**
|
||
- [`docs/offene-punkte.md`](docs/offene-punkte.md) — was noch fehlt
|
||
- [`docs/obs-layout.md`](docs/obs-layout.md) — die Layout-Vorgabe für OBS
|
||
- [`docs/projects/`](docs/projects/) — je ein Spec-Dokument pro Tool
|
||
- [`docs/projects/discord-community.md`](docs/projects/discord-community.md) — Aufbau des Community-Servers
|
||
- [`docs/decisions/`](docs/decisions/) — Architekturentscheidungen (ADRs)
|
||
|
||
## Auf dem Stream-PC installieren
|
||
|
||
Eine native Windows-Anwendung. Node, ffmpeg, whisper.cpp und die Schriften
|
||
sind mitgeliefert — vorausgesetzt wird nur OBS. Kein Docker, kein WSL2, nichts
|
||
zu übersetzen ([ADR-0007](docs/decisions/ADR-0007-native-windows.md)).
|
||
|
||
Ein Befehl, ohne Administratorrechte. Programm und Daten landen im
|
||
Benutzerprofil.
|
||
|
||
```powershell
|
||
irm https://git.zeasy.dev/ZeasyAlex/abdulive/raw/branch/main/scripts/install.ps1 | iex
|
||
```
|
||
|
||
Kein Netz auf dem Stream-PC? Dann das Paket von der Releases-Seite laden,
|
||
entpacken und darin `install.ps1` ausführen.
|
||
|
||
Der Installer lädt danach das Sprachmodell, läuft den Selbsttest, startet
|
||
den Daemon und öffnet die Einrichtungsseite. Ein Befehl, und du bist da.
|
||
|
||
Dort die Twitch-Zugangsdaten eintragen. Sie werden verschlüsselt abgelegt,
|
||
nicht in einer Datei im Projekt
|
||
([ADR-0005](docs/decisions/ADR-0005-zugangsdaten.md)).
|
||
|
||
Ausführlich: [`docs/05-setup.md`](docs/05-setup.md).
|
||
|
||
## Paket bauen und ausliefern
|
||
|
||
```powershell
|
||
node scripts/build-package.ts --version 0.5.0
|
||
```
|
||
|
||
Lädt Node, ffmpeg und whisper.cpp bei ihren Herausgebern, packt alles nach
|
||
`dist/` und schreibt `abdulive.json` — das Manifest, das der Updater auf
|
||
Abdus Rechner abfragt. Läuft auch in der CI unter Linux.
|
||
|
||
Auf dem Stream-PC sieht `abdulive update` täglich nach und legt eine neue
|
||
Fassung bereit; eingespielt wird sie beim nächsten Start, nie mitten im
|
||
Stream.
|
||
|
||
## Aktueller Stand
|
||
|
||
Vier von sieben Scheiben des MVP „Clip-Knopf" sind gebaut: Toolchain,
|
||
Einrichtung im Browser, Twitch-Auth, Datenbank, Chat-Aufnahme, OBS-Anbindung mit
|
||
`!clip`, 9:16-Render und Untertitel. Dazu die native Auslieferung mit Installer
|
||
und Updater. 79 Tests grün.
|
||
|
||
Offen: die Abnahme der OBS-Anbindung an einem laufenden OBS, dann S5 —
|
||
Onboarding-Assistent und Sichtungsseite.
|
||
|
||
Details: [`docs/handoff.md`](docs/handoff.md)
|
||
|
||
## Tests
|
||
|
||
```powershell
|
||
node --test "packages/**/*.test.ts" "apps/**/*.test.ts"
|
||
```
|