Skip to content

Open-source platform for 3D AI agents. Turn text or a photo into a rigged, animated GLB avatar, give it an LLM brain, memory and a wallet, and embed it anywhere with one web component. Remote MCP server, x402 payments, Three.js, browser-native.

13.2 KB
Raw Blame
<!doctype html>
<html lang="en">
	<head>
		<script>/* three.ws theme boot — no-flash; runtime in /theme-switcher.js */(function(){try{var m=localStorage.getItem('twx_theme');var l=m==='auto'?(window.matchMedia&&window.matchMedia('(prefers-color-scheme: light)').matches):m==='light';document.documentElement.setAttribute('data-theme',l?'light':'dark');}catch(e){document.documentElement.setAttribute('data-theme','dark');}})();</script>
		<meta charset="utf-8" />
		<meta http-equiv="X-UA-Compatible" content="IE=edge" />
		<title data-i18n="docs_walk_index.meta_title">Docs · Walk Avatar · three.ws</title>
		<meta name="viewport" content="width=device-width, initial-scale=1.0, viewport-fit=cover" />
		<meta name="description" content="Developer and user documentation for the three.ws walking-avatar system: the /walk page, iframe embeds, the JavaScript SDK, the postMessage event contract, companion mode, analytics, and the Chrome extension."  data-i18n-attr="content:docs_walk_index.meta_description"/>
		<meta name="theme-color" content="#0a0a0a" />
		<link rel="canonical" href="https://three.ws/docs/walk" />
		<link rel="shortcut icon" href="/favicon.ico" />
		<link rel="stylesheet" href="/fonts/fonts.css" />
		<link rel="stylesheet" href="/style.css" />
		<link rel="stylesheet" href="/footer.css" />
		<link rel="stylesheet" href="/nav.css" />
		<link rel="stylesheet" href="/docs/walk/docs.css" />
	
	<meta name="robots" content="index, follow, max-image-preview:large, max-snippet:-1">
	<meta property="og:type" content="website">
	<meta property="og:site_name" content="three.ws">
	<meta property="og:locale" content="en_US">
	<meta property="og:title" content="Docs · Walk Avatar · three.ws" data-i18n-attr="content:docs_walk_index.meta_og_title">
	<meta property="og:description" content="Developer and user documentation for the three.ws walking-avatar system: the /walk page, iframe embeds, the JavaScript SDK, the postMessage event contract, companion mode, analytics, and the Chrome extension." data-i18n-attr="content:docs_walk_index.meta_og_description">
	<meta property="og:url" content="https://three.ws/docs/walk">
	<meta property="og:image" content="https://three.ws/api/page-og?s=learn&amp;t=Docs+%C2%B7+Walk+Avatar&amp;d=Developer+and+user+documentation+for+the+three.ws+walking-avatar+system%3A+the+%2Fwalk+page%2C+iframe+embeds%2C+the+JavaScript+SDK%2C+the+postMessage+event+contract&amp;p=%2Fdocs%2Fwalk">
	<meta property="og:image:width" content="1200">
	<meta property="og:image:height" content="630">
	<meta property="og:image:type" content="image/png">
	<meta property="og:image:alt" content="Docs · Walk Avatar — three.ws">
	<meta name="twitter:card" content="summary_large_image">
	<meta name="twitter:site" content="@trythreews">
	<meta name="twitter:title" content="Docs · Walk Avatar · three.ws" data-i18n-attr="content:docs_walk_index.meta_twitter_title">
	<meta name="twitter:description" content="Developer and user documentation for the three.ws walking-avatar system: the /walk page, iframe embeds, the JavaScript SDK, the postMessage event contract, companion mode, analytics, and the Chrome extension." data-i18n-attr="content:docs_walk_index.meta_twitter_description">
	<meta name="twitter:image" content="https://three.ws/api/page-og?s=learn&amp;t=Docs+%C2%B7+Walk+Avatar&amp;d=Developer+and+user+documentation+for+the+three.ws+walking-avatar+system%3A+the+%2Fwalk+page%2C+iframe+embeds%2C+the+JavaScript+SDK%2C+the+postMessage+event+contract&amp;p=%2Fdocs%2Fwalk">
	<script type="application/ld+json">{"@context":"https://schema.org","@graph":[{"@type":"WebPage","name":"Docs · Walk Avatar","description":"Developer and user documentation for the three.ws walking-avatar system: the /walk page, iframe embeds, the JavaScript SDK, the postMessage event contract, companion mode, analytics, and the Chrome extension.","url":"https://three.ws/docs/walk","isPartOf":{"@type":"WebSite","name":"three.ws","url":"https://three.ws"},"primaryImageOfPage":"https://three.ws/api/page-og?s=learn&t=Docs+%C2%B7+Walk+Avatar&d=Developer+and+user+documentation+for+the+three.ws+walking-avatar+system%3A+the+%2Fwalk+page%2C+iframe+embeds%2C+the+JavaScript+SDK%2C+the+postMessage+event+contract%2C+comp&p=%2Fdocs%2Fwalk"},{"@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https://three.ws/"},{"@type":"ListItem","position":2,"name":"Docs","item":"https://three.ws/docs"},{"@type":"ListItem","position":3,"name":"Walk","item":"https://three.ws/docs/walk"}]}]}</script>
</head>
	<body>
		<a class="wd-skip" href="#wd-main" data-i18n="docs_walk_index.skip_to_content">Skip to content</a>
		<header>
			<div id="nav-container"></div>
		</header>
		<script src="/nav.js"></script>

		<div class="wd-shell">
			<button class="wd-side-toggle" type="button" aria-expanded="false" aria-controls="wd-side" data-i18n-html="docs_walk_index.documentation_menu">
				<span>Documentation menu</span>
				<span aria-hidden="true">☰</span>
			</button>

			<aside class="wd-side" id="wd-side" aria-label="Walk documentation">
				<h2 data-i18n="docs_walk_index.walk_docs">Walk docs</h2>
				<nav aria-label="Walk documentation pages">
					<a href="/docs/walk" aria-current="page" data-i18n="docs_walk_index.overview">Overview</a>
					<a href="/docs/walk/getting-started" data-i18n="docs_walk_index.getting_started">Getting started</a>
				</nav>
				<h2 data-i18n="docs_walk_index.use_it">Use it</h2>
				<nav aria-label="Using Walk">
					<a href="/docs/walk/walk-page" data-i18n="docs_walk_index.the_walk_page">The walk page</a>
					<a href="/docs/walk/companion-mode" data-i18n="docs_walk_index.companion_mode">Companion mode</a>
					<a href="/docs/walk/chrome-extension" data-i18n="docs_walk_index.chrome_extension">Chrome extension</a>
				</nav>
				<h2 data-i18n="docs_walk_index.build_with_it">Build with it</h2>
				<nav aria-label="Building with Walk">
					<a href="/docs/walk/embed-iframe" data-i18n="docs_walk_index.iframe_embed">Iframe embed</a>
					<a href="/docs/walk/embed-sdk" data-i18n="docs_walk_index.javascript_sdk">JavaScript SDK</a>
					<a href="/docs/walk/postmessage-events" data-i18n="docs_walk_index.postmessage_events">postMessage events</a>
					<a href="/docs/walk/analytics" data-i18n="docs_walk_index.analytics">Analytics</a>
				</nav>
				<h2 data-i18n="docs_walk_index.reference">Reference</h2>
				<nav aria-label="Reference">
					<a href="/docs/walk/changelog" data-i18n="docs_walk_index.changelog">Changelog</a>
				</nav>
			</aside>

			<main class="wd-main" id="wd-main">
				<p class="wd-crumbs" data-i18n-html="docs_walk_index.docs_walk"><a href="/docs">Docs</a> / Walk</p>
				<h1 data-i18n="docs_walk_index.walk_avatar_documentation">Walk avatar documentation</h1>
				<p class="wd-lede" data-i18n="docs_walk_index.walk_turns_a_three_ws_avatar_into">
					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.
				</p>

				<div class="wd-demo">
					<div class="wd-demo-head"><span data-i18n-html="docs_walk_index.live_embed_a_real_avatar_rendered_now"><span class="wd-demo-dot"></span>Live embed — a real avatar, rendered now</span><span data-i18n="docs_walk_index.walk_embed">/walk-embed</span></div>
					<iframe
						title="Live walking avatar embed"
						src="/walk-embed?controls=none&autoplay=true&ground=false&env=studio"
						height="320"
						loading="lazy"
						allow="accelerometer; gyroscope; xr-spatial-tracking"
					></iframe>
				</div>

				<h2 data-i18n="docs_walk_index.start_here">Start here</h2>
				<div class="wd-cards">
					<a class="wd-card" href="/docs/walk/getting-started">
						<h3 data-i18n="docs_walk_index.getting_started_2">Getting started →</h3>
						<p data-i18n="docs_walk_index.walk_your_first_avatar_in_five_minutes">Walk your first avatar in five minutes — page, embed, or companion.</p>
					</a>
					<a class="wd-card" href="/docs/walk/walk-page">
						<h3 data-i18n="docs_walk_index.the_walk_page_2">The walk page →</h3>
						<p data-i18n="docs_walk_index.controls_four_camera_modes_six_environments">Controls, four camera modes, six environments, gestures, multiplayer, and AR.</p>
					</a>
					<a class="wd-card" href="/docs/walk/embed-iframe">
						<h3 data-i18n="docs_walk_index.iframe_embed_2">Iframe embed →</h3>
						<p data-i18n-html="docs_walk_index.every_query_parameter_with_a_live_preview">Every <code>/walk-embed</code> query parameter, with a live preview to copy.</p>
					</a>
					<a class="wd-card" href="/docs/walk/embed-sdk">
						<h3 data-i18n="docs_walk_index.javascript_sdk_2">JavaScript SDK →</h3>
						<p data-i18n-html="docs_walk_index.the_host_api_mount_control_listen">The <code>window.ThreeWalkAvatar</code> host API: mount, control, listen.</p>
					</a>
					<a class="wd-card" href="/docs/walk/postmessage-events">
						<h3 data-i18n="docs_walk_index.postmessage_events_2">postMessage events →</h3>
						<p data-i18n="docs_walk_index.the_full_bi_directional_contract_between_a">The full bi-directional contract between a host page and the iframe.</p>
					</a>
					<a class="wd-card" href="/docs/walk/companion-mode">
						<h3 data-i18n="docs_walk_index.companion_mode_2">Companion mode →</h3>
						<p data-i18n="docs_walk_index.a_site_wide_avatar_that_walks_with">A site-wide avatar that walks with you between three.ws pages.</p>
					</a>
					<a class="wd-card" href="/docs/walk/analytics">
						<h3 data-i18n="docs_walk_index.analytics_2">Analytics →</h3>
						<p data-i18n="docs_walk_index.sessions_distance_top_origins_and_conversion">Sessions, distance, top origins, and conversion events per avatar.</p>
					</a>
					<a class="wd-card" href="/docs/walk/chrome-extension">
						<h3 data-i18n="docs_walk_index.chrome_extension_2">Chrome extension →</h3>
						<p data-i18n="docs_walk_index.your_avatar_on_every_site_with_optional">Your avatar on every site, with optional read-aloud narration.</p>
					</a>
				</div>

				<h2 data-i18n="docs_walk_index.what_walk_is_made_of">What "Walk" is made of</h2>
				<p data-i18n="docs_walk_index.the_system_is_four_surfaces_over_one">The system is four surfaces over one rendering engine:</p>
				<ul>
					<li data-i18n-html="docs_walk_index.the_walk_page_the_full_experience_wasd"><strong>The walk page</strong> (<code>/walk</code>) — the full experience: WASD/touch movement, four camera modes, six worlds, gestures, live multiplayer presence, AR camera passthrough, and a global distance leaderboard.</li>
					<li data-i18n-html="docs_walk_index.the_embed_a_chrome_less_transparent_iframe"><strong>The embed</strong> (<code>/walk-embed</code>) — a chrome-less, transparent iframe that renders a single avatar. Configured entirely by URL query parameters and driven live over <code>postMessage</code>.</li>
					<li data-i18n-html="docs_walk_index.the_sdk_a_zero_dependency_script_tag"><strong>The SDK</strong> (<code>/walk-embed-sdk.js</code>) — a zero-dependency script tag that mounts the embed as a floating corner avatar and exposes <code>window.ThreeWalkAvatar</code> for runtime control and event listening.</li>
					<li data-i18n-html="docs_walk_index.companion_mode_the_extension_the_same_avatar"><strong>Companion mode &amp; the extension</strong> — the same avatar following you across three.ws pages, or across every website via the Chrome extension.</li>
				</ul>

				<div class="wd-note">
					<span class="wd-icon" aria-hidden="true">✱</span>
					<span data-i18n="docs_walk_index.every_example_on_these_pages_is_taken">Every example on these pages is taken from the shipped source. There are no placeholders and no "coming soon" sections — if it is documented here, it works today.</span>
				</div>

				<h2 data-i18n="docs_walk_index.conventions">Conventions</h2>
				<ul>
					<li data-i18n-html="docs_walk_index.urls_are_shown_relative_to_from_a">URLs are shown relative to <code>https://three.ws</code>. From a third-party page, prefix the origin (e.g. <code>https://three.ws/walk-embed</code>).</li>
					<li data-i18n-html="docs_walk_index.code_blocks_have_a_copy_button_the">Code blocks have a <strong>Copy</strong> button. The copied text is the raw source, never the on-screen syntax tint.</li>
					<li data-i18n-html="docs_walk_index.every_page_has_an_edit_this_page">Every page has an <strong>Edit this page</strong> link to its file in the canonical GitHub repository.</li>
				</ul>

				<div class="wd-pagefoot">
					<a class="wd-edit" href="https://github.com/nirholas/three.ws/edit/main/public/docs/walk/index.html" rel="noopener" data-i18n-html="docs_walk_index.edit_this_page_on_github">
						<span aria-hidden="true">✎</span> Edit this page on GitHub
					</a>
					<div class="wd-nextprev">
						<a href="/docs/walk/getting-started" data-i18n-html="docs_walk_index.nextgetting_started"><span>Next</span>Getting started →</a>
					</div>
				</div>
			</main>
		</div>

		<div id="footer-container"></div>
		<script src="/footer.js"></script>
		<script src="/brand.js" defer></script>
		<script type="module" src="/docs/walk/docs.js"></script>
		<!-- Runtime i18n: detects locale, swaps annotated copy, mounts <lang-switcher>. -->
	<script type="module" src="/i18n.js"></script>
</body>
</html>