Struktur, Doku und S0-Toolchain fuer das abdulive-Toolkit

Monorepo-Geruest fuer neun Streamer-Tools plus den Ingest-Daemon, der
unter sechs davon liegt. Enthaelt:

- docs/: Ueberblick, Architektur, Twitch-Integration, Datenmodell,
  Roadmap, Setup, Hebel-Analyse und den MVP-Plan "Clip-Knopf"
- docs/projects/: je eine Spezifikation pro Tool
- docs/decisions/: vier ADRs (TS-Monorepo, SQLite, EventSub/IRC, Docker)
- docker/: Image mit ffmpeg und whisper.cpp, abhaengigkeitsfreier
  Entrypoint mit check-env, fetch-model und calibrate
- config/layout.yaml: aus einem VOD-Screenshot eingemessener
  Facecam-Ausschnitt (440x330 oben links, Chat-Overlay ab x=1270)

Noch kein Anwendungscode - Scheibe S0 aus docs/07-mvp-plan.md.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013VTGjd92LsDDWF3frd9FTB
This commit is contained in:
ZeasyAlexandClaude Opus 5 committed 2026-09-09 08:56:09 +02:00
commit d09e2b945a
98 files changed
+3273

No files matched your search

+108
View File
@@ -0,0 +1,108 @@
# Setup
Alles läuft in Containern. Auf dem Rechner selbst wird nur Docker Desktop und
OBS gebraucht — ffmpeg, whisper.cpp, Node und pnpm stecken im Image.
Begründung: [ADR-0004](decisions/ADR-0004-docker.md).
## Voraussetzungen
| Was | Version | Wo |
|---|---|---|
| Docker Desktop | aktuell, WSL2-Backend | Host |
| OBS Studio | 30+ mit obs-websocket v5 | Host |
| Git | beliebig | Host |
Alles Weitere (Node 22, pnpm, ffmpeg mit libx264/libass, whisper.cpp,
Sprachmodell) liefert das Image.
## WSL2 begrenzen
Docker Desktop startet eine VM, die sich ohne Grenze so viel RAM nimmt, wie sie
kriegen kann. Auf einem Stream-PC ist das nicht egal. `%USERPROFILE%\.wslconfig`
anlegen:
```ini
[wsl2]
memory=4GB
processors=4
swap=2GB
```
Danach `wsl --shutdown` und Docker Desktop neu starten.
## Twitch-Apps anlegen
Zwei Anwendungen unter https://dev.twitch.tv/console/apps:
1. `abdulive-toolkit` — OAuth Redirect `http://localhost:4780/callback`
2. `abdulive-bot` — gleicher Redirect
Client-ID und Client-Secret beider Apps in `.env` eintragen
(Vorlage: `.env.example`).
## OBS vorbereiten
1. **obs-websocket aktivieren:** Werkzeuge → WebSocket-Servereinstellungen →
Server aktivieren, Port 4455, Passwort setzen und in `.env` eintragen.
2. **Wiedergabepuffer aktivieren:** Einstellungen → Ausgabe → Wiedergabepuffer,
90 Sekunden. Den Zielordner merken und in `.env` als `OBS_REPLAY_DIR`
eintragen — mit Forward-Slashes, z. B. `C:/Users/abdu/Videos/replay`.
3. **Hotkey setzen:** Einstellungen → Hotkeys → „Wiedergabepuffer speichern".
Das ist der Clip-Knopf. Ein globaler Windows-Hotkey wird bewusst *nicht*
gebaut — aus einem Container ist er nicht abfangbar, und OBS meldet den
gespeicherten Puffer ohnehin über WebSocket.
4. **Browser-Sources** (erst ab Meilenstein M3 relevant): „Browser-Quelle beim
Szenenwechsel neu laden" **aus**, sonst brechen laufende Effekte ab.
## Erste Einrichtung
```powershell
Copy-Item .env.example .env # Secrets und OBS_REPLAY_DIR eintragen
Copy-Item config\config.example.yaml config\config.yaml
docker compose build
docker compose run --rm toolkit check-env # prueft ffmpeg, whisper, Modell, Volumes
docker compose run --rm --service-ports toolkit auth # Browser oeffnet sich, zweimal bestaetigen
docker compose run --rm toolkit db:migrate
```
Der `auth`-Lauf braucht `--service-ports`, damit Port 4780 für den
OAuth-Rücksprung erreichbar ist.
## Facecam einmessen
Einmalig, sobald eine Replay-Datei vorliegt:
```powershell
docker compose run --rm toolkit calibrate
```
Legt einen Frame als PNG in `data/clips/_calibration/` ab, fragt die vier
Crop-Werte ab und schreibt sie nach `config/layout.yaml`.
## Betrieb
```powershell
docker compose up -d # startet
docker compose logs -f # Logs
docker compose down # stoppt
```
Sichtungsseite: http://localhost:4792
## Backup
```powershell
.\scripts\backup.ps1
```
Kopiert die Datenbank per `VACUUM INTO` aus dem Volume `abdulive-db` nach
`data/db/backup/` und hält 30 Generationen. Die DB liegt bewusst in einem
Docker-Volume und nicht in einem Windows-Ordner — Dateisperren über die
WSL2-Brücke sind für SQLite nicht verlässlich.
## Was nicht ins Repo gehört
`.env`, `config/config.yaml`, alles unter `data/`. Steht in `.gitignore`.
Die Datenbank enthält personenbezogene Daten (Chatverläufe, Notizen zu
Zuschauern) und darf nicht committet oder geteilt werden.