GRiMbot documentation

Action Type Reference

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

Action Type Reference

This page lists Action Chain types used in GRiMbOS editors. Exact availability depends on the trigger and on installed plugins.

NOTE

Clip identifiers differ between catalogs. Button Box uses media_clip. Custom Commands use play_clips for the same Media Library playback idea. JSON actions still syncs to legacy action_type / action_payload on some saves.

Core actions

Label Typical id Group Effect Plugin
No action none Basic Placeholder. The trigger does nothing. Core
Delay delay Basic Waits 0 to 300 seconds before the next action when Run Actions is In order. Core
Play media clip / Play media clips media_clip / play_clips Media Plays Media Library clips. Playback can be sequential, simultaneous, or one random clip. Core
Custom Command media_command Media Runs a saved Custom Command and its full chain. Button Box only. Core
Play Twitch clip on overlay twitch_clip_overlay Media Shows a Twitch clip on the stage overlay. Core
Send chat message send_chat Chat & voice Posts a Chat Message as the bot identity. Core
Speak TTS speak_tts Chat & voice Speaks text through Streamer.bot / Speaker.bot. Streamer.bot
AI Bot Response ai_bot_response Overlays Generates an in-character Bot Overlay reply. Falls back to chat if Bot Overlay is off for that trigger. AI Integration
Overlay toggle widget overlay_toggle_widget Overlays Shows or hides a layout object. Core
Custom Counter increment / decrement / reset counter_* Counters Changes a Custom Counter. Core

Spotify actions

Requires Spotify. These actions do not post in chat and do not add tracks to the Song Requests playlist.

Label Effect
Play Song URL Jumps to an open.spotify.com/track/ link, then continues the queue.
Play Playlist Starts a playlist shuffled from a random first track.
Pause Spotify Pauses the active device.
Unpause Spotify Resumes from pause.
Set Spotify Volume Sets volume from 0 to 100.

OBS actions

Requires OBS Integration. Direct mode talks to OBS on the same PC. Agent mode uses the PC Agent.

Label Effect
Switch OBS scene Sets the program scene.
Toggle OBS source visibility Shows a hidden source or hides a visible source.
Toggle / mute / unmute OBS audio Controls an audio input.

Variables in action text

Chat, TTS, and AI guidance fields accept Variables for that trigger. See Variables Index and Event Alert Variables.

Related pages