# encantar.js WebAR engine

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/alemart/encantar-js)](https://github.com/alemart/encantar-js/releases/) ![GitHub file size in bytes on a specified ref (branch/commit/tag)](https://img.shields.io/github/size/alemart/encantar-js/dist/encantar.min.js?branch=master&label=minified%20js) [![GitHub Repo stars](https://img.shields.io/github/stars/alemart/encantar-js?logo=github)](https://github.com/alemart/encantar-js/stargazers) [![GitHub Sponsors](https://img.shields.io/github/sponsors/alemart?logo=github)](https://github.com/sponsors/alemart/)

Enchant your users with **encantar.js**, a GPU-accelerated Augmented Reality engine for the web.

:magic_wand: **[Demos](https://alemart.github.io/encantar-js/demos/)** | :books: **[Learn](https://alemart.github.io/encantar-js/)** | :heart: **[Sponsor](https://github.com/sponsors/alemart)**

![Demo](docs/img/mage.gif)

## Features

* **AR everywhere**: encantar.js runs on Android, on iOS, and even on Desktop computers! Only a modern web browser is required.
* **Plugins**: use encantar.js with the 3D framework of your choice, including A-Frame, Babylon.js, Three.js and more!
* **Image tracking**: track detailed images such as book covers, cartoons and photos. No need of manual training!
* **Pointer tracking**: create interactive experiences based on touch, mouse and pen input with an easy-to-use API.

## Why use encantar.js?

* **Device-agnostic**: no need of AR-capable devices. encantar.js runs in all modern web browsers. It's AR built from scratch with computer vision.
* **Fast and powerful**: encantar.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
* **No need to download apps**: encantar.js is a WebAR engine. Users can access the AR experiences immediately.
* **Easy to get started**: encantar.js can be used with a `<script>` tag in your page. A static HTML page is enough to get started.
* **Open-source**: what are you waiting for? [Try it now!](https://alemart.github.io/encantar-js/demos/)

## Browser compatibility

encantar.js is compatible with all major web browsers:

| Chrome | Edge | Firefox | Opera | Safari* |
| ------ | ---- | ------- | ----- | ------- |
| ✔      | ✔    | ✔       | ✔     | ✔       |

\* use Safari 15.2 or later.

encantar.js requires WebGL2 and WebAssembly, which are widely supported.

## About

encantar.js is developed by [Alexandre Martins](https://github.com/alemart) and released under the [LGPL](LICENSE.md). It is based on [Speedy Vision](https://github.com/alemart/speedy-vision).
