SDK对接文档

主题

WARNING

💡 模块名:GameHelper.Network

B站小游戏项目构建 ​

官方文档：https://miniapp.bilibili.com/small-game-doc/engine/common

  1. 引入构建工具扩展（采用官方文档的手动适配方案修改构建工程），解压放入游戏工程extensions目录下

扩展工具：

线下联系业务同事获取bilibili-adapter.zip

  • 编辑器选择构建微信小游戏

  • 构建面板最底下勾选上自动替换B站适配文件

必接功能 ​

1. 启动场景上报 ​

  • 在游戏可交互 - 用户最早可操作游戏的时候调用GameHelper.BLBLBase.reportScene接口上报；

示例：

javascript
GameHelper.BLBLBase.reportScene({
            success: () => {
                console.log("场景上报成功")
            },
            fail: () => {
                console.log("场景上报失败")
            }
        });

2. 添加桌面 ​

SDK提供两个接口，一个用于检查用户是否已经将游戏添加到桌面，一个用于拉起添加桌面的弹窗。使用时先判断是否添加到桌面，若没有则调用添加桌面接口

接口 ​

GameHelper.AddDesk.checkIsAdd ​

参数类型默认值是否必填说明
callbackFunction/是回调

GameHelper.AddDesk.addDesk ​

参数类型默认值是否必填说明
callbackFunction/是回调

示例 ​

javascript
//先判断用户是否添加到桌面
GameHelper.AddDesk.checkIsAdd((isAdd)=>{
            if(isAdd){
                console.log("已经添加到桌面");
            }else{
                console.log("未添加到桌面");
                GameHelper.AddDesk.addDesk((res)=>{
                    console.log("添加桌面是否成功",res);
                })
            }
        })

3. 侧边栏 ​

B站侧边栏逻辑链路图：


设计物料参考 ​

游戏需要根据本游戏整体风格及定位，设计相关图片素材，包括不限于礼包领取入口、点击礼包后引导弹窗及内容，可根据基础版动图引导，替换成自己游戏的 icon

内容建议文案建议设计
任务入口文案需直观，快速让用户理解，建议为 「限定福利」「入口有奖」等
任务界面建议包含以下内容
1.顶部标题：「侧边栏进入领取奖励」
2.步骤文案：
  (1) 点击下方「去首页侧边栏」按钮按钮
  (2) 在侧边栏，点击「XXXXX」（游戏名）
  (3) 返回游戏，领取奖励
3.按钮文案：去首页侧边栏（未完成态）/ 立即领奖（完成态）
4.需注意设计关闭弹窗的按钮		可以使用B站提供的设计物料也可以自己设计
任务频次因复访习惯需要逐步养成，建议奖励设置为「每日」可领取，加强用户感知及留存

接口 ​

模块名：BLBLSidebar

属性 ​
属性类型说明
supportboolean是否支持侧边栏
enterBySidebarboolean是否通过侧边栏进入
方法 ​

BLBLSidebar.toSidebar

参数 ​
属性名类型默认值是否必填说明
optParams/否跳转到侧边栏（会将游戏切到后台）

Params

Object

属性名类型是否必填说明
successFunction否成功回调
failFunction否失败回调

示例

javascript
if(GameHelper.BLBLSidebar.enterBySidebar){
    //从侧边栏进入
    //...其余逻辑代码
}else{
    //不是测边栏进入
    //...其余逻辑代码
}

//给跳转侧边栏按钮使用
function jumpToSiderbar(){
    GameHelper.BLBLSidebar.toSidebar({
            success: () => {
                console.log("跳转侧边栏成功");
            },
            fail: () => {
                console.log("跳转侧边栏失败");
            }
        })
}
点我快速对接