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 for iOS, you will need:

  • Xcode
  • Git (to clone the GitHub example repository)

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 to, once familiar with MyScript iink SDK.

The code is available on GitHub.

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

  • If you have just registered with MyScript Developer Portal, you should have received a certificate by mail that will let you run the provided GetStarted and Demo examples. The certificate comes embedded in a source file that you should include in your project.
  • If not - or to activate iink SDK with your own applications - please follow the on-device license management instructions.

More details on certificates and license management can be found in the dedicated support section.

Developer Portal certificates are specifically generated for each app identifier. You cannot directly reuse the certificate inside your own application.

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 them, just follow the following instructions:

Step 1: Clone the MyScript Git repository containing the examples for the iOS platform and navigate to the root of the folder containing the applications:

git clone https://github.com/MyScript/interactive-ink-examples-ios.git
cd interactive-ink-examples-ios

Step 2: Navigate to the root folder of the example application you want to run:

  • cd Examples/GetStarted or cd Examples/Demo

Step 3: Replace MyCertificate.c file in the MyScriptCertificate directory with your certificate.

Step 4: Open the Xcode workspace, compile and run the default target.

  • When opening the project with iink SPM dependency, Xcode will read the SPM’s Package.swift file to get the URL of the MyScriptSDK-libiink.xcframework.zip file and will automatically download and unzip it.

Swift Package Management guidelines

To add iink SPM package dependency to your App Xcode project:

  • Open the “Package Dependency“ dialog and enter the URL of the public GitHub repository "https://github.com/MyScript/interactive-ink-packages-ios" in the bottom right search field.
  • You can specify the version by setting the “Dependency Rule“: the list of releases is available here.
  • Then click on “Add Package“ button.