QQ小游戲 引擎插件

小游戲引擎插件接入

一、概述

為了提升小游戲的打開速度，提高用戶體驗，開發(fā)者可接入引擎插件能力。

引擎插件會單獨在客戶端進行緩存。當小游戲首次啟動時，如果本地已經(jīng)存在同類別游戲引擎插件，可直接復用引擎插件或可通過增量下載的方式快速下載，從而提升啟動速度。

二、引擎插件配置

使用 新版引擎IDE 或 引擎工具重導出QQ小游戲 即可。

使用新版引擎IDE或引擎工具重導出后，會有三個變化。

(1) 引擎IDE選擇使用插件分離后代碼包中將不包含引擎插件相關代碼。

(2) game.json中添加通用插件配置。

如

(3) 使用引擎的方式變更為requirePlugin。

如

注意事項：

• 目前一個APPID，只支持引用一個插件。

• 目前支持整包小游戲引用插件，和分包小游戲的主包引用插件。

• 如果需要本地調(diào)試引擎代碼建議不使用插件分離能力。

三、使用QQ小程序開發(fā)者工具調(diào)試插件

1.調(diào)試引擎插件的ide版本為0.1.29。

2.調(diào)試引擎插件的基礎庫版本為1.8.0。

3.在代碼調(diào)試過程中,ide會直接下載game.json中配置的全量的 provider 的 version 版本的文件作為引用的插件代碼。如果配置錯誤，ide會提示:"獲取插件文件錯誤"。

如

4.上傳/預覽時，系統(tǒng)會直接使用線上已發(fā)布的全量的 provider 的 version 版本的文件作為引用的插件代碼。

開發(fā)者工具下載地址：

四、在QQ客戶端中體驗插件分離功能

在QQ客戶端中可直接體驗到插件分離功能.(QQ版本為8.1.8及以上)

使用了插件分離的小游戲，在console日志中會輸出

plugin ***** inject success/fail!

小游戲引擎插件開發(fā)

開發(fā)小游戲插件需要一個appid，申請步驟同小游戲一致。

開發(fā)者工具從 1.29.0 開始支持小游戲插件的開發(fā)。

基礎庫從 1.8.0 開始支持小游戲插件的運行。

# 小游戲插件目錄結構

project
├── minigame
│   ├── game.json       // 插件提供的自定義組件（可以有多個）
├── plugin
│   ├── index.js        // 插件的 js 入口
│   ├── code.js         // 插件的 js 代碼
│   ├── plugin.json     // 插件配置文件
├── project.config.json // 項目配置文件

小游戲插件目錄一般包括以下兩個：

• minigame 目錄： 放置一個小游戲項目，用于調(diào)試插件

• plugin 目錄： 插件源碼

minigame 目錄內(nèi)容可以當成普通小游戲來編寫，用于小游戲插件調(diào)試和預覽。

在項目的project.config.json中配置

{
    "compileType": "gamePlugin",
    "miniprogramRoot": "minigame/",
    "pluginRoot": "plugin/",
}

在 minigame 目錄中的game.json中配置插件信息

{
    "plugins": {
      "layaPlugin": {
        "version": "dev",
        "provider": "your plugin appid"
      }
    }
}

插件代碼目錄 plugin 中需要有插件配置文件 plugin.json，插件的入口須配置在該文件中。

{
    "main": "index.js"
}

預覽、上傳和發(fā)布

插件可以像小游戲一樣預覽和上傳，但插件沒有體驗版。

插件上傳后需要去QQ小程序開放平臺管理端操作上線后方可被使用。

插件會同時有多個線上版本，由使用插件的小游戲決定具體使用的版本號。