0.3.2 • Published 4 years ago
org.swiftable.jabberwocky.cordova.plugin v0.3.2
Jabberwocky Head Tracking Cordova Plugin for iOS
Head Tracking Cursor for Cordova (iOS) apps!
About
The Jabberwocky® Cordova Plugin wraps the Jabberwocky® Head Tracking Kit (JabberwockyHTKit). It is an open-source iOS framework, developed by Swiftable LLC, that provides a touch-free interface for existing iOS applications. Jabberwocky enables users to interact with an application by just moving their head. Head movement translates into the movement of a mouse-like cursor on the screen. Cursor location and blink events can be subscribed to allowing actions to be performed in Cordova.
See JabberwockyHTKit for more information.
Installation
Create Cordova Project
cordova create jabberwocky-cordova-app example.jabberwocky.cordova JabberwockyCordovaExample && cd jabberwocky-cordova-app
Set Correct Deployment Target
- Set the iOS deployment target to
12.0
in the rootconfig.xml
<widget ...>
...
<preference name="deployment-target" value="12.0" />
...
</widget>
Create iOS platform
cordova platform add ios
Install Jabberwocky Cordova Plugin
cordova plugin add https://github.com/swiftablellc/jabberwocky-cordova-plugin-ios.git
Initialize Jabberwocky in Cordova
- Modify
onDeviceReady
function inplatforms/ios/www/js/index.js
onDeviceReady: function() {
...
var jabberwocky = window.plugins.JabberwockyHeadTracking;
jabberwocky.configure(jabberwocky.getDefaultCordovaFeatures(), function() {
jabberwocky.enable(function() {
console.log("Jabberwocky Enabled!");
});
});
...
}
Test
- Run on a physical device (FaceID capability required).
Release (Swiftable Devs Only)
- Navigate to jabberwocky-head-tracking-kit-ios-binary directory
git pull
- Update the JabberwockyHTKit.podspec file.
- Modify the version number in plugin.xml.
- Modify the version number in the package.json.
- Prepare Release Commit
git add *
git commit -m 'Preparing <version> for release.'
- Tag version
git tag -a <version> -m 'Tagging Release <version>'
git push origin --tags
- Publish to NPM
npm publish ./
- IMPORTANT - Finish pushing the commit to master.
git push origin master
- We don't do this before, because we can amend the commit until publish succeeds.
Trademarks
Jabberwocky® is a registered trademark of Swiftable LLC.
License
0.3.2
4 years ago