温馨提示：本指南主要介绍开发流程，不包含应用上架与发布相关的操作。如需了解小游戏接入的完整流程，请前往小游戏专区索引获取后续步骤的详细说明。

一、开发流程简述

注意事项：接入游戏前请阅读接入及上架指南了解平台接入规则并提前做好准备。

小米小游戏在开发流程上主要分为两个阶段：

1. 游戏逻辑开发阶段：使用引擎自带的 IDE（如 Cocos Creator、LayaAirIDE、Unity Editor 等）完成游戏本体开发。
2. 代码调试阶段：使用各引擎的导出能力生成“小米小游戏”工程，并通过小米提供的真机调试工具进行调试。

整体的开发流程如下：

• step1: 游戏开发者使用游戏引擎（cocos, unity, laya等）的IDE按照传统的基于引擎的开发模式去进行游戏开发
• step2: 游戏引擎厂商会为各平台的小游戏提供支持，提供可以将各自游戏工程构建出各平台小游戏工程的能力，所以在游戏逻辑开发完成之后，可以使用这些能力构建导出小米小游戏工程
• step3: 使用小米提供的打包工具打出游戏调试用的rpk包（各引擎IDE导出时亦集成了小米打包工具的调用，也可以在上一步生成工程的同时就生成游戏rpk包），使用真机调试器提供的调试能力，对游戏进行调试
• step4: 调试完成后打出最终要上线的release版本包体（区别调试时用的debug包），在小米开放平台进行审核、上架、投放发布

二、游戏开发

1.环境准备

• 安装node服务，建议安装node16及以上版本的NodeJS

下载地址：NodeJS官网

• 下载安装自己所使用引擎的IDE，若需了解详细的下载、安装及使用方法请参考各引擎官方网站，以下为常用引擎官网地址
• cocos官方网站
• Unity官方网站
• Laya官方网站

• 下载安装调试工具至测试机

下载地址：快应用调试器

• 确保手机上安装了版本较新版本的快应用服务框架，该服务框架为小游戏运行的环境，有三种更新方式：
  
• 方法一：打开手机应用商店，点击“我的-->应用升级-->快应用服务框架”，看是否有可用更新
• 方法二：部分机型较老，已退出维护名单，无法使用应用商店更新，需手动下载安装，下载后在命令行工具调用adb install -t {下载下来的.apk文件路径}进行安装
• 方法三：直接在手机浏览器中打开下载地址，然后点击对应快应用服务框架版本下的“下载”按钮，手机上会自动弹出一个弹窗，点击“快应用服务框架”旁的升级按钮即可升级安装

下载地址：快应用服务框架

更详细的环境配置指引可查看环境搭建。

2.游戏代码编写及API使用

小米小游戏目前支持市面上大多数小游戏引擎（Cocos, Unity, Laya等），开发者在编写游戏代码时可以直接使用这些游戏引擎进行开发。
如在开发过程中需要调用小米小游戏平台提供的JS API以及平台开放能力相关API时请参看：小游戏开发->API部分。

三、构建小游戏工程

1.Cocos、Laya、Egret引擎构建方式

Cocos, Laya, Egret等引擎，均使用引擎IDE进行导出即可，在发布配置中勾选发布渠道为小米小游戏后点击构建按钮即可构建生成小游戏工程。
注意事项：以下截图中各配置项填写无参考价值，开发者需根据自己需求填写。

1.1 Cocos引擎构建方式

• 在 Cocos 构建界面选择发布渠道为“小米小游戏”，点击构建即可

• Cocos构建出的小游戏工程位于原Cocos项目工程下的build文件夹中的xiaomi-quick-game文件夹：

1.2 Laya引擎构建方式

• 在 LayaAir 发布界面选择“小米小游戏”

• Laya构建出小游戏工程位于原laya工程项目下的release文件夹中的xmgame文件夹

1.3 Egret引擎构建方式

• Egret 发布界面选择“小米小游戏”

• Egret构建出小游戏工程位于原Egret工程同级目录下多了_qgame的文件夹中

2.Unity引擎构建方式

不同于以上其他引擎，Unity需下载小米小游戏对应的插件进行导出
下载地址：打包工具1.5.9版本（插件仅支持Unity2019-2022版本以及团结引擎1.x）

• 插件导入后，菜单栏就会出现“小米小游戏”选项，点击打包设置填写配置项后点击最下方打包按钮即可构建生成小米小游戏项目，同时打出rpk包

• Unity构建出的小游戏工程，位于原Unity工程同级目录下的MiQGameBuild文件夹，该目录下的MiQGame文件夹即为构建出的小游戏工程

四、游戏调试

1.Debug包打包

在调试阶段打debug类型的rpk包进行真机调试即可，无需打正式环境签名包体，小米线上存在webview和runtime两种运行环境，因此包体也分为webview包体和runtime包体，为了给线上用户带来最优体验，我们建议开发者接入runtime，但是需开发者根据自身实际情况进行考量和选择。
详细的打包指引和打包工具介绍可参看打包指引文档，此处仅进行简要介绍。

1.1 webview包体打包

• 默认方式：通过各游戏引擎构建生成的rpk包体即为debug包，位于游戏工程目录下的dist文件夹中，可直接使用
• 手动打包：在异常情况下（如：游戏打包后运行有问题），则建议手动执行打包，需在根目录下的pacakge.json文件中手动指定 quickgame-cli 工具版本，目前该工具用来打webview包体的最新版本是0.1.24。然后在小游戏工程根目录下执行 npm run build进行手动打包。

package.json中内容如下：

{
    "name": "xiaomi-quickgame",
    "version": "1.0.0",
    "build-template": "xiaomigame",
    "scripts": {
        "build": "quickgame build",
        "release": "quickgame release",
        "server": "quickgame server",
        "debug": "quickgame debug"
    },
    "babel": {
        "plugins": [
            "babel-plugin-transform-remove-strict-mode"
        ]
    },
    "dependencies": {
        "quickgame-cli": "0.1.24"
    }
}

注意事项：部分引擎生成的小游戏工程中可能无package.json文件，若无此文件则自己创建一个，创建完成后在小游戏工程根目录下执行 npm install安装依赖，依赖安装完成后方可进行手动打包。若使用最新版本打包后游戏运行出现异常，可尝试降低打包工具版本至如0.1.21版本重新打包重试。

1.2 runtime包体打包

不同于webview包体，runtime包无法通过引擎IDE中选择小米渠道直接导出，只能通过手动打包，

• 打包方式：和webview包异常情况下的打包类似，只需修改package.json文件中的quickgame-cli 工具版本，打runtime包，此工具版本需>=0.2.5版本，当前最新版本也为0.2.5版本。配置好工具版本安装好依赖后，在构建出的小游戏工程根目录下执行 npm run build即可在dist目录下打出debug包体。

2.真机调试

在打出调试用的debug包体后，即可在手机上的“快应用调试器”中安装rpk包进真机调试，详细的调试方法可参看调试指南。

2.1 在调试器app安装并启动游戏

可以选择扫码安装或者本地安装（推荐）在调试器App中安装并启动游戏rpk包

• 扫码安装：以cocos为例，点击构建任务右下角的“运行”按钮可以生成一个二维码，使用调试器中的扫码安装扫码后可安装启动，其他引擎在构建生成完成后也会有类似二维码生成

• 本地安装：若扫码安装失败，可以通过usb数据线连接手机，开启文件传输，将之前生成的debug包文件直接放到手机上的某个方便自己寻找的目录，然后点击本地安装，找到先前导入手机的游戏debug包后，点击选中即可安装启动

2.2 查看调试日志

日志查看有两种方式可选，可以使用手机调试器app中的的vconsole插件查看，也可以连接adb后使用浏览器inspect进行查看，详细操作方式可查看调试指南。

• 使用VConsole：在手机设置中搜索“快应用服务框架”，点开后多次点击“关于”展开隐藏内容，然后打开“vConsole”的开关，然后在调试器App中启动游戏，右下角即会出现vConsole插件，点开可查看日志

注意事项：1312版本以上的快应用框架需要通过在调试器设置启动参数去开启vConsole开关：
*示例：engineType=cocos&useVConsole=true&waitingDebugger=false
游戏的运行环境类型的取值范围为：unity、cocos、webview

• webview包：需要在webview环境调试
• runtime包：
• cocos游戏：需要在cocos环境调试
• 其他游戏：需要在unity环境调试

• 使用浏览器inspect（如果想要进一步使用devtools进行debug，选择此调试方式）：打开Microsoft Edge浏览器（推荐使用，chrome中部分版本可能会存在日志不全的问题）并在地址栏输入edge://inspect（如果使用的是chrome浏览器，地址可改为chrome://inspect），勾选discover USB devices和discover network targets.然后usb连接手机，终端执行adb devices确保adb连上，然后执行adb forward tcp:9229 tcp:9229，inspect页面会出现对应项目，点击inspect按钮进入查看

注意：如果Chrome打开页面长时间等待或者出现404无法找到的问题，可以使用inspect fallback选项打开

五、游戏发布与上传

1.构建发布版本的rpk包

1.1 签名文件准备

与调试时使用的debug包不同，在打用于正式发布的release包体时需要进行签名，因此在打包前需要准备好签名文件，将其放在构建出的小游戏工程目录的sign文件夹中。

若之前已经生成过签名文件则务必使用之前使用的签名文件，若无签名文件则需要生成签名文件，生成方式如下：
通过openssl命令等工具生成签名文件private.pem、certificate.pem，在小米小游戏工程<project-name>/sign目录下创建release目录，将私钥文件private.pem和证书文件certificate.pem拷贝进去。例如：

openssl req -newkey rsa:2048 -nodes -keyout private.pem -x509 -days 3650 -out certificate.pem

注意事项：正式签名文件生成之后请务必妥善保管，之后每次上传到开平的包都需要使用此签名进行打包，否则会签名校验失败无法上传，且此签名无法变更

1.2 打出正式包体

与debug包体一样，分为webview包体打包和runtime包体打包，同样的，详细打包指引可查看打包指引。

1.3 webview包体打包

• 默认情况下同样可以使用引擎IDE直接出包，只不过需要在填写配置项中勾选包体种类为正式包，然后填写签名文件的路径后进行打包即可。cocos中较为特殊，cocos中取消勾选“使用调试密钥库”，然后填写选择下面两个签名文件的路径后进行构建生成。

• 手动打包时，除使用的打包命令不同外，其余与debug包打包完全相同，可参考游戏调试部分的debug包打包，正式包体打包调用npm run release，执行命令前确保sign文件夹下存在release签名文件即可

1.2.2 Runtime包体打包

只能通过手动打包，除使用的打包命令不同外，其余与debug包打包完全相同，可参考游戏调试部分的debug包打包，正式包体打包调用npm run release，执行命令前确保sign文件夹下存在release签名文件即可。

1.3包体限制

• 分包包体限制：
  
• 小游戏的整个 RPK 包体（含主包+所有分包）不超过 30M
• 主包<4M，单个分包大小不限制

> com.application.demo.rpk整体压缩包(包名+.rpk) （最大30M）
> -------------- com.application.demo.rpk 原整包(包名+.rpk) （最大30M）
> -------------- main.rpk 分包主包(main+.rpk) （单个主包，最大4M）
> -------------- pkgA.rpk pkgA分包(子包名+.rpk) （单个分包不限制大小）
> -------------- pkgB.rpk pkgB分包(子包名+.rpk)

• 普通包体（不分包）限制：

未分包的包体中仅有一个主包，包体大小需限制在4M以下；若无法限制在4M以下，请进行分包处理，具体分包操作可以参考分包目录及大小限制。

2.上架前自检

上线前请再次核对确认游戏功能，游戏内支付、广告功能及各项配置正常无误

3.提交上架审核

请登录“小米澎湃OS开发者平台”→“管理中心”→“小游戏”进入小游戏开发者站进行正式release包体的提交和上传，上传后开平会进行审核，审核通过后方可上架，详细操作指引可参考小游戏开发者上架&更新流程。