Skip to content

SDK Upgrade

Upgrade Hive SDK with SDK Manager

To newly install or upgrade the Hive SDK via the SDK Manager, right-click EUW_HiveSDKManager inside the HiveSDKManager plugin folder in the Content Browser and execute Run Editor Utility Widget.

Execute SDK Manager

When the SDK Manager menu opens, click SDK Upgrade to execute it.

Execute SDK Manager upgrade menu

Upgrade flow

1. Select upgrade version

Select SDK Manager upgrade version

(1) SDK Manager upgrade guide

Click to go to the SDK Manager guide page. Read the guide and proceed with the upgrade.

(2) Check applied version and latest version

You can check the currently applied Hive SDK version and the latest distributed version. If the Hive SDK is not applied, the applied version is displayed as -.

(3) Release notes

Click Go to the right of the Interface package to go to the release notes page for that version. Read the release notes for the latest version you want to upgrade to and proceed with the upgrade.

(4) Select Interface package version

Select the Interface package to update or newly install. When you select the Interface version, the Platform package selection UI is displayed.

Warning

Downgrading to a version lower than the currently applied version is not supported.

(5) Select Platform package version

Select the Platform package (Android, iOS, Windows) you want to newly install or update. Then, select the version (major.minor.patch) you want to apply via the combo box.

The Platform package major and minor versions must be the same as the Interface package. The Platform package patch version can be the same as or higher than the Interface package patch version.

  • Example: Interface package version is 26.0.0
    • Platform package version
      • 26.0.0, 26.0.1, 26.0.2 (Compatible)
      • 25.9.0 (Incompatible)
      • 25.9.1 (Incompatible)
      • 26.1.0 (Incompatible)
      • 26.1.1 (Incompatible)

As long as they are compatible with the Interface package, the Android, iOS, and Windows Platform package versions can be different from each other.

Note

For more details on Platform packages and Interface packages, refer to here.

(6) Apply

Once you have selected the packages to upgrade, click the Apply button to proceed to the next process.

2. Integrity verification

If you have selected the version to upgrade, you can select files to exclude from upgrade and perform integrity verification in this step. Among the existing Hive SDK version files, only files with verified integrity can be upgraded to the target version.

SDK Manager upgrade integrity verification screen-1

(1) Select files to exclude from upgrade

Select files to exclude from the upgrade among the files configured in the Hive SDK package. Clicking Edit Now displays a memo file where you can write the list of files to exclude from the upgrade. Then modify and save the memo file.

(2) Integrity verification

Compares the files constituting the existing Hive SDK version package with the original. In other words, it compares the Hive SDK package files installed on the local development machine with the Hive SDK original files existing on the SDK Manager server. If there are modified files locally as a result of the comparison, they are displayed in the list.

(3) Restore to current version

Restores modified files to the original files. Once restoration is complete, they are excluded from the list above, and the upgrade target version contents are reflected during the upgrade. If you proceed with the upgrade without restoring a specific file, that file is excluded from the upgrade.

Note

If there are no modified files in the integrity verified file list, the Restore to Current Version button is not displayed. This means that the currently applied version original files have not been modified locally. Therefore, if there are no modified files through integrity verification, you can proceed to the next step without the Restore to Current Version button.

SDK Manager upgrade integrity verification screen-2

(4) Upgrade

Proceeds with the upgrade to the selected Interface and Platform package versions.

(5) Stop

Returns to the Select upgrade version screen.

3. Upgrade progress

After the integrity verification step, you can proceed with the upgrade and check the results.

SDK Manager upgrade complete screen

(1) Upgrade applied version

You can check the Interface and Platform package versions of the upgraded Hive SDK.

(2) Restart Editor

Due to the nature of Unreal Engine, you must restart the editor after newly installing or updating a plugin.

Note

We recommend restarting the editor immediately for stable plugin application.