vrr/talemate
2
0
Fork 0
mirror of https://github.com/vegu-ai/talemate.git synced 2025-09-02 18:39:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
talemate/docs/tts.md
fiwo 496eb469db
Prep 0.14.0 (#34) 
* tts agent first progress

* coqui support
voice lists

* orca-2

* tts tweaks

* switch to ux for audio gen

* some tweaks for the new audio queue

* fix error handling if llm fails to create a good world state on initial scene load

* loading creative mode for a new scene will now ask for confirmation if the current scene has unsaved progress

* local tts support

* fix voice list reloading when switching tts api
fix agent config ux to auto save on change, remove save / close buttons

* only do a delayed save on agent config on text input changes

* OrionStar

* dont allow scene loading when llm agents arent correctly configured

* wire summarization to game loop, summarizer agent configs

* fix issues with time passage

* editor fix narrator messages

* 0.14.0

* poetry lock

* requires_llm_client moved to cls property

* add additional config stubs

* tts still load voices even if the agent is disabled

* fix bugf that would keep losing voice selection for tts agent after backend restart

* update tts install requirements

* remove debug output
2023-11-24 22:08:13 +02:00

2.8 KiB
Raw Blame History

Talemate Text-to-Speech (TTS) Configuration

Talemate supports Text-to-Speech (TTS) functionality, allowing users to convert text into spoken audio. This document outlines the steps required to configure TTS for Talemate using different providers, including ElevenLabs, Coqui, and a local TTS API.

Configuring ElevenLabs TTS

To use ElevenLabs TTS with Talemate, follow these steps:

  1. Visit ElevenLabs and create an account if you don't already have one.
  2. Click on your profile in the upper right corner of the Eleven Labs website to access your API key.
  3. In the config.yaml file, under the elevenlabs section, set the api_key field with your ElevenLabs API key.

Example configuration snippet:

elevenlabs:
  api_key: <YOUR_ELEVENLABS_API_KEY>

Configuring Coqui TTS

To use Coqui TTS with Talemate, follow these steps:

  1. Visit Coqui and sign up for an account.
  2. Go to the account page and scroll to the bottom to find your API key.
  3. In the config.yaml file, under the coqui section, set the api_key field with your Coqui API key.

Example configuration snippet:

coqui:
  api_key: <YOUR_COQUI_API_KEY>

Configuring Local TTS API

For running a local TTS API, Talemate requires specific dependencies to be installed.

Windows Installation

Run install-local-tts.bat to install the necessary requirements.

Linux Installation

Execute the following command:

pip install TTS

Model and Device Configuration

  1. Choose a TTS model from the Coqui TTS model list.
  2. Decide whether to use cuda or cpu for the device setting.
  3. The first time you run TTS through the local API, it will download the specified model. Please note that this may take some time, and the download progress will be visible in the Talemate backend output.

Example configuration snippet:

tts:
  device: cuda # or 'cpu'
  model: tts_models/multilingual/multi-dataset/xtts_v2

Voice Samples Configuration

Configure voice samples by setting the value field to the path of a .wav file voice sample. Official samples can be downloaded from Coqui XTTS-v2 samples.

Example configuration snippet:

tts:
  voices:
    - label: English Male
      value: path/to/english_male.wav
    - label: English Female
      value: path/to/english_female.wav

Saving the Configuration

After configuring the config.yaml file, save your changes. Talemate will use the updated settings the next time it starts.

For more detailed information on configuring Talemate, refer to the config.py file in the Talemate source code and the config.example.yaml file for a barebone configuration example.