README.en-us.md

Lava

Multi funtion free & open source Discord music bot powered by Lavalink
Read more »

中文 ·
Try it out!(Chinese server) · Bug report · Request new features

Table of contents

1. Screenshots
2. Get started
   • Spotify Support
   • Requirements
3. Usage
4. Configs
5. ToDo
6. License
7. Contributing

Screenshots

(Back to top)

Get started

If you just want to experiment what the bot is like, you can join Yeecord(Chinese) and use Lava#8364 there

One click setup

You can use this one click script LavaLauncher, and follow the steps to setup Lavalink and the Discord bot

Docker

Docker compose

Make sure that Docker is installed on your computer or server already then:

1. Clone this Repository

git clone https://github.com/Nat1anWasTaken/Lava.git

2. cd to project directory

cd Lava

3. Rename example.stack.env to stack.env

mv example.stack.env stack.env

Fill out stack.env

4. Launch

docker compose up

Docker CLI

Make sure that Docker is installed on your computer or server already then:

1. Pull the image

docker pull ghcr.io/nat1anwastaken/lava:latest

2. Setup Lavalink, then fill IP and Port into configs/lavalink.json, if you're lazy to setup Lavalink, please use Docker Compose instead

{
    "host": "Lavalink IP",
    "port": "Lavalink Port"
}

3. Create stack.env file, and fill in the following

TOKEN=Bot Token
SPOTIFY_CLIENT_ID=Spotify client id
SPOTIFY_CLIENT_SECRET=Spotify client secret

4. Start to bot

docker run -it \
  --name lava \
  --volume "./configs:/app/configs" \
  --env-file stack.env \
  --restart unless-stopped \
  ghcr.io/nat1anwastaken/lava:latest

If you need to skip Spotify auto setup (Go to the following url: ...), you can set SKIP_SPOTIFY_SETUP to 1

(back to top)

Usage

After setting up the bot and invited it into your server, you can use /play to play music, as like in the example screenshot

Every command usage is explained in command description, you can learn how to use this bot by reading them

(Back to top)

Configs

Lava provided a few simple customizble configs for you to custom your bot to your likings such as:

Progress bar

You can modify configs/icons.json to set custom emoji for progress bar

{
    "empty": "⬛",
    "progress": {
        "start_point": "⬜",
        "start_fill": "⬜",
        "mid_point": "⬜",
        "end_fill": "⬛",
        "end_point": "⬛",
        "end": "⬛"
    },
    "control": {
        "rewind": "⏪",
        "forward": "⏩",
        "pause": "⏸️",
        "resume": "▶️",
        "stop": "⏹️",
        "previous": "⏮️",
        "next": "⏭️",
        "shuffle": "🔀",
        "repeat": "🔁",
        "autoplay": "🔥"
    }
}

Status

You can modify configs/activity.json to set custom status

{
    "type": 0, // 0: Playing, 1: Streaming, 2: Listing, 3: Watching
    "name": "Music", // Status text
    "url": "" // Stream link (Only when using streaming staus)
}

(Back to top)

ToDo

ToDo has been moved to Projects

(Back to top)

License

This project is licensed under MIT License, check LICENSE.txt for more information

(Back to top)

Contributing

Head to CONTRUBUTING.md for detail