Table of Contents

DOCS

OVERVIEW

This section is documentation of the special functions available for TheBushyBot commands. These functions provide users with a range of advanced capabilities to enhance their interaction with the bot.

DEFAULT COMMANDS

These are the default commands available for TheBushyBot.

!commands

  • Description: Displays a link in the chat that directs users to a webpage listing all the current commands available for a channel.
  • Example: !commands

    • !enter

  • Description: Enables users to participate in an ongoing channel giveaway by entering their name for a chance to win.
  • Example: !enter

    • !followage

  • Description: Sends a chat message displaying the duration that the command initiator or mentioned user has been following the channel.
  • Format: !followage or !followage @mentionedUser
  • Example: !followage @thebushybot

    • !game

  • Description: Allows users to update the broadcast category for the channel. It is recommended to assign this command a userlevel of "mod" or higher.
  • Format: !game {gameName}
  • Example: !game Just Chatting

    • !so

  • Description: Enables users to give a shoutout to other streamers. This command sends a chat message and uses Twitch's built-in /shoutout command. It is recommended to assign this command a userlevel of "mod" or higher. Additionally, this command requires an @mention, while other commands may not necessarily require one.
  • Format: !so @username
  • Example: !so @thebushybot

    • !subcount

  • Description: Sends a chat message displaying the current total number of subscribers for the channel.
  • Example: !subcount

    • !title

  • Description: Allows users with appropriate permissions to update the broadcast title of the channel. It is recommended to set the userlevel of this command to "mod" or higher.
  • Format: !title {newTitle}
  • Example: !title Streaming TheBushyBot!

    • !uptime

  • Description: Sends a chat message displaying the duration that the channel has been live during the current session. Note that this command does not work for offline channels.
  • Example: !uptime


    • VARIABLES

    All variables are called within commands with this format $(variable). Some variables have addition parameters which will be listed below.

    Array

  • Description: This is used to pick an item from a list at random.
  • Format: $(array):[item1, item2, item3]
  • Example: $(array):[toast, pancakes, waffles]

    • Channel

  • Description: This is replaced with the channel name where the command was initiated.
  • Format: $(channel)

    • Time

  • Description: This is used to get the current time of the seleted timezone.
  • Format: $(time {timezone})
  • Available Timezones: EST, PST, CST, and MST.
  • Example: $(time EST)

    • Touser

  • Description: This is replaced with either the name first mentioned user or the name of the user that initiated the command.
  • Format: $(touser)

    • URLFetch

  • Description: This is used to access 3rd party APIs. This returns a Content-Type of text/plain.
  • Format: $(urlfetch):[https://someExistingAPI.someExistingDomain]

    • User

  • Description: This is replaced with the name of the user that initiated the command.
  • Format: $(user)