Merge pull request #76 from moonstar-x/update-4.1.0

Update 4.1.0
moonstar-x · Mar 26, 2022 · 7fcfac0 · 7fcfac0
2 parents 5ccc0ed + 216646a
commit 7fcfac0
Show file tree

Hide file tree

Showing 57 changed files with 3,458 additions and 630 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
diff --git a/README.md b/README.md
@@ -5,12 +5,13 @@
 [![open-issues-count](https://img.shields.io/github/issues-raw/moonstar-x/discord-tts-bot?logo=github)](https://github.com/moonstar-x/discord-tts-bot)
 [![docker-image-size](https://img.shields.io/docker/image-size/moonstarx/discord-tts-bot?logo=docker)](https://hub.docker.com/repository/docker/moonstarx/discord-tts-bot)
 [![docker-pulls](https://img.shields.io/docker/pulls/moonstarx/discord-tts-bot?logo=docker)](https://hub.docker.com/repository/docker/moonstarx/discord-tts-bot)
-[![ko-fi](https://img.shields.io/badge/buy%20me%20a%20coffee-%E2%98%95%20%20-%23ff5f5f)](https://ko-fi.com/moonstar_x)
 
 # Discord TTS Bot
 
 This is a simple TTS Bot that uses the Google Translate TTS API. With this bot you can send Text-to-Speech messages in multiple languages using Google Translate or other TTS engines.
 
+For more information, visit the bot's [official page](https://docs.moonstar-x.dev/discord-tts-bot/).
+
 ## Requirements
 
 To self-host this bot you'll need the following:
@@ -119,7 +120,8 @@ Your file should look like this.
   "provider_type": "level",
   "redis_url": "redis://ip:port",
   "enable_tts_channels": false,
-  "enable_keep_alive": false
+  "enable_keep_alive": false,
+  "enable_who_said": false
 }
 ```
 
@@ -140,6 +142,7 @@ This table contains all the configuration settings you may specify with both env
 | DISCORD_REDIS_URL                  | `redis_url`                  | No. (Defaults to: `null`)   | `string` or `null`         | The URL of the redis service. This is only required if you have set the provider type to `redis`.                                                                                                                                                                                                                                                                                    |
 | DISCORD_ENABLE_TTS_CHANNELS        | `enable_tts_channels`        | No. (Defaults to: `false`)  | `boolean`                  | Whether to enable the message-only TTS for specific channels. With this setting, you can send TTS messages by just sending messages to a channel that you have enabled a provider for. You need the privileged message intent (accessible in the `Bot` page of your bot's application page) for this feature to work properly.                                                       |
 | DISCORD_ENABLE_KEEP_ALIVE          | `enable_keep_alive`          | No. (Defaults to: `false`)  | `boolean`                  | Whether an HTTP server should be started. You should only use this option if you're planning to host the bot on something like Repl.it or Heroku. Additionally, you should use something like UptimeRobot to poll the associated address to keep the bot alive. If you need to specify the port to use you should set the `PORT` environment variable (Heroku uses this by default). |
+| DISCORD_ENABLE_WHO_SAID            | `enable_who_said`            | No. (Defaults to: `false`)  | `boolean`                  | Whether the bot should prepend each TTS message with a 'User said...'. This makes it so the bot speaks the name of the author of every message.                                                                                                                                                                                                                                      |
 
 > If you set `enable_tts_channels` to `true`, you must enable the message content privileged intent in your bot's [application page](https://discord.com/developers/applications/).
 

diff --git a/app.json b/app.json
@@ -50,6 +50,16 @@
       "description": "Whether to enable the message-only based TTS to send TTS messages on a certain channel with a certain setting without the need to execute a command.",
       "value": "false",
       "required": false
+    },
+    "DISCORD_ENABLE_KEEP_ALIVE": {
+      "description": "Whether an HTTP server should be started. You should only use this option if you're planning to host the bot on something like Repl.it or Heroku. Additionally, you should use something like UptimeRobot to poll the associated address to keep the bot alive. If you need to specify the port to use you should set the `PORT` environment variable (Heroku uses this by default).",
+      "value": "true",
+      "required": false
+    },
+    "DISCORD_ENABLE_WHO_SAID": {
+      "description": "Whether the bot should prepend each TTS message with a 'User said...'. This makes it so the bot speaks the name of the author of every message.",
+      "value": "false",
+      "required": false
     }
   }
 }