aframe

aframe

Building blocks for the VR Web.

Usage

CodePen

If you want to get started 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 (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 [e-mail]:aframevr/aframe.git
cd aframe && npm install

To start the local development server:

npm start

And fire up http://localhost:9000!

Browser console logging

If you'd like to see helpful logs, warnings, and errors, you can enable logging from the console of your favourite developer tools:

localStorage.logs = 1

And to disable:

localStorage.logs = 0

Maintainers

Ensure you have cloned the repo and installed the dependencies.

Developing alongside the other aframe packages (e.g., aframe-core)

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

Releasing and publishing a new version 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
git commit -am 'Bump dist'

Publishing to GitHub Pages

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

npm run ghpages

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

npm run ghpages your_username

License

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