gpkvt
/
twitchtts
mirror of https://gitlab.com/gpvkt/twitchtts.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
gpkvt 2022-08-12 01:59:34 +00:00
parent a7bdc0c757
commit fd43fd26d5
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -68,9 +68,9 @@ whitelist:
``` ```
**Explanation**: #### Explanation
#### irc ##### irc
* `channel`: Channel you want to monitor (e.g. #gpkvt) * `channel`: Channel you want to monitor (e.g. #gpkvt)
* `username`: The bots username (e.g. gpkvt) * `username`: The bots username (e.g. gpkvt)
@ -78,18 +78,18 @@ whitelist:
* `server`: Twitch IRC server to be used (default should be fine) * `server`: Twitch IRC server to be used (default should be fine)
* `clearmsg_timeout`: Time to wait for an moderator to delete a message, before it's added to the TTS queue * `clearmsg_timeout`: Time to wait for an moderator to delete a message, before it's added to the TTS queue
#### http ##### http
* `port`: Internal Webserver Port to listen to (e.g. 8080) * `port`: Internal Webserver Port to listen to (e.g. 8080)
* `bind`: Interface/IP to bind server to (e.g. localhost) * `bind`: Interface/IP to bind server to (e.g. localhost)
#### bot ##### bot
* `subonly`: If `True` only Subs can use TTS * `subonly`: If `True` only Subs can use TTS
* `modonly`: If `True` only Mods can use TTS * `modonly`: If `True` only Mods can use TTS
* `message_length`: Maximum allowed message length for TTS * `message_length`: Maximum allowed message length for TTS
#### messages ##### messages
* `too_long`: The bots reply if message exceeds `message_length` * `too_long`: The bots reply if message exceeds `message_length`
* `disabled`: The bots reply if TTS is disabled * `disabled`: The bots reply if TTS is disabled
@ -99,17 +99,17 @@ whitelist:
* `ready`: The bots init message * `ready`: The bots init message
* `says`: Prefix to add between username and message * `says`: Prefix to add between username and message
#### log ##### log
* `level`: The loglevel, valid values are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL` * `level`: The loglevel, valid values are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`
#### usermapping ##### usermapping
Use this section to define key:value pairs of usernames. The first value is the Twitch username, the second value is how the bot should pronouce the user, when reading the message. This is helpfull if you have regulars with numbers or strangs chars in the name. You can add new/change entries on the fly without restarting the bot (changes took up to 60 seconds). Use this section to define key:value pairs of usernames. The first value is the Twitch username, the second value is how the bot should pronouce the user, when reading the message. This is helpfull if you have regulars with numbers or strangs chars in the name. You can add new/change entries on the fly without restarting the bot (changes took up to 60 seconds).
Please note: The key (real username) MUST be lowercase. Please note: The key (real username) MUST be lowercase.
### whitelist ##### whitelist
You can add a whitelist section to `config.yml`, a whitelist will override any other settings like `subonly` and `modonly`. Only users on the whitelist are allowed to use `!tts`. Broadcasters and mods can temporarily add users (including themselfs) to the whitelist by using the `!ptts` command, though. You can add a whitelist section to `config.yml`, a whitelist will override any other settings like `subonly` and `modonly`. Only users on the whitelist are allowed to use `!tts`. Broadcasters and mods can temporarily add users (including themselfs) to the whitelist by using the `!ptts` command, though.