.gitignore

@@ -4,3 +4,6 @@ dist
 tts.spec
 random*.txt
 quotes.txt
+tts.zip
+tts.log
+tts.log.?

CHANGELOG.md

@@ -1,6 +1,55 @@
 # Change Log
 
-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`.
+
+## [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
 

README.md

@@ -1,6 +1,6 @@
 # Twitch TextToSpeech Bot
 
-![Latest Release](https://img.shields.io/gitlab/v/release/38486705) ![License](https://img.shields.io/gitlab/license/38486705) ![Maintenance](https://img.shields.io/maintenance/yes/2022)
+![Latest Release](https://img.shields.io/gitlab/v/release/38486705) ![License](https://img.shields.io/gitlab/license/38486705) ![Maintenance](https://img.shields.io/maintenance/yes/2024)
 
 A simple Twitch TTS bot (Web Speech API)
 
@@ -8,14 +8,12 @@ A simple Twitch TTS bot (Web Speech API)
 
 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.
 
-The project consits of a very simple IRC client, which monitors the incoming messages. If a valid​⃰ `!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.
+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.
 
 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).
 
-(⃰sender is not on the blacklist, message is not too long, etc.)
-
 ## Getting Started
 
 ### Dependencies
@@ -55,9 +53,22 @@ bot:
   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."
@@ -116,10 +127,33 @@ Please note that the `oauth_token` is valid for approximately 60 days. If it bec
 * `message_length`: Maximum allowed message length for TTS
 * `language`: Language for `!wiki` command
 
+##### features
+
+* `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
@@ -181,8 +215,11 @@ Connect to the configured Twitch channel and send a message starting with `!tts`
 Additional commands (broadcaster and mods only) are:
 
 * `!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`
@@ -190,17 +227,123 @@ Additional commands (broadcaster and mods only) are:
 
 ### Additional features
 
+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
 
-The `!quickvote` feature implements a simple vote system. If a broadcaster or moderator send the `!quickvote` command a vote will be started (or a already running vote will be ended). After a quickvote has been started your community can casts votes by sending a chat message starting with `#`. You can include a message after `!quickvote` (e.g. `!quickvote Is pizza hawaii any good? #yes/#no`). If you do so, this message will be repeated every 60 seconds, so everyone keeps in mind, that a vote is still active.
+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
 
-The `!random` command will read a random line from a file called `random.txt`. You can also use multiple files, if you call `!random foo` the bot fetch the random line from a file called `random_foo.txt` instead of `random.txt`. `!random bar` will use the file `random_bar.txt` and so on. The `!random` command is restricted to the broadcaster and moderators.
+Picks a random line from a file.
 
-#### !smartquote
+**Usage:**
 
-The `!smartquote` command will read a line from a file called `quotes.txt`. You can add a parameter after the command. If the parameter is numeric the bot will search for a line starting with `#$number`. If the parameter is a string it will search for a line matching the parameter. If no parameter is given it will search for a completely random line.
+* 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:
 
@@ -208,17 +351,20 @@ The format of `quotes.txt` looks as follows:
 #1: "the quote" -username/game (date)
 ```
 
-#### !addquote
-
-The `!addquote` command adds a new line to `quotes.txt`. It expects two parameters: `!addquote username quote` where `username` is the name of the user to be quoted.
-
 #### !wiki
 
-The `!wiki` command searchs the wikipedia and fetches the first three sentences of the result.
+Search the Wikipedia.
 
-#### !pick
+**Usage:**
 
-The `!pick` command will randomly pick a given number of participants. After `!pick <max number of participants>` was started by the broadcaster or a moderator, everyone can type `#pickme` to become the chance to get picked when `!pick` gets triggered again. If no number was given, when `!pick` was frist triggered only one participant will get picked.
+* 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
 

config-dist.yml

@@ -16,9 +16,22 @@ bot:
   message_length: 200 # Max. TTS message length
   language: de # Language for wikipedia
 
+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."

requirements.txt

@@ -1,5 +1,5 @@
-fuzzywuzzy==0.18.0
-PyInstaller==5.3
-PyYAML==6.0
-requests==2.28.1
-wikipedia==1.4.0
+fuzzywuzzy==0.18.0
+PyInstaller==5.3
+PyYAML==6.0
+requests==2.28.1
+wikipedia==1.4.0

tts.html

@@ -1,48 +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>
-  <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>
-</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>