micahstubbs / aframe-extras

:confetti_ball: Add-ons and helpers for A-Frame VR.

A-Frame Extras

Add-ons and helpers for A-Frame VR.

Usage (Scripts)

In the dist/ folder, download any package(s) you need. Include the scripts on your page, and all components are automatically registered for you:

<script src="//cdn.rawgit.com/donmccurdy/aframe-extras/v2.6.0/dist/aframe-extras.min.js"></script>

CDN builds for aframe-extras/v2.6.0:

• aframe-extras.js (development)
• aframe-extras.min.js (production)

For partial builds, use a subpackage like aframe-extras.controls.min.js. Full list of packages below.

A-Frame Version Compatibility

A-Frame	Extras
>= v0.3.0	aframe-extras/v2.6.0
< v0.2.0	*/v1.17.0

Usage (NPM)

npm install --save aframe-extras

// custom-extras.js

var extras = require('aframe-extras');

// Register a single component.
AFRAME.registerComponent('checkpoint', extras.misc.checkpoint);

// Register a particular package, and its dependencies.
extras.controls.registerAll();

// Register everything.
extras.registerAll();

Once installed, you'll need to compile your JavaScript using something like Browserify or Webpack. Example:

npm install -g browserify
browserify custom-extras.js -o bundle.js

bundle.js may then be included in your page. See here for a better introduction to Browserify.

Add-ons

src
├── controls/ (Documentation)
│   ├── checkpoint-controls.js
│   ├── gamepad-controls.js
│   ├── hmd-controls.js
│   ├── keyboard-controls.js
│   ├── mouse-controls.js
│   ├── touch-controls.js
│   └── universal-controls.js
├── loaders/ (Documentation)
│   ├── ply-model.js
│   └── three-model.js
├── misc/ (Documentation)
│   ├── checkpoint.js
│   ├── grab.js                 
│   ├── jump-ability.js
│   ├── kinematic-body.js       
│   ├── sphere-collider.js      
│   └── toggle-velocity.js
├── physics/ (Moved to aframe-physics-system)
├── primitives/ (Documentation)
│   ├── a-grid.js
│   ├── a-ocean.js
│   └── a-tube.js
└── shadows/ (Documentation)    
    ├── shadow-light.js
    └── shadow.js