Installation 🔌

Setting up your own bot using Elite Music is quite simple. Ensure that you follow the prerequisites section first, before heading over and continuing with the main setup. 👍

tip

Want to test out and demo the bot before hosting and configuring it yourself?

You can invite Elite Music to your server here to test it out!

Prerequisites 🛂

In order for the bot to function correctly, there are a few prerequisites that you must have on your system.

• NodeJS - For the bot to function, it must be running in a NodeJS environment running on v16.9.0 or higher. It is highly recommended that you download the LTS build which is available for your OS to remain on the latest stable version. Head over to the NodeJS Download website to download and install an appropriate version.

• FFmpeg or Avconv - You will require either of these for transcoding. It is recommended to use FFmpeg. By default, the bot comes with the ffmpeg-static binaries as a dependency which allows the bot to work out of the box. Alternatively, you may decide to set your own ffmpeg binaries. In this case, head over to the FFmpeg Download website, select your OS and download the appropriate package. You can then place FFMPEG_PATH as a new option into your .ENV file stating the custom path to your custom FFmpeg binaries.

• Discord Bot Account - You must register a bot on the Discord Developer site to access a token to run the bot. Head over to the Developer website and click on New Application button. Provide a name and press Create. Next on the left-hand menu, select the Bot section and press Add Bot alongside the confirmation. Finally, press Reset Token and finally copy the token and keep it safe. This is what you will have to place into your .ENV file for the bot to function.

Setup 🔧

The first step is to clone the repository or download it manually as a folder to host it directly. The Git option is recommended for more advanced users and for users who already have it installed.

Regular Installation

Basic download

Head over to the download page and download the .zip source code. Next, using a tool such as 7-Zip, extract the files from the .zip folder. You can now move on to the following steps.

Download using Git

An alternative way to download the repository is through the usage of Git. If you do not have Git installed, please use the basic download method. Git users can run the command git clone https://github.com/ThatGuyJacobee/Elite-Bot-Music/tree/main to automatically clone the repository to a new folder.

Continuing the Setup

Now that you have downloaded the repository, you can continue with the following steps.

1. Open a new command/shell/terminal window within your new folder. You should be able to right-click and open the Windows terminal/command prompt if on Windows.
2. Run the command npm install to download all of the module dependencies.
3. Rename the file .env.example to simply .env. Once down, edit the .env file with the configuration options that you would like!
4. Finally, run your bot using node . within a command/shell/terminal window. The bot should now become online and provide a success message if everything was configured correctly. 🎉
5. (Optional) If you are editing the code, you can use npm run dev within your IDE to activate nodemon, which will automatically restart the bot on any change which is ideal for development.

Of course, you need to add your bot to your server now in order to use it. Follow this useful guide from the discord.js Guide which explains how to do this with great detail if you need help understanding how to do this.

Installation via Docker

Elite Music now has Docker image and Docker Compose support, allowing you to simply install and use the bot through Docker.

You can access the Docker Image via Docker Hub which provides the image and the instructions within the description. The instructions to either install via Docker Run or Docker Compose are also provided below. Once you have installed and configured your bot, you will need to add your bot to your server now in order to use it. Follow this useful guide from the discord.js Guide which explains how to do this with great detail if you need help understanding how to do this.

Docker Run Command

You should use the following command to download the image and run it:

docker run -d \
--name=elite-music \
--env-file /path/to/.env \
--restart unless-stopped \
thatguyjacobee/elitemusic:latest

Note: The --env-file path is relative to the directory you are running your docker run command from.

See the .env.sample file on the GitHub repository to view and copy over all of the environmental options into your target .env file for the bot.

Docker Compose

Use the following for your docker-compose.yml file:

version: '3'
services:
    elitemusic:
        container_name: 'elite-music'
        image: 'thatguyjacobee/elitemusic:latest'
        env_file: 
           - /path/to/.env
        restart: unless-stopped

Once again, see the .env.sample file on the GitHub repository to view and copy over all of the environmental options into your target .env file for the bot.

Congratulations! Just like that, you have setup your own bot using Elite Bot and invited it to your server! 🎉