@micosmo/aframe
Version:
Aframe components, systems and utilities
79 lines (40 loc) • 2.31 kB
Markdown
@micosmo/aframe
The *aframe* package contains Aframe helper components, systems and utilities for constructing Aframe applications.
# PREREQUISITES
* An ECAScript 2015 complient Javascript environment
# INSTALLATION
* NPM Package - `npm install @micosmo/aframe'
# CONTENTS
## [keyboard](md/keyboard.md)
Keyboard event handler system. Integrates with *keymap* component.
## [keymap](md/keymap.md)
Keyboard key mapping component.
## [misound](md/misound.md)
Extended version of the Aframe *sound* component.
## [mipool](md/mipool.md)
Extended verison of the Aframe *pool* component.
## [jukebox](md/jukebox.md)
Backgound music manager component.
## [button](md/button.md)
Button controller component.
## [gltf-blender-part](md/gltf-blender-part.md)
Extract a part within a Blender gltf asset.
## [gamma](md/gamma.md)
Enable or disable gamma output on the scene's renderer.
## [utils](md/utils.md)
Aframe and threejs utility services
## [initialise](md/initialise.md)
Contains imports that must be processed in the applications *index.js*.
# IMPORTING
There are no default imports for this package.
Aframe component and system modules can be imported as a complete group by importing *@micosmo/aframe/components* and *@micosmo/aframe/systems*.
# VERSIONS
0.1.1 - Fixes to jukebox & gltf-blender-part
0.1.0 - Based on Aframe 0.9.2
# AUTHORS
* Bruce Twite - Initial work
# LICENSE
ISC - Internet Systems Consortium
Copyright 2019 Micosmo ([www.micosmo.com](http://www.micosmo.com))
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.