Skip to content

Commit a7d3961

Browse files
committed
docs: update minigame
1 parent e04d416 commit a7d3961

File tree

1 file changed

+51
-27
lines changed

1 file changed

+51
-27
lines changed

docs/zh/platform/wechatMiniGame.mdx

Lines changed: 51 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ label: Platform
99

1010
在导出到微信小游戏平台的时候,有以下这些配置项:
1111

12-
<Image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*natiS7i3cvUAAAAAAAAAAAAADjCHAQ/fmt.webp" />
12+
<Image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*Dc_mQITPRogAAAAAAAAAAAAAejCHAQ/fmt.webp" />
1313

1414
| 配置 | 描述 | 对应到微信小游戏的配置文件 | 对应到微信小游戏中的字段
1515
| ------------- | ------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------- |
@@ -19,56 +19,80 @@ label: Platform
1919
| Connect Socket | wx.connectSocket 的超时时间,单位:毫秒 | game.json | networkTimeout.connectSocket |
2020
| Upload File | wx.uploadFile 的超时时间,单位:毫秒 | game.json | networkTimeout.uploadFile |
2121
| Download File | wx.downloadFile 的超时时间,单位:毫秒 | game.json | networkTimeout.downloadFile |
22+
| Subpackages | 子包列表的配置 | game.json | subpackages |
2223

2324
更多配置详见:[project.config.json](https://developers.weixin.qq.com/minigame/dev/devtools/projectconfig.html)[game.json](https://developers.weixin.qq.com/minigame/dev/reference/configuration/app.html)
2425

2526
## 导出
2627

2728
选择好微信小游戏平台后,点击导出面板最下方的下载按钮,即可导出所需工程:
2829

29-
<Image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*a1-PQIsWlgIAAAAAAAAAAAAADjCHAQ/fmt.webp" />
30+
<Image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*yAeER487lbsAAAAAAAAAAAAAejCHAQ/fmt.webp" />
3031

3132
## 调试
3233

33-
1、工程导出到本地后,先进入到根目录执行以下命令进行依赖包的安装:
34+
1、从编辑器导出到本地后,目录结构如下:
35+
36+
<Image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*LMWMQpQNdA0AAAAAAAAAAAAAejCHAQ/fmt.webp" style={{zoom: "50%"}} />
37+
38+
**工程目录说明**
39+
|目录或文件|说明|
40+
|-------------|-------------|
41+
|public|资产目录,编辑器所有资产导出到这个目录下,资产的 path 为 /public/xxx|
42+
|scripts|开发者在编辑器中添加的脚本组件,导出到本地后,开发者可以在里面的脚本组件中进行二次开发|
43+
|game.json|对应微信小游戏工程所需要的 [game.json](https://developers.weixin.qq.com/minigame/dev/reference/configuration/app.html)|
44+
|game.ts|入口文件,初始化的逻辑都放在这里|
45+
|package.json|主要存放项目依赖包|
46+
|project.config.json|对应微信小游戏工程所需要的 [project.config.json](https://developers.weixin.qq.com/minigame/dev/devtools/projectconfig.html)|
47+
|project.ts|Galacean 的工程文件,放置初始化相关信息|
48+
49+
2、工程导出到本地后,先进入到根目录执行以下命令进行依赖包的安装:
3450

3551
```bash
3652
npm i
3753
```
3854

39-
2、打开**微信开发者工具** ,选择小游戏,并导入刚才的工程,如下
55+
3、本地构建微信小游戏平台所需产物,调试阶段可以执行如下命令
4056

41-
<Image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*gCnXSqRgLnMAAAAAAAAAAAAADjCHAQ/fmt.webp" />
57+
```bash
58+
npm run dev
59+
```
60+
执行完这个命令后,会在项目的根目录下生成一个新的目录,这个目录就是微信小游戏所需要的产物,如下:
4261

43-
3、在微信开发者工具中,点击**工具->构建 npm**,如下:
62+
<Image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*wYi0QoS-BUsAAAAAAAAAAAAAejCHAQ/fmt.webp" />
4463

45-
<Image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*G5aBQKNFdV8AAAAAAAAAAAAADjCHAQ/fmt.webp" />
64+
执行 dev 命令,产物里会有源码的 source map 文件,方便调试,当开发者完成调试准备发包时,可以执行命令:
4665

47-
4、完成上述 3 后,即可在微信开发者工具中预览最终的结果,如下:
66+
```bash
67+
npm run release
68+
```
4869

49-
<Image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*JyoIS54k3uYAAAAAAAAAAAAADjCHAQ/fmt.webp" />
70+
执行这个命令后,相对 dev 产生的产物会去掉 source map 文件,并对代码进行压缩,体积更小,适合发布,如下:
5071

51-
5、在微信开发者工具中的调试,详见:[微信小游戏调试](https://developers.weixin.qq.com/minigame/dev/guide/runtime/debug/)
72+
<Image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*7mvZR6wwEV4AAAAAAAAAAAAAejCHAQ/fmt.webp" />
5273

53-
## 发布
5474

55-
本地完成调试后,即可进行发布,具体发布流程详见:[微信小游戏发布](https://developers.weixin.qq.com/minigame/introduction/guide/)
75+
4、打开**微信开发者工具** ,选择小游戏,并导入步骤 3 中生成的目录,如下:
5676

57-
## 导出工程目录说明
77+
<Image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*v-odQJDjcfUAAAAAAAAAAAAAejCHAQ/fmt.webp" />
5878

59-
导出到本地的工程目录如下
79+
5、完成步骤 4 后,即可在微信开发者工具中预览最终的结果,如下
6080

61-
<Image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*3jBDQYE5T9AAAAAAAAAAAAAADjCHAQ/fmt.webp" style={{zoom: "50%"}} />
81+
<Image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*meRxSLDswlgAAAAAAAAAAAAAejCHAQ/fmt.webp" />
82+
83+
6、在微信开发者工具中的调试,详见:[微信小游戏调试](https://developers.weixin.qq.com/minigame/dev/guide/runtime/debug/)
84+
85+
## 分包
86+
87+
微信小游戏对于包体大小有严格的限制,分包是微信小游戏的一个重要特性,在 Galacean 编辑器中,我们以文件夹作为子包的单位。在导出小游戏面板中,可以通过在子包列表中添加子包并设置对应的文件夹来进行分包,具体的配置如下:
88+
89+
<Image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*ndgyR5bjGqsAAAAAAAAAAAAAejCHAQ/fmt.webp" />
90+
91+
关于子包,有几个点需要注意:
92+
- 设置为子包的文件夹下的脚本资源不会计入子包,会单独导出
93+
- 开发者无需关注子包的加载时机,引擎会自动处理,开发者加载子包中的资源和正常加载资源的方式一致
94+
95+
## 发布
96+
97+
本地完成调试后,即可进行发布,具体发布流程详见:[微信小游戏发布](https://developers.weixin.qq.com/minigame/introduction/guide/)
6298

63-
**工程目录说明**
64-
|目录或文件|说明|
65-
|-------------|-------------|
66-
|adapters|项目用到的引擎相关的包,按需导出|
67-
|public|资产目录,编辑器所有资产导出到这个目录下,资产的 path 为 /public/xxx|
68-
|scripts|开发者在编辑器中添加的脚本组件,导出到本地后,开发者可以在里面的脚本组件中进行二次开发|
69-
|game.json|对应微信小游戏工程所需要的 [game.json](https://developers.weixin.qq.com/minigame/dev/reference/configuration/app.html)|
70-
|game.ts|入口文件,初始化的逻辑都放在这里|
71-
|package.json|主要存放项目依赖包|
72-
|polyfill.js|平台 DOM 适配代码和全局变量适配代码,开发者无需关心|
73-
|project.config.json|对应微信小游戏工程所需要的 [project.config.json](https://developers.weixin.qq.com/minigame/dev/devtools/projectconfig.html)|
74-
|project.ts|Galacean 的工程文件,在初始化的时候会解析|

0 commit comments

Comments
 (0)