|
| 1 | +# Immersive Web SDK |
| 2 | + |
| 3 | +> Immersive Web SDK (IWSDK) is an AI-native WebXR framework for building VR, AR, mixed-reality, and browser-first 3D applications with Entity Component System architecture, Three.js-compatible rendering, spatial input, locomotion, spatial UI, runtime CLI tooling, MCP-compatible inspection, and headless browser verification. |
| 4 | + |
| 5 | +IWSDK applications should be built from the official scaffold and verified through the `iwsdk` CLI whenever possible. Cloud-based harnesses often have incomplete MCP setup, so agents should load the skill first and prefer CLI commands for setup, runtime inspection, screenshots, ECS debugging, XR emulation, and reference queries. MCP tools are useful when the harness exposes them and they are already connected. |
| 6 | + |
| 7 | +## Agent Entry Points |
| 8 | + |
| 9 | +- [IWSDK development skill](https://iwsdk.dev/skill.md): Canonical cloud-harness instructions for building, testing, debugging, and deploying IWSDK applications. |
| 10 | +- [Agent quickstart](https://iwsdk.dev/go.md): Short operational entrypoint for agents that need a compact start-here file before loading the full skill. |
| 11 | + |
| 12 | +## Start Here |
| 13 | + |
| 14 | +- [AI-native development overview](https://iwsdk.dev/ai/): How IWSDK's managed browser, runtime CLI, and MCP-compatible tooling fit together. |
| 15 | +- [Getting started with AI](https://iwsdk.dev/ai/getting-started.html): Enable AI tooling, start the managed runtime, and connect supported tools. |
| 16 | +- [AI workflows](https://iwsdk.dev/ai/workflows.html): Runtime-first CLI workflows for screenshots, controller interaction, scene inspection, ECS debugging, and parity checks. |
| 17 | +- [MCP tools reference](https://iwsdk.dev/ai/mcp-tools.html): Runtime tool surface and CLI/MCP equivalents. |
| 18 | + |
| 19 | +## Guides |
| 20 | + |
| 21 | +- [Project setup](https://iwsdk.dev/guides/01-project-setup.html): Scaffold a new IWSDK project and choose XR, AR, browser-first, and feature flags. |
| 22 | +- [Testing experience](https://iwsdk.dev/guides/02-testing-experience.html): Run, inspect, and verify IWSDK apps during development. |
| 23 | +- [Working in 3D](https://iwsdk.dev/guides/03-working-in-3d.html): Core scene, mesh, transform, and material patterns. |
| 24 | +- [Built-in interactions](https://iwsdk.dev/guides/06-built-in-interactions.html): Input, pointers, grabbing, and interaction systems. |
| 25 | +- [Custom systems](https://iwsdk.dev/guides/07-custom-systems.html): Build ECS systems and components. |
| 26 | +- [Build and deploy](https://iwsdk.dev/guides/08-build-deploy.html): Production builds, optimized assets, and static deployment. |
| 27 | +- [Browser-first systems](https://iwsdk.dev/guides/16-browser-first-systems.html): Browser-first 3D app patterns without requiring a headset. |
| 28 | + |
| 29 | +## Core Concepts |
| 30 | + |
| 31 | +- [ECS](https://iwsdk.dev/concepts/ecs/): World, entity, component, system, query, lifecycle, and architecture concepts. |
| 32 | +- [Three.js with IWSDK](https://iwsdk.dev/concepts/three-basics/): Three.js interoperability, transforms, meshes, geometry, and materials. |
| 33 | +- [XR input](https://iwsdk.dev/concepts/xr-input/): Input actions, visuals, pointers, stateful gamepads, and XR origin handling. |
| 34 | +- [Locomotion](https://iwsdk.dev/concepts/locomotion/): Slide, teleport, turn, and locomotion performance. |
| 35 | +- [Spatial UI](https://iwsdk.dev/concepts/spatial-ui/): UIKit, UIKitML, layout, documents, and end-to-end spatial UI flow. |
| 36 | +- [Grabbing](https://iwsdk.dev/concepts/grabbing/): Object grabbing and manipulation interaction types. |
| 37 | + |
| 38 | +## API Reference |
| 39 | + |
| 40 | +- [API index](https://iwsdk.dev/api/): Generated TypeDoc reference for IWSDK packages. |
| 41 | +- [Core API](https://iwsdk.dev/api/core/): Core runtime, ECS, world, rendering, and framework APIs. |
| 42 | +- [XR input API](https://iwsdk.dev/api/xr-input/): XR input package reference. |
| 43 | +- [Locomotor API](https://iwsdk.dev/api/locomotor/): Locomotion package reference. |
| 44 | +- [Vite plugin APIs](https://iwsdk.dev/api/vite-plugin-gltf-optimizer/): Build-time plugins and optimization references. |
| 45 | + |
| 46 | +## Examples |
| 47 | + |
| 48 | +- [Examples overview](https://iwsdk.dev/examples/): Example apps covering audio, environment raycast, grab interactions, locomotion, physics, scene understanding, and depth occlusion. |
| 49 | +- [GitHub repository](https://github.com/facebook/immersive-web-sdk): Source code, examples, packages, and issue tracker. |
| 50 | + |
| 51 | +## Optional |
| 52 | + |
| 53 | +- [llms.txt proposal](https://llmstxt.org/index.md): Informal convention used by this file. |
| 54 | +- [AGENTS.md convention](https://agents.md/): Project-level coding-agent instruction convention; separate from this site's public skill entrypoint. |
0 commit comments