Upgrade to V1.17

Player Network SDK 1.17 integrates LI PASS SDK to support LI PASS features.This upgrade adds support for Unity 2022 and Unreal Engine 5.1, and streamlines the file structure to facilitate future upgrades.

For complete version update details, see V1.17 Release Notes.

Upgrade Impact

This version is compatible with Unity 2022 and Unreal Engine 5.1, and the INTLConfig plugin folder contains all the basic SDK configurations.For UE 5.1, each plugin folder independently manages its own resources and configurations.For Unity 2022, each plugin’s Android library manages the Android platform configuration specific to that plugin.This arrangement streamlines the SDK folder structure and simplifies the upgrade process for future SDK versions.

Therefore, projects planning to upgrade the game engine or intending to upgrade to a future SDK version—whether to integrate new features or fix issues—should consider upgrading to this SDK version.In addition, this upgrade integrates the LI PASS SDK, supporting all LI PASS functionality. Therefore, for projects intending to adopt LI PASS, this upgrade is essential.

Upgrade Contents

Unity

File Structure Reorganization:

• A new INTLConfig folder has been created to store all the basic SDK configurations, including the Encrypt folder, the INTLConfig.ini configuration file, and the INTL{Plugin}{Platform}PostProcess.cs scripts.
• A new Plugins/Android/Gradle folder was created to store Gradle build instructions for Android.The Gradle build instructions for each plugin have been separated and moved to Plugins/Android/INTL{Plugin}.androidlib.

Therefore, the configuration has been adjusted:

• Regardless of the platform the project runs on, SDK configurations are stored in the INTLConfig.ini file, which includes multi-channel package configurations.
• The build instructions for Player Network SDK are stored in Plugins/Android/Gradle/INTLCore.mainTemplate.gradle.
• Build instructions related to plugins have been separated into each plugin’s Plugins/Android/INTL{Plugin}.androidlib folder.

Unreal Engine

The Player Network SDK folder name has been changed from INTLSDKPlugin to INTLSDK, and the following changes have been made:

• The INTLSDKPlugin/Source/INTLSDKPlugin folder was split into multiple plugin folders.These include the INTLCore, INTLConfig, and INTLFoundation folders.Downloaded plugins will include these folders.
• All basic configurations of the Player Network SDK have been moved to the new INTLConfig folder, including the INTLConfig.ini configuration file, the SDK’s encryption features, Android Gradle configuration files, iOS property list files, and UPL XML files used to modify the iOS plist files.
• The INTLSDKPlugin/Source/INTLSDKPlugin/INTLPlugin.Build.cs file has been split, so each plugin folder now contains its own build script: INTLSDK/Source/INTL{Plugin}/INTL{Plugin}.Build.cs.For example, INTLSDK/Source/INTLConfig/INTLConfig.Build.cs.

Encryption Features

Unity

Before Update

There was no Encrypt folder, and files related to encryption were scattered in the Editor folder along with other editor configuration files, as shown below:

After Update

All files related to encryption features have been moved to the INTLSDK/Scripts/INTLConfig/Editor/Encrypt folder, as shown below:

Unreal Engine

Before Update

There was no Encrypt folder, and files related to encryption were scattered in the INTLSDKPlugin folder. The configuration file was EncryptConfig.ini.

After Update

The INTLSDK/Source/INTLConfig/Encrypt folder contains the executable files for the encryption feature, with the configuration file DefaultEngine.ini.

Configuration Files

Unity

Before Update

The configuration file path varies by platform:

• Android: Assets/Plugins/Android/assets/INTLConfig.ini
• iOS : Assets/Plugins/iOS/INTLSDK/INTLCore/INTLSDK.bundle/INTLConfig.ini
• Windows & PS5: Assets/Plugins/x86_64/INTLConfig.ini

After Update

The configuration file path is consistent across all platforms: INTLSDK/Scripts/INTLConfig/Editor/Resources/INTLConfig.ini

Unreal Engine

Before Update

The configuration file path varies by platform:

• Android: INTLSDKPlugin/Source/INTLSDKPlugin/INTLSDK/Android/assets/INTLConfig.ini
• iOS : INTLSDKPlugin/Source/INTLSDKPlugin/INTLSDK/iOS/INTLCore/INTLSDK.bundle/INTLConfig.ini
• Windows & PS5: INTLSDKPlugin/Source/INTLSDKPlugin/INTLSDK/resources/INTLConfig.ini

After Update

The configuration file path is consistent across all platforms: INTLSDK/Source/INTLConfig/Configs/Resources/INTLConfig.ini

Android Gradle Files

Unity

Gradle project files differ between Unity 2019 and earlier versions.Therefore, the changes for Unity 2018 and earlier and Unity 2019 and later will be described separately.

Unity 2018 and earlier versions

Before Update

All build instructions are specified in the Assets/Plugins/Android/mainTemplate.gradle file.

After Update

The Plugins/Android/mainTemplate.gradle file contains general build instructions, while plugin-specific instructions are split into each INTL{Plugin}.mainTemplate.gradle file.

Unity 2019 and later versions

Before Update

All Gradle project build instruction files:

• Plugins/Android/mainTemplate.gradle
• Plugins/Android/baseProjectTemplate.gradle
• Plugins/Android/launcherTemplate.gradle

After Update

• General Gradle project build instruction files:
  • Plugins/Android/mainTemplate.gradle
  • Plugins/Android/baseProjectTemplate.gradle
  • Plugins/Android/launcherTemplate.gradle
• Plugin-related Gradle project build instruction files:
  • Plugins/Android/Gradle/INTL{Plugin}.mainTemplate.gradle
  • Plugins/Android/Gradle/INTL{Plugin}.baseProjectTemplate.gradle
  • Plugins/Android/Gradle/INTL{Plugin}.launcherTemplate.gradle

Unreal Engine

Before Update

All build instructions are specified in the INTLSDKPlugin/INTLSDK/Android/INTLCore_UPL.xml file.

After Update

The INTLSDK/Source/INTLConfig/Configs/Android/INTLConfig_APL.xml file contains general build instructions, while plugin-specific instructions are split into each INTLSDK/Source/INTL{Module}/Libs/Android/INTL{Module}_APL.xml file.

iOS Information Property List

Unity

No Update

Unreal Engine

Before Update

All configurations are specified in the INTLSDKPlugin/Source/INTLSDKPlugin/INTLSDK/iOS/iOS_UPL.xml file.

After Update

Each plugin folder includes its own configuration file INTLSDK/Source/INTL{Plugin}/Libs/iOS/INTL{Plugin}_UPL.xml.

C# Scripts

Unity

Before Update

All plugin {XXX}PostProcess.cs scripts are stored in the INTLSDK/Editor directory, as shown below:

After Update

The scripts are organized by plugin, and the new path is: INTLSDK/Scripts/INTL{Plugin}/Editor/INTL{Plugin}XXXPostProcess.cs, as shown below:

Unreal Engine

Before Update

All scripts were written in the INTLSDKPlugin/Source/INTLSDKPlugin/INTLPlugin.Build.cs file.

After Update

Scripts are organized by plugin, and the new path is INTLSDK/Source/INTL{Plugin}/INTL{Plugin}.Build.cs.

Upgrade Guide

Unity

1. Download and unzip Player Network SDK V1.17 as instructed in Download Resources. The folder structure is as follows:

   

2. Replace the INTLSDK/Scripts/INTLConfig/Editor/Resources/INTLConfig.ini configuration file with the version in your project that contains the correct settings.

   The previous version of the configuration file can be found at the following paths:

   • Android: Assets/Plugins/Android/assets/INTLConfig.ini
   • iOS: Assets/Plugins/iOS/INTLSDK/INTLCore/INTLSDK.bundle/INTLConfig.ini
   • Windows: Assets/Plugins/x86_64/INTLConfig.ini

3. For Android, update the Gradle configuration files according to your Unity engine version.

Unity 2018 and earlier versions

1. Replace the placeholder configuration in the Plugins/Android/Gradle/INTLCore.mainTemplate.gradle file with the configuration from your project's Assets/Plugins/Android/mainTemplate.gradle file.

   

2. Merge your project's Assets/Plugins/Android/mainTemplate.gradle file into the Plugins/Android/mainTemplate.gradle file in Player Network SDK V1.17.

   Player Network SDK configurations must be preserved.

   

Unity 2019 and later versions

3. Replace the placeholder configuration in the Plugins/Android/Gradle/INTLCore.launcherTemplate.gradle file with the configuration from your project's Assets/Plugins/Android/launcherTemplate.gradle file.

   

4. Merge the following files from your project into the corresponding files in Player Network SDK V1.17:

   • Merge Assets/Plugins/Android/mainTemplate.gradle into Plugins/Android/Gradle/INTLCore.mainTemplate.gradle;
   • Merge Assets/Plugins/Android/baseProjectTemplate.gradle into Plugins/Android/Gradle/INTLCore.baseProjectTemplate.gradle;
   • Merge Assets/Plugins/Android/launcherTemplate.gradle into Plugins/Android/Gradle/INTLCore.launcherTemplate.gradle.

   Player Network SDK configurations must be preserved.

   

4. Delete the Assets/INTLSDK folder from your project and replace it with the INTLSDK folder from Player Network SDK V1.17.

5. Delete files in the Assets/Plugins folder related to the Player Network SDK.

   Example of files to delete:

   

6. Merge the Plugins folder from Player Network SDK V1.17 into your project's Assets/Plugins folder.

Unreal Engine

1. Download and extract Player Network SDK V1.17 according to the instructions in Download resources. The folder structure is as follows:

   

2. Replace the INTLSDK/Source/INTLConfig/Configs/Resources/INTLConfig.ini configuration file with the version in your project that contains the correct settings.

   The previous version of the configuration file can be found at the following paths:

   • Android: Plugins/INTLSDKPlugin/Source/INTLSDKPlugin/INTLSDK/Android/assets/INTLConfig.ini
   • iOS: Plugins/INTLSDKPlugin/Source/INTLSDKPlugin/INTLSDK/iOS/INTLCore/INTLSDK.bundle/INTLConfig.ini
   • Windows: Plugins/INTLSDKPlugin/Source/INTLSDKPlugin/INTLSDK/resources/INTLConfig.ini

3. For Android, replace the placeholder configurations in INTLCDK/Source/INTLConfig/Configs/Android/INTLConfig_APL.xml with the configurations from your project’s INTLCore_UPL.xml file.

   

4. For iOS, replace the placeholder configuration in the INTLSDK/Source/INTLPlugin/Libs/iOS/INTLPlugin_UPL.xml file with the configuration from INTLSDKPlugin/Source/INTLSDKPlugin/INTLSDK/iOS/iOS_UPL.xml in your project.

5. Backup the /Plugins/INTLSDKPlugin/Source/INTLSDKPlugin/INTLSDK/Android/googleservices.json and /Plugins/INTLSDKPlugin/Source/INTLSDKPlugin/IOS/iOS/GoogleService-Info.plist files.

6. Delete the Plugins/INTLEncrypt and Plugins/INTLSDKPlugin folders from the project.

7. Place the V1.17 version of the INTLSDK folder, with configurations updated to match your project, into the project’s Plugins folder.

8. Save the files backed up in step 5 as /Plugins/INTLSDK/Source/INTLFirebase/Libs/Android/googleservices.json and /Plugins/INTLSDK/Source/INTLFirebase/Libs/iOS/GoogleService-Info.plist.

9. Open the {Project}.Build.cs file and update the PrivateDependencyModuleNames.AddRange(new string[] { "INTLPlugin" }); section to:

   PrivateDependencyModuleNames.AddRange(new string[] {
           "INTLCore",
           "INTLFoundation"
   });

Notes

1. To avoid dependency conflicts with the Android com.google.android.play.core library, split the dependency libraries and rename the task packages according to the instructions in Migrating from Play Core Java and Kotlin libraries.

   

2. In Player Network SDK 1.17, the ext field for Android projects has been moved to INTLCore.mainTemplate.Gradle, which includes the line: apply from: "$rootDir/INTL.Gradle/INTLCore.mainTemplate.gradle".Therefore, the ext field is still valid.However, commonVersions is no longer valid, and only common can be used within the ext field.

   

3. The compileSdkVersion, buildToolsVersion, minSdkVersion, and targetSdkVersion in the Android Gradle file ext.common field are upgraded according to Google Play requirements.If your project does not need to be published on Google Play, you can revert to the previous versions.

4. Two new versions are specified in the ext.common field: ndkVersion and cmakeVersion.If your project does not require them, these can be left unconfigured.

5. For minSdkVersion 23 and above, the newly added overrideLibrary in AndroidManifest.xml is not required.These fields were added to the SDK because the default minSdkVersion is 16, but specifying plugin package names that are not used does not affect the project’s functionality.

   

6. For targetSdkVersion: 33, required system permissions must be updated.

   • To enable push notifications, add <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/> in the manifest file.

   • Replace android.permission.READ_EXTERNAL_STORAGE and android.permission.WRITE_EXTERNAL_STORAGE with the following permissions:

     <uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
     <uses-permission android:name="android.permission.READ_MEDIA_AUDIO" />
     <uses-permission android:name="android.permission.READ_MEDIA_VIDEO" />

7. If you need to update dependencies in Android Gradle, change: compile fileTree(dir:'libs',include:['*.jar']) to implementation fileTree(dir:'libs',include:['*.jar']). Then copy the Gradle modifications indicated by the arrows in the figure to the corresponding files.