Skip to content
A marker based Augmented Reality library for Three.js
TypeScript HTML JavaScript
Branch: master
Clone or download
JamesMilnerUK V1.0.0 alpha.5 release (#93)
* 1.0.0-alpha.5

* Update change log for alpha.5
Latest commit 8ce7975 Jul 29, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
data Add image and video examples Mar 3, 2019
dist Move checking for lost markers out of marker detection, add example (#91 Jul 29, 2019
docs Move checking for lost markers out of marker detection, add example (#91 Jul 29, 2019
examples Move checking for lost markers out of marker detection, add example (#91 Jul 29, 2019
src Move checking for lost markers out of marker detection, add example (#91 Jul 29, 2019
.gitignore Initial commit Feb 19, 2019
.npmignore Add source maps, .npmignore, change package.json to v1.0.0-alpha.1 Mar 3, 2019
.prettierignore
.prettierrc Remove leftover files, use tabs, add prettier to lint command Mar 2, 2019
.travis.yml Add build mode for CI Mar 10, 2019
AIMS.md Add basic documentation using TypeDoc Mar 10, 2019
CHANGELOG.md V1.0.0 alpha.5 release (#93) Jul 29, 2019
CODE_OF_CONDUCT.md Move development instructions to seperate markdown file, add Code of … Mar 3, 2019
DEVELOPMENT.md Add basic documentation using TypeDoc Mar 10, 2019
README.md Fix link to changelog (#82) May 19, 2019
index.html Added Hole in the Floor example (#74) Apr 28, 2019
package-lock.json auto-changelog (#92) Jul 29, 2019
package.json V1.0.0 alpha.5 release (#93) Jul 29, 2019
tsconfig.json Fix minConfidence issue for PatternMarker, create BaseMarker abstract… Mar 16, 2019
tslint.json Remove leftover files, use tabs, add prettier to lint command Mar 2, 2019
webpack.config.js Fix the webpack build to account for module types in THREE externals (#… May 12, 2019

README.md

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:

Hiro Marker

Documentation and Examples

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

You can’t perform that action at this time.