Discord Soundbot

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, or simply chat, feel free to join our Discord server.

Have fun!

Installation

General

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.

The bot can be installed manually, via Docker, or as an npm package. Docker is the simplest solution if you just want to run the bot, and do not have any programming experience.

Configuration

Check

config/config.example.json

config.json

config

!config

Running via Docker

• Make sure to have Docker installed.
• Start the bot with the following command while passing your CLIENT_ID and TOKEN that you have obtained in the previous step in to it.

  docker pull markokajzer/discord-soundbot && \
  mkdir -p sounds/ && touch db.json && \
  docker run --name soundbot --restart=on-failure:10 -e CLIENT_ID=YOUR_CLIENT_ID -e TOKEN=YOUR_TOKEN -v $(pwd)/sounds:/app/sounds -v $(pwd)/db.json:/app/db.json markokajzer/discord-soundbot

• To run the bot in the background additionally use the

  -d

  flag in the last step.
• Pass additional configuration options by adding additional

  -e OPTION_NAME=option_value

  to the command above.

Building

When not using Docker, make sure to install Node.js v12.0.0 or newer and FFmpeg for its voice functionality. You can install

ffmpeg

Building manually

• Clone the repository.
• Install the dependencies with

  yarn install

  .
• Run the bot with

  yarn start

  .

Need details? You can find more detailed installation guides for Unix (including your Raspberry Pi), macOS, and Windows.

Using npm

You can also add the bot as a project dependency to your Node project, by simply adding it to your project dependencies.

  # For npm
  $ npm install discord-soundbot

For yarn
  $ yarn add discord-soundbot

Start the bot.

const SoundBot = require('discord-soundbot');

const myBot = new SoundBot({
  clientId: 'YOUR_CLIENT_ID',
  token: 'YOUR_BOT_USER_TOKEN'
});
myBot.start();

For more configuration options see here. You can also add additional commands using this method, see here.

Adding the bot to your server

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.

Try out the sample sounds

!airhorn

!johncena

Commands

Type

!help

!commands

!welcome

You can add, rename, download, tag, play, and remove sounds, ignore users, set the avatar, and more.

Note: The commands

!rename

!remove

!tag  clear

!ignore

!unignore

!avatar

!config

elevatedRoles

Languages

The bot is available in multiple languages. To see all available languages use

!lang

Note, that I do not speak all available languages and therefore some translations might be missing, out of date or just straight up bad. If you feel like contributing, reach out to me on Discord.

Adding sounds

You can add sounds to the bot by typing

!add

You can instead also add a sound from YouTube with

!add  

!add    

  > !add gta https://www.youtube.com/watch?v=6gQNgh6iSBM 6 9
  > !add bruh https://www.youtube.com/watch?v=2ZIpFytCSVc 12:23

Playing sounds

Type

!sounds

!rickroll

!random

!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  ... 

You can loop sounds by using

!loop 

!loop  

You can skip the current sound with the

!skip

!next 

Setting entrance sounds

Every user can set his own entrance sound, a sound that will play whenever the user joins a voice channel by using

!entrance 

!entrance

The same is possible for exit sounds with

!exit 

Tagging and searching sounds

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  

!tag 

!tag  clear

To search for specific sounds use

!search 

To see all sounds with their respective tags use

!tags

Adjusting sounds

Sounds can be adjusted in various ways.

Use

!modify  volume 

  > !modify airhorn volume 4
  > !modify johncena volume 0.5

To adjust the length or to clip a sound, you can use

!modify  clip  

  > !modify airhorn clip 12:23 12:25
  > !modify johncena clip 23

Renaming sounds

Sounds can be renamed by using

!rename  

Removing sounds

You can delete sounds by typing

!remove 

Downloading sounds

You can send existing sounds to chat with

!download 

Ignoring users

Users can be ignore from using any command by the

!ignore 

!unignore 

Setting an avatar

Use

!avatar

remove

!avatar remove

Changing the config

The config can be changed by editing the

config.json

To change the config on the go, use

!config  

Contributing

This bot is a dear passion project of mine. If you encounter any bugs, or 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:

• Dutch, @nstapelbroek
• French, @sipahius
• Hungarian, @alma
• Italian, @Reckless
• Spanish, @ibito
• Japanese, @Sigmy
• Brazilian Portuguese, @Space_Interprise