Skip to main content

Variables

Variables let you display dynamic values in your overlay or chat bot. Unlike with Functions however you cannot add in any extra parameters.

The format for using variables is {{variable_name}}. There can be no spaces in-between the word and the curly brackets. Variables can be used inside Functions but not the other way around.

For overlays

When used in the text field of a Text Widget or similar, they will display their value and automatically refresh when the value changes.

Alert variables

Text widgets placed inside a Custom Alert Box Widget can reference the firing alert's individual fields via the {{alert.<field>}} namespace — for example {{alert.name}}, {{alert.bits}}, {{alert.streak_months}}. The same handles work inside the streamer-configured display message and TTS message templates in Alert Configuration. See the full alert variable reference.