summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGrail Finder <wohilas@gmail.com>2026-01-08 09:28:16 +0300
committerGrail Finder <wohilas@gmail.com>2026-01-08 09:28:16 +0300
commit51916895789fc2b166af752c14cd4696d6517bec (patch)
tree584d8612449a8a2e4185211ba9a9581e358d8386 /docs
parent5f0de6f3112d2bbda6af408cc5d6e51c0a752f88 (diff)
Feat: google-translate-tts support
Diffstat (limited to 'docs')
-rw-r--r--docs/config.md12
-rw-r--r--docs/tutorial_rp.md6
2 files changed, 15 insertions, 3 deletions
diff --git a/docs/config.md b/docs/config.md
index fa5d42b..f1cac5b 100644
--- a/docs/config.md
+++ b/docs/config.md
@@ -96,11 +96,21 @@ This document explains how to set up and configure the application using the `co
- Enable or disable text-to-speech functionality.
#### TTS_URL (`"http://localhost:8880/v1/audio/speech"`)
-- The endpoint for TTS API.
+- The endpoint for TTS API (used with `kokoro` provider).
#### TTS_SPEED (`1.2`)
- Playback speed for speech output (1.0 is normal speed).
+#### TTS_PROVIDER (`"kokoro"`)
+- TTS provider to use. Options: `"kokoro"` or `"google"`.
+ - `"kokoro"`: Uses Kokoro FastAPI TTS server (requires TTS_URL to be set). Provides high-quality voice synthesis but requires a running Kokoro server.
+ - `"google"`: Uses Google Translate TTS with gopxl/beep for local playback. Works offline using Google's public TTS API with local audio playback via gopxl/beep. Supports multiple languages via TTS_LANGUAGE setting.
+
+#### TTS_LANGUAGE (`"en"`)
+- Language code for TTS (used with `google` provider).
+ - Examples: `"en"` (English), `"es"` (Spanish), `"fr"` (French)
+ - See Google Translate TTS documentation for supported languages.
+
### Speech-to-Text (STT) Settings
#### STT_ENABLED (`false`)
diff --git a/docs/tutorial_rp.md b/docs/tutorial_rp.md
index 451aadb..9053ffb 100644
--- a/docs/tutorial_rp.md
+++ b/docs/tutorial_rp.md
@@ -1,5 +1,7 @@
-after [installing](https://github.com/GrailFinder/gf-lt/tree/master?tab=readme-ov-file#how-to-install)
-[set up your config](config.md)
+### RP case example
+
+check the (https://github.com/GrailFinder/gf-lt/tree/master?tab=readme-ov-file#how-to-install) and
+[setting up your config](config.md)
To roleplay, we would need to create a character card or get one from the web.
For this tutorial, we are going to use the default character Seraphina from [SillyTavern (ST)](https://github.com/SillyTavern/SillyTavern/blob/release/default/content/default_Seraphina.png).