{"_id":"@8thwall/image-target-cli","_rev":"10-dcfdd2d518b5c61065c075e93f9ee06c","name":"@8thwall/image-target-cli","dist-tags":{"alpha":"1.0.0-alpha.3","latest":"1.0.0"},"versions":{"1.0.0-alpha.0":{"name":"@8thwall/image-target-cli","version":"1.0.0-alpha.0","keywords":["8thwall","image","targets","tracking"],"author":{"name":"8th Wall Team"},"license":"MIT","_id":"@8thwall/image-target-cli@1.0.0-alpha.0","maintainers":[{"name":"dat-8thwall","email":"dat@8thwall.com"},{"name":"atomarch","email":"atomarch@gmail.com"},{"name":"cmbartschat8","email":"christoph@8thwall.com"},{"name":"waynehsu64","email":"wayne@8thwall.com"},{"name":"kaci8","email":"kaci@8thwall.com"}],"homepage":"https://8thwall.org","bugs":{"url":"https://github.com/8thwall/8thwall/issues"},"dist":{"shasum":"d87c07856c1c5a54ffd4a1bad80a6e9902ac874c","tarball":"https://registry.npmjs.org/@8thwall/image-target-cli/-/image-target-cli-1.0.0-alpha.0.tgz","fileCount":12,"integrity":"sha512-UK4Rc9O+JKmxiRc6W5Z72A0Fu0aATBBBbu7k2Lvd0na021BH8vIIk09liigQGx80YKg5q6fokArLsbioN4gDlA==","signatures":[{"sig":"MEYCIQD8CiSp+8k4qbtdcsa7UQj9wjNjnFxbfClQEIs3YylFMgIhAPNIyi0d2L35qVTxzZXbhFc4UXLRcERvSWvUSTXxWcPZ","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":28341},"main":"src/index.js","type":"module","gitHead":"c8af93f5970906ab5d07bbab14599d96d3cc67c9","scripts":{"test":"npx tsc -P tsconfig.json && node --test src/*.test.js"},"_npmUser":{"name":"cmbartschat8","email":"christoph@8thwall.com"},"repository":{"url":"git+https://github.com/8thwall/8thwall.git","type":"git","directory":"apps/image-target-cli"},"_npmVersion":"9.6.7","description":"Generate 8th Wall Image Target Metadata","directories":{},"_nodeVersion":"18.17.1","dependencies":{"sharp":"^0.34.5"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.9.3","@types/node":"^25.2.3","@types/sharp":"^0.31.1"},"_npmOperationalInternal":{"tmp":"tmp/image-target-cli_1.0.0-alpha.0_1772578468448_0.9957213592364758","host":"s3://npm-registry-packages-npm-production"}},"1.0.0-alpha.1":{"name":"@8thwall/image-target-cli","version":"1.0.0-alpha.1","keywords":["8thwall","image","targets","tracking"],"author":{"name":"8th Wall Team"},"license":"MIT","_id":"@8thwall/image-target-cli@1.0.0-alpha.1","maintainers":[{"name":"dat-8thwall","email":"dat@8thwall.com"},{"name":"atomarch","email":"atomarch@gmail.com"},{"name":"cmbartschat8","email":"christoph@8thwall.com"},{"name":"waynehsu64","email":"wayne@8thwall.com"},{"name":"kaci8","email":"kaci@8thwall.com"}],"homepage":"https://8thwall.org","bugs":{"url":"https://github.com/8thwall/8thwall/issues"},"bin":{"image-target-cli":"src/index.js"},"dist":{"shasum":"e6bba0c063dba4657408017920b97e200afc460c","tarball":"https://registry.npmjs.org/@8thwall/image-target-cli/-/image-target-cli-1.0.0-alpha.1.tgz","fileCount":12,"integrity":"sha512-NF0879DJhnqB5l+NI9pW6ieSGI5GuIolDoSldzWav4KHYC1usRlPenF9rhpsgUHrIGAK25ILmpB54X+27P1X/g==","signatures":[{"sig":"MEQCIFgEzNpREbyDfz67pQ/yRxnzgadMW6KfA9OCZhaRhEqIAiAQ98Pj3hIE36LaPoifUn93nMjCLBAxKiauor7XcI0Esw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":28370},"type":"module","gitHead":"c8af93f5970906ab5d07bbab14599d96d3cc67c9","scripts":{"test":"npx tsc -P tsconfig.json && node --test src/*.test.js"},"_npmUser":{"name":"cmbartschat8","email":"christoph@8thwall.com"},"repository":{"url":"git+https://github.com/8thwall/8thwall.git","type":"git","directory":"apps/image-target-cli"},"_npmVersion":"10.9.3","description":"Generate 8th Wall Image Target Metadata","directories":{},"_nodeVersion":"22.20.0","dependencies":{"sharp":"^0.34.5"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.9.3","@types/node":"^25.2.3","@types/sharp":"^0.31.1"},"_npmOperationalInternal":{"tmp":"tmp/image-target-cli_1.0.0-alpha.1_1772579209677_0.10905109043328842","host":"s3://npm-registry-packages-npm-production"}},"1.0.0-alpha.2":{"name":"@8thwall/image-target-cli","version":"1.0.0-alpha.2","keywords":["8thwall","image","targets","tracking"],"author":{"name":"8th Wall Team"},"license":"MIT","_id":"@8thwall/image-target-cli@1.0.0-alpha.2","maintainers":[{"name":"dat-8thwall","email":"dat@8thwall.com"},{"name":"atomarch","email":"atomarch@gmail.com"},{"name":"cmbartschat8","email":"christoph@8thwall.com"},{"name":"waynehsu64","email":"wayne@8thwall.com"},{"name":"kaci8","email":"kaci@8thwall.com"}],"homepage":"https://8thwall.org","bugs":{"url":"https://github.com/8thwall/8thwall/issues"},"bin":{"image-target-cli":"src/index.js"},"dist":{"shasum":"794fd7279912e3e08331c6845169369d60207884","tarball":"https://registry.npmjs.org/@8thwall/image-target-cli/-/image-target-cli-1.0.0-alpha.2.tgz","fileCount":12,"integrity":"sha512-psd9dcAu3QPF8u3a7wdv+P/BfzmKTktZOlhPXrMFGvNnr45p58ZuS9Pa2ScFNmct1cIQIJcRe//pTPputui0Sg==","signatures":[{"sig":"MEQCID2Hd/PY7px9i5IEhKzD3r20piBnh4VVhWL2/vvl0eEgAiAcdX36n+2kJCMT0NMhvE8Lq4VqKwRm1HNteXTV32jC8Q==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":28397},"main":"src/index.js","type":"module","gitHead":"c8af93f5970906ab5d07bbab14599d96d3cc67c9","scripts":{"test":"npx tsc -P tsconfig.json && node --test src/*.test.js"},"_npmUser":{"name":"cmbartschat8","email":"christoph@8thwall.com"},"repository":{"url":"git+https://github.com/8thwall/8thwall.git","type":"git","directory":"apps/image-target-cli"},"_npmVersion":"10.9.3","description":"Generate 8th Wall Image Target Metadata","directories":{},"_nodeVersion":"22.20.0","dependencies":{"sharp":"^0.34.5"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.9.3","@types/node":"^25.2.3","@types/sharp":"^0.31.1"},"_npmOperationalInternal":{"tmp":"tmp/image-target-cli_1.0.0-alpha.2_1772579287018_0.37950189138452584","host":"s3://npm-registry-packages-npm-production"}},"1.0.0-alpha.3":{"name":"@8thwall/image-target-cli","version":"1.0.0-alpha.3","keywords":["8thwall","image","targets","tracking"],"author":{"name":"8th Wall Team"},"license":"MIT","_id":"@8thwall/image-target-cli@1.0.0-alpha.3","maintainers":[{"name":"dat-8thwall","email":"dat@8thwall.com"},{"name":"atomarch","email":"atomarch@gmail.com"},{"name":"cmbartschat8","email":"christoph@8thwall.com"},{"name":"waynehsu64","email":"wayne@8thwall.com"},{"name":"kaci8","email":"kaci@8thwall.com"}],"homepage":"https://8thwall.org","bugs":{"url":"https://github.com/8thwall/8thwall/issues"},"bin":{"image-target-cli":"src/index.js"},"dist":{"shasum":"fb41295d66029b520285da7e4ade44bbd3a219ef","tarball":"https://registry.npmjs.org/@8thwall/image-target-cli/-/image-target-cli-1.0.0-alpha.3.tgz","fileCount":15,"integrity":"sha512-m0rRPZgyw9Gu4HFtAD2pAnrlMzD3Te90MfNbglruCPP0UdA2NGYKmhmB3A+p0zAcwEPMnJbnJtIndN7SVdC15w==","signatures":[{"sig":"MEUCIAVnf3WarDV3l2yUoQAd1I5dR3rYuoppv3W9MG77pE0hAiEApY++cX+Fs7z+0sib2HDC5C6a88fHHtw6EGQwzfpNscM=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":45574},"main":"src/index.js","type":"module","gitHead":"f1a0ad515b9811312748db6c27fd4a9ef29cedf7","scripts":{"test":"npx tsc -P tsconfig.json && node --test src/*.test.js"},"_npmUser":{"name":"cmbartschat8","email":"christoph@8thwall.com"},"repository":{"url":"git+https://github.com/8thwall/8thwall.git","type":"git","directory":"apps/image-target-cli"},"_npmVersion":"10.9.3","description":"Generate 8th Wall Image Target Metadata","directories":{},"_nodeVersion":"22.20.0","dependencies":{"sharp":"^0.34.5"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"typescript":"^5.9.3","@types/node":"^25.2.3","@types/sharp":"^0.31.1"},"_npmOperationalInternal":{"tmp":"tmp/image-target-cli_1.0.0-alpha.3_1772581007361_0.0953756519884903","host":"s3://npm-registry-packages-npm-production"}},"1.0.0":{"name":"@8thwall/image-target-cli","version":"1.0.0","keywords":["8thwall","image","targets","tracking"],"author":{"name":"8th Wall Team"},"license":"MIT","_id":"@8thwall/image-target-cli@1.0.0","maintainers":[{"name":"dat-8thwall","email":"dat@8thwall.com"},{"name":"atomarch","email":"atomarch@gmail.com"},{"name":"cmbartschat8","email":"christoph@8thwall.com"},{"name":"waynehsu64","email":"wayne@8thwall.com"},{"name":"kaci8","email":"kaci@8thwall.com"}],"homepage":"https://8thwall.org","bugs":{"url":"https://github.com/8thwall/8thwall/issues"},"bin":{"image-target-cli":"src/index.js"},"dist":{"shasum":"5a0effff96a8cb0344eab8a36d396166d81e846f","tarball":"https://registry.npmjs.org/@8thwall/image-target-cli/-/image-target-cli-1.0.0.tgz","fileCount":15,"integrity":"sha512-ugAUhyiPUH9ppJom9y/ehlUVcIVA08e4i+MhJvSKcMjhZEUxw9putfcjRU/fUb4bgIr9jrC6AJYfnh1ATj+AQA==","signatures":[{"sig":"MEUCIFK59AlwVcSZO0J88vQkgf1z2K5zCQN1boi8XgeEUcmrAiEA/CtrLKVuV2bifqMA9HnPyFAs+Lra63pvWkNnu9ojNXg=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":45574},"main":"src/index.js","type":"module","gitHead":"86ee640483d0eaf6520da629e40a6a09b71d8bc6","scripts":{"test":"npx tsc -P tsconfig.json && node --test src/*.test.js"},"_npmUser":{"name":"cmbartschat8","email":"christoph@8thwall.com"},"repository":{"url":"git+https://github.com/8thwall/8thwall.git","type":"git","directory":"apps/image-target-cli"},"_npmVersion":"10.9.3","description":"Generate 8th Wall Image Target Metadata","directories":{},"_nodeVersion":"22.20.0","dependencies":{"sharp":"^0.34.5"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.9.3","@types/node":"^25.2.3","@types/sharp":"^0.31.1"},"_npmOperationalInternal":{"tmp":"tmp/image-target-cli_1.0.0_1772581226698_0.6866723959889078","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2026-03-03T22:54:28.318Z","modified":"2026-04-07T22:49:11.850Z","1.0.0-alpha.0":"2026-03-03T22:54:28.696Z","1.0.0-alpha.1":"2026-03-03T23:06:49.820Z","1.0.0-alpha.2":"2026-03-03T23:08:07.191Z","1.0.0-alpha.3":"2026-03-03T23:36:47.487Z","1.0.0":"2026-03-03T23:40:26.868Z"},"bugs":{"url":"https://github.com/8thwall/8thwall/issues"},"author":{"name":"8th Wall Team"},"license":"MIT","homepage":"https://8thwall.org","keywords":["8thwall","image","targets","tracking"],"repository":{"url":"git+https://github.com/8thwall/8thwall.git","type":"git","directory":"apps/image-target-cli"},"description":"Generate 8th Wall Image Target Metadata","maintainers":[{"email":"christoph@8thwall.org","name":"cmbartschat8"},{"email":"kaci@8thwall.org","name":"kaci.gl"}],"readme":"# Image Target CLI\n\nThis CLI tool allows the creation of image targets in the format supported by the\n[Offline Engine](https://8th.io/xrjs).\n\n## Usage\n\n```\nnpx @8thwall/image-target-cli@latest\n```\n\nYou will be prompted to enter an image path, select crop, and choose a folder/image target name. You can either use a default centered crop, or choose your crop dimensions according to this diagram:\n\n![Diagram showing an original image dimension of 2000x2000, then a crop being applied by offsetting the top left corner by the top and left parameters, and reducing the width and height of the crop using width and height parameters](./docs/flat-diagram.jpg)\n\nIf you choose a cylindrical geometry, you will also be prompted for the cylinder circumference and target width. See the diagram below for a visualization. The choice of units (mm vs inches) will not affect tracking behavior, so the measurements can also be scale-free.\n\n![3D Visualization showing two views of a cylinder with a label wrapped around the side. One view shows the entire top circle of the cylinder highlighted. The other view shows the top edge of the label highlighted, which is about one third of the full circumference](./docs/cylinder-diagram.jpg) \n\nFor conical images, wider top and wider bottom shapes are both supported. The below image shows the input format, with the label curving around the shape of a large circle. For wider bottom images, the arc of the label should curve the opposite direction. You will be prompted for the outer radius and inner radius of the label's curve. You'll also input the angle of the cone covered by label. If you choose to customize the crop, you'll be cropping against the flattened geometry image, as shown below.\n\n![Diagram showing a conical image target as it is processed. Initially the label is aligned to a section of a ring, with rounded top and bottom edges. The same label is shown flattened to a rectangle, with right angled sides. The flattened label displays a crop being applied by offsetting the top left corner by the top and left parameters, and reducing the width and height of the crop using width and height parameters.](./docs/cone-diagram.jpg) \n\nOn generation, the following will be outputted:\n\n- Metadata within a json file\n- Original image\n- Geometry image (for conical)\n- Cropped image\n- Thumbnail image (263x350)\n- Luminance image (grayscale, 480x640)\n\nGenerated image targets can be loaded into the engine by adding this code to your project:\n\n```\nconst onxrloaded = () => {\n  XR8.XrController.configure({\n    imageTargetData: [\n      require('../image-targets/target1.json'),\n      require('../image-targets/target2.json'),\n    ],\n  })\n}\nwindow.XR8 ? onxrloaded() : window.addEventListener('xrloaded', onxrloaded)\n```\n\nThe `imagePath` field of the json data will tell the engine where to load the tracked image, which\nwill have its features extracted and compared to the camera feed.\n","readmeFilename":"README.md"}