aframe

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:

• Guide
• Examples
• awesome-aframe
• Ask us on Slack!

Usage

CodePen

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

Downloads

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

• aframe.min.js

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

• aframe.js

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

npm

First install from npm:

npm install aframe

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

require('aframe')

Local Installation and Development

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

And fire up http://localhost:9000!

Maintainers

Ensure you have cloned the repo and installed the dependencies.

Publishing to npm

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

Updating dist Files

npm run dist

Publishing to GitHub Pages

To publish to https://aframevr.github.io/aframe/:

npm run ghpages

To publish to https://your_username.github.io/aframe/:

npm run ghpages your_username

Contributing

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

License

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