Skip to content

Commit

Permalink
Enhancement: Description for changing TTS(#86)
Browse files Browse the repository at this point in the history
* Add description for local piper plugin

* Adding server-plugin description

* Adding small descriptions for each option
  • Loading branch information
BigYellowHammer authored Mar 5, 2024
1 parent bafacb2 commit dd73e40
Showing 1 changed file with 62 additions and 1 deletion.
63 changes: 62 additions & 1 deletion docs/092-ht_change_voice.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,64 @@
# How To Change Your Assistant's Voice

**WIP**
## Using TTS server plugin

### General
TTS server plugin is using services hosted by OVOS community:
https://openvoiceos.github.io/community-docs/325-members/#members-hosting-services

That reduces local resource consumption. Its recommended to use TTS server plugin for resource constraint hardware (eg. RPi 3)

> [!NOTE]
> You can host TTS server by yourself - check this [blog post for details](https://blog.graywind.org/posts/piper-tts-server-script/)
> The post is specifically for running Piper TTS, but could also be adapted to run [other TTS plugins](https://github.com/orgs/OpenVoiceOS/repositories?language=&q=tts-plugin&sort=&type=all).
### Changes
Open the file for editing. `nano ~/.config/mycroft/mycroft.conf`.

If your file is empty, or does not have a `"tts"` section, you need to create it. Add this to your config

```json
{
"tts": {
"ovos-tts-plugin-server": {
"voice": "amy-low"
}
}
}
```

For available voices please refer to [piper-voices section](#voices-available-for-piper-plugin)

## Using local piper plugin

### General
Local piper plugin does all Text-To-Speech translation on your local device.

### Changes
Open the file for editing. `nano ~/.config/mycroft/mycroft.conf`.

If your file is empty, or does not have a `"tts"` section, you need to create it. Add this to your config

```json
{
"tts": {
"module": "ovos-tts-plugin-piper",
"ovos-tts-plugin-piper": {
"voice": "alba-medium"
}
}
}
```

For available voices please refer to [piper-voices section](#voices-available-for-piper-plugin)

> [!WARNING]
> After a configuration change it's important to reload the audio service.
> (an example used with systemd services `systemctl --user restart ovos`)
>
> If your system is not using systemd - please refer to [relevant documentation](051-starting_modules.md)
# Voices available for [piper-plugin](https://github.com/OpenVoiceOS/ovos-tts-plugin-piper/)
List of available voices can be found [here](https://github.com/OpenVoiceOS/ovos-tts-plugin-piper/blob/dev/ovos_tts_plugin_piper/__init__.py#L155C8-L242C109).

You can listen to voice samples on the official piper site - https://rhasspy.github.io/piper-samples/

0 comments on commit dd73e40

Please sign in to comment.