小游戏配置
小游戏根目录下的 game.json
文件用来对小游戏进行配置。文件内容为一个 JSON 对象,有以下属性:
配置项
属性 | 类型 | 必填 | 默认值 | 描述 | 最低版本 |
---|---|---|---|---|---|
deviceOrientation | String | 否 | 'portrait' | 屏幕选择方向 | |
showStatusBar | Boolean | 否 | false | 是否显示状态栏 | |
networkTimeout | Object | 否 | - | 网络请求的超时时间,单位:毫秒 | |
workers | String | 否 | - | 多线程 Worker 配置项,详细请参考 Worker文档) | |
subpackages | Object Array | 否 | - | 分包结构配置 | |
navigateToMiniProgramAppIdList | String Array | 否 | - | 需要跳转的小程序列表,详见 wx.navigateToMiniProgram | 2.4.0 |
permission | Object | 否 | - | 小游戏接口权限相关设置 | 微信客户端 7.0.0 |
openDataContext | String | 否 | - | 小游戏开放数据域目录,详见 关系链数据 | |
disableSetUserStorageFromMiniProgram | Boolean | 否 | false | 是否禁止开放数据域接口 wx.setUserCloudStorage 写入托管数据,设置为 true 之后,只能通过后台接口写用户托管数据 |
deviceOrientation 的合法值
值 | 说明 | 最低版本 |
---|---|---|
portrait | 竖屏。不随用户手机的旋转而旋转。 | |
landscape | home 键在屏幕右侧的横屏。当用户的手机没有锁定屏幕方向时,横屏的方向会随着手机的旋转而旋转。 | |
landscapeLeft | home 键在屏幕左侧的横屏 | 微信客户端 7.0.0 |
landscapeRight | home 键在屏幕右侧的横屏 | 微信客户端 7.0.0 |
networkTimeout
各类网络请求的超时时间,单位均为毫秒。
属性 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
request | Number | 否 | 60000 | wx.request 的超时时间,单位:毫秒。 |
connectSocket | Number | 否 | 60000 | wx.connectSocket 的超时时间,单位:毫秒。 |
uploadFile | Number | 否 | 60000 | wx.uploadFile 的超时时间,单位:毫秒。 |
downloadFile | Number | 否 | 60000 | wx.downloadFile 的超时时间,单位:毫秒。 |
workers
使用 Worker) 处理多线程任务时,设置 Worker
代码放置的目录
subpackages
微信客户端 6.6.7 ,基础库 2.1.0 及以上版本支持
启用分包加载时,声明项目分包结构。
写成 subPackages 也支持。
navigateToMiniProgramAppIdList
基础库 2.4.0 开始支持,低版本需做兼容处理。
当小程序需要使用 wx.navigateToMiniProgram 接口跳转到其他小程序时,需要先在配置文件中声明需要跳转的小程序 appId 列表,最多允许填写 10 个。
permission
微信客户端 7.0.0 及以上版本支持
小游戏接口权限相关设置。字段类型为 Object
,结构为:
属性 | 类型 | 必填 | 默认值 | 描述 |
---|---|---|---|---|
scope.userLocation | PermissionObject | 否 | 位置相关权限声明 |
PermissionObject 结构
属性 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
desc | string | 是 | 小程序获取权限时展示的接口用途说明。最长30个字符 |
如:
{
"permission": {
"scope.userLocation": {
"desc":"你的位置信息将用于小游戏位置接口的效果展示"
}
}
}
配置示例
{
"deviceOrientation": "portrait",
"networkTimeout": {
"request": 5000,
"connectSocket": 5000,
"uploadFile": 5000,
"downloadFile": 5000
},
"navigateToMiniProgramAppIdList": [
"wxe5f52902cf4de896"
]
}