# iamar

> iamar is a native 3D world browser. People visit worlds, walk around and meet each other; anyone can build a world with their own AI agent and host it from their computer. https://iamar.ai

## Build a world (start here, agents)

- [Agent kit: instructions for building an iamar world](https://iamar.ai/docs/oakhaven/kit/AGENT_KIT.md): read this first and follow its playbook
- [Build your own iamar world (TypeScript getting started)](https://iamar.ai/docs/start/): write world.ts, compile it, package, and host from the browser (Esc > Host My World)
- [World API 0.3 reference](https://iamar.ai/docs/api/): every function and callback in TypeScript, error codes and limits; world scripts are written in TypeScript
- [iamar-world.d.ts (TypeScript declarations)](https://iamar.ai/docs/api/iamar-world.d.ts): `declare const iamar: {...}` plus the callback declarations, generated from world_api.json
- [world_api.json (machine-readable API)](https://iamar.ai/docs/api/world_api.json): the source of truth the reference and declarations are generated from
- [Make it look like iamar city (art guide)](https://iamar.ai/docs/art/): the iamar look in numbers, step-by-step quality and a self-check list for agents
- [World package format](https://iamar.ai/docs/oakhaven/docs/WORLD_FORMAT.md): manifest.json, scene.json, assets, budgets, signing, every field
- [World API (sandboxed WebAssembly scripts)](https://iamar.ai/docs/oakhaven/docs/WORLD_API.md): the raw API, callbacks, budgets
- [Hardware tiers](https://iamar.ai/docs/oakhaven/docs/WORLD_TIERS.md)
- [Techniques and recipes](https://iamar.ai/docs/oakhaven/kit/recipes/TECHNIQUES.md): LOD, impostors, merging, baking, budgets
- [Host My World: self-hosting from the browser](https://iamar.ai/docs/oakhaven/docs/SELF_HOSTING.md)

## Schemas

- [manifest.schema.json](https://iamar.ai/docs/oakhaven/schemas/manifest.schema.json)
- [scene.schema.json](https://iamar.ai/docs/oakhaven/schemas/scene.schema.json)
- [signature.schema.json](https://iamar.ai/docs/oakhaven/schemas/signature.schema.json)
- [pieces.schema.json](https://iamar.ai/docs/oakhaven/schemas/pieces.schema.json)

## Platform

- [Hub protocol](https://iamar.ai/docs/iamar/docs/HUB_PROTOCOL.md): every hub message, for browsers and world hosts
- [Architecture](https://iamar.ai/docs/iamar/docs/ARCHITECTURE.md)
- [World addresses and aliases](https://iamar.ai/docs/iamar/docs/ALIASES.md)
- [Documentation page](https://iamar.ai/docs/)
- Source: https://github.com/endsley/iamar (iamar city, browser, runtime, kit), https://github.com/endsley/iamar-hub (iamar hub, protocol)
- Download the browser (Windows, macOS, Linux; private test build, password required): https://iamar.ai/#get