Giter VIP home page Giter VIP logo

jukebox's Introduction

Jukebox

Just a simple Discord music bot

CI Status Deploy

Usage

[โš ] Requires Node.JS version 12.9.0 or above.

  1. Install Node.JS
  2. Rename .env.schema to .env and fill out the values (example on .env.example)
  3. Install dependencies as stated here
  4. Run npm run build
  5. (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)

Based on discord-music-bot

jukebox's People

Contributors

hazmi35 avatar dependabot[bot] avatar dependabot-preview[bot] avatar jingexz01 avatar example0365 avatar mzrtamp avatar billyaddlers avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.