From 7f9c057b056cc1cbbe092d903fcbfacf670f0c5d Mon Sep 17 00:00:00 2001 From: gpkvt Date: Thu, 11 Aug 2022 12:14:13 +0200 Subject: [PATCH] Improved README --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 90f4a78..9920458 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ A simple Twitch TTS bot ## Installation -Clone the repo, move/copy `./dist/tts.exe` into the main directory. Rename `config-dist.yml` to `config.yml` +1. Clone the repo, or download and unzip the newest [Release](https://gitlab.com/gpvkt/twitchtts/-/releases) +2. Rename/copy `config-dist.yml` to `config.yml` +3. (Optional) Move/copy `./dist/tts.exe` into the main directory (you can omit this step if you have Python installed) ## Configuration @@ -98,11 +100,11 @@ whitelist: - bar ``` -To disable the whitelist remove it from `config.yml` completely. If you just leave `whitelist:` without entries, everyone must be whitelisted using `!ptts`. The permit is temporarily until the bot restarts or the user is removed from the (temporary) whitelist using `!dtts`. +To disable the whitelist, remove it from `config.yml` completely. If you just leave `whitelist:` without entries, everyone must be whitelisted using `!ptts` (even broadcaster and mods). The permit is temporary until the bot restarts or (whichever happens first) if the user is removed from the whitelist using `!dtts`. ## Usage -Execute `tts.exe` (or `tts.py` if you have Python installed), open the TTS webpage in your browser (the URL depends on your `bind` and `port` configuration, usually it's just http://localhost). Click the `Init` button at the button of the TTS webpage (you should hear `Init complete`). +Execute `tts.exe` (or `tts.py` if you have Python installed), open the TTS webpage in your browser (the URL depends on your `bind` and `port` configuration, usually it's just http://localhost). Click the `Init` button at the bottom of the TTS webpage (you should hear `Init complete`). Connect to the configured Twitch channel and send a message starting with `!tts`. After a few seconds (depending on your `clearmsg_timeout` config), the message should be read. @@ -113,3 +115,13 @@ Additional commands (broadcaster and mods only) are: * `!dtts `: Disable TTS for the given user * `!ptts `: Allow TTS for the given user + +# Voices + +The voices available depends on your Operating System and/or browser. On some systems only a default voice is available and the `Select voice` dropdown might stay empty or will only show entries after you clicked the `Init` button. Some Android devices will show a huge list of voices, but sounds the same no matter which one you choose. + +On Windows you can install additional voices via `Settings` > `Time & language` > `Speech` > `Add voices` or by simply run `Add speech voices` + +# Troubleshooting + +Feel free to use the [Issuetracker](https://gitlab.com/gpvkt/twitchtts/-/issues) if you experience any problems.