Instruity

Custom made discord music bot made for me and my friends. This bot is meant to be hosted on a Heroku server.

Features

• Play music from YouTube (/play <url | name>)
• Use slash commands to control the bot
• Has a nice button interface to control the bot (/actions)
• You can run multiple instances of the bot on the same server
• Assign a "special" song to a bot via SPECIALITIES environment variable to play it via /perform command

Setup

Create a bot

1. Go to the (Discord Developer Portal)[https://discord.com/developers/applications]
2. Create a new application
3. Go to the "Bot" tab and click "Add Bot"
4. Copy the token and save it for later
5. Go to the "OAuth2" tab and select "bot" and "applications.commands" in the scopes section
6. Select the permissions the bot will need ("Send Messages", "Connect", "Speak" and "Read Messages/View Channels")
7. Copy the link, it will be used to invite the bot to a server

Deploy the bot

Heroku

1. Create a new app on (Heroku)[https://dashboard.heroku.com/new-app]
2. Make sure to use heroku-20 stack, as later versions have issues with ffmpeg at the time of writing
3. Add the following buildpacks (Settings -> Buildpacks -> Add buildpack):
   • heroku/nodejs
   • heroku/python
   • https://github.com/jonathanong/heroku-buildpack-ffmpeg-latest.git
   • https://github.com/xrisk/heroku-opus.git
4. Setup the environment variables (Settings -> Config Vars). See Configuration for more information
5. Connect the app to the repository (Deploy -> Deployment method -> GitHub)
6. Start the worker (Resources -> worker -> edit -> toggle the switch)

Local

1. Clone the repository

2. Install (ffmpeg)[https://www.ffmpeg.org/download.html]

3. Install (Python 3.10+)[https://www.python.org/downloads/]

4. Run the following commands: Windows:

   python -m venv .venv
   .venv\Scripts\activate
   pip install -r requirements.txt

   Linux:

   python -m venv .venv
   source .venv/bin/activate
   pip install -r requirements.txt

5. Setup the environment variables. See Configuration for more information

6. Run the bot with the following command: Windows: cmd .venv\Scripts\python bot.py

   Linux: bash .venv/bin/python bot.py

Docker

1. Clone the repository
2. Build the image with the following command:

   docker build -t instruity .

3. Run the container with the following command:

   docker run -e TOKENS="token1 token2 ..." -e SPECIALITIES="url1 url2 ..." -e HIDDEN=1 instruity

Configuration

Create a .env file with the following content:

TOKENS=token1 token2 ...
SPECIALITIES=url1 url2 ... [optional]
HIDDEN=1 [optional]

• TOKENS - whitespace-separated list of bot tokens (any whitespace is allowed: space, tab, newline, etc.)
• SPECIALITIES - whitespace-separated list of URLs to special songs
• HIDDEN - if set to 1, the bots will be shown as offline in the server