mirror of https://gitlab.com/gpvkt/twitchtts.git
Updated markdown files
This commit is contained in:
parent
9ff464e9ec
commit
2b4da04127
16
CHANGELOG.md
16
CHANGELOG.md
|
@ -2,13 +2,13 @@
|
||||||
|
|
||||||
All notable changes to this project will be documented in this file. If there is a `Changed` section please read carefully, as this often means that you will need to adapt your `config.yml`, otherwise the bot might fail to start.
|
All notable changes to this project will be documented in this file. If there is a `Changed` section please read carefully, as this often means that you will need to adapt your `config.yml`, otherwise the bot might fail to start.
|
||||||
|
|
||||||
## [1.2.1] - unreleased
|
## [1.2.1] - 2022-08-13
|
||||||
|
|
||||||
### Changed
|
### Changed 1.2.1
|
||||||
|
|
||||||
* Reworked internal code structure
|
* Reworked internal code structure
|
||||||
|
|
||||||
### Fixed
|
### Fixed 1.2.1
|
||||||
|
|
||||||
* Publish vote info in chat when reloading config was not working when TTS was disabled
|
* Publish vote info in chat when reloading config was not working when TTS was disabled
|
||||||
* Casting votes was allowed for broadcaster and mods only
|
* Casting votes was allowed for broadcaster and mods only
|
||||||
|
@ -19,17 +19,17 @@ All notable changes to this project will be documented in this file. If there is
|
||||||
|
|
||||||
* `!random` feature (see README.md for details)
|
* `!random` feature (see README.md for details)
|
||||||
|
|
||||||
### Changed
|
### Changed 1.2.0
|
||||||
|
|
||||||
* The vote result will be read out
|
* The vote result will be read out
|
||||||
|
|
||||||
### Fixed
|
### Fixed 1.2.0
|
||||||
|
|
||||||
* Improved handling of missing config values.
|
* Improved handling of missing config values.
|
||||||
|
|
||||||
## [1.1.0] - 2022-08-12
|
## [1.1.0] - 2022-08-12
|
||||||
|
|
||||||
### Added
|
### Added 1.1.0
|
||||||
|
|
||||||
* `!quickvote` feature (see README.md for details)
|
* `!quickvote` feature (see README.md for details)
|
||||||
* `!ping` command added
|
* `!ping` command added
|
||||||
|
@ -37,12 +37,12 @@ All notable changes to this project will be documented in this file. If there is
|
||||||
* OAuth-Token generator
|
* OAuth-Token generator
|
||||||
* Webbrowser autostart
|
* Webbrowser autostart
|
||||||
|
|
||||||
### Changed
|
### Changed 1.1.0
|
||||||
|
|
||||||
* You need to review your `config.yml` as there a new config values added.
|
* You need to review your `config.yml` as there a new config values added.
|
||||||
* The bot replies with a chat message when `!ton` or `!toff` is used
|
* The bot replies with a chat message when `!ton` or `!toff` is used
|
||||||
|
|
||||||
### Fixed
|
### Fixed 1.1.0
|
||||||
|
|
||||||
* Improved error handling
|
* Improved error handling
|
||||||
|
|
||||||
|
|
12
README.md
12
README.md
|
@ -34,7 +34,7 @@ By using Javascript for the actual TTS part it's not only very easy to access th
|
||||||
|
|
||||||
Adapt `config.yml` to your needs. Example:
|
Adapt `config.yml` to your needs. Example:
|
||||||
|
|
||||||
```
|
``` lang=yaml
|
||||||
irc:
|
irc:
|
||||||
channel: "#gpkvt"
|
channel: "#gpkvt"
|
||||||
username: "ttsbot"
|
username: "ttsbot"
|
||||||
|
@ -139,7 +139,7 @@ You can add a whitelist section to `config.yml`, a whitelist will override any o
|
||||||
|
|
||||||
A whitelist looks as follows:
|
A whitelist looks as follows:
|
||||||
|
|
||||||
```
|
``` lang=yaml
|
||||||
whitelist:
|
whitelist:
|
||||||
- gpkvt
|
- gpkvt
|
||||||
- foo
|
- foo
|
||||||
|
@ -152,7 +152,7 @@ Please note: Usernames MUST be lowercase.
|
||||||
|
|
||||||
### Executing program
|
### Executing program
|
||||||
|
|
||||||
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 button 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.
|
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.
|
||||||
|
|
||||||
|
@ -211,9 +211,9 @@ This project is licensed under the GPLv3 License - see [LICENSE](https://gitlab.
|
||||||
|
|
||||||
### Ideas and Testing
|
### Ideas and Testing
|
||||||
|
|
||||||
* [GERBrowny and community](https://www.twitch.tv/gerbrowny/) ![](https://static-cdn.jtvnw.net/emoticons/v2/303172270/static/light/1.0)
|
* [GERBrowny and community](https://www.twitch.tv/gerbrowny/) ![Emote](https://static-cdn.jtvnw.net/emoticons/v2/303172270/static/light/1.0)
|
||||||
* [DerZugger and community](https://www.twitch.tv/derzugger/) ![](https://static-cdn.jtvnw.net/emoticons/v2/302400142/static/light/1.0)
|
* [DerZugger and community](https://www.twitch.tv/derzugger/) ![Emote](https://static-cdn.jtvnw.net/emoticons/v2/302400142/static/light/1.0)
|
||||||
* [Timmeh74 and community](https://www.twitch.tv/timmeh74/) ![](https://static-cdn.jtvnw.net/emoticons/v2/300192675/static/light/1.0)
|
* [Timmeh74 and community](https://www.twitch.tv/timmeh74/) ![Emote](https://static-cdn.jtvnw.net/emoticons/v2/300192675/static/light/1.0)
|
||||||
|
|
||||||
### Libraries
|
### Libraries
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue