Getting Started#

System requirements#

  • Xcode minimum SDK: 9

  • iOS minimum version: 11.0

Adding the App Kit to your project#

You should have been provided with mupdfdk.xcframework & mupdf_default_ui.xcframework files for your project. These files are collectively the MuPDF App Kit and contain all the App Kit code required for your projects.

The linked frameworks should be added to your project file system and then referenced in the Frameworks section in Xcode.

See the Xcode screenshot below for an example:

_images/xcode-frameworks.png

Xcode embedding frameworks

Note

If there is an compile time error which complains that the linked framework cannot be found ensure to validate your workspace in Xcode with:

Build Settings -> Build Options -> Validate Workspace = YES

License Key#

To remove the MuPDF document watermark from your App, you will need to use a license key to activate App Kit.

To acquire a license key for your app you should:

  1. Go to artifex.com/appkit

  2. Purchase your license(s)

  3. In your application code add the API call to activate the license

Note

App Kit does not require network connection to validate a license key and there is no server tracking or cloud logging involved with key validation.

Using your License Key#

If you have a license key for MuPDF App Kit, it will be bound to the App ID which you will have defined at the time of purchase. Therefore you should ensure that the App ID in your iOS project is correctly set. This is defined in the Bundle Identifier for the product $(PRODUCT_BUNDLE_IDENTIFIER).

Once you have confirmed that your Bundle Identifier is correctly named, then call the following API early on in your application code:

import mupdfdk
...

let key:String = "put your license key here"
MuPDFDKDocumentViewController.unlockAppKit(key)

Note

The API call to set the license key should be made before you instantiate an App Kit DocumentView.


This software is provided AS-IS with no warranty, either express or implied. This software is distributed under license and may not be copied, modified or distributed except as expressly authorized under the terms of that license. Refer to licensing information at artifex.com or contact Artifex Software, Inc., 39 Mesa Street, Suite 108A, San Francisco, CA 94129, USA, for further information.Discord logo