Welcome to NaviMusic, a highly user-friendly music bot for Discord. Developed using Discord4J, NaviMusic offers a seamless music experience for your Discord server.
This section provides a step-by-step guide on how to get a copy of NaviMusic up and running on your local machine for development and testing purposes.
Before you begin, ensure you have the following installed on your machine:
- Java 21
- Maven
- Docker (optional)
Follow these steps to get a copy of NaviMusic on your local machine:
- Clone the repository
git clone https://github.com/andre-carbajal/NaviMusic.git
- Navigate into the cloned repository
cd NaviMusic
- Build the project with Maven
mvn clean compile
Replace x.y with the version number of the last release. {nogui} is an optional argument to run the bot without the GUI. You can run NaviMusic using the following commands:
java -jar target/NaviMusic-x.y.jar {nogui}
java -jar target/NaviMusic-x.y.jar DISCORD_TOKEN=your_discord_token SPOTIFY_CLIENT_ID=your_spotify_client_id SPOTIFY_SECRET=your_spotify_secret {nogui}
You have two options to run NaviMusic using Docker:
-
Pull the Docker image from Docker Hub:
docker pull anvian/navi-music docker run anvian/navi-music -e DISCORD_TOKEN=your_discord_token SPOTIFY_CLIENT_ID=your_spotify_client_id SPOTIFY_SECRET=your_spotify_secret
-
Or, build and run the Docker image locally:
First, build the Docker image:
docker build -t navimusic .
Then, run the Docker container, passing your Discord token as an argument:
docker run navimusic -e DISCORD_TOKEN=your_discord_token SPOTIFY_CLIENT_ID=your_spotify_client_id SPOTIFY_SECRET=your_spotify_secret
This project is licensed under the GNU GENERAL PUBLIC LICENSE Version 3 For more details, see the LICENSE file.