rustore / Unity RuStore AppUpdate SDK
CI/CD
Реестр контейнеров и пакетов

HOME.en.md

RU EN
🏠 Home ❮ Back

RuStore Unity plugin for app updates

The RuStoreAppUpdateManager plugin helps keep your app up to date on the user’s device. Unity 6000+ versions are supported.

Adding to the project

From a network location (recommended)

RuStore packages are published in the npm registry and connected to the project via Package Manager without manually downloading archives.

  1. Open settings: Edit → Project Settings → Package Manager.
  2. In the Scoped Registries section, click + and fill in the fields:
    • Name — RuStore Nexus.
    • URL — https://nexus-external.rustore.ru/repository/npm-unity-rustore-exposed/.
    • Scopes — ru.rustore.
  3. Open Window → Package Manager — the RuStore Nexus registry will appear in the list of sources.
  4. Select RuStore Nexus and install the ru.rustore.update package using the Install button. The ru.rustore.core dependency will be installed automatically.

From a local location

Installing via Package Manager

  1. To connect, download the following packages from the releases page:
    • ru.rustore.core-version.tgz.
    • ru.rustore.update-version.tgz.
  2. Import the packages into the project via Package Manager (Window → Package Manager → + → Add package from tarball…).

*Installing via .unitypackage

  1. Download the RuStoreUnityAppUpdateSDK-version.unitypackage file from the releases page.
  2. Import it into the project (Assets → Import Package → Custom Package…).

Cloning the repository

To install from source code, use the cloning instructions.

For each artifact in the release, checksum (.sha256) and digital signature (.sig) files are available, which can be used to verify the integrity and authenticity of the artifact after downloading.

Tip

If you use the macOS operating system, change the settings of the archiving utility. In the Archive Utility settings, clear the Keep expanding if possible checkbox. Otherwise, the project archive will be downloaded incorrectly.

Project setup

To correctly handle SDK dependencies, configure the following settings.

  1. Open the project settings: Edit → Project Settings → Player → Android Settings.
  2. In the Publishing Settings section, enable the following settings.
    • Custom Main Manifest.
    • Custom Main Gradle Template.
    • Custom Gradle Properties Template.
  3. In the Other Settings section, configure:
    • package name.
    • Minimum API Level = 24.
    • Target API Level = 34.

Connecting dependencies

After installation, update the project dependencies using External Dependency Manager (Assets → External Dependency Manager → Android Resolver → Force Resolve).

Installing External Dependency Manager

The Android External Dependency Manager is included in the RuStoreCore package. To install it, perform the following steps.

  1. Open RuStoreCore in the package manager window (Window → Package Manager → Packages RuStore → RuStoreCore).
  2. Go to the Sample tab.
  3. Import the External Dependency Manager sample.

Open the External Dependency Manager settings: Assets → External Dependency Manager → Android Resolver → Settings, enable the following settings:

  • Use Jetifier.
  • Patch mainTemplate.gradle.
  • Patch gradleTemplate.properties.

Working with the SDK

Start exploring the RuStore library documentation with the methods of the RuStoreAppUpdateManager 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.