Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

alemart/encantar-js

Open more actions menu

Repository files navigation

encantar.js: GPU-accelerated Augmented Reality library for the web

Enchant your users with high performance Augmented Reality experiences compatible with any modern web browser. Users don't need to download apps, and WebXR support isn't required.

🧙‍♂️ Get started at https://encantar.dev

Table of contents

Features

  • Broad compatibility - Create WebAR experiences for all platforms: iOS, Android, Desktops. WebXR support isn't required thanks to encantar's custom trackers based on Computer Vision.
  • High performance - Deliver blazing fast AR experiences to a wide user base through encantar's GPU-accelerated trackers and WebAssembly-powered computational wizardry.
  • Modularity - Use encantar.js with the 3D engine of your choice: A-Frame, babylon.js, three.js, or any other!
  • Image tracking - Track custom images such as cartoons or photos with no need of custom setup. This is known as Natural Feature Tracking.
  • Pointer tracking - Create interactive experiences based on touch and mouse input with an easy-to-use API.
  • Add-Ons - Enchant your users with additional features that enhance the core of encantar.js!

Demos

Pick any demo below, or browse the website for more!

Demo Game Video Player

Download

There are two editions: free and commercial. They are functionally equivalent, but have significant differences in usage rights.

Free Edition

Download the Free Edition for creating and distributing free and open-source projects, or for developing internal prototypes of non-free/proprietary projects (no distribution rights under the GPL).

Commercial Edition

Purchase the Commercial Edition before distributing your non-free/proprietary projects to others (browser delivery counts as distribution). Use it in production.

Add-Ons

Get extras for rich AR experiences!

Quick Start

Get started with the Free Edition:

  1. Download and extract encantar-free-VERSION.zip
  2. Download and run Servez, a simple local web server
  3. In Folder to Serve, specify the folder named encantar-free-VERSION extracted in step 1
  4. Change the Port to 8000
  5. Click on Start to launch the local web server

Next, open http://localhost:8000/demos/hello-aframe/video.html. Also try the different demos on a mobile phone. Enjoy! 🪄

When testing WebAR with a webcam, it's recommended to launch the web server using HTTPS.

Tip

Try online

You can also try the demos online!

Do you prefer the Command Line?

npx http-server -p 8000 /path/to/encantar-free-VERSION/

The latest version of the library is GitHub Release

Documentation

Support

👨‍💻 Contact me for library-specific questions or support services.

About

encantar.js is developed by Alexandre Martins and released under version 3 of the GNU GPL, with optional terms enabling usage in proprietary software. It's based on speedy-vision, a Computer Vision library for JavaScript created by the same author.

Developing an Augmented Reality engine from scratch with Computer Vision is a massive undertaking, yet it happened! 😀

About

GPU-accelerated Augmented Reality framework for creating WebAR experiences.

Topics

Resources

Contributing

Stars

Watchers

Forks

Releases

Sponsor this project

Used by

Contributors

Languages

Morty Proxy This is a proxified and sanitized view of the page, visit original site.