Files
abdulive/apps/hub/src/rewards.ts
T
ZeasyAlexandClaude Opus 5.5 63ea40d5a8 Vorlesen: Piper im Hub statt Sprachausgabe im Browser
In OBS' Browser-Quelle kam `speechSynthesis` amerikanisch heraus: der
eingebaute Browser sah keine deutsche Stimme, und die Seite nahm die erste
beliebige. Welche Stimmen es gibt, haengt am Rechner, der streamt.

Jetzt spricht der Hub mit Piper (lokal im LXC, 200 Zeichen in 0,7 s). Die
WAV liegt kurz im Speicher, `/tts` holt sie unter /tts/audio/<id> mit dem
Overlay-Schluessel und spielt sie ueber <audio> ab - das laeuft sicher ueber
OBS' Tonspur. Der Browser springt nur noch mit einer deutschen Stimme ein,
sonst wird nur angezeigt. Stimme und Sprecher stehen in rewards.tts.

Dazu:

- `abdulive rewards:anlegen`: Belohnung ueber die API anlegen. Nur die App,
  die sie angelegt hat, darf Einloesungen abschliessen oder erstatten.
- Einloesungen werden nach der Aktion als FULFILLED markiert, statt in
  Twitchs Warteschlange liegen zu bleiben.
- Wortfilter normalisiert vorher: Leetspeak, Punkte dazwischen, gezogene
  Buchstaben, Akzente. Kurze Eintraege nur am Wortanfang.
- Der Testknopf "Vorlesen" geht durch Piper und prueft so die echte Stimme.
- scripts/install-piper.sh richtet Piper und Stimme im LXC ein.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-09-23 22:58:36 +02:00

246 lines
8.6 KiB
TypeScript

// Was bei einer Kanalpunkt-Einloesung passiert.
//
// Der Weg: EventSub meldet die Einloesung -> hier wird sie einer Aktion aus
// der Konfiguration zugeordnet -> die Aktion laeuft, oder sie landet in der
// Warteschlange und wartet auf Abdus Klick.
//
// Zur Zuordnung: Belohnungen werden ueber ihren Titel gefunden, wahlweise
// ueber die ID. Der Titel ist lesbar und laesst sich in der Konfiguration
// wiedererkennen, kann sich aber aendern; die ID ist stabil, aber
// nichtssagend. Deshalb beides, und die ID gewinnt.
//
// Warum TTS eine Warteschlange hat, steht in docs/projects/chat-control.md:
// Kanalpunkte sammeln sich beim Zugucken von allein an und sind damit kaum
// eine Huerde. Wer beliebigen Fremdtext ungeprueft vorlesen laesst, hat eine
// Vorlesefunktion fuer Fremde im eigenen Stream.
import { logger } from '#core/logger.ts';
const log = logger('rewards');
/** Eine Einloesung, so weit sie hier gebraucht wird. */
export type Einloesung = {
id: string;
rewardId: string;
rewardTitle: string;
userId: string;
userName: string;
/** Der eingegebene Text. Leer, wenn die Belohnung keinen verlangt. */
text: string;
kosten: number;
ts: string;
};
export type AktionsArt = 'konfetti' | 'emote-regen' | 'einblendung' | 'tts' | 'nichts';
export type BelohnungsPlan = {
/** Titel der Belohnung auf Twitch. Gross-/Kleinschreibung egal. */
titel?: string;
/** Stabile Belohnungs-ID. Gewinnt gegen den Titel. */
id?: string;
aktion: AktionsArt;
/** Nur bei `tts`: ohne Freigabe wird sofort vorgelesen. */
freigabe?: boolean;
/** Nur bei `tts`: laengerer Text wird abgelehnt statt gekuerzt. */
maxZeichen?: number;
};
export type RewardsConfig = {
enabled: boolean;
belohnungen: BelohnungsPlan[];
tts: {
/** Vorgabe fuer `freigabe`, wenn eine Belohnung nichts anderes sagt. */
freigabe: boolean;
maxZeichen: number;
/** Woerter, die den Text ohne Nachfrage ablehnen. */
blockliste: string[];
/** So viele Einloesungen je Person und Stunde. */
proPersonProStunde: number;
};
};
/** Was mit einer Einloesung geschehen soll. Rein, damit pruefbar. */
export type Entscheidung =
| { art: 'ausfuehren'; aktion: Exclude<AktionsArt, 'tts' | 'nichts'>; plan: BelohnungsPlan }
| { art: 'vorlesen'; text: string }
| { art: 'warteschlange'; text: string }
| { art: 'abgelehnt'; grund: string }
| { art: 'unbekannt' };
/** Findet den Plan zu einer Einloesung. ID gewinnt, sonst der Titel. */
export function planFuer(
e: Pick<Einloesung, 'rewardId' | 'rewardTitle'>, plaene: BelohnungsPlan[],
): BelohnungsPlan | undefined {
return plaene.find((p) => p.id && p.id === e.rewardId)
?? plaene.find((p) => p.titel && p.titel.toLowerCase() === e.rewardTitle.toLowerCase());
}
export function entscheiden(
e: Einloesung,
cfg: RewardsConfig,
/** Wie oft diese Person in der letzten Stunde schon eingeloest hat. */
bisherigeDieseStunde = 0,
): Entscheidung {
if (!cfg.enabled) return { art: 'abgelehnt', grund: 'Belohnungs-Aktionen sind ausgeschaltet' };
const plan = planFuer(e, cfg.belohnungen);
// Unbekannte Belohnung heisst nicht "Fehler": Abdu darf Belohnungen anlegen,
// die mit dem Toolkit nichts zu tun haben. Sie werden protokolliert und
// sonst in Ruhe gelassen.
if (!plan) return { art: 'unbekannt' };
if (plan.aktion === 'nichts') return { art: 'unbekannt' };
if (plan.aktion !== 'tts') {
return { art: 'ausfuehren', aktion: plan.aktion, plan };
}
// ---- ab hier nur noch TTS
const text = e.text.trim();
if (!text) return { art: 'abgelehnt', grund: 'kein Text eingegeben' };
const max = plan.maxZeichen ?? cfg.tts.maxZeichen;
if (text.length > max) {
// Abschneiden waere schlimmer: dann wird ein halber Satz vorgelesen, und
// niemand weiss, ob der Rest Absicht war.
return { art: 'abgelehnt', grund: `zu lang (${text.length} von ${max} Zeichen)` };
}
if (wortfilterTreffer(text, cfg.tts.blockliste)) return { art: 'abgelehnt', grund: 'Wortfilter' };
if (bisherigeDieseStunde >= cfg.tts.proPersonProStunde) {
return { art: 'abgelehnt', grund: 'zu viele Einloesungen in der letzten Stunde' };
}
const freigabe = plan.freigabe ?? cfg.tts.freigabe;
return freigabe ? { art: 'warteschlange', text } : { art: 'vorlesen', text };
}
// ---------------------------------------------------------------- Wortfilter
const LEET: Record<string, string> = {
'0': 'o', '1': 'i', '3': 'e', '4': 'a', '5': 's', '7': 't', '8': 'b',
'@': 'a', '$': 's', '!': 'i', '|': 'i',
};
/**
* Text auf das bringen, was man hoert: klein, ohne Akzente, Leetspeak
* zurueckuebersetzt, Buchstabenketten auf einen gekuerzt. Wer "N 3 G G 3 R"
* oder "h.i.t.l.e.r" schreibt, will am Filter vorbei - vorgelesen klingt es
* trotzdem wie das Original.
*
* `mitLuecken` laesst Wortgrenzen als Leerzeichen stehen, sonst wird alles
* zusammengezogen.
*/
export function fuerFilter(text: string, mitLuecken: boolean): string {
return text
.toLowerCase()
.replace(/ß/g, 'ss')
.normalize('NFKD').replace(/\p{M}/gu, '')
.replace(/[0134578@$!|]/g, (c) => LEET[c] ?? c)
.replace(/[^a-z]+/g, mitLuecken ? ' ' : '')
.replace(/([a-z])\1+/g, '$1')
.trim();
}
/**
* Trifft der Text ein Wort der Blockliste?
*
* Lange Eintraege (ab 5 Buchstaben) werden im zusammengezogenen Text
* gesucht, damit Punkte und Leerzeichen dazwischen nicht helfen. Kurze nur
* am Wortanfang: zusammengezogen stuende "nazi" sonst auch in "kann azubi".
*/
export function wortfilterTreffer(text: string, blockliste: string[]): string | undefined {
const dicht = fuerFilter(text, false);
const woerter = fuerFilter(text, true).split(' ');
return blockliste.find((eintrag) => {
const e = fuerFilter(eintrag, false);
if (!e) return false;
return e.length >= 5 ? dicht.includes(e) : woerter.some((w) => w.startsWith(e));
});
}
// ---------------------------------------------------------------- Warteschlange
export type Wartend = {
id: string;
name: string;
text: string;
/** Fuer die Erstattung, falls abgelehnt wird. */
rewardId: string;
redemptionId: string;
seit: string;
};
export type Warteschlange = {
einreihen: (w: Wartend) => void;
/** Gibt den Eintrag zurueck, damit der Aufrufer ihn vorlesen lassen kann. */
entnehmen: (id: string) => Wartend | undefined;
liste: () => Wartend[];
leeren: () => Wartend[];
};
/**
* Wartende Nachrichten. Bewusst im Arbeitsspeicher: was beim Neustart
* verloren geht, war ohnehin nicht dringend, und eine Tabelle mit fremdem
* Text, die niemand aufraeumt, will hier niemand.
*/
export function createWarteschlange(maximal = 25): Warteschlange {
const wartend: Wartend[] = [];
return {
einreihen(w) {
wartend.push(w);
// Laeuft sie voll, faellt das Aelteste raus. Eine Warteschlange, die
// bei einem Ansturm auf 300 waechst, arbeitet Abdu nie ab.
while (wartend.length > maximal) {
const weg = wartend.shift();
if (weg) log.warn(`Warteschlange voll, aelteste Nachricht verworfen (${weg.name})`);
}
},
entnehmen(id) {
const i = wartend.findIndex((w) => w.id === id);
return i === -1 ? undefined : wartend.splice(i, 1)[0];
},
liste: () => [...wartend],
leeren: () => wartend.splice(0, wartend.length),
};
}
/**
* Zaehlt Einloesungen je Person in einem gleitenden Fenster.
* Braucht keine Datenbank - nach einem Neustart faengt das Fenster neu an,
* und das ist bei einer Stunde Fensterbreite egal.
*/
export function createDrossel(fensterMs = 3_600_000) {
const gesehen = new Map<string, number[]>();
return {
zaehlen(userId: string, jetzt = Date.now()): number {
const bisher = (gesehen.get(userId) ?? []).filter((t) => jetzt - t < fensterMs);
gesehen.set(userId, bisher);
return bisher.length;
},
merken(userId: string, jetzt = Date.now()): void {
const bisher = (gesehen.get(userId) ?? []).filter((t) => jetzt - t < fensterMs);
bisher.push(jetzt);
gesehen.set(userId, bisher);
},
};
}
/** Das EventSub-Ereignis in unsere Form bringen. */
export function ausEventSub(event: Record<string, unknown>): Einloesung | null {
const reward = event['reward'] as { id?: string; title?: string; cost?: number } | undefined;
const id = event['id'];
const userId = event['user_id'];
if (typeof id !== 'string' || typeof userId !== 'string' || !reward?.id) return null;
return {
id,
rewardId: reward.id,
rewardTitle: reward.title ?? '',
userId,
userName: String(event['user_name'] ?? event['user_login'] ?? ''),
text: String(event['user_input'] ?? ''),
kosten: Number(reward.cost ?? 0),
ts: String(event['redeemed_at'] ?? new Date().toISOString()),
};
}