Skip to content

Manual installation instructions

Jump to bottom
Sam Dozor edited this page May 5, 2016 · 19 revisions

Manual Installation

Follow the steps below if you'd prefer to include the SDK manually, without a dependency manager:

  1. Navigate to the releases section and download the manual-install.zip attached to the latest release.

  2. The manual-install archive contains the following:

    • Simulator/mParticle_Apple_SDK.framework - dynamic framework containing all valid architectures for both the simulator and physical devices.
    • App Store/mParticle_Apple_SDK.framework - this does not contain the simulator architecture. Use this .framework when shipping to the App Store.

  3. Move mParticle_Apple_SDK.framework into your project directory. Note that the framework must be located in the same directory as your project (.xcodeproj or .xcworkspace), or in a nested directory.

  4. In Xcode navigate to the Embedded Binaries section under the General configuration tab of your project and add the mParticle_Apple_SDK.framework

  5. Add the following required dependencies to Linked Frameworks and Libraries:

    • Accounts.framework
    • CoreGraphics.framework
    • CoreTelephony.framework
    • Foundation.framework
    • libc++
    • libsqlite3
    • libz
    • Security.framework
    • SystemConfiguration.framework
    • UIKit.framework

  6. The following libraries should be included in your project, but can be marked as optional:

    • AdSupport.framework
    • iAd.framework

  7. The following library is optional:

    • CoreLocation.framework - Include it if location tracking features are needed

Adding kits

If you would like to additionally include any kits there are several additional steps:

Add MPARTICLE_MANUAL_INSTALL preprocessor macro

  1. In your Xcode project, navigate to your target->Build Settings
  2. Search for "GCC_PREPROCESSOR_DEFINITIONS"
  3. Click the + button and add MPARTICLE_MANUAL_INSTALL to the list

Navigate to the kit repository and download the latest code

  1. See here for all kit repositories
  2. Each repository contains a directory ie "MParticle-Localytics", which contains the code for the kit (typically MPKitFoo.h and .m).
  3. Download the latest code from step 2 and drag it into your project

Follow the manual instructions for the underlying SDK of each Kit

This will typically involve downloading their framework and including it in your project along with adding any additional dependencies that don't overlap with mParticle's dependencies.

Submitting the App Store

You will receive an error if you attempt to submit to the App Store including Simulator/mParticle_Apple_SDK.framework - simply swap it out for App Store/mParticle_Apple_SDK.framework when you're ready to submit.

Clone this wiki locally