Music Disc

A discord music bot, supports YouTube, Spotify, SoundCloud, Deezer streams and web dashboard.
Developed based on discord.js v14, LavaShark, Lavalink.

Features

• Stable
• Use Lavalink
• Web dashboard
• Local node
• Docker images

If you need the version of discord-player, please refer to this branch.

If you encounter any issues or would like to contribute to the community, please join our Discord server.

Deploying with node.js

Clone the latest version of the repository

git clone https://github.com/hmes98318/Music-Disc.git

or click here to download

Install the dependencies

install all the dependencies from package.json

npm ci

Add Lavalink node

At least one Lavalink node is required to operate.
Edit the config.js file to add the Lavalink node.
Only supports Lavalink v4 nodes, v4.0.8 or higher is recommended.

• Use public node
• or host your own
• or enable local node setup

Please refer to this documentation for detailed information.

nodeList: [
    {
        "id": "Node 1",
        "hostname": "localhost",
        "port": 2333,
        "password": "youshallnotpass"
    }
]

Configure Bot

Edit the .env file to set the bot token.

# Discord Bot Token
BOT_TOKEN = "your_token"

Edit config.js to configure other parameters of the bot.

• Env & config.js detailed description

Running the script

npm run start

Deploying with Docker

image link : https://hub.docker.com/r/hmes98318/music-disc

If you don't have any available nodes, you need to first start the server container using Docker Compose in the server directory.

Start with Docker Compose

Please put your token into the BOT_TOKEN variable.
Edit config.js to configure other parameters of the bot.

• Env & config.js detailed description

services:
  music-disc:
    image: hmes98318/music-disc:latest
    container_name: music-disc
    restart: always
    environment:
      TZ: "Asia/Taipei"
      BOT_TOKEN: "your_token"
    volumes:
      - ./config.js:/bot/config.js              # Bot config
      - ./logs:/bot/logs                        # Bot logs
      - ./server:/bot/server                    # localnode configuration file
    ports:
      - 33333:33333

Start the docker compose

docker compose up -d

Start with Docker

Use the following command to start the container:
Please put your token into the BOT_TOKEN variable.

docker run -d \
  --name music-disc \
  --restart always \
  -e TZ="Asia/Taipei" \
  -e BOT_TOKEN="your_token" \
  -v $(pwd)/config.js:/bot/config.js \
  -v $(pwd)/logs:/bot/logs \
  -v $(pwd)/server:/bot/server \
  -p 33333:33333 \
  hmes98318/music-disc:latest

Development

Contributing

If you'd like to contribute to the development of Music Disc, please follow these steps:

1. Fork the repository
2. Create a new branch from the dev branch (all development work happens on the dev branch)
3. Make your changes
4. Submit a pull request to the dev branch

Please note that the main branch is only updated for releases.

Translations

Music Disc supports multiple languages. If you want to contribute translations:

1. Read the translation guidelines in src/locales/README.md
2. Follow the IETF language tag format (e.g. en-US)
3. Ensure all translation keys from the default en-US templates are included