小游戏开发配置

更新时间:
复制 MD 格式

game.json

game.json 是小游戏根目录下的配置文件,用于定义小游戏的基本设置。文件内容为一个 JSON 对象,拥有以下属性:

属性

类型

必填

默认值

描述

最低版本

deviceOrientation

String

否

portrait

屏幕选择方向

-

screenOrientation

String

否

portrait

屏幕选择方向,历史版本

-

showStatusBar

Boolean

否

false

是否显示状态栏

-

subpackages

Object Array

否

-

分包结构配置

-

deviceOrientation 的合法值

值

说明

portrait

竖屏,不随用户手机的旋转而旋转。

landscape

home 键在屏幕右侧的横屏,不随用户手机的旋转而旋转。

配置示例

{
  "deviceOrientation": "portrait",
  "showStatusBar":false,
  "iOSHighPerformance":true,
  "subpackages": [
    {
      "name": "stage1",
      "root": "sub/"
    }    
  ]
}

project.config.json

project.config.json 为小游戏的项目配置文件,用于定义小游戏的构建、打包行为等各种设置。

配置结构

project.config.json 是一个可以包含以下字段的 JSON 对象。

字段名

类型

必填

描述

setting

Setting

否

小游戏编译配置

类型定义 Setting

小游戏编译配置对象。

字段名

类型

必填

描述

transpile

TranspileSetting

否

JavaScript 转译配置

minify

MinifySetting

否

代码压缩配置

json

JsonSetting

否

JSON 文件配置

TranspileSetting

JavaScript 转译设置,目前为 boolean 类型。

值

含义

场景

true

将现代 JavaScript 语法转换为兼容性更好的版本。

希望提高小游戏代码的兼容性(例如支持低版本的 iOS 设备)。

false

不进行转译。

小游戏项目从引擎导出时,如果引擎已经进行了语法的转译,可以选择主动关闭。

说明

在提审构建时,如果开发者没有指定转译配置,默认会进行转译。

MinifySetting

代码压缩配置,支持 简单格式 和 详细格式。

简单格式

"minify": true

详细格式

"minify": {
  "enable": true,
  "mangle": false
}

字段名

类型

必填

描述

enable

boolean

否

是否开启 minify。

mangle

boolean

否

是否压缩类/函数名,默认开启。

提审构建时,如果开发者没有指定压缩配置,默认会进行压缩。

JsonSetting

JSON 文件配置是包含以下字段的对象:

字段名

类型

必填

描述

transform

boolean

否

是否需要对 JSON 文件进行转换,默认开启。

当使用的小游戏引擎需要 JSON 文件的 checksum 保持不变时,可以选择关闭 JSON 的转换。

基础配置示例

{
  "setting": {
    "transpile": true,
    "minify": true
  }
}

详细配置示例

{
  "setting": {
    "transpile": true,
    "minify": {
      "enable": true,
      "mangle": false
    },
    "json": {
      "transform": false
    }
  }
}