TrioBot Documentation

• !commands

  Lists available custom commands.

  Examples:

  TwitchUser: !commands

  TerribleTrioBot: !commands, !timer, !custom, !something, !other
• !addcommand !add

  Adds a custom command.

  Only usable by authorized users.

  For full documentation on custom command responses, see the section below.

  Examples:

  TwitchUser: !addcommand !test This is a test

  TerribleTrioBot: Added !test
• !editcommand !edit

  Edits a custom command, or adds it if it does not exist.

  Examples:

  TwitchUser: !editcommand !test This is an edited test

  TerribleTrioBot: Edited !test
• !deletecommand !delete !remove

  Removes a custom command.

  Examples:

  TwitchUser: !deletecommand !test

  TerribleTrioBot: Deleted !test
• !timer !time

  The available timer subcommands are: check, start, restart,and reset

  !time can be used in place of !timer for all examples below.

  check or no subcommand

  Check the elapsed time

  Examples:

  TwitchUser: !timer check

  TerribleTrioBot: 1:17 has elapsed

  TwitchUser: !timer

  TerribleTrioBot: 1:17 has elapsed

  start [initialTime]

  Starts the timer.

  If initialTime is specified the timer will start with that amount of time elapsed. initialTime can be specified as hh:mm:ss or an integer number of seconds.

  If the timer is already running, this command will do nothing.

  Examples:

  TwitchUser: !timer start

  TwitchUser: !timer start 1:17

  TwitchUser: !timer start 117

  TwitchUser: !timer start

  TerribleTrioBot: Timer is already started. Use !timer restart instead.

  restart [initialTime]

  Starts the timer, similar to !timer start.

  If the timer is already running, this command will restart it.

  Examples:

  TwitchUser: !timer restart

  reset

  Stops and resets the timer.

  Examples:

  TwitchUser: !timer reset

Authorized users can add custom commands that the bot will respond to for all users. There are two types of custom command responses: static and dynamic.

When adding or editing a custom command, the response is all text after the command name.

Examples:

Static Responses

Static responses are simple text responses that do not change. In other words, the command will always result in the same message sent in response by the bot. Responses are static if they do not contain a dynamic section.

Examples:

Dynamic Responses

Dynamic responses allow for more interesting bot interaction.

To create a dynamic response, the response must have at least one dynamic section. Dynamic sections are composed of a dynamic function call between double square brackets ([[ and ]]).

Examples:

Dynamic Functions

The available dynamic functions are: arg, args, randInt, and user

• arg {index}

  Replaces the dynamic section with the space-separated command argument specified by the given index.

  index is required.

  The index starts from 0 (so the first argument is arg 0).

  An invalid index will result in the dynamic section being replaced with an empty space.

  Examples:

  Command definition:

  !hello Hello [[arg 0]]

  TwitchUser: !hello abc

  TerribleTrioBot: Hello abc

  Command definition:

  !hello Hello [[arg 2]]

  TwitchUser: !hello abc def ghi jkl

  TerribleTrioBot: Hello ghi

  Command definition:

  !hello Hello [[arg 42]]

  TwitchUser: !hello abc def

  TerribleTrioBot: Hello
• args

  Replaces the dynamic section with everything after the command name.

  Examples:

  Command definition:

  !hello Hello [[args]]

  TwitchUser: !hello abc def

  TerribleTrioBot: Hello abc def

  Command definition:

  !quote "[[args]]" said the other twitch user

  TwitchUser: !quote something random

  TerribleTrioBot: "something random" said the other twitch user
• randInt {min} {max}

  Replaces the dynamic section with a random integer between min inclusive and max exclusive (math notation: [min, max)).

  min and max are both required and must be integers.

  Examples:

  Command definition:

  !pbchance There is [[randInt 0 100]]% chance of PB

  TwitchUser: !pbchance

  TerribleTrioBot: There is a 42% chance of PB
• user

  Replaces the dynamic section with a mention of the user who sent the command (i.e. @terribletriojoe).

  Examples:

  Command definition:

  !hello Hello [[user]]

  TwitchUser: !hello

  TerribleTrioBot: Hello @TwitchUser

TrioBot has a simple permissions model. There are authorized users and normal users.

Authorized users are the channel owner, and specific users chosen by the owner.

Normal users are everyone else.

Authorized users can add, edit, and remove custom commands. They can check, start, restart, and reset the timer. They can also use custom commands.

Normal users can check the timer and use custom commands.

Normal users have a 30 second cooldown per command.

Authorized users have a 3 second cooldown per command.

Reach out to TerribleTrioJoe if you have questions.