Skip to content

lcarneli/deej

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

DeeJ

A DJ for Discord parties


A DJ for Discord parties to easily play music.

⏩ Getting Started

⚙️ Installation

Install Docker and Docker Compose by using the link below https://docs.docker.com/engine/install

Clone project

git clone https://github.com/milkyonehq/deej.git

🏁 Quickstart

Start DeeJ with Docker Compose

docker compose -f deployments/docker-compose.yaml up -d

Stop DeeJ with Docker Compose

docker compose -f deployments/docker-compose.yaml down

🛠️ Environment variables

The DeeJ container can be configured with the environment variables below.

Variable Description Default Value
LOG_LEVEL The log level for application output. info
DISCORD_BOT_TOKEN The token used to authenticate the Discord bot. ""

⌨️️ Available Discord Commands

DeeJ supports the following slash commands to control music playback and manage the queue.

Command Description Example Usage
/play Play a single track from a search query or URL. /play never gonna give you up or /play https://www.youtube.com/watch?v=dQw4w9WgXcQ
/skip Skip the current track. /skip
/pause Pause the playback. /pause
/resume Resume the playback. /resume
/queue Display the queue. /queue
/clear Clear the queue. /clear
/volume Get or set the volume of the player (0-100). /volume or /volume 75
/shuffle Shuffle the queue. /shuffle

💻 Technologies

technologies

✏️ License

DeeJ is distributed under the Apache 2.0 License.

✍️ Contributors

Thanks goes to these wonderful people (emoji key):


Lorenzo Carneli

💻 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!


🚀 Don't forget to put a ⭐️ on our repositories!

About

A DJ for Discord parties.

Topics

Resources

License

Stars

Watchers

Forks

Languages

  • Go 98.7%
  • Dockerfile 1.3%