https://github.com/jameslmilner/threear

A marker based Augmented Reality library for Three.js
https://github.com/jameslmilner/threear

artoolkit artoolkitx augmented-reality marker threejs typescript webxr

Last synced: 2 months ago
JSON representation

A marker based Augmented Reality library for Three.js

• Host: GitHub
• URL: https://github.com/jameslmilner/threear
• Owner: JamesLMilner
• Created: 2019-02-19T23:45:19.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-01T04:40:37.000Z (almost 2 years ago)
• Last Synced: 2024-10-10T01:03:42.433Z (2 months ago)
• Topics: artoolkit, artoolkitx, augmented-reality, marker, threejs, typescript, webxr
• Language: TypeScript
• Homepage: https://jameslmilner.github.io/THREEAR/
• Size: 12.6 MB
• Stars: 171
• Watchers: 11
• Forks: 24
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# 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](https://www.typescriptlang.org/). You can see a description of the aims of THREE AR [here](./AIMS.md).

## 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:

```html

```

## Demo 

The examples folder features [a basic demo](https://JamesLMilner.github.io/THREEAR/examples/basic.html), you can open it on a mobile device and point your camera at the following marker:



  



## Documentation and Examples

* [Docs](https://JamesLMilner.github.io/THREEAR/docs)

* [Examples (Source)](https://JamesLMilner.github.io/THREEAR/)

* [Examples (Live)](https://JamesLMilner.github.io/THREEAR/)

* [Change Log](./CHANGELOG.md)

## Development and Contribution

Please see the [development guide](./DEVELOPMENT.md). 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](https://github.com/JamesLMilner/THREEAR/issues). Please take a moment to read the [code of conduct](./CODE_OF_CONDUCT.md).

## Acknowledgements

 - [ar.js](https://github.com/jeromeetienne/AR.js) on which this library is based

 - [jsartoolkit](https://github.com/artoolkitx/jsartoolkit5) 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](https://github.com/jeromeetienne/AR.js/blob/master/LICENSE.txt)