mobrule/mobrule-pack-communication-kit
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
MPP v2 pack communication kit � protocol fixtures, a Python reference adapter, and a conformance checker for building mobrule pack adapters.
2 commits 1 branch 0 tags 52 KiB
  • Python 100%
Find a file
Exact
aiko a71bd90471 docs: juice up the README 
Lead with what an Adapter is and why the kit exists, add a what's-in-the-box
section and a start-here path, link the protocol reference on docs.mobrule.tv.
2026-07-24 16:09:01 +02:00
mpp-v2 Initial commit: MPP v2 pack communication kit 2026-07-24 15:59:30 +02:00
packcomms Initial commit: MPP v2 pack communication kit 2026-07-24 15:59:30 +02:00
reference/python Initial commit: MPP v2 pack communication kit 2026-07-24 15:59:30 +02:00
.gitignore Initial commit: MPP v2 pack communication kit 2026-07-24 15:59:30 +02:00
LICENSE Initial commit: MPP v2 pack communication kit 2026-07-24 15:59:30 +02:00
README.md docs: juice up the README 2026-07-24 16:09:01 +02:00

README.md

mobrule-pack-communication-kit

Build a mobrule pack Adapter in any language, straight from the protocol.

A mobrule pack lets a streamer's Twitch chat set off effects inside the game they're playing. The piece that makes an effect actually happen is the Adapter: a small program that talks to the mobrule bridge and turns each incoming redeem into something in-game. This kit is everything you need to write one.

MPP (the Mobrule Pack Protocol) is how the Adapter and the bridge talk: newline delimited JSON over a TCP socket. The bridge hands out invocations, the Adapter reports what it did with each one. That is the whole conversation. There is no SDK to link and nothing runtime-specific here, just the protocol and enough reference material to check your work against.

MIT licensed. Copy anything useful straight into your pack, closed source or not. No strings.

What's in the box

  • mpp-v2/ the protocol, as fixtures you can run against.
    • sample-runs/ full bridge-to-adapter conversations, step by step: the happy path, refunds on failure, config latching, timed effects, version rejection.
    • sample-frames/ single frames with their exact wire bytes, for codec tests.
    • mpp-v2/README.md explains the fixture formats.
  • reference/python/ a complete, working Adapter in about 200 lines of Python stdlib. Read it next to the spec, then port it to your language.
  • packcomms/ the conformance checker that replays the sample runs against your Adapter. Scaffolded here, not built yet.

Start here

  1. Read the MPP protocol reference. An Adapter written from that page alone will interoperate with any bridge.
  2. Read reference/python/mpp_adapter.py alongside it to see the whole flow in one file.
  3. Write your Adapter, keeping the sample runs open and matching their frames.
  4. Check it against the fixtures before you ship.

Conformance is honor-system

No badge, no registry, no "certified adapter" stamp. The fixtures are a spec you can execute: feed the sample runs through your Adapter, check its output matches what is expected, and if it does, you are good. Run the checks yourself, trust your own results, ship it.