SDK对接文档

主题

WARNING

💡 Unity bilibili小游戏

注意

  1. 目前推荐unity版本为2021.3.39f1，也可使用 2022 版本

  2. 不支持 webgl 2.0 ，需要将 webgl 版本改为 1.0

准备工作 ​

  1. 切换并安卓b站小游戏插件

  • 修改小游戏启动模式

导入配置 ​

需要切 WebGL 平台

并需要将 webgl 选中为 webgl 1.0 版本

导入游戏配置

设置项目 ​

Debug 模式的开启或关闭

发最后一共正式包时，一定要取消调试模式

下载b站开发者工具 ​

https://miniapp.bilibili.com/small-game-doc/open/ide-update/

bilibili必须接入功能 ​

添加到桌面 ​

将小游戏图标添加到桌面

c#
ZMYSDKManager.I.XYXHandler.CreateShortcut(Action<bool> isSuccess);

侧边栏复访能力 ​

WARNING

  1. 能力入口可放置在游戏首页显眼位置，并着红色或者抖动提醒
  2. 点击侧边栏复访按钮，展示界面对玩家有明确的引导，并给予一定的游戏奖励
  3. 每日奖励领取完后，展示界面按钮文字由“领取”变为“明日再来”，复访按钮入口不消失，保持常驻
  4. 可与运营沟通具体设计方案，将复访引导与 7 日任务或者签到任务等结

是否支持侧边栏

c#
//先检查是否支持，再决定是否跳转
ZMYSDKManager.I.XYXHandler.CheckSupportSide(CheckCallback);
void CheckCallback(bool isSupportSide)
{
    UnityEngine.Debug.Log($"是否支持侧边栏  {isSupportSide}");
}

是否是侧边栏启动

c#
//这里先判断是否支持侧边栏，回调里面再判断是否是侧边栏启动
bool isOn = ZMYSDKManager.I.XYXHandler.CheckLaunchFormSide();
UnityEngine.Debug.Log($"是否是侧边栏启动  {isOn}");

跳转到侧边栏

c#
ZMYSDKManager.I.XYXHandler.JumpToSide();

构建与调试 ​

构建面板 ​

Unity 菜单栏选择：BiliGame=>b站小游戏打包面板

打开面板时会自动设置好 appid，以及复制打包需要的文件

配置构建面板 ​

  1. 配置 CDN 地址

b站必须配置 cdn 否则无法运行

  • 设置背景图

  • 设置导出路径

  • 其他设置，与微小类似，按需修改

安装b站包转化工具 ​

勾选自动转换成 bilibili 小游戏

点击安装最新版 哔哩哔哩 CLI 工具，等待完成后会刷新显示的 CLI 版本

安装时间较长，请耐心等待

如果安装失败，可以考虑挂梯子之后安装

打包构建 ​

自动转换的情况 ​

  1. 勾选自动转换成 bilibili 小游戏

  2. 点击“打包并自动转换成bilibili小游戏”

  3. 等待打包完成，时间大概在10分钟左右

  4. 构建产物如下图，其中 CDN_Res 下的内容要上传到前面配置的 cdn

  • 然后使用 bilibili开发者工具打开 biligame 文件夹即可

手动转换的情况（不推荐） ​

  1. 取消勾选自动转换成 bilibili 小游戏

  2. 点击最下方的“导出WEBGL并转换成小游戏（常用）”

  • 打包完成后使用 bilibili 开发者工具转换

  • 转换完成后点击“处理使用开发者工具手动转换成bilibili小游戏的包”

  • 注意选择的文件夹路径为biligame的父文件夹

  • 执行完毕后， CDN_Res 下的内容要上传到前面配置的 cdn

  • 最后使用bilibili开发者工具重新打开biligame 文件夹

上传资源 ​

CDN_Res 文件夹下的内容需要上传到服务器上

必须上传，B站小游戏不支持资源在包内的情况

调试 ​

操作跟微小开发者类似，点击预览可以扫码使用真机测试

IOS 无法使用预览，必须上传之后使用上传后的码才能测试

合法域名处理 ​

什么是合法域名 ​

在小程序后台的开发设置中， 有一处配置。合法域名的地方。

其中将域名分为几个大类，我们重点关注 request，socket，download。

request 就是常规的 http 请求，get,post。

socket 请求 webgl 使用 wss 域名

download 就是我们的 cdn 地址。这里有一点需要注意，cdn 地址除了配置到 download 中，还需要配置到 request 中

为什么要配置这个 ​

小游戏严格限制了请求的地址信息，只有配置上的地址 才能成功的进行访问。所有的配置的域名都是要求经过备案的，否则无法配置。

哪些需要配置 ​

联系对应得运营，在后台进行添加：

所有的 域名 不带端口的 配置到域名级，带端口的请求需要带上端口，举个例子

plain text
原始  https://log.328vip.com/stat/index/initV2
配置  https://log.328vip.com

带端口的
原始  https://pay.wedobest.com.cn:8449/xxx/bbb/ccc
配置  https://pay.wedobest.com.cn:8449

发布 ​

点击上传按钮，填写版本和描述日志之后点击确定

常见问题QA ​

1. 打包报错如下图 1 ，Cannt read property 'type' of underfined ​

找到报错对应的打包脚本，添加非空判定之后可以正常打包

2. IOS 相关问题 ​

2.1 无法预览 ​

目前也不支持pad

2.2 IOS 看不到打印 ​

b站问题，官方正在修复中

2.3 IOS 的 ugui mask 组件失效 ​

2022打b站包在 ios 上，ugui mask 组件会失效，替换成 RectMask2D 组件即可

3. unity2022打包无法播放音频问题 ​

音频设置修改成 Compressed In Memory

4. 卡加载进度条 ​

大部分是因为 webgl.data 文件没上传到 cdn，或者是域名白名单没配置好导致的 webgl.data 文件下载失败，价差资源是否已上传到 CDN，并且检测域名白名单是否配置正确

点我快速对接