System sub-actions

Get clipboard text

Reads the text you last copied (Ctrl+C) and saves it in a variable. Handy for turning a copied link into a chat message.

Setting	What to put in
Save in variable	The variable that receives the copied text, without % signs. The default clipboardText means you use %clipboardText%. Starts as: clipboardText.

Variables it adds

Variable	What it holds
%clipboardText%	The copied text (the variable name can be changed in the settings)
%clipboardTextFound%	True if there was text on the clipboard

Type id: desktop.getClipboard

Keyboard press

Presses keys on your keyboard for you, as if you typed them, in whatever program is in front. Good for triggering another program's shortcut.

Setting	What to put in
Keys	A shortcut like "Ctrl+Shift+F1". For several in a row, separate them with commas, like "Ctrl+C, Ctrl+V". On Linux the desktop may ask for permission once. Starts as: Ctrl+Shift+F1.
Pause between combos (ms)	How many milliseconds to wait between shortcuts when you list several. 1000 = 1 second. Starts as: 30.

Variables it adds

Variable	What it holds
%keysPressed%	The shortcuts that were pressed

Type id: input.keyboardPress

Run program

Starts a program or opens a file on your computer, like a script or another tool. It can wait until the program ends and even collect what it prints.

Setting	What to put in
Program or file	The program or file to open, with its full location, like C:\Tools\clip.exe or /usr/bin/notify-send.
Command-line options	Extra words to give the program, like "--fast". Empty is fine for most programs.
Working directory	The folder the program starts in. Empty = the default. Most people can leave this alone.
Wait for exit	Tick to wait for the program to finish before the next step. Unticked, Cuebot goes on straight away. Starts as: false.
Wait at most (seconds, 0 = no limit)	With "Wait for exit": give up waiting after this many seconds. 0 = wait as long as it takes. Starts as: 0.
Capture output (%output1%...)	Tick to save the lines the program prints in %output1%, %output2% and so on. Only works together with "Wait for exit". Starts as: false.
Environment variables	Extra settings for the program, one per line as NAME=value. Most people leave this empty.

Variables it adds

Variable	What it holds
%exitCode%	The number the program ended with (0 usually means it went fine). Only after waiting.
%timedOut%	True if you stopped waiting because the time ran out. Only after waiting.
%output1%	The first line the program printed (output2 is the second). Only with capture output.
%outputCount%	How many lines the program printed. Only with capture output.

Type id: core.runProgram

Set clipboard text

Puts text on your clipboard, so you can paste it with Ctrl+V. Handy to copy a link or a viewer's message.

Setting	What to put in
Text	The text to copy. You can use %variables%, like %message%.

Type id: desktop.setClipboard

Set watcher state

Turns a watcher or a followed file on, off or flips it. Watchers are made on the Watchers page. Turn one off if you do not need it right now.

Setting	What to put in
Watcher or file tail	The name of the watcher or followed file, exactly as on the Watchers page.
State	Enable turns it on. Disable turns it off. Toggle switches it to the opposite. Options: Enable, Disable, Toggle. Starts as: Enable.

Type id: core.setWatcherState

Show desktop notification

Shows a small pop-up message on your computer screen, only for you, not your viewers. Good as a private reminder. Click it to start an action with the "Toast notification clicked" trigger.

Setting	What to put in
Title	The bold line at the top of the pop-up. The default is Cuebot. Starts as: Cuebot.
Message	The text of the pop-up. You can use %variables%.
Icon file	Optional. The location of a small picture file to show next to the text.
Notification id	Optional. A name you make up so the "Toast notification clicked" trigger can tell which pop-up was clicked.
Seconds on screen	How many seconds the pop-up stays on screen. From 1 to 120. Starts as: 5.
Show with	Auto = your system's notifications where possible, else Cuebot's own pop-up. In-app = always Cuebot's own. System = your system's. Options: Auto, In-app, System. Starts as: Auto.

Variables it adds

Variable	What it holds
%notificationShownWith%	Which way the pop-up was shown

Type id: desktop.showNotification