A-Frame

Building Blocks for the VR Web

A-Frame is a framework for creating virtual reality web experiences.

Virtual Reality: Drop in the library and have a WebVR scene within a few lines of markup.
Based on the DOM: Manipulate with JavaScript, use with your favorite libraries and frameworks.
Entity-Component-System: Based on an entity-component-system pattern for better composability and extensibility.

Find out more:

Usage

To get started immediately, just fire up this CodePen example scene!

To embed this library in your project, include this file:

For the unminified version for local development (with source maps), include this file:

Also, be sure to check out the awesome examples (or the ones in this repository).

First install from npm:

npm install aframe

And in your Browserify/Webpack modules, simply require the module:

require('aframe')

Alternatively, you can clone this repository to work locally on this project and explore the examples.

git clone git@github.com:aframevr/aframe.git
cd aframe && npm install

To start the local development server:

npm start

To increment the preminor version of the package (e.g., 0.1.19 to 0.1.20) and create a git tag (e.g., v0.1.20):

npm run release:bump

NOTE: npm versions cannot be unpublished.

Once the package is 100% ready to go, to push the new version to npm (e.g., 0.1.20) and to the new tag to GitHub (e.g., v0.1.20):

npm run release:push

npm run dist

npm run ghpages

npm run ghpages your_username

Get involved! Check out the Contributing Guide for how to get started.

This program is free software and is distributed under an MIT License.