Skip to content

Latest commit

 

History

History
109 lines (68 loc) · 5.93 KB

README.md

File metadata and controls

109 lines (68 loc) · 5.93 KB
Raw

Xinguinho Discord Bot

It is a Discord music bot built using discord-player & discord.js library.

This bot is modified for my personal use in my brazilian discord server and it is not used for commercial purposes.

Open Source Disclaimer

This repo is a fork of the open source discord-player-bot repo with my additions and modifications.

If you want to fork this project, please do it on the original open source project.

Table of Contents

Features

  • Beginner-Friendly: Designed with simplicity in mind, making it easy for users of all skill levels to understand and use.
  • Quick Setup: Get the bot up and running swiftly with straightforward installation instructions and minimal configuration requirements.
  • Versatile Commands: A comprehensive range of commands to cater to various music playback needs, ensuring an enjoyable listening experience for all users.
  • Audio Filters: Access to 25 different ffmpeg audio filters, allowing users to customize their listening experience to their preferences.
  • Multi-Guild Support: Effortlessly manage the bot across multiple Discord guilds, providing flexibility for diverse communities.
  • Platform Integration: Supports various platform links, enabling users to play music from a wide range of sources, including YouTube, Spotify, SoundCloud, Apple Music, Reverbnation, Deezer, Tidal, and more.
  • Slash Commands: Take advantage of slash commands for seamless interaction with the bot, enhancing user experience and accessibility.

Disclaimer (Terms of Use)

This project is intended for educational and entertainment purposes only. It is not designed to encourage or facilitate any form of unfair usage. If you represent a supported streaming platform and have concerns about the bot's functionality, please reach out to us via GitHub Discussions or our support channels for a constructive dialogue.

Disclaimer (if self-hosted)

  • Prohibited Use: Uploading this bot to any bot listing service such as Discord Bot List or top.gg is strictly prohibited.
  • Community Hosting Only: You are authorized to host this bot exclusively for your community's use.
  • Security Responsibility: Hosting the bot on public platforms like Glitch.com or repl.it poses a risk of bot token exposure. In the event of such an incident, you are solely responsible for any consequences.

We appreciate your cooperation and understanding in adhering to these guidelines.

Installation

Before You Start

Before diving into the setup process, ensure you have the following prerequisites:

  • Discord Token A Discord application with a bot token. You can create one by following the Discord Developer Portal guide.

  • Node.js: Version 20 or higher is required. If you haven't already installed Node.js, you can download it from the official website.

  • NPM: A package manager is required. NPM comes bundled with Node.js, so no separate installation is required.

  • FFmpeg or Avconv: Ensure you have FFmpeg or Avconv installed for media transcoding. You can download (recommended) FFmpeg from the official website or install it via npm npm i ffmpeg-static.

Config

To configure the Discord Player Bot, you'll need to set up environment variables in a .env file. Here's how to do it:

  1. Create .env File: In the root directory of the cloned repository, create a new file named .env.

  2. Use .env.sample as Template: Open the .env.sample file provided in the repository. This file contains a template with placeholders for environment variables.

  3. Fill in Environment Variables: Replace the placeholder values in the .env.sample file with your actual values. Refer to the comments in the file for guidance on each variable.

  4. Save as .env: After filling in the environment variables, save the file as .env in the same directory. This file will be used by the bot to load configuration during runtime.

  5. Review Configuration: Double-check the configuration in the .env file to ensure that all necessary variables are properly set.

By following these steps and customizing the .env file with your specific configuration, you can effectively set up the Discord Player Bot according to your requirements.

Local Installation

  1. Fill the .env File: Ensure that you have filled out the necessary environment variables in the .env file as described above.

  2. Install Dependencies: Install the required dependencies by running the following command in the project directory:

    npm install

  3. Register Slash Commands: If you are using this bot for the first time or have added new commands, you need to register the slash commands with Discord. Run the following command:

    npm run register

    This will register all the slash commands defined in your project with Discord. You should see a message indicating the number of commands registered.

  4. Run the Bot: Start the bot by running:

    npm start

    This will launch the bot, and it will connect to Discord using the provided token.

Usage

Once the bot is running and added to your Discord server, you can use the features it provides. For detailed command usage and examples, please refer to the Commands documentation.

Contributing

Please check the open source project discord-player-bot