Commands work the same as any other chatbot. When a command is activated its actions will run. Actions are instructions for the command. Commands are created on the commands page or from chat using the syntax -
- !command add !NAME RESPONSE
- !command new !NAME RESPONSE
- !cmd add !NAME RESPONSE
- !cmd new !NAME RESPONSE
- !cmd remove !NAME
- !cmd del !NAME
Adding commands from chat adds the ChatMessage action.
Triggers are what will activate your command. A command can have any amount of triggers. The following triggers exist:
- ChatMessage: Runs when a specified message in sent in the format of !TRIGGER_NAME
- Follower: Runs when a user follows the stream.
- Welcome: Runs when a user speaks in chat for the first time that stream.
- Constraint: Only welcome a specific user or every user.
Actions are the instructions that your command follows. Commands can do a lot more than send a message! You can play sound effects, record clips, make API requests, and much more.
A full list of actions can be found here
Settings are properties for your commands. You can restrict thier usage by points or rank. You can also add cooldowns and set a command to run on a set interval.
This is how many points it takes to activate the command. The user must have the set amount or more to run the command.
This is the amount of times the command has been used. You can set this to any value or leave it at 0. Every time the command is used the command counter will increase by one. This can be seen in the $cmdcount variable.
This is how long the command must wait to run after being used. If someone attempts to use it while on cooldown the cooldown message will be sent to chat. This can be customized on the command settings page. Setting it to 0 removes the cooldown.
Values are in minutes
You can limit points by bot ranks. This can be used to make mod only commands or limit certain commands to long time supporters. Note that this restricts the command to the specified rank and above, not just the rank itself. You will want to adjust the rank tiers on the rank page.
If the command has repeat enabled it will be added to the repeat list. This list will run one of the commands on a set timer. The timer and other settings related to repeating commands can be found on the command settings page.
This setting allows you to delete the trigger that actived the command (!cmdname). The bot must have delete message mod setting on Glimesh. The trigger will be deleted when all of the actions have finished running. This only affects chatmessage triggers.
Determines if the command is allowed to run.