A Twitch bot to easily get a streamer's PBs in the game they're currently playing.
powered by therun.gg.If you aren't already, start using TheRun!
To get the bot to join your chat, head to the bot's own chat at https://www.twitch.tv/speedrunbuddy and type !join
.
You should receive a message saying the bot joined, and it should say hello in your chat!
The majority of stats commands have a feature called "game and category negotation" to handle fetching stats. This sounds fancier than it actually is. All this means is the bot will attempt to fetch stats for a specific game and / or category based on what the user does. Negotiation occurs in the following order:
- Check to see if the user has provided an argument to the command, such as "Super Mario 64 70 star." If so, the bot will use this information to either return stats for that game and category or inform the user it doesn't exist.
- Check to see if the streamer is live on The Run. If they are, the game and category can be retrieved this way.
- Get the game from Twitch, and the category from the stream title.
- If the stream title doesn't contain a known category, try to find an Any% category for the game.
- Finally, return the first found category for the Twitch game.
If a command below says (GCN) next to it, it means you can:
- Use the command without arguments, to allow the bot to automatically negotiate the game and category, or
- Provide an argument to the command with either the game, category, or both you want.
Example: !pb sm64 16 star
Example: !pbs super metroid rbo
Example: !attempts super mario sunshine Any%
!playtime
(GCN) - Get the streamer's total playtime, or amount of time actually running the game as opposed to practicing
Example: !playtime super mario bros
!speedrunbuddy disable [command]
- Disables a command. This can be used to prevent the use of commands whose stats you may believe could be used to shame, harass, or otherwise attack you.
Example: !speedrunbuddy disable !attempts
!speedrunbuddy rename [command] [newCommandName]
- Renames a command to a name of your choosing. Speedrunbuddy is meant to replace some commands, but it can be annoying if you have your own command you prefer to maintain and then two outputs appear from different bots when running a command.
Examples:
!speedrunbuddy rename !pb !peanutbutter
- Renames !pb
to !peanutbutter
!speedrunbuddy rename !pb default
- Renames !pb
back to !pb
(the default
keyword is special and will set it back to its default)
If you run into any strange, persistent issues, please DM me on Twitter at https://twitter.com/DeveloperRowan.
If you get a message saying something went wrong when trying to get the bot to join your channel, wait a couple minutes and try again. If the issue keeps occurring, please contact me so I may investigate!
You can have the bot leave and rejoin your channel at anytime, and it could be helpful to fix issues that could come up. The bot leaving your channel does NOT affect any of your stats, as these are kept by The Run. However, the bot leaving your channel WILL clear any of your command preferences.
Make sure you've uploaded a run to TheRun!
When the bot joins your channel, some very basic information is collected and stored about your channel:
- Your username
- Your display name
- Your user ID
- The date the bot joined your channel
- The bot reports when your channel last used its functionality, but only in the form of a date - logs are not kept. This is the only usage statistic collected, and does not uniquely identify any one user or action.
When the bot leaves your channel, ALL of this is cleared. Your information is deleted entirely from the database.
The bot experiences a brief 5-10 minute downtime every day at 00 (midnight) EST to automatically restart itself and apply new changes. Apologies for any interruptions this causes to your experience during this time!