A Soundboard Bot for Discord to play your favorite sounds or music. You can add and play sounds, ignore users, set an avatar and more!
This is a self-hosted bot which means that you have to install and start the bot yourself. This is due to the bot being heavily involved with voice functionality. But don't sweat it! You can find a thorough installation and configuration guide in this README!
If you still need any help after reading this guide and the wiki, or you want to stay tuned, feel free to join my Discord server.
Have fun!
To use this bot, you first have to create your own Discord Application. If you don't know how to do it, this wiki page will guide you through every step of the way.
Check config/config.example.json for an example configuration and create a new file config.json inside the config folder with your desired configuration. For a detailed description on all of the options, see here. Make sure to restart the bot whenever you change the configuration.
To learn how to edit the config while the bot is running, see below.
The bot can be installed via npm, manually or via Docker.
Install the bot as a dependency using npm.
$ npm install discord-soundbot
Start the bot.
const Bot = require('discord-soundbot').default;
const bot = new Bot({
clientID: 'YOUR_CLIENT_ID',
token: 'YOUR_BOT_USER_TOKEN',
});
bot.start();For more configuration options see here.
- Install Node.js v8.0.0 or newer and FFmpeg.
- Clone the repository.
- Install the bot's dependencies with
npm install. - Run the bot with
npm start.
Need more details? You can find more detailed installation guides for Unix (including your Raspberry Pi), macOS, and Windows.
Note: Using this method, the bot will lose all sounds when restarting because the Docker container has its own file system.
- Simply clone the repo and run
docker build -t soundbot .inside the folder. - Afterwards start the bot via
docker run soundbot. - To run the container in the background use
docker run -d soundbot.
In both cases the bot will print a message to your console which should look a little bit like this
Use the following URL to let the bot join your server!
https://discordapp.com/oauth2/authorize?client_id={YOUR_CLIENT_ID}&scope=bot
Follow the link and allow the bot to join your Discord server.
Type !help or !commands to print a list of available commands. To see the welcome message again, use !welcome.
You can add, rename, download, tag, play, and remove sounds, ignore users, set the avatar, and more.
Note: The commands !rename, !remove, !tag <sound> clear, !ignore, !unignore, !avatar and !config are restricted and can only be accessed by administrators.
You can add sounds to the bot by typing !add and attaching a file. Accepted file formats and a limit to the size are configurable. The name of the sound can only contain alphanumeric characters.
You can instead also add a sound from YouTube with !add <name> <link>.
Type !sounds to get a list of all sounds that are available to your bot. Play any sound by prefixing it with your prefix, e.g. !rickroll. Play a random sound with !random.
All sounds will be added to a queue and played in succession. To halt the playback and empty the queue type !stop.
You can use !combo <sound1> ... <soundN> to add multiple sounds to the queue.
When your library of sounds gets too big and you forget what kinds of sounds you have, you can add tags to sounds.
You can add tags to sounds with !tag <sound> <tag>. You can specify one or more sounds. You can get the tags of a sound with !tag <sound>. You can also remove all tags from a sound with !tag <sound> clear.
To search for specific sounds use !search <tag>. It will look for the name of the sound as well as tags that you might have added to the sound.
To see all sounds with their respective tags use !tags.
Sounds can be renamed by using !rename <old> <new>. The bot will respond with a status update.
You can delete sounds by typing !remove <sound>. The bot will respond with the status of the deletion in the channel of the message.
You can send existing sounds to chat with !download <sound> in case you do not have the files anymore.
Users can be ignore from using any command by the !ignore <user> command while specifying their respective ID. The user will be mentioned by the bot in the channel of the message. Use !unignore <user> to allow the user to interact with the bot again.
Use !avatar and attach an image to set the bot's avatar. You can remove the avatar to go back to the default by using the optional remove parameter as in !avatar remove.
The config can be changed by editing the config.json file, after which the bot needs to be restarted.
To change the config on the go, use !config <option> <value>. This will change the configuration immediately and update the configuration file.
This bot is a dear passion project of mine. If you have any suggestions for new features or improvements, feel free to open an issue or talk to me on Discord. I'll be glad to look into it!
In particular, thanks to these splendid lads for providing localization: