• Bot
  • !announce - Announcements
    • nosleep - Disables automatic sleep
    • start - Re-enables announcements after being disabled
    • stop - Disables announcements completely
    • time - Sets the frequency of Announcements
    • list - Lists all of the commands to the console
    • del - Deletes an announcement by ID.
    • add - Adds a new announcement to Default category
    • enable - Enables an announcement by ID
    • disable - Disables an announcement by ID
    • status - Displays status in chat
    • category - Base command
      • add - Add a new category
      • del - Deletes a category by ID
      • list - Lists the available categories to the console
      • assign - Assign an announcement to a category
      • activate - Sets a category as active
  • !channelpoint_cooldown - Base command
    • attention - Sets Attention cooldown
    • treat - Sets Treat cooldown
  • !allowlinks - Allows links from a user to be sent to discord
  • !disable_attn - Disable Attention
  • !ignorelinks - Ignore links from a user to be sent to discord
  • !treatme - Sends a Treat
    • enable - Enables the treatbot
    • disable - Disables the treatbot
  • !treatmenow - Force sends a treat
  • !topic - Chat Topic (Alias: !project)
    • set - Sets a topic
    • goal - Sets the goal for the topic
    • step - Sets the current step for the topic (Alias: !step)
    • link - Sets the link for the topic
  • wig - Base command
    • poll - Start a wig poll
    • time - Set duration of wig poll
    • add - Add a new wig
    • del - Delete a wig by ID
    • list - Lists current wigs
    • disable - Disable a wig
    • enable - Enable a wig
    • used - Mark a wig as used for the current stream.
    • reset - Resets all of the wigs currently marked as used.
  • stream - Stream controls
    • live - Sets the bot to Live status
    • status - Shows the stream status
    • lab - Sets the location to In the Lab
    • office - Sets the location to In the Office
  • mqtttest - Tests the connection to MQTT
  • ignore - Ignore users based on a pattern
    • add - Adds a user to the ignore list
    • del - Removes a pattern from the ignore list
    • enable - Enable pattern by ID
    • disable - Disable pattern by ID
  • clear_poll - Clears the setup data in MQTT for the poll display.
  • so - Shoutouts
    • msg - Set the shoutout message
  • trivia - Trivia base command
    • winner - Announce the winner of the most recent trivia
  • vipupdate - Forces the bot to sync with Twitch's VIP list
  • todo - The bot will send the entire contents of the message to a pre-defined discord channel
• Web
  • /send_command
    • POST - Send a command to the bot
  • /topic
    • GET - Show chat topic
    • POST - Set chat topic
  • /ignore
    • GET - Show table of ignored users
• MQTT

Permission: Admin (for all sub commands)

Base command, doesn't do anything directly

This is saved in the database and will survive restarts.

This is saved in the database and will survive restarts.

Send the time in seconds as a parameter for frequency of announcements.

Send the ID as a parameter. If message is the last in the active category, resets active category to Default

Send the Announcement you want to add as the parameter

Send the ID to be enabled as the parameter

Send the ID to be disable as the parameter

Doesn't do anything directly

Send name of new category as paremeter

Send ID as parameter to delete category. Must not have any announcements assigned Can not delete Default

Send {AnnouncementID:int} {CategoryID:int} as parameters

Sets the {CategoryID:int} as the active category.

Permission: Admin For setting channelpoint cooldowns

Permission: Admin Send new cooldown in seconds as parameter

Permission: Admin Send new cooldown in seconds as parameter

Permission: Admin Send username to allow links from as the parameter

Permission: Admin Disables sending the MQTT publish to twitch-attn-indi

Permission: Admin Send username to ignore links from as the parameter

Permission: Everyone / Admin Sends a MQTT publish of 1 to dispense-treat-toggle if an Admin user and emoji requirements have been met. Sends a message to the channel reminding users to use the emoji

Permission: Admin Note: Does not survive bot restart.

Permission: Admin Note: Does not survive bot restart.

Permission: Admin Immediately sends a treat, for testing purposes

Permission: Everyone Posts to chat the currently set topic

Permission: Admin

• !topic set New topic text

Permission: Admin

• !topic goal New goal text

Permission: Admin

• !topic step New text for the current step

Permission: Admin

• !topic link New note or link for project

Permission: Admin

Permission: Admin Send time in seconds as parameter

Permission: Admin Send wig name as parameter

Permission: Admin Send wig ID as parameter

Permission: Admin

Permission: Admin Send wig ID as parameter

Permission: Admin Send wig ID as parameter

Permission: Admin Send wig Name as parameter

Permission: Admin No parameters

Permission: Admin Base Command

Permission: Admin Send "true" or "false" as parameter

This is intended for use by automated scripting, and should only be used to fix an invalid state.

Permission: Admin

Permission: Admin

Permission: Admin

Permission: Admin

Sends the arguments as the value to stream/mqtttest topic.

Permission: Admin

Parameters: Regex pattern for desired username to be ignored.

Permission: Admin

Paramaters: ID of pattern to remove.

Permission: Admin

Permission: Admin

Permission: Admin

Permission: Admin, Groups with the "so" permission. Paramaters: Username to shoutout to Responds with the shoutout message for the username specified, or with the last raided user.

Permission: Admin Parameters: Message Adding {channel} to the message will be replaced by the username being highlighted.

Permission: Admin

Permission: Admin

Permission: Admin

Permission: todo (Intended for VIP's to use)

Requires

• access_token header
• JSON object as the data with:
  • command: The command to send
  • args: Arguments to pass to the command, include subcommands here. Must be a LIST ex: [arg1, arg2, arg3]

Example with curl:

curl --header "Content-Type: application/json" --header "access_token: testKey" --request POST --data '{"command":"!topic", "args":["set", "New", "topic"], "silent":false}' http://localhost:5000/send_command

Returns the current Bot topic as a json object of {"topic":"Topic text"}

Requires

• access_token header
• JSON object as the data with topic as the only needed key, and text as the value.

  {"topic":"Topic text"}

Example with curl:

curl --header "Content-Type: application/json" --header "access_token: testKey" --request POST --data '{"topic":"Test topic sent from a json post"}' http://{WEB_HOSTNAME}/topic

All Stream related MQTT topics are prefixed with stream/

• treat-in-queue TwitchBot sends 1 when a treat is in the queue
• dispense-treat-toggle TwitchBot sends 1, TreatBot should listen for 1. TreatBot should reset to 0 when done.
• treat_status TwitchBot sends json object of TreatBot status. {"current": int(current count), "needed":int(needed count), "complete": bool(True if treat is being dispensed.)}
• twitch-attn-indi TwitchBot sends 1, AttentionBot should listen for 1. AttentionBot should reset to 0 when done.
• channel-raid TwitchBot sends username of raider
• channel-subscription TwitchBot sends username of subscriber
• channel-cheer TwitchBot sends json of {"username": username, "bits": bits_used, "total_bits": total_bits_used}
• channel-follow TwitchBot sends str of username that followed.
• yay-toggle TwitchBot sends 1, OBSBot should listen for 1 to activate Yay scene.
• poll/setup TwitchBot sends json of poll setup data
• poll/data TwitchBot sends json of poll data
• verify1k TwitchBot sends 1
• mqtttest TwitchBot sends string of args given
• first_time_chatter TwitchBot sends json {"author":"author name", "timestamp"=str(datetime.now())} when a new chatter is seen ever.
• new_chatter_topic TwitchBot sends json {"author":"author name", "timestamp"=str(datetime.now())} when a new chatter is seen for the first time this stream.

This is a test, this is only a test.