WebGL Getting Started

Integrating the IV Metrics SDK for Web 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:

Build-Time

• Requires use of HTML canvas to render your application.

Runtime

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

Configure Your App

1. Download the latest ivmetrics-web.js library
2. Drag the downloaded library into your project dependencies

Initialise the IV Metrics SDK

You must initialise the SDK as soon as you can within the app’s lifecycle, else you risk missing data that could be crucial to getting the full picture of each user’s experience within your game.

The following things are required to be passed through to the IVMetrics.Create(…); function, they MUST be NonNull:

1. String developerKey
   1. You can find this Key on the IV Metrics panel.
2. String projectKey
   1. You can also find this Key on the IV Metrics panel.
3. boolean verboseLogging
   1. This should only be enabled for debugging purposes. You must set this to false when building for production
4. String appVersion
   1. Pass through your app version (e.g. 1.28.1) to allow accurate collection for requests.

An example of how you could initialise the SDK:

const MyAppRoot = {
    InitialiseMyApp: function()
    {
        const verboseLoggingEnabled = false;
        const appVersion = "1.28.1";

        window.IVMetrics.Create("DEV-KEY-XXXX", "PRJ-KEY-XXXX", verboseLoggingEnabled, appVersion);
    },
}

Setup Complete

Your project is now set up to use IV Metrics when deploying to Android devices. You should begin to see devices appearing in requests on the panel when the project is ran on a device.

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

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

N/A