Remote Settings migration guide#

On June 27, 2023, Remote Settings will be deprecated. All users must migrate to Unity's newer service, Remote Config; the process is documented below.

Prerequisites#

Remote Config versions 2.X requires Unity Editor version 2018.4 or higher. However, Unity recommends using Remote Config versions 3.1X for Editor versions 2019.4 and higher.

Before installing the Remote Config package:

1. In the Unity Editor, select Assets > Remote Settings.
2. Delete the existing Remote Settings plugin.

Install the Remote Config package#

To install the latest Remote Config package for Unity:

1. In the Editor, open Window > Package Manager.
2. In the Package Manager, select the Unity Registry list view.
3. Search for com.unity.services.remote-config, or locate the Remote Config package in the list.
4. Select the package, then select Install.

See the Remote Config installation instructions for more information.

Update your Unity Cloud Dasboard#

Perform the following migration steps on the Unity Cloud Dashboard.

Environments#

Remote Settings come with two environments:

• RELEASE
• DEBUG

If you haven’t introduced new environments to the Unity Cloud Dashboard, all Remote Settings will be copied from RELEASE to the PRODUCTION environment by default. If you want to maintain separate environments, you must create the required environments in the Unity Cloud Dashboard.

Retrieve Remote Settings keys#

The dashboard for Remote Settings is no longer accessible. To retrieve your Remote Setting keys you can reach out to our Support team

Import Remote Settings keys into Remote Config#

Format your keys into CSV files to look like the example below with the key, type, and value columns:

Important: Do not include the segment and priority columns.

key,type,value
time_amount,float,30
score_to_win,int,1

Upload the resulting file to Remote Config:

1. In the primary navigation menu, select LiveOps.
2. In the secondary navigation menu, select Remote Config > Config.
3. On the Remote Config page, select Import.
4. Select your modified CSV files to import.

This copies the keys from Remote Settings to the new Remote Config environment. If the file has any errors, you are prompted to download a CSV file with the rejection reason.

Code Integration#

To use the imported keys, follow the code integration guide that details initialization, fetching, and applying settings at runtime.

Recreate Overrides#

Unfortunately Remote Settings Segments and Remote Config Audiences do not map perfectly. This means that you need to create new Overrides with JEXL manually.

As you need to analyze each campaign individually, Unity recommends only replicating active campaigns and ignoring inactive campaigns.

Support#

If you encounter any issues or have questions related to the migration, reach out to our Support team.