aframe

Building blocks for the VR Web.

Usage

CodePen

If you want to get starting immediately, just fire up this CodePen example scene!

Downloads

If you would like to embed this library in your project, simply include this file:

• aframe.min.js

Or if you'd prefer the unminified version for local development (with source maps):

• aframe.js

Also, be sure to check out the awesome examples.

npm

First install from npm:

npm install aframe

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

require('aframe')

Local Development

If you'd like to hack on components and/or examples, simply run these commands to get started:

git clone [email protected]:aframevr/aframe.git
cd aframe && npm install && npm start

If you'd like to hack on this project and don't have access to the npm packages, contact @cvan and he'll give you the info you'll need to log in:

npm login

And fire up http://localhost:9000!

Working with aframe-core library

If you want to make changes to the aframe-core library and test with aframe, you'll need to run these commands to link things up correctly.

Linking

When you are in the directory of your aframe-core repo checkout:

npm link

When you are in the directory of your aframe repo checkout:

npm link aframe-core

Now when you make changes to aframe-core, those changes will get reflected when a bundle gets built (the page is refreshed or a aframe file is changed), so you can test the aframe-core dependency against aframe without having to manually push things to npm for testing (which is a big no no!).

Unlinking

You'll need to npm unlink when you are done testing things and want to actually use the npm-published versions, not your versions that are locally linked.

From your aframe-core directory:

npm unlink

From your aframe directory:

npm unlink aframe-core

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