Introduction
What is mobrule?
Section titled “What is mobrule?”mobrule is a SaaS platform for chat-chaos integrations. Twitch viewers spend channel points to inflict effects on a streamer’s game in real time, with bits, subs, and later YouTube, Kick, and donations on the way. The platform is generic: the community ships Packs that declare game-specific capabilities, and the Adapter process talks to the game itself. Streamers wire those capabilities to chat in a web UI.
How it fits together
Section titled “How it fits together”- Pack: a
pack.tomlManifest plus assets that describe the Events a game exposes (e.g. “spawn a monster”, “low gravity”), along with JSON Schema for each Event’s parameters. - Adapter: a process you write that opens a TCP connection to the bridge, speaks MPP (JSON over NDJSON), and applies dispatched Invocations against the game.
- Bridge: the platform’s local TCP server. It loads a Pack, pins the
active session to a
manifest_hash, validates Invocations, and ferries them to the Adapter.
A viewer’s channel-point redemption travels the whole pipeline before it shows
up in the game. The Overlay reads live Pack state from the bridge (not the
Adapter) over WS /rpc/subscribe:
Source code
Section titled “Source code”The platform is open source (AGPL):
- mobrule: the platform itself: bridge, desktop dashboard, CLI, cloud module, and the pack-hello-world reference Pack.
- mobrule-pack-doom: the DOOM chaos Pack, the finished code behind the Doom pack tutorial.
- mobrule-ci: CI containers and build tooling.
Start here
Section titled “Start here”New Pack author? Start with the Quickstart.
Reference docs
Section titled “Reference docs”- Manifest reference: every key in
pack.toml. - MPP protocol: the wire format between bridge and Adapter.
- Adapter tutorial (Python): a minimal Adapter walkthrough.