- 📍 Overview
- 📦 Features
- 📂 Structure
- 💻 Installation
- 🏗️ Usage
- 🌐 Hosting
- 📜 API Documentation
- 📄 License
- 👏 Authors
The Discord Music Playback Bot is designed to enhance the social and entertainment experiences of users on Discord by providing a seamless music playback system. This bot supports various music sources through integration with popular APIs and encourages user interaction via shared musical experiences.
Feature | Description | |
---|---|---|
🎶 | Music Playback | Play, pause, resume, and stop music from services like YouTube, Spotify, and SoundCloud directly in Discord. |
📜 | Playlist Management | Users can create, edit, and manage song queues tailored to their preference, fostering collaborative experiences. |
🔍 | Search Functionality | Easily find songs using simple text commands; integrates with third-party APIs for accurate results. |
🔊 | Volume Control | Users can adjust volume levels according to their preferences for a personalized audio experience. |
🎛️ | Audio Effects | Apply audio effects such as bass boost and echo for customized sound quality. |
⚙️ | Robust Command System | An intuitive command system enables easy interaction, with help commands for guidance. |
🔒 | Permissions Management | Ensure server order and security by regulating access to various commands based on user roles. |
🔄 | Cross-Server Functionality | Retain user preferences across different Discord servers, promoting community sharing. |
🎉 | User Engagement Features | Add music-based games, quizzes, or voting systems for song selections to deepen user interaction. |
project-root
├─ commands
│ ├─ audioCommands.js
│ ├─ playlistCommands.js
│ ├─ userCommands.js
│ └─ adminCommands.js
├─ events
│ ├─ messageHandler.js
│ ├─ musicPlayerEvents.js
│ └─ userJoinLeaveEvents.js
├─ music
│ ├─ audioPlayer.js
│ ├─ volumeControl.js
│ ├─ audioEffects.js
│ └─ queueManager.js
├─ services
│ ├─ discordService.js
│ ├─ youtubeService.js
│ ├─ spotifyService.js
│ └─ soundcloudService.js
├─ models
│ ├─ userModel.js
│ ├─ playlistModel.js
│ └─ songModel.js
├─ middlewares
│ ├─ errorHandler.js
│ ├─ permissionsHandler.js
│ └─ rateLimiter.js
├─ utils
│ ├─ config.js
│ ├─ logger.js
│ └─ commandParser.js
├─ database
│ └─ mongoConnection.js
├─ .env
├─ .gitignore
├─ package.json
└─ README.md
- Node.js
- npm
- Docker
- Clone the repository:
git clone https://github.com/spectra-ai-codegen/discord-music-playback-bot.git
- Navigate to the project directory:
cd discord-music-playback-bot
- Install dependencies:
npm install
- Start the bot:
node index.js
- Follow the bot's setup instructions to invite it to your server.
Adjust configuration settings in config.js
or the .env
file as needed.
- GET /api/play: To play a song in the voice channel.
- POST /api/playlist: To create or update a user's playlist.
Utilizes OAuth for user authentication and session management via Discord.
This project is licensed under the GNU AGPLv3.
- Drix10 - GitHub Profile
Why only generate Code? When you can generate the whole Repository!