guofei 4fe0162b34 | ||
---|---|---|
.. | ||
README.md | ||
p1.png | ||
p2.png | ||
p3.png | ||
p4.png |
README.md
一.开发环境准备
- Egret Launcher 1.0.65 以上版本
- 白鹭引擎 5.2.23 以上版本
- 在电脑中安装 npm:下载地址
- 在电脑中安装 adb 工具:下载地址
- 最新版本的 vivo 小游戏引擎(平台版本1041+)下载地址
- 更多 vivo 小游戏 API 文档,请访问小游戏支持网站:网站地址
二.创建小游戏和可视化编译打包小游戏
- 使用最新的 Egret Launcher 创建一个 Egret 游戏项目,引擎使用 5.2.23 以上版本。 创建完成后,会在 Egret Launcher 的列表里看到该项目。点击发布设置:
- 选择
vivo小游戏
标签,点击确定
,创建项目 - 创建成功后,点击
发布
标签,可以可视化的发布小游戏包- 编译游戏代码到小游戏:相当于执行命令
egret build --target vivogame
,把游戏的代码编译到小游戏的项目里 - 发布:相当于执行命令
npm run build
,把小游戏工程,编译成rpk
包 - 调试:使用 USB 连接手机和电脑后,点击调试,会把
rpk
上传到手机中,然后启动一个Chrome
窗口,可以调试手机中运行的小游戏
- 编译游戏代码到小游戏:相当于执行命令
三.使用命令行把白鹭游戏编译到小游戏项目
方法1:开发者可以使用命令行来编译和发布到 vivo 小游戏项目中:
- dubug 模式:
egret build --target vivogame
- release 模式:
egret publish --target vivogame
方法2:配置 egretProperties.json
"engineVersion": "5.2.23",
"compilerVersion": "5.2.23",
"template": {},
"target": {
"current": "vivogame"
},
如上所示,将 egretProperties.json
配置文件中的 current
属性设置为 vivogame
时,可以直接使用egret build
或者 egret publish
命令编译和发布 vivo 小游戏。
四.使用命令行打包发布 vivo 小游戏
-
进入小游戏项目,在命令行里执行编译命令
npm run build
,成功后会生成一个dist
文件夹,里面的com.application.demo.rpk
文件就是打包好的小游戏项目,可以在手机上运行调试。 -
如果执行命令
npm run release
,则会生成正式发布的小游戏项目。注意,发布正式项目,需要在sign/release/private.pem
路径下自己准备签名文件。 -
项目代码目录的结构如下
- 目录结构说明
- egret.vivogame.js: 白鹭引擎与小游戏的适配层
- js 文件夹:游戏项目的代码
- game.js:项目入口文件
- manifest.js:用来引用所有的 js 代码
- manifest.json:小游戏的相关参数设置
- resource 文件夹:游戏资源文件
- sign 文件夹:签名文件存放的位置
- manifest.json 配置说明
{
"package": "com.application.demo",
"name": "vivogame",
"versionName": "1.0.0",
"versionCode": "1",
"minPlatformVersion": "1030",
"icon": "/icon/logo.png",
"orientation": "portrait"
}
- 参数说明
- package:应用包名
- name:应用名称,6 个汉字以内,与应用商店保存的名称一致,用于在桌面图标、弹窗等处显示应用名称
- versionName:应用版本名称
- versionCode:应用版本号,从1自增,推荐每次重新上传包时versionCode+1
- minPlatformVersion:支持的最小平台版本号
- icon:应用图标的路径
- orientation:支持的屏幕方向。portrait 为竖屏,landscape 为横屏。该参数会自动从白鹭游戏项目的 index.html 里获取。
四.真机调试调试
**注意:**一定要使用 vivo 手机才可以调试
1.在 vivo 手机上安装 快应用调试器
3.打开快游戏调试器,点击 扫码安装
,扫描 EgretLauncher 发布 vivo 小游戏界面里的二维码。
升级指南
因为 vivo 小游戏项目结构升级,从白鹭引擎 5.2.28 开始不再支持老版本的结构,需要您升级一下游戏项目。
注意:如果是老项目 (xxx_vivogame),请删除原来的 vivo 小游戏项目,重新创建项目!!
Egret 项目升级方法1
- 1.使用 EgretLauncher 下载白鹭引擎 5.2.28 版本
- 2.执行
egret upgrade --egretversion 5.2.28
- 升级将会把您项目中的
scripts/config.vivogame.ts
和scripts/vivogame/vivogame.ts
这两个文件替换掉。如果您修改了这2个文件,请提前做好备份,升级完成以后再进行对应修改。
- 升级将会把您项目中的
Egret 项目升级方法2
- 1.使用 EgretLauncher 下载白鹭引擎 5.2.28 版本
- 2.新创建一个游戏项目,将项目中
scripts/config.vivogame.ts
和scripts/vivogame/vivogame.ts
这两个文件替换您原来项目里对应的文件
常见问题排查
如果您的 vivo 小游戏项目不能运行,请先检查下面这些流程是否正确