Git Product home page Git Product logo

jabberwocky-cordova-plugin-ios's Introduction

Jabberwocky Head Tracking Cordova Plugin for iOS

GitHub tag (latest SemVer) Platform GitHub

Head Tracking Cursor for Cordova (iOS) apps!

cordova-gif

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

Preflight Verification

  • JabberwockyHTKit requires CocoaPods version 1.10.0 or greater to operate correctly.
pod --version

1.10.0
  • An update to the newest version can be done using the following command:
sudo gem install cocoapods

Create Cordova Project

cordova create jabberwocky-cordova-app example.jabberwocky.cordova JabberwockyCordovaExample && cd jabberwocky-cordova-app

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 in platforms/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)

  1. Navigate to jabberwocky-cordova-plugin-ios directory
    • git pull
  2. Update Version
    • Modify the version number in plugin.xml.
    • Run plugman createpackagejson ..
  3. Prepare Release Commit
    • git add *
    • git commit -m 'Preparing <version> for release.'
  4. Tag version
    • git tag -a <version> -m 'Tagging Release <version>'
    • git push origin --tags
  5. Publish to NPM
    • npm publish ./
  6. 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

Apache 2.0 License

jabberwocky-cordova-plugin-ios's People

Contributors

broag avatar whitmer avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

whitmer

jabberwocky-cordova-plugin-ios's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.