- Introduction
- Installation
- Ionicitude Usage
- App Usage
- Differences with the AR Cordova Sample App
- Contribution and Issues
- References
- License
This repository contains a demo application for using the Wikitude Cordova Plugin in an Ionic application with the Ionicitude package.
All the AR Worlds contained in the app (in the www/wikitude-worlds folder) are the same as the ones in the Augmented Reality Cordova Sample App, provided by Wikitude, except some minor changes in the 6_BrowsingPois_6_Bonus-CaptureScreen AR World, to comply with Ionicitude specs.
To install and launch this application, you need to do the following:
- Install the Ionic framework (if it's not already on your computer)
- Clone this repository on your computer
- Restore the state of the Ionic project (this means basically installing the plugins, notably the Wikitude Cordova Plugin) with:
ionic state restore
- Follow the Wikitude License Key part of the Ionicitude documentation to obtain and use your personnal Trial Key for the Wikitude Cordova Plugin.
- Install whichever platform you want to build and install the app on:
ionic platform add ios
or
ionic platform add [email protected] (This is important ! See here for more details)
- Run the app on the platform(s) you added:
ionic run ios
or
ionic run android
Plase note that this step requires that you have a working environment for either of these platforms. If this is not the case, please refer to this iOS Guide or this Android Guide from the Cordova website.
The Ionicitude package is used to manage the Wikitude Cordova Plugin in this Ionic app.
The code demonstrating this usage can be found in the www/js/app.js file.
The app is fairly easy to use. The main screen shows you a list of sample AR Worlds demonstrating what you can achieve with the Wikitude Cordova plugin. Simply click on one of these AR World to see it in action.
Some of these AR World request you to scan a particular photo or image. They can be found on the project folder: www/wikitude-worlds/target_images_examples.pdf
The code for each AR World can be found under the www/wikitude-worlds folder.
Differences with the Wikitude Cordova Sample App
The Wikitude Cordova Sample App allows you to launch an AR World that is deploy on a distant server and accessible via an URL.
This feature is not present in the Ionicitude Demo App because it's not supported by the current version (0.2.1-alpha) of Ionicitude.
In the Wikitude Cordova Sample App, this AR World uses the front camera (if available) when launching.
This is not the case in the Ionicitude Demo App, because the current version (0.2.1-alpha) of Ionicitude doesn't support individual AR World settings.
Any contribution or enhancement to this Ionicitude Demo App are welcomed and will be appreciated.
If you experience bugs or strange behaviors while testing this app, please do not hesitate to raise an issue about it.
In both case, please, use the GitHub tools of this repository (merge request and issues) rather than sending a personnal email. This way, it will be easier to manage and keep track of what's happening. Thanks !
This demo application is licensed under both the MIT Licence (as requested by Ionicitude) and the Apache v2.0 License (as requested by the Augmented Reality Cordova Sample App).
See LICENCE-MIT.txt and LICENCE-APACHE.txt, respectivly, for more information.