Building blocks for the VR Web.
A-Frame is a library for creating virtual reality web experiences.
- Virtual Reality: Drop in the library and have a WebVR scene within a few lines of markup.
- Entity-Component-System: Based on an entity-component-system pattern 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):
First install from npm:
npm install aframe
And in your Browserify/Webpack modules, simply require the module:
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:
And fire up http://localhost:9000!
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.20) and create a git tag (e.g.,
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.,
npm run release:push
npm run dist git commit -am 'Bump 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
This program is free software and is distributed under an MIT License.