jukebox

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #claude-code #codex #cli #developer-tools #react #windows

★ 73 Open GitHub ↗

Just a simple Discord music bot.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![](https://raw.githubusercontent.com/Hazmi35/jukebox/main/.github/images/jukebox.png)
# Maintenance Notice
⚠️ Due to rapid changes on the library Jukebox used, and Discord API, this branch of Jukebox is discontinued.

New Jukebox would be created in `new` branch.

# Jukebox
> Just a simple Discord music bot

## Usage

**[⚠] Requires [Node.JS](https://nodejs.org) version 16.6.0 or above.**

1. Install [Node.JS](https://nodejs.org)
2. Install requirements for yt-dlp

For Linux/Mac OS/Unix-like system, install [Python 3](https://www.python.org/downloads/), and add them to the PATH environment variable

For Windows, you don't need to install Python, but you need to install [Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package (x86)](https://download.microsoft.com/download/1/6/5/165255E7-1014-4D0A-B094-B6A430A6BFFC/vcredist_x86.exe)

3. Rename `.env.schema` to `.env` and fill out the values (example on .env.example)
4. Install dependencies as stated [here](https://github.com/Hazmi35/jukebox#install)
5. Run `npm run build`
6. (Optional) Prune dev dependencies (This is good to save disk spaces):
```sh
$ npm prune --production
```
1. 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](https://github.com/Hazmi35/jukebox#Docker)
2. If you're using "Deploy to Heroku" button, you don't need to do this.

## Install

Without optional packages
```sh
$ npm install --no-optional
```

With optional packages (Recommended)

```sh
$ npm install
```
For optional packages, you need to install build tools as stated [here](https://github.com/nodejs/node-gyp#installation) and you also need to install [Git](https://git-scm.com/)

## Docker
Want to use Dockerized version of jukebox? sure! we provide them on the [Docker Hub](https://hub.docker.com/r/hazmi35/jukebox) and also in [GitHub Container Registry](https://github.com/users/Hazmi35/packages/container/package/jukebox)

### Volumes
[Docker Volumes](https://docs.docker.com/storage/volumes/) are needed to store cache and logs persistently

### Example:
```sh
$ docker run --env-file .env --volume cache:/app/cache --volume logs:/app/logs --restart unless-stopped hazmi35/jukebox
```
We also provide [docker-compose.yml](docker-compose.yml) and [docker-compose.debian.yml](docker-compose.debian.yml) if you want to go that way.

There is also a [docker-compose.pull.yml](docker-compose.pull.yml) version, which pulls the image from Docker Hub (latest tag, alpine)

### Compose Example
```sh
$ docker-compose up
```

jukebox

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README