HOME.en.md

---

Unreal plugin RuStore for working with the cloud application configuration service

RuStore Remote Config is a cloud service that allows you to change the behavior and appearance of your application without requiring users to download an application update. The SDK encapsulates the configuration request from the server, caching, and background update. Unreal Engine 5.3 and later versions are supported.

Installing the plugin in your project

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

2. Download the artifacts from the selected release:

   • RuStoreRemoteConfig.zip
   • RuStoreCore.zip

3. Extract the downloaded archives into the Plugins folder in 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), check the plugins RuStoreRemoteConfig and RuStoreCore.

3. Add the modules RuStoreCore and RuStoreRemoteConfig 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 the library methods, you need to initialize it. To do this, create a class extending GameApplication and add initialization of RemoteConfigClient in 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 behavior of the SDK.

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 on initialization, see the online guide.

Working with the SDK

Start exploring the documentation of the RuStore library with the methods of the URuStoreRemoteConfigClient class. Or 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 MIT-LICENSE document.