Skip to content

Commit 38da029

Browse files
author
nebulaliu
committed
feat: fix docs
1 parent e17994e commit 38da029

15 files changed

+96
-44
lines changed

‎Design/AndroidProfile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
1. 编译版本仅当导出勾选Profiling-funcs(推荐)或Development时才能在函数堆栈中看到可读函数名。
3434
2. 特殊情况下，如果游戏勾选Profiling-funcs会导致代码包过大，那么不要使用此选项。此时得到的Profile中函数为数字ID，有两种做法进行解读：
3535
- 2.1 通过webgl导出目录下的symbols文件对照映射
36-
- 2.2 通过[替换脚本](../tools/update_v8_wasm_profile.py)对cpuprofile进行自动映射到真实函数。使用方式：python update_v8_wasm_profile.py $cpuprofile $symbol
36+
- 2.2 通过[替换脚本](../tools/update_v8_wasm_profile.py){target="_self"}对cpuprofile进行自动映射到真实函数。使用方式：python update_v8_wasm_profile.py $cpuprofile $symbol
3737
3. 如希望能从游戏启动立即抓取profile，请在game.js末尾代码稍作修改：
3838
```
3939
const gl = GameGlobal.canvas.getContext('webgl')

‎Design/CompressedTexture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@
116116

117117
## 新版本异常回退说明
118118

119-
​ 微信纹理压缩升级了全新的内核程序，尽管发布前进行了多数Unity年限版本与常见机型的测试，目前仍处于初期测试使用，若使用期间存在异常影响正常的游戏发布可前往issues提出问题，并使用[上一代稳定版微信纹理压缩包（旧）](../tools/minigame.texturecompressed.backup.unitypackage)导入工程后采用旧版本完成游戏发布。旧版本使用指引请参阅：[微信压缩纹理使用说明（旧）](https://github.com/wechat-miniprogram/minigame-unity-webgl-transform/blob/37ee6bf04443ac37c81571f60d43f9ca6e6c21c8/Design/CompressedTexture.md)
119+
​ 微信纹理压缩升级了全新的内核程序，尽管发布前进行了多数Unity年限版本与常见机型的测试，目前仍处于初期测试使用，若使用期间存在异常影响正常的游戏发布可前往issues提出问题，并使用[上一代稳定版微信纹理压缩包（旧）](../tools/minigame.texturecompressed.backup.unitypackage){target="_self"}导入工程后采用旧版本完成游戏发布。旧版本使用指引请参阅：[微信压缩纹理使用说明（旧）](https://github.com/wechat-miniprogram/minigame-unity-webgl-transform/blob/37ee6bf04443ac37c81571f60d43f9ca6e6c21c8/Design/CompressedTexture.md)
120120

121121

122122

@@ -164,7 +164,7 @@
164164

165165
#### 解决方案二：
166166

167-
​ 先下载 [libgdiplus.dylib](../tools/libgdiplus.dylib) 文件后，将其放在 UnityEditor `/Applications/Unity/Hub/Editor/{$Unity_Editor_Version}/Unity.app/Contents/MonoBleedingEdge/lib/libgdiplus.dylib` 路径下，并编辑 `/Applications/Unity/Hub/Editor/{$Unity_Editor_Version}/Unity.app/Contents/MonoBleedingEdge/etc/mono/config` 文件，将 `target= .../libgdiplus.dylib` 路径内容均变更为下载文件的存放完整路径，重启 Unity Editor 即可。
167+
​ 先下载 [libgdiplus.dylib](../tools/libgdiplus.dylib){target="_self"} 文件后，将其放在 UnityEditor `/Applications/Unity/Hub/Editor/{$Unity_Editor_Version}/Unity.app/Contents/MonoBleedingEdge/lib/libgdiplus.dylib` 路径下，并编辑 `/Applications/Unity/Hub/Editor/{$Unity_Editor_Version}/Unity.app/Contents/MonoBleedingEdge/etc/mono/config` 文件，将 `target= .../libgdiplus.dylib` 路径内容均变更为下载文件的存放完整路径，重启 Unity Editor 即可。
168168

169169
## 微信压缩纹理API介绍
170170

‎Design/CustomLoading.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ loadingPageConfig: {
8181

8282

8383
## 默认效果
84-
<img src='../image/loading_default.png' width="600">
84+
<img src='../image/loading_default.png' width="600"/>
8585

8686
实现默认效果很简单，开发者只需在导出时配置启动素材即可
8787

@@ -98,12 +98,12 @@ loadingBarWidth: 加载进度条宽度；-- $LOADING_BAR_WIDTH
9898
启动loader提供的默认加载界面为了契合不同游戏，做得相对通用，但游戏可能会存在定制启动loading的需求，以达到和游戏更贴近的体验。
9999

100100
- 小游戏表现
101-
<img src='../image/loading_demo.jpg' width="600">
101+
<img src='../image/loading_demo.jpg' width="600"/>
102102

103103
- 设计稿
104104
设计尺寸：1600*720
105105

106-
<img src='../image/loading_design.jpg' width='600'>
106+
<img src='../image/loading_design.jpg' width='600'/>
107107

108108
- 小游戏配置
109109
```js

‎Design/DevelopmentQAList.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
#### 11.开发者工具提示`pluginid: wx7a727ff7d940bb3f, permission deny`字样错误
4343
Q:
4444

45-
<image src="../image/rank-demo/addplugin.png" width="400">
45+
<image src="../image/rank-demo/addplugin.png" width="400"/>
4646

4747
A: 新版导出插件使用小游戏插件来渲染关系链数据，因此需要添加插件。可通过微信开发者工具控制台-添加插件的报错信息添加插件，即可正常使用。同时需要注意**实际未使用关系链数据时请删掉game.json中plugins.Layout配置**。如果开发者工具控制台没有添加插件的入口请手动在MP端[添加插件](https://mp.weixin.qq.com/wxopen/plugindevdoc?appid=wx7a727ff7d940bb3f)或者升级至最新版本的开发者工具。
4848

‎Design/FileCache.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ maxStorage: 最大缓存容量，修改此值需要联系研发助手开通权
199199

200200
缓存文件在usr目录下
201201

202-
<img src='../image/cache_path.png'>
202+
<img src='../image/cache_path.png'/>
203203

204204
4. 真机安卓缓存目录：data/com.tencent.mm/MicroMsg/wxanewfiles/随机ID(根据最近使用时间判断是哪个目录)
205205
5. 未开通`mp后台-能力地图-生产提效包-空间提升`的游戏，修改`maxStorage`超过200MB会导致出现写缓存失败。

‎Design/LaunchOpera.md

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
### 步骤一：设计剧情
3030

31-
剧情设计由开发者自行准备游戏主题相关视频、图片资源素材并上传至CDN。剧情编辑工具目前有一定的使用学习成本，Beta阶段为了降低开发者的接入难度，具体的剧情设计需联系[研发助手](/Design/IssueAndContact.md#小游戏研发助手)协助设计。
31+
剧本设计请阅读 [启动剧情剧本自助设计工具及文档](LaunchOperaDocument.md) 完成设计与调试；
3232

3333
剧本产物：资源目录 `launchOperaPlay`。
3434

@@ -76,6 +76,11 @@ GameGlobal.events.on("launchOperaInit", (operaHandler) => {
7676
operaHandler.end(); // 发生异常时强制结束，避免用户无法退出剧情插件模式
7777
})
7878

79+
// 弱网处理
80+
operaHandler.onWeakNetwork((info) => {
81+
82+
})
83+
7984
});
8085

8186
```
@@ -136,6 +141,17 @@ GameGlobal.event.on("launchOperaInit", (operaHandler) => {
136141
launchOpera.percentage = 0.6; // 开发者输入 .0～1.0 浮点数，对应控制剩余 30%
137142
```
138143

144+
### 弱网处理
145+
146+
启动剧情通常以视频内容呈现为主，网络流畅度对用户体验是存在直接关系，除了开发者需要确保使用可靠的CDN服务托管视频资源确保足够的输出带宽，用户的实际网络也是影响的重要因素。微信小游戏启动剧情对可能影响用户体验的弱网情况做了相应的回调事件，也对网络情况做了三个级别的分级，请开发者对弱网的反馈同样做出合理的处理提升用户体验。
147+
148+
弱网级别：
149+
- 0级：视频、音频数据流畅
150+
- 1级：存在稍微卡顿但可及时恢复播放。可适当给出Toast提醒网络较弱，并及时弹出可退出剧情的按钮由用户主动放弃剧情。
151+
- 2级：严重卡顿，长时间等待视频数据缓冲。建议主动提前结束启动剧情，进入原本的loading阶段。
152+
153+
请参阅 [.onWeakNetwork](#onweaknetworkcallback-function) API描述。
154+
139155
## API执行环境说明
140156

141157
启动剧情的运行环境主要以 JavaScript 为主，当然我们也提供了部分 C# 侧需要用到的访问接口。JavaScript 侧指的是导出目录中 `minigame` 文件夹中的脚本，这是微信开发者工具打开的脚本目录，`minigame/game.js` 是整个游戏客户端启动的入口，我们通常也是从该入口进行能力迭代。不过值得注意的是，`minigame` 目录是导出产物，在重新导出游戏时将会被覆盖，所以正确的修改目录应该位于 `Assets/WX-WASM-SDK-V2/Runtime/wechat-default` 目录中，这里是导出 `minigame` 的模板文件，并且能够跟随项目Git等代码版本托管迭代。
@@ -204,6 +220,42 @@ launchOpera.onErr((err) => {
204220

205221
注销当发生异常时的回调事件。
206222

223+
### .onWeakNetwork(callback: Function)
224+
225+
当发生1-2级弱网情况时发生的回调事件。
226+
227+
一种推荐的配置：
228+
229+
```js
230+
launchOpera.onWeakNetwork((info) => {
231+
/**
232+
* info 结构：
233+
* interface info {
234+
* level: number; // 弱网级别
235+
* url: string; // 产生本次回调的远程资源url
236+
* }
237+
*/
238+
if (info.level == 1) {
239+
wx.showToast({
240+
title: '网络较弱正在缓冲...',
241+
icon: 'none',
242+
});
243+
// 使用 GlobalVar 显示跳过/退出按钮
244+
// code...
245+
} else { // 不是 level 1 则为 level 2
246+
wx.showToast({
247+
title: '网络较差，以为您跳过剧情',
248+
icon: 'none',
249+
});
250+
launchOpera.end(); // 强制结束
251+
}
252+
});
253+
```
254+
255+
### .offWeakNetwork(callback: Function)
256+
257+
注销当发生弱网情况时的回调事件。
258+
207259
### .setGlobalVar(globalName: string, value: string)
208260

209261
设置启动剧情全局变量值。
@@ -240,7 +292,7 @@ var launchOperaHandler = WX.GetLaunchOperaHandler();
240292

241293
提前结束启动剧情。
242294

243-
### void onEnd(Action<bool> callback)
295+
### void onEnd(Action\<bool> callback)
244296

245297
注册当剧情结束时的回调事件。
246298

@@ -258,7 +310,7 @@ WX.GetLaunchOperaHandler().onEnd((status) =>
258310
});
259311
```
260312

261-
### void offEnd(Action<bool> callback)
313+
### void offEnd(Action\<bool> callback)
262314

263315
注销当剧情结束时配置的回调事件。
264316

‎Design/OpenData.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ WX.GetOpenDataContext().PostMessage(msg);
145145
整体流程示意：
146146

147147

148-
<img src="../image/opendata/demo1.jpeg" width="30%"> <img src="../image/opendata/demo2.jpeg" width="30%"> <img src="../image/opendata/demo3.jpeg" width="30%">
148+
<img src="../image/opendata/demo1.jpeg" width="30%"/> <img src="../image/opendata/demo2.jpeg" width="30%"/> <img src="../image/opendata/demo3.jpeg" width="30%"/>
149149
#### 5.2 群好友排行榜
150150
1. 为了使用群排行榜，需要调用 WX.UpdateShareMenu 设置分享菜单
151151
``` CSharp
@@ -196,7 +196,7 @@ WX.OnShow((OnShowCallbackResult res) =>
196196
整体流程示意：
197197

198198

199-
<img src="../image/opendata/demo6.jpeg" width="24%"> <img src="../image/opendata/demo7.jpeg" width="24%"> <img src="../image/opendata/demo4.jpeg" width="24%"> <img src="../image/opendata/demo5.jpeg" width="24%">
199+
<img src="../image/opendata/demo6.jpeg" width="24%"/> <img src="../image/opendata/demo7.jpeg" width="24%"/> <img src="../image/opendata/demo4.jpeg" width="24%"/> <img src="../image/opendata/demo5.jpeg" width="24%"/>
200200

201201

202202
## 常见问题QA

‎Design/PerformanceMonitor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ interface IBaseRequestInfo {
289289
## 优化分析工具
290290

291291
### 微信开发者工具
292-
<img src="../image/monitor/network-profile.png">
292+
<img src="../image/monitor/network-profile.png"/>
293293

294294
- step1: 点击调试器-performance
295295
- step2: 点击录制按钮

‎Design/Startup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
## 启动加载时序
44
Unity WebGL转换的小游戏主要依靠Unity Loader进行初始化，典型的流程如下图所示：
5-
<img src="../image/launch1.png">
5+
<img src="../image/launch1.png"/>
66

77

88

99
## Unity Loader工作流程
10-
<img src="../image/launch.png">
10+
<img src="../image/launch.png"/>
1111

1212

1313
关键过程：

‎Design/Transform.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,18 +62,18 @@
6262
导入转换后的`minigame`目录
6363

6464
3. 工具预览
65-
<img src='../image/devtools_preview.png'>
65+
<img src='../image/devtools_preview.png'/>
6666

6767
注意：
6868
> 项目使用了小游戏Unity适配插件，若小游戏是第一次使用本插件，在开发者工具会报错提示插件未授权
6969
70-
<img src="../image/addPlugin.png">
70+
<img src="../image/addPlugin.png"/>
7171

7272
**请前往mp后台-能力地图-生产提效包-快适配，开通使用**
7373

74-
<img src='../image/mp_addplugin.png'>
74+
<img src='../image/mp_addplugin.png'/>
7575

76-
<img src='../image/auth_plugin.png'>
76+
<img src='../image/auth_plugin.png'/>
7777

7878
4. 真机预览
7979
点击**预览**，扫码二维码预览即可。

0 commit comments

Comments
 (0)