Docs / Walk
Walk avatar documentation
Walk turns a three.ws avatar into a real 3D character that moves through the web — on the dedicated walk page, as a floating companion on any page, as a one-tag embed on your own site, or as a Chrome extension that strolls across every tab. This hub documents everything the system actually ships today.
Start here
Getting started →
Walk your first avatar in five minutes — page, embed, or companion.
The walk page →
Controls, four camera modes, six environments, gestures, multiplayer, and AR.
Iframe embed →
Every /walk-embed query parameter, with a live preview to copy.
JavaScript SDK →
The window.ThreeWalkAvatar host API: mount, control, listen.
postMessage events →
The full bi-directional contract between a host page and the iframe.
Companion mode →
A site-wide avatar that walks with you between three.ws pages.
Analytics →
Sessions, distance, top origins, and conversion events per avatar.
Chrome extension →
Your avatar on every site, with optional read-aloud narration.
What "Walk" is made of
The system is four surfaces over one rendering engine:
- The walk page (
/walk) — the full experience: WASD/touch movement, four camera modes, six worlds, gestures, live multiplayer presence, AR camera passthrough, and a global distance leaderboard. - The embed (
/walk-embed) — a chrome-less, transparent iframe that renders a single avatar. Configured entirely by URL query parameters and driven live overpostMessage. - The SDK (
/walk-embed-sdk.js) — a zero-dependency script tag that mounts the embed as a floating corner avatar and exposeswindow.ThreeWalkAvatarfor runtime control and event listening. - Companion mode & the extension — the same avatar following you across three.ws pages, or across every website via the Chrome extension.
Conventions
- URLs are shown relative to
https://three.ws. From a third-party page, prefix the origin (e.g.https://three.ws/walk-embed). - Code blocks have a Copy button. The copied text is the raw source, never the on-screen syntax tint.
- Every page has an Edit this page link to its file in the canonical GitHub repository.