Added readme and license

2025-12-29 15:39:45 -05:00
parent 2b62bd3683
commit 1512018a4f
9 changed files with 104 additions and 22 deletions
@@ -0,0 +1,63 @@
+## Welcome to RhythmWorks
+Please use the [getting started](#getting-started) section for instructions on how to create a bot for RhythmWorks
+### Getting Started
+#### You will need to create a bot in Discord for this to work. This is not an application you can add from Discord's App Store.
+1. Go to the [Discord Development Portal](https://discord.com/developers/applications)
+2. Click New Application
+3. Give it a name
+4. Go to the OAuth2 Section
+    - Check mark the "bot" option under "OAuth2 URL Generator"
+    - Enable the Following Permissions
+        - Send Messages
+        - Read Message History
+        - Connect
+        - Speak
+    - Copy the Generated URL and paste it into your browser
+    - This will automatically launch discord and allow you to add the bot to your server
+5. Go to the "Bot" Section
+    - Click "Reset Token" and copy it 
+        * **You will need to save this in a secure place. This current version does not have a save functionality and you will have to type it in every time**
+    - When you start the bot, paste the token into the prompt
+    
+6. Keep the bot running while you want music to play
+7. **IMPORTANT - You will need to !stop the currently playing track or wait for the track to finish before you start playing a new song. If you don't, the two tracks will play overtop of each other**
+### Commands
+
+```
+!join
+```
+This will join the bot to your current voice channel
+
+```
+!play https://youtube.com/full-url
+```
+This will play the youtube audio from the URL 
+
+```
+!stop
+```
+Completely stops the bot
+```
+!pause
+```
+Pauses the currently playing track
+```
+!resume
+```
+Resumes the paused track
+```
+!leave
+```
+The bot will leave the channel
+
+### Roadmap
+
+- Add save funtionality for Discord Bot Token
+
+- User Interface for the admin or whoever the person is who started the bot to have a heads up display and be able to control the bot
+
+
+## License
+
+[AGPLv3](https://choosealicense.com/licenses/agpl-3.0/)
+