GRiMbot documentation

PC Agent

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

PC Agent

The PC Agent is a small Windows program that runs on the streaming PC. GRiMbot on another machine cannot open OBS, Handy, or Streamer.bot through your firewall. The agent starts the conversation and long-polls the bot.

One zip, several jobs

Download from GRiMbOS. The same package is offered from Streamer.bot settings, OBS Settings, and Voice Recognition.

Extract the zip. Run start-streamerbot-agent.bat. Leave the window open while you stream. Stop it with the matching stop batch file.

The agent can send TTS speak requests to Streamer.bot and Speaker.bot. It can relay media clip local URLs. It can talk to OBS WebSocket when OBS Integration is in agent mode. It can accept Handy at http://127.0.0.1:28787 and forward Voice Recognition text as the Broadcaster.

Config

grimbot-relay.config.ps1 sits next to the scripts. A fresh zip from GRiMbOS can already contain your bot URL and token.

The token must match STREAMERBOT_AGENT_TOKEN on the bot. If the lamp stays red, the token or the bot URL is wrong. The agent must reach GRiMbot over the network. 127.0.0.1 in the agent config would mean GRiMbot is on the streaming PC. That is Direct mode, not agent mode.

Other agents

ATS Agent and MSFS Agent are separate batch files for the sim PC. Download those from ATS Settings or MSFS Settings. start-streamerbot-agent.bat does not read truck telemetry.

Security

Treat the agent zip like a secret. It holds a token that can trigger TTS, clips, and Voice Commands as you. Do not leave an old zip on a shared USB stick.