You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ See examples/simple_image_wasm.html for details.
42
42
2. Clone ARToolKit5 project to get the latest source files. From within jsartoolkit5 directory do `git submodule update --init`. If you already cloned ARToolKit5 to a different directory you can:
43
43
- create a link in the `jsartoolkit5/emscripten/` directory that points to ARToolKit5 (`jsartoolkit5/emscripten/artoolkit5`) (Linux and macOS only)
44
44
- or, set the `ARTOOLKIT5_ROOT` environment variable to point to your ARToolKit5 clone
45
-
- or, change the `tools/makem.js` file to point to your artoolkit5 clone (line 62, 83, 107, 140)
45
+
- or, change the `tools/makem.js` file to point to your artoolkit5 clone (line 20)
46
46
47
47
## Build Instructions
48
48
@@ -57,7 +57,7 @@ See examples/simple_image_wasm.html for details.
57
57
8.`docker rmi trzeci/emscripten-slim:latest` - remove the image if you don't need it anymore
58
58
9. The build artefacts are in `/build`. There's a build with debug symbols in `artoolkit.debug.js` and the optimized build with bundled JS API in `artoolkit.min.js` and a WebAssembly build artoolkit_wasm.js and artoolkit_wasm.wasm
59
59
60
-
### !! Not recommended !! : Build local with manual emscripten setup
60
+
### ⚠️ Not recommended ⚠️ : Build local with manual emscripten setup
61
61
To prevent issues with Emscripten setup and to not have to maintain several build environments (macOS, Windows, Linux) we only maintain the **Build using Docker**. Following are the instructions of the last know build on Linux which we verified are working. **Use at own risk.**
62
62
** Not working on macOS!**
63
63
@@ -71,7 +71,7 @@ jsartoolkit5 aim is to create a Javascript version of artoolkit5. First, you nee
71
71
2. Clone ARToolKit5 project to get the latest source files. From within jsartoolkit5 directory do `git submodule update --init`. If you already cloned ARToolKit5 to a different directory you can:
72
72
- create a link in the `jsartoolkit5/emscripten/` directory that points to ARToolKit5 (`jsartoolkit5/emscripten/artoolkit5`)
73
73
- or, set the `ARTOOLKIT5_ROOT` environment variable to point to your ARToolKit5 clone
74
-
- or, change the `tools/makem.js` file to point to your artoolkit5 clone (line 62, 83, 107, 140)
74
+
- or, change the `tools/makem.js` file to point to your artoolkit5 clone (line 20)
75
75
76
76
3. Building
77
77
1. Make sure `EMSCRIPTEN` env variable is set (e.g. `EMSCRIPTEN=/usr/lib/emsdk_portable/emscripten/master/ node tools/makem.js`
@@ -82,15 +82,15 @@ During development, you can run ```npm run watch```, it will rebuild the library
82
82
83
83
4. The built ASM.js files are in `/build`. There's a build with debug symbols in `artoolkit.debug.js` and the optimized build with bundled JS API in `artoolkit.min.js`.
84
84
85
-
# ARToolKit JS API
85
+
##ARToolKit JS API
86
86
87
87
```js
88
88
<script src="../build/artoolkit.min.js">
89
89
// include optimized ASM.js build and JS API
90
90
</script>
91
91
```
92
92
93
-
# ARToolKit JS debug build
93
+
##ARToolKit JS debug build
94
94
95
95
```js
96
96
<script async src="../build/artoolkit.debug.js">
@@ -101,7 +101,7 @@ During development, you can run ```npm run watch```, it will rebuild the library
101
101
</script>
102
102
```
103
103
104
-
# ARToolKit Three.js helper API
104
+
##ARToolKit Three.js helper API
105
105
106
106
```js
107
107
<script src="../build/artoolkit.min.js">
@@ -119,11 +119,11 @@ console.log("Three.js helper API loaded");
119
119
};
120
120
if (window.ARController&&window.ARController.getUserMediaThreeScene) {
121
121
ARThreeOnLoad();
122
-
}
122
+
};
123
123
</script>
124
124
```
125
125
126
-
# Examples
126
+
##Examples
127
127
128
128
See `examples/` for examples on using the raw API and the Three.js helper API.
0 commit comments