Actions
Introduction
Perhaps the most important piece of Streamer.bot, actions are at the center of everything you do.
You can configure actions for anything from basic alerts and shoutouts to extremely complex integrations such as TerrierDart's Leaderboard Points System
Actions consist of configurable sets of sub-actions that can be executed by Streamer.bot's event sources, such as Triggers, Commands, various integrations such as Elgato Stream Deck, and even your own voice!
Sub-actions even have the ability to trigger other actions, giving you the ability to organize significant pieces of your setup into consolidated sections, and share logic across multiple event sources.
As sub-actions are executed, another important feature of Streamer.bot comes into play, the argument stack, which consists of all variables available at a given time.
Each sub-action has the ability to populate new variables for upcoming sub-actions, read existing variables from earlier sub-actions, or even modify them on the fly!
Actions
The actions tab is split into 3 main parts:
Actions- All of your configured actions are listed here, sorted by groupTriggers- All triggers configured for the selected action will be listed hereSub-Actions- All sub-actions configured for the selected action will be listed here
Configuration
To create your first action, Right-Click in the actions pane and select Add to open the configuration dialog
Options
The friendly name the action will be referred as throughout the bot
NoneOptionally type or select a group name.
This is used to organize similar actions into collapsible sections to keep the interface clean if you have a large number of actions
trueAssign this action to an Action Queue
Default queue is configured as a non-blocking queue, meaning actions will execute immediately on request and are allowed to run concurrently.trueToggle this action on or off
trueRandomly execute a single sub-action from within this action
Weight configuration on sub-actions, allowing you to adjust the probability that specific sub-actions will be chosen.trueExecute all sub-actions in this action simultaneously, rather than waiting for each step to complete.
trueForce this action to execute even if the queue is in a Paused state
trueExclude this action from being logged to the action history.
Context Menu
Right-Click any existing action to reveal the context menu:
Many of the action configuration options outlined above can be quickly modified here.
Additional context menu options are outlined below:
Options
Create a new action. Opens the Add Action dialog.
Open the configuration dialog for the selected action
Delete the selected action
By default, you will be asked for confirmation with the option to hide all future confirmations.
You can reinstate delete confirmations in the Settings tab
Create a copy of the selected action, including all of its sub-actions.
Copy the unique ID of the selected action to your clipboard.
Collapse all action groups in the action pane
Expand all action groups in the action pane
Sub-Actions
To activate the sub-actions pane, you must first select an action via Left-Click in the actions pane.
With an action selected, you can then Right-Click anywhere in the sub-actions pane, on the right, to browse available sub-actions and add them to your selected action.
Context Menu
- Right-Click anywhere in the sub-actions pane to browse and add a new sub-action
- Right-Click any existing sub-action to reveal additional context menu options
Options
Opens the list of sub-actions you have marked as favorites.
You can toggle any sub-action as a favorite by using Right-Click on any item in the hierarchical sub-action menus.
Open the configuration dialog for the selected sub-action
This is the same as using Double-Click on the sub-action itself
Copy the selected sub-action, including its configuration, to the clipboard
Paste a copied sub-action into the selected action
Clones the selected sub-action into the currently open action
Delete the selected sub-action
By default, you will be asked for confirmation with the option to hide all future confirmations.
You can reinstate delete confirmations in the Settings tab
Create a sub-action group
- If the action contains any groups the
Move to Groupsub menu will also display below this option
Delete the selected group
- Only displays if current selection is a group folder
Rename the selected group
- Only displays if current selection is a group folder
Boolean flag for disabling a sub-action for diagnostic purposes
- Disabled sub-actions will be highlighted with red text
Boolean flag to set a group folder as Random Execution
This will only execute a single, random sub-action from within the group.
The weight of the Sub-Action when the Action/Group is set on Random.
Weight options on sub-actions inside that group.
Weighting is used to make a sub-action more or less likely to be chosenRemove all sub-actions from this action
By default, you will be asked for confirmation with the option to hide all future confirmations.
You can reinstate delete confirmations in the Settings tab
Change the order of your sub-actions
This has the same effect as keyboard shortcuts Ctrl + ↑ and Ctrl + ↓
Valid options are Up, Down, Top, Bottom
Action Queues
In Streamer.bot, all actions exist within a queue. The Default queue is created automatically and will contain all action executions unless specified otherwise.
Queues
In this section, you will find all the queues that have been created.
At a glance, you can view the status of several queue properties:
Pending Count: Number of actions waiting to be executed within the respective queueCompleted Count: Number of actions that have completed execution within the respective queue- This includes actions that have been cancelled - learn more in Action History
Paused: Shows the current paused status of this queueBlocking: Shows whether the queue is configured as aBlockingqueue
Context Menu
You can Right-Click within the Queues pane to reveal the context menu:
Options
Create a new Queue, configuration detailed below
- Available if you Right-Click on a specific queue
- Available if you Right-Click an empty space within the Queues pane
This option displays the current action you can perform on the queue.
- Available if you Right-Click on a specific queue
- If the queue is currently
Paused, you can selectResumeto restart a queue and trigger any pending actions. - If the queue is currently
Active, you can selectPauseto temporarily stop new actions from being triggered in that queue. Once resumed, pending actions will be processed.
Toggle the Blocking state of the selected queue.
If selected, check mark will appear beside Blocking, indicating that the queue will execute actions in sequence.
- Available if you Right-Click on a specific queue
Clears the selected queue of any pending actions.
- Available if you Right-Click on a specific queue
Immediately pause all queues.
- Available if you Right-Click on a specific queue
- Available if you Right-Click an empty space of Queues area
Immediately resume any queues which are currently paused.
- Available if you Right-Click on a specific queue
- Available if you Right-Click an empty space of Queues area
Configuration
To create a new queue, Right-Click within the queues pane and select Add
Options
Enter a descriptive name for your new queue
falseBy default, all queues execute actions immediately, with no wait.
To execute actions in sequence, waiting for each previous action to complete, you can enable the Blocking option.
Pending Actions
The pending actions view will display any queued actions which are waiting to run.
Action History
The action history view will display a log of all actions that have been executed by Streamer.bot
At a glance, you can view the following properties:
Name: The name of the executed actionState: The current status of the executed action- e.g.
Completed,Cancelled,Pending
- e.g.
Variables: The number of variables populated by this actionDuration: Time, in milliseconds, the action took to finish executionQueue: The name of the queue this action was executed inQueued At: The date and time the action was initially queued for executionStarted At: The date and time the action began executionCompleted At: The date and time the action finished execution
Context Menu
You can Right-Click on any entry to open the context menu:
Open a dialog which shows all variables, and their values, available to the action when it was initially queued
Open a dialog which shows all variables, and their values, available at the end of action execution
Re-add the completed action to the queue to be executed again
Remove all current records from the Action History view