aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9b1fea9..55ca02d 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,7 @@ The following binaries must be available on `PATH`:
23- `ffmpeg` — audio decoding/encoding for playback, conversion, and compression 23- `ffmpeg` — audio decoding/encoding for playback, conversion, and compression
24- `qalc` (Qalculate) — used by `/math` to evaluate expressions 24- `qalc` (Qalculate) — used by `/math` to evaluate expressions
25- `yt-dlp` (optional) — used by `/download` 25- `yt-dlp` (optional) — used by `/download`
26- `piper` (optional) — local TTS for `/tts` and `/senator ... tts_vc`; falls back to Google Translate TTS if unavailable
26 27
27Unlike the Python version, QR encode/decode is handled by the pure-Rust 28Unlike the Python version, QR encode/decode is handled by the pure-Rust
28`qrcode`/`rxing` crates — no `zbar` system library required. 29`qrcode`/`rxing` crates — no `zbar` system library required.
@@ -44,6 +45,11 @@ On launch, missing variables are reported via tracing (`error!` for required,
44`warn!` for optional with defaults). The database and schema migrations are 45`warn!` for optional with defaults). The database and schema migrations are
45created automatically on first run. 46created automatically on first run.
46 47
48For local TTS, set `TTS_MODEL_PATH` to a Piper `.onnx` model file (or a
49directory of models, in which case `TTS_VOICE` selects the model, defaulting to
50`pl_PL-bass-high`). When `TTS_MODEL_PATH` is unset or Piper is unavailable, the
51bot falls back to Google Translate TTS.
52
47### 5. Run 53### 5. Run
48 54
49```bash 55```bash
@@ -65,7 +71,7 @@ servers.
65- `/join` — join the caller's voice channel 71- `/join` — join the caller's voice channel
66 72
67### TTS 73### TTS
68- `/tts` — Google Translate TTS (Polish), sent as a file or played in voice 74- `/tts` — local Piper TTS (Polish, Google Translate fallback), sent as a file or played in voice
69 75
70### Search & Web 76### Search & Web
71- `/web` — DuckDuckGo HTML scrape (soon to use 4get) 77- `/web` — DuckDuckGo HTML scrape (soon to use 4get)