chords
chords copied to clipboard
A self-hosted music discord bot, with detailed documentation and constantly upgrading features. Attached below is the documentation to deploy the bot. : )
Chords
On a mission to build the best Discord Music Bot
View Demo
·
Report Bug
·
Request Feature
.
Deploy Walkthrough
Table of Contents
-
About The Project
- Built With
-
Getting Started
- Prerequisites
- Installation
- Bot Commands
- Configuration - Discord Developer Portal
- Roadmap
- Contributing
- License
![](https://github.com/Yoda-Canada/chords/blob/issue-32/icon/Toicon-icon-fandom-annoy.svg.png)
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.
![](https://github.com/Yoda-Canada/chords/blob/issue-32/icon/note.png)
Built With
![](https://github.com/Yoda-Canada/chords/blob/issue-32/icon/Toicon-icon-fandom-charm.svg.png)
Getting Started
To get a local copy up and running follow these simple steps.
![](https://github.com/Yoda-Canada/chords/blob/issue-32/icon/note.png)
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)
![](https://github.com/sagarkumar3105/chords/blob/1bb1bd0e28adabdd1d76ee3bbbc40f3befc2314e/icon/1.png)
Installation for Windows users
-
Download the installation file from this link.
-
Right click on the downlaoded file and run it as administrator.
-
Create a Bot from the Discord Developer Portal and copy the Bot token. Create a
.env
file and paste the Token.TOKEN = "Your Token"
-
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
![](https://github.com/sagarkumar3105/chords/blob/b29d6e853ad9a70a33efdffd4da4c7763b96cbb6/icon/linux-logo.png)
Installation for other users
-
Fork the project first
-
Clone this repo on your local machine
git clone https://github.com/amanjha8100/chords
-
In the project directory, install the packages using
pip install -r requirements.txt
-
Create a Bot from the Discord Developer Portal and copy the Bot token. Create a
.env
file and paste the Token.TOKEN = "Your Token"
-
Invite the Bot to your server and run
python app.py
![](https://github.com/Yoda-Canada/chords/blob/issue-32/icon/Toicon-icon-fandom-steal.svg.png)
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 ✔️
![](https://github.com/Yoda-Canada/chords/blob/issue-32/icon/Toicon-icon-fandom-rap.svg.png)
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.
![](https://github.com/Yoda-Canada/chords/blob/issue-32/icon/Toicon-icon-fandom-submerge.svg.png)
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 |
:white_check_mark: |
pn |
:white_check_mark: |
pause |
:white_check_mark: |
resume |
:white_check_mark: |
remove |
:white_check_mark: |
restart |
:white_check_mark: |
queuetime |
:white_check_mark: |
help |
![](https://github.com/Yoda-Canada/chords/blob/issue-32/icon/Toicon-icon-fandom-drop.svg.png)
Roadmap
See the open issues for a list of proposed features (and known issues). Feel free to raise new issues.
![](https://github.com/Yoda-Canada/chords/blob/issue-32/icon/Toicon-icon-fandom-shred.svg.png)
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Add your Changes (
git add .
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
![](https://github.com/Yoda-Canada/chords/blob/issue-32/icon/Toicon-icon-fandom-sound.svg.png)
License
Distributed under the MIT License. See LICENSE
for more information.