Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hazmi35/jukebox
Just a simple Discord music bot.
https://github.com/hazmi35/jukebox
discord discord-bot discord-music-bot discordbot discordbots discordjs hacktoberfest jukebox music-bot musicbot node nodejs typescript
Last synced: 17 days ago
JSON representation
Just a simple Discord music bot.
- Host: GitHub
- URL: https://github.com/hazmi35/jukebox
- Owner: Hazmi35
- License: agpl-3.0
- Created: 2020-04-03T15:06:27.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-05T23:57:25.000Z (over 1 year ago)
- Last Synced: 2024-10-12T18:06:42.765Z (about 1 month ago)
- Topics: discord, discord-bot, discord-music-bot, discordbot, discordbots, discordjs, hacktoberfest, jukebox, music-bot, musicbot, node, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 3.57 MB
- Stars: 72
- Watchers: 0
- Forks: 35
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```