{"id":17502639,"url":"https://github.com/tzachari/cordova-plugin-webxr","last_synced_at":"2025-04-23T03:50:48.185Z","repository":{"id":46605533,"uuid":"202439607","full_name":"tzachari/cordova-plugin-webxr","owner":"tzachari","description":"Add AR content to your iOS app using the WebXR Device API","archived":false,"fork":false,"pushed_at":"2019-10-25T22:30:50.000Z","size":4514,"stargazers_count":6,"open_issues_count":3,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-19T17:07:05.776Z","etag":null,"topics":["app","ar","arkit","augmented-reality","cordova","immersive-web","ios","mixed-reality","mozilla","plugin","polyfill","virtual-reality","vr","w3c","webar","webvr","webxr","xr"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tzachari.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-14T23:20:06.000Z","updated_at":"2024-12-21T05:09:19.000Z","dependencies_parsed_at":"2022-08-26T17:31:32.629Z","dependency_job_id":null,"html_url":"https://github.com/tzachari/cordova-plugin-webxr","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzachari%2Fcordova-plugin-webxr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzachari%2Fcordova-plugin-webxr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzachari%2Fcordova-plugin-webxr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tzachari%2Fcordova-plugin-webxr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tzachari","download_url":"https://codeload.github.com/tzachari/cordova-plugin-webxr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250366685,"owners_count":21418768,"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":["app","ar","arkit","augmented-reality","cordova","immersive-web","ios","mixed-reality","mozilla","plugin","polyfill","virtual-reality","vr","w3c","webar","webvr","webxr","xr"],"created_at":"2024-10-19T21:15:05.370Z","updated_at":"2025-04-23T03:50:48.171Z","avatar_url":"https://github.com/tzachari.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cordova WebXR Plugin\n\nAdd augmented reality content to your app using the WebXR Device API ([Mozilla's version](https://github.com/mozilla/webxr-polyfill/)).  \n\nThis is intended to support the same content as Mozilla's [iOS WebXR Viewer](https://apps.apple.com/us/app/webxr-viewer/id1295998056).\n\n\n## Installation\n\nInstall using the Apache Cordova command line:\n\n    cordova plugin add cordova-plugin-webxr\n\n\n## Try It Out\n\nTo quickly test some interactive AR content, set the default source in the project's config.xml to Mozilla's [example site](https://webxr-ios.webxrexperiments.com/):\n\n    \u003ccontent src=\"https://webxr-ios.webxrexperiments.com/\" /\u003e\n\nThe source code for the examples can be found in Mozilla's [webxr-ios-js repo](https://github.com/MozillaReality/webxr-ios-js/tree/develop/examples)\n\n\n## Options\n\nThe plugin provides a set of a configurable options:\n\n- **WEBXR_AUTHORIZATION**: Sets what is shared with a page that uses the WebXR API\n  - `denied`: Shares no world sensing data \u0026 no video\n  - `minimal` (default): Shares minimal world sensing data, but no video\n  - `lite`: Shares one real world plane \u0026 enables face-based experiences, but no video\n  - `worldSensing`: Shares full world sensing data, but no video\n  - `videoCameraAccess`: Shares full world sensing data \u0026 video feed\n\n- **GRAPHICS_FRAMEWORK**: Specifies which graphics framework to use\n  - `sceneKit` (default): Uses [SceneKit](https://developer.apple.com/scenekit/)\n  - `metal`: Uses [Metal](https://developer.apple.com/metal/) (experimental)\n\n- **CAMERA_USAGE_DESCRIPTION**: Describes to user why camera access is required\n  - Default: `This app uses the camera for augmented reality`\n\nTo set these options, specify them when adding the plugin, e.g:\n\n    cordova plugin add cordova-plugin-webxr --variable GRAPHICS_FRAMEWORK=metal\n\nOr add them within the plugin's tag in config.xml, e.g:\n\n    \u003cplugin name=\"cordova-plugin-webxr\" spec=\"^1.17.0\"\u003e\n        \u003cvariable name=\"WEBXR_AUTHORIZATION\" value=\"lite\" /\u003e\n    \u003c/plugin\u003e\n\n\n## NOTE: Mozilla WebXR ≠ W3C WebXR (yet)\nMozilla is in the process of aligning [their version of the API](https://github.com/mozilla/webxr-polyfill/) with the [official draft W3C spec](https://www.w3.org/TR/webxr/).\nAs such, some features are currently broken.\nThis plugin will be updated as the API stabilizes.\n\n\n## Dependencies\n\n- **iOS 12 / ARKit 2**: The plugin only works with [ARKit-compatible devices](https://www.apple.com/ios/augmented-reality/#ac-globalfooter) \u0026 requires an iOS Deployment Target ≥ 12.0. It will automatically set the project's target to 12.0, unless specified otherwise in config.xml.\n\n- **Swift 4**: The iOS source code assumes Swift 4.0. It will automatically install `cordova-plugin-add-swift-support`, if it is not already present.\n\n- **WKWebView**: The plugin requires WKWebView. It will automatically install `cordova-plugin-wkwebview-engine`, if not already in use.\n\n\n## Credits\n\nThis plugin is based on the source for Mozilla's WebXR Viewer ([webxr-ios@f820224](https://github.com/mozilla-mobile/webxr-ios/tree/f820224eb7cc4577096fff4a74563d440e9e49c6))","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftzachari%2Fcordova-plugin-webxr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftzachari%2Fcordova-plugin-webxr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftzachari%2Fcordova-plugin-webxr/lists"}