Skip to content

Latest commit

 

History

History
211 lines (160 loc) · 7.76 KB

README.md

File metadata and controls

211 lines (160 loc) · 7.76 KB
Raw
Banner

Logo

Chords

On a mission to build the best Discord Music Bot

View Demo · Report Bug · Request Feature . Deploy Walkthrough

Table of Contents
  1. About The Project
  2. Getting Started
  3. Bot Commands
  4. Configuration - Discord Developer Portal
  5. Roadmap
  6. Contributing
  7. License

About The Project

Most of the Discord Music Bots are down. They got banned, unfortunately.
So we thought of making our own Discord Music Bot for our Discord Community.

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You should have Python and FFmpeg installed in your system if not then don't worry the installation file will get you everything if you are using a windows machine

  • Active internet connection through out installation (Must)
  • Python3 (Must for Other Users)
  • FFmpeg (Must for Other Users)

Installation for Windows users

  1. Download the installation file from this link.

  2. Right click on the downlaoded file and run it as administrator.

  3. Create a Bot from the Discord Developer Portal and copy the Bot token. Create a .env file and paste the Token.

    TOKEN = "Your Token"

  4. Invite the Bot to your server and run

    python app.py

*Incase you are unable to install with above instructions then follow the Instructions for other users

Installation for other users

  1. Fork the project first

  2. Clone this repo on your local machine

    git clone https://github.com/amanjha8100/chords

  3. In the project directory, install the packages using

    pip install -r requirements.txt

  4. Create a Bot from the Discord Developer Portal and copy the Bot token. Create a .env file and paste the Token.

    TOKEN = "Your Token"

  5. Invite the Bot to your server and run

    python app.py

Configuration - Discord Developer Portal

Go to the Discord Developer Portal to create your application and bot. You must give the following permissions:

  • Server Members Intent ✔️
  • Text Permissions:
    • Send Messages ✔️
    • Read Message History ✔️

Available Bot Commands

_p : Plays the song with search keyword following the command
_cp: Shows the currently playing song
_pn : Moves the song to the top of the queue
_pause : Pause the currently playing song
_resume : Resume the currently playing song
_q : Shows the music added in list/queue
_qt : Shows the total time of music in the list/queue
_s : Skips the currently playing music
_r : removes song from queue at index given.
_l : Commands the bot to leave the voice channel
_help : shows all the commands of the bot.
_rep : Repeats the current playing song
_sleep : To set timer.

Required roles

To run some of the commands, the user must have some specific roles. The following table illustrates the roles which are necessary for running specific commands. If a command is ticked for more than one role, then this means that both roles have the permission for running the command.

Command DJ
play
playing
queue
clear
shuffle
skip
voteskip
leave ✅
pn ✅
pause ✅
resume ✅
remove ✅
restart ✅
queuetime ✅
help

Roadmap

See the open issues for a list of proposed features (and known issues). Feel free to raise new issues.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch ( git checkout -b feature/AmazingFeature )
  3. Add your Changes ( git add . )
  4. Commit your Changes ( git commit -m 'Add some AmazingFeature' )
  5. Push to the Branch ( git push origin feature/AmazingFeature )
  6. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.