Unity Getting Started

Integrating the IV Metrics SDK for Unity is the first step towards recording user gameplay and tracking their progress in your mobile game.

Download the latest IV Metrics SDK

Prerequisites

The following prerequisites are needed to run IV Metrics:

Compile-Time

• Minimum Unity 2020.3
• Minimum Android API 21 or higher
• Minimum iOS 12 target
• Project contains Google’s External Dependency Manager for Unity

Runtime

• Gameplay recording requires:
  • Minimum 1.5 GB total device RAMMinimum 1.5 GB total device RAM

Configure SDK

1. Download the latest IVMetrics-Unity-vX.XX.XX.unitypackage package.
2. Import the downloaded package into your unity project – Assets > Import Package > Custom Package…
3. If this is the first time you have imported the IV Metrics SDK into your project, the IV Metrics Setup Wizard will appear after compilation has finished. Here you can input the following:
   1. Developer Key and Project Key (These can be found in the project setup page for the project you created)
   2. Enable the Consent Form. If enabled, the IV Metrics consent form will appear for the user if chosen to be recorded. All data is anonymous, however updated Apple Developer License Agreement requires user consent before recordings can take place.
   3. Input your company’s Privacy Policy URL, the consent form contains a button to link to your company’s privacy policy if the user wishes to view it before consenting to having their gameplay recorded. Ignore this if the consent form is disabled.
   4. Verbose Logging should only be enabled for development purposes and should be disabled before building for production.
4. If this is NOT the first time you have used the IV Metrics SDK within your project, you can go to the menu item IV Metrics > Edit Settings… to confirm or modify the SDK configuration. More options can be changed here:
   1. If the Consent Form is enabled, you may decide how to trigger it showing by setting Consent Show Trigger. Setting this to Manual leaves it up to you to show either the builtin consent form or your own version.
   2. Show Recording Icon; You can disable this indicator that appears when a recording is underway on iOS, however, updated Apple Developer License Agreement requires some type of indicator to inform the user of a recording taking place, so you must show your own version and use the listener API to receive callbacks from the SDK when to show/hide your indicator.
   3. Change the placement of the builtin recording indicator (if enabled) to either a preset position, or a custom vector with a preset anchor.
5. (Android Only) Force Resolve using the External Dependency Manager.

Initialise the IV Metrics SDK

Before any SDK functionality can commence, the SDK must be initialised. Fortunately with this Unity SDK, it will initialise itself before the first scene loads so it is only necessary to make sure you have configured the “IVMetricsSettings.asset” correctly.

Setup Complete

Your project is now set up to use IV Metrics within the Unity Editor and when deploying to Android and iOS devices. You should begin to see devices appearing in requests on the panel when the project is played.

To begin receiving recordings from devices, go to the IV Metrics panel and create a new request.

Consent Form

As obtaining user consent is now required on iOS (it’s still optional on other platforms), you can let the SDK handle showing it’s builtin consent form to the user, or you can manually show it or your own version. The IV Metrics SDK now has the following APIs you can use for the consent purposes:

• IVMetrics.IVMetricsManager.ConsentStatus
  • Returns: IVConsentStatus
  • Description: Set or Get the consent status stored by the SDK
• IVMetrics.IVMetricsManager.ShowConsentForm()
  • Returns: void
  • Description: Attempts to show the buitin consent form if it is available on your target platform.

iOS also requires some type of indicator so the user is aware that a recording is taking place. If you disable the builtin indicator on the IVMetricsSettings asset, use the following listener APIs so you can use a custom version:

• IVMetrics.IVMetricsManager.AddRecordingDotEnabledListener(Action<bool>)
  • Returns: void
  • Description: Add to this listener to recevie a callback from the sdk when to show/hide your custom recording indicator.
• IVMetrics.IVMetricsManager.RemoveRecordingDotEnabledListener(Action<bool>)
  • Returns: void
  • Description: Remove an action if it was previously added with the above API

If you are using the builtin recording indicator, you can change the position of it either on the IVMetricsSettings asset, or through code with the following APIs:

• IVMetrics.IVMetricsManager.SetRecordingDotPosition(IVRecordingDotPosition)
  • Returns: void
  • Description: Sets the position of the builtin recording indicator to one of the preset positions defined in the IVRecordingDotPosition enum
• IVMetrics.IVMetricsManager.SetRecordingDotPosition(Vector2, IVRecordingDotPosition)
  • Returns: void
  • Description: Set the positions of the builtin recording indicator to a custom vector relative to the second parameter which is a preset anchor position.

Next Steps

Now the IV Metrics SDK is implemented, here’s some additional things you can do with the IV Metrics SDK:

Events API

Legacy Support Solutions

Here are some solutions you may need to know when targeting legacy/older versions of Unity. It is not an exhaustive list so if you notice this SDK clashing with Unity in the Editor or when deployed, please don’t hesitate to contact our Support Team.

Android

• N/A

iOS

• New Unity versions (2022+) may require you to manually add the IVMetricsCore.framework to the UnityFramework.framework target’s Frameworks and Libraries list in XCode.
• Some versions of Unity and XCode may require you to embed the IVMetricsCore.framework into the UnityFramework.framework target.