Utilities
These commands provide various utility functions for controlling script execution and system operations.
stop
Stops the currently running media and returns to the menu.
Syntax
**stop
Arguments
None.
Advanced Arguments
| Argument | Type | Default | Description |
|---|---|---|---|
when | expression | - | Conditional execution (see Expressions) |
Examples
**stop
Stops whatever is currently playing and returns to the menu.
**stop?when=[[media_playing]]
Only stops if media is currently playing.
echo
Outputs a message to the Zaparoo Core log file.
Syntax
**echo:<message>
Arguments
message (required)
The text to output. Logged at "info" level.
Advanced Arguments
| Argument | Type | Default | Description |
|---|---|---|---|
when | expression | - | Conditional execution (see Expressions) |
Examples
**echo:Token was scanned
Logs "Token was scanned" to the Core log file.
**echo:Platform is [[platform]]
Logs the current platform using an expression.
execute
Runs a shell command on the host system.
Syntax
**execute:<command>
Arguments
command (required)
The shell command to run, including any arguments. The command has a 2-second timeout.
Advanced Arguments
| Argument | Type | Default | Description |
|---|---|---|---|
when | expression | - | Conditional execution (see Expressions) |
Examples
**execute:reboot
Reboots the system.
**execute:notify-send "Game started"
Sends a desktop notification (on Linux systems with notify-send).
This command requires explicitly enabling the arguments in the allow_execute config option. Commands from remote sources are always blocked.
delay
Pauses script execution for a specified duration.
Syntax
**delay:<milliseconds>
Arguments
milliseconds (required)
The number of milliseconds to pause. Must be a positive integer.
Advanced Arguments
| Argument | Type | Default | Description |
|---|---|---|---|
when | expression | - | Conditional execution (see Expressions) |
Examples
**delay:500
Pauses for 500 milliseconds (half a second).
**delay:10000
Pauses for 10 seconds.
_Console/SNES||**delay:10000||**input.keyboard:{f12}
Launches SNES, waits 10 seconds, then presses F12.
This is a blocking command. The entire script pauses until the delay completes.