Skip to content

Latest commit

 

History

History
48 lines (28 loc) · 1.17 KB

README.md

File metadata and controls

48 lines (28 loc) · 1.17 KB
Raw

Tangerine

A Node.js Discord music bot made using Discord.js & lavalink.

Features:

  • Multiple Sources through Lavalink and Lavasrc: YouTube, Spotify, Deezer, Soundcloud, etc
  • Basic functions: join, leave, loop, play, skip, remove from queue, seek
  • Interactive queue command that shows playback progress
  • Supports playlists/albums, the entire playlist is shown as a single item until it reaches the front of the queue
  • Playlists and albums are added as a single queue object until they reach the front of the queue or are expanded with /expandplaylist.

Todo:

  • Playlist/album search
  • Docker Container
  • Tests
  • Improve readme

Setup:

You'll need Node v20 or greater, NPM, and a Lavalink node with the Lavasrc plugin and installed and setup.

  1. Clone or download the source:

    git clone https://github.com/karyeet/Tangerine

  2. Move into the folder:

    cd Tangerine

  3. Copy the example config and rename to config.json

    cp config.json.example config.json

  4. Edit and fill out config.json in your favorite text editor

  5. Install dependencies:

    npm install

  6. Compile typescript:

    npm run compile

  7. Start the bot

    node .