跳到主要内容

iOS自动接入工具使用指南

1 简介​

该工具将SDK接入操作及配置自动化，大大简化了研发接入SDK的步骤。工具的作用对象为Xcode工程，如果游戏是基于Unity或Cocos开发的，那么必须将游戏工程导出为Xcode工程后才可以使用本工具。

建议环境：

  • Unity：2018.4.31f1及以上
  • CocosCreator：3.0.0及以上
  • Xcode：12.4及以上
  • macOS：11.2.2及以上

2 使用说明​

2.1 下载SDK包​

请在SDK下载页选择好需要接入的登录方式及游戏引擎，并下载SDK包（含工具）。

SDK包包含（目录层级及文件名不可更改）：

  • sdk：TopSdk的主库
  • plugins：插件资源
  • TopSDKTool：自动接入工具程序
  • cocos：cocos引擎插件，如果您在下载页选择了cocos引擎，才会有该目录
  • unity：unity引擎插件，如果您在下载页选择了unity引擎，才会有该目录

tips：如果您是iOS原生工程，可跳过2.2、2.3直接查看2.4

2.2 导入插件（Unity、Cocos）​

2.2.1 Unity​

详细的unity接入说明可查看Unity接入文档

请将下载的SDK包中unity目录下的xxx.unitypackage包导入工程，按以下步骤操作进行插件导入：

  • 在 Unity 菜单栏中，依次点击 Assets > Import Package > Custom Package

  • 找到 xxx.unitypackage 文件的下载位置并选择该文件

  • 在 Import Unity Package 对话框中，全选并点击 Import

    unity_add_gradle

2.2.2 Cocos​

详细的unity接入说明可查看Cocos插件接入文档

请将下载的SDK包中的cocos目录下的TopSDK.ts复制到工程目录->assets下即可

2.3 导出Xcode工程（Unity、Cocos）​

2.3.1 Unity​

在菜单->File->Build Setting弹窗中，选择iOS平台，并点击Build导出工程

2.3.2 Cocos​

在CocosCreator中的菜单->项目->构建发布弹窗中，点击新建构建任务，发布平台选择iOS，点击构建即可

2.4 运行工具​

双击TopSDKTool会弹出命令行窗口，按照工具提示进行操作即可

tips：如果该文件没有可执行权限，请先在终端输入以下命令进行授权

chmod 777 【TopSDKTool文件路径】
例：chmod 777 ~/Desktop/TopSDKTool

2.4.1 获取渠道参数​

按照您下载的TopSDK插件配置，参考渠道参数申请指南申请并配置三方登录服务，获取接入参数并交付给TopSDK管理人员。

2.4.2 输入appId和appSecret​

参照提示，选择游戏引擎（不在支持项中的，选择iOS原生即可）,输入序号（0或1或2）并回车进行选择

请输入appId：这里填写SDK分配的appId
请输入appSecret：这里填写SDK分配的appSecret

2.4.3 选择开发引擎​

选择游戏引擎
1 unity
2 cocos
3 ios
请输入序号进行选择：根据项目开发引擎选择

如果是unity引擎，由于版本差异性，还需要选择引擎版本

选择unity版本（如果没有，请选择最接近的版本）：
1 2017.4.40c1
2 2018.4.31f1
3 2019.4.28f1c1
4 2020.2.3f1c1
5 2020.3.1f1c1
6 2021.1.14f1c1
7 other
请输入序号进行选择：选择对应版本，如不在罗列版本内，请选择最接近的版本

2.4.4 输入.xcodeproj文件路径​

输入工程中的.xcodeproj文件的完整路径，可通过将.xcodeproj文件拖入终端窗口自动填入

请输入工程（.xcodeproj）文件路径：将导出的xcode工程文件，以.xcodeproj结尾的文件拖入终端即可

2.4.5 检查结果​

2.4.5.1 配置接入结果​

配置接入完成，则可以看到如下输出：

*** 工程配置结束 ***

没有这行输出的，则都为接入失败，请参照提示信息修改

2.4.5.2 自动接口接入结果​

在配置接入成功后，会对适配过的工程进行自动接口接入（应用生命周期监听接口），如果接入成功，则会有如下输出：

检测到工程UIApplicationDelegate实现类，将自动接入对应接口
自动接入完成

如果工程检测到多个UIApplicationDelegate实现类，则需根据提示选择后进行接入：

请选择打包Target对应的UIApplicationDelegate实现类（我们将执行自动接口接入）：

如果自动接口接入出现异常，导致接入失败，则有如下输出：

自动接入失败，请参照在线文档（https://open-gameplus.meetsocial.com/sdk-wiki/ios_api/#11）自行接入

如果自动接口接入不成功，请参照iOS接口说明 12 自行接入

如果接入了数据上报服务，请参照TOPData接口说明