/aframe

A web framework for building virtual reality experiences.
  1. JavaScript 97.6%
  2. CSS 2.0%
  3. HTML 0.4%
JavaScript CSS HTML
Find file
Latest commit 4c82e0a Dec 1, 2016 @magnus-bergman magnus-bergman committed with dmarcos Fixes #2088 (#2151) 
Update groundcolor to groundColor in light.js.
Permalink
Failed to load latest commit information.
.github Ask for link to reproducable code within Issue template (#1830) Aug 22, 2016
dist bump master dist Nov 23, 2016
docs [docs] Update "build a more advanced scene" link (#2149) Nov 29, 2016
examples Fix deprecation warnings within the examples (#2135) Nov 23, 2016
scripts rename master builds to aframe-master* (fixes #2007) (#2082) Nov 13, 2016
src Fixes #2088 (#2151) Dec 1, 2016
tests Preserve type of default property values. (#2144) Nov 27, 2016
vendor Bump VREFfect and VRControls Nov 15, 2016
.ackrc add `.ackrc` so `ack` does not search build files Nov 13, 2015
.gitattributes Aframe gitattributes based on conversations #1586 (#1825) Aug 20, 2016
.gitignore Update npmignore and gitignore for coverage (#1787) Aug 12, 2016
.jshintrc Add browserify env to .jshintrc (#1831) Aug 20, 2016
.nojekyll allow `ghpages` npm command to push to GH Pages of fork (fixes #197) Sep 24, 2015
.npmignore Update npmignore and gitignore for coverage (#1787) Aug 12, 2016
.travis.yml add documentation tester for link checking (fixes #2079) (#2080) Nov 10, 2016
CHANGELOG.md properly deprecate moved utils to utils.device (#2103) Nov 23, 2016
CODE_OF_CONDUCT.md adapt rust code of conduct as base for aframe code of conduct (fixes #… Jul 22, 2016
CONTRIBUTING.md docs server (fixes #1818) Oct 31, 2016
LICENSE update license May 26, 2016
ORGANIZATION.md organization.md file (fixes #970) Mar 20, 2016
README.md fix download links readme (fixes #2111) Nov 18, 2016
ROADMAP.md update roadmap (#1668) Aug 2, 2016
codecov.yml make codecov find the codecov.yml config Aug 22, 2016
index.html The Purge II: add vr-markup examples, change port to 9001 Sep 24, 2015
package.json update package.json to point to master Nov 23, 2016

README.md

A-Frame

Building Blocks for the VR Web

build status codecov NPM version Downloads js-semistandard-style

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

<a-montage>

  • 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

CodePen

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

Downloads

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).

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 [email protected]:aframevr/aframe.git
cd aframe && npm install

To start the local development server:

npm start

And fire up http://localhost:9000!

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.