alemart 10 месяцев назад
Родитель
Сommit
396a27662a
69 измененных файлов: 191 добавлений и 203 удалений
  1. 16
    12
      README.md
  2. 1
    1
      demos/hello-aframe/NOTICE.html
  3. 3
    3
      demos/hello-aframe/README.html
  4. 1
    1
      demos/hello-aframe/index.html
  5. 1
    1
      demos/hello-aframe/video.html
  6. 1
    1
      demos/hello-babylon/NOTICE.html
  7. 3
    3
      demos/hello-babylon/README.html
  8. 1
    1
      demos/hello-babylon/index.html
  9. 1
    1
      demos/hello-babylon/video.html
  10. 1
    1
      demos/hello-three/NOTICE.html
  11. 3
    3
      demos/hello-three/README.html
  12. 1
    1
      demos/hello-three/index.html
  13. 1
    1
      demos/hello-three/video.html
  14. 1
    1
      demos/hello-webgl/NOTICE.html
  15. 3
    3
      demos/hello-webgl/README.html
  16. 1
    1
      demos/hello-webgl/index.html
  17. 1
    1
      demos/hello-webgl/video.html
  18. 1
    1
      demos/hello-world/NOTICE.html
  19. 3
    3
      demos/hello-world/README.html
  20. 1
    1
      demos/hello-world/index.html
  21. 1
    1
      demos/hello-world/video.html
  22. 2
    2
      docs/api/ar.md
  23. 1
    1
      docs/api/speedy-matrix.md
  24. 2
    2
      docs/api/speedy.md
  25. 4
    2
      docs/demos.md
  26. 4
    8
      docs/faq.md
  27. 4
    4
      docs/getting-started/activate-your-webcam.md
  28. 3
    3
      docs/getting-started/concepts.md
  29. 3
    3
      docs/getting-started/create-the-augmented-scene.md
  30. 15
    13
      docs/getting-started/index.md
  31. 9
    0
      docs/getting-started/introduction.md
  32. 2
    2
      docs/getting-started/next-steps.md
  33. 2
    2
      docs/getting-started/set-up-a-web-server.md
  34. 1
    1
      docs/getting-started/set-up-the-session.md
  35. 5
    5
      docs/getting-started/set-up-the-tracker.md
  36. Двоичные данные
      docs/img/cat.gif
  37. Двоичные данные
      docs/img/demo-aframe.gif
  38. Двоичные данные
      docs/img/demo-cool.mp4
  39. Двоичные данные
      docs/img/demo-cool.webm
  40. Двоичные данные
      docs/img/demo-cool.webp
  41. Двоичные данные
      docs/img/demo-cool2.mp4
  42. Двоичные данные
      docs/img/demo-cool2.webm
  43. Двоичные данные
      docs/img/demo-cool2.webp
  44. Двоичные данные
      docs/img/demo-cool3.gif
  45. Двоичные данные
      docs/img/demo-cool3.mp4
  46. Двоичные данные
      docs/img/demo-cool3.webm
  47. Двоичные данные
      docs/img/demo-cool3.webp
  48. Двоичные данные
      docs/img/demo-interactivity-three.jpg
  49. Двоичные данные
      docs/img/demo-touchthree.gif
  50. Двоичные данные
      docs/img/demo-webgl.jpg
  51. Двоичные данные
      docs/img/mage.gif
  52. Двоичные данные
      docs/img/qr-demo-hello-aframe.gif
  53. Двоичные данные
      docs/img/qr-demo-hello-three.gif
  54. Двоичные данные
      docs/img/qr-demo-hello-webgl.gif
  55. Двоичные данные
      docs/img/qr-demo-hello-world.gif
  56. Двоичные данные
      docs/img/qr-demo-simple-webcam.gif
  57. Двоичные данные
      docs/img/qr-demo-touch-interaction.gif
  58. Двоичные данные
      docs/img/splash.gif
  59. Двоичные данные
      docs/img/splash.mp4
  60. Двоичные данные
      docs/img/splash.webm
  61. Двоичные данные
      docs/img/splash.webp
  62. 1
    1
      docs_overrides/demo.html
  63. 1
    1
      docs_overrides/download.html
  64. 23
    6
      docs_overrides/index.html
  65. 55
    1
      docs_overrides/js/extra.js
  66. 4
    100
      docs_overrides/style/extra.css
  67. 1
    1
      docs_overrides/support-my-work.html
  68. 2
    2
      mkdocs.yml
  69. 1
    1
      src/main.ts

+ 16
- 12
README.md Просмотреть файл

@@ -1,26 +1,30 @@
1
-# encantAR.js WebAR engine
1
+# encantar.js WebAR engine
2 2
 
3 3
 [![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/)
4 4
 
5
-Enchant your users with **encantAR.js**, a GPU-accelerated Augmented Reality engine for the web.
5
+Enchant your users with **encantar.js**, a GPU-accelerated Augmented Reality engine for the web.
6 6
 
7 7
 :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)**
8 8
 
9
+![Demo](docs/img/mage.gif)
10
+
9 11
 ## Features
10 12
 
11
-* **Runs everywhere**: on Android, on iOS, and even on Desktop computers!
12
-* **Image tracking**: track detailed images such as book covers, cartoons and photos.
13
+* **AR everywhere**: encantar.js runs on Android, on iOS, and even on Desktop computers! Only a modern web browser is required.
14
+* **Plugins**: use encantar.js with the 3D framework of your choice, including A-Frame, Babylon.js, Three.js and more!
15
+* **Image tracking**: track detailed images such as book covers, cartoons and photos. No need of manual training!
13 16
 
14
-## Why use encantAR.js?
17
+## Why use encantar.js?
15 18
 
16
-* **Wide compatibility:** encantAR.js runs in all modern web browsers. It's built from scratch using standard web technologies. No need of AR-capable devices.
17
-* **Fast and powerful:** encantAR.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
18
-* **No need to download apps:** encantAR.js is a WebAR engine. Users can access the AR experiences immediately.
19
-* **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.
19
+* **Device-agnostic**: no need of AR-capable devices. encantar.js runs in all modern web browsers. It's AR built from scratch.
20
+* **Fast and powerful**: encantar.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
21
+* **No need to download apps**: encantar.js is a WebAR engine. Users can access the AR experiences immediately.
22
+* **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.
23
+* **Open-source**: what are you waiting for? [Try it now!](https://alemart.github.io/encantar-js/demos/)
20 24
 
21 25
 ## Browser compatibility
22 26
 
23
-encantAR.js is compatible with all major web browsers:
27
+encantar.js is compatible with all major web browsers:
24 28
 
25 29
 | Chrome | Edge | Firefox | Opera | Safari* |
26 30
 | ------ | ---- | ------- | ----- | ------- |
@@ -28,8 +32,8 @@ encantAR.js is compatible with all major web browsers:
28 32
 
29 33
 \* use Safari 15.2 or later.
30 34
 
31
-encantAR.js requires WebGL2 and WebAssembly.
35
+encantar.js requires WebGL2 and WebAssembly, which are widely supported.
32 36
 
33 37
 ## About
34 38
 
35
-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).
39
+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).

+ 1
- 1
demos/hello-aframe/NOTICE.html Просмотреть файл

@@ -17,7 +17,7 @@
17 17
         <p>This application contains free and open-source software and this page sets forth the corresponding attribution notices.</p>
18 18
         <ol>
19 19
             <li>
20
-                encantAR.js: GPU-accelerated Augmented Reality for the web<br>
20
+                encantar.js: GPU-accelerated Augmented Reality for the web<br>
21 21
                 Copyright &copy; 2022-present Alexandre Martins<br>
22 22
                 License: <a href="#lgpl">GNU Lesser General Public License, version 3</a><br>
23 23
                 <a href="https://github.com/alemart/encantar-js" target="_blank" rel="external">https://github.com/alemart/encantar-js</a>

+ 3
- 3
demos/hello-aframe/README.html Просмотреть файл

@@ -2,7 +2,7 @@
2 2
 <html>
3 3
     <head>
4 4
         <meta charset="utf-8">
5
-        <title>encantAR.js WebAR demo with A-Frame</title>
5
+        <title>encantar.js WebAR demo with A-Frame</title>
6 6
         <script data-goatcounter="https://encantar-js.goatcounter.com/count" async src="//gc.zgo.at/count.js"></script>
7 7
         <style>
8 8
         body {
@@ -48,7 +48,7 @@
48 48
         </style>
49 49
     </head>
50 50
     <body>
51
-        <h1>encantAR.js with A-Frame</h1>
51
+        <h1>encantar.js with A-Frame</h1>
52 52
         <p>Scan the QR code to launch the web-based Augmented Reality experience. Next, scan <a href="../assets/mage.webp" target="_blank">this cartoon</a> or <a href="../assets/cat.webp" target="_blank">this picture</a>.</p>
53 53
 
54 54
         <h2>Menu</h2>
@@ -64,7 +64,7 @@
64 64
         <img src="qr-code.gif" alt="QR code" class="qr-code">
65 65
 
66 66
         <h2>Share</h2>
67
-        <p>This experience is powered by <a href="https://alemart.github.io/encantar-js" target="_blank">encantAR.js: GPU-accelerated Augmented Reality for the web</a>.</p>
67
+        <p>This experience is powered by <a href="https://alemart.github.io/encantar-js" target="_blank">encantar.js: GPU-accelerated Augmented Reality for the web</a>.</p>
68 68
         <div>
69 69
             <a href="https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Falemart.github.io/encantar-js&quote=%23encantar-js" target="_blank" rel="external" class="button"><img src="../assets/facebook.png" alt="Share on Facebook"></a>
70 70
             <a href="https://twitter.com/intent/tweet?url=https%3A%2F%2Falemart.github.io/encantar-js&hashtags=encantar-js" target="_blank" rel="external" class="button"><img src="../assets/twitter.png" alt="Share on X"></a>

+ 1
- 1
demos/hello-aframe/index.html Просмотреть файл

@@ -3,7 +3,7 @@
3 3
     <head>
4 4
         <meta charset="utf-8">
5 5
         <meta name="viewport" content="width=device-width,initial-scale=1">
6
-        <title>encantAR.js WebAR demo with A-Frame</title>
6
+        <title>encantar.js WebAR demo with A-Frame</title>
7 7
         <link href="demo.css" rel="stylesheet">
8 8
         <script src="../../dist/encantar.min.js"></script>
9 9
         <script src="https://cdn.jsdelivr.net/npm/aframe@1.4.2/dist/aframe-v1.4.2.min.js"></script>

+ 1
- 1
demos/hello-aframe/video.html Просмотреть файл

@@ -3,7 +3,7 @@
3 3
     <head>
4 4
         <meta charset="utf-8">
5 5
         <meta name="viewport" content="width=device-width,initial-scale=1">
6
-        <title>encantAR.js WebAR demo with A-Frame</title>
6
+        <title>encantar.js WebAR demo with A-Frame</title>
7 7
         <link href="demo.css" rel="stylesheet">
8 8
         <script src="../../dist/encantar.min.js"></script>
9 9
         <script src="https://cdn.jsdelivr.net/npm/aframe@1.4.2/dist/aframe-v1.4.2.min.js"></script>

+ 1
- 1
demos/hello-babylon/NOTICE.html Просмотреть файл

@@ -17,7 +17,7 @@
17 17
         <p>This application contains free and open-source software and this page sets forth the corresponding attribution notices.</p>
18 18
         <ol>
19 19
             <li>
20
-                encantAR.js: GPU-accelerated Augmented Reality for the web<br>
20
+                encantar.js: GPU-accelerated Augmented Reality for the web<br>
21 21
                 Copyright &copy; 2022-present Alexandre Martins<br>
22 22
                 License: <a href="#lgpl">GNU Lesser General Public License, version 3</a><br>
23 23
                 <a href="https://github.com/alemart/encantar-js" target="_blank" rel="external">https://github.com/alemart/encantar-js</a>

+ 3
- 3
demos/hello-babylon/README.html Просмотреть файл

@@ -2,7 +2,7 @@
2 2
 <html>
3 3
     <head>
4 4
         <meta charset="utf-8">
5
-        <title>encantAR.js WebAR demo with babylon.js</title>
5
+        <title>encantar.js WebAR demo with babylon.js</title>
6 6
         <script data-goatcounter="https://encantar-js.goatcounter.com/count" async src="//gc.zgo.at/count.js"></script>
7 7
         <style>
8 8
         body {
@@ -48,7 +48,7 @@
48 48
         </style>
49 49
     </head>
50 50
     <body>
51
-        <h1>encantAR.js with babylon.js</h1>
51
+        <h1>encantar.js with babylon.js</h1>
52 52
         <p>Scan the QR code to launch the web-based Augmented Reality experience. Next, scan <a href="../assets/mage.webp" target="_blank">this cartoon</a> or <a href="../assets/cat.webp" target="_blank">this picture</a>.</p>
53 53
 
54 54
         <h2>Menu</h2>
@@ -64,7 +64,7 @@
64 64
         <img src="qr-code.gif" alt="QR code" class="qr-code">
65 65
 
66 66
         <h2>Share</h2>
67
-        <p>This experience is powered by <a href="https://alemart.github.io/encantar-js" target="_blank">encantAR.js: GPU-accelerated Augmented Reality for the web</a>.</p>
67
+        <p>This experience is powered by <a href="https://alemart.github.io/encantar-js" target="_blank">encantar.js: GPU-accelerated Augmented Reality for the web</a>.</p>
68 68
         <div>
69 69
             <a href="https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Falemart.github.io/encantar-js&quote=%23encantar-js" target="_blank" rel="external" class="button"><img src="../assets/facebook.png" alt="Share on Facebook"></a>
70 70
             <a href="https://twitter.com/intent/tweet?url=https%3A%2F%2Falemart.github.io/encantar-js&hashtags=encantar-js" target="_blank" rel="external" class="button"><img src="../assets/twitter.png" alt="Share on X"></a>

+ 1
- 1
demos/hello-babylon/index.html Просмотреть файл

@@ -3,7 +3,7 @@
3 3
     <head>
4 4
         <meta charset="utf-8">
5 5
         <meta name="viewport" content="width=device-width,initial-scale=1">
6
-        <title>encantAR.js WebAR demo with babylon.js</title>
6
+        <title>encantar.js WebAR demo with babylon.js</title>
7 7
         <link href="demo.css" rel="stylesheet">
8 8
         <script src="../../dist/encantar.min.js"></script>
9 9
         <script src="https://cdn.jsdelivr.net/npm/babylonjs@7.29.0/babylon.min.js"></script>

+ 1
- 1
demos/hello-babylon/video.html Просмотреть файл

@@ -3,7 +3,7 @@
3 3
     <head>
4 4
         <meta charset="utf-8">
5 5
         <meta name="viewport" content="width=device-width,initial-scale=1">
6
-        <title>encantAR.js WebAR demo with babylon.js</title>
6
+        <title>encantar.js WebAR demo with babylon.js</title>
7 7
         <link href="demo.css" rel="stylesheet">
8 8
         <script src="../../dist/encantar.min.js"></script>
9 9
         <script src="https://cdn.jsdelivr.net/npm/babylonjs@7.29.0/babylon.min.js"></script>

+ 1
- 1
demos/hello-three/NOTICE.html Просмотреть файл

@@ -17,7 +17,7 @@
17 17
         <p>This application contains free and open-source software and this page sets forth the corresponding attribution notices.</p>
18 18
         <ol>
19 19
             <li>
20
-                encantAR.js: GPU-accelerated Augmented Reality for the web<br>
20
+                encantar.js: GPU-accelerated Augmented Reality for the web<br>
21 21
                 Copyright &copy; 2022-present Alexandre Martins<br>
22 22
                 License: <a href="#lgpl">GNU Lesser General Public License, version 3</a><br>
23 23
                 <a href="https://github.com/alemart/encantar-js" target="_blank" rel="external">https://github.com/alemart/encantar-js</a>

+ 3
- 3
demos/hello-three/README.html Просмотреть файл

@@ -2,7 +2,7 @@
2 2
 <html>
3 3
     <head>
4 4
         <meta charset="utf-8">
5
-        <title>encantAR.js WebAR demo with three.js</title>
5
+        <title>encantar.js WebAR demo with three.js</title>
6 6
         <script data-goatcounter="https://encantar-js.goatcounter.com/count" async src="//gc.zgo.at/count.js"></script>
7 7
         <style>
8 8
         body {
@@ -48,7 +48,7 @@
48 48
         </style>
49 49
     </head>
50 50
     <body>
51
-        <h1>encantAR.js with three.js</h1>
51
+        <h1>encantar.js with three.js</h1>
52 52
         <p>Scan the QR code to launch the web-based Augmented Reality experience. Next, scan <a href="../assets/mage.webp" target="_blank">this cartoon</a> or <a href="../assets/cat.webp" target="_blank">this picture</a>.</p>
53 53
 
54 54
         <h2>Menu</h2>
@@ -64,7 +64,7 @@
64 64
         <img src="qr-code.gif" alt="QR code" class="qr-code">
65 65
 
66 66
         <h2>Share</h2>
67
-        <p>This experience is powered by <a href="https://alemart.github.io/encantar-js" target="_blank">encantAR.js: GPU-accelerated Augmented Reality for the web</a>.</p>
67
+        <p>This experience is powered by <a href="https://alemart.github.io/encantar-js" target="_blank">encantar.js: GPU-accelerated Augmented Reality for the web</a>.</p>
68 68
         <div>
69 69
             <a href="https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Falemart.github.io/encantar-js&quote=%23encantar-js" target="_blank" rel="external" class="button"><img src="../assets/facebook.png" alt="Share on Facebook"></a>
70 70
             <a href="https://twitter.com/intent/tweet?url=https%3A%2F%2Falemart.github.io/encantar-js&hashtags=encantar-js" target="_blank" rel="external" class="button"><img src="../assets/twitter.png" alt="Share on X"></a>

+ 1
- 1
demos/hello-three/index.html Просмотреть файл

@@ -3,7 +3,7 @@
3 3
     <head>
4 4
         <meta charset="utf-8">
5 5
         <meta name="viewport" content="width=device-width,initial-scale=1">
6
-        <title>encantAR.js WebAR demo with three.js</title>
6
+        <title>encantar.js WebAR demo with three.js</title>
7 7
         <link href="demo.css" rel="stylesheet">
8 8
         <script src="../../dist/encantar.min.js"></script>
9 9
         <script src="https://cdn.jsdelivr.net/npm/three@0.147.0/build/three.min.js"></script>

+ 1
- 1
demos/hello-three/video.html Просмотреть файл

@@ -3,7 +3,7 @@
3 3
     <head>
4 4
         <meta charset="utf-8">
5 5
         <meta name="viewport" content="width=device-width,initial-scale=1">
6
-        <title>encantAR.js WebAR demo with three.js</title>
6
+        <title>encantar.js WebAR demo with three.js</title>
7 7
         <link href="demo.css" rel="stylesheet">
8 8
         <script src="../../dist/encantar.min.js"></script>
9 9
         <script src="https://cdn.jsdelivr.net/npm/three@0.147.0/build/three.min.js"></script>

+ 1
- 1
demos/hello-webgl/NOTICE.html Просмотреть файл

@@ -17,7 +17,7 @@
17 17
         <p>This application contains free and open-source software and this page sets forth the corresponding attribution notices.</p>
18 18
         <ol>
19 19
             <li>
20
-                encantAR.js: GPU-accelerated Augmented Reality for the web<br>
20
+                encantar.js: GPU-accelerated Augmented Reality for the web<br>
21 21
                 Copyright &copy; 2022-present Alexandre Martins<br>
22 22
                 License: <a href="#lgpl">GNU Lesser General Public License, version 3</a><br>
23 23
                 <a href="https://github.com/alemart/encantar-js" target="_blank" rel="external">https://github.com/alemart/encantar-js</a>

+ 3
- 3
demos/hello-webgl/README.html Просмотреть файл

@@ -2,7 +2,7 @@
2 2
 <html>
3 3
     <head>
4 4
         <meta charset="utf-8">
5
-        <title>encantAR.js WebAR demo with WebGL</title>
5
+        <title>encantar.js WebAR demo with WebGL</title>
6 6
         <script data-goatcounter="https://encantar-js.goatcounter.com/count" async src="//gc.zgo.at/count.js"></script>
7 7
         <style>
8 8
         body {
@@ -48,7 +48,7 @@
48 48
         </style>
49 49
     </head>
50 50
     <body>
51
-        <h1>encantAR.js with WebGL</h1>
51
+        <h1>encantar.js with WebGL</h1>
52 52
         <p>Scan the QR code to launch the web-based Augmented Reality experience. Next, scan <a href="../assets/my-reference-image.webp" target="_blank">this cartoon</a>.</p>
53 53
 
54 54
         <h2>Menu</h2>
@@ -64,7 +64,7 @@
64 64
         <img src="qr-code.gif" alt="QR code" class="qr-code">
65 65
 
66 66
         <h2>Share</h2>
67
-        <p>This experience is powered by <a href="https://alemart.github.io/encantar-js" target="_blank">encantAR.js: GPU-accelerated Augmented Reality for the web</a>.</p>
67
+        <p>This experience is powered by <a href="https://alemart.github.io/encantar-js" target="_blank">encantar.js: GPU-accelerated Augmented Reality for the web</a>.</p>
68 68
         <div>
69 69
             <a href="https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Falemart.github.io/encantar-js&quote=%23encantar-js" target="_blank" rel="external" class="button"><img src="../assets/facebook.png" alt="Share on Facebook"></a>
70 70
             <a href="https://twitter.com/intent/tweet?url=https%3A%2F%2Falemart.github.io/encantar-js&hashtags=encantar-js" target="_blank" rel="external" class="button"><img src="../assets/twitter.png" alt="Share on X"></a>

+ 1
- 1
demos/hello-webgl/index.html Просмотреть файл

@@ -3,7 +3,7 @@
3 3
     <head>
4 4
         <meta charset="utf-8">
5 5
         <meta name="viewport" content="width=device-width,initial-scale=1">
6
-        <title>encantAR.js WebAR demo with WebGL</title>
6
+        <title>encantar.js WebAR demo with WebGL</title>
7 7
         <link href="demo.css" rel="stylesheet">
8 8
         <script src="../../dist/encantar.min.js"></script>
9 9
         <script src="demo.js"></script>

+ 1
- 1
demos/hello-webgl/video.html Просмотреть файл

@@ -3,7 +3,7 @@
3 3
     <head>
4 4
         <meta charset="utf-8">
5 5
         <meta name="viewport" content="width=device-width,initial-scale=1">
6
-        <title>encantAR.js WebAR demo with WebGL</title>
6
+        <title>encantar.js WebAR demo with WebGL</title>
7 7
         <link href="demo.css" rel="stylesheet">
8 8
         <script src="../../dist/encantar.min.js"></script>
9 9
         <script src="demo.js"></script>

+ 1
- 1
demos/hello-world/NOTICE.html Просмотреть файл

@@ -17,7 +17,7 @@
17 17
         <p>This application contains free and open-source software and this page sets forth the corresponding attribution notices.</p>
18 18
         <ol>
19 19
             <li>
20
-                encantAR.js: GPU-accelerated Augmented Reality for the web<br>
20
+                encantar.js: GPU-accelerated Augmented Reality for the web<br>
21 21
                 Copyright &copy; 2022-present Alexandre Martins<br>
22 22
                 License: <a href="#lgpl">GNU Lesser General Public License, version 3</a><br>
23 23
                 <a href="https://github.com/alemart/encantar-js" target="_blank" rel="external">https://github.com/alemart/encantar-js</a>

+ 3
- 3
demos/hello-world/README.html Просмотреть файл

@@ -2,7 +2,7 @@
2 2
 <html>
3 3
     <head>
4 4
         <meta charset="utf-8">
5
-        <title>encantAR.js WebAR template</title>
5
+        <title>encantar.js WebAR template</title>
6 6
         <script data-goatcounter="https://encantar-js.goatcounter.com/count" async src="//gc.zgo.at/count.js"></script>
7 7
         <style>
8 8
         body {
@@ -48,7 +48,7 @@
48 48
         </style>
49 49
     </head>
50 50
     <body>
51
-        <h1>encantAR.js WebAR template</h1>
51
+        <h1>encantar.js WebAR template</h1>
52 52
         <p>Scan the QR code to launch the web-based Augmented Reality experience. Next, scan <a href="../assets/mage.webp" target="_blank">this cartoon</a> or <a href="../assets/cat.webp" target="_blank">this picture</a>.</p>
53 53
 
54 54
         <h2>Menu</h2>
@@ -64,7 +64,7 @@
64 64
         <img src="qr-code.gif" alt="QR code" class="qr-code">
65 65
 
66 66
         <h2>Share</h2>
67
-        <p>This experience is powered by <a href="https://alemart.github.io/encantar-js" target="_blank">encantAR.js: GPU-accelerated Augmented Reality for the web</a>.</p>
67
+        <p>This experience is powered by <a href="https://alemart.github.io/encantar-js" target="_blank">encantar.js: GPU-accelerated Augmented Reality for the web</a>.</p>
68 68
         <div>
69 69
             <a href="https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Falemart.github.io/encantar-js&quote=%23encantar-js" target="_blank" rel="external" class="button"><img src="../assets/facebook.png" alt="Share on Facebook"></a>
70 70
             <a href="https://twitter.com/intent/tweet?url=https%3A%2F%2Falemart.github.io/encantar-js&hashtags=encantar-js" target="_blank" rel="external" class="button"><img src="../assets/twitter.png" alt="Share on X"></a>

+ 1
- 1
demos/hello-world/index.html Просмотреть файл

@@ -3,7 +3,7 @@
3 3
     <head>
4 4
         <meta charset="utf-8">
5 5
         <meta name="viewport" content="width=device-width,initial-scale=1">
6
-        <title>encantAR.js WebAR template</title>
6
+        <title>encantar.js WebAR template</title>
7 7
         <link href="demo.css" rel="stylesheet">
8 8
         <script src="../../dist/encantar.min.js"></script>
9 9
         <script src="demo.js"></script>

+ 1
- 1
demos/hello-world/video.html Просмотреть файл

@@ -3,7 +3,7 @@
3 3
     <head>
4 4
         <meta charset="utf-8">
5 5
         <meta name="viewport" content="width=device-width,initial-scale=1">
6
-        <title>encantAR.js WebAR template</title>
6
+        <title>encantar.js WebAR template</title>
7 7
         <link href="demo.css" rel="stylesheet">
8 8
         <script src="../../dist/encantar.min.js"></script>
9 9
         <script src="demo.js"></script>

+ 2
- 2
docs/api/ar.md Просмотреть файл

@@ -1,6 +1,6 @@
1 1
 # AR
2 2
 
3
-The `AR` namespace is the entry point of the features and components of encantAR.js.
3
+The `AR` namespace is the entry point of the features and components of encantar.js.
4 4
 
5 5
 ## Properties
6 6
 
@@ -14,7 +14,7 @@ The [settings](settings.md) of the engine.
14 14
 
15 15
 `AR.version: string, read-only`
16 16
 
17
-The version of encantAR.js.
17
+The version of encantar.js.
18 18
 
19 19
 ## Methods
20 20
 

+ 1
- 1
docs/api/speedy-matrix.md Просмотреть файл

@@ -1,6 +1,6 @@
1 1
 # SpeedyMatrix
2 2
 
3
-[Speedy](speedy.md) includes its own fast implementation of matrices. They are used extensively in encantAR.js.
3
+[Speedy](speedy.md) includes its own fast implementation of matrices. They are used extensively in encantar.js.
4 4
 
5 5
 ## Properties
6 6
 

+ 2
- 2
docs/api/speedy.md Просмотреть файл

@@ -1,8 +1,8 @@
1 1
 # Speedy
2 2
 
3
-encantAR.js is built using [Speedy Vision](https://github.com/alemart/speedy-vision){ ._blank }, a GPU-accelerated Computer Vision library which is another project of mine.
3
+encantar.js is built using [Speedy Vision](https://github.com/alemart/speedy-vision){ ._blank }, a GPU-accelerated Computer Vision library which is another project of mine.
4 4
 
5
-Many features provided by Speedy Vision are very useful (e.g., matrices). I have decided to include some of them in parts of the encantAR.js API for convenience.
5
+Many features provided by Speedy Vision are very useful (e.g., matrices). I have decided to include some of them in parts of the encantar.js API for convenience.
6 6
 
7 7
 In this documentation, I provide a quick reference of some of the classes used in Speedy Vision. This reference is minimal. For a more complete reference, please visit the [website of the project](https://github.com/alemart/speedy-vision){ ._blank }.
8 8
 

+ 4
- 2
docs/demos.md Просмотреть файл

@@ -21,7 +21,7 @@ title: WebAR Demo gallery
21 21
 
22 22
 ### WebAR with A-Frame
23 23
 
24
-Create an augmented scene with [A-Frame](https://aframe.io){ ._blank }. No knowledge of JavaScript is required!
24
+Create an augmented scene with [A-Frame](https://aframe.io){ ._blank }. For beginners - no knowledge of JavaScript is required!
25 25
 
26 26
 [Launch demo](/encantar-js/demos/hello-aframe/README.html){ ._blank .md-button }
27 27
 
@@ -54,7 +54,9 @@ Create an augmented scene without a 3D framework.
54 54
 * Run on a console:
55 55
 
56 56
 ```sh
57
-git clone git@github.com:alemart/encantar-js.git
57
+repo=https://github.com/alemart/encantar-js.git
58
+tag=$(git ls-remote --refs --tags $repo | cut -d/ -f3 | sort -V | tail -n1)
59
+git clone $repo --branch $tag --depth 1
58 60
 cd encantar-js
59 61
 npm start
60 62
 ```

+ 4
- 8
docs/faq.md Просмотреть файл

@@ -1,8 +1,8 @@
1 1
 # Questions & Answers
2 2
 
3
-## What is encantAR.js?
3
+## What is encantar.js?
4 4
 
5
-encantAR.js is a standalone GPU-accelerated Augmented Reality engine for the web. The name derives from the Portuguese and Spanish word _encantar_, which means: to enchant, to delight, to love, to fascinate, to put a magical spell on someone or something. :sparkles:
5
+encantar.js is a standalone GPU-accelerated Augmented Reality engine for the web. The name derives from the Portuguese and Spanish word _encantar_, which means: to enchant, to delight, to love, to fascinate, to put a magical spell on someone or something. :sparkles:
6 6
 
7 7
 ## What is WebAR?
8 8
 
@@ -10,20 +10,16 @@ Refer to the [concepts](./getting-started/concepts.md).
10 10
 
11 11
 ## Is this WebXR?
12 12
 
13
-No, encantAR.js is not WebXR. The WebXR API allows you to access functionalities of VR and AR-capable devices in web browsers. It relies on other technologies, such as Google's ARCore or Apple's ARKit, to run the show. Those technologies are great, but they are supported on specific devices, which may or may not match your users' devices. On the other hand, encantAR.js is fully standalone and is built from scratch using standard web technologies such as WebGL2 and WebAssembly, which are widely available. My intention is to give it broad compatibility.
13
+No, encantar.js is not WebXR. The WebXR API allows you to access functionalities of VR and AR-capable devices in web browsers. It relies on other technologies, such as Google's ARCore or Apple's ARKit, to run the show. Those technologies are great, though they are supported on specific devices, which may or may not match your users' devices. On the other hand, encantar.js is fully standalone and is built from scratch using standard web technologies such as WebGL2 and WebAssembly, which are widely available. My intention is to give it broad compatibility.
14 14
 
15 15
 ## Why do my models appear "laid down" in AR?
16 16
 
17
-encantAR.js uses a right-handed coordinate system with the Z-axis pointing "up". The same convention is used in [Blender](https://www.blender.org){ ._blank }. When exporting your own models, make sure that the Z-axis points "up" and that the ground plane is the XY-plane. If your models appear "laid down" in AR, this is probably the issue.
17
+encantar.js uses a right-handed coordinate system with the Z-axis pointing "up". The same convention is used in [Blender](https://www.blender.org){ ._blank }. When exporting your own models, make sure that the Z-axis points "up" and that the ground plane is the XY-plane. If your models appear "laid down" in AR, this is probably the issue.
18 18
 
19 19
 !!! info "Fix with code"
20 20
 
21 21
     Fixing the orientation of the model is the preferred solution. However, you can also fix the issue with code: add a node (entity) to the scene graph and make it rotate its children by 90 degrees around the x-axis.
22 22
 
23
-## How can I contact you?
24
-
25
-[Get in touch!](https://github.com/alemart)
26
-
27 23
 ## I am enchanted!
28 24
 
29 25
 I know! :wink:

+ 4
- 4
docs/getting-started/activate-your-webcam.md Просмотреть файл

@@ -4,7 +4,7 @@ In this section we're going to learn how to use your webcam to capture the video
4 4
 
5 5
 ## Change the source of data
6 6
 
7
-Instead of using a video file, we're going to use your webcam. We simply need to change the source of data and instruct encantAR.js to use your webcam. We'll do it with 1 new line of code!
7
+Instead of using a video file, we're going to use your webcam. We simply need to change the source of data and instruct encantar.js to use your webcam. We'll do it with 1 new line of code!
8 8
 
9 9
 ```js title="ar-demo.js" hl_lines="20-22"
10 10
 async function startARSession()
@@ -51,7 +51,7 @@ Let's also comment (or remove) the `<video>` tag from the HTML file - we no long
51 51
     <head>
52 52
         <meta charset="utf-8">
53 53
         <meta name="viewport" content="width=device-width,initial-scale=1">
54
-        <title>encantAR.js WebAR demo</title>
54
+        <title>encantar.js WebAR demo</title>
55 55
         <script src="encantar.js"></script>
56 56
         <script src="ar-demo.js"></script>
57 57
         <style>body { background-color: #3d5afe; }</style>
@@ -81,7 +81,7 @@ Open <http://localhost:8000>{ ._blank } and... ta-da! The web browser will ask f
81 81
 
82 82
 !!! tip "Check your physical scene"
83 83
 
84
-    Good lighting conditions are important for a good user experience. Even though the encantAR.js can handle various lighting conditions, you should get your physical scene appropriately illuminated.
84
+    Good lighting conditions are important for a good user experience. Even though the encantar.js can handle various lighting conditions, you should get your physical scene appropriately illuminated.
85 85
 
86 86
     When developing your own WebAR experiences, ask yourself:
87 87
     
@@ -125,7 +125,7 @@ In order to display that scan gimmick, we need to create a HUD (<em>Heads-Up Dis
125 125
     <head>
126 126
         <meta charset="utf-8">
127 127
         <meta name="viewport" content="width=device-width,initial-scale=1">
128
-        <title>encantAR.js WebAR demo</title>
128
+        <title>encantar.js WebAR demo</title>
129 129
         <!-- <script> tags of the rendering engine of your choice -->
130 130
         <script src="encantar.js"></script>
131 131
         <script src="ar-demo.js"></script>

+ 3
- 3
docs/getting-started/concepts.md Просмотреть файл

@@ -16,9 +16,9 @@ Let me clarify what I mean by terms such as Augmented Reality and WebAR:
16 16
 
17 17
 4. A **WebAR experience** is an Augmented Reality experience developed using WebAR technology.
18 18
 
19
-5. **encantAR.js** is a WebAR technology. I also call it a WebAR engine. Lots of computations have to be performed behind the scenes in order to make an Augmented Reality experience possible. encantAR.js uses the GPU[^2] to accelerate many of those computations. In fact, the GPU and the CPU[^3] are used together. This approach improves the performance of the WebAR experience and ultimately leads to a better user experience.
19
+5. **encantar.js** is a WebAR technology. I also call it a WebAR engine. Lots of computations have to be performed behind the scenes in order to make an Augmented Reality experience possible. encantar.js uses the GPU[^2] to accelerate many of those computations. In fact, the GPU and the CPU[^3] are used together. This approach improves the performance of the WebAR experience and ultimately leads to a better user experience.
20 20
 
21
-Now that those terms are clarified, I say this: you can use encantAR.js to create amazing WebAR experiences! :wink:
21
+Now that those terms are clarified, I say this: you can use encantar.js to create amazing WebAR experiences! :wink:
22 22
 
23 23
 [^1]: This definition of AR experience is convenient in different ways. For example, it makes the term "WebAR experience", which is arguably better than "WebAR app" (no apps are downloaded), well-defined. I make a distinction between AR experience and experience of AR. An experience of AR is an event in consciousness in which AR is experienced. I sometimes use the latter definition.
24 24
 [^2]: Graphics Processing Unit
@@ -26,7 +26,7 @@ Now that those terms are clarified, I say this: you can use encantAR.js to creat
26 26
 
27 27
 ## Practical concepts
28 28
 
29
-Let me explain some concepts that you'll see over and over again when developing WebAR experiences with encantAR.js:
29
+Let me explain some concepts that you'll see over and over again when developing WebAR experiences with encantar.js:
30 30
 
31 31
 1. The experience of Augmented Reality is created by augmenting the physical scene with the virtual scene.
32 32
 

+ 3
- 3
docs/getting-started/create-the-augmented-scene.md Просмотреть файл

@@ -4,9 +4,9 @@ Now that the image is being tracked, the next step is to render a virtual scene
4 4
 
5 5
 ## Pick a 3D rendering technology
6 6
 
7
-encantAR.js is not a 3D rendering technology. It is an Augmented Reality technology that provides the data you need in order to augment your physical scenes. There are free and open-source 3D rendering technologies for the web that you can find online and use with encantAR.js. Popular solutions include: [A-Frame](#a-frame), [Babylon.js](#babylonjs) and [Three.js](#threejs). You can also use other solutions. encantAR.js lets you pick any 3D rendering technology.
7
+encantar.js is not a 3D rendering technology. It is an Augmented Reality technology that provides the data you need in order to augment your physical scenes. There are free and open-source 3D rendering technologies for the web that you can find online and use with encantar.js. Popular solutions include: [A-Frame](#a-frame), [Babylon.js](#babylonjs) and [Three.js](#threejs). You can also use other solutions. encantar.js lets you pick any 3D rendering technology.
8 8
 
9
-Once you pick a 3D rendering technology, you need to integrate it with encantAR.js. There is a code that is responsible for that integration. I call it a _plugin_. Among other things, a plugin transports the tracking results from encantAR.js to the 3D rendering technology of your choice.
9
+Once you pick a 3D rendering technology, you need to integrate it with encantar.js. There is a code that is responsible for that integration. I call it a _plugin_. Among other things, a plugin transports the tracking results from encantar.js to the 3D rendering technology of your choice.
10 10
 
11 11
 ## Use a plugin
12 12
 
@@ -24,7 +24,7 @@ Let me tell you a bit more about the 3D rendering technologies I just mentioned.
24 24
 
25 25
 ### A-Frame
26 26
 
27
-[A-Frame](https://aframe.io){ ._blank } is an open-source framework used to build virtual reality (VR) experiences for the web. When you combine it with encantAR.js, you become able to use it to create AR experiences too - without the need of special hardware or software.
27
+[A-Frame](https://aframe.io){ ._blank } is an open-source framework used to build virtual reality (VR) experiences for the web. When you combine it with encantar.js, you become able to use it to create AR experiences too - without the need of special hardware or software.
28 28
 
29 29
 A-Frame is built on top of [Three.js](#threejs) and extends it in powerful ways. It introduces a HTML-based declarative approach for [scene graphs](https://en.wikipedia.org/wiki/Scene_graph){ ._blank }, empowering them with the [Entity-Component-System](https://en.wikipedia.org/wiki/Entity_component_system){ ._blank }, a software pattern commonly used in game development. A-Frame is easy for beginners and pleasing for experts. In many cases, writing JavaScript code is not needed.
30 30
 

+ 15
- 13
docs/getting-started/index.md Просмотреть файл

@@ -1,26 +1,28 @@
1
-# Welcome to encantAR.js!
1
+# Welcome to encantar.js!
2 2
 
3 3
 [![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/)
4 4
 
5
-Enchant your users with **encantAR.js**, a GPU-accelerated Augmented Reality engine for the web.
5
+Enchant your users with **encantar.js**, a GPU-accelerated Augmented Reality engine for the web.
6 6
 
7
-[:sparkles: Demos](../demos.md){ .md-button .md-button } [:books: Learn](./introduction.md){ .md-button } [:heart:{ .heart } Sponsor](../support-my-work.md){ .md-button }
7
+[:sparkles: Demos](../demos.md){ .md-button .md-button } [:books: Learn](./introduction.md){ .md-button } [:heart: Sponsor](../support-my-work.md){ .md-button }
8 8
 
9 9
 ## Features
10 10
 
11
-* **Runs everywhere**: on Android, on iOS, and even on Desktop computers!
12
-* **Image tracking**: track detailed images such as book covers, cartoons and photos.
11
+* **AR everywhere**: encantar.js runs on Android, on iOS, and even on Desktop computers! Only a modern web browser is required.
12
+* **Plugins**: use encantar.js with the 3D framework of your choice, including A-Frame, Babylon.js, Three.js and more!
13
+* **Image tracking**: track detailed images such as book covers, cartoons and photos. No need of manual training!
13 14
 
14
-## Why use encantAR.js?
15
+## Why use encantar.js?
15 16
 
16
-* **Wide compatibility:** encantAR.js runs in all modern web browsers. It's built from scratch using standard web technologies. No need of AR-capable devices.
17
-* **Fast and powerful:** encantAR.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
18
-* **No need to download apps:** encantAR.js is a WebAR engine. Users can access the AR experiences immediately.
19
-* **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.
17
+* **Device-agnostic**: no need of AR-capable devices. encantar.js runs in all modern web browsers. It's AR built from scratch.
18
+* **Fast and powerful**: encantar.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
19
+* **No need to download apps**: encantar.js is a WebAR engine. Users can access the AR experiences immediately.
20
+* **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.
21
+* **Open-source**: what are you waiting for? [Try it now!](../demos.md)
20 22
 
21 23
 ## Browser compatibility
22 24
 
23
-encantAR.js is compatible with all major web browsers:
25
+encantar.js is compatible with all major web browsers:
24 26
 
25 27
 | Chrome | Edge | Firefox | Opera | Safari* |
26 28
 |:------:|:----:|:-------:|:-----:|:-------:|
@@ -28,8 +30,8 @@ encantAR.js is compatible with all major web browsers:
28 30
 
29 31
 \* use Safari 15.2 or later.
30 32
 
31
-encantAR.js requires WebGL2 and WebAssembly.
33
+encantar.js requires WebGL2 and WebAssembly, which are widely supported.
32 34
 
33 35
 ## About
34 36
 
35
-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).
37
+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).

+ 9
- 0
docs/getting-started/introduction.md Просмотреть файл

@@ -5,15 +5,24 @@ Augmented Reality (AR) has applications in many fields, including: games, market
5 5
 Traditionally, users were required to download (sometimes large) apps to experience AR. That was an obstacle for adoption. What if we dropped the need for apps and just required a web browser instead? Users already have web browsers! That's where WebAR comes in.
6 6
 
7 7
 <figure markdown>
8
+<!--
8 9
 <video poster="../../img/demo-cool3.webp" style="width:600px" controls muted loop playsinline autoplay oncanplay="this.muted=true;this.play()">
9 10
     <source src="../../img/demo-cool3.webm" type="video/webm" />
10 11
     <source src="../../img/demo-cool3.mp4" type="video/mp4" />
11 12
 </video>
13
+-->
14
+![Demo](../../img/mage.gif)
12 15
 <figcaption>Image Tracking</figcaption>
13 16
 </figure>
14 17
 
18
+!!! tip "In a hurry?"
19
+
20
+    This guide is an in-depth introduction to web-based Augmented Reality with encantar.js. If you're in a hurry, skip straight to the [Demos](../demos.md) section.
21
+
15 22
 ## What to expect from this guide
16 23
 
17 24
 We will create together an Augmented Reality experience that runs in web browsers. You will learn how to track an image in real-time. This is a common use case of Augmented Reality technology.
18 25
 
19 26
 No matter if you are a beginner, an expert, or somewhere in-between, set yourself at ease: this step-by-step guide can be followed by you.
27
+
28
+[Get started](concepts.md){ .md-button }

+ 2
- 2
docs/getting-started/next-steps.md Просмотреть файл

@@ -1,6 +1,6 @@
1 1
 # Next steps
2 2
 
3
-Congratulations! You have created your first WebAR experience with encantAR.js! :sunglasses:
3
+Congratulations! You have created your first WebAR experience with encantar.js! :sunglasses:
4 4
 
5 5
 Let me tell you some of the steps you can take from now on.
6 6
 
@@ -90,6 +90,6 @@ So far we've just created a static HTML page. The next step is to make your page
90 90
 
91 91
 If you came this far in the guide, WebAR probably excites you. It is definitely something you want. I know, it is awesome! The possibilities are endless. Even better than getting your creative juices boiling with enthusiasm is the feeling of joy I have for sharing this work with you.
92 92
 
93
-I develop encantAR.js independently. Creating this WebAR engine required a lot of time, effort, skill and specialized knowledge. Please support my work today, so that I can make it even more awesome!
93
+I develop encantar.js independently. Creating this WebAR engine required a lot of time, effort, skill and specialized knowledge. Please support my work today, so that I can make it even more awesome!
94 94
 
95 95
 [:heart:{ .heart } Support my work](../support-my-work.md){ .md-button }

+ 2
- 2
docs/getting-started/set-up-a-web-server.md Просмотреть файл

@@ -7,7 +7,7 @@ Let's prepare our local environment in order to create our first WebAR experienc
7 7
 Let's create a file structure for our AR experience:
8 8
 
9 9
 1. Create a new folder called `ar-demo` in your filesystem
10
-2. Download the [latest release of encantAR.js](../download.md){ ._blank } and extract `dist/encantar.js` to `ar-demo/`
10
+2. Download the [latest release of encantar.js](../download.md){ ._blank } and extract `dist/encantar.js` to `ar-demo/`
11 11
 3. Create a new empty file called `index.html` and store it in `ar-demo/`
12 12
 
13 13
 You will have the following file structure:
@@ -26,7 +26,7 @@ Use the code editor of your choice to write the following content to `index.html
26 26
     <head>
27 27
         <meta charset="utf-8">
28 28
         <meta name="viewport" content="width=device-width,initial-scale=1">
29
-        <title>encantAR.js WebAR demo</title>
29
+        <title>encantar.js WebAR demo</title>
30 30
         <script src="encantar.js"></script>
31 31
         <style>body { background-color: #3d5afe; }</style>
32 32
     </head>

+ 1
- 1
docs/getting-started/set-up-the-session.md Просмотреть файл

@@ -12,7 +12,7 @@ We begin by creating the viewport. Remember that the viewport is the area in whi
12 12
     <head>
13 13
         <meta charset="utf-8">
14 14
         <meta name="viewport" content="width=device-width,initial-scale=1">
15
-        <title>encantAR.js WebAR demo</title>
15
+        <title>encantar.js WebAR demo</title>
16 16
         <script src="encantar.js"></script>
17 17
         <script src="ar-demo.js"></script>
18 18
         <style>body { background-color: #3d5afe; }</style>

+ 5
- 5
docs/getting-started/set-up-the-tracker.md Просмотреть файл

@@ -23,7 +23,7 @@ Next, let's add the reference image to our web page. Add an `<img>` tag to the `
23 23
     <head>
24 24
         <meta charset="utf-8">
25 25
         <meta name="viewport" content="width=device-width,initial-scale=1">
26
-        <title>encantAR.js WebAR demo</title>
26
+        <title>encantar.js WebAR demo</title>
27 27
         <script src="encantar.js"></script>
28 28
         <style>body { background-color: #3d5afe; }</style>
29 29
     </head>
@@ -50,7 +50,7 @@ Once you see that the image is being properly loaded, there is no need to keep i
50 50
     <head>
51 51
         <meta charset="utf-8">
52 52
         <meta name="viewport" content="width=device-width,initial-scale=1">
53
-        <title>encantAR.js WebAR demo</title>
53
+        <title>encantar.js WebAR demo</title>
54 54
         <script src="encantar.js"></script>
55 55
         <style>body { background-color: #3d5afe; }</style>
56 56
     </head>
@@ -88,7 +88,7 @@ Let's include the test video in our page. Add a `<video>` tag as follows:
88 88
     <head>
89 89
         <meta charset="utf-8">
90 90
         <meta name="viewport" content="width=device-width,initial-scale=1">
91
-        <title>encantAR.js WebAR demo</title>
91
+        <title>encantar.js WebAR demo</title>
92 92
         <script src="encantar.js"></script>
93 93
         <style>body { background-color: #3d5afe; }</style>
94 94
     </head>
@@ -116,7 +116,7 @@ We'll be writing a little bit of JavaScript code now. In order to keep our code
116 116
     <head>
117 117
         <meta charset="utf-8">
118 118
         <meta name="viewport" content="width=device-width,initial-scale=1">
119
-        <title>encantAR.js WebAR demo</title>
119
+        <title>encantar.js WebAR demo</title>
120 120
         <script src="encantar.js"></script>
121 121
         <script src="ar-demo.js"></script>
122 122
         <style>body { background-color: #3d5afe; }</style>
@@ -154,7 +154,7 @@ window.onload = async function()
154 154
 
155 155
 The `AR` namespace holds the various elements featured by the engine. We'll be using it extensively.
156 156
 
157
-encantAR.js only requires standard web technologies that have been around for a while. Still, it's a good practice to check if those technologies are supported by the target system. If they are not, we display a message and quit. If they are, we instantiate an Image Tracker.
157
+encantar.js only requires standard web technologies that have been around for a while. Still, it's a good practice to check if those technologies are supported by the target system. If they are not, we display a message and quit. If they are, we instantiate an Image Tracker.
158 158
 
159 159
 Before moving on, make sure that you have the following directory structure at this point:
160 160
 

Двоичные данные
docs/img/cat.gif Просмотреть файл


Двоичные данные
docs/img/demo-aframe.gif Просмотреть файл


Двоичные данные
docs/img/demo-cool.mp4 Просмотреть файл


Двоичные данные
docs/img/demo-cool.webm Просмотреть файл


Двоичные данные
docs/img/demo-cool.webp Просмотреть файл


Двоичные данные
docs/img/demo-cool2.mp4 Просмотреть файл


Двоичные данные
docs/img/demo-cool2.webm Просмотреть файл


Двоичные данные
docs/img/demo-cool2.webp Просмотреть файл


Двоичные данные
docs/img/demo-cool3.gif Просмотреть файл


Двоичные данные
docs/img/demo-cool3.mp4 Просмотреть файл


Двоичные данные
docs/img/demo-cool3.webm Просмотреть файл


Двоичные данные
docs/img/demo-cool3.webp Просмотреть файл


Двоичные данные
docs/img/demo-interactivity-three.jpg Просмотреть файл


Двоичные данные
docs/img/demo-touchthree.gif Просмотреть файл


Двоичные данные
docs/img/demo-webgl.jpg Просмотреть файл


Двоичные данные
docs/img/mage.gif Просмотреть файл


Двоичные данные
docs/img/qr-demo-hello-aframe.gif Просмотреть файл


Двоичные данные
docs/img/qr-demo-hello-three.gif Просмотреть файл


Двоичные данные
docs/img/qr-demo-hello-webgl.gif Просмотреть файл


Двоичные данные
docs/img/qr-demo-hello-world.gif Просмотреть файл


Двоичные данные
docs/img/qr-demo-simple-webcam.gif Просмотреть файл


Двоичные данные
docs/img/qr-demo-touch-interaction.gif Просмотреть файл


Двоичные данные
docs/img/splash.gif Просмотреть файл


Двоичные данные
docs/img/splash.mp4 Просмотреть файл


Двоичные данные
docs/img/splash.webm Просмотреть файл


Двоичные данные
docs/img/splash.webp Просмотреть файл


+ 1
- 1
docs_overrides/demo.html Просмотреть файл

@@ -3,7 +3,7 @@
3 3
     <head>
4 4
         <meta charset="utf-8">
5 5
         <meta http-equiv="refresh" content="0; url='{{ 'demos/hello-webgl/README.html' | url }}'">
6
-        <title>encantAR.js WebAR demo</title>
6
+        <title>encantar.js WebAR demo</title>
7 7
     </head>
8 8
     <body>
9 9
         <p>Redirecting to <a href="{{ 'demos/hello-webgl/README.html' | url }}">{{ 'demos/hello-webgl/README.html' | url }}</a>...</p>

+ 1
- 1
docs_overrides/download.html Просмотреть файл

@@ -3,7 +3,7 @@
3 3
     <head>
4 4
         <meta charset="utf-8">
5 5
         <meta http-equiv="refresh" content="0; url='https://github.com/alemart/encantar-js/releases'">
6
-        <title>Download encantAR.js</title>
6
+        <title>Download encantar.js</title>
7 7
     </head>
8 8
     <body>
9 9
         <p>Redirecting to <a href="https://github.com/alemart/encantar-js/releases">https://github.com/alemart/encantar-js/releases</a>...</p>

+ 23
- 6
docs_overrides/index.html Просмотреть файл

@@ -37,6 +37,21 @@
37 37
     padding-right: 16px;
38 38
 }
39 39
 
40
+#splash::before {
41
+    content: ' ';
42
+    display: block;
43
+    position: absolute;
44
+    left: 0;
45
+    top: 0;
46
+    width: 100%;
47
+    height: 100%;
48
+    background-image: url(img/mage.gif);
49
+    background-repeat: no-repeat;
50
+    background-position: 50% 0;
51
+    background-size: cover;
52
+    opacity: 0.05;
53
+}
54
+
40 55
 .splash-container {
41 56
     display: flex;
42 57
     align-items: stretch;
@@ -60,11 +75,13 @@
60 75
     color: var(--md-accent-fg-color);
61 76
 }
62 77
 
63
-.splash-text h2 {
78
+.splash-text h1 {
64 79
     margin: 0.5em 0 0.5em 0;
80
+    color: var(--md-primary-bg-color);
81
+    font-size: 1.8em;
65 82
 }
66 83
 
67
-.splash-image > video {
84
+.splash-image > * {
68 85
     width: 80%;
69 86
     border-radius: 32px;
70 87
     border: 4px solid var(--md-primary-fg-color--light);
@@ -88,7 +105,7 @@
88 105
         margin-bottom: 0;
89 106
     }
90 107
 
91
-    .splash-image > video {
108
+    .splash-image > * {
92 109
         width: 100%;
93 110
     }
94 111
 }
@@ -111,9 +128,9 @@
111 128
 <section id="splash">
112 129
     <div class="splash-container md-grid">
113 130
         <div class="splash-text md-typeset appear text-center">
114
-            <h2>&#x2728; encantAR.js &#x2728;</h2>
115
-            <p>Enchant your users with Augmented Reality experiences that run everywhere!</p>
116
-            <a href="{{ './getting-started' | url }}" class="md-button">Get started</a>
131
+            <h1>&#x2728; encant<span style="color: #ffd500">ar</span>.js &#x2728;</h1>
132
+            <p>GPU-accelerated Augmented Reality for the web</p>
133
+            <a href="{{ './getting-started' | url }}" class="md-button">Get enchanted</a>
117 134
         </div>
118 135
         <!--
119 136
         <div class="splash-image">

+ 55
- 1
docs_overrides/js/extra.js Просмотреть файл

@@ -1,4 +1,4 @@
1
-window.addEventListener('load', () => {
1
+document.addEventListener('DOMContentLoaded', () => {
2 2
 
3 3
     //
4 4
     // Open links in a new window
@@ -8,4 +8,58 @@ window.addEventListener('load', () => {
8 8
         link.target = '_blank';
9 9
     });
10 10
 
11
+    //
12
+    // Support button
13
+    //
14
+
15
+    if(document.getElementById('splash'))
16
+        return;
17
+
18
+    const sponsor = document.createElement('a');
19
+    const heart = document.createElement('img');
20
+    const text = document.createTextNode('Support me');
21
+
22
+    heart.src = 'https://github.githubassets.com/images/icons/emoji/unicode/2764.png';
23
+    heart.style.width = '24px';
24
+    heart.style.paddingRight = '8px';
25
+    heart.classList.add('gemoji', 'heart');
26
+
27
+    sponsor.href = 'https://github.com/sponsors/alemart';
28
+    sponsor.target = '_blank';
29
+    sponsor.role = 'button';
30
+    sponsor.style.display = 'flex';
31
+    sponsor.style.alignItems = 'center';
32
+    sponsor.style.position = 'fixed';
33
+    sponsor.style.right = '16px';
34
+    sponsor.style.bottom = '16px';
35
+    sponsor.style.padding = '0 20px';
36
+    sponsor.style.height = '48px';
37
+    sponsor.style.color = 'var(--md-primary-fg-color)';
38
+    sponsor.style.backgroundColor = 'var(--md-primary-bg-color)';
39
+    sponsor.style.fontWeight = 'bold';
40
+    sponsor.style.fontSize = '16px';
41
+    sponsor.style.fontFamily = 'var(--md-text-font) sans-serif';
42
+    sponsor.style.cursor = 'pointer';
43
+    sponsor.style.borderWidth = '2px';
44
+    sponsor.style.borderStyle = 'solid';
45
+    sponsor.style.borderColor = 'var(--md-primary-fg-color)';
46
+    sponsor.style.borderRadius = '100px';
47
+    sponsor.style.transition = 'color 125ms,background-color 125ms,border-color 125ms';
48
+
49
+    sponsor.addEventListener('pointerenter', () => {
50
+        sponsor.style.backgroundColor = 'var(--md-accent-fg-color)';
51
+        sponsor.style.borderColor = 'var(--md-accent-fg-color)';
52
+        sponsor.style.color = 'var(--md-accent-bg-color)';
53
+    });
54
+
55
+    sponsor.addEventListener('pointerleave', () => {
56
+        sponsor.style.backgroundColor = 'var(--md-primary-bg-color)';
57
+        sponsor.style.borderColor = 'var(--md-primary-fg-color)';
58
+        sponsor.style.color = 'var(--md-primary-fg-color)';
59
+    });
60
+
61
+    sponsor.appendChild(heart);
62
+    sponsor.appendChild(text);
63
+    document.body.appendChild(sponsor);
64
+
11 65
 });

+ 4
- 100
docs_overrides/style/extra.css Просмотреть файл

@@ -14,9 +14,10 @@
14 14
     animation: heart 1000ms infinite;
15 15
 }
16 16
 
17
-.transparent-background {
18
-    background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgAQMAAABJtOi3AAAABlBMVEWZmZlmZmZYfKrVAAAAE0lEQVQI12P4/5+BgZoEA3VNBADtvT/BrQ+bEwAAAABJRU5ErkJggg==);
19
-    background-repeat: repeat;
17
+/* Buttons */
18
+
19
+.md-button {
20
+    border-radius: 100px !important;
20 21
 }
21 22
 
22 23
 /* Responsive videos */
@@ -25,100 +26,3 @@
25 26
     height: auto;
26 27
     max-width: 100%;
27 28
 }
28
-
29
-/* Share buttons */
30
-
31
-.share-buttons {
32
-  font-size: .5rem;
33
-  margin: 8px 0 8px 0;
34
-}
35
-
36
-@media screen and (min-width: 1220px) {
37
-  .share-buttons {
38
-    float: right;
39
-    margin-left: 16px;
40
-  }
41
-}
42
-
43
-.resp-sharing-button__link,
44
-.resp-sharing-button__icon {
45
-  display: inline-block
46
-}
47
-
48
-.resp-sharing-button__link {
49
-  text-decoration: none;
50
-  color: #fff;
51
-  /*margin: 0.5em*/
52
-}
53
-
54
-.resp-sharing-button {
55
-  color: #fff;
56
-  margin: 0.5em
57
-  border-radius: 5px;
58
-  transition: 25ms ease-out;
59
-  padding: 0.5em 0.75em;
60
-  font-family: Helvetica Neue,Helvetica,Arial,sans-serif
61
-}
62
-
63
-.resp-sharing-button__icon svg {
64
-  width: 1em;
65
-  height: 1em;
66
-  margin-right: 0.4em;
67
-  vertical-align: top
68
-}
69
-
70
-.resp-sharing-button--small svg {
71
-  margin: 0;
72
-  vertical-align: middle
73
-}
74
-
75
-/* Non solid icons get a stroke */
76
-.resp-sharing-button__icon {
77
-  stroke: #fff;
78
-  fill: none
79
-}
80
-
81
-/* Solid icons get a fill */
82
-.resp-sharing-button__icon--solid,
83
-.resp-sharing-button__icon--solidcircle {
84
-  fill: #fff;
85
-  stroke: none
86
-}
87
-
88
-.resp-sharing-button--twitter {
89
-  background-color: #55acee
90
-}
91
-
92
-.resp-sharing-button--twitter:hover {
93
-  background-color: #2795e9
94
-}
95
-
96
-.resp-sharing-button--facebook {
97
-  background-color: #3b5998
98
-}
99
-
100
-.resp-sharing-button--facebook:hover {
101
-  background-color: #2d4373
102
-}
103
-
104
-.resp-sharing-button--facebook {
105
-  background-color: #3b5998;
106
-  border-color: #3b5998;
107
-}
108
-
109
-.resp-sharing-button--facebook:hover,
110
-.resp-sharing-button--facebook:active {
111
-  background-color: #2d4373;
112
-  border-color: #2d4373;
113
-}
114
-
115
-.resp-sharing-button--twitter {
116
-  background-color: #55acee;
117
-  border-color: #55acee;
118
-}
119
-
120
-.resp-sharing-button--twitter:hover,
121
-.resp-sharing-button--twitter:active {
122
-  background-color: #2795e9;
123
-  border-color: #2795e9;
124
-}

+ 1
- 1
docs_overrides/support-my-work.html Просмотреть файл

@@ -3,7 +3,7 @@
3 3
     <head>
4 4
         <meta charset="utf-8">
5 5
         <meta http-equiv="refresh" content="0; url='https://github.com/sponsors/alemart'">
6
-        <title>encantAR.js - Support my work</title>
6
+        <title>encantar.js - Support my work</title>
7 7
     </head>
8 8
     <body>
9 9
         <p>Redirecting to <a href="https://github.com/sponsors/alemart">GitHub Sponsors</a>...</p>

+ 2
- 2
mkdocs.yml Просмотреть файл

@@ -1,7 +1,7 @@
1
-site_name: "encantAR.js: GPU-accelerated Augmented Reality for the web"
1
+site_name: "encantar.js: GPU-accelerated Augmented Reality for the web"
2 2
 site_url: https://alemart.github.io/encantar-js
3 3
 site_author: Alexandre Martins
4
-site_description: Enchant your users with WebAR experiences that run everywhere!
4
+site_description: Home of encantar.js, a GPU-accelerated Augmented Reality engine for the web
5 5
 copyright: Copyright &copy; 2022 - present Alexandre Martins
6 6
 
7 7
 repo_name: alemart/encantar-js

+ 1
- 1
src/main.ts Просмотреть файл

@@ -118,7 +118,7 @@ Object.freeze(AR);
118 118
 
119 119
 // Display a notice
120 120
 Utils.log(
121
-    `encantAR.js version ${AR.version}. ` +
121
+    `encantar.js version ${AR.version}. ` +
122 122
     `GPU-accelerated Augmented Reality for the web by Alexandre Martins. ` +
123 123
     __AR_WEBSITE__
124 124
 );

Загрузка…
Отмена
Сохранить