文章目录
SDK合规指南
1 文档修订记录
| 文档版本 | 文档更新日期 | 文档更新内容 |
|---|---|---|
| 3.3.53 | 2024.03.21 | 1.「4.1.1 导出Xcode工程」新增权限国际化 |
| 3.3.30 | 2021.11.18 | 文档改版 |
2 接入准备
推荐 C#4 以上版本，如果游戏是4及以下版本，可能会无法支持新特性
推荐Unity2018及以上版本
2.1 添加文件
- 将文件
FYBase.unitypackage与FYService.unitypackage先后导入到您的Unity工程的Assets文件夹下 - 导入方式：打开UNITY工程，菜单栏Assets=>Import Package=>Custom Package... ，之后选择文件导入工程
2.2 配置DLL文件平台属性
UNITY项目中，选择对应Dll文件，在Inspector面板=>Select platforms for plugin 勾选对应平台
如果已经配置，请忽略此步骤
- Assets\Plugins\FYBase\FYBase.dll勾选"Any Platform",并勾选"iOS"和“Android”以排除这2平台
- Assets\Plugins\FYBase\Android\FYBase.dll选择平台为"Android",注意"Any Platform"不要打钩
- Assets\Plugins\FYBase\iOS\FYBase.dll选择平台为"iOS",注意"Any Platform"不要打钩
- Assets\Plugins\FYService\FYService.dll选择平台为"Any Platform"
2.3 添加SDK配置
- 打开"星云平台->对接中心->SDK对接->SDK 列表->基础接入参数"，找到 App ID、App Key、Company ID
- 在UNITY打开星云配置界面
- 将 App ID、App Key、Company ID 填入对应输入框，选择游戏屏幕朝向，点击
确定，完成配置
2.4 开启调试模式
1.将配置界面中的Debug勾选并点击确定，即可开启「调试模式」；取消勾选并点击确定，即关闭「调试模式」。
2.开启「调试模式」会显示客户端的悬浮球，点击进入调试工具可以查看接口/回调的调用信息，具体调试方法可查看文档。
2.5 引入命名空间
游戏代码中引入以下命名空间，开始接入。
using FYService;3 客户端接口
3.1 初始化接口(必接)
1.方法
void DoInit(string channelId = "", string appId = "", string appKey = "")
2.说明
- 在刚启动游戏的时候调用
3.调用
FYServiceBridge.Instance.DoInit();4.参数
| 参数名 | 说明 | 是否必传 |
|---|---|---|
| channelId | 自定义渠道ID，数字格式。如有设置，则使用自定义渠道ID；如未设置：1.默认使用配置文件中的渠道ID 2.如有接入星云聚合SDK，则渠道ID与最终渠道包的一致 |
否 |
| appId | 保留字段，不需传参 | 否 |
| appKey | 保留字段，不需传参 | 否 |
3.2 登录前调用客服接口
1.方法
void BeforeLogin(string gameVersion)
2.说明
- 在登录之前调用跳转客服系统，只需要传入游戏版本号即可。
3.调用
FYServiceBridge.Instance.BeforeLogin(gameVersion);4.参数
| 参数 | 说明 | 是否必传 |
|---|---|---|
| gameVersion | 游戏版本号 | 是 |
3.3 登录后进入游戏前调用客服接口
1.方法
void BeforeEnterGame(string gameVersion, string openId)
2.说明
- 在登录成功之后，尚未进入游戏时调用跳转客服系统。
3.调用
FYServiceBridge.Instance. BeforeEnterGame(gameVersion, openId);4.参数
| 参数名 | 说明 | 是否必传 |
|---|---|---|
| gameVersion | 游戏版本号 | 是 |
| openId | 用户唯一id | 是 |
3.4 进入游戏后调用客服接口(必接)
1.方法
void AfterEnterGame(string gameVersion, string openId, string serverId, string serverName, string playerId, string playerName, string playerLevel, string playerLevelVip)
2.说明
- 进入游戏后调用跳转客服系统。
3.调用
FYServiceBridge.Instance.AfterEnterGame(gameVersion, openId, serverId, serverName, playerId, playerName, playerLevel, playerLevelVip);4.参数
| 参数名 | 说明 | 是否必传 |
|---|---|---|
| gameVersion | 游戏版本号 | 是 |
| openId | 用户唯一id | 是 |
| serverId | 游戏服id | 是 |
| serverName | 游戏服名称 | 是 |
| playerId | 角色id | 是 |
| playerName | 角色名称 | 是 |
| playerLevel | 角色等级 | 是 |
| playerLevelVip | 角色vip等级 | 是 |
4 原生端对接
4.1 iOS
4.1.1 导出Xcode工程
-
将UNITY项目导出为XCODE工程，然后就可以在Xcode开发工具上调试了
-
如果是海外游戏，请下载客服权限国际化文件，解压后将里面的文件添加到Xcode工程中
4.2 Andorid
4.2.1 导出Android工程
- 方式一：使用UNITY打包Android APK调试
- 方式二：将UNITY项目导出为Android Studio工程，然后就可以在Android Studio开发工具上调试了
5 F&Q
5.1 导出Android Studio或Xcode项目报错
该情况有可能是因为UNITY配置界面未配置完成，请查看该文档的添加SDK配置部分，重新操作一次