{"id":28122723,"url":"https://github.com/webarkit/jsartoolkitnft","last_synced_at":"2025-05-14T08:14:31.908Z","repository":{"id":37937654,"uuid":"253888121","full_name":"webarkit/jsartoolkitNFT","owner":"webarkit","description":"jsartolkitNFT is a smaller version of jsartoolkit5 with only NFT support","archived":false,"fork":false,"pushed_at":"2025-05-09T02:59:04.000Z","size":233176,"stargazers_count":136,"open_issues_count":32,"forks_count":25,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-05-14T08:14:26.159Z","etag":null,"topics":["augmented-reality","es6","hacktoberfest","image-tracking","jsartoolkit5","jsartoolkitnft","markerless","nft","webapp","webar","webarkit"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webarkit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":null,"patreon":"walterperdan","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-04-07T19:08:55.000Z","updated_at":"2025-05-07T18:30:58.000Z","dependencies_parsed_at":"2023-09-25T00:04:59.883Z","dependency_job_id":"c4916d21-09aa-4ab8-a01a-40eb290b9ad0","html_url":"https://github.com/webarkit/jsartoolkitNFT","commit_stats":{"total_commits":714,"total_committers":11,"mean_commits":64.9090909090909,"dds":"0.31092436974789917","last_synced_commit":"c5486f00ca5f91be25fd69b0dcff1b48d814d07e"},"previous_names":["kalwalt/jsartoolkitnft"],"tags_count":55,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webarkit%2FjsartoolkitNFT","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webarkit%2FjsartoolkitNFT/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webarkit%2FjsartoolkitNFT/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webarkit%2FjsartoolkitNFT/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webarkit","download_url":"https://codeload.github.com/webarkit/jsartoolkitNFT/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254101541,"owners_count":22014909,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["augmented-reality","es6","hacktoberfest","image-tracking","jsartoolkit5","jsartoolkitnft","markerless","nft","webapp","webar","webarkit"],"created_at":"2025-05-14T08:14:26.797Z","updated_at":"2025-05-14T08:14:31.894Z","avatar_url":"https://github.com/webarkit.png","language":"TypeScript","funding_links":["https://patreon.com/walterperdan"],"categories":[],"sub_categories":[],"readme":"![github releases](https://flat.badgen.net/github/release/webarkit/jsartoolkitNFT)\n![github stars](https://flat.badgen.net/github/stars/webarkit/jsartoolkitNFT)\n![github forks](https://flat.badgen.net/github/forks/webarkit/jsartoolkitNFT)\n![npm package version](https://flat.badgen.net/npm/v/@webarkit/jsartoolkit-nft)\n![Dependabot Badge](https://flat.badgen.net/github/dependabot/webarkit/jsartoolkit-nft)\n[![Tested with QUnit](https://img.shields.io/badge/tested_with-qunit-9c3493.svg)](https://qunitjs.com/)\n[![CI](https://github.com/webarkit/jsartoolkitNFT/actions/workflows/CI.yml/badge.svg)](https://github.com/webarkit/jsartoolkitNFT/actions/workflows/CI.yml)\n[![Build jsartoolkitNFT CI](https://github.com/webarkit/jsartoolkitNFT/actions/workflows/main.yml/badge.svg)](https://github.com/webarkit/jsartoolkitNFT/actions/workflows/main.yml)\n\n\n\n\n# JSARToolKitNFT\n\nEmscripten port of [WebARKitLib](https://github.com/webarkit/WebARKitLib) to JavaScript.\nModified and lighter version of [JSARToolKit5](https://github.com/artoolkitx/jsartoolkit5).\n\nTry the example !! [www.webarkit.org/examples/artoolkitnft_es6_example](https://www.webarkit.org/examples/artoolkitnft_es6_example)\n\n## Features\n### Markers Types\n\n**JSARToolKitNFT** support only this type of marker:\n\n- NFT (natural feature tracking) markers ✅ 🎉 🎨\n- Multi NFT markers !!!\n\n## WASM\n\nhas **WASM** embedded in a single file!\n\n## ZFT\n\n**JSARToolKitNFT** now supports loading NFT markers from `.zft` compressed files. This allows for faster loading times and reduced file sizes.\n\n\n## ES6\n\n❕From 0.8.0 version has **ES6** feature 🎉 😻\n\n## Typescript\n\n❕From 0.9.0 version has **Typescript** feature 💖 💣\n\n## Pthread\n\nFrom 1.6.0 version has **Pthread** experimental feature 🎉 🎉 🎉\n\n❕❕❕ ATTENTION: this feature is experimental, and it is not well tested yet. It is not recommended to use it in production.\nYou need to set up a server with COOP and COEP headers to use this feature. Read this [Emscripten article](https://emscripten.org/docs/porting/pthreads.html#pthreads-support)\n\n## InternalLuma with simd\nEnable internal luma calculation with simd instructions. This feature is experimental and it is not well tested yet. Set the internalLuma flag to true in the ARControllerNFT constructor, or in the `initWithDimensions / initWithImage` static methods.\n\n## Using the library 💥\nYou can use raw.githack.com links:\n\n**WASM** version of the library (deprecated it will be removed in a future release):\n\n```html\n\u003cscript src=\"https://raw.githack.com/webarkit/jsartoolkitNFT/master/build/artoolkitNFT_wasm.js\"\u003e\n```\n\n**WASM** version of the library as a Module:\n\n```html\n\u003cscript src=\"https://raw.githack.com/webarkit/jsartoolkitNFT/master/build/artoolkitNFT_ES6_wasm.js\"\u003e\n```\n\n**WASM** version of the library as a Module with new ES6 feature:\n\n```html\n\u003cscript src=\"https://raw.githack.com/webarkit/jsartoolkitNFT/master/build/artoolkitNFT_embed_ES6_wasm.js\"\u003e\n```\n\n**NO WASM** minified (deprecated it will be removed in a future release):\n\n```html\n\u003cscript src=\"https://raw.githack.com/webarkit/jsartoolkitNFT/master/build/artoolkitNFT.min.js\"\u003e\n```\n\nor (recommended) use the **UMD** library:\n\n```html\n\u003cscript src=\"https://raw.githack.com/webarkit/jsartoolkitNFT/master/dist/ARToolkitNFT.js\"\u003e\n```\n\nor you can install with npm and use as a module:\n\n```nodejs\nnpm i @webarkit/jsartoolkit-nft\n```\nthen:\n\n```javascript\nimport { ARToolkitNFT, ARControllerNFT } from '@webarkit/jsartoolkit-nft'\n```\n\n**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.\n\n```javascript\n// example of import in a worker with the wasm code lib\nimportScripts(\"../build/artoolkitNFT_wasm.js\");\n// or the dist lib\nimportScripts(\"../dist/ARToolkitNFT.js\");\n```\n\n## Downloads\n\nYou 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).\n\nor you can clone the repository with git, follow the instructions below:\n\n## Clone the repository 🌀\n\n1. Clone this repository\n2. Clone WebARKitLib project to get the latest source files. From within JSARToolKitNFT directory do `git submodule update --init`. If you already cloned WebARKitLib to a different directory you can:\n\n  - create a link in the `jsartoolkitNFT/emscripten/` directory that points to WebARKitLib (`jsartoolkitNFT/emscripten/WebARKitLib`) (Linux and macOS only)\n  - or, set the `WEBARKITLIB_ROOT` environment variable to point to your WebARKitLib clone\n  - or, change the `tools/makem.js` file to point to your WebARKitLib clone (line 32-33)\n\n## Documentation\n\nYou can build the documentation of the library. You need node and npm installed and then run these commands in a console:\n\n```nodejs\nnpm install\nnpm run docs\n```\nAt this point you have build the docs in the `docs/` folder, you should run a server and then go to `docs/` folder.\n\n## Using with React\n\nTry [react-three-arnft](https://github.com/j-era/react-three-arnft) a specific project that uses JsartoolkitNFT with React and Three.js.\n\n## ARnft library\n\n**JSARToolKitNFT** is used by [ARnft](https://github.com/webarkit/ARnft) a small library that helps developers to create **WebAR** apps.\n\n## Project Structure 📂\n\n- `build/` (compiled debug and minified versions of JSARToolKitNFT)\n- `dist/` (compiled UMD lib with ES6 of JSARToolKitNFT)\n- `emscripten/` (C/C++ source code for ARToolKitNFT)\n- `examples/` (demos and examples using JSARToolKitNFT)\n- `js/` (api and workers of JSARToolKitNFT.js for the standard api)\n- `src/` (source code of ARToolKitNFT with Typescript)\n- `tests/` (tests - WIP)\n- `tools/` (build scripts for building JSARToolKitNFT with Emscripten)\n- `types/` (type definitions of ARToolKitNFT)\n\n## WebAssembly 👋\n\n**JSARToolKitNFT** supports WebAssembly. The library builds WebAssembly artifacts during the build process, **WASM** is embedded in a single file. This is `build/artoolkitNFT_wasm.js`. To use it, include the `artoolkitNFT_wasm.js` into your html page like this:\n\n```html\n\u003cscript src=\"../build/artoolkitNFT_wasm.js\"\u003e\u003c/script\u003e\n```\n\nAs loading the WebAssembly artifact is done asynchronously, there is a callback that is called when everything is ready.\n\n```javascript\nwindow.addEventListener('artoolkitNFT-loaded', () =\u003e {\n    //do artoolkit stuff here\n});\n```\n\nSee the examples folder for details.\n\n\n## Build the project 🔨\n\nGo to the [wiki](https://github.com/kalwalt/jsartoolkitNFT/wiki#build-instructions) for more infos. Note that you need to build the library only if you make changes to the source code.\n\n### Notes\nThe jsartoolkitNFT npm package is served until version **0.9.4** from `@kalwalt/jsartoolkit-nft`. By 0.9.5 version from `@webarkit/jsartoolkit-nft`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebarkit%2Fjsartoolkitnft","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebarkit%2Fjsartoolkitnft","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebarkit%2Fjsartoolkitnft/lists"}