bnfoneMusic - A Discord Music Bot

This is a fork of the original EvoBot, a Discord Music Bot built with TypeScript, discord.js & uses Command Handler from discordjs.guide. This version includes enhancements and additional features to improve user experience and functionality.

🌟 Quickstart & Support

Thank you for your support in helping us develop and maintain this bot. We greatly appreciate your understanding and contributions.

⚠️ Important Note: We no longer offer hosting services. Thank you for your understanding and continued support!

If you would still like to support us, you can make a donation here: Donate 💖

You can still choose the amount you wish to donate; every contribution is welcome and appreciated. Thank you for your generosity!

📋 Requirements

1. Discord Bot Token Guide
   1.1. Enable 'Message Content Intent' in Discord Developer Portal
2. Spotify Client ID & Secret *-> can be requested at Spotify Developer Dashboard
3. Node.js 16.11.0 or newer

🛠️ Getting Started

git clone https://github.com/bnfone/DiscordMusicBot-evobot.git  # Clone the forked repository
cd DiscordMusicBot-evobot
npm install

After installation finishes, follow the configuration instructions and then run npm run start to start the bot.

⚙️ Configuration

Copy or Rename config.json.example to config.json and fill out the values:

⚠️ Note: Never commit or share your token or api keys publicly ⚠️

{
  "TOKEN": "",  // Your Discord Bot Token
  "SPOTIFY_CLIENT_ID": "",   // Your Spotify Client ID
  "SPOTIFY_CLIENT_SECRET": "", // Your Spotify Client Secret
  "MAX_PLAYLIST_SIZE": 10,
  "PRUNING": false,
  "LOCALE": "en",
  "DEFAULT_VOLUME": 100,
  "STAY_TIME": 30
}

🐳 Docker Configuration

For those who would prefer to use our Docker container, you may provide values from config.json as environment variables.

docker run -e TOKEN=your_discord_bot_token -e SPOTIFY_CLIENT_ID=your_spotify_client_id -e SPOTIFY_CLIENT_SECRET=your_spotify_client_secret bnfone/DiscordMusicBot-evobot -d

Docker Compose

version: '3.8'

services:
  discord_music_bot:
    image: bnfone/DiscordMusicBot-evobot
    container_name: discord_music_bot
    environment:
      - TOKEN=your_discord_bot_token
      - SPOTIFY_CLIENT_ID=your_spotify_client_id
      - SPOTIFY_CLIENT_SECRET=your_spotify_client_secret
    restart: always

📝 Features & Commands

• 🎶 Play music from YouTube, Spotify, and Apple Music via URL
• 🔎 Play music using search queries
• 📃 Play YouTube, Spotify, and Apple Music playlists via URL
• 🔎 Search and select music to play
• 🎛️ Volume control, queue system, loop/repeat, shuffle, and more
• 🎤 Display lyrics for the playing song
• ⏸️ Pause, resume, skip, and stop music playback
• 📱 Media Controls via Buttons
• 🌍 Supports multiple locales

Note: For Spotify and Apple Music integration, the bot converts the provided links to YouTube links before playing, ensuring compatibility and a broader range of music availability. The Odesli.co API is used for that.

🌎 Locales

This fork supports additional locales. For a complete list, please refer to the original repository. If you want to contribute by adding new locales, please check the contributing section.

🤝 Contributing to This Fork

1. Clone your fork: git clone https://github.com/your-username/evobot.git
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: cz OR npm run commit (Avoid using git commit directly)
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request to the original repository and mention that it's for the forked version

---

Note: This fork is maintained separately from the original EvoBot. For changes specific to this fork, ensure to target the correct repository when submitting pull requests or issues.