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.
JavaScript 3d-generationai-agentsanimationavatardigital-humangenerative-aiglbgltfimage-to-3dllmmcpmcp-servermodel-context-protocolsolanatext-to-3dthreejsweb-componentswebglwebxrx402
<!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_getting_started.meta_title">Getting started — Walk docs — three.ws</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0, viewport-fit=cover" />
<meta name="description" content="Walk your first three.ws avatar in five minutes: try the walk page, drop a one-tag embed onto any site, or turn on the site-wide companion." data-i18n-attr="content:docs_walk_getting_started.meta_description"/>
<meta name="theme-color" content="#0a0a0a" />
<link rel="canonical" href="https://three.ws/docs/walk/getting-started" />
<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_getting_started.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_getting_started.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_getting_started.walk_docs">Walk docs</h2>
<nav aria-label="Walk documentation pages">
<a href="/docs/walk" data-i18n="docs_walk_getting_started.overview">Overview</a>
<a href="/docs/walk/getting-started" aria-current="page" data-i18n="docs_walk_getting_started.getting_started">Getting started</a>
</nav>
<h2 data-i18n="docs_walk_getting_started.use_it">Use it</h2>
<nav aria-label="Using Walk">
<a href="/docs/walk/walk-page" data-i18n="docs_walk_getting_started.the_walk_page">The walk page</a>
<a href="/docs/walk/companion-mode" data-i18n="docs_walk_getting_started.companion_mode">Companion mode</a>
<a href="/docs/walk/chrome-extension" data-i18n="docs_walk_getting_started.chrome_extension">Chrome extension</a>
</nav>
<h2 data-i18n="docs_walk_getting_started.build_with_it">Build with it</h2>
<nav aria-label="Building with Walk">
<a href="/docs/walk/embed-iframe" data-i18n="docs_walk_getting_started.iframe_embed">Iframe embed</a>
<a href="/docs/walk/embed-sdk" data-i18n="docs_walk_getting_started.javascript_sdk">JavaScript SDK</a>
<a href="/docs/walk/postmessage-events" data-i18n="docs_walk_getting_started.postmessage_events">postMessage events</a>
<a href="/docs/walk/analytics" data-i18n="docs_walk_getting_started.analytics">Analytics</a>
</nav>
<h2 data-i18n="docs_walk_getting_started.reference">Reference</h2>
<nav aria-label="Reference"><a href="/docs/walk/changelog" data-i18n="docs_walk_getting_started.changelog">Changelog</a></nav>
</aside>
<main class="wd-main" id="wd-main">
<p class="wd-crumbs" data-i18n-html="docs_walk_getting_started.docs_walk_getting_started"><a href="/docs">Docs</a> / <a href="/docs/walk">Walk</a> / Getting started</p>
<h1 data-i18n="docs_walk_getting_started.walk_your_first_avatar_in_five_minutes">Walk your first avatar in five minutes</h1>
<p class="wd-lede" data-i18n="docs_walk_getting_started.three_ways_in_fastest_first_try_the">
Three ways in, fastest first. Try the live page, drop an avatar onto your own
site with a single script tag, or turn on the companion that walks with you
across three.ws.
</p>
<h2 data-i18n="docs_walk_getting_started.1_try_it_live_zero_setup">1 · Try it live (zero setup)</h2>
<p data-i18n-html="docs_walk_getting_started.open_three_ws_walk_move_with_w">
Open <a href="/walk">three.ws/walk</a>. Move with <kbd>W</kbd> <kbd>A</kbd>
<kbd>S</kbd> <kbd>D</kbd> or the arrow keys, hold <kbd>Shift</kbd> to run,
press <kbd>Space</kbd> to jump, and tap a number key for a gesture. On a phone,
use the on-screen joysticks. The full control reference lives on
<a href="/docs/walk/walk-page">the walk page docs</a>.
</p>
<div class="wd-demo">
<div class="wd-demo-head"><span data-i18n-html="docs_walk_getting_started.embedded_preview"><span class="wd-demo-dot"></span>Embedded preview</span><span data-i18n="docs_walk_getting_started.autoplay_walk">autoplay walk</span></div>
<iframe title="Walking avatar preview" src="/walk-embed?controls=none&autoplay=true&ground=false&env=studio" height="300" loading="lazy" allow="accelerometer; gyroscope; xr-spatial-tracking"></iframe>
</div>
<h2 data-i18n="docs_walk_getting_started.2_put_an_avatar_on_your_own">2 · Put an avatar on your own site (one tag)</h2>
<p data-i18n-html="docs_walk_getting_started.the_fastest_integration_is_a_single_tag">
The fastest integration is a single <code><script></code> tag. Drop this
into the <code><body></code> of any page on any origin — no build step, no
framework, no API key:
</p>
<div class="wd-code" data-lang="html" data-label="HTML">
<pre><code><script src="https://three.ws/walk-embed-sdk.js"
data-position="bottom-right"
data-width="220"
data-height="320"></script></code></pre>
</div>
<p data-i18n="docs_walk_getting_started.that_injects_a_fixed_position_transparent_if">
That injects a fixed-position, transparent iframe in the corner and starts a
slow circular walk. To show a specific avatar, add its id:
</p>
<div class="wd-code" data-lang="html" data-label="HTML">
<pre><code><script src="https://three.ws/walk-embed-sdk.js"
data-avatar="YOUR-AVATAR-UUID"
data-position="bottom-left"
data-env="beach"></script></code></pre>
</div>
<div class="wd-note">
<span class="wd-icon" aria-hidden="true">✱</span>
<span data-i18n-html="docs_walk_getting_started.omit_and_the_sdk_falls_back_to">Omit <code>data-avatar</code> and the SDK falls back to the bundled default avatar — served same-origin, so it works in dev, preview, and production without any CORS setup.</span>
</div>
<p data-i18n-html="docs_walk_getting_started.want_full_programmatic_control_instead_of_at">
Want full programmatic control instead of attributes? See the
<a href="/docs/walk/embed-sdk">JavaScript SDK reference</a>. Prefer to manage
the iframe yourself? See the <a href="/docs/walk/embed-iframe">iframe embed
guide</a>.
</p>
<h2 data-i18n="docs_walk_getting_started.3_walk_across_three_ws_companion_mode">3 · Walk across three.ws (companion mode)</h2>
<p data-i18n-html="docs_walk_getting_started.on_three_ws_itself_the_walk_button">
On three.ws itself, the <strong>Walk</strong> button in the top navigation
detaches your avatar from the page and lets it stroll around — and it follows
you as you navigate between pages. You can also force it on with a query
parameter on any three.ws URL:
</p>
<div class="wd-code" data-lang="text" data-label="URL">
<pre><code>https://three.ws/?walk=1</code></pre>
</div>
<p data-i18n-html="docs_walk_getting_started.read_more_in_companion_mode">Read more in <a href="/docs/walk/companion-mode">Companion mode</a>.</p>
<h2 data-i18n="docs_walk_getting_started.next_steps">Next steps</h2>
<ul>
<li data-i18n-html="docs_walk_getting_started.the_walk_page_every_control_camera_environme"><a href="/docs/walk/walk-page">The walk page</a> — every control, camera, environment, gesture, and AR.</li>
<li data-i18n-html="docs_walk_getting_started.javascript_sdk_drive_the_avatar_at_runtime"><a href="/docs/walk/embed-sdk">JavaScript SDK</a> — drive the avatar at runtime: <code>setAvatar</code>, <code>setEnv</code>, <code>setPosition</code>, events.</li>
<li data-i18n-html="docs_walk_getting_started.analytics_measure_sessions_distance_and_conv"><a href="/docs/walk/analytics">Analytics</a> — measure sessions, distance, and conversions per avatar.</li>
<li data-i18n-html="docs_walk_getting_started.chrome_extension_your_avatar_on_every_websit"><a href="/docs/walk/chrome-extension">Chrome extension</a> — your avatar on every website you visit.</li>
</ul>
<div class="wd-pagefoot">
<a class="wd-edit" href="https://github.com/nirholas/three.ws/edit/main/public/docs/walk/getting-started.html" rel="noopener" data-i18n-html="docs_walk_getting_started.edit_this_page_on_github"><span aria-hidden="true">✎</span> Edit this page on GitHub</a>
<div class="wd-nextprev">
<a href="/docs/walk" data-i18n-html="docs_walk_getting_started.previous_overview"><span>Previous</span>← Overview</a>
<a href="/docs/walk/walk-page" data-i18n-html="docs_walk_getting_started.nextthe_walk_page"><span>Next</span>The walk page →</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>