Skip to content

Overview

Vifu docs are for people building companion-native agentic browser games. A game runs as static web content, exposes safe state through the Companion SDK, and lets the Vifu host request small player-visible actions.

Platform surface

AreaWhat it covers
Browser runtimeHTML entry, static assets, iframe behavior, local boot requirements.
Companion SDKContexts, commands, observations, signals, reactions, and host connection status.
Vifu CLIProject creation, local run/test/build workflows, and publishing commands.
ManifestEntry file and capability declaration for companion.plugin.v1.
Release channelCurrent package version, protocol compatibility, and migration notes.

Start here

  1. Read the Quickstart.
  2. Add @consenger/companion-sdk.
  3. Install @consenger/vifu for local workflows.
  4. Declare the manifest capability.
  5. Verify the browser runtime contract.

Good fit

  • HTML, Canvas, Phaser, Pixi, Three.js, and Godot web exports.
  • Language-learning games, quizzes, simulations, flashcards, and lightweight interactive scenes.
  • Games that can describe current state and expose small, safe actions to the companion.