aframe travis-ci npm

Building Blocks for the VR Web

3 years after

A-Frame

Building blocks for the VR Web.

build status NPM version Downloads js-semistandard-style

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.
  • 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 flexibility.

Find out more:

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:

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

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!

Maintainers

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

Updating dist Files

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

License

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

Related Repositories

awesome-aframe

awesome-aframe

A collection of awesome things regarding the A-Frame ecosystem. ...

aframe-draw-component

aframe-draw-component

HTML5 canvas component for AFrame VR. ...

aframe-stereo-component

aframe-stereo-component

aframe.io component to enable separate eye rendering of objects, plus stereo vid ...

aframe-textwrap-component

aframe-textwrap-component

Text wrapping for AFrame draw. ...

aframe-video-controls

aframe-video-controls

AFrame component to control (play/pause/jump) videos. ...


Top Contributors

dmarcos cvan ngokevin nylki caseyyee JoshGalvin mattdesl cemkod meta-meta fernandojsg mattpolicastro K4orta donmccurdy legendtang roninb RSpace autonome amberroy maxkrieger mrdoob rolz larouxn

Releases

-   v0.1.3 zip tar
-   v0.1.2 zip tar
-   v0.1.1 zip tar
-   v0.1.0 zip tar