Your first three.ws agent

A one-click starting point for putting a live, animated 3D agent on a web page. Open the
repository in GitHub Codespaces and the demo starts automatically.

Start in Codespaces

Use Code > Codespaces > Create codespace on main. When the forwarded port opens, the page
shows a real <agent-3d> component using the production three.ws CDN.

For a local checkout:

npm ci
npm run dev

Open http://localhost:4173.

Make the character yours

Run this in the terminal:

npm create @three-ws/agent "a friendly robot guide"

The command uses the public generation lane, downloads the finished GLB, and creates a working
page. No three.ws account or API key is required. Replace the body URL in index.html with
the generated model URL or a path to the downloaded agent.glb.

The whole integration

<script type="module" src="https://three.ws/agent-3d/latest/agent-3d.js"></script>
<agent-3d body="https://three.ws/avatars/default.glb" name="Nova"></agent-3d>

app.js adds two real interactions: it finds a wave in the live animation catalog and calls
playClip(), and it calls speak() for a talking gesture.

Verify

npm test

Continue with LEARN.md, then explore the
web component API and the
visual creator.

License

Apache-2.0

Star History