THREE AR

Introduction

THREE AR aims to provide a simple to use Augmented Reality API for the web, leveraging three.js's 3D capabilities. THREE AR is written in TypeScript. You can see a description of the aims of THREE AR here.

Usage

THREE AR works with npm and also as a CDN. For npm you can install in the following manner:

npm install threear

using a CDN you can include a script tag from unpkg like so:

<script src="https://unpkg.com/threear"></script>

Demo

The examples folder features a basic demo, you can open it on a mobile device and point your camera at the following marker:

<p align="center"> <img width="400px" alt="Hiro Marker" src="./data/hiro.jpg"/> </p>

Documentation and Examples

• Docs
• Examples (Source)
• Examples (Live)
• Change Log

Development and Contribution

Please see the development guide. If you are interested in contributing, it may be a good starting point to see the list of open issues on our GitHub issues page. Please take a moment to read the code of conduct.

Acknowledgements

• ar.js on which this library is based
• jsartoolkit the Emscripten library from the C code for artoolkit, on which this library is underpinned

License

All files within the src/artoolkit folder are licensed LGPLv3

All other files are MIT Licensed and are adapted from the work of Jerome Etienne