Configuring your Project for Unity Remote Config

Requirements

Installing the Remote Config package

See documentation on packages for more information on working with packages in a Project. These steps may vary depending on which version of the Unity Editor you’re using.

Verified Release

  1. In the Unity Editor, select Window > Package Manager.
  2. From the Package Manager Window find Remote Config in the Packages List View and select it
  3. In the Package Specific Detail View select the version and install to import the package into your Project

Preview Release

  1. In the Package Manager Window the Advanced button will allow you to toggle Preview Packages making them visible in the Package List View
  2. Follow the instructions for the Verified Release Installation (directly above this section)

Beta Customers

Upon receiving the Remote Config package from your account manager, follow these steps:

  1. Download and unzip the package.
  2. In the Unity Editor, select Window > Package Manager.
  3. Click the plus (+) button at the bottom of the Package Manager window to open the Add package from disk... dialog.
  4. Locate the package.json file inside your unzipped copy of the Remote Config package.
  5. Click Open to import the package into your Project.

See documentation on packages for more information on working with packages in a Project. These steps may vary depending on which version of the Unity Editor you’re using.

Remote Config Environments

To get started, create an environment and give it a name. Note environment names are immutable.

The first environment created will be set to the default environment, which is the environment which will be requested unless otherwise specified by the client. The default environment can be assigned to an EnvironmentID in the Remote Config Window in the Editor, via the Web Dashboard, or via the REST API.

The Legacy Remote Config service included only two build environments. Starting with version 1.1.0 developers can create environments, choose the environment used in a build, and set a default environment. Note the environment name Development is a reserved name.

If a 1.0.x version package was used in your Unity Project, there will be 2 environments created for your project; Release and Development. Additional environments can be created and the default environment which is set to Default can be changed to one of the new Environments.

For users downgrading from 1.1.x to 1.0.x, an environment with the name Development will be created if it does not exist.

Deleting the environment named Development is possible however; using a Development Build version of your Unity Project may cause unintended or breaking behavior. Those builds will receive the settings and rules from the environment which is set as the default environment.

Legacy Remote Config Environments (Only for packages in version range <=1.0.x)

Development environment

Remote Config sends settings from the Development environment to builds marked as development builds.

Note: For Unity to request the Development environment settings, you must check the Development Build setting in the Build Settings window when building your application.

Configuring your build for the Development environment.

Release environment

Remote Config sends settings from the Release environment to any non-development builds.

Note: The Editor’s Play mode always uses the Development environment settings.

Once you’ve configured your Project, start configuring your Rules and Settings in the Remote Config window.