Actions

Configuration of actions, sub-actions, and queues

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

To get started, navigate to Actions in Streamer.bot

Streamer.bot Actions Configuration

The actions tab is split into 3 main parts:

Actions - All of your configured actions are listed here, sorted by group
Triggers - All triggers configured for the selected action will be listed here
Sub-Actions - All sub-actions configured for the selected action will be listed here

Explore the Import & Export Guide to learn how to import actions shared by the community!

Configuration

To create your first action, in the actions pane and select Add to open the configuration dialog

Add Action Dialog

Options

Name

Text required

The friendly name the action will be referred as throughout the bot

Group

Text

Optionally 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

Queue

Select required

Assign this action to an Action Queue

The Default queue is configured as a non-blocking queue, meaning actions will execute immediately on request and are allowed to run concurrently.

Learn more about Action Queues below

Enabled

Toggle

Toggle this action on or off

Random Action (RA)

Toggle

Randomly execute a single sub-action from within this action

Sub-action groups will be treated as a single entity and will execute as if they were a standalone action.

This option enables the Weight configuration on sub-actions, allowing you to adjust the probability that specific sub-actions will be chosen.

Concurrent (CC)

Toggle

Execute all sub-actions in this action simultaneously, rather than waiting for each step to complete.

This will also ignore the Delay sub-action

Always Run

Toggle

Force this action to execute even if the queue is in a Paused state

Exclude from Action Queue Pending/History

Toggle

Exclude this action from being logged to the action history.

This option is recommended for frequently executed actions to improve performance of your bot

Context Menu

any existing action to reveal the context menu:

Action Context Menu

Many of the action configuration options outlined above can be quickly modified here.

Additional context menu options are outlined below:

Options

Add

Dialog

Create a new action. Opens the Add Action dialog.

Edit

Dialog

Open the configuration dialog for the selected action

Delete

Action

Delete the selected actionBy default, you will be asked for confirmation with the option to hide all future confirmations.You can reinstate delete confirmations in the Settings tab

Duplicate

Action

Create a copy of the selected action, including all of its sub-actions.

Copy Action ID

Action

Copy the unique ID of the selected action to your clipboard.

Collapse All

Action

Collapse all action groups in the action pane

Expand All

Action

Expand all action groups in the action pane

Sub-Actions

To activate the sub-actions pane, you must first select an action via in the actions pane.

With an action selected, you can then anywhere in the sub-actions pane, on the right, to browse available sub-actions and add them to your selected action.

Sub-Actions Pane

Explore all available sub-actions and their configuration options in the Sub-Actions API References

Context Menu

anywhere in the sub-actions pane to browse and add a new sub-action
any existing sub-action to reveal additional context menu options

Sub-Actions Context Menu (New)

Sub-Actions Context Menu (Edit)

Options

Favorite Sub-Actions

Select

Opens the list of sub-actions you have marked as favorites.You can toggle any sub-action as a favorite by using on any item in the hierarchical sub-action menus.

Edit Sub-Action

Dialog

Open the configuration dialog for the selected sub-actionThis is the same as using on the sub-action itself

Copy Sub-Action

Action

Copy the selected sub-action, including its configuration, to the clipboard

Paste Sub-Action

Action

Paste a copied sub-action into the selected action

Duplicate Sub-Action

Action

Clones the selected sub-action into the currently open action

Delete Sub-Action

Action

Delete the selected sub-actionBy default, you will be asked for confirmation with the option to hide all future confirmations.You can reinstate delete confirmations in the Settings tab

Add Group

Action

Create a sub-action group

If the action contains any groups the Move to Group sub menu will also display below this option

Delete Group

Action

Delete the selected group

Only displays if current selection is a group folder

Rename Group

Rename the selected group

Only displays if current selection is a group folder

Enabled

Toggle

Boolean flag for disabling a sub-action for diagnostic purposes

Disabled sub-actions will be highlighted with red text

Random

Toggle

Boolean flag to set a group folder as Random ExecutionThis will only execute a single, random sub-action from within the group.

Weight

Dialog

The weight of the Sub-Action when the Action/Group is set on Random.

Setting a group to Random will also enable the Weight options on sub-actions inside that group. Weighting is used to make a sub-action more or less likely to be chosen

Delete all sub-actions

Action

Remove all sub-actions from this actionBy default, you will be asked for confirmation with the option to hide all future confirmations.You can reinstate delete confirmations in the Settings tab

Move

Action

Change the order of your sub-actionsThis has the same effect as keyboard shortcuts and Valid options are Up, Down, Top, Bottom

You can also drag and drop items both up and down the list and into and out of group folders

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

To get started, navigate to Action Queues > Queues in Streamer.bot

queues tab

Action Queues > Queues View

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 queue
Completed 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 queue
Blocking: Shows whether the queue is configured as a Blocking queue

Context Menu

You can within the Queues pane to reveal the context menu:

Action Queues Context Menu

Options

Add

Action

Create a new Queue, configuration detailed below

Available if you on a specific queue
Available if you an empty space within the Queues pane

Pause/Resume

Action

This option displays the current action you can perform on the queue.

Available if you on a specific queue
If the queue is currently Paused, you can select Resume to restart a queue and trigger any pending actions.
If the queue is currently Active, you can select Pause to temporarily stop new actions from being triggered in that queue. Once resumed, pending actions will be processed.

Blocking

Toggle

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 on a specific queue

Clear

Action

Clears the selected queue of any pending actions.

Available if you on a specific queue

Pause All Queues

Action

Immediately pause all queues.

Available if you on a specific queue
Available if you an empty space of Queues area

Resume All Queues

Action

Immediately resume any queues which are currently paused.

Available if you on a specific queue
Available if you an empty space of Queues area

Configuration

To create a new queue, within the queues pane and select Add

create queue dialog

Add/Edit Queue Dialog

Options

Name

Text required

Enter a descriptive name for your new queue

Blocking

Toggle

By 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.

It's especially useful to have a blocking queue for alerts, to allow them to execute one at a time!

Pending Actions

The pending actions view will display any queued actions which are waiting to run.

When utilizing blocking queues, as all currently blocked actions will show here.

Action History

The action history view will display a log of all actions that have been executed by Streamer.bot

Action History is the best place to discover what variables are available within your action!

Action Queues > Action History View

At a glance, you can view the following properties:

Name: The name of the executed action
State: The current status of the executed action
- e.g. Completed, Cancelled, Pending
Variables: The number of variables populated by this action
Duration: Time, in milliseconds, the action took to finish execution
Queue: The name of the queue this action was executed in
Queued At: The date and time the action was initially queued for execution
Started At: The date and time the action began execution
Completed At: The date and time the action finished execution

Context Menu

You can on any entry to open the context menu:

Action History Context Menu

Inspect Variables When Queued

Dialog

Open a dialog which shows all variables, and their values, available to the action when it was initially queued

Inspect Variables After Run

Dialog

Open a dialog which shows all variables, and their values, available at the end of action execution

Requeue

Action

Re-add the completed action to the queue to be executed again

Clear History

Action

Remove all current records from the Action History view

FAQ

Frequently Asked Questions

Triggers

Overview of trigger configuration in Streamer.bot