File tree Expand file tree Collapse file tree 17 files changed +32
-30
lines changed Expand file tree Collapse file tree 17 files changed +32
-30
lines changed Original file line number Diff line number Diff line change @@ -2,7 +2,7 @@ import { defineConfig } from "vitepress";
2
2
3
3
// https://vitepress.dev/reference/site-config
4
4
export default defineConfig ( {
5
- title : "微信小游戏团结/Unity快适配 " ,
5
+ title : "微信小游戏Unity/团结快适配 " ,
6
6
description : "Wechat Mini Game Unity engine adapter documents." ,
7
7
themeConfig : {
8
8
logo : '/image/vitepress/icon.png' ,
Original file line number Diff line number Diff line change 14
14
15
15
版本建议:
16
16
17
- Unity版本支持从2018到最新的2021版本
17
+ Unity版本支持从2018到最新的2022版本
18
18
19
- 建议使用LTS版本,尽量使用2021 (更快编译和更小体积、压缩纹理、压缩音频等支持)
19
+ 建议使用LTS版本,尽量使用2022 (更快编译和更小体积、压缩纹理、压缩音频等支持)
20
20
21
21
22
22
### 3. 能力支持
23
23
| 能力 | 是否支持 | 解决方案 |
24
24
| --- | --- | --- |
25
25
| Unity基础模块 | 支持 | 支持动画、物理、AI、UI等基础模块|
26
- | 渲染管线 | 支持 | 支持标准渲染管线、URP,但依赖WebGL2.0的特性处于Beta测试 |
26
+ | 渲染管线 | 支持 | 支持标准渲染管线、URP|
27
27
| 资源加载 | 支持 | Addressable、AssetBundle网络异步加载 |
28
28
| Lua脚本 | 支持 | 支持标准Lua与常见binding(如xlua, tolua等), 不支持Luajit。需根据实际游戏在真机验证性能|
29
29
| PureTS | 支持 | iOS系统需14.5以上, 支持JIT|
@@ -32,7 +32,7 @@ Unity版本支持从2018到最新的2021版本
32
32
| 网络系统 | 需调整 | HTTP使用UnityWebRequest,TCP使用WX SDK适配或WebSocket通信替代(如开源的UnityWebSocket插件),UDP使用WX SDK适配|
33
33
| 渲染接口 | 支持 | 仅支持WebGL1.0(相当于OpenGLES2.0),2.0支持处于Beta测试阶段|
34
34
| 多线程 | 不支持 | 删除多线程用法,使用异步等其他替代方式 |
35
- | 文件API | 需调整 | 不支持System.File接口,但可使用微信小游戏WX SDK实现文件存储,大小限制为200MB。玩家存档请使用服务器或云开发;AssetsBundle缓存适配插件已自动支持|
35
+ | 文件API | 需调整 | 不支持System.File接口,但可使用微信小游戏WX SDK实现文件存储,[ 大小限制为200MB(最高可开通1GB) ] ( FileCache.md ) 。玩家存档请使用服务器或云开发;AssetsBundle缓存适配插件已自动支持|
36
36
37
37
38
38
Original file line number Diff line number Diff line change 65
65
66
66
> 相关手册:[ WX SDK 平台能力适配] ( WX_SDK.md ) 、[ 屏幕适配] ( fixScreen.md ) 、 [ 输入法适配] ( InputAdaptation.md ) 、 [ 排行榜与微信关系数据] ( OpenData.md )
67
67
68
- Unity 游戏接入微信小游戏平台将获得微信提供的 API 以及开放能力,开发者根据需要进行按需接入。微信 API 支持的能力包括登陆 、设备(存储、震动)、开放数据、广告等等。
68
+ Unity 游戏接入微信小游戏平台将获得微信提供的 API 以及开放能力,开发者根据需要进行按需接入。微信 API 支持的能力包括登录 、设备(存储、震动)、开放数据、广告等等。
69
69
70
70
71
71
Original file line number Diff line number Diff line change @@ -48,7 +48,7 @@ lacop watch
48
48
49
49
#### Step4 预览默认剧情
50
50
51
- 使用 ` 微信开发者工具 ` 打开 ` /minigame ` 目录,AppID 请切换成当前登陆用户有开发权限的小游戏AppID ,如果AppID是首次打开后会要求添加用于调试的小游戏插件,按照提示申请权限,若一切正常,你将在工具完全载入资源后看到默认的启动剧情内容。
51
+ 使用 ` 微信开发者工具 ` 打开 ` /minigame ` 目录,AppID 请切换成当前登录用户有开发权限的小游戏AppID ,如果AppID是首次打开后会要求添加用于调试的小游戏插件,按照提示申请权限,若一切正常,你将在工具完全载入资源后看到默认的启动剧情内容。
52
52
53
53
#### Step5 对剧本修改
54
54
Original file line number Diff line number Diff line change @@ -30,7 +30,7 @@ Unity小游戏的启动可参考[启动流程与时序](Startup.md)
30
30
| 游戏初始化完成 | 引擎和首场景完成,出现首个业务场景 | 通过timelog, 或日志查看“游戏启动耗时” |
31
31
| 游戏可交互完成 | 游戏核心场景完成 | 通常定义为用户可交互的时机,可通过[ 启动留存上报能力] ( ReportStartupStat.md ) 上报统计。</br >eg:休闲游戏为** 核心玩法** ,RPG游戏为** 创角** |
32
32
| 内存峰值 | 内存峰值 | 进程内存峰值,测量方法请参考[ 优化Unity WebGL的内存] ( OptimizationMemory.md ) |
33
- | 内存Crash运行时长 | 由于内存不足而使小游戏发生Crash时,当前游戏的运行时长,表示游戏的稳定运行时长 | 通过[ 小游戏数据助手] ( https://developers.weixin.qq.com/minigame/analysis/assistant.html ) 查看(仅包含线上用户数据)</br > 数据路径:` 数据 - 性能分析 - 运行性能 - 内存异常退出分析 ` |
33
+ | 内存异常退出运行时长 | 由于内存不足而使小游戏发生Crash时,当前游戏的运行时长,表示游戏的稳定运行时长 | 通过[ 小游戏数据助手] ( https://developers.weixin.qq.com/minigame/analysis/assistant.html ) 查看(仅包含线上用户数据)</br > 数据路径:` 数据 - 性能分析 - 运行性能 - 内存异常退出分析 ` |
34
34
| 帧率 | 核心玩法的平均帧率 | 测量5分钟以上游戏核心玩法帧率,取平均值 |
35
35
| 卡顿率 | 核心玩法的平均卡顿率 | 测量5分钟以上游戏核心玩法卡顿率,取平均值 |
36
36
@@ -63,7 +63,7 @@ Unity小游戏的启动可参考[启动流程与时序](Startup.md)
63
63
| 阶段 | 重点关注指标 |
64
64
| :---: | --- |
65
65
| 启动 | 1. 游戏初始化完成耗时</br > 2. 游戏可交互耗时 |
66
- | 运行 | 1. 内存峰值</br > 2. FPS均值</br > 3. 卡顿率</br > 4. 内存Crash率 (iOS)</br > 5. 内存Crash运行时长 |
66
+ | 运行 | 1. 内存峰值</br > 2. FPS均值</br > 3. 卡顿率</br > 4. 内存异常退出率 (iOS)</br > 5. 内存异常退出运行时长 |
67
67
| 兼容性问题 | 1. 逻辑异常</br > 2. 黑/白屏</br > 3. JS Error |
68
68
69
69
#### 游戏类型说明
@@ -82,7 +82,7 @@ Unity小游戏的启动可参考[启动流程与时序](Startup.md)
82
82
83
83
*** 运行性能***
84
84
85
- 重点关注:` 内存峰值 ` 、` GC后内存峰值 ` 、` 内存Crash率 ` 、` 内存Crash运行时长 `
85
+ 重点关注:` 内存峰值 ` 、` GC后内存峰值 ` 、` 内存异常退出率 ` 、` 内存异常退出运行时长 `
86
86
87
87
<img src =' ../image/performance-standard/ios_running_performance.png ' />
88
88
Original file line number Diff line number Diff line change @@ -55,20 +55,22 @@ Unity WebGL导出形式相对于原生APP应用,需要开发者更关注性能
55
55
* 释放不使用的资源
56
56
* 发布前使用压缩纹理工具进行优化
57
57
* 音频资源尽可能勾选强制单声道
58
+ * iOS开启高性能+模式
58
59
59
60
更多信息请阅读:
60
- * [ 优化Unity WebGL的内存] ( OptimizationMemory.md )
61
- * [ 压缩纹理优化] ( CompressedTexture.md )
62
- * [ Unity WebGL内存原理详解] ( https://gameinstitute.qq.com/community/detail/112321 )
61
+ * [ iOS 高性能与高性能+模式] ( iOSOptimization.md )
62
+ * [ 优化Unity WebGL的内存] ( OptimizationMemory.md )
63
+ * [ 压缩纹理优化] ( CompressedTexture.md )
64
+ * [ Unity WebGL内存原理详解] ( https://gameinstitute.qq.com/community/detail/112321 )
63
65
64
66
### 3.5 降低CPU消耗
65
67
* iOS使用高性能模式
66
68
* 尽量使用Android CPU Profiler在小游戏真机环境Profie计算瓶颈
67
69
* 提前在Unity环境使用Unity Profiler发现问题
68
70
* 物理计算较重的游戏使用Fixed Timestep控制计算频率
69
- * 在中低端机型限制帧率已减轻设备发烫
71
+ * 在中低端机型限制帧率以减轻设备发烫
70
72
71
73
更多信息请阅读:
72
- * [ iOS高性能模式 ] ( iOSOptimization.md )
74
+ * [ iOS 高性能与高性能+模式 ] ( iOSOptimization.md )
73
75
* [ 使用Android CPU Profiler性能调优] ( AndroidProfile.md )
74
76
* [ 使用Unity Profiler性能调优] ( UnityProfiler.md )
Original file line number Diff line number Diff line change @@ -145,5 +145,5 @@ export const launchEventType = {
145
145
146
146
*** 注:***
147
147
148
- 1 . 若使用的 ` 转换插件版本<202211101011 ` (对应` Unity Loader版本<1.1.2 ` ),数据统计报表需要建联 [ 小游戏研发助手 ] ( IssueAndContact.md ) 获取。
148
+ 1 . 若使用的 ` 转换插件版本<202211101011 ` (对应` Unity Loader版本<1.1.2 ` ),数据统计报表需要 [ 联系我们 ] ( IssueAndContact.md ) 获取。
149
149
2 . 数据报表数据未来会开放到《小游戏数据助手》。
Original file line number Diff line number Diff line change 14
14
15
15
### 安装指南
16
16
17
- ` 打开游戏工程 ` -> ` 团结/ Unity Editor 菜单栏` -> ` Package Manager ` -> ` 右上方 “+” ` -> ` Add package from git URL `
17
+ ` 打开游戏工程 ` -> ` Unity/团结引擎 Editor 菜单栏 ` -> ` Package Manager ` -> ` 右上方 “+” ` -> ` Add package from git URL `
18
18
URL地址为:
19
19
```
20
20
https://github.com/wechat-miniprogram/minigame-tuanjie-transform-sdk.git
21
21
```
22
22
23
- 国内Gitee镜像 :
23
+ 或国内Gitee镜像 :
24
24
```
25
25
https://gitee.com/wechat-minigame/minigame-tuanjie-transform-sdk.git
26
26
```
@@ -37,7 +37,7 @@ https://gitee.com/wechat-minigame/minigame-tuanjie-transform-sdk.git
37
37
38
38
## 目录结构说明
39
39
40
- 我们希望SDK与工程代码节藕 ,如此一来也更方便开发者的代码版本维护。因此 PackageManager 模式下,微信SDK内容将不再存放在游戏工程的Assets目录中。为兼容需要,仍然会自动在 Assets 目录下创建 ` WX-WASM-SDK-V2 ` 数据目录,如需保持相关的应用配置应始终保留该目录内容。
40
+ 我们希望SDK与工程代码解耦 ,如此一来也更方便开发者的代码版本维护。因此 PackageManager 模式下,微信SDK内容将不再存放在游戏工程的Assets目录中。为兼容需要,仍然会自动在 Assets 目录下创建 ` WX-WASM-SDK-V2 ` 数据目录,如需保持相关的应用配置应始终保留该目录内容。
41
41
42
42
## 常见问题
43
43
Original file line number Diff line number Diff line change 1
1
# 转换案例
2
2
3
3
文档为使用Unity WebGL适配小游戏方案的部分上线游戏。
4
- > 转换案例目的是分享学习,若作者认为不适合分享,请联系小游戏研发助手删除 。
5
- > 如开发者希望分享案例,也可通过小游戏开发助手添加 。
4
+ > 转换案例目的是分享学习,若作者认为不适合分享,请联系 [ 联系我们 ] ( IssueAndContact.md ) 删除 。
5
+ > 如开发者希望分享案例,也可通过 [ 联系我们 ] ( IssueAndContact.md ) 添加 。
6
6
7
7
## 无尽冬日
8
8
Original file line number Diff line number Diff line change 13
13
14
14
3 . 导出内存堆栈数据
15
15
- 方式1:点击性能面板左上角的"ProfilingMemory Dump" 完成导出(开启性能面板可通过修改unity-namespace.js-enableProfileStats或C#调用OpenProfileStats)
16
- - 方式2:者在微信开发者工具中选择gameContext , 并在Console输入命令: GameGlobal.memprofiler.onDump()。
16
+ - 方式2:在微信开发者工具中选择gameContext , 并在Console输入命令: GameGlobal.memprofiler.onDump()。
17
17
<img src =' ../image/memoryprofiler2.png ' width =" 600 " />
18
18
19
19
4 . 微信开发者工具-“游戏缓存目录/usr/alloc_used.csv”(Android位于data/com.tencent.mm/MicroMsg/wxanewfiles/最近使用时间的目录)拖拽并以csv方式导入sqlite数据库, 推荐使用[ DB Browser for SQLite] ( https://sqlitebrowser.org/ )
You can’t perform that action at this time.
0 commit comments