Adding parameters
Remote configuration is defined as a set of keys-value pairs named “parameters” that can be added and modified in the “parameter tab” found on the app config page
To add parameters:
- Click EDIT
- Click ADD PARAMETER
Then add parameters manually, filling the following fields:
| Data | Description | Guideline |
|---|---|---|
| Parameters name | Name of the parameters | Parameters' name should be in lowercase Parameters' name should not start with a one character prefix like "a_parameter" |
| Type | Type of the parameter, it can have the following values - String - Int - Float - Boolean - JSON | |
| Default value | Value that you want to set for this parameter | |
| Description | Description of the parameters, what is the functional impact of this parameter? | Not mandatory but strongly encouraged |
Alternatively, a list of parameters can be imported from a CSV by clicking IMPORT CSV.
The csv must have the following columns:
- parameter_name
- variable type
- description
- default_value
An example of such a csv can be found geryon param csv.csv.
CSV import adds keys that were not present before, updates the values of keys that were already present but does not remove existing keys
Creating scopes and scope overrides
Scopes are created in the “Parameter” tab. A Scope targets an OS and optionally a list of countries on which it is then possible to override the default configuration (e.g the value associated one or more parameters) or to launch AB tests.
This can be used to have different game behaviour on different platforms and geographies - typically when audiences don’t react the same way to some features (ad pressure, difficulty or specific systems).
By default, 2 scopes are created: IOS and Android.
To create a new scope, click on add scope and select the adequate OS and countries.
To override a parameter value on a scope:
- Click on the scope to select it
- Click EDIT
- Click EDIT PARAMETER VALUE
- add the parameter key and value to define the override
Scopes have several limitations:
- Scopes need to target mutually exclusive countries (it is not possible to both have a scope for IOS US and for IOS US + CA active at the same time)
- A Scope needs to be active for its overrides to have any effect
- A Scope needs to be active to be a target of an AB test
How do scope overrides work ?
Remote configuration and scope overrides are fetched by the game client right after installation, on the first app open.
As a consequence, the configuration of a game stays static once the game is launched for the first time. Scope overrides only affect players that install the game after the override setup.
How to override configuration for existing users ?
It is possible to define overrides that apply to existing players as well - these overrides will be applied the next time they open the app after the override has been defined.
This is done in the “Apply all players” tab of the app config page.
To override configuration in this tab:
- Select the desired scope
- Create a new version
- Add parameters and the desired values
- Save and apply
⚠️ Note: a configuration value defined in this way will take precedence on the configuration defined on the parameters tab and will not be possible to AB test anymore.