🎵 Melody Bot

ATTENTION: THIS PROJECT IS NOT MAINTAINED ANYMORE!!! Official successor is "Quabot." You can find it in this organisation.

Melody is a music bot written in Java. It features various functions with the main focus on music.
It is in active development and is being improved every week.

Here is the current build/release status:

🙌 Contribution

Simply open a pull request with the template we have provided. Describe your changes and how they may affect the current project.

❗ Bugs/Features

Open an issue on our issue tracker at GitHub, and we will reach out to you.

⚙ Configuration

🤔 Prerequisites (Is being moved to new wiki soon!)

• Basic knowledge of Java and Gradle.
• Editor or IDE
• Discord bots API

🚀 Getting Started

Run these commands in your terminal.
⚠ Make sure to have Git installed on your machine.

git clone https://github.com/DisBots-Studios-Inc/Melody-Bot.git
cd Melody-Bot
chmod +x gradlew
./gradlew build

👩‍💻 Adding configuration variables

Make a new environmental variable called TOKEN and give it the value of your bots token. (music config part to be updated on wiki)

Running it

Just run it using the play button on IntelliJ or any other IDE.

📖 Website

---

If you want to commit to our website then do the following:

🙌 Contribution

Simply open a pull request with the template we have provided. Describe your changes and how they may affect the current project. Also be sure to append the "Website - " before your pull request.

❗ Bugs/Features

Open an issue on our issue tracker at GitHub, and we will reach out to you. Be sure to append "Website - " before the issue name! Like this:

Website - xxx is wrong documentation.

⚙ Configuration

---

🤔 Prerequisites (Is being moved to the new wiki soon!)

• Basic knowledge of javascript, nodejs and yarn
• yarn installed
• yarn installed
• text editor or IDE

🚀 Getting Started

---

Clone the repo like normal and then run these commands:

#cd into website dir
cd melody-website

#install dependencies:
yarn

To start the dev server, use in the website dir:

yarn start

Additional information will be available once wiki is hosted.