mirror of
https://gitlab.com/gpvkt/twitchtts.git
synced 2025-04-06 20:10:07 +02:00
Compare commits
No commits in common. "v1.0.0" and "main" have entirely different histories.
11 changed files with 2158 additions and 368 deletions
7
.gitignore
vendored
7
.gitignore
vendored
|
|
@ -1,4 +1,9 @@
|
|||
config.yml
|
||||
build
|
||||
dist
|
||||
tts.spec
|
||||
tts.exe
|
||||
random*.txt
|
||||
quotes.txt
|
||||
tts.zip
|
||||
tts.log
|
||||
tts.log.?
|
||||
193
CHANGELOG.md
193
CHANGELOG.md
|
|
@ -1,13 +1,192 @@
|
|||
# Change Log
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
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`.
|
||||
|
||||
## [1.8.1] - 2022-10-29
|
||||
|
||||
### Added 1.8.1
|
||||
|
||||
* Logging to file (tts.log)
|
||||
|
||||
### Fixed 1.8.1
|
||||
|
||||
* Error when checking black-/whitelist
|
||||
|
||||
## [1.8.0] - 2022-10-23
|
||||
|
||||
### Added 1.8.0
|
||||
|
||||
* Option to disable TTS audio output for !wiki function
|
||||
* Option to configure the number of sentences fetched by !wiki function
|
||||
* !wtoff command
|
||||
* !wton command
|
||||
|
||||
### Changed 1.8.0
|
||||
|
||||
* "oauth_token doesn't need to start with "oauth:" anymore
|
||||
* Improved oauth-token detection
|
||||
* Improved README.md
|
||||
|
||||
## [1.7.3] - 2022-10-20
|
||||
|
||||
### Fixed 1.7.3
|
||||
|
||||
* Crash when message has no/invalid metadata
|
||||
|
||||
## [1.7.2] - 2022-10-17
|
||||
|
||||
### Fixed 1.7.2
|
||||
|
||||
* Crash when evaluating !quickvote result
|
||||
|
||||
## [1.7.1] - 2022-10-02
|
||||
|
||||
### Fixed 1.7.1
|
||||
|
||||
* Allow usage of `!sq` command when TTS is disabled
|
||||
|
||||
## [1.7.0] - 2022-08-27
|
||||
|
||||
### Added 1.7.0
|
||||
|
||||
* Option to disable functions in `config.yml`
|
||||
|
||||
## [1.6.1] - 2022-08-25
|
||||
|
||||
### Fixed 1.6.1
|
||||
|
||||
* Type Error during pick
|
||||
* Improved command handling
|
||||
|
||||
## [1.6.0] - 2022-08-25
|
||||
|
||||
### Added 1.6.0
|
||||
|
||||
* `!pick` command
|
||||
|
||||
## [1.5.0] - 2022-08-24
|
||||
|
||||
### Added 1.5.0
|
||||
|
||||
* `!wiki` command
|
||||
* `!version` command
|
||||
|
||||
### Changed 1.5.0
|
||||
|
||||
* Added `!sq` as alias for `!smartquote`
|
||||
|
||||
### Fixed 1.5.0
|
||||
|
||||
* Darkmode: Options background color
|
||||
|
||||
## [1.4.0] - 2022-08-23
|
||||
|
||||
### Added 1.4.0
|
||||
|
||||
* `!usermap` command added
|
||||
* `!delay` command added
|
||||
* Darkmode added
|
||||
|
||||
## [1.3.2] - 2022-08-19
|
||||
|
||||
### Fixed 1.3.2
|
||||
|
||||
* `!smartquote` and `!addquote` are not longer Mods only.
|
||||
|
||||
## [1.3.1] - 2022-08-19
|
||||
|
||||
### Added 1.3.1
|
||||
|
||||
* Added `game_name` and date to quote
|
||||
|
||||
### Fixed (hopefully) 1.3.1
|
||||
|
||||
* Improved HTTP request handling (hopefully removes delay in Chrome)
|
||||
|
||||
## [1.3.0] - 2022-08-18
|
||||
|
||||
### Added 1.3.0
|
||||
|
||||
* Added `!smartquote` command
|
||||
* Added `!addquote` command
|
||||
|
||||
## [1.2.5] - 2022-08-16
|
||||
|
||||
### Changed 1.2.5
|
||||
|
||||
* Improved logging
|
||||
|
||||
## [1.2.4] - 2022-08-15
|
||||
|
||||
### Added 1.2.4
|
||||
|
||||
* Check OAuth Token via Twitch API
|
||||
|
||||
### Fixed 1.2.4
|
||||
|
||||
* Internal URL when using special HTTP_BIND values
|
||||
|
||||
## [1.2.3] - 2022-08-14
|
||||
|
||||
### Fixed 1.2.3
|
||||
|
||||
* Message sort order
|
||||
|
||||
## [1.2.2] - 2022-08-13
|
||||
|
||||
### Changed 1.2.2
|
||||
|
||||
* The message queue is only queried when the Init button is pressed
|
||||
* Further code optimization
|
||||
|
||||
### Fixed 1.2.2
|
||||
|
||||
* Minor fixes
|
||||
|
||||
## [1.2.1] - 2022-08-13
|
||||
|
||||
### Changed 1.2.1
|
||||
|
||||
* Reworked internal code structure
|
||||
|
||||
### Fixed 1.2.1
|
||||
|
||||
* Publish vote info in chat when reloading config was not working when TTS was disabled
|
||||
* Casting votes was allowed for broadcaster and mods only
|
||||
|
||||
## [1.2.0] - 2022-08-13
|
||||
|
||||
### Added
|
||||
|
||||
* `!random` feature (see README.md for details)
|
||||
|
||||
### Changed 1.2.0
|
||||
|
||||
* The vote result will be read out
|
||||
|
||||
### Fixed 1.2.0
|
||||
|
||||
* Improved handling of missing config values
|
||||
|
||||
## [1.1.0] - 2022-08-12
|
||||
|
||||
### Added 1.1.0
|
||||
|
||||
* `!quickvote` feature (see README.md for details)
|
||||
* `!ping` command added
|
||||
* Configoption to start TTS in disabled mode
|
||||
* OAuth-Token generator
|
||||
* Webbrowser autostart
|
||||
|
||||
### Changed 1.1.0
|
||||
|
||||
* 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
|
||||
|
||||
### Fixed 1.1.0
|
||||
|
||||
* Improved error handling
|
||||
|
||||
## [1.0.0] - 2022-08-11
|
||||
|
||||
Initial Release
|
||||
|
||||
### Added
|
||||
|
||||
### Changed
|
||||
|
||||
### Fixed
|
||||
|
|
|
|||
370
README.md
370
README.md
|
|
@ -1,16 +1,40 @@
|
|||
# Twitch TextToSpeech Bot
|
||||
|
||||
  
|
||||
|
||||
A simple Twitch TTS bot (Web Speech API)
|
||||
|
||||
## Installation
|
||||
## Description
|
||||
|
||||
Clone the repo (or fetch the [latest Release](https://gitlab.com/gpvkt/twitchtts/-/releases)), move/copy `./dist/tts.exe` into the main directory. Rename `config-dist.yml` to `config.yml`
|
||||
The goal of this project is to provide a simple to use Text to Speech IRC bot. It's mainly focused on Twitch, but might be easily adapt to other IRC chats as well. Anyway, right now some parts are Twitch specific (like `CAP REQ :twitch.tv/commands twitch.tv/tags`). There are some other projects providing TTS for IRC based chats, like [IRC Radio (TTS)](https://play.google.com/store/apps/details?id=com.earthflare.android.ircradio&hl=en&gl=US), but they often are missing moderation features like Black-/Whitelists or deletion of single messages, before they are read. Therefore I created my own TTS bot, providing those features. Another very important aspect was that you should use almost any device capable running an HTML5-webbrowser as output. Therefore the bot uses a client-server "architecture". You can run the bot - for example - on your IRL server, but use your phone as output device. A mobile only solution always have the disadvantage of loosing messages, e.g. when your mobile connection drops.
|
||||
|
||||
## Configuration
|
||||
The project consits of a very simple IRC client, which monitors the incoming messages. If a valid (sender is not on the blacklist, message is not too long, etc.) `!tts` command is detected the message will send into a queue. Depending on your config it will wait there a few seconds for deletion by you/your moderators. If nobody deletes the message, it will send into another queue. This queue will get fetched by the HTML frontend, which will be delivered by an internal webserver (backend). The HTML frontend will use the [Web Speech API](https://wicg.github.io/speech-api/) included in any modern webbrowser to read the incoming TTS message. When this is done it will report back to the webserver and the message will be removed from the queue.
|
||||
|
||||
Adapt `config.yml` to your needs. Example:
|
||||
The server part is written in Python. The TTS part is written in Javascript.
|
||||
|
||||
```
|
||||
By using Javascript for the actual TTS part it's not only very easy to access the Web Speech API and the underlying Speech features of your OS, it also makes it possible to use a wide range of devices to actually play the TTS output. You can start the backend on your PC/Server and open the frontend on your Android/iOS tablet or Mobile Phone. If you expose the backend to the internet (I would recommend to use a reverse proxy, rather than exposing the backend directly) you can also use the TTS bot on the go (e.g. your IRL setup).
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Dependencies
|
||||
|
||||
* Browser with Web Speech API support
|
||||
* Web Speech API Voices (usually already included in your OS and/or browser)
|
||||
* If you use `tts.py` see `requirements.txt`. If you use `tts.exe` all dependencies are included.
|
||||
|
||||
### Installing
|
||||
|
||||
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. Adapt `config.yml` to your needs. See `Configuration` for details.
|
||||
|
||||
### Configuration
|
||||
|
||||
Please use `UTF-8` as encoding, when editing `config.yml`.
|
||||
|
||||
Example:
|
||||
|
||||
``` lang=yaml
|
||||
irc:
|
||||
channel: "#gpkvt"
|
||||
username: "ttsbot"
|
||||
|
|
@ -23,11 +47,28 @@ http:
|
|||
bind: "localhost"
|
||||
|
||||
bot:
|
||||
start_enabled: True
|
||||
subonly: False
|
||||
modonly: False
|
||||
message_length: 200
|
||||
language: de
|
||||
|
||||
features:
|
||||
quote: True
|
||||
pick: True
|
||||
vote: True
|
||||
wiki: True
|
||||
wikitts: True
|
||||
wikisentences: 3
|
||||
random: True
|
||||
version: True
|
||||
ping: True
|
||||
|
||||
messages:
|
||||
toff: "TTS is now inactive."
|
||||
ton: "TTS is now active."
|
||||
wikitoff: "Wiki TTS is now inactive."
|
||||
wikiton: "Wiki TTS is now active."
|
||||
too_long: "Sorry, your TTS message is too long."
|
||||
disabled: "Sorry, TTS is disabled right now."
|
||||
denied: "Sorry, you are not allowed to use TTS."
|
||||
|
|
@ -35,6 +76,19 @@ messages:
|
|||
whitelist: "Sorry, you are not allowed to use TTS."
|
||||
ready: "TTS bot alpha ready!"
|
||||
says: "says"
|
||||
votestart: "Quickvote started. Send #yourchoice to participate."
|
||||
voteend: "Quickvote ended. The results are:"
|
||||
votenobody: "Nobody casted a vote. :("
|
||||
voteresult: "Voting has ended. The result is:"
|
||||
votes: "Votes"
|
||||
pickstart: "Pick started. Send #pickme to participate."
|
||||
pickresult: "Pick ended. The results are:"
|
||||
picknone: "Nobody was picked. :("
|
||||
quotenotfound: "Sorry, no quote found."
|
||||
quoteaddedprefix: "Quote:"
|
||||
quoteaddedsuffix: "added."
|
||||
wiki_too_many: "Sorry, there are too many possible results. Try a more narrow search."
|
||||
wiki_no_result: "Sorry, there was an error fetching the wikipedia answer."
|
||||
|
||||
log:
|
||||
level: "INFO"
|
||||
|
|
@ -46,54 +100,100 @@ whitelist:
|
|||
|
||||
```
|
||||
|
||||
**Explanation**:
|
||||
#### Explanation
|
||||
|
||||
#### irc
|
||||
##### irc
|
||||
|
||||
* `channel`: Channel you want to monitor (e.g. #gpkvt)
|
||||
* `username`: The bots username (e.g. gpkvt)
|
||||
* `oauth_token`: The bots OAUTH-Token (e.g. oauth:ohkoace0wooghue8she9xaN0nooSau)
|
||||
* `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
|
||||
* `channel`: Channel you want to monitor (e.g. #gpkvt)
|
||||
* `username`: The bots username (e.g. gpkvt)
|
||||
* `oauth_token`: The bots OAUTH-Token (e.g. oauth:ohkoace0wooghue8she9xaN0nooSau)
|
||||
* `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
|
||||
|
||||
#### http
|
||||
You can generate your `oauth_token` by leaving the value empty when starting `tts.exe/tts.py`. The integrated webserver will then provide an OAuth-Generator. Due to limitations to the `redirect_url` parameter used by twitch, this is only possible if you use Port `8080` or `80` as `http:bind`. If you use a different port, you will need to use another [Twitch OAuth Generator](https://html.duckduckgo.com/html/?q=twitch+oauth+token+generator). The bot will need `chat:edit` and `chat:read` permissions.
|
||||
|
||||
* `port`: Internal Webserver Port to listen to (e.g. 8080)
|
||||
* `bind`: Interface/IP to bind server to (e.g. localhost)
|
||||
Please note that the `oauth_token` is valid for approximately 60 days. If it become invalid the bot will not connect anymore and you will have to renew the token.
|
||||
|
||||
#### bot
|
||||
|
||||
* `subonly`: If `True` only Subs can use TTS
|
||||
* `modonly`: If `True` only Mods can use TTS
|
||||
* `message_length`: Maximum allowed message length for TTS
|
||||
##### http
|
||||
|
||||
#### messages
|
||||
* `port`: Internal Webserver Port to listen to (e.g. 8080)
|
||||
* `bind`: Interface/IP to bind server to (e.g. localhost)
|
||||
|
||||
* `too_long`: The bots reply if message exceeds `message_length`
|
||||
* `disabled`: The bots reply if TTS is disabled
|
||||
* `denied`: The bots reply if the user is not allowed to use TTS
|
||||
* `subonly`: The bots reply if `subonly` is active and the user isn't one.
|
||||
* `whitelist`: The bots reply if `whitelist` is set and user isn't on the list.
|
||||
* `ready`: The bots init message
|
||||
* `says`: Prefix to add between username and message
|
||||
##### bot
|
||||
|
||||
#### log
|
||||
* `start_enabled`: Enable the bot on start? If `False` you need to use `!ton` first to make TTS work.
|
||||
* `subonly`: If `True` only Subs can use TTS
|
||||
* `modonly`: If `True` only Mods can use TTS
|
||||
* `message_length`: Maximum allowed message length for TTS
|
||||
* `language`: Language for `!wiki` command
|
||||
|
||||
* `level`: The loglevel, valid values are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`
|
||||
##### features
|
||||
|
||||
#### usermapping
|
||||
* `quote`: Enable/Disable `!quote` function
|
||||
* `pick`: Enable/Disable `!pick` function
|
||||
* `wiki`: Enable/Disable `!wiki` function
|
||||
* `wikitts`: Enable/Disable audio output for `!wiki` function
|
||||
* `wikisentences`: Number of sentences fetched by `!wiki` function
|
||||
* `random`: Enable/Disable `!random` function
|
||||
* `version`: Enable/Disable `!version` function
|
||||
* `ping`: Enable/Disable `!ping` function
|
||||
|
||||
Please note, the text output from `!wiki` might been shorter that the TTS output. This is due to the Twitch chat message length restriction. Therefore the `wikisentences` option might not have any effects, when `wikitts` is set to `False`.
|
||||
|
||||
Please also note that every `.` in the wikipedia result is counted as a sentence. This might cause issues with certain date-formats, e.g. if `wikisentences` is set to `1` and `bot:language` is set to `de` the command `!wiki douglas adams` will only return:
|
||||
|
||||
```text
|
||||
Douglas Noël Adams (* 11.
|
||||
```
|
||||
|
||||
Therefore the recommended minimum value for `wikisentences` is `3`.
|
||||
|
||||
##### messages
|
||||
|
||||
* `toff`: The bots reply when `!toff` is used.
|
||||
* `ton`: The bots reply when `!ton` is used.
|
||||
* `wikitoff`: The bots reply when `!wikitoff` is used.
|
||||
* `wikiton`: The bots reply when `!wikiton` is used.
|
||||
* `too_long`: The bots reply if message exceeds `message_length`
|
||||
* `disabled`: The bots reply if TTS is disabled
|
||||
* `denied`: The bots reply if the user is not allowed to use TTS
|
||||
* `subonly`: The bots reply if `subonly` is active and the user isn't one.
|
||||
* `whitelist`: The bots reply if `whitelist` is set and user isn't on the list.
|
||||
* `ready`: The bots init message
|
||||
* `says`: Prefix to add between username and message
|
||||
* `votestart`: Message when a quickvote was started.
|
||||
* `voteend`: Message when a quickvote ends.
|
||||
* `votenobody`: Message when quickvote ends, but nobody has voted.
|
||||
* `voteresult`: Prefix for the result (will be read out).
|
||||
* `votes`: Suffix to vote count.
|
||||
* `pickstart`: Message when `!pick` was started.
|
||||
* `pickresult`: Message when `!pick` ends.
|
||||
* `picknone`: Message if nobody was picked.
|
||||
* `quotenotfound`: Message if requests quote wasn't found.
|
||||
* `quoteaddedprefix`: Prefix for `Quote <number> added` message.
|
||||
* `quoteaddedsuffix`: Suffix for `Quote <number> added` message.
|
||||
* `wiki_too_many`: Message if `!wiki` command has more than one result.
|
||||
* `wiki_no_result`: Message if `!wiki` command hasn't a valid result.
|
||||
|
||||
##### log
|
||||
|
||||
* `level`: The loglevel, valid values are: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`
|
||||
|
||||
Do not use `DEBUG` in a production environment.
|
||||
|
||||
##### 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).
|
||||
|
||||
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.
|
||||
|
||||
A whitelist looks as follows:
|
||||
|
||||
```
|
||||
``` lang=yaml
|
||||
whitelist:
|
||||
- gpkvt
|
||||
- foo
|
||||
|
|
@ -104,51 +204,219 @@ To disable the whitelist, remove it from `config.yml` completely. If you just le
|
|||
|
||||
Please note: Usernames MUST be lowercase.
|
||||
|
||||
## Usage
|
||||
### 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.
|
||||
|
||||
### Additional Commands
|
||||
|
||||
Additional commands (broadcaster and mods only) are:
|
||||
|
||||
* `!toff`: Turn TTS off (will also empty the current TTS queue)
|
||||
* `!ton`: Turn TTS back on
|
||||
* `!dtts <username>`: Disable TTS for the given user
|
||||
* `!ptts <username>`: Allow TTS for the given user
|
||||
* `!ping`: Check if bot is alive (the bot should reply: `Pong!`)
|
||||
* `!version`: Print the bot version
|
||||
* `!toff`: Turn TTS off (will also empty the current TTS queue)
|
||||
* `!ton`: Turn TTS back on
|
||||
* `!wton`: Turn on TTS for `!wiki`
|
||||
* `!wtoff`: Turn off TTS for `!wiki`
|
||||
* `!dtts <username>`: Disable TTS for the given user
|
||||
* `!ptts <username>`: Allow TTS for the given user
|
||||
* `!usermap <username> <spoken name>`: Add an entry to the usermapping in `config.yml`
|
||||
* `!delay <int>`: Adjust the `clearmsg_timeout` in `config.yml`
|
||||
|
||||
# Voices
|
||||
### Additional features
|
||||
|
||||
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.
|
||||
You can enable/disable any feature in your `config.yml`:
|
||||
|
||||
``` lang=yaml
|
||||
features:
|
||||
quote: False
|
||||
pick: False
|
||||
vote: False
|
||||
wiki: False
|
||||
wikitts: False
|
||||
random: False
|
||||
version: True
|
||||
ping: True
|
||||
```
|
||||
|
||||
The default is enabled.
|
||||
|
||||
#### !quickvote
|
||||
|
||||
A simple vote system.
|
||||
|
||||
**Usage:**
|
||||
|
||||
1. Broadcaster/Mods: `!quickvote <message>`
|
||||
2. User: `#choice`
|
||||
3. Broadcaster/Mods: `!quickvote`
|
||||
|
||||
**Example:**
|
||||
|
||||
``` lang=text
|
||||
mod: !quickvote Is pizza hawaii any good? #yes/#no
|
||||
chat: #no
|
||||
mod: !quickvote
|
||||
bot: The result is: #no
|
||||
```
|
||||
|
||||
If a message is given by the Mods it will be repeated every 60 seconds, so everyone keeps in mind, that a vote is still active.
|
||||
|
||||
#### !pick
|
||||
|
||||
Randomly choose users from chat (who wants to participate).
|
||||
|
||||
**Usage:**
|
||||
|
||||
1. Broadcaster/Mods: `!pick <int>`
|
||||
2. User: #pickme
|
||||
3. Broadcaster/Mods: `!pick`
|
||||
|
||||
**Example:**
|
||||
|
||||
``` lang=text
|
||||
mod: !pick 3
|
||||
user1: #pickme
|
||||
user2: #pickme
|
||||
user3: #pickme
|
||||
user4: #pickme
|
||||
user5: #pickme
|
||||
mod: !pick
|
||||
bot: The picked users are: user5, user3, user1
|
||||
```
|
||||
|
||||
#### !random
|
||||
|
||||
Picks a random line from a file.
|
||||
|
||||
**Usage:**
|
||||
|
||||
* Broadcaster/Mod: `!random <file>`
|
||||
|
||||
You can use multiple files, if you call `!random foo` the bot fetch the random line from a file called `random_foo.txt`, `!random bar` will use the file `random_bar.txt` and so on. If no `<file>` is given the command use the file `random.txt`.
|
||||
|
||||
**Example:**
|
||||
|
||||
``` lang=text
|
||||
mod: !random
|
||||
bot: This is a random message
|
||||
```
|
||||
|
||||
#### !addquote
|
||||
|
||||
The `!addquote` command adds a new line to `quotes.txt`.
|
||||
|
||||
**Usage:**
|
||||
|
||||
* Chat: `!addquote <username> <quote>`
|
||||
|
||||
**Example:**
|
||||
|
||||
``` lang=text
|
||||
chat: !addquote gpkvt This is a very funny quote.
|
||||
bot: Quote #1 was added.
|
||||
```
|
||||
|
||||
#### !smartquote / !sq
|
||||
|
||||
Picks a random/specific line from `quotes.txt`.
|
||||
|
||||
**Usage:**
|
||||
|
||||
* Chat: `!smartquote`
|
||||
* Chat: `!smartquote <linenumber>`
|
||||
* Chat: `!smartquote <searchstring>`
|
||||
* Chat: `!sq`
|
||||
* Chat: `!sq <linenumber>`
|
||||
* Chat: `!sq <searchstring>`
|
||||
|
||||
(`!sq` is an alias for `!smartquote`)
|
||||
|
||||
**Example:**
|
||||
|
||||
``` lang=text
|
||||
chat: !smartquote
|
||||
bot: This is a random quote
|
||||
chat: !smartquote 1000
|
||||
bot: This is quote #1000
|
||||
chat: !smartquote something stupid
|
||||
bot: This is a quote containing something stupid (or similiar)
|
||||
```
|
||||
|
||||
The format of `quotes.txt` looks as follows:
|
||||
|
||||
``` lang=text
|
||||
#1: "the quote" -username/game (date)
|
||||
```
|
||||
|
||||
#### !wiki
|
||||
|
||||
Search the Wikipedia.
|
||||
|
||||
**Usage:**
|
||||
|
||||
* Chat: `!wiki <searchstring>`
|
||||
|
||||
**Example:**
|
||||
|
||||
``` lang=text
|
||||
chat: !wiki 42 answer
|
||||
bot: 42 is the "Answer to the Ultimate Question of Life, the Universe, and Everything".
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
If you prefer to build your own `tts.exe` instead of using the shipped one, you can do as follows:
|
||||
|
||||
* Install Python 3
|
||||
* Install pyinstaller: `pip install pyinstaller`
|
||||
* Install the required dependencies: `pip install -r requirements.txt -v`
|
||||
* Create the executeable: `pyinstaller --onefile tts.py`
|
||||
|
||||
## Voices
|
||||
|
||||
The voices available depend 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`.
|
||||
|
||||
Do not use Online-Voices, as this will result in serious delays.
|
||||
|
||||
## Help
|
||||
|
||||
Feel free to use the [Issuetracker](https://gitlab.com/gpvkt/twitchtts/-/issues) if you experience any problems.
|
||||
Feel free to use the [Issuetracker](https://gitlab.com/gpvkt/twitchtts/-/issues) or send an [E-Mail](mailto:contact-project+gpvkt-twitchtts-38486705-issue-@incoming.gitlab.com) if you experience any problems.
|
||||
|
||||
## Authors
|
||||
|
||||
[@gpkvt](https://gitlab.com/gpvkt)
|
||||
[@gpkvt](mailto:contact-project+gpvkt-twitchtts-38486705-issue-@incoming.gitlab.com)
|
||||
|
||||
## Version History
|
||||
|
||||
See `CHANGELOG.md`.
|
||||
See [CHANGELOG.md](https://gitlab.com/gpvkt/twitchtts/-/blob/main/CHANGELOG.md)
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the GPLv3 License - see the `LICENSE.md` details.
|
||||
This project is licensed under the GPLv3 License - see [LICENSE](https://gitlab.com/gpvkt/twitchtts/-/blob/main/LICENSE) for details.
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
* [Python Software Foundation and contributors](https://www.python.org/)
|
||||
### Ideas and Testing
|
||||
|
||||
* [GERBrowny and community](https://www.twitch.tv/gerbrowny/) 
|
||||
* [DerZugger and community](https://www.twitch.tv/derzugger/) 
|
||||
* [Timmeh74 and community](https://www.twitch.tv/timmeh74/) 
|
||||
|
||||
### Libraries
|
||||
|
||||
* [Python](https://www.python.org/)
|
||||
* [jQuery](https://jquery.org/)
|
||||
* [Bootstrap](https://getbootstrap.com/)
|
||||
* [PyYAML](https://pyyaml.org/)
|
||||
* [requests](https://requests.readthedocs.io/en/latest/)
|
||||
* [fuzzywuzzy](https://github.com/seatgeek/fuzzywuzzy)
|
||||
* [wikipedia](https://github.com/goldsmith/Wikipedia)
|
||||
* [pyinstaller](https://pyinstaller.org/)
|
||||
* [OpenJS Foundation and jQuery contributors](https://jquery.org/)
|
||||
* [Twitter Inc. and Bootstrap contributors](https://getbootstrap.com/)
|
||||
* [GERBrowny and community](https://twitch.tv/gerbrowny/)
|
||||
* [DerZugger and community](https://www.twitch.tv/derzugger/)
|
||||
* [Timmeh74 and community](https://www.twitch.tv/timmeh74/)
|
||||
|
||||
## Disclaimer
|
||||
|
||||
|
|
|
|||
13
bootstrap.min.css
vendored
13
bootstrap.min.css
vendored
File diff suppressed because one or more lines are too long
67
build.py
Normal file
67
build.py
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
#!/usr/bin/python3
|
||||
# -*- coding: utf-8 -*-
|
||||
# pylint: disable=line-too-long,too-many-lines
|
||||
|
||||
""" buildscript """
|
||||
|
||||
from pprint import pprint
|
||||
import time
|
||||
import os
|
||||
|
||||
import yaml
|
||||
import requests
|
||||
|
||||
import PyInstaller.__main__
|
||||
|
||||
with open("config.yml", "r", encoding="UTF-8") as ymlfile:
|
||||
cfg = yaml.load(ymlfile, Loader=yaml.Loader)
|
||||
|
||||
apikey = cfg['virustotal']
|
||||
|
||||
PyInstaller.__main__.run(['tts.py', '--onefile',])
|
||||
|
||||
os.replace("./dist/tts.exe", "./tts.exe")
|
||||
|
||||
print("Uploading file")
|
||||
api_endpoint = "https://www.virustotal.com/api/v3/files" # pylint: disable=invalid-name
|
||||
headers = {
|
||||
"Accept": "application/json",
|
||||
"X-Apikey": apikey
|
||||
}
|
||||
files = {"file": open("./tts.exe", "rb")}
|
||||
req = requests.post(api_endpoint, headers=headers, files=files)
|
||||
print(" [OK]")
|
||||
|
||||
data = {}
|
||||
data['data'] = {}
|
||||
data['data']['attributes'] = {}
|
||||
data['data']['attributes']['status'] = "incomplete"
|
||||
|
||||
print("Waiting for results")
|
||||
while data['data']['attributes']['status'] != "completed":
|
||||
time.sleep(10)
|
||||
|
||||
print( " [CHK]")
|
||||
data = req.json()
|
||||
api_endpoint = f"https://www.virustotal.com/api/v3/analyses/{data['data']['id']}"
|
||||
headers = {
|
||||
'X-Apikey': apikey
|
||||
}
|
||||
req = requests.get(api_endpoint, headers=headers)
|
||||
data = req.json()
|
||||
|
||||
print(" [OK]")
|
||||
|
||||
try:
|
||||
pprint(data['data']['attributes']['results']['Microsoft'])
|
||||
except KeyError:
|
||||
pass
|
||||
|
||||
pprint(data['data']['attributes']['stats'])
|
||||
print("https://www.virustotal.com/gui/file/"+str(data['meta']['file_info']['sha256']))
|
||||
|
||||
try:
|
||||
if data['data']['attributes']['results']['Microsoft']['category'] != "undetected":
|
||||
print('FILE WILL BE DETECTED AS MALICIOUS. PLEASE RECOMPILE!')
|
||||
except KeyError:
|
||||
pass
|
||||
|
|
@ -1,20 +1,37 @@
|
|||
irc:
|
||||
channel: "#changeme"
|
||||
username: "changeme"
|
||||
oauth_token: "use https://www.21x9.org/twitch/ or a similiar service to get your token"
|
||||
server: "irc.chat.twitch.tv"
|
||||
clearmsg_timeout: 10
|
||||
channel: "#changeme" # Your twitch channel
|
||||
username: "changeme" # Your bots username
|
||||
oauth_token: # leave this blank to start the token generator
|
||||
server: "irc.chat.twitch.tv" # Twitch IRC server, default should be fine
|
||||
clearmsg_timeout: 10 # Time to wait for a new message to be deleted before being read
|
||||
|
||||
http:
|
||||
port: 80
|
||||
bind: "localhost"
|
||||
port: 80 # Internal webserver port
|
||||
bind: "localhost" # Internal webserver IP/Hostname, use 0.0.0.0 to listen on all interfaces
|
||||
|
||||
bot:
|
||||
subonly: False
|
||||
modonly: False
|
||||
message_length: 200
|
||||
start_enabled: True # Start the bot with TTS active, if set to False you need to enable TTS with !ton
|
||||
subonly: False # Only Subs can use TTS
|
||||
modonly: False # Only Mods can use TTS
|
||||
message_length: 200 # Max. TTS message length
|
||||
language: de # Language for wikipedia
|
||||
|
||||
messages:
|
||||
features:
|
||||
quote: True
|
||||
pick: True
|
||||
vote: True
|
||||
wiki: True
|
||||
wikitts: True
|
||||
wikisentences: 3
|
||||
random: True
|
||||
version: True
|
||||
ping: True
|
||||
|
||||
messages: # Things the bot can send as chat message
|
||||
toff: "TTS is now inactive."
|
||||
ton: "TTS is now active."
|
||||
wikitoff: "TTS is now inactive."
|
||||
wikiton: "TTS is now active."
|
||||
too_long: "Sorry, your TTS message is too long."
|
||||
disabled: "Sorry, TTS is disabled right now."
|
||||
denied: "Sorry, you are not allowed to use TTS."
|
||||
|
|
@ -23,9 +40,22 @@ messages:
|
|||
modonly: "Sorry, TTS is a mod-only feature."
|
||||
ready: "TTS bot alpha ready!"
|
||||
says: "says"
|
||||
votestart: "Quickvote started. Send #yourchoice to participate."
|
||||
voteend: "Quickvote ended. The results are:"
|
||||
votenobody: "Nobody casted a vote. :("
|
||||
voteresult: "Voting has ended. The result is:"
|
||||
votes: "Votes"
|
||||
pickstart: "Pick started. Send #pickme to participate."
|
||||
pickresult: "Pick ended. The results are:"
|
||||
picknone: "Nobody was picked. :("
|
||||
quotenotfound: "Sorry, no quote found."
|
||||
quoteaddedprefix: "Quote:"
|
||||
quoteaddedsuffix: "added."
|
||||
wiki_too_many: "Sorry, there are too many possible results. Try a more narrow search."
|
||||
wiki_no_result: "Sorry, there was an error fetching the wikipedia answer."
|
||||
|
||||
log:
|
||||
level: "INFO"
|
||||
level: "INFO" # Loglevel, valid values are: DEBUG, INFO, WARNING, ERROR, CRITICAL (do not use DEBUG in a production environment)
|
||||
|
||||
usermapping:
|
||||
gpkvt: "gpk"
|
||||
gpkvt: "gpk" # rename users when being read, to make their names shorter or sound better.
|
||||
|
|
|
|||
|
|
@ -1 +1,5 @@
|
|||
PyYAML==6.0
|
||||
fuzzywuzzy==0.18.0
|
||||
PyInstaller==5.3
|
||||
PyYAML==6.0
|
||||
requests==2.28.1
|
||||
wikipedia==1.4.0
|
||||
|
|
|
|||
BIN
tts.exe
Normal file
BIN
tts.exe
Normal file
Binary file not shown.
84
tts.html
84
tts.html
|
|
@ -1,35 +1,49 @@
|
|||
<html lang="de">
|
||||
<head>
|
||||
<link href="./bootstrap.min.css" rel="stylesheet" />
|
||||
<title>TTS</title>
|
||||
<script src="./jquery.js"></script>
|
||||
</head>
|
||||
<body class="container mt-2">
|
||||
<p class="lead mt-2">Select Voice</p>
|
||||
<select id="voices" class="form-select bg-transparent"></select>
|
||||
<div class="d-flex mt-2">
|
||||
<div>
|
||||
<p class="lead">Volume</p>
|
||||
<input type="range" min="0" max="1" value="1" step="0.1" id="volume" />
|
||||
<span id="volume-label" class="ms-2">1</span>
|
||||
</div>
|
||||
<div class="mx-4">
|
||||
<p class="lead">Rate</p>
|
||||
<input type="range" min="0.1" max="10" value="1" id="rate" step="0.1" />
|
||||
<span id="rate-label" class="ms-2">1</span>
|
||||
</div>
|
||||
<div>
|
||||
<p class="lead">Pitch</p>
|
||||
<input type="range" min="0" max="2" value="1" step="0.1" id="pitch" />
|
||||
<span id="pitch-label" class="ms-2">1</span>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<button id="start" class="btn btn-success mt-4 me-2">Init</button>
|
||||
<button id="pause" class="btn btn-warning mt-4 me-2">Pause</button>
|
||||
<button id="resume" class="btn btn-info mt-4 me-2">Resume</button>
|
||||
<button id="cancel" class="btn btn-danger mt-4 me-2">Cancel</button>
|
||||
</div>
|
||||
</body>
|
||||
<script src="./tts.js"></script>
|
||||
</html>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<link href="./bootstrap.min.css" rel="stylesheet" />
|
||||
<title>TTS</title>
|
||||
<script src="./jquery.js"></script>
|
||||
</head>
|
||||
<body class="container mt-2">
|
||||
<p class="lead mt-2">Select Voice</p>
|
||||
<select id="voices" class="form-select bg-transparent"></select>
|
||||
<div class="d-flex mt-2">
|
||||
<div>
|
||||
<p class="lead">Volume</p>
|
||||
<input type="range" min="0" max="1" value="1" step="0.1" id="volume" />
|
||||
<span id="volume-label" class="ms-2">1</span>
|
||||
</div>
|
||||
<div class="mx-4">
|
||||
<p class="lead">Rate</p>
|
||||
<input type="range" min="0.1" max="10" value="1" id="rate" step="0.1" />
|
||||
<span id="rate-label" class="ms-2">1</span>
|
||||
</div>
|
||||
<div>
|
||||
<p class="lead">Pitch</p>
|
||||
<input type="range" min="0" max="2" value="1" step="0.1" id="pitch" />
|
||||
<span id="pitch-label" class="ms-2">1</span>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<button id="start" class="btn btn-success mt-4 me-2">Init</button>
|
||||
<button id="pause" class="btn btn-warning mt-4 me-2">Pause</button>
|
||||
<button id="resume" class="btn btn-info mt-4 me-2">Resume</button>
|
||||
<button id="cancel" class="btn btn-danger mt-4 me-2">Cancel</button>
|
||||
</div>
|
||||
<script src="./tts.js"></script>
|
||||
<script>
|
||||
$(document).ready (function(){
|
||||
if (window.matchMedia) {
|
||||
if(window.matchMedia('(prefers-color-scheme: dark)').matches){
|
||||
$('body').addClass('bg-dark');
|
||||
$('p').addClass('text-light');
|
||||
$('select').addClass('text-light');
|
||||
$('option').addClass('bg-dark');
|
||||
$('span').addClass('text-light');
|
||||
}
|
||||
}
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
5
tts.js
5
tts.js
|
|
@ -34,6 +34,7 @@ document.querySelector("#start").addEventListener("click", () => {
|
|||
speech.text = "Init complete";
|
||||
window.speechSynthesis.speak(speech);
|
||||
$("#start").hide();
|
||||
init();
|
||||
});
|
||||
|
||||
document.querySelector("#pause").addEventListener("click", () => {
|
||||
|
|
@ -54,7 +55,7 @@ function sleep(ms) {
|
|||
|
||||
reload = true;
|
||||
|
||||
$(document).ready(function() {
|
||||
function init() {
|
||||
setInterval(function(){
|
||||
if (reload) {
|
||||
$.ajax({
|
||||
|
|
@ -89,4 +90,4 @@ $(document).ready(function() {
|
|||
});
|
||||
}
|
||||
}, 1000);
|
||||
});
|
||||
};
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue