GRiMbot documentation

Variables Index

This is the hosted copy of the GRiMbot technical manual. Use the table of contents to open any page in the manual.

Variables Index

A Variable is a token in curly braces that GRiMbot replaces with a live value. Use only the Variables listed for that message or action. A token that the event never supplies is left on screen as written.

Where Variables are used

Feature Typical tokens Help / wiki
Event Alerts {display_name}, {login}, event-specific fields Event Alert Variables
Walk-On & Clip Overlay {display_name}, {custom_text}, {clip_title} Walk-On & Clip Overlay
Shoutouts chat line {display_name}, {login} Shoutouts
Favorite Streamers greeting {display_name}, {login} Lurkers, Streaks, Favorites
Streaks chat Event bag plus {streak} Lurkers, Streaks, Favorites
Custom Counters command replies {name}, {value} Custom Counters
Custom Counters AI keys {counter_name_<id>}, {counter_value_<id>} Hyphens in the counter ID become underscores
Bot Messages pool lines None. Lines are literal. Bot Messages
Bot Messages AI hint Counter AI keys only if you type them Bot Messages
Ad Breaks {seconds_remaining}, {interval_minutes}, {duration_seconds}, {user} Ad Breaks
Opening Chat {user}, {xp}, {buds} Opening Chat
Point Redemptions {display_name}, {login}, {user_input}, {reward_title}, {cost} Point Redemptions
Spotify Messages {track}, {artist}, {user}, {url} Spotify
Streamer.bot Event TTS Same bags as Event Alerts Streamer.bot

IMPORTANT

Custom Counter AI keys are your stream stats. The model sees a counter only when you put that key in the prompt. It does not treat every counter as belonging to the viewer who triggered the reply.

Related pages