虎牙开放平台文档

虎牙小游戏 - 首屏插件

小游戏启动涉及下载资源，游戏引擎启动与首屏渲染准备等多个流程。为了提升小游戏首屏体验，小游戏提供首屏插件，在不依赖游戏引擎的基础上，提供封面图渲染。

接入方式

1. 添加封面图资源

在小游戏工程内创建static目录，添加封面图资源，目录结构如下。

封面图大小限制200KB，建议使用尺寸较小的jpg格式模糊图。

├── hygame-demo
    ├── h5Dir
    ├── package.json
    ├── node_modules
    ├── project.config.json
    └── static
        └── bg.jpg

其中project.config.json 是我们项目的配置文件，封面图放置目录为 static。

2. 添加配置

project.config.json 文件中添加preload配置，以下是配置范例，详细参数根据游戏内容修改。

{
  "name": "hygame",
  "outputPath": "hyext_dist",
  "releasePath": "hyext_release",
  "ignore": [
    "*.md",
    "LICENSE",
    ".git/**",
    ".gitignore",
    "package-lock.json"
  ],
  "builder": {
    "name": "@hyext/builder-webview",
    "config": {
      "webTitle": "hygame",
      "https": true,
      "h5Dir": "h5Dir",
      "buildConfig": [
        {
          "extType": "app_minigame_h5",
          "platform": "web"
        }
      ],
      "preload": {
        "firstScreen": {
          "mode": "static-bg",
          "url": "bg.jpg", // 基于static的文件路径的封面图路径
          "style": {
            "background-color": "#FFFFFF", // 封面图背景颜色，建议`#FFFFFF`，可根据游戏实际首屏内容调整
          }
        }
      }
    }
  }
}

3. 移除封面

游戏引擎初始化完毕，且游戏首屏渲染完成后，调用移除接口，移除封面图。

请在游戏合适时机主动调用以下接口，默认5s会自动移除封面。

window.__removeFirstScreen && window.__removeFirstScreen();