LiveOps Remote Config
Introduction
LiveOps package is designed to help your game studio gain insights into your player base and identify actionable opportunities for growing your audience and revenue.
The features that liveOps provides are,
LiveOps automatically:
Initialises selected liveOps solution (Satori or Firebase)
Sets essential properties
Logs important data (experiment name, etc.) to Analytics
Fetches and stores Feature Flag values
LiveOps also provides simple functions to:
Access Feature Flag (remote configuration) values
Fire Events (to assign payers to audiences)
Set Custom Properties
Installation
Install LionSDK
Complete the steps in Getting Started
Install LiveOps Package
Go to Package Manager → “My Registry” → “Lion Studios - Advanced” and install “Lion - LiveOps Remote Config” package. Reference image is attached below.
Requirements
Remote Setup
LiveOps solution has three types. Either of them can be configured in editor, but only one of them will be used at runtime. The three types of liveOps solution are:
Setup instructions for each solution are provided in the links above. After setting it up, you can select it by going to LionStudios → Settings Manager → LiveOps
.
Loading Scene
The liveops solutions need to load their values before the gameplay starts. The easiest solution for this is to integrate our Loading Scene module.
Usage
The following methods must be called after the LiveOps package has been initialized. The module is part of LionSDK’s initialization cycle; you can use LionCore.IsInitialized
and LionCore.OnInitialized
to ensure that it is ready.
If you have a loading scene already waiting for LionCore initialization, you don’t have to worry about this in your game scene.
1. Remote values:
Remote values gives the ability to change the behaviour and appearance of your app without publishing an app update for users.
For Firebase, Remote value means Remote configs
For Satori, Remote value means Feature Flag
For Test, Remote value means local list of values present in editor window
Function signature
This will return the value of the feature flag for the current player.
Examples
Flag names are case-sensitive.
2. Log Event
Events allow you to send data for a given user to the server for processing.
For Firebase, the events are created on runtime so just need to call the “LogEvent” function with events.
For satori, the event must be created in the Satori Dashboard for this function to work. See HeroicLabs Guides
For Test, the events are just Debug logs.
Function signature
Example
3. Fetching data
For Firebase, By calling “FetchAndUpdateRemoteConfig” function, only remote configs are updated by fetching them from server.
For Satori, By calling “FetchAndUpdateRemoteConfig” function, Remote configs and experiments are updated automatically as they are fetched again from the server.
For Test, By calling “FetchAndUpdateRemoteConfig” function, will fetch latest values present in editor window. But in runtime this won’t do anything as values in unity editor will be the same everytime.
Function signature
The given function is an async task function, “await” can be used here, that ensures that code waits until the data is fetched completely from server.
Example
4. Custom/User properties
Properties are an important tool used to define and enrich a user identity profile, and ultimately used to define the audience segments.
For Firebase, more information can be found here Firebase user properties
For Satori, more information can be found here Satori Custom Properties
For test, there are no user properties.Setting them won’t do anything.
Function signature
Example-1
Example-2
5. Existing user
A boolean value that’s used to identify players who have previously played the app in a version without LiveOps (Satori or Firebase). These players must be processed differently internally because the LiveOps SDK (Satori or Firebase) has incomplete data on them.
So at the start of the first session with LiveOps, you need to let us know if the player has existed before that session. You can use your own persistent data to check this.
Make sure to call this only once.
Pass “true” if user existed before.
Example
6. Set up experiments
Below are the instructions to set up AB Experiments on the dashboard so that the module can send appropriate events to Lion Analytics:
For Firebase: AB Experiments (Firebase)
For Satori: AB Experiments (Satori)
For Balancy: AB Experiments (Balancy) [WIP]
Last updated