Skip to content

darkflam82/Boombox

Repository files navigation

Boombox is now archived

Unfortunately, Discord has removed Boombox's verifcation status, meaning it can no longer join any servers. Because of this we have made the decision to shutdown the bot and archive this repository.

Logo

Boombox Music Bot

A free and open source Discord music bot built on Discord.js
Read the docs >>

Invite to your server · Report bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. License
  4. Contact

About The Project

Boombox is a free and open source music bot for Discord built on Disocrd.js. Boombox uses Lavalink as it's music server and redis as it's database. All commands on Boombox are free and will always be free to use.

DigitalOcean Referral Badge

Commands

Below is a table of all of Boombox's commands.

Command Name Usage Description
Play /play [song name, youtube or spotify link] This will find the song from youtube or spotify and start playing. If there is something currently playing it will add it to the queue.
Skip /skip Will skip the currently playing song.
Stop /stop Will stop currently playing song and delete the queue.
Now Playing /np Displays what song is currently playing.
Queue /queue Displays the first 20 songs in the queue.
Volume /volume Set's the volume. Use a number between 1 and 100.
Invite /invite Sends an invite link for the bot.
Playlist /playlist [youtube playlist url or spotify album or playlist] This command will add all songs from a youtube playlist or spotify album or playlist into the queue.
Pause /pause Will pause the song that is currently playing.
Remove /remove [position in queue] Will remove that song from the queue.
Shuffle /shuffle Shuffles the current queue.
Seek /seek [time e.g 1m 30s] Goes to that time point in the song.

Getting Started

The eaisest way to start Boombox is by using docker. Docker will automaticly install Lavalink, Redis and build the image for the bot. To get started follow the instructions below.

Prerequisites

Make sure you have Docker and docker-compose installed. You can find instructions on how to install Docker here, and docker-compose here.

Make sure you have Node >= 14 installed.

Docker Install

  1. Clone the repo
git clone https://github.com/Boombox-Discord/Boombox.git
  1. Rename config-example.json to config.json and insert your own values. Leave the redis fields as they are.

  2. Get a clientID and client secret for Spotify from here and paste it into the config file. This allows you to play music from Spotify links.

  3. Rename lavalink-config-example.yml to lavalink-config.yml and replace password with something different. Make sure to put this password in the config.json file under lavalinkPassword.

  4. Run docker-compose

docker-compose up -d

This will automaticly register the slash commands with discord using the token provided in config.json. These can take up to one hour to appear in Discord.

Other ways to install

If you would like to run Boombox using Node or using our Docker image then you can find more information about this on our docs here.

License

Distributed under the AGPL-3.0 License. See LICENSE for more details.

Contact

If you have any questions or would like to talk with other Boombox users you can join or Discord server here.

About

A free and open source discord music bot.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published