A web framework for building virtual reality experiences.
👓 Virtual reality made simple: A-Frame handles the 3D and WebVR boilerplate required to get running across platforms including mobile, desktop, Vive, and Rift just by dropping in <a-scene>
.
❤️ Declarative HTML: A-Frame is accessible to all developers due to its easy-to-read and copy-and-pastable HTML.
⚙ Entity-component pattern: A-Frame is a powerful framework for three.js, providing an declarative, composable, reusable entity-component architecture.
🔨 Tool agnostic: A-Frame interoperates beautifully with JavaScript DOM APIs and most libraries such as React, Vue.js, Angular, or d3.js.
🔍 Visual Inspector: A-Frame provides a built-in visual inspector that acts just like your browser's DevTools; open up a scene and hit <ctrl> + <alt> + i
.
📦 Registry: A-Frame has a Registry, a curated component repository similar to the Unity Asset Store. Install some components and use them right from your HTML.
To get started playing now, open this CodePen example scene.
<html>
<head>
<title>My A-Frame Scene</title>
<script src="https://aframe.io/releases/0.5.0/aframe.min.js"></script>
</head>
<body>
<a-scene>
<a-box position="-1 0.5 -3" rotation="0 45 0" color="#4CC3D9"></a-box>
<a-sphere position="0 1.25 -5" radius="1.25" color="#EF2D5E"></a-sphere>
<a-cylinder position="1 0.75 -3" radius="0.5" height="1.5" color="#FFC65D"></a-cylinder>
<a-plane position="0 0 -4" rotation="-90 0 0" width="4" height="4" color="#7BC8A4"></a-plane>
<a-sky color="#ECECEC"></a-sky>
</a-scene>
</body>
</html>
To use the latest stable build of A-Frame, include aframe.min.js
:
<head>
<script src="https://aframe.io/releases/0.5.0/aframe.min.js"></script>
</head>
To check out the stable and master builds, see the dist/
folder.
npm install --save aframe
require('aframe') // e.g., with Browserify or Webpack.
git clone https://github.com/aframevr/aframe.git # Clone the repository.
cd aframe && npm install # Install dependencies.
npm start # Start the local development server.
And open in your browser https://localhost:9000.
npm run dist
For questions and support, ask on StackOverflow.
- To hang out with the community, join the A-Frame Slack.
- Follow
A Week of A-Frame
on the A-Frame blog. - Follow @aframevr on Twitter.
Get involved! Check out the Contributing Guide for how to get started.
This program is free software and is distributed under an MIT License.