{"_id":"@8thwall/coaching-overlay","_rev":"2-2ae9789d88c7d9e6c9308f0d71bbb9dc","name":"@8thwall/coaching-overlay","dist-tags":{"alpha":"1.0.0-alpha1","latest":"1.0.0"},"versions":{"1.0.0-alpha1":{"name":"@8thwall/coaching-overlay","version":"1.0.0-alpha1","keywords":["8thwall","coaching overlay","xr","sky","absolute scale","webxr"],"author":{"name":"8th Wall Team"},"license":"MIT","_id":"@8thwall/coaching-overlay@1.0.0-alpha1","maintainers":[{"name":"cmbartschat8","email":"christoph@8thwall.org"},{"name":"kaci.gl","email":"kaci@8thwall.org"}],"dist":{"shasum":"2c4a77eda1e673708a0e41df91d64353c5c31de6","tarball":"https://registry.npmjs.org/@8thwall/coaching-overlay/-/coaching-overlay-1.0.0-alpha1.tgz","fileCount":6,"integrity":"sha512-3ftFtBRa26I63ruL/9nrEgBLMB0WwNrM4dfFBelu9Wv3dAdfeRtUx0pITo+6rIa9TRrNXPBKEUXgUI05iSzkaA==","signatures":[{"sig":"MEQCIBtPdtUIEBHqSRol52Jp7UZMIEEv+ahXVj66IcgkQ15eAiAZVDLbcOQdm0y4sVcgzGvt63/Tbwp4m/2BtbXL+RX29A==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":50348},"main":"index.js","gitHead":"f0c5a4a3eeb87d7cb5f2d79024eb56eca5e1722f","scripts":{"build":"npx webpack","watch":"echo \"Test page will be available at: https://localhost:9003\" && npx webpack-dev-server","prepack":"npm run build && cp src/entry.js index.js"},"_npmUser":{"name":"cmbartschat8","email":"christoph@8thwall.org"},"_npmVersion":"9.6.7","description":"Fallback page displayed when an 8th Wall experience cannot run on the current device","directories":{},"_nodeVersion":"18.17.1","_hasShrinkwrap":false,"devDependencies":{"sass":"^1.94.2","three":"^0.132.2","preact":"^10.5.13","webpack":"^5.103.0","css-loader":"^5.2.6","typescript":"^6.0.2","@babel/core":"^7.14.6","html-loader":"^2.1.2","sass-loader":"^16.0.6","webpack-cli":"^6.0.1","@types/three":"^0.131.0","babel-loader":"^8.2.2","style-loader":"^3.0.0","@babel/runtime":"^7.29.2","@babel/preset-env":"^7.14.7","webpack-dev-server":"^5.2.2","copy-webpack-plugin":"^13.0.1","webpack-bundle-analyzer":"^4.4.2","@babel/preset-typescript":"^7.14.5","@babel/plugin-transform-runtime":"^7.14.5","babel-plugin-transform-react-jsx":"^6.24.1","@babel/plugin-syntax-dynamic-import":"^7.8.3","@babel/plugin-transform-object-assign":"^7.14.5","@babel/plugin-proposal-class-properties":"^7.14.5","@babel/plugin-proposal-optional-chaining":"^7.14.5","@babel/plugin-transform-modules-commonjs":"^7.14.5","@babel/plugin-proposal-object-rest-spread":"^7.14.7","@babel/plugin-proposal-export-default-from":"^7.14.5","@babel/plugin-proposal-export-namespace-from":"^7.14.5"},"_npmOperationalInternal":{"tmp":"tmp/coaching-overlay_1.0.0-alpha1_1785523373108_0.5566167252830589","host":"s3://npm-registry-packages-npm-production"}},"1.0.0":{"name":"@8thwall/coaching-overlay","version":"1.0.0","description":"Fallback page displayed when an 8th Wall experience cannot run on the current device","author":{"name":"8th Wall Team"},"license":"MIT","main":"index.js","scripts":{"build":"npx webpack","prepack":"npm run build && cp src/entry.js index.js","watch":"echo \"Test page will be available at: https://localhost:9003\" && npx webpack-dev-server"},"keywords":["8thwall","coaching overlay","xr","sky","absolute scale","webxr"],"devDependencies":{"@babel/core":"^7.14.6","@babel/plugin-proposal-class-properties":"^7.14.5","@babel/plugin-proposal-export-default-from":"^7.14.5","@babel/plugin-proposal-export-namespace-from":"^7.14.5","@babel/plugin-proposal-object-rest-spread":"^7.14.7","@babel/plugin-proposal-optional-chaining":"^7.14.5","@babel/plugin-syntax-dynamic-import":"^7.8.3","@babel/plugin-transform-modules-commonjs":"^7.14.5","@babel/plugin-transform-object-assign":"^7.14.5","@babel/plugin-transform-runtime":"^7.14.5","@babel/preset-env":"^7.14.7","@babel/preset-typescript":"^7.14.5","@babel/runtime":"^7.29.2","@types/three":"^0.131.0","babel-loader":"^8.2.2","babel-plugin-transform-react-jsx":"^6.24.1","copy-webpack-plugin":"^13.0.1","css-loader":"^5.2.6","html-loader":"^2.1.2","preact":"^10.5.13","sass":"^1.94.2","sass-loader":"^16.0.6","style-loader":"^3.0.0","three":"^0.132.2","typescript":"^6.0.2","webpack":"^5.103.0","webpack-bundle-analyzer":"^4.4.2","webpack-cli":"^6.0.1","webpack-dev-server":"^5.2.2"},"gitHead":"acfe85035e7c0baebf4e8c2011a2b7836a904502","_id":"@8thwall/coaching-overlay@1.0.0","_nodeVersion":"18.17.1","_npmVersion":"9.6.7","dist":{"integrity":"sha512-SsVsSKDOxqfjs6kdgv2a9UYa/fGfFrou8huDntROgjZuBqCVE26T9zElv25UU6qk9ZEEeyVszo1ZAKhdx6fYKQ==","shasum":"23e6c0e3371eae8d57833d14f4fc2401daa486dd","tarball":"https://registry.npmjs.org/@8thwall/coaching-overlay/-/coaching-overlay-1.0.0.tgz","fileCount":6,"unpackedSize":50341,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIHwT++nDqf5IEkx1BRmFKoI3/sQicV+9JEM2GRAPiMrbAiBbCXjdgioujsv/Uaeh3bef7y+J1v+6PFjZNoWEgoErDg=="}]},"_npmUser":{"name":"cmbartschat8","email":"christoph@8thwall.org"},"directories":{},"maintainers":[{"name":"cmbartschat8","email":"christoph@8thwall.org"},{"name":"kaci.gl","email":"kaci@8thwall.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/coaching-overlay_1.0.0_1785524457523_0.14183029939669534"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-31T18:42:52.976Z","modified":"2026-07-31T19:00:57.910Z","1.0.0-alpha1":"2026-07-31T18:42:53.255Z","1.0.0":"2026-07-31T19:00:57.719Z"},"author":{"name":"8th Wall Team"},"license":"MIT","keywords":["8thwall","coaching overlay","xr","sky","absolute scale","webxr"],"description":"Fallback page displayed when an 8th Wall experience cannot run on the current device","maintainers":[{"name":"cmbartschat8","email":"christoph@8thwall.org"},{"name":"kaci.gl","email":"kaci@8thwall.org"}],"readme":"# Coaching Overlay\n\nHelpful user prompts for Absolute Scale and Sky Effects projects\n\n![Preview of the absolute scale showing a splash image and QR code](https://raw.githubusercontent.com/8thwall/8thwall.github.io/refs/heads/main/static/images/coachingoverlay-example.jpg)\n\n## Usage\n\nSee https://8thwall.org/docs/engine/guides/coaching-overlays for a complete guide to customizing the coaching overlay.\n\n### Option 1: Script tag\n\n```html\n<script src=\"https://cdn.jsdelivr.net/npm/@8thwall/coaching-overlay@1/dist/coaching-overlay.js\" crossorigin=\"anonymous\"></script>\n```\n  \n### Option 2: npm\n\n```bash\nnpm install @8thwall/coaching-overlay\n```\n\nYou will need to copy the included artifacts into your dist folder, for example in webpack:\n\n```js\nnew CopyWebpackPlugin({\n  patterns: [\n    {\n      from: 'node_modules/@8thwall/coaching-overlay/dist',\n      to: 'external/coaching-overlay',\n    }\n  ]\n})\n```\n\nYou can then load the library by adding the following to index.html:\n\n```html\n<script src=\"./external/coaching-overlay/coaching-overlay.js\"></script>\n```\n\nWhen you import the package, a simple helper for accessing window.CoachingOverlay/window.SkyCoachingOverlay is provided. The expectation is still that the script tag is added to the HTML. Note that configuring the overlays in this way is not required for A-Frame projects as the configuration is passed through the component schema.\n\n```js\nimport * as CoachingOverlay from '@8thwall/coaching-overlay'\nCoachingOverlay.AbsoluteScale.configure({\n  promptColor: '#00ff00',\n})\nCoachingOverlay.Sky.configure({\n  promptText: 'Look at the sky!',\n})\n```\n\n## Development\n\n- Start a local server with `npm run watch`\n- Try out the test at `https://localhost:9003/test/`. \n- In order to use your local version in a project, replace the existing script tag with `<script crossorigin=\"anonymous\" src=\"https://localhost:9003/coaching-overlay.js\"></script>`\n","readmeFilename":"README.md"}