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
| Area | What it covers |
|---|---|
| Browser runtime | HTML entry, static assets, iframe behavior, local boot requirements. |
| Companion SDK | Contexts, commands, observations, signals, reactions, and host connection status. |
| Vifu CLI | Project creation, local run/test/build workflows, and publishing commands. |
| Manifest | Entry file and capability declaration for companion.plugin.v1. |
| Release channel | Current package version, protocol compatibility, and migration notes. |
Start here
- Read the Quickstart.
- Add
@consenger/companion-sdk. - Install
@consenger/vifufor local workflows. - Declare the manifest capability.
- 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.
