Going live
Use this checklist before submitting a Vifu browser game that uses @consenger/companion-sdk.
Package
- Use
@consenger/companion-sdk@0.1.0-alpha.0. - Use
@consenger/vifu@0.1.0-alpha.0for local run, test, build, and publish workflows. - Keep the game on the
0.1.xcompatibility line unless a newer line is documented. - Bundle the browser build with the game if the game does not use a bundler.
Manifest
- Set
entryto the browser entry file. - Add
companion.plugin.v1tocapabilities. - Keep metadata player-facing: title, description, language tags, and genre tags should describe the game, not its implementation.
Runtime behavior
- The game must run in a normal browser tab without the Vifu host bridge.
- Companion features should activate only when
companion.isHostConnected()is true. - Register context and commands during startup, then update game state through callbacks instead of re-registering every frame.
Companion safety
- Context should contain only information the player can safely know.
- Do not expose tokens, private notes, account identifiers, hidden answers, or future content.
- Commands must validate their input and return a stable result object.
Verification
- Load the game locally.
- Confirm
companion.status()reports the expected SDK version and protocol. - Trigger at least one context read, one command, and one observation.
- Verify the game still works when the host bridge is absent.
