|
|
@@ -1,40 +1,34 @@
|
|
1
|
|
-# encantar.js WebAR engine
|
|
|
1
|
+# encantar.js Web AR engine :magic_wand:
|
|
2
|
2
|
|
|
3
|
|
-The Augmented Reality engine that will enchant you!
|
|
|
3
|
+encantar.js is a GPU-accelerated Augmented Reality framework for the web.
|
|
4
|
4
|
|
|
5
|
|
-:heart: encantar.js is an Augmented Reality technology which I develop independently. Support this work by [purchasing your copy](https://encantar.dev/download). You can also [become a sponsor](https://github.com/sponsors/alemart).
|
|
|
5
|
+* It's **compatible with all platforms**: iOS, Android, Desktops...
|
|
|
6
|
+* It can run in devices without native support for AR / WebXR
|
|
|
7
|
+* It's **blazing fast**, built with GPU acceleration at its core
|
|
|
8
|
+* It's **easy to use** for developers and artists alike
|
|
|
9
|
+* **All you need is a modern web browser** - no app required!
|
|
6
|
10
|
|
|
7
|
|
-:star2: **[Try it!](https://encantar.dev/demos/hello-aframe/poster.html)** | :video_game: **[Play a game!](https://encantar.dev/demos/basketball/poster.html)** | :magic_wand: **[Demos](https://encantar.dev/demos/)** | :heart_eyes: **[Add-Ons](https://encantar.dev/addons/)** | :books: **[Learn](https://encantar.dev/tutorial/)**
|
|
|
11
|
+Get started at <https://encantar.dev> :magic_wand:
|
|
8
|
12
|
|
|
9
|
|
-<a href="https://encantar.dev/demos/hello-aframe/poster.html"><img src="docs/img/mage.gif" alt="Demo" height="144"></a> <a href="https://encantar.dev/demos/basketball/poster.html"><img src="docs/img/basketball.gif" alt="Game" height="144"></a> <a href="https://encantar.dev/addons/"><img src="docs/img/video-player.gif" alt="Video Player" height="144"></a>
|
|
|
13
|
+## Demos
|
|
10
|
14
|
|
|
11
|
|
-## Features
|
|
|
15
|
+<a href="https://alemart.github.io/encantar-js/demos/hello-aframe/poster.html" target="_blank"><img src="docs/img/mage.gif" alt="Demo" height="144"></a> <a href="https://alemart.github.io/encantar-js/demos/basketball/poster.html" target="_blank"><img src="docs/img/basketball.gif" alt="Game" height="144"></a> <a href="https://alemart.github.io/encantar-js/addons/" target="_blank"><img src="docs/img/video-player.gif" alt="Video Player" height="144"></a>
|
|
12
|
16
|
|
|
13
|
|
-* **Image tracking**: track detailed images such as book covers, cartoons and photos. No need of manual training!
|
|
14
|
|
-* **Pointer tracking**: create interactive experiences based on touch and mouse input with an easy-to-use API.
|
|
15
|
|
-* **Plugins**: use encantar.js with the 3D framework of your choice, including: A-Frame, Babylon.js, Three.js and more!
|
|
16
|
|
-* **Add-Ons**: create rich experiences with additional features that enhance the core of encantar.js!
|
|
17
|
|
-
|
|
18
|
|
-## Key points
|
|
|
17
|
+[More at the website...](https://encantar.dev/demos)
|
|
19
|
18
|
|
|
20
|
|
-* **AR everywhere**: it runs on Android, on iOS, and even on Desktop computers! Only a modern web browser is required.
|
|
21
|
|
-* **Easy to use**: just load a static HTML page! No need of heavy app downloads, server-side components or subscriptions.
|
|
22
|
|
-* **Device-agnostic**: no need of AR-capable devices! encantar.js is AR built from scratch with computer vision!
|
|
23
|
|
-* **Fast & powerful**: encantar.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
|
|
24
|
|
-* **Open source**: personal, professional and educational uses are allowed.
|
|
|
19
|
+## Core features
|
|
25
|
20
|
|
|
26
|
|
-## Browser compatibility
|
|
27
|
|
-
|
|
28
|
|
-encantar.js is compatible with all major web browsers:
|
|
|
21
|
+* **Image tracking**: track detailed images such as cartoons or photos. Give it [reference images](https://encantar.dev/guidelines-for-images) and it just works!
|
|
|
22
|
+* **Pointer tracking**: create interactive experiences based on touch and mouse input with an easy-to-use API.
|
|
|
23
|
+* **Plugins**: use encantar.js with the 3D engine of your choice: A-Frame, Babylon.js, Three.js, or any other!
|
|
29
|
24
|
|
|
30
|
|
-| Chrome | Edge | Firefox | Opera | Safari* |
|
|
31
|
|
-| ------ | ---- | ------- | ----- | ------- |
|
|
32
|
|
-| ✔ | ✔ | ✔ | ✔ | ✔ |
|
|
|
25
|
+## Add-Ons
|
|
33
|
26
|
|
|
34
|
|
-\* use Safari 15.2 or later.
|
|
|
27
|
+Additional features [available for supporters](https://encantar.dev/addons):
|
|
35
|
28
|
|
|
36
|
|
-encantar.js requires WebGL2 and WebAssembly, which are widely supported.
|
|
|
29
|
+* **Video Player**: easy-to-use video player with controls - suitable for AR books, AR business cards, interactive art, etc. [Read more...](https://encantar.dev/addons/ar-video-player)
|
|
|
30
|
+* **Buttons & Clickables**: easily detect and trigger reactions when buttons or 3D objects are tapped in AR. [Read more...](https://encantar.dev/addons/ar-button)
|
|
37
|
31
|
|
|
38
|
32
|
## About
|
|
39
|
33
|
|
|
40
|
|
-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).
|
|
|
34
|
+encantar.js is developed by [Alexandre Martins](https://github.com/alemart) and released under the [GNU LGPL v3](LICENSE.md). It's based on [speedy-vision](https://github.com/alemart/speedy-vision).
|
alemart
3 月之前