Skip to content

Latest commit

 

History

History
148 lines (116 loc) · 5.92 KB

README.md

File metadata and controls

148 lines (116 loc) · 5.92 KB
Raw

A simple yet powerful Discord music bot using the Lavalink client and Discord.js v14.

Version MIT License Contributors Stargazers Forks Watchers Issues

📢 Main Features

  • ☑️ Used Rainlink Lavalink client
  • ☑️ Supports Lavalink v3 and v4
  • ☑️ Slash commands
  • ☑️ Prefix commands [Dev-only commands]
  • ☑️ Clean UI
  • ☑️ Better performance
  • ☑️ Easy to use
  • ☑️ And more...!

🎵 Supported Platforms

  • ☑️ Youtube
  • ☑️ Youtube Music
  • ☑️ Apple Music
  • ☑️ Deezer
  • ☑️ Spotify
  • ☑️ SoundCloud
  • ☑️ And more...!

📌 Requirements

  • Discord Bot Token [Guide]
  • Node.js v18 or higher
  • MongoDB v5.x or higher [For local database]
  • Lavalink [Guide]
  • Java v18 or higher [For Lavalink]

🚀 Configuration & Installation

1. Clone the repository.

git clone https://github.com/adh319/Lunox.git

2. Open the Lunox folder then run

npm install

3. Rename .env.example to .env and fill out these variables according to yours.

#########################################
# ALL THE DETAILS BELOW SHOULD BE FILLED #
#########################################

# GENERAL DETAILS
TOKEN =  # Your bot token
PREFIX = ! # Prefix of the bot
OWNER =  # Your Discord user ID
DEV =  # Your Discord ID & Your developer Discord user ID (separated by comma "," if more than one) [Example: 393798172591259651, 393798172591259651]
EMBED_COLOR = 5865F2 # Embed color, example: FFFFFF (without #)
LEAVE_TIMEOUT = 60000 # Set leave timeout when bot was alone or not playing
MIN_VOLUME = 1 # Minimum volume
MAX_VOLUME = 100 # Maximum volume
MONGO_URI =  # Your MongoDB URI
GENIUS_API_KEY =  # Your Genius API key
SUPPORT_SERVER_URL = https://discord.gg/kNdSkHchzH # Support server url

# RAINLINK DETAILS
DEFAULT_SEARCH_ENGINE = youtubeMusic # Default search engine. Available engines: youtubeMusic, youtube, soundcloud, spotify, deezer and apple
SPOTIFY_CLIENT_ID =  # Your Spotify client ID
SPOTIFY_CLIENT_SECRET =  # Your Spotify client secret

4. Go to ./src/settings/config.js, open the file and fill out these config options value.

rainlinkNodes: [
    {
        name: "Lunox",
        host: "localhost",
        port: 2333,
        auth: "youshallnotpass",
        secure: false,
        driver: "lavalink/v4/koinu", // Available drivers based on your Lavalink version: https://github.com/RainyXeon/Rainlink#-drivers
    },
],

5. Go to ./src/settings/emoji.js, open the file and fill out the emoji variables.

6. Start the bot by running.

npm start

🤖 Bots Using This Source Code

Below is a list of Discord bots that are using this source code. If you want your bots to be listed here, edit this table and make a pull request with the following format:

No. Bot Name Invite Link Support Server
1 Jive Invite Link Jive Corner
2
3
4

🔐 Licensed

Distributed under the MIT License. You are free to use, and modify the code. However, you must provide attribution by linking back to the original repository and include this copyright notice:

© 2024 adh319@github. This project is available under the MIT License.You must include proper attribution by linking to the original GitHub repository: https://github.com/adh319/Lunox.

👥 Contributors