GRiMbot documentation

Streamer.bot

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

Streamer.bot

This plugin bridges GRiMbot to Streamer.bot on the streaming PC for spoken TTS, Clip-Bridge, spoken nicknames, and stream-event speech.

Zip: sb-integration.zip

GRiMbar folder: Streamer.bot

Third-party requirements

Install Streamer.bot on the streaming PC.

Install Speaker.bot, or whatever voice pipeline your Streamer.bot Grimbot TTS action calls.

Enable the Streamer.bot HTTP server. You will paste the base URL and action names in GRiMbOS.

The PC Agent is recommended. The agent long-polls GRiMbot. You do not open inbound ports on the gaming PC.

Set STREAMERBOT_AGENT_TOKEN in the bot .env file.

AI Integration is optional. It is required for AI-mode Stream Event TTS.

Windows

Streamer.bot Integration holds URL, speak action name, agent versus direct, Download PC Agent, and test TTS.

TTS Nicknames stores spoken names so TTS does not misread logins. The broadcaster can also use !nickname. Nicknames are plain text. They do not accept template variables.

Stream Event TTS covers follows, subs, raids, cheers, and custom redemptions. Each event can be off, a static template, or AI.

Static templates use the same bags as Event Alerts. Examples are {display_name}, {bits}, {viewers}, and sub month fields. custom.redemption is for Streamer.bot webhook triggers. It is not the EventSub channel-point id.

Clip-Bridge

When enabled, Copy URL and media clip events can forward into Streamer.bot for your own actions.

TTS from games and Bot Overlay

Game Messages & TTS checkboxes and Bot Overlay speech both POST speak requests through this plugin. If TTS is silent, test from Streamer.bot settings after Speaker.bot is talking from Streamer.bot itself. If Streamer.bot is silent, GRiMbot cannot fix that.