/Jukebox

Jukebox

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

Jukebox

Just a simple Discord music bot

CI Status Deploy

Usage

[⚠] Requires Node.JS version 16.6.0 or above.

  1. Install Node.JS

  2. Install requirements for yt-dlp

    For Linux/Mac OS/Unix-like system, install Python 3, 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)

  3. Rename .env.schema to .env and fill out the values (example on .env.example)

  4. Install dependencies as stated here

  5. Run npm run build

  6. (Optional) Prune dev dependencies (This is good to save disk spaces):

$ 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
  2. If you're using "Deploy to Heroku" button, you don't need to do this.

Install

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

Docker

Want to use Dockerized version of jukebox? sure! we provide 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

  • A production-ready music bot, suitable for you that dislike hassling with the code.
  • Basic Commands (Help, Ping, Invite & Eval [for advanced bot owners])
  • Basic Music Commands (Play, Skip, Stop, Pause & Resume, Now Playing, Queue, Repeat, Volume)
  • Caching! (cache youtube downloads)
  • Configurable
  • Docker-friendly
  • Lightweight (only around 120MB with dev dependencies pruned)

Penggunaan

[⚠] Membutuhkan Node.JS versi 16.6.0 atau lebih tinggi.

  1. Instal Node.JS

  2. Persyaratan instal untuk yt-dlp

    Untuk sistem mirip Linux/Mac OS/Unix, instal Python 3, dan tambahkan ke variabel lingkungan PATH

    Untuk Windows, Anda tidak perlu menginstal Python, tetapi Anda perlu menginstal [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. Ganti nama .env.schema menjadi .env dan isi nilainya (contoh pada .env.example)

  4. Instal dependensi seperti yang dinyatakan di sini

  5. Jalankan npm run build

  6. (Opsional) Pangkas dependensi dev (Ini bagus untuk menghemat ruang disk):

$npm memangkas --produksi
  1. Mulai dengan npm start. Dan Anda sudah selesai!

Catatan:

  1. Anda hanya perlu mengonfigurasi file .env saat menggunakan gambar Docker
  2. Jika Anda menggunakan tombol "Deploy to Heroku", Anda tidak perlu melakukan ini.

Install

Tanpa paket opsional

$npm install --no-opsional

Dengan paket opsional (Disarankan)

$npm instal

Untuk paket opsional, Anda perlu menginstal alat build seperti yang dinyatakan di sini dan Anda juga perlu menginstal [Git](https://git-scm. com/)

buruh pelabuhan

Ingin menggunakan jukebox versi Dockerized? Tentu! kami menyediakannya di Docker Hub dan juga di [GitHub Container Registry](https://github.com/users/Hazmi35/packages/container /paket/jukebox)

Volume

Volume Docker diperlukan untuk menyimpan cache dan log secara terus-menerus

Contoh:

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

Kami juga menyediakan docker-compose.yml jika Anda ingin melakukannya

Tulis Contoh

$ komposisi buruh pelabuhan

Fitur

  • Bot musik siap produksi, cocok untuk Anda yang tidak suka mengganggu kode.
  • Perintah Dasar (Bantuan, Ping, Undang & Evaluasi [untuk pemilik bot tingkat lanjut])
  • Perintah Musik Dasar (Play, Skip, Stop, Pause & Resume, Now Playing, Queue, Repeat, Volume)
  • Caching! (cache unduhan youtube)
  • Dapat dikonfigurasi
  • Ramah buruh pelabuhan
  • Ringan (hanya sekitar 120MB dengan dependensi dev dipangkas)