https://github.com/kalwalt/artoolkitx-ts
Typescript version of artoolkitX.js
https://github.com/kalwalt/artoolkitx-ts
artoolkitx artoolkitxjs typescript webar webassembly
Last synced: 7 months ago
JSON representation
Typescript version of artoolkitX.js
- Host: GitHub
- URL: https://github.com/kalwalt/artoolkitx-ts
- Owner: kalwalt
- License: lgpl-2.1
- Created: 2021-10-21T17:18:25.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-14T16:04:36.000Z (about 2 years ago)
- Last Synced: 2024-04-17T02:23:16.049Z (about 2 years ago)
- Topics: artoolkitx, artoolkitxjs, typescript, webar, webassembly
- Language: TypeScript
- Homepage:
- Size: 50.6 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# artoolkitX-ts
**artoolkitX-ts** is the Typescript version of [ArtoolkitX.js](https://github.com/webarkit/artoolkitX.js), the first emscripten port of [ARToolkitX](https://github.com/artoolkitx/artoolkitx).
Most of the features are in the library, but it's in an experimental stage. Actually it can track only barcode and pattern markers but we plan to add support for 2d markers too.
## Examples
Test the examples:
- `examples/simple_image.html` it load a simple static image and output some message in the console.
- `examples/simple_barcode.html` barcode example - a colored cube should appear on the barcode marker.
- `examples/simple_hiro.html` pattern example - a colored cube should appear on the hiro marker.
- `examples/simple_2d_tracking.html` 2d tracking example with the pinball image - very bad perfs.
- `examples/ArtoolkitX_example.html` 2d tracking example in a WebWorker with the pinball image - very bad perfs.
## Contributing
You can contribute to the project, just file an issue and send a PR: you are welcome!
Follow the **Build** instructions if you make changes to the code.
### Build
We use webpack as bundler, you need to rebuild the dist lib if you make changes.
If you make changes to the C/C++ Source code you need to build the whole project.
First of all you need to clone the **artoolkitX_em_2d** submodule:
`git submodule update --init`
then run the `configure.sh` script inside the main folder:
`./configure.sh`
the script will run cmake and will create the config.h file necessary for the compilation. After this step you can install all nodejs dependencies:
`npm install`
You need emsdk 2.0.20 to build the wasm module, check if you have installed with `emcc -v`. So if you have installed it run the command:
`npm run build`
For a development dist build run:
`npm run dev-ts`
For a production-optimized dits build run:
`npm run build-ts`
this will produce ARToolkitX.js dist lib.
### Future plans
- Add support for 2d markers! (only experimental examples for now!)
- NFT markers
- improved new build script for the wasm lib.
- npm package
- multi pattern marker support.