iOS

Player Network SDK 1.23 及之后版本
Player Network SDK 1.23 之前版本

UE4.21 ~ UE4.27 & UE5 ~ UE5.4

版本需求

由于 App Store Connect 的上架要求规定使用 Xcode 15，iOS 最低支持版本为 iOS 12。

如果接入 Facebook、Firebase、DMM、Google、WeChat、Adjust、AppsFlyer、QQ，iOS SDK 需要升级到版本 12 或以上。

如果接入 LINE，iOS SDK 需要升级到版本 13 或以上。

前提条件

警告

游戏使用的每个 SDK 插件的版本（包括游戏启动器使用的版本）必须保持一致。如果游戏需要同时访问多个版本的 Player Network SDK，或者只有一个组件需要升级，请联系 Player Network 助手。

步骤1：安装 SDK

1. 将 Player Network SDK 添加到您的项目

解压 SDK 软件包。
将 INTLSDK 文件夹复制到项目的 Plugins 文件夹中。
如果项目中没有 Plugins 文件夹，请创建一个。

打开项目的 {项目名称}.Build.cs 文件，并按照示例将 Player Network SDK 添加到 Unreal Engine 中。

public INTLSample(ReadOnlyTargetRules Target) : base(Target)
{
    PrivateDependencyModuleNames.AddRange(new string[] {
        "INTLCore",
        "INTLFoundation",
        "INTLConfig",
    });
}

Player Network SDK package

├─INTLSDK
│  ├─INTLSDK.uplugin    // Player Network SDK plugins description files
│  ├─Resources          // Player Network SDK resources
│  └─Source             // Player Network SDK plugin modules. Each module contains its own Build.cs file, libraries, and interfaces.
│    ├─INTLApple
│    ├─INTLConfig       // Player Network SDK configurations
│    ├─INTLCore         // Player Network SDK Core module
│    ├─INTLDiscord
│    ├─INTLEpic
│    ├─INTLFacebook
│    ├─INTLFoundation
│    ├─INTLGoogle
│    ├─INTLKakao
│    ├─INTLLine
│    ├─INTLSteam
│    ├─INTLTwitter
│    └─INTLVK
├─LevelInfinite     // LI PASS APIs
└─Symbols           // Player Network SDK symbol table *.so files

INTLSDK/Source/INTLCore

└─INTLSDK
   ├─INTLSDK.uplugin
   ├─Resources
   └─Source
     ├─INTLConfig
     ├─INTLCore
     |  ├─INTLCore.Build.cs // INTLCore Build.cs file
     |  ├─Libs              // INTLCore libraries for different platforms which contain dll, lib, and other binary files.
     |  |  ├─Android
     |  |  ├─include
     |  |  ├─iOS
     |  |  ├─MacOS
     |  |  └─Win
     |  ├─Private           // Player Network SDK private folder
     |  └─Public            // Player Network SDK public interfaces
     |                      // INTLSDKAPI.h: Player Network SDK APIs
     |                      // INTLSDKPluginObserver.h: Player Network SDK observer classes
     |                      // INTLSDKPluginDefine.h: Player Network SDK data types
     |                      // INTLSDKOutputUtility.h: Player Network SDK utility to process callbacks
     |                      // INTLSDKBaseUserWidget.h: Player Network SDK base class for UserWidget which includes registration and deregistration APIs
     ├─INTLCustomer
     ├─INTLDiscord
     ├─INTLEpic

INTLSDK/Source/INTLConfig

└─INTLSDK
   ├─INTLSDK.uplugin
   ├─Resources
   └─Source
     ├─INTLConfig
     |  ├─Configs       // Player Network SDK configurations for different platform
     |  |  ├─Android
     |  |  |  └─INTLConfig_APL.xml  // Player Network SDK Android gradle configuration file
     |  |  ├─iOS
     |  |  |  ├─INTL.plist
     |  |  |  ├─INTLConfig_UPL.xml
     |  |  |  ├─mergeplist.sh
     |  |  |  └─Plist
     |  |  ├─Resources
     |  |  |  ├─APASConfig.ini      // APAS device level configuration file
     |  |  |  └─INTLConfig.ini      // Player Network SDK main configuration file
     |  ├─Encrypt
     |  ├─INTLConfig.Build.cs
     |  ├─INTLConfig.uplugin  
     |  ├─Private
     |  ├─Public
     |  └─Resources
     ├─INTLCore

2. 加载所需的权限和插件

在配置文件中添加 Player Network SDK 相关配置。

例如，对于 Facebook 插件配置，应根据自己的游戏修改 Facebook 配置。

Player Network SDK 1.18 及之后版本
Player Network SDK 1.18 之前版本

根据 SDK 版本打开对应的文件进行修改：

V1.24 及之后版本：INTLSDK/Source/INTLFacebook/Libs/iOS/INTLFacebook_UPL.xml
V1.18 至 V1.23：INTLSDK/Source/INTLConfig/Configs/iOS/Plist/INTLFacebook.plist

<key>CFBundleURLSchemes</key>
<array>
    <string>fb{INTL_FACEBOOK_APP_ID}</string>
</array>

进入 Unreal Engine > Settings > Project Settings > Platforms > iOS > Extra Plist Data 修改配置并在 PLIST 文件中添加 SDK。

图片：Extra Plist Data

<key>LSApplicationQueriesSchemes</key>
<array>
    <string>fb</string>
    <string>fb-messenger-api</string>
    <string>fbshareextension</string>
    <string>fbauth2</string>
    <string>fb-messenger-share-api</string>
    <string>fbapi</string>
</array>
<key>CFBundleURLTypes</key>
<array>
    <dict>
        <key>CFBundleURLName</key>
        <string>Facebook</string>
        <key>CFBundleTypeRole</key>
        <string>Editor</string>
        <key>CFBundleURLSchemes</key>
        <array>
            <string>fb{INTL_FACEBOOK_APP_ID}</string>
        </array>
    </dict>
</array>

iOS 使用说明

警告

集成时，用户可根据自己的需要修改内容，并 与法律团队确认内容是否合规。如果没有修改，请用游戏名称替换 INTLSample。

根据 iOS 权限要求，在申请敏感权限时，当系统弹出提示用户填写信息时，填写用途描述。

在 Plugins/INTLSDK/Source/INTLConfig/Configs/iOS/Plist/INTLCore.plist 中，以下权限已升级：

<key>NSPhotoLibraryUsageDescription</key>
<key>NSCameraUsageDescription</key>
<key>NSLocationWhenInUseUsageDescription</key>
<key>NSPhotoLibraryAddUsageDescription</key>
<key>NSMicrophoneUsageDescription</key>

在 Plugins/INTLSDK/Source/INTLConfig/Configs/iOS/Plist/INTLADTracking.plist 中，以下权限已升级：
```
<key>NSUserTrackingUsageDescription</key>
```

3. Swift SDK 兼容设置

版本要求：iOS SDK 9 及更高版本

如果模块使用 Swift SDK，将出现 iOS Swift 和 Objective-C 混合编辑问题。按照以下步骤操作创建桥接层，使两种编程语言的类名保持一致：

创建新文件并选择 SWIFT 文件类型。
根据需要指定文件名，并确保扩展名为 .swift，然后点击 Create。
点击 Create Bridging Header。
注意
确保选择 Create Bridging Header，否则 Xcode 将不会创建桥接层文件。
确保在 Xcode 项目中创建了两个文件（一个是步骤2 中创建的 .swift 文件，另一个是自动创建的 project_name-Bridging-Header.h 文件）。
注意
文件内容保持不变。

添加 iOS swift 模块到 Unreal Engine

iOS swift 模块不能直接添加到 Unreal Engine 中，必须先修改引擎配置。

使用 Xcode 12 或更高版本时，必须在 /Plugins/INTLSDK/Source/INTLCore/INTLCore.Build.cs 中添加以下代码。
```
PublicSystemLibraryPaths.Add("/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/iphoneos");
PublicSystemLibraryPaths.Add("/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift-5.0/iphoneos");
```
注意
因为 Player Network SDK 已经提前设置了以下配置，所以在使用其他 Xcode 版本时可以跳过这一步。
由于在使用 Xcode 12 及更高版本的 Swift lib 编译 Unreal Engine 时会报告以下错误，因此只有在使用 Xcode 12 及更高版本时才需要此步骤来解决问题。

修改本地 Unreal Engine 源代码。

在 /Your_UE_Installation_Path/Engine/Source/Programs/UnrealBuildTool/ProjectFiles/Xcode/XcodeProject.cs 的 private void AppendProjectBuildConfiguration(StringBuilder Content, string ConfigName, string ConfigGuid) 函数中添加以下代码。

// Enable Swift
Content.Append("\t\t\t\tCLANG_ENABLE_MODULES = YES;" + ProjectFileGenerator.NewLine);
Content.Append("\t\t\t\tSWIFT_VERSION = 5.0;" + ProjectFileGenerator.NewLine);
Content.Append("\t\t\t\tLIBRARY_SEARCH_PATHS = \"$(TOOLCHAIN_DIR)/usr/lib/swift/$(PLATFORM_NAME)\";" + ProjectFileGenerator.NewLine);
if (ConfigName == "Debug")
{
    Content.Append("\t\t\t\tSWIFT_OPTIMIZATION_LEVEL = \"-Onone\";" + ProjectFileGenerator.NewLine);
}
Content.Append("\t\t\t\tALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;" + ProjectFileGenerator.NewLine);
Content.Append("\t\t\t\tEMBEDDED_CONTENT_CONTAINS_SWIFT = YES;" + ProjectFileGenerator.NewLine);

图片：Unreal Swift Configuration 5

在 /Your_UE_Installation_Path/Engine/Source/Programs/UnrealBuildTool/Platform/IOS/IOSToolChain.cs 的 string GetLinkArguments_Global(LinkEnvironment LinkEnvironment) 函数中添加以下代码。

Before XCode 12
XCode 12 and later

// enable swift support
Result += " -rpath \"/usr/lib/swift\"";
Result += " -rpath \"@executable_path/Frameworks\"";
// /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/usr/lib/swift/
String swiftLibPath = String.Format(" -L {0}Platforms/{1}.platform/Developer/SDKs/{1}{2}.sdk/usr/lib/swift",
    Settings.Value.XcodeDeveloperDir, 
    bIsDevice? Settings.Value.DevicePlatformName : Settings.Value.SimulatorPlatformName, 
    Settings.Value.IOSSDKVersion);
Result += swiftLibPath;
Log.TraceInformation("Add swift lib path : {0}", swiftLibPath);
///Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/iphoneos
swiftLibPath = String.Format(" -L {0}Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/{1}",
    Settings.Value.XcodeDeveloperDir, 
    bIsDevice? Settings.Value.DevicePlatformName.ToLower() : Settings.Value.SimulatorPlatformName.ToLower());
Result += swiftLibPath;
Log.TraceInformation("Add swift lib path : {0}", swiftLibPath);
///Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift-5.0/iphoneos
swiftLibPath = String.Format(" -L {0}Toolchains/XcodeDefault.xctoolchain/usr/lib/swift-5.0/{1}",
    Settings.Value.XcodeDeveloperDir, 
    bIsDevice? Settings.Value.DevicePlatformName.ToLower() : Settings.Value.SimulatorPlatformName.ToLower());
Result += swiftLibPath;

图片：Unreal Swift Configuration 3

// This line of code must be prepended (see the sample image below for the position of the prepended code)
// enable swift support, make sure '/usr/lib/swift' goes before '@executable_path/Frameworks'
Result += " -rpath \"/usr/lib/swift\"";

图片：Unreal Swift Configuration 6

// enable swift support
Result += " -rpath \"@executable_path/Frameworks\"";
// /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/usr/lib/swift/
String swiftLibPath = String.Format(" -L {0}Platforms/{1}.platform/Developer/SDKs/{1}{2}.sdk/usr/lib/swift",
    Settings.Value.XcodeDeveloperDir, 
    bIsDevice? Settings.Value.DevicePlatformName : Settings.Value.SimulatorPlatformName, Settings.Value.IOSSDKVersion);
Result += swiftLibPath;
Log.TraceInformation("Add swift lib path : {0}", swiftLibPath);
///Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/iphoneos
swiftLibPath = String.Format(" -L {0}Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/{1}",
    Settings.Value.XcodeDeveloperDir, 
    bIsDevice? Settings.Value.DevicePlatformName.ToLower() : Settings.Value.SimulatorPlatformName.ToLower());
Result += swiftLibPath;
Log.TraceInformation("Add swift lib path : {0}", swiftLibPath);
///Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift-5.0/iphoneos
swiftLibPath = String.Format(" -L {0}Toolchains/XcodeDefault.xctoolchain/usr/lib/swift-5.0/{1}",
    Settings.Value.XcodeDeveloperDir, 
    bIsDevice? Settings.Value.DevicePlatformName.ToLower() : Settings.Value.SimulatorPlatformName.ToLower());
Result += swiftLibPath;

// Xcode 12 adds the swiftCompatibility51 library, so you need to add the following code
if (Settings.Value.IOSSDKVersionFloat >= 14.0f)
{
        Result += String.Format(" -lswiftCompatibility51");
}

图片：Unreal Swift Configuration 7

打开解决方案并重新编译 /Users/intl/UE4/UE_4.25/Engine/Source/Programs/UnrealBuildTool/UnrealBuildTool.sln。

4. 合并隐私清单

版本要求：Player Network SDK V1.22 及更高版本

从 2024 年春季开始，对于需更新或上传至 Apple App Store Connect 的应用，开发者需明确注明使用原因，以展示该应用如何使用 required reason API（需提交使用原因的 API）。更多信息，请参见即将发布的第三方 SDK 要求。

对于受影响的 Player Network SDK 插件，需要手动合并的包括 INTLFoundation、INTLCore、INTLGarena，其中 INTLGarena 只在项目确认接入 Garena 时需配置。
另外，INTLLine 已在 Player Network SDK 自动整合而无需额外操作。

由于其他第三方 SDK 的隐私清单尚未公布，目前 Player Network SDK 隐私清单中不包含对应的内容。要查看尚未发布插件的列表，请参见 iOS 17 隐私清单。

步骤

在 Player Network SDK 产物目录内找到所需插件的隐私清单 PrivacyInfo.xcprivacy。

Unity
Unreal Engine

插件	路径
INTLFoundation	/Plugins/iOS/INTLSDK/INTLFoundation/INTLFoundation.framework/PrivacyInfo.xcprivacy
INTLCore	/Plugins/iOS/INTLSDK/INTLCore/INTLCore.framework/PrivacyInfo.xcprivacy
INTLGarena	/Plugins/iOS/INTLSDK/INTLGarena/INTLGarena.framework/PrivacyInfo.xcprivacy

插件	路径
INTLFoundation	/INTLSDK/Source/INTLFoundation/Libs/iOS/INTLFoundation/INTLFoundation.embeddedframework/INTLFoundation.framework/PrivacyInfo.xcprivacy
INTLCore	/INTLSDK/Source/INTLCore/Libs/iOS/INTLCore/INTLCore.embeddedframework/INTLCore.framework/PrivacyInfo.xcprivacy
INTLGarena	/INTLSDK/Source/INTLGarena/Libs/iOS/INTLGarena/INTLGarena.embeddedframework/INTLGarena.framework/PrivacyInfo.xcprivacy

将 Player Network SDK 内的 PrivacyInfo.xcprivacy 中的4个节点，用于与游戏项目内 PrivacyInfo.xcprivacy 中对应的内容进行比较，并根据以下条件合并。
1. Privacy Nutrition Label Types (NSPrivacyCollectedDataTypes) 为使用数据的类型描述节点：
  比较各个 item 的 Collected Data Type (NSPrivacyCollectedDataType)，有不同值则添加至游戏项目文件。
  若存在相同值则比较 Collection Purposes (NSPrivacyCollectedDataTypePurposes)，有不同值则添加至游戏项目文件。
2. Privacy Tracking Domains (NSPrivacyTrackingDomains) 为域名追踪列表节点：
  比较对应节点，有不同值则添加至游戏项目文件。
3. Privacy Tracking Enabled (NSPrivacyTracking) 描述是否开启 App Tracking Transparency 功能：
  比较对应节点，Player Network SDK 隐私清单的值为 YES 时修改游戏项目文件。
4. Privacy Accessed API Types (NSPrivacyAccessedAPITypes) 为使用接口的类型描述节点：
  比较各个 item 的 Privacy Accessed API Type (NSPrivacyAccessedAPIType)，有不同值则添加至游戏项目文件。
  若存在相同值则比较 Privacy Accessed API Reasons (NSPrivacyAccessedAPITypeReasons)，有不同值则添加至游戏项目文件。
通过 Xcode 15 生成隐私报告来验证是否符合预期。

5. Player Network SDK 配置

注意

手动修改 INTLConfig.ini 配置时，请联系 Player Network 助手确认内容变更是否符合预期，详见 SDK Config Information。

请按照 INTLConfig.ini 的说明进行相应配置。

6. 初始化 Player Network SDK

在集成第三方渠道之前，必须先初始化 Player Network SDK。更多详情，请参见初始化 SDK。

UINTLSDKAPI::Init();

步骤2：验证 Player Network SDK 接入成功

修改 INTLConfig.ini 文件中 INTL Log 节点下的配置。

[INTL Log]
LOG_LEVEL = 1
LOG_ENCRYPT_ENABLE = 0
LOG_COMPRESS_ENABLE = 0
LOG_CONSOLE_OUTPUT_ENABLE = 1
LOG_FILE_OUTPUT_ENABLE = 1

运行程序，当日志中显示 Init INTL SDK success. 时，表示接入成功。

前提条件​

步骤1：安装 SDK​

1. 将 Player Network SDK 添加到您的项目​

2. 加载所需的权限和插件​

iOS 使用说明​

3. Swift SDK 兼容设置​

添加 iOS swift 模块到 Unreal Engine​

4. 合并隐私清单​

5. Player Network SDK 配置​

6. 初始化 Player Network SDK​

步骤2：验证 Player Network SDK 接入成功​

推荐使用​