Skip to content

coslynx/discord-audio-playback-bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

37 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation


discord-audio-playback-bot

Enhance your Discord experience with seamless music playback.

Developed with the software and tools below.

git-last-commit GitHub commit activity GitHub top language

πŸ“‘ Table of Contents

  • πŸ“ Overview
  • πŸ“¦ Features
  • πŸ“‚ Structure
  • πŸ’» Installation
  • πŸ—οΈ Usage
  • 🌐 Hosting
  • πŸ“œ License
  • πŸ‘₯ Authors

πŸ“ Overview

The repository contains a project called "discord-audio-playback-bot" that provides a comprehensive solution to enhance the music experience in Discord servers through seamless playback from various music platforms.

πŸ“¦ Features

Feature Description
🎡 Music Playback Integrates multiple music sources like YouTube, Spotify, and SoundCloud for streaming music live in Discord.
⏱️ Queue Management Users can manage their own song queues, allowing songs to be added, viewed, and controlled in a structured format.
πŸ”Š Volume Control Provides commands to adjust the volume, including mute and unmute functionalities.
βš™οΈ Dynamic Commands A set of essential commands for playback control (play, pause, skip, stop) along with a help command.
πŸ” User Permissions Only users with specified roles can manage the bot, ensuring controlled usage to prevent spam.
πŸ“‚ Playlist Creation Users can create custom playlists and share these with others, enhancing community interaction.
πŸ” Search Functionality Allows users to search for songs directly from the bot, even previewing songs before adding them to the queue.
πŸ”— API Integrations Connects with various music service APIs to provide a diverse library of music.

πŸ“‚ Structure

discord-audio-playback-bot/
β”œβ”€β”€ commands/
β”‚   β”œβ”€β”€ play.js
β”‚   β”œβ”€β”€ skip.js
β”‚   β”œβ”€β”€ stop.js
β”‚   β”œβ”€β”€ queue.js
β”‚   β”œβ”€β”€ help.js
β”‚   └── search.js
β”œβ”€β”€ events/
β”‚   β”œβ”€β”€ message.js
β”‚   β”œβ”€β”€ guildMemberAdd.js
β”‚   β”œβ”€β”€ ready.js
β”‚   └── voiceStateUpdate.js
β”œβ”€β”€ models/
β”‚   β”œβ”€β”€ userModel.js
β”‚   β”œβ”€β”€ playlistModel.js
β”‚   └── songModel.js
β”œβ”€β”€ services/
β”‚   β”œβ”€β”€ musicService.js
β”‚   β”œβ”€β”€ queueService.js
β”‚   β”œβ”€β”€ playlistService.js
β”‚   β”œβ”€β”€ userService.js
β”‚   └── permissionService.js
β”œβ”€β”€ utils/
β”‚   β”œβ”€β”€ commandHandler.js
β”‚   β”œβ”€β”€ logger.js
β”‚   β”œβ”€β”€ errorHandler.js
β”‚   β”œβ”€β”€ configLoader.js
β”‚   └── permissionsHandler.js
β”œβ”€β”€ config/
β”‚   β”œβ”€β”€ env.config.js
β”‚   └── database.config.js
β”œβ”€β”€ routes/
β”‚   β”œβ”€β”€ api.js
β”‚   └── musicRoutes.js
└── middleware/
    β”œβ”€β”€ authentication.js
    β”œβ”€β”€ permissions.js
    └── logging.js

πŸ’» Installation

πŸ”§ Prerequisites

  • Node.js
  • npm
  • MongoDB

πŸš€ Setup Instructions

  1. Clone the repository:
    git clone https://github.com/spectra-ai-codegen/discord-audio-playback-bot.git
  2. Navigate to the project directory:
    cd discord-audio-playback-bot
  3. Install dependencies:
    npm install

πŸ—οΈ Usage

πŸƒβ€β™‚οΈ Running the Project

  1. Start the bot:
    npm start
  2. Ensure your bot is added to your Discord server and interact using commands defined in commands/.

βš™οΈ Configuration

Adjust configuration settings in .env to include your Discord bot token and other necessary API keys.

🌐 Hosting

πŸš€ Deployment Instructions

You can deploy the bot on services like Heroku, AWS, or DigitalOcean following the standard deployment practices of Node.js applications.

πŸ”‘ Environment Variables

Add the following to your .env:

  • DISCORD_TOKEN: Your Discord Bot Token
  • MONGODB_URI: MongoDB connection string

πŸ“œ License

This project is licensed under the MIT License.

πŸ‘₯ Authors

🌐 Spectra.Codes

Why only generate Code? When you can generate the whole Repository!