Add Getting Started

James Brotosky
2025-12-31 11:13:16 -05:00
commit cbf20ddaa3
+31
@@ -0,0 +1,31 @@
#### 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"
![botselection](https://git.racooncity.org/brotoskyj/RhythmWorks/src/branch/master/images/1.png)
- Enable the Following Bot Permissions (Next Section)
- Send Messages
- Read Message History
- Connect
- Speak
![permissionsselection](images/2.png)
- 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
![copyURL](images/3.png)
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**
![tokenReset](images/4.png)
- When you start the bot, paste the token into the prompt
6. Enable all three privileged gateway intents
![intents](images/5.png)
6. Download Necessary Files
- Windows:
- Download [yt-dlp (Windows)](https://git.racooncity.org/brotoskyj/RhythmWorks/src/branch/master/assets/yt-dlp.exe)
- Linux:
- Download [yt-dlp (Linux)](https://git.racooncity.org/brotoskyj/RhythmWorks/src/branch/master/assets/yt-dlp)
7. Place these files in the same directory as RhythmWorks
8. Keep the bot running while you want music to play
9. **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**