From 6bcfda7188550aba1484eaa2f6236ecc63662b61 Mon Sep 17 00:00:00 2001 From: Sweaterdog Date: Tue, 18 Feb 2025 18:04:50 -0800 Subject: [PATCH] Update README.md Added TTS documentation to the Readme file --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index d2b473e..86047b7 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,21 @@ When running in docker, if you want the bot to join your local minecraft server, To connect to an unsupported minecraft version, you can try to use [viaproxy](services/viaproxy/README.md) +## TTS in Mindcraft + +TTS is an acronym for "Text To Speech", allowing you to talk into a microphone and the model responding. + +TTS can be enabled in `settings.js` under the section that looks like this: +```javascript + "tts_transcription": true, // Change this to "true" to enable TTS + "tts_username": "SYSTEM", + "tts_agent_name": "" +``` + +The Text to Speech engine will begin listening on the **system default input device**, ensure you have your preferred device set as the default. + +When using TTS, you **need** a [GroqCloud API key](https://console.groq.com/keys) as Groq is used for Audio transcription + # Bot Profiles Bot profiles are json files (such as `andy.json`) that define: