Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 2.33 KB

README.md

File metadata and controls

73 lines (50 loc) · 2.33 KB

FIXME: This needs to be updated to start WebAudio on user input event

Demo here (currently broken on most modern browsers) https://meta-meta.github.io/aframe-puredata-component/basic/

aframe-component-boilerplate

This is not at all means required for writing an A-Frame component. It is intended for publishing and sharing a component for the community to re-use.

Boilerplate for sharing A-Frame components:

  1. npm install && npm run unboil to rename and trim stuff. Don't forget to unboil.
  2. Write your component.
  3. Build examples (npm run dev to watch for changes to build example bundles).
  4. npm publish and commit the dist/ files.
  5. npm run ghpages to share with people.
  6. Share on Slack and awesome-aframe!

Examples:

--trim--

aframe-example-component

A example component for A-Frame.

API

Property Description Default Value

Installation

Browser

Install and use by directly including the browser files:

<head>
  <title>My A-Frame Scene</title>
  <script src="https://aframe.io/releases/0.2.0/aframe.min.js"></script>
  <script src="https://rawgit.com/ngokevin/aframe-component-boilerplate/master/dist/aframe-example-component.min.js"></script>
</head>

<body>
  <a-scene>
    <a-entity example="exampleProp: exampleVal"></a-entity>
  </a-scene>
</body>

npm

Install via npm:

npm install aframe-example-component

Then register and use.

require('aframe');
require('aframe-example-component');