Skip to content

Compatibility

The first public compatibility line is 0.1.x.

Package lineDocumented versionProtocolCapabilityRuntime
@consenger/companion-sdk@0.1.x0.1.0-alpha.0companion.plugin.v1companion.plugin.v1Vifu Web iframe, iOS WKWebView

Version policy

Patch releases keep the same protocol and capability. They may add documentation, diagnostics, browser bundle fixes, and non-breaking SDK helpers.

Minor releases may add APIs or capabilities. A game can remain on 0.1.x until it needs a newer documented capability.

Protocol-breaking changes require a new compatibility line and a new capability name. Games that declare companion.plugin.v1 should continue to receive the v1 host bridge behavior.

Host requirements

  • Browser runtime with window.postMessage for Vifu Web.
  • window.webkit.messageHandlers.consengerHost for the iOS WKWebView runtime.
  • Static game entry that can load without server-side code.
  • JSON-serializable context, command input, command result, and observation payloads.