glue to use aframe to author argon applications
JavaScript Ruby CSS
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
examples
src
tests
.gitignore
API.md
CLA.md
CONTRIBUTING.md
CopyrightNotice.md
Gemfile
Gemfile.lock
LICENSE
LICENSE.txt
README.md
_config-develop.yml
_config-master.yml
_config-test.yml
package.json

README.md

argon-aframe

A collection of components, entities and systems to integrate A-Frame with argon.js, so augmented reality content for the Argon web browser can be created with A-Frame.

A note about using https for development

More and more, modern web browsers demand that you use https:// instead of http://. You cannot, for example, use the web location APIs, or access video via WebRTC, over http connections on many browsers. If you want to do development using https and node.js use the devssl target (used by doing npm run devssl).

Documentation

To see documentation of the collection of Entities and Components that link Argon and AFrame, see the API Documentation.

Builds

To use the latest stable build of Argon-AFrame, include argon-aframe.min.js:

<head>
  <script src="https://rawgit.com/argonjs/argon-aframe/master/dist/argon-aframe.js"></script>
</head>

To check out the stable and master builds, see the dist/ folder.

Local Development

git clone https://github.com/argonjs/argon-aframe.git  # Clone the repository.
cd argon-aframe && npm install  # Install dependencies.
npm run devsite # update build.js and genereate a local development site in _sites
npm run dev  # Start the local development server.

And open in your browser http://localhost:8001.

When you change the HTML files, you need to regenerate _site with npm run devsite.

Generating Builds

npm run dist

Questions

For questions and support, ask on one of our support channels.

Stay in Touch

Contributing

Get involved! Check out the Contributing Guide for how to get started.

License

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