虎牙小游戏 - 开发指南
介绍
虎牙小游戏是一类通过游戏引擎开发并直接下发到虎牙终端运行的游戏类应用程序，支持的终端包括虎牙观众端(安卓)，适配 Cocos、Laya、Egret、Unity 游戏引擎。
合作咨询
联系官方获取合作指引
微信号：15625706431 邮箱：hy-ext@huya.com
开发指南
小游戏注册、管理、发布流程与小程序完全一致，全部在虎牙小程序开发者中心进行。
小游戏能使用所有小程序提供的能力，也支持在多终端下运行。目前暂支持移动端，其余端在开发中。
1. 创建小游戏
登陆虎牙小程序开发者中心，创建、管理这个账号下面的虎牙小游戏：
点击页面中间的“立即创建”按钮，弹出表单，选择构建类型为小游戏：
2. 申请权限
点击左侧菜单的权限管理，点击上方权限包标签页，找到相关开发小游戏的权限包：
点击下方申请按钮，完成申请，可以在上方申请进度里面查看申请结果。
3. 创建小游戏工程
参考小程序的快速开始搭建开发环境
环境要求
- 要求 Node 版本: >=14.0.0
- 推荐 Node 版本: 20.0.0+
创建一个空hygame-demo目录, 并在目录下执行命令：
npm install -g @hyext/cli
hyext init -b webview
在提示"请输入资源文件所在的目录"时, 选择默认值
h5Dir即可
选择终端类型的过程参考快速开始, 这里选择:
- 虎牙直播APP-小游戏
创建完成之后的目录结构类似如下：
├── hygame-demo
├── h5Dir
├── package.json
├── node_modules
└── project.config.json
其中project.config.json 是我们项目的配置文件.
4. 虎牙小游戏SDK
小游戏通过访问全局的 hy 对象来调用虎牙小游戏提供的能力, 全局对象 hy 由虎牙运行环境自动注入, 开发者无需关注其来源, 请参考API文档
在 H5 游戏开发过程中，为了提高效率，可先按照独立 H5 游戏的方式来开发调试，先不集成到虎牙终端中，涉及到虎牙小游戏 SDK 调用的部分，可采用 mock 的方式来模拟。
5. 导入游戏
在游戏开发完成后,
- COCOS 选择发布平台
web-mobile
- Laya 选择发布平台
Web
- Egret 选择发布平台
HTML5
并把游戏引擎的构建结果复制到 h5Dir 文件夹内
- Unity 适配请使用Unity适配方案。
6. 扫码预览
在项目根目录下面执行：hyext start 开启小游戏本地开发模式, 项目内会生成一个hyext_dist/build-result文件夹, 里面包含了小游戏的下发配置文件. 为了能在直播间预览小游戏, 需完成以下步骤:
创建小程序, 并把
hyext_dist/build-result内的文件拖到开发者中心的相关区域。在小游戏版本的程序配置中，配置适龄年龄与屏幕方向。
在小游戏版本的白名单设置中，添加开发者虎牙号至内测版本观众白名单(虎牙号)。
通过开发者后台，提交小游戏测试版本，点击小游戏版本，支持白名单开发者通过真机扫码进行小游戏的开发调试。
- 小游戏开发版本调试存在限制，推荐使用测试版本进行调试
- 使用虎牙直播App扫码功能，扫描调试二维码可进行真机调试。
- 安装最新的虎牙直播App
7. 提交测试
小游戏版本开发完毕后，可提交测试。 执行 hyext release 打包小游戏代码，然后上传到虎牙小程序平台。 参考文档程序配置, 提交测试
8. 调试
project.config.json 文件中添加devToolsExtTypes，重新启动小游戏即可查看。
9. 数据上报
- 联运小游戏上线前需接入数据上报。其中IAP游戏，必需上报角色和等级信息。
- 小游戏数据上报
10. 首屏体验优化
- 为了提升小游戏首屏体验，小游戏提供首屏插件，在不依赖游戏引擎的基础上，提供封面图渲染。
- 小游戏首屏插件
11. 发布小游戏
与小程序一致，参考文档版本发布