Grim Games Live Grim Games Live

GRiMbot documentation

Two-PC setup

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

GRiMbot product page Manual home

Two-PC setup

Purpose and scope

This page records the two-PC limitation in the current packaged release. It is a reference for administrators who already manage a separate GRiMbot network deployment. It is not a two-PC setup procedure for packaged users.

Prerequisites

  • You administer a GRiMbot deployment outside the packaged launcher workflow.
  • That separately managed deployment already provides a Core endpoint for the streaming PC.
  • You understand how that endpoint is secured and maintained.
  • The required integration plugin is installed.
  • STREAMERBOT_AGENT_TOKEN is set when an integration will use the PC Agent.

[!IMPORTANT] The current packaged release does not support a two-PC layout. The Windows launcher, Linux launcher, and Debian service bind to 127.0.0.1. Installing the PC Agent does not make Core reachable from another machine.

flowchart LR
    Twitch[Twitch] <--> Core[GRiMbot Core]
    Core <--> Endpoint[Administrator-managed endpoint]
    Endpoint <--> Agent[PC Agent when Agent mode is enabled]
    Agent <--> OBS[OBS or Streamer.bot on streaming PC]

Procedure

Administrators of a separately managed deployment can use this checklist to verify the boundary:

  1. Confirm that Core is reachable through the endpoint maintained by the administrator.
  2. Confirm that the packaged localhost launcher is not being used as the network service.
  3. Install the required integration plugin.
  4. In Streamer.bot Settings, enable Use streaming PC agent only when the managed topology requires it.
  5. In OBS Settings, select Agent mode only when the managed topology requires it.
  6. Set STREAMERBOT_AGENT_TOKEN before downloading the PC Agent.
  7. Download GRiMbot-PC-Agent.zip from Streamer.bot Settings or OBS Settings.
  8. Extract the package on the streaming PC.
  9. Run start-streamerbot-agent.bat while Agent mode is in use.
  10. Use overlay URLs only through the endpoint maintained by the administrator.

The Streamer.bot integration can use direct localhost mode when GRiMbot and Streamer.bot run on the same PC. In that layout, clear Use streaming PC agent and use the local Streamer.bot URL. The PC Agent is not required for that mode.

Settings and choices

Setting Choose it when
Streamer.bot direct localhost mode GRiMbot and Streamer.bot run on the same PC.
Use streaming PC agent A separately managed topology requires the PC Agent.
OBS Direct mode GRiMbot and OBS run on the same PC.
OBS Agent mode A separately managed deployment provides the streaming PC with a Core endpoint.
PC Agent token Agent mode is enabled. The generated agent configuration must match STREAMERBOT_AGENT_TOKEN.

Download a new PC Agent package after changing its token, GRiMbot endpoint, or OBS WebSocket settings.

Expected result

Packaged users identify the two-PC layout as unsupported and stay with the local layout. Administrators of a separately managed deployment can verify whether Agent mode and the PC Agent match their topology.

Verification checklist

  • [ ] This is a separately managed deployment, not a packaged two-PC installation.
  • [ ] No packaged launcher is being treated as a LAN listener.
  • [ ] Streamer.bot uses direct localhost mode when it runs on the GRiMbot PC.
  • [ ] Use streaming PC agent is enabled only when required.
  • [ ] OBS uses Direct or Agent mode for the actual topology.
  • [ ] The PC Agent reports connected when Agent mode is enabled.
  • [ ] OBS Browser Sources load through the endpoint supplied by the supported deployment.
  • [ ] Browser Source dimensions match the overlay canvas.
  • [ ] Control audio via OBS is enabled where required.

Failure handling

If you are using the current packaged release, stop. Its launchers and PC Agent cannot establish the required cross-machine Core connection.

If the supported endpoint fails its own verification, follow the failure procedure supplied with that deployment before troubleshooting plugins.

If the PC Agent cannot connect after the endpoint works, verify that Agent mode is enabled and download a new package after checking STREAMERBOT_AGENT_TOKEN.

If Streamer.bot runs on the same PC as GRiMbot, switch to direct localhost mode and test that path without the PC Agent.

Security and data notes

[!SECURITY] Do not improvise a network deployment by changing bind addresses, firewall rules, or public port forwarding. Follow the procedure maintained by the deployment administrator.

Do not publish .env, the PC Agent token, the generated PC Agent configuration, or the OBS WebSocket password.

Related pages