SR.Bot Documentation

Configuration

Note: The bot will not work properly if these settings are not configured.

Navigate to the SR.Bot folder:
- Locate the folder where sr.bot.exe is located.
Find the configuration file:
- Locate the file named sr.bot.exe.config in the SR.Bot folder.
Open the configuration file:
- Open sr.bot.exe.config and search for the comment .
Configure the bot settings:
- TwitchBotUsername: Modify this value to either your main Twitch account username or create another Twitch account to act as the bot account. If you have trouble creating another Twitch account because your phone number is already in use, go to Twitch and sign in. Click your profile image at the top left of the screen, click settings, click security and privacy, and enable "Enable additional account creation". You should now be able to create another Twitch account using the same phone number.
- TwitchOAuthToken: This is the OAuth token for TwitchBotUsername (your main Twitch account or the one you created just for the bot). You can find your OAuth token by logging into the TwitchBotUsername account on Twitch and then navigating to TwitchApps TMI. Follow the instructions to receive your OAuth token. It should look something like oauth:pp38fpvdvsqoe1f220cykwu87urihl (this is not a valid token). Protect your OAuth token like it's a password, because it is.
- TwitchChannelName: Modify this value to the Twitch account you will be streaming from, not the bot account.

Commands

`!sr`

The !sr command allows users to request songs in your Twitch chat. The command can be used in two ways:

Request by YouTube Link: Use !sr followed by a valid YouTube link to add that specific song to the queue.
Request by Song Name and Author: Use !sr followed by the song name and the author's name. SR Bot will search YouTube for the song and add the top result to the queue.

                Example:
                
                !sr https://www.youtube.com/watch?v=dQw4w9WgXcQ - Requests a specific YouTube song by link.
                
                !sr Never Gonna Give You Up Rick Astley - Searches for "Never Gonna Give You Up" by Rick Astley and adds it to the queue.

OBS Widget

The OBS widget can be enabled within SR.Bot's settings under the OBS tab. This widget allows you to display song requests directly on your stream using OBS.

Enable the Widget: Go to the OBS tab in SR.Bot's settings and toggle the widget on.
Add the Widget to OBS: In OBS, add a new Browser Source and set the URL to http://localhost:5000.

The widget will now display on your stream, showing the currently playing song and any new requests.

Third-Party Libraries

This project uses the following third-party libraries:

TwitchLib: TwitchLib is used for integrating with Twitch services. It is licensed under the MIT License. GitHub Repository | MIT License
YouTube Explode: YouTube Explode is used for interacting with YouTube. It is licensed under the MIT License. GitHub Repository | MIT License
CefSharp: CefSharp is used for embedding a Chromium browser in the application. It is licensed under the BSD License. GitHub Repository | BSD License

License

This project is proprietary software and is intended for personal use only. To view the full license agreement, please visit the End User License Agreement (EULA) page.