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.

19.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_walk_page.meta_title">The walk page — Walk docs — three.ws</title>
		<meta name="viewport" content="width=device-width, initial-scale=1.0, viewport-fit=cover" />
		<meta name="description" content="The three.ws walk page: keyboard and touch controls, four camera modes, six environments, eight gestures, live multiplayer presence, AR camera passthrough, and the URL parameters it reads."  data-i18n-attr="content:docs_walk_walk_page.meta_description"/>
		<meta name="theme-color" content="#0a0a0a" />
		<link rel="canonical" href="https://three.ws/docs/walk/walk-page" />
		<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" />
	</head>
	<body>
		<a class="wd-skip" href="#wd-main" data-i18n="docs_walk_walk_page.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_walk_page.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_walk_page.walk_docs">Walk docs</h2>
				<nav aria-label="Walk documentation pages">
					<a href="/docs/walk" data-i18n="docs_walk_walk_page.overview">Overview</a>
					<a href="/docs/walk/getting-started" data-i18n="docs_walk_walk_page.getting_started">Getting started</a>
				</nav>
				<h2 data-i18n="docs_walk_walk_page.use_it">Use it</h2>
				<nav aria-label="Using Walk">
					<a href="/docs/walk/walk-page" aria-current="page" data-i18n="docs_walk_walk_page.the_walk_page">The walk page</a>
					<a href="/docs/walk/companion-mode" data-i18n="docs_walk_walk_page.companion_mode">Companion mode</a>
					<a href="/docs/walk/chrome-extension" data-i18n="docs_walk_walk_page.chrome_extension">Chrome extension</a>
				</nav>
				<h2 data-i18n="docs_walk_walk_page.build_with_it">Build with it</h2>
				<nav aria-label="Building with Walk">
					<a href="/docs/walk/embed-iframe" data-i18n="docs_walk_walk_page.iframe_embed">Iframe embed</a>
					<a href="/docs/walk/embed-sdk" data-i18n="docs_walk_walk_page.javascript_sdk">JavaScript SDK</a>
					<a href="/docs/walk/postmessage-events" data-i18n="docs_walk_walk_page.postmessage_events">postMessage events</a>
					<a href="/docs/walk/analytics" data-i18n="docs_walk_walk_page.analytics">Analytics</a>
				</nav>
				<h2 data-i18n="docs_walk_walk_page.reference">Reference</h2>
				<nav aria-label="Reference"><a href="/docs/walk/changelog" data-i18n="docs_walk_walk_page.changelog">Changelog</a></nav>
			</aside>

			<main class="wd-main" id="wd-main">
				<p class="wd-crumbs" data-i18n-html="docs_walk_walk_page.docs_walk_the_walk_page"><a href="/docs">Docs</a> / <a href="/docs/walk">Walk</a> / The walk page</p>
				<h1 data-i18n="docs_walk_walk_page.the_walk_page_2">The walk page</h1>
				<p class="wd-lede" data-i18n-html="docs_walk_walk_page.three_ws_walk_is_the_full_experience">
					<a href="/walk">three.ws/walk</a> is the full experience: move an avatar through
					six 3D worlds, switch between four camera modes, fire gestures, see other
					walkers live, and step into AR. This page documents the controls exactly as
					they ship.
				</p>

				<h2 data-i18n="docs_walk_walk_page.keyboard_pointer_controls">Keyboard &amp; pointer controls</h2>
				<p data-i18n="docs_walk_walk_page.on_desktop_the_avatar_is_driven_with">On desktop, the avatar is driven with the keyboard; the mouse orbits the camera.</p>
				<div class="wd-table-wrap">
					<table class="wd-table">
						<thead><tr><th data-i18n="docs_walk_walk_page.key">Key</th><th data-i18n="docs_walk_walk_page.action">Action</th></tr></thead>
						<tbody>
							<tr><td data-i18n-html="docs_walk_walk_page.w"><kbd>W</kbd> / <kbd>↑</kbd></td><td data-i18n="docs_walk_walk_page.move_forward">Move forward</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.s"><kbd>S</kbd> / <kbd>↓</kbd></td><td data-i18n="docs_walk_walk_page.move_backward">Move backward</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.a"><kbd>A</kbd> / <kbd>←</kbd></td><td data-i18n="docs_walk_walk_page.strafe_left">Strafe left</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.d"><kbd>D</kbd> / <kbd>→</kbd></td><td data-i18n="docs_walk_walk_page.strafe_right">Strafe right</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.shift_hold"><kbd>Shift</kbd> (hold)</td><td data-i18n="docs_walk_walk_page.run">Run</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.space"><kbd>Space</kbd></td><td data-i18n="docs_walk_walk_page.jump">Jump</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.q_e"><kbd>Q</kbd> / <kbd>E</kbd></td><td data-i18n="docs_walk_walk_page.snap_turn_45_left_right">Snap-turn 45° left / right</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.c"><kbd>C</kbd></td><td data-i18n="docs_walk_walk_page.cycle_camera_mode">Cycle camera mode</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.v"><kbd>V</kbd></td><td data-i18n="docs_walk_walk_page.cycle_environment">Cycle environment</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.g_hold"><kbd>G</kbd> (hold)</td><td data-i18n="docs_walk_walk_page.open_the_gesture_wheel">Open the gesture wheel</td></tr>
							<tr><td><kbd>1</kbd>–<kbd>8</kbd></td><td data-i18n="docs_walk_walk_page.play_a_gesture_directly">Play a gesture directly</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.t_enter"><kbd>T</kbd> / <kbd>Enter</kbd></td><td data-i18n="docs_walk_walk_page.focus_chat">Focus chat</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.p"><kbd>P</kbd></td><td data-i18n="docs_walk_walk_page.screenshot">Screenshot</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.r"><kbd>R</kbd></td><td data-i18n="docs_walk_walk_page.toggle_gif_recording">Toggle GIF recording</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.m"><kbd>M</kbd></td><td data-i18n="docs_walk_walk_page.toggle_minimap">Toggle minimap</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.z"><kbd>Z</kbd></td><td data-i18n="docs_walk_walk_page.hide_ui_zen_mode">Hide UI (Zen mode)</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.h"><kbd>H</kbd> / <kbd>?</kbd></td><td data-i18n="docs_walk_walk_page.toggle_the_help_overlay">Toggle the help overlay</td></tr>
							<tr><td data-i18n="docs_walk_walk_page.mouse_drag">Mouse drag</td><td data-i18n="docs_walk_walk_page.orbit_the_camera">Orbit the camera</td></tr>
							<tr><td data-i18n="docs_walk_walk_page.scroll_pinch">Scroll / pinch</td><td data-i18n="docs_walk_walk_page.zoom_in_out">Zoom in / out</td></tr>
							<tr><td data-i18n-html="docs_walk_walk_page.esc"><kbd>Esc</kbd></td><td data-i18n="docs_walk_walk_page.close_overlay_release_pointer_lock">Close overlay / release pointer lock</td></tr>
						</tbody>
					</table>
				</div>
				<div class="wd-note">
					<span class="wd-icon" aria-hidden="true">✱</span>
					<span data-i18n="docs_walk_walk_page.on_touch_devices_the_page_shows_dual">On touch devices the page shows dual on-screen sticks — the left stick moves the avatar, the right stick orbits the camera — plus jump, camera, and gesture buttons. Hold the gesture button to open the radial wheel.</span>
				</div>

				<h2 data-i18n="docs_walk_walk_page.camera_modes">Camera modes</h2>
				<p data-i18n-html="docs_walk_walk_page.press_c_or_tap_the_camera_button">Press <kbd>C</kbd> (or tap the camera button) to cycle through four modes. Your choice persists across sessions.</p>
				<div class="wd-table-wrap">
					<table class="wd-table">
						<thead><tr><th data-i18n="docs_walk_walk_page.mode">Mode</th><th data-i18n="docs_walk_walk_page.label">Label</th><th data-i18n="docs_walk_walk_page.behaviour">Behaviour</th></tr></thead>
						<tbody>
							<tr><td><code>follow</code></td><td data-i18n="docs_walk_walk_page.follow">Follow</td><td data-i18n="docs_walk_walk_page.default_third_person_camera_that_trails_the">Default third-person camera that trails the avatar.</td></tr>
							<tr><td><code>cinematic</code></td><td data-i18n="docs_walk_walk_page.cinematic">Cinematic</td><td data-i18n="docs_walk_walk_page.auto_orbiting_camera_that_periodically_cuts">Auto-orbiting camera that periodically cuts to a new angle.</td></tr>
							<tr><td><code>firstperson</code></td><td data-i18n="docs_walk_walk_page.first_person">First Person</td><td data-i18n="docs_walk_walk_page.sees_through_the_avatar_s_eyes_the">Sees through the avatar's eyes; the body is hidden.</td></tr>
							<tr><td><code>topdown</code></td><td data-i18n="docs_walk_walk_page.top_down">Top Down</td><td data-i18n="docs_walk_walk_page.overhead_view_of_the_avatar_and_surrounding">Overhead view of the avatar and surrounding world.</td></tr>
						</tbody>
					</table>
				</div>

				<h2 data-i18n="docs_walk_walk_page.environments">Environments</h2>
				<p data-i18n-html="docs_walk_walk_page.six_worlds_each_with_its_own_terrain">Six worlds, each with its own terrain, sky, and lighting. Cycle with <kbd>V</kbd>, or land directly in one with the <code>?env=</code> URL parameter.</p>
				<div class="wd-table-wrap">
					<table class="wd-table">
						<thead><tr><th data-i18n="docs_walk_walk_page.id">id</th><th data-i18n="docs_walk_walk_page.name">Name</th><th data-i18n="docs_walk_walk_page.setting">Setting</th></tr></thead>
						<tbody>
							<tr><td><code>park</code></td><td data-i18n="docs_walk_walk_page.park">Park</td><td data-i18n-html="docs_walk_walk_page.rolling_green_with_shade_trees_benches_and">Rolling green with shade trees, benches, and lamp posts. <em>(default)</em></td></tr>
							<tr><td><code>beach</code></td><td data-i18n="docs_walk_walk_page.beach">Beach</td><td data-i18n="docs_walk_walk_page.bright_sand_palms_parasols_and_a_turquoise">Bright sand, palms, parasols, and a turquoise sea.</td></tr>
							<tr><td><code>gallery</code></td><td data-i18n="docs_walk_walk_page.gallery">Gallery</td><td data-i18n="docs_walk_walk_page.white_walled_exhibition_space_with_pedestals">White-walled exhibition space with pedestals and hung art.</td></tr>
							<tr><td><code>cyberpunk</code></td><td data-i18n="docs_walk_walk_page.cyberpunk">Cyberpunk</td><td data-i18n="docs_walk_walk_page.neon_towers_and_holo_signs_over_a">Neon towers and holo signs over a rain-dark street.</td></tr>
							<tr><td><code>office</code></td><td data-i18n="docs_walk_walk_page.office">Office</td><td data-i18n="docs_walk_walk_page.the_three_ws_virtual_office_desks_plants">The three.ws virtual office — desks, plants, brand wall.</td></tr>
							<tr><td><code>void</code></td><td data-i18n="docs_walk_walk_page.void">Void</td><td data-i18n="docs_walk_walk_page.a_minimal_grid_plane_under_a_soft">A minimal grid plane under a soft gradient — pure focus.</td></tr>
						</tbody>
					</table>
				</div>
				<div class="wd-code" data-lang="text" data-label="URL">
					<pre><code>https://three.ws/walk?env=cyberpunk</code></pre>
				</div>

				<h2 data-i18n="docs_walk_walk_page.gestures">Gestures</h2>
				<p data-i18n-html="docs_walk_walk_page.eight_gestures_play_on_top_of_or">
					Eight gestures play on top of (or instead of) walking. Hold <kbd>G</kbd> for the
					radial wheel, or press a number key. Upper-body gestures layer over locomotion
					so the avatar keeps walking; full-body gestures take over until they finish.
				</p>
				<div class="wd-table-wrap">
					<table class="wd-table">
						<thead><tr><th>#</th><th data-i18n="docs_walk_walk_page.gesture">Gesture</th><th data-i18n="docs_walk_walk_page.layer">Layer</th></tr></thead>
						<tbody>
							<tr><td>1</td><td><code>wave</code></td><td data-i18n="docs_walk_walk_page.upper_body_keeps_walking">Upper body (keeps walking)</td></tr>
							<tr><td>2</td><td><code>dance</code></td><td data-i18n="docs_walk_walk_page.full_body">Full body</td></tr>
							<tr><td>3</td><td><code>sit</code></td><td data-i18n="docs_walk_walk_page.full_body_2">Full body</td></tr>
							<tr><td>4</td><td><code>point</code></td><td data-i18n="docs_walk_walk_page.upper_body_keeps_walking_2">Upper body (keeps walking)</td></tr>
							<tr><td>5</td><td><code>cheer</code></td><td data-i18n="docs_walk_walk_page.upper_body_keeps_walking_3">Upper body (keeps walking)</td></tr>
							<tr><td>6</td><td><code>agree</code></td><td data-i18n="docs_walk_walk_page.upper_body_keeps_walking_4">Upper body (keeps walking)</td></tr>
							<tr><td>7</td><td><code>disagree</code></td><td data-i18n="docs_walk_walk_page.upper_body_keeps_walking_5">Upper body (keeps walking)</td></tr>
							<tr><td>8</td><td><code>talking</code></td><td data-i18n="docs_walk_walk_page.full_body_3">Full body</td></tr>
						</tbody>
					</table>
				</div>

				<h2 data-i18n="docs_walk_walk_page.multiplayer_presence">Multiplayer presence</h2>
				<p data-i18n-html="docs_walk_walk_page.the_walk_page_connects_to_a_real">
					The walk page connects to a real-time presence server, so when others are in the
					same world you see them move, gesture, and chat live. Each remote walker's
					position, facing, motion, name, colour, and avatar are synchronised continuously.
					The status pill shows <strong>online</strong>, <strong>connecting</strong>,
					<strong>solo</strong>, or <strong>offline</strong>, and a player list names
					everyone present.
				</p>
				<p data-i18n-html="docs_walk_walk_page.walkers_are_grouped_into_shared_rooms_by">
					Walkers are grouped into shared rooms by the <code>?coin</code> community they
					arrive with — pass a Solana mint and a friendly name to put a community in one
					room together:
				</p>
				<div class="wd-code" data-lang="text" data-label="URL">
					<pre><code>https://three.ws/walk?coin=&lt;mint&gt;&amp;coinName=&lt;name&gt;&amp;coinSymbol=&lt;ticker&gt;</code></pre>
				</div>
				<div class="wd-note">
					<span class="wd-icon" aria-hidden="true">✱</span>
					<span data-i18n="docs_walk_walk_page.if_the_presence_server_is_unreachable_the">If the presence server is unreachable the page still works perfectly — it simply runs solo. Multiplayer is an enhancement, never a requirement.</span>
				</div>

				<h2 data-i18n="docs_walk_walk_page.ar_camera_passthrough">AR camera passthrough</h2>
				<p data-i18n="docs_walk_walk_page.on_a_phone_the_ar_button_drops">
					On a phone, the AR button drops the avatar into your real surroundings. It
					streams the rear camera as the backdrop, hides the procedural terrain, keeps a
					shadow-catcher under the avatar's feet, freezes the camera in world space, and
					continuously samples the live video to match the avatar's lighting to your room.
				</p>
				<div class="wd-warn">
					<span class="wd-icon" aria-hidden="true">▲</span>
					<span data-i18n-html="docs_walk_walk_page.ar_uses_the_device_camera_for_passthrough">AR uses the device camera (<code>getUserMedia</code>) for passthrough — it is not WebXR spatial AR, so there is no plane detection or world anchoring. It requires a browser with camera access and falls back gracefully with a clear message where the camera API is unavailable.</span>
				</div>

				<h2 data-i18n="docs_walk_walk_page.url_parameters_the_page_reads">URL parameters the page reads</h2>
				<p data-i18n-html="docs_walk_walk_page.append_these_to_to_deep_link_into">Append these to <code>/walk</code> to deep-link into a configuration.</p>
				<div class="wd-table-wrap">
					<table class="wd-table">
						<thead><tr><th data-i18n="docs_walk_walk_page.parameter">Parameter</th><th data-i18n="docs_walk_walk_page.value">Value</th><th data-i18n="docs_walk_walk_page.effect">Effect</th></tr></thead>
						<tbody>
							<tr><td><code>avatar</code></td><td data-i18n="docs_walk_walk_page.avatar_uuid">avatar UUID</td><td data-i18n="docs_walk_walk_page.load_a_registered_avatar_by_id">Load a registered avatar by id.</td></tr>
							<tr><td><code>avatarUrl</code></td><td data-i18n="docs_walk_walk_page.glb_vrm_url">GLB / VRM URL</td><td data-i18n="docs_walk_walk_page.load_a_model_directly_by_url">Load a model directly by URL.</td></tr>
							<tr><td><code>name</code></td><td data-i18n="docs_walk_walk_page.string_24_chars">string (≤24 chars)</td><td data-i18n="docs_walk_walk_page.pre_fill_the_player_name">Pre-fill the player name.</td></tr>
							<tr><td><code>env</code></td><td data-i18n="docs_walk_walk_page.environment_id">environment id</td><td data-i18n="docs_walk_walk_page.start_in_a_specific_world">Start in a specific world.</td></tr>
							<tr><td><code>coin</code></td><td data-i18n="docs_walk_walk_page.solana_mint">Solana mint</td><td data-i18n="docs_walk_walk_page.join_that_community_s_shared_room">Join that community's shared room.</td></tr>
							<tr><td><code>coinName</code></td><td data-i18n="docs_walk_walk_page.string_48">string (≤48)</td><td data-i18n="docs_walk_walk_page.display_name_for_the_community">Display name for the community.</td></tr>
							<tr><td><code>coinSymbol</code></td><td data-i18n="docs_walk_walk_page.string_16">string (≤16)</td><td data-i18n="docs_walk_walk_page.ticker_for_the_community">Ticker for the community.</td></tr>
							<tr><td><code>coinImage</code></td><td data-i18n="docs_walk_walk_page.image_url_1024">image URL (≤1024)</td><td data-i18n="docs_walk_walk_page.community_logo">Community logo.</td></tr>
							<tr><td><code>agent</code></td><td data-i18n="docs_walk_walk_page.agent_id">agent id</td><td data-i18n="docs_walk_walk_page.the_three_ws_agent_this_walker_embodies">The three.ws agent this walker embodies.</td></tr>
							<tr><td><code>ui</code></td><td><code>hidden</code> / <code>off</code></td><td data-i18n="docs_walk_walk_page.hide_the_ui_on_load_zen_mode">Hide the UI on load (Zen mode).</td></tr>
						</tbody>
					</table>
				</div>

				<div class="wd-pagefoot">
					<a class="wd-edit" href="https://github.com/nirholas/three.ws/edit/main/public/docs/walk/walk-page.html" rel="noopener" data-i18n-html="docs_walk_walk_page.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_walk_page.previous_getting_started"><span>Previous</span>← Getting started</a>
						<a href="/docs/walk/embed-iframe" data-i18n-html="docs_walk_walk_page.nextiframe_embed"><span>Next</span>Iframe embed →</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>