https://github.com/tzachari/cordova-plugin-webxr

Add AR content to your iOS app using the WebXR Device API
https://github.com/tzachari/cordova-plugin-webxr

app ar arkit augmented-reality cordova immersive-web ios mixed-reality mozilla plugin polyfill virtual-reality vr w3c webar webvr webxr xr

Last synced: 17 days ago
JSON representation

Add AR content to your iOS app using the WebXR Device API

• Host: GitHub
• URL: https://github.com/tzachari/cordova-plugin-webxr
• Owner: tzachari
• Created: 2019-08-14T23:20:06.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-10-25T22:30:50.000Z (about 5 years ago)
• Last Synced: 2024-10-10T08:33:28.746Z (26 days ago)
• Topics: app, ar, arkit, augmented-reality, cordova, immersive-web, ios, mixed-reality, mozilla, plugin, polyfill, virtual-reality, vr, w3c, webar, webvr, webxr, xr
• Language: Swift
• Homepage:
• Size: 4.3 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Cordova WebXR Plugin

Add augmented reality content to your app using the WebXR Device API ([Mozilla's version](https://github.com/mozilla/webxr-polyfill/)).  

This is intended to support the same content as Mozilla's [iOS WebXR Viewer](https://apps.apple.com/us/app/webxr-viewer/id1295998056).

## Installation

Install using the Apache Cordova command line:

    cordova plugin add cordova-plugin-webxr

## Try It Out

To 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/):

    

The 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)

## Options

The plugin provides a set of a configurable options:

- **WEBXR_AUTHORIZATION**: Sets what is shared with a page that uses the WebXR API

  - `denied`: Shares no world sensing data & no video

  - `minimal` (default): Shares minimal world sensing data, but no video

  - `lite`: Shares one real world plane & enables face-based experiences, but no video

  - `worldSensing`: Shares full world sensing data, but no video

  - `videoCameraAccess`: Shares full world sensing data & video feed

- **GRAPHICS_FRAMEWORK**: Specifies which graphics framework to use

  - `sceneKit` (default): Uses [SceneKit](https://developer.apple.com/scenekit/)

  - `metal`: Uses [Metal](https://developer.apple.com/metal/) (experimental)

- **CAMERA_USAGE_DESCRIPTION**: Describes to user why camera access is required

  - Default: `This app uses the camera for augmented reality`

To set these options, specify them when adding the plugin, e.g:

    cordova plugin add cordova-plugin-webxr --variable GRAPHICS_FRAMEWORK=metal

Or add them within the plugin's tag in config.xml, e.g:

    

        

    

## NOTE: Mozilla WebXR ≠ W3C WebXR (yet)

Mozilla 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/).

As such, some features are currently broken.

This plugin will be updated as the API stabilizes.

## Dependencies

- **iOS 12 / ARKit 2**: The plugin only works with [ARKit-compatible devices](https://www.apple.com/ios/augmented-reality/#ac-globalfooter) & requires an iOS Deployment Target ≥ 12.0. It will automatically set the project's target to 12.0, unless specified otherwise in config.xml.

- **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.

- **WKWebView**: The plugin requires WKWebView. It will automatically install `cordova-plugin-wkwebview-engine`, if not already in use.

## Credits

This plugin is based on the source for Mozilla's WebXR Viewer ([webxr-ios@f820224](https://github.com/mozilla-mobile/webxr-ios/tree/f820224eb7cc4577096fff4a74563d440e9e49c6))