Feature upgrade three.js

.github/workflows/CI.yml

@@ -10,21 +10,21 @@ jobs:
     strategy:
       matrix:
         node:
-          - 16.x
+          - 20.x
 
     # Packages 'firefox' and 'chromium' are pre-installed.
     #
     # https://github.com/actions/virtual-environments/blob/ubuntu20/20210302.0/images/linux/Ubuntu2004-README.md
     runs-on: ubuntu-20.04
     name: Node.js ${{ matrix.node }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Use Node.js ${{ matrix.node }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

.github/workflows/main.yml

@@ -12,14 +12,14 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x]
+        node-version: [20.x]
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
-    - uses: actions/cache@v3
+    - uses: actions/cache@v4
       with:
         path: ~/.npm
         key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
@@ -34,7 +34,7 @@ jobs:
       run: |
         echo $RELEASE_VERSION
         echo ${{ steps.vars.outputs.tag }}
-    - uses: actions/upload-artifact@v3
+    - uses: actions/upload-artifact@v4
       with:
         name: build
         path: |
@@ -43,9 +43,9 @@ jobs:
           !build/libar_simd.bc
     - run: git submodule update --init
     - run: npm install
-    - run: docker run -dit --name emscripten -v $(pwd):/src emscripten/emsdk:3.1.40 bash
+    - run: docker run -dit --name emscripten -v $(pwd):/src emscripten/emsdk:3.1.69 bash
     - run: docker exec emscripten npm run build
-    - uses: actions/upload-artifact@v3
+    - uses: actions/upload-artifact@v4
       with:
         name: dist
         path: dist
@@ -58,17 +58,15 @@ jobs:
         message: new build files from action
         add: '["build", "dist"]'
     - name: Release
-      uses: softprops/action-gh-release@v1
+      uses: softprops/action-gh-release@v2
       if: startsWith(github.ref, 'refs/tags/')
       with:
         files: |
           build/artoolkitNFT_embed_ES6_wasm.js
           build/artoolkitNFT_ES6_wasm.js
           build/artoolkitNFT_ES6_wasm_td.js
-          build/artoolkitNFT_ES6_wasm_td.worker.js
           build/artoolkitNFT_ES6_wasm.simd.js
           build/artoolkitNFT_thread.js
-          build/artoolkitNFT_thread.worker.js
           build/artoolkitNFT_wasm.js
           build/artoolkitNFT_wasm.simd.js
           build/artoolkitNFT.debug.js

.gitignore

@@ -1,3 +1,4 @@
 build/*.bc
+build/*.o
 node_modules
 docs/*

.nvmrc

@@ -1 +1 @@
-16.18.1
+20.18.0

.prettierignore

@@ -3,9 +3,10 @@ emscripten
 dist
 docs
 node_modules
-examples
+examples/*/*/*/*.js
+examples/*/*/*.js
 types
-*.html
+#*.html
 *.json
 build/*.js
 js/*.api.js

README.md

@@ -86,6 +86,16 @@ then:
 ```javascript
 import { ARToolkitNFT, ARControllerNFT } from '@webarkit/jsartoolkit-nft'
 ```
+
+**Note**: All the examples in the repository are running the code inside a Worker (don't use it in the main thread!). So i you need to import the library in a worker you need to use the `importScripts` function.
+
+```javascript
+// example of import in a worker with the wasm code lib
+importScripts("../build/artoolkitNFT_wasm.js");
+// or the dist lib
+importScripts("../dist/ARToolkitNFT.js");
+```
+
 ## Downloads
 
 You can download the build libs in the [releases page](https://github.com/webarkit/jsartoolkitNFT/releases). Starting from version 0.8.0 it is possible to download `dist` or `build` zip packages and from 0.9.6 version only single libs (no zipped).