Documentation

Protocol reference, guides, and package documentation for Open Face.

State messages, 11 states, 13 emotions, compound expressions, intensity, gaze, amplitude, and the full field reference.

Create custom packs with geometry, palette, personality, body, head, and accessories. Includes examples and testing workflow.

HTTP endpoints, WebSocket protocol, authentication, rate limiting, audio pipeline, and chat proxy.

Connect via OpenClaw plugin, MCP tools, HTTP/WS, web component, or Cloudflare Edge. Step-by-step for each path.

Hosted faces — claim a URL, push state, no server needed. Claim API, per-face config, WebSocket viewing, dashboard.

Claim a face at oface.io in 30 seconds. Get an API key, push state, share the URL. The fastest integration path.

Packages

@openface/renderer — Canvas2D engine, zero deps

@openface/element — <open-face> web component

@openface/server — Bun WebSocket relay + HTTP API

@openface/client — TypeScript client library

@openface/mcp — 8 MCP tools for Claude

@openface/plugin — OpenClaw lifecycle plugin

@openface/filter — Emotion detection + text cleaning

@openface/server-edge — oface.io (Workers + Durable Objects)