Skip to content

oscarmarinmiro/aframe-component-boilerplate

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

aframe-component-boilerplate

Boilerplate for sharing A-Frame VR components:

  1. npm install && npm run unboil to rename and trim stuff.
  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

An example component for A-Frame VR.

Properties

Property Description Default Value

Usage

Browser Installation

Install and use by directly including the browser files:

<head>
  <title>My A-Frame Scene</title>
  <script src="https://aframe.io/releases/latest/aframe.min.js"></script>
  <script src="https://raw.githubusercontent.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 Installation

Install via NPM:

npm install aframe-example-component

Then register and use.

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

About

Boilerplate for sharing A-Frame VR components.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%