Kruiz Control Documentation

July 12, 2026 · View on GitHub

Each handler provides its own triggers and actions that can be used in a triggers file. These are detailed below after the general formatting.

General
- Case Sensitivity
- Quotes
- Multi-line Inputs
- Comments
- Parameters
- Aliases
Default Parameters
Action
- Triggers
  - OnAction
- Actions
  - Action
API
- Triggers
- Actions
  - API Clear
  - API Data
  - API Get
  - API Header
  - API Method
  - API RawData
  - API Send
  - API Url
Chat
- Triggers
- Actions
  - Chat Send
  - Chat Whisper
Cooldown
- Triggers
- Actions
Debug
- Triggers
- Actions
Discord
- Triggers
- Actions
File
- Triggers
  - OnFileUpdated
- Actions
  - File Read
List
- Triggers
- Actions
  - List Add
  - List Contains
  - List Count
  - List Empty
  - List Export
  - List Get
  - List Global
  - List Import
  - List Index
  - List Join
  - List Remove
  - List Set
  - List Unique
Message
- Triggers
  - OnMessage
- Actions
  - Message Send
Miscellaneous
- Triggers
  - OnInit
- Actions
  - Args
  - AsyncFunction
  - Delay
  - Error
  - Exit
  - Function
  - Globals
  - If
  - Ignore
  - Jump
  - Label
  - Log
  - Loop
  - Play
  - Play Stop
  - Reset
  - Skip
MQTT
- Triggers
  - OnMQTT
- Actions
  - MQTT Publish
OBS
- Triggers
- Actions
Param
- Triggers
- Actions
Random
- Triggers
- Actions
SLOBS
- Triggers
- Actions
StreamElements
- Triggers
- Actions
Streamlabs
- Triggers
- Actions
Text-To-Speech
- Triggers
- Actions
  - TTS
  - TTS Stop
  - TTS Voices
Time
- Triggers
- Actions
Timer
- Triggers
  - OnTimer
- Actions
Twitch
- Triggers
- Actions
Variable
- Triggers
- Actions
Voicemod
- Triggers
- Actions

General

Trigger files are sections of triggers and actions separated by empty lines. Each trigger can be followed by 1 or more actions. Here's the general format.

<Trigger>
<Action>
...
<Action>

<Trigger>
<Action>
...
<Action>

Case Sensitivity

Triggers and Actions are case insensitive. The following example sends a message after a command.

OnCommand f 0 !caseSensitive
Chat Send "Triggers and Actions are case insensitive"

The following is also correct.

Oncommand f 0 !caseSensitive
chat SEND "Triggers and Actions are case insensitive"

Note that the message itself IS case sensitive. Whenever you are supplying parameters to Triggers or Actions, they are almost always case sensitive.

Quotes

It is highly recommended to use quotes when providing multi-word arguments. For example,

Chat Send "Some really long message"
OBS Scene "Starting Soon"

Multi-line Inputs

As of Kruiz Control v2.0.6, the inputs to triggers and actions can be split over multiple lines. For example, the below action provides a Function input via multiple lines.

OnInit
Function "
  var data = 4; 
  return { value: data * 2 };
"
Error {data}

Note: While an individual input can be multiple lines, inputs cannot be distributed over multiple lines.

The below events are NOT valid.

# Invalid because the inputs are provided on the following lines.
OnInit
Random 
  "Chat Send 'Option 1'"
  "Chat Send 'Option 2'"

# Invalid because the first input ends on the first line.
# The second option will be skipped.
OnInit
Random "Chat Send 'Option 1'"
  "Chat Send 'Option 2'"

The below is technically valid, albeit funky looking. As long as a quote is not terminated until the following line, it will be parsed as a multi-line input.

# Since the end double quote for the first input is on the second line, the second line is included when processing the action.
OnInit
Random "Chat Send 'Option 1'
  " "Chat Send 'Option 2'"

Comments

Trigger files support comments using the # character. This allows you to leave text in the trigger file that is not treated as a trigger or action.

Comment Example

# My really complicated trigger
OnCommand e 10 !example
Chat Send "This is a silly example!"


_successful_	A comma delimited list of handlers that initialized correctly.
_unsuccessful_	A comma delimited list of handlers that did not initialize correctly.
_kc_event_id_	A unique id (UUID) for each event occurrence in Kruiz Control. If you need a unique identifier for an event, use this.


Info	Used to define a list of actions that will get inserted into an event when the provided `<action>` is called.
Format	`OnAction <action>`
Format w/ Aliases	`OnAction <action1> <action2> ...`
Example	`OnAction ReadFile`
Example w/ Aliases	`OnAction ReadFile rf`


action	The `<action>` performed that triggered this event.
in#	The numbered arguments passed to the action. Replace `#` with a number, starting at 1 and ending at the last argument passed into the command.
in_count	The number of arguments passed to the action.


Info	Used to run an action by passing it through. This allows actions to be fired dynamically within an event. `<action>` is the full action that you want to complete. The action can be provided as a single argument (inside of quotes) or written out normally.
Format	`Action <action>`
Example	`Action Chat Send "Hello world"`
Example w/ Single Argument	`Action "Chat Send 'Hello world'"`


Info	Used to clear an API configuration. `<name>` is the name of the API to clear.
Format	`API Clear <name>`
Example	`API Clear HostLookup`


Info	Used to add a key-value pair as data to an API configuration. `<name>` is the name of the API to update. `<key>` and `<value>` are the inputs.
Format	`API Data <name> <key> <value>`
Example	`API Data TwitchAPI login {user}`


Info	Used to call an API and retrieve the data. `<url>` is the API to call.
Format	`API GET <url>`
Example	`API GET https://api.crunchprank.net/twitch/hosts/kruiser8?implode&display_name`


Info	Used to add a header to an API configuration. `<name>` is the name of the API to update. `<key>` and `<value>` are the input header.
Format	`API Header <name> <key> <value>`
Example	`API Header TwitchAPI "Authorization" "Oauth {token}"`


Info	Used to set the method of an API configuration. `<name>` is the name of the API to update. `<method>` is the type of API call (i.e. GET, POST, PUT, DELETE, etc.). If this is not called, the default method is `GET`.
Format	`API Method <name> <method>`
Example	`API Method TwitchAPI POST`


Info	Used to add raw data to an API configuration. `<name>` is the name of the API to call. `<raw_data>` is the API data. This can be used to add json or other formats to the API body.
Format	`API RawData <name> <raw_data>`
Example	`API RawData DummyAPI "{ user: kruiser8, text: "my custom text" }"`


Info	Used to trigger a set of actions when a command is used at the beginning of a message.
Format	`OnCommand <permission> <optional_info> <cooldown> <command>`
Format w/ Aliases	`OnCommand <permission> <optional_info> <cooldown> <command1> <command2> <command3> ...`
Example	`OnCommand e 0 !example`
Example w/ Aliases	`OnCommand bvm 0 !so !caster !sh !shout`


user	The display name of the user that sent the command.
message	The entire chat message, including the command.
message_id	The id of the message (used with Twitch DeleteMessage). If the message was sent by Kruiz Control, the id will be an empty string (`""`).
amount	The value of the Hype Chat sent by the user. Example: `500` if $5 was tipped.
formatted_amount	The formatted value of the Hype Chat sent by the user. Example: `5.00` is $5 was tipped.
currency	The ISO 4217 alphabetic currency code the user has sent the Hype Chat in.
exponent	Indicates how many decimal points this currency represents partial amounts in. Decimal points start from the right side of the value defined in `amount`.
level	The level of the Hype Chat, in English. Possible values are [`ONE`, `TWO`, ..., `TEN`], written in all caps.
is_system_message	A boolean value that determines if the message sent with the Hype Chat was filled in by the system.
data	An object with all metadata about the message (for use with Function).


Info	Used to trigger a set of actions when a keyword or phrase appears in a message.
Format	`OnKeyword <permission> <optional_info> <cooldown> <command>`
Format w/ Aliases	`OnKeyword <permission> <optional_info> <cooldown> <keyword1> <keyword2> <keyword3> ...`
Example	`OnKeyword smv 10 "music"`
Example w/ Aliases	`OnKeyword e 0 hi hello yo o7`


Info	Used to send a whisper to a user.
Format	`Chat Whisper <user> <message>`
Example	`Chat Whisper Kruiser8 "Chicken Dinner"`


Info	Used to send an API configuration. `<name>` is the name of the API to call.
Format	`API Send <name>`
Example	`API Send TwitchAPI`


Info	Used to set the url of an API configuration. `<name>` is the name of the API to update. `<url>` is the API to call.
Format	`API Url <name> <url>`
Example	`API Url TwitchAPI "https://api.twitch.tv/helix/users/follows"`


command	The command that triggered the event.
user	The display name of the user that sent the command.
after	The message excluding the command.
message	The entire chat message, including the command.
message_id	The id of the message (used with Twitch DeleteMessage). If the message was sent by Kruiz Control, the id will be an empty string (`""`).
data	An object with all metadata about the message (for use with Function).
arg#	The numbered arguments in the message. Replace `#` with a number, starting at 1 and ending at the last argument passed into the command.
arg_count	The number of arguments in the message. This indicates the number of `arg#` parameters returned.


Info	Used to trigger a set of actions when ever a chat message is sent.
Format	`OnEveryChatMessage`
Example	`OnEveryChatMessage`


user	The display name of the user that triggered the keyword.
keyword	The keyword matched by the trigger.
message	The chat message.
message_id	The id of the message (used with Twitch DeleteMessage). If the message was sent by Kruiz Control, the id will be an empty string (`""`).
data	An object with all metadata about the message (for use with Function).
arg#	The numbered arguments in the message. Replace `#` with a number, starting at 1 and ending at the last argument passed into the command.
arg_count	The number of arguments in the message. This indicates the number of `arg#` parameters returned.


Info	Used to send a message to chat.
Format	`Chat Send <message>`
Example	`Chat Send "Hello World"`


Info	Used to apply a cooldown to triggers. `<name>` is the identifier for the cooldown. `<seconds>` is the number of seconds before the trigger can fire again.
Format	`Cooldown Apply <name> <seconds>`
Example	`Cooldown Apply MyCustomTrigger 30`


Info	Used to check if a cooldown is active. `<name>` is the identifier for the cooldown.
Format	`Cooldown Check <name>`
Example	`Cooldown Check MyCustomTrigger`


<name>	[true/false] Whether or not the cooldown is active where <name> is the name of the cooldown.
cooldown	The number of seconds (rounded to a whole number) left on the cooldown. This is only returned if the cooldown is active (`<name>` is True).
cooldown_real	The decimal number of seconds left on the cooldown. This is only returned if the cooldown is active (`<name>` is True).


Info	Used to clear (remove) an existing cooldown. `<name>` is the identifier for the cooldown.
Format	`Cooldown Clear <name>`
Example	`Cooldown Clear MyCustomTrigger`


Info	Used to apply a global cooldown to triggers. Global cooldowns persist between sessions (i.e. the cooldown remains after a reset). `<name>` is the identifier for the cooldown. `<seconds>` is the number of seconds before the trigger can fire again.
Format	`Cooldown Global Apply <name> <seconds>`
Example	`Cooldown Global Apply MyCustomTrigger 30`


Info	Used to check if a global cooldown is active. Global cooldowns persist between sessions (i.e. the cooldown remains after a reset). `<name>` is the identifier for the cooldown.
Format	`Cooldown Global Check <name>`
Example	`Cooldown Global Check MyCustomTrigger`


Info	Used to clear (remove) an existing global cooldown. Global cooldowns persist between sessions (i.e. the cooldown remains after a reset). `<name>` is the identifier for the cooldown.
Format	`Cooldown Global Clear <name>`
Example	`Cooldown Global Clear MyCustomTrigger`


Info	Used to enable all debugging.
Format	`Debug`
Example	`Debug`


Info	Used to enable debugging for Chat events.
Format	`Debug Chat`
Example	`Debug Chat`


Info	Used to enable debugging for internal event handling.
Format	`Debug Controller`
Example	`Debug Controller`


Info	Used to enable debugging for internal debug handling.
Format	`Debug Debug`
Example	`Debug Debug`


Info	Used to enable debugging for MQTT events.
Format	`Debug MQTT`
Example	`Debug MQTT`


Info	Used to enable debugging for OBS events.
Format	`Debug OBS`
Example	`Debug OBS`


Info	Used to enable debugging of Kruiz Control's parser to see how Kruiz Control is interpreting event code.
Format	`Debug Parser`
Example	`Debug Parser`