HOME.en.md

---

RuStore Unreal plugin for working with the cloud application configuration service

RuStore Remote Config is a cloud service that lets you change the behavior and appearance of your app without requiring users to download an app update. The SDK encapsulates fetching configuration from the server, caching, and background updates. Unreal Engine 5.3 and higher are supported.

Installing the plugin into your project

1. Go to the Releases section of the project repository on GitFlic.

2. Download the following artifacts from the selected release:

   • RuStoreRemoteConfig.zip
   • RuStoreCore.zip

3. Unpack the downloaded archives into the Plugins folder at the root of your Unreal project so that the following structure is obtained:

📁 your_project
└─ 📁 Plugins
   ├─ 📁 RuStoreRemoteConfig
   │  ├─ 📁 Binaries
   │  ├─ 📁 Content
   │  ├─ 📁 Intermediate
   │  ├─ 📁 Resources
   │  ├─ 📁 Source
   │  └─ RuStoreRemoteConfig.uplugin
   └─ 📁 RuStoreCore
      ├─ 📁 Binaries
      ├─ 📁 Content
      ├─ 📁 Intermediate
      ├─ 📁 Resources
      ├─ 📁 Source
      └─ RuStoreCore.uplugin

1. Restart Unreal Engine.

2. In the plugin list (Edit → Plugins → Project → Mobile), enable the RuStoreRemoteConfig and RuStoreCore plugins.

3. Add the RuStoreCore and RuStoreRemoteConfig modules to the PublicDependencyModuleNames list in the YourProject.Build.cs file.

4. In the project settings (Edit → Project Settings → Android), set the Minimum SDK Version parameter to at least 24 and the Target SDK Version parameter to at least 31.

SDK initialization

Before calling library methods, you must initialize it. To do this, create a class that extends GameApplication and add RemoteConfigClient initialization to the onCreate method.

package com.example.RuStoreRemoteConfigApp;

import android.content.Context;
import com.epicgames.ue4.GameApplication;
import ru.rustore.unitysdk.remoteconfigclient.model.UnityUpdateBehaviour;
import ru.rustore.unitysdk.remoteconfigclient.RuStoreUnityRemoteConfigClient;

public class RuStoreRemoteConfigApplication extends GameApplication {

    public final String APP_ID = "a83c91d3-21b4-4891-841e-0ed0fc39a562";
    public final int UPDATE_TIME = 15;
    public final String UPDATE_BEHAVIOUR = "Actual";

    @Override
    public void onCreate() {
        super.onCreate();

        RuStoreUnityRemoteConfigClient.INSTANCE.init(APP_ID, UPDATE_TIME, UPDATE_BEHAVIOUR, null, null, getApplicationContext());
    }
}

• APP_ID — unique identifier of the Remote Config tool. Available in the RuStore Console on the Remote Config parameters creation page.
• UPDATE_TIME — update timer interval in minutes.
• UPDATE_BEHAVIOUR — parameter that defines the SDK behavior.

To replace the GameApplication class with RuStoreRemoteConfigApplication in your project’s manifest file, use the Unreal Plugin Language (UPL) functionality:

<prebuildCopies>
    <copyDir src="$S(PluginDir)/Java" dst="$S(BuildDir)/src/com/example/RuStoreRemoteConfigApp" />
</prebuildCopies>

<androidManifestUpdates>
    <addAttribute tag="application" name="android:name" value="com.example.RuStoreRemoteConfigApp.RuStoreRemoteConfigApplication" />
</androidManifestUpdates>

For more details about initialization, see the online guide.

Working with the SDK

Start exploring the RuStore library documentation with the methods of the URuStoreRemoteConfigClient class. Alternatively, use the online guide.

Technical support

Additional help and instructions are available in the RuStore documentation and by email at support@rustore.ru.

Distribution terms

This software, including source code, binary libraries, and other files, is distributed under the MIT license. Licensing information is available in the document MIT-LICENSE.