Disc 11 by Zhycorp

A dedicated open-source music bot for Zhycorp based on Jukebox

Usage

Requires Node.js version v14.x or above.

1. Install Node.js
2. Delete old .env, rename .env.schema to .env and fill out the values (example on .env.example)
3. Install dependencies as stated here before you continue surfing
4. Run npm run build using Node package manager
5. Optional thing, prune dev dependencies (this is good to save disk spaces):

$ npm prune --production

6. Start it with npm start, and you're done!

Notes:

1. You only need to configure .env file when you're using the Docker image
2. If you're using Deploy to Heroku button, you don't need to do this.

Installation

Without optional packages:

$ npm install --no-optional

With optional packages (recommended):

$ npm install

For optional packages, you need to install build tools as stated here and you also need to install Git.

Heroku

This clone project is still supports Heroku host because the original project is using this.

Glitch

You can still use Glitch and keep it online in this project, no worries 😉

1. Go to glitch.com and make an account
2. Click New Project, and then Import from GitHub
3. Please specify the field with https://github.com/zhycorp/disc-11, then wait for a while
4. Find the file names .env.schema then rename it to .env, let's configure that
5. Get your bot token at Discord developer portal then invite it to your server, and fill the bot prefix with anything you want
6. To get an YouTube API v3 Key, please watch this video carefully
7. Specify another options on that file. If you don't know how, there's .env.example so you can know what it should looks like
8. After that, go to Tools > Terminal type refresh
9. Close Terminal tab, then open Tools > Logs, wait for a while
10. To make it stay online, please watch this video carefully.

Your bot is online, and ready to use! If you have any questions or need support, feel free to join our Discord server.

Docker

Want to use Dockerized version of this project? Sure, we have provided them on the Docker Hub, and also in GitHub Container Registry.

Volumes

Docker Volumes are needed to store cache and logs persistently.

Example

$ docker run --env-file .env --volume cache:/app/cache --volume logs:/app/logs --restart unless-stopped hazmi35/jukebox

We also provide docker-compose.yml if you want to go that way.

Compose Example

$ docker-compose up

Features

• Basic Commands (Help, Ping, Invite and Evaluate [for advanced bot owners])
• Basic Music Commands (Play, Skip, Stop, Pause, Resume, Repeat, Volume, Now Playing, and Queue)
• A production-ready music bot, suitable for you that don't like to hassling with the code
• Lightweight, only around 120MB with dev dependencies pruned
• Docker-friendly (if you're advanced user)
• Caching (cache youtube downloads)
• Configurable (easy to use)

Based on jukebox