WebAR Fácil documentation
Español · English
WebAR Fácil is an MIT-licensed TypeScript library for building browser-based augmented reality. The standalone build includes the renderer, vision runtime, workers and model decoders. Start with HTML or use the JavaScript API to control the camera, tracking and rendering yourself.
Start here
- Your first HTML app gets a JPG or PNG marker and a GLB on screen.
- Declarative HTML describes scene attributes, content and events.
- Declarative recipes adds transforms, animations and transitions.
- Installation and distribution explains the standalone, ESM and core builds.
| Goal | Where to start |
|---|---|
| Add a model, video, gestures or several image targets | Declarative HTML, Interaction, Multiple markers |
| Show a model when the camera detects a phone | Phone recognition |
| Control rendering and the engine in JavaScript | Programmatic integration, WebAREngine, Three.js, A-Frame |
| Place content in space and recover a saved map | Spatial tracking, Placement, Local maps |
| Tune capture and diagnose tracking | Camera and performance, Events, Diagnostics |
| Check what is implemented and tested | Generated API, Verification, Physical-device acceptance |
| Generate a working example with an AI assistant | AI integration contract, JSON API contract |
Run an example
The gallery of 31 examples covers markers, gestures, 3D models, video, surfaces and local maps. Use the image example for a first test, the video example for chroma key, or the placement example for a surface.
Image tracking and optical odometry work with ordinary camera capture. Native immersive WebXR depends on the browser and device. Optical placement without a metric reference uses relative scale. Tracking modes