+3
Daily
17,711
stars
4,407
forks
499
watchers
2,551
prs
3,265
issues
33
releases
README
A-Frame
A web framework for building browser based 3D, AR and VR experiences.
Site
—
Docs
—
Examples
—
School
—
Community
Examples
Find more examples on the homepage, A Week of A-Frame, and WebVR Directory.
Features
:eyeglasses: Virtual Reality Made Simple: A-Frame handles the 3D and WebXR
boilerplate required to get running across platforms including mobile, desktop, and all headsets (compatible with a WebXR capable browser) just by dropping in .
:heart: Declarative HTML: HTML is easy to read and copy-and-paste. Since
A-Frame can be used from HTML, A-Frame is accessible to everyone: web
developers, VR and AR enthusiasts, educators, artists, makers, kids.
:electric_plug: Entity-Component Architecture: A-Frame is a powerful
framework on top of three.js, providing a declarative, composable, reusable
entity-component structure for three.js. While A-Frame can be used from HTML,
developers have unlimited access to JavaScript, DOM APIs, three.js, WebXR, and
WebGL.
:zap: Performance: A-Frame is a thin framework on top of three.js.
Although A-Frame uses the DOM, A-Frame does not touch the browser layout
engine. Performance is a top priority, being battle-tested on highly
interactive WebXR experiences.
:globe_with_meridians: Cross-Platform: Build VR and AR applications for any headset compatible with a WebXR capable browser. Don't have a headset or controllers? No
problem! A-Frame still works on standard desktop and smartphones.
:mag: Visual Inspector: A-Frame provides a built-in visual 3D inspector
with a workflow similar to a browser's developer tools and interface similar to
Unity. Open up any A-Frame scene and hit + + i.
:runner: Features: Hit the ground running with A-Frame's built-in
components such as geometries, materials, lights, animations, models,
raycasters, shadows, positional audio, tracked controllers. Get even further
with community components such as particle systems, physics, multiuser, oceans,
mountains, speech recognition, or teleportation!
Usage
Example
Build VR and AR scenes in the browser with just a few lines of HTML! To start playing
and publishing now, remix the starter example on:
html
With A-Frame's entity-component
architecture, we can drop in community
components from the ecosystem (e.g., ocean, physics) and plug them into our
objects straight from HTML:
See example
html
Builds
To use the latest stable build of A-Frame, include aframe.min.js:
js
To check out the stable and master builds, see the dist/ folder.
npm
sh
npm install --save aframe
Or yarn add aframe
js
import AFRAME from 'aframe'; // e.g., with Webpack or Vite.
Local Development
sh
git clone https://github.com/aframevr/aframe.git Clone the repositoTop issues
#4709WebXR not working on Chrome Desktop Windows106 comments · 2020-10-22#3921User camera not honored anymore and default one injected anyways25 comments · 2018-12-16#3650Initial camera rotation incorrect (Chrome/Android)25 comments · 2018-06-18#4242Make A-Frame ES Modules Compliant to Enable Tree Shaking24 comments · 2019-08-02#2281[docs] Write guide for "Building User Interfaces in VR"23 comments · 2017-01-13#3223Samsung S8 device: double / blurry vision in VR (Cardboard)22 comments · 2017-11-07#3952PCF Soft shadow performance / alternative (approximation)21 comments · 2019-01-14#5305hand-controls misaligned with HTC Vive controllers in 1.4.220 comments · 2023-06-11
Latest release
v1.8.0 v1.8.0 2026-06-241.8.0 (June 23, 2026) Major Changes - Bug fixes and improvements. - Update THREE to r184 Bug fixes - Fix issue when a loaded cube texture doesn't contribute to light probes (fix 5734) (5735) (@mrxz) - Fix issue when url of gltf-model changes when model is still loading (5739) (@mrxz) - Address unsafe-eval error with with strict Content Security Policy (CSP) (fix 5028) (5821) (@vincentfretin, @samiemad, @mrxz) - Replace Clock instance by Timer instance. Clock is deprecated in THREE r183+ (5800) (@vincentfretin) - Remove pcfsoft shadow type in shadow component, deprecated in