Examples & Tutorials
The following examples should give you an overview of the capabilities offered by the Wikitude SDK. Each sample is capable of running without modifications on all supported platforms.
Each of the included examples is structured as following:
index.html: entry point for the experience
css/*: css style sheets required
assets/*: contains images, 3D models and tracker files
js/clientrecognition.js file). Code which is mentioned in the description of the examples can be found in this file, if not explicitly stated otherwise.
Including the architect.js library
architect.js. You will notice that include in every
index.html of the samples provided. The include has to look like the following starting with 5.3. The actual file will be injected by the Wikitude SDK on run-time, so don't worry if you see a
404 - Not found in case you try to download the file. Even if it looks like the Wikitude SDK is loading this file remotely, it will only be replaced locally without any network connection opening up.
Including architect.js prior to Wikitude SDK 5.3
Prior to Wikitude SDK 5.3 the include was differently made and used a custom protocol handler named
architect:// - this conflicted with support for ATS (App Transport Security) for iOS. Note, that if you want to comply to ATS you need to use Wikitude SDK 5.3 or later. Please have a look at the corresponding migration guide.
Samples on GitHub
If you are just interested in browsing through the code of the augmented reality experience you can also find the entire source code of the samples on GitHub
Android SDK Examples
This section describes the
SDK Sample project in detail and highlights the main features and use-cases of the Wikitude SDK.
The project is part of the SDK bundle and is an Android Studio project, ready to run on any of the supported Android devices.
Note: You cannot run Wikitude SDK project on Android Emulator due to OpenGL restrictions.
Run through the setup guide, install the sample project on your device and scroll through the sample list.
asset folder contains implementation of the various ARchitect Worlds.
Implementation of the native Android activities is available in the
- Download latest Android SDK through the Android Studio Bundle (either Mac OS or Windows)
- From the main menu select
Open an existing Android Studio projectwhich will open the import wizard.
- Navigate to the
SDKExamplesproject folder in your filesystem.
Chooseto start the import.
- From the menu bar select
Appearance & Behavior->
- Ensure you have very latest SDK (or at least 16) installed in the
- Right click on the project and select
Open Module Settings.
Flavorsmake sure you have an equally appropriate version selected.
- Plug in the device via USB.
- From the menu bar select
- The sample application is then installed onto your device
Define a method named
There are several ways to create a JSON in Android.
Sometimes events like a click in your AR experience should cause a reaction in native Android, like launching another screen when clicking a placemark or image target. To achieve that you need to add a
AR.platform.sendJSONObject call will fire an event in your listener (e.g.