For the core library, check out A-Frame Core.
Building blocks for the VR Web.
- 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: Use the entity-component system for better composability and flexibility.
Find out more:
If you want to get started immediately, just fire up this CodePen example scene!
If you would like to embed this library in your project, simply include this file:
Or if you'd prefer the unminified version for local development (with source maps):
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 [email protected]:aframevr/aframe.git
cd aframe && npm install
To start the local development server:
npm start
And fire up http://localhost:9000! Saving local JS and HTML files in examples/, elements/ and so forth will rebuild the bundle and reload the page.
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
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
npm run dist
git commit -am 'Bump dist'
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
This program is free software and is distributed under an MIT License.