Repository navigation
Actions and Triggers
An action is a list of steps (called sub-actions) that Cuebot runs. Triggers decide when it runs. One action can have many triggers, and the same trigger can start many actions.
Everything here lives under Automation in the left rail.
- Automation > Actions, click + and name the action. Put related actions in a group with the group field.
- On the Sub-actions tab click + Sub-action, search for a step (for example "send chat message", "set scene", "play sound", "speak") and fill in its settings.
- Add more steps. Steps run top to bottom; use the arrows to reorder them, and the checkbox to turn one off without deleting it.
- Click Run to try the action right away, or Test trigger... to run it with the arguments a trigger would send (for example a pretend follow from a viewer you name).
Undo and redo work per action (Ctrl+Z / Ctrl+Y). Copy, paste and duplicate work for actions, triggers and steps, including between two Cuebot installs.
The Flowchart tab shows the same action as a graph. Drag nodes around, click + on a port to add a step there, or drop a node on a port to rewire it. Both views edit the same action.
Logic steps include If / Else, Switch, While, loop Break / Continue, Get input and Random number. Steps can be grouped, nested, run at random, or run at the same time.
On the Triggers tab click + Trigger and pick an event: a chat message or command, a follow, a sub or gift, a cheer, a raid, a channel-point redemption, a donation, an OBS scene change, a Stream Deck or MIDI button, a hotkey, a timer, Cuebot starting, and many more. Most triggers have filters (for example "only rewards named Hydrate").
An action with no triggers runs only when you start it by hand, from a command, or from another action.
Automation > Commands creates commands such as !hello or !so, with aliases. A command matches plain text or a
regular expression, at the start of a message, as the whole message, or anywhere in it; it has cooldowns (global and per viewer), a minimum
role (subscriber, VIP, moderator, broadcaster), allowed and denied viewers or groups, and use counters. To run an
action from it, add a Chat command trigger to the action and pick the command; the action receives the rest of
the message as %input0%, %input1%... and %rawInput%.
Automation > Timers runs actions on a schedule: every N seconds, a random interval between two values, after a
minimum number of chat lines, or on a cron schedule (minute hour day month weekday, local time).
Actions run in queues. A blocking queue runs one action at a time, in order, which is useful for alerts that must not overlap. Automation > Queues shows what is waiting and lets you pause, resume or clear a queue. Chat > History shows every run with its arguments, and can run one again or cancel it.
Text fields can include values:
| Write | Inserts |
|---|---|
%user%, %message%, %input0%, %bits%... |
an argument of the current run (what the trigger or earlier steps provided) |
~name~ |
a global variable |
%time%, %date%, %unixtime%
|
the current time |
%amount:c2%, %date:yyyy-MM-dd%
|
an argument with a format |
$math(2 * %bits%)$, $length(%message%)$
|
the result of an inline function |
Automation > Variables shows global variables (saved and temporary) and per-viewer variables, and lets you edit them.
Automation > Watchers fires triggers when something changes on your computer: a file is created, changed, deleted or renamed in a folder; a line is added to a text file (for example a game's log); or a program starts or stops.
The Execute C# code and Execute Python code steps run your own code with access to Cuebot's script API: C#
through Cb (and Streamer.bot's CPH methods), Python through cb, for example cb.get_arg("user"),
cb.send_chat("hi") or cb.call("twitch.getUser", user="someone"). Return false / False to stop the action.
Python needs a Python interpreter, which Cuebot downloads once: a specific, checksum-verified Python 3.13 build (about 20–35 MB depending on your system). It is installed automatically the first time a Python step runs (that first run is skipped while it downloads), or right away with Install Python in the step editor or on Automation > Scripting. The Scripting page also installs pip packages, and can use an existing Python on your computer instead.
Cuebot by Tech Daddy Digital · MIT license · Privacy
Cuebot Docs (the same pages, nicer to read)
- Home
- Start here
-
Guides
- Chat commands
- The mod portal
- Overlays and alerts
- Writing your own overlay widgets
- Text-to-speech
- Music and now playing
- Points, store and giveaways
- Subathons and goals
- Stream apps and devices
- VTuber apps
- Stream Deck
- The phone app
- Donations and integrations
- Discord bot
- The setup assistant and AI tools
- The assistant on your own computer
- Moving from Streamer.bot
- Cuebot's servers
- Writing code (C# and Python)
- Python in detail
- Using your own code editor
- Controlling Cuebot from other programs
- Backups and your data
- Linux
- Command-line options
- Troubleshooting
- What's experimental
- Reference