Skip to content

lcarneli/deej

Repository files navigation

Logo

DeeJ

A DeeJ for your Discord parties.


Do you need a DJ for your Discord parties? Just call DeeJ, he will come to your channel and play your favorite music!

📕 How does it work?

The project uses the Discord.js SDK alongside discord-player package to stream audio tracks from different providers (Spotify, Youtube, Soundcloud...) to Discord.

⏩ Getting Started

⚙️ Installation

Install Docker using the official documentation and pull the DeeJ Docker image:

docker pull ghcr.io/MrZalTy/deej:latest

Edit the .env.example file according to your needs and rename it to .env.

Start the DeeJ Docker container:

docker run -d --env-file .env ghcr.io/MrZalTy/deej:latest

🏁 Quickstart

⚠️ All these commands must be executed in Discord.

Clear the queue.

/clear

Display information about the currently playing audio track.

/info

Pause the player.

/pause

Play a single audio track based on provided keywords or from a URL.

/play track <track>

Play a list of audio tracks from a URL.

/play playlist <playlist>

Display information about the queue.

/queue [page]

Resume the player.

/resume

Shuffle the queue.

/shuffle

Skip the currently playing audio track.

/skip

Set the volume of the player.

/volume [level]

## 💻 Technologies

<img src="https://skillicons.dev/icons?i=nodejs,ts,docker" alt="technologies" />

## ✏️ License

DeeJ is distributed under the [MIT License](LICENSE).

## ✍️ Authors

<table>
  <tr>
    <td align="center">
      <a href="https://github.com/MrZalTy">
        <img src="https://avatars.githubusercontent.com/u/25481821?v=4?s=100" width="100px;" alt="avatar"/><br />
      <sub>
        <b>MrZalTy</b>
      </sub>
    </a>
  </tr>
</table>

---

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