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.

Requirements

To self-host this bot you'll need the following:

• git
• node.js (Version 16.6.0 or higher)
• ffmpeg

ffmpeg should be installed by default on Linux and MacOS, in case it isn't, install it with your package manager. For Windows users, head over to ffmpeg's official website to download the binary which will need to be added to your \$PATH. If you don't know how to add folders to your \$PATH, check out this guide.

You may also try installing it with:

npm install ffmpeg-static

Installation

In order to self-host this bot, first you'll need to clone this repository.

git clone https://github.com/moonstar-x/discord-tts-bot.git

Install the dependencies with:

npm ci --only=prod

Or, if you want to also install the devDependencies:

npm install

After you have configured the bot, you should deploy the slash commands by running:

npm run deploy

Then, you can run your bot with:

npm start

In case your bot is in a lot of servers (more than 2000), you should shard your bot. You can start a sharded client with:

npm run start-sharded

Updating

In order to update this bot, you should pull the latest changes:

git pull origin master

And re-install the dependencies:

rm -rf node_modules && npm install

Once this is done, you should re-deploy the commands:

npm run deploy

And you're ready to go. Make sure you check the README everytime you wish to update in case there are breaking changes that may affect your current installation.

Creating your Bot Token

Head over to Discord Application Page and create a new bot. Then, you should enable it as a bot by going into the Bot page and setting up your bot. Then, you should head over to the OAuth2 page and select OAuth2 URL Generator. A box should show up with plenty of checkboxes, enable the bot and application.commands checkboxes. Then, another box should show up with more checkboxes, enable the following ones:

• Send Messages
• Read Message History
• Connect
• Speak

At the bottom a link should show up, access this link to invite your bot. You should send this link to anyone that wishes to add your bot to their Discord server.

Configuration

Inside the config folder, rename the file settings.json.example to settings.json and edit the file with your own Discord Token and other settings. If you don't have a discord token yet, you can see a guide on how to create it here.

Your file should look like this.

{
  "token": "YOUR_DISCORD_TOKEN",
  "prefix": "$",
  "owner_id": "123123123",
  "owner_reporting": false,
  "presence_refresh_interval": 600000,
  "default_disconnect_timeout": 5,
  "testing_guild_id": null,
  "provider_type": "level",
  "redis_url": "redis://ip:port",
  "enable_tts_channels": false,
  "enable_keep_alive": false,
  "enable_who_said": false
}

You may also configure these options with environment variables. The settings set with the environment variables will take higher precedence than the ones in the config JSON file.

This table contains all the configuration settings you may specify with both environment variables and the JSON config file.

If you set enable_tts_channels to true, you must enable the message content privileged intent in your bot's application page.

Running on Docker

Before you run this image, you should deploy your commands, you can do so by running:

 docker run -it --rm -e DISCORD_TOKEN="your_token" -e DISCORD_ENABLE_TTS_CHANNELS="true/false" moonstarx/discord-tts-bot npm run deploy

After that, you can start a container with the bot's image by running:

docker run -it -e DISCORD_TOKEN="YOUR DISCORD TOKEN" moonstarx/discord-tts-bot:latest

Check configuration to see which environment variables you can use.

The following volumes can be used:

• /opt/app/config: The config folder for the bot, here you can use the settings.json file to configure the bot if you don't want to use environment variables.
• /opt/app/data: The data folder for the bot. If you use a level data provider you should set this volume to keep the bot's data persistent across restarts.

Running on Repl.it

To run this bot on Repl.it, create a new Repl by importing this repository. Then, run the following commands:

chmod +x init-replit.sh
./init-replit.sh

This will set up the proper node environment for the bot.

Then, after you have configured your bot, you should deploy your commands and start the bot with:

npm run deploy
npm start

Make sure to have enable_keep_alive set to true and use UptimeRobot to poll the address that shows up for your repl to make sure it stays on 24/7.

Deploying to Heroku

To deploy to Heroku, you can click on the image below and login to your account.

You can now go back to your app's Overview, make sure you disable the web dyno and enable the bot dyno. Your bot should now be up and running. Remember you can always check your bot's console if you access the View Logs in the More dropdown menu.

Usage

Here's a list of all the commands for the bot:

If you have enable_tts_channels set to true, you will have access to the additional commands:

Up until now, these settings are saved in memory, which means if the bot crashes/restarts, all of these settings will go back to default (Language: English, Speed: normal).

Language Support

Here's a list of all the supported languages by the Google Translate provider:

Add this bot to your server

You can add this bot to your server by clicking the image below:

Author

This bot was made by moonstar-x.