Installation

When developing Melody, we have tried to make the installation process as simple and easy as possible. If you have any issues when following the guide below, please feel free to create an issue, or contact me elsewhere for help.

The guide below assumes you are hosting the bot with a hosting company that offers a control panel for your service such as Pterodactyl or Multicraft, or a fork/modified version of these projects. If you are hosting the bot on a dedicated linux machine, we assume that you are confident with using tools like pm2, and therefore can only provide limited assistance.

1. Download the source code from this repository.
2. Upload to your hosting and extract the files. (Or just extract locally)
3. Rename the file config.yml.example to config.yml.
4. Enter Discord bot token, Discord bot client ID, and Genius API key into config.yml. For more information on configuration Melody, please see the configuration guide.
5. Optional: Upload the custom emojis found in the /emojis/ directory to your server, and set the IDs of the emojis in the configuration file.
6. Install dependencies listed in package.json. This can be done with the npm install command. You do not need to install anything listed under the devDependencies section.
7. Launch bot with node dist/bot.js or npm run start. (If your hosting is managed and you can't change the startup command, you should be able to set the file that is run at launch. This must be set to dist/bot.js).