Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MrRedacted authored Sep 27, 2021
1 parent 04bd175 commit 1ce4838
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Music-Bot

To use this music bot, you must create a bot through the discord developer portal.
Once that is done, you need to create a "config.json" file and include "token", "clientId", and "guildId" in the file in order for the bot to work.

The client ID and the bot's token can be found on your developer portal once the bot is created.
The guild ID can be found through discord itself, you will need to turn on developer mode in the discord app. (This can be found in user settings - advanced, "developer mode")
Once developer mode is turned on you simply need to right click on your server's icon and click "Copy ID".

Once everything is set up, and you have installed all dependencies, you will have to run "node src/deploy-commands.js" while in the directory of the bot.
This registers the commands to your bot so that they can be used in the server.

If you choose to make more commands, or event handlers, they need to be put in either the "commands" or "events" folders respectively.
This bot is made modular enough that new functionality can be added if you so choose.
Functionality does not necessarily need to be for music playing, as the discord api allows for all sorts of fun and cool stuff.

Enjoy!

0 comments on commit 1ce4838

Please sign in to comment.