{"_id":"@ar-js-org/marker-creator","name":"@ar-js-org/marker-creator","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@ar-js-org/marker-creator","version":"0.1.0","description":"An utility app to create pattern markers from your own images","keywords":["artoolkit","ar","augmented reality","marker creator","pattern marker","ar.js","webar"],"main":"dist/marker-creator.umd.js","module":"dist/marker-creator.mjs","types":"dist/index.d.ts","exports":{".":{"import":"./dist/marker-creator.mjs","require":"./dist/marker-creator.umd.js"}},"scripts":{"dev":"vite","build":"vite build","preview":"vite preview","test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/AR-js-org/Marker-Creator.git"},"author":{"name":"Walter Perdan","url":"https:://github.com/kalwalt"},"devDependencies":{"@types/node":"^25.5.0","typescript":"^6.0.2","vite":"^8.0.3","vite-plugin-dts":"^4.5.4"},"_id":"@ar-js-org/marker-creator@0.1.0","gitHead":"856a04732cbc004fafc04e98489e6d4e4a6a65b0","bugs":{"url":"https://github.com/AR-js-org/Marker-Creator/issues"},"homepage":"https://github.com/AR-js-org/Marker-Creator#readme","_nodeVersion":"22.21.1","_npmVersion":"10.9.4","dist":{"integrity":"sha512-S7mSD7kdGdR2z6kAR0MRwW+tO7IaQxwbgSeagc93WJE22h5JnXa4VR9CrzOKUPjHojo3YgAF7hf4OwyY70b/IA==","shasum":"80c980d7a73c39772a4de38fba9644d1ec736fd8","tarball":"https://registry.npmjs.org/@ar-js-org/marker-creator/-/marker-creator-0.1.0.tgz","fileCount":10,"unpackedSize":20951,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDjUB5JuoTFBf7gY+ATZun34NXV1s2KJ8WISSoiAPxDcwIgaoOYzyzrzKwMJWoEZSmO3Nmc23afMpbZp+kpa/oqTy0="}]},"_npmUser":{"name":"kalwalt","email":"info@kalwaltart.it"},"directories":{},"maintainers":[{"name":"kalwalt","email":"info@kalwaltart.it"},{"name":"nickw1","email":"nickw4426@gmail.com"},{"name":"nicolocarpignoli","email":"nicolocarpignoli@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/marker-creator_0.1.0_1774895569957_0.5092269812242693"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-30T18:32:49.837Z","0.1.0":"2026-03-30T18:32:50.092Z","modified":"2026-03-30T18:32:50.709Z"},"maintainers":[{"name":"kalwalt","email":"info@kalwaltart.it"},{"name":"nickw1","email":"nickw4426@gmail.com"},{"name":"nicolocarpignoli","email":"nicolocarpignoli@gmail.com"}],"description":"An utility app to create pattern markers from your own images","homepage":"https://github.com/AR-js-org/Marker-Creator#readme","keywords":["artoolkit","ar","augmented reality","marker creator","pattern marker","ar.js","webar"],"repository":{"type":"git","url":"git+https://github.com/AR-js-org/Marker-Creator.git"},"author":{"name":"Walter Perdan","url":"https:://github.com/kalwalt"},"bugs":{"url":"https://github.com/AR-js-org/Marker-Creator/issues"},"readme":"# Marker-Creator\r\n\r\n[![npm version](https://img.shields.io/npm/v/@ar-js-org/marker-creator.svg?style=flat-square)](https://www.npmjs.com/package/@ar-js-org/marker-creator)\r\n[![npm downloads](https://img.shields.io/npm/dm/@ar-js-org/marker-creator.svg?style=flat-square)](https://www.npmjs.com/package/@ar-js-org/marker-creator)\r\n[![GitHub stars](https://img.shields.io/github/stars/AR-js-org/Marker-Creator?style=flat-square)](https://github.com/AR-js-org/Marker-Creator/stargazers)\r\n[![GitHub forks](https://img.shields.io/github/forks/AR-js-org/Marker-Creator?style=flat-square)](https://github.com/AR-js-org/Marker-Creator/network/members)\r\n[![GitHub issues](https://img.shields.io/github/issues/AR-js-org/Marker-Creator?style=flat-square)](https://github.com/AR-js-org/Marker-Creator/issues)\r\n[![License](https://img.shields.io/github/license/AR-js-org/Marker-Creator?style=flat-square)](https://github.com/AR-js-org/Marker-Creator/blob/main/LICENSE)\r\n\r\nMarker-Creator is a tool to generate AR.js compatible pattern markers from your own images. It allows you to create custom markers for AR.js-based applications easily and quickly.\r\n\r\n## Project Intent\r\n\r\nThe goal of this project is to generate a pattern marker file (and marker image) from a user-provided image. The generated marker can be used in AR.js and other ARToolKit-based frameworks.\r\n\r\n## Installation\r\n\r\nYou can install Marker-Creator via npm:\r\n\r\n```\r\nnpm install @ar-js-org/marker-creator\r\n```\r\n\r\n## Usage\r\n\r\n### Import as ES Module (in your code)\r\n\r\n```js\r\n// Import in a JavaScript/TypeScript project\r\nimport { ArPatternFile } from '@ar-js-org/marker-creator';\r\n\r\n// Example usage:\r\nArPatternFile.encodeImageURL(imageDataUrl, (patternFileString) => {\r\n  // Do something with the pattern file string\r\n});\r\n```\r\n\r\n### Load from CDN (browser, e.g. with raw.githack.com)\r\n\r\nYou can use the UMD bundle directly in the browser without npm:\r\n\r\n```html\r\n<script src=\"https://raw.githack.com/AR-js-org/Marker-Creator/main/dist/marker-creator.umd.js\"></script>\r\n<script>\r\n  // Access via window.MarkerCreator.ArPatternFile\r\n  window.MarkerCreator.ArPatternFile.encodeImageURL(imageDataUrl, function(patternFileString) {\r\n    // Do something with the pattern file string\r\n  });\r\n</script>\r\n```\r\n\r\n## Example\r\n\r\nA complete example is provided in the `examples/generator.html` file. This example demonstrates how to use the Marker-Creator library to upload an image, adjust marker parameters, preview the result, and download the generated marker files.\r\n\r\n---\r\n\r\nFor more information, see the documentation or open an issue on the repository.\r\n","readmeFilename":"README.md","_rev":"1-5f380cab65bc725af9d26629dae95ec4"}