Setup

MyScript iink SDK makes it easy to get started. This page helps you set up a development environment, get a certificate and play with provided example applications.

Setting up a development environment

To develop with iink SDK C++ API, you need a C++ compiler.

To run the example or use the provided reference UI implementation, you will need:

Qt 6.5.2 or higher 6.5 version.
CMake 3.16 or higher

As the example project is based on a CMake file, it is not tied to the use of a particular IDE. We recommend:

Xcode for Mac platforms
Visual Studio for Windows platforms

Example applications

MyScript iink SDK comes with example applications illustrating how to use key APIs:

The GetStarted example is a good starting point to discover MyScript iink SDK.
The Demo example is a more advanced integration that you can refer too, once familiar with MyScript iink SDK.

A custom compilation step will download the minimal set of recognition assets required for the example to run. More assets (e.g. to support other recognition languages) can be downloaded from MyScript Developer Portal.

A reference implementation for the platform-specific integration layer can be found alongside the examples. It covers aspects such as rendering that the low-level iink SDK does not provide out-of-the-box for flexibility and portability reasons.

The source code of both the examples and the reference implementation is released under the Apache 2.0 license. You can reuse it into your own projects without any particular restriction.

Getting a certificate

A certificate is a binary "key" provided by MyScript that is required to enable iink SDK in an application.

MyScript-provided examples expect it to be located at a specific location (see instructions below).
For your own application, you can place it where you want, provided that it is accessible to instantiate the iink runtime.

Developer Portal certificates

C++ API certificates are only available on demand.

Partner certificates

It comes embedded in a source file contained in the <customer_name>.vo_iink_sdk.zip package that you can download from your account on the MyScript Partners website. You should extract the certificate source file from this .zip archive to include it in your project.

If you are currently evaluating the technology, your certificate may be time-limited. Make sure to apply for an unlimited certificate to deploy your solution to production.

Playing with the examples

To run it, just follow the following instructions:

Step 1: Unzip the following libraries at the same location:

myscript-iink-api-cpp.zip
myscript-iink-examples-qt.zip
myscript-iink-recognition-diagram.zip
myscript-iink-recognition-math.zip
myscript-iink-recognition-raw-content.zip
myscript-iink-recognition-text-en_US.zip
myscript-iink-lib-mac.zip, myscript-iink-lib-lin.zip or myscript-iink-lib-win.zip depending on your platform.
<customer_name>.vo_iink_sdk.zip
On macOS, when uncompressing the libraries, we recommend you to use the following command line: find . -name "*.zip" -exec unzip {} ";". This should avoid some issues with the default unarchiver that will lose files when encountering duplicated folders.

Step 2: Create a _build folder in that same location. Now, your root folder structure shall be something like:

certificate
iink
recognition-assets
_build

Step 3: Open a command prompt and navigate to the _build folder.

Step 4: Run CMake to generate the project files from the ../iink/examples/qt source directory

Step 5: Open the solution or XCode project that was generated into the _build folder, compile it and launch it.

Building your first interactive ink application

To guide you through the fundamentals of iink SDK, this documentation explains some key concepts and provides you with code portions that are relevant for a simple iink SDK integration.

The guide consists of the following steps:

While introducing the different concepts one-by-one in a logical manner, this guide is written in a way that allows you to refer to a particular aspect at any time, even if you don't strictly follow the intended order.

Ready? Let's start!