Skip to content

Commit ebd97b2

Browse files
author
nebulaliu
committed
fix: content error
1 parent c344b97 commit ebd97b2

17 files changed

+32
-30
lines changed

Diff for: .config/.vitepress/config.mts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { defineConfig } from "vitepress";
22

33
// https://vitepress.dev/reference/site-config
44
export default defineConfig({
5-
title: "微信小游戏团结/Unity快适配",
5+
title: "微信小游戏Unity/团结快适配",
66
description: "Wechat Mini Game Unity engine adapter documents.",
77
themeConfig: {
88
logo: '/image/vitepress/icon.png',

Diff for: Design/Evaluation.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@
1414

1515
版本建议:
1616

17-
Unity版本支持从2018到最新的2021版本
17+
Unity版本支持从2018到最新的2022版本
1818

19-
建议使用LTS版本,尽量使用2021(更快编译和更小体积、压缩纹理、压缩音频等支持)
19+
建议使用LTS版本,尽量使用2022(更快编译和更小体积、压缩纹理、压缩音频等支持)
2020

2121

2222
### 3. 能力支持
2323
| 能力 |是否支持 |解决方案 |
2424
| --- | --- |--- |
2525
| Unity基础模块 |支持 |支持动画、物理、AI、UI等基础模块|
26-
| 渲染管线 |支持 |支持标准渲染管线、URP,但依赖WebGL2.0的特性处于Beta测试|
26+
| 渲染管线 |支持 |支持标准渲染管线、URP|
2727
| 资源加载 | 支持 | Addressable、AssetBundle网络异步加载 |
2828
| Lua脚本 |支持 |支持标准Lua与常见binding(如xlua, tolua等), 不支持Luajit。需根据实际游戏在真机验证性能|
2929
| PureTS |支持 | iOS系统需14.5以上, 支持JIT|
@@ -32,7 +32,7 @@ Unity版本支持从2018到最新的2021版本
3232
| 网络系统 | 需调整 |HTTP使用UnityWebRequest,TCP使用WX SDK适配或WebSocket通信替代(如开源的UnityWebSocket插件),UDP使用WX SDK适配|
3333
| 渲染接口 | 支持 |仅支持WebGL1.0(相当于OpenGLES2.0),2.0支持处于Beta测试阶段|
3434
| 多线程 | 不支持 | 删除多线程用法,使用异步等其他替代方式 |
35-
| 文件API | 需调整 |不支持System.File接口,但可使用微信小游戏WX SDK实现文件存储,大小限制为200MB。玩家存档请使用服务器或云开发;AssetsBundle缓存适配插件已自动支持|
35+
| 文件API | 需调整 |不支持System.File接口,但可使用微信小游戏WX SDK实现文件存储,[大小限制为200MB(最高可开通1GB)](FileCache.md)。玩家存档请使用服务器或云开发;AssetsBundle缓存适配插件已自动支持|
3636

3737

3838

Diff for: Design/Guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565

6666
> 相关手册:[WX SDK 平台能力适配](WX_SDK.md)[屏幕适配](fixScreen.md)[输入法适配](InputAdaptation.md)[排行榜与微信关系数据](OpenData.md)
6767
68-
​ Unity 游戏接入微信小游戏平台将获得微信提供的 API 以及开放能力,开发者根据需要进行按需接入。微信 API 支持的能力包括登陆、设备(存储、震动)、开放数据、广告等等。
68+
​ Unity 游戏接入微信小游戏平台将获得微信提供的 API 以及开放能力,开发者根据需要进行按需接入。微信 API 支持的能力包括登录、设备(存储、震动)、开放数据、广告等等。
6969

7070

7171

Diff for: Design/LaunchOperaDocument.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ lacop watch
4848

4949
#### Step4 预览默认剧情
5050

51-
使用 `微信开发者工具` 打开 `/minigame` 目录,AppID 请切换成当前登陆用户有开发权限的小游戏AppID,如果AppID是首次打开后会要求添加用于调试的小游戏插件,按照提示申请权限,若一切正常,你将在工具完全载入资源后看到默认的启动剧情内容。
51+
使用 `微信开发者工具` 打开 `/minigame` 目录,AppID 请切换成当前登录用户有开发权限的小游戏AppID,如果AppID是首次打开后会要求添加用于调试的小游戏插件,按照提示申请权限,若一切正常,你将在工具完全载入资源后看到默认的启动剧情内容。
5252

5353
#### Step5 对剧本修改
5454

Diff for: Design/PerfMeasure.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Unity小游戏的启动可参考[启动流程与时序](Startup.md)
3030
| 游戏初始化完成 | 引擎和首场景完成,出现首个业务场景 | 通过timelog, 或日志查看“游戏启动耗时” |
3131
| 游戏可交互完成 | 游戏核心场景完成 | 通常定义为用户可交互的时机,可通过[启动留存上报能力](ReportStartupStat.md)上报统计。</br>eg:休闲游戏为**核心玩法**,RPG游戏为**创角** |
3232
| 内存峰值 | 内存峰值 | 进程内存峰值,测量方法请参考[优化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> 数据路径:`数据 - 性能分析 - 运行性能 - 内存异常退出分析` |
3434
| 帧率 | 核心玩法的平均帧率 | 测量5分钟以上游戏核心玩法帧率,取平均值 |
3535
| 卡顿率 | 核心玩法的平均卡顿率 | 测量5分钟以上游戏核心玩法卡顿率,取平均值 |
3636

@@ -63,7 +63,7 @@ Unity小游戏的启动可参考[启动流程与时序](Startup.md)
6363
| 阶段 | 重点关注指标 |
6464
| :---: | --- |
6565
| 启动 | 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. 内存异常退出运行时长 |
6767
| 兼容性问题 | 1. 逻辑异常</br> 2. 黑/白屏</br> 3. JS Error |
6868

6969
#### 游戏类型说明
@@ -82,7 +82,7 @@ Unity小游戏的启动可参考[启动流程与时序](Startup.md)
8282

8383
***运行性能***
8484

85-
重点关注:`内存峰值``GC后内存峰值``内存Crash率``内存Crash运行时长`
85+
重点关注:`内存峰值``GC后内存峰值``内存异常退出率``内存异常退出运行时长`
8686

8787
<img src='../image/performance-standard/ios_running_performance.png'/>
8888

Diff for: Design/PerfOptimization.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -55,20 +55,22 @@ Unity WebGL导出形式相对于原生APP应用,需要开发者更关注性能
5555
* 释放不使用的资源
5656
* 发布前使用压缩纹理工具进行优化
5757
* 音频资源尽可能勾选强制单声道
58+
* iOS开启高性能+模式
5859

5960
更多信息请阅读:
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)
6365

6466
### 3.5 降低CPU消耗
6567
* iOS使用高性能模式
6668
* 尽量使用Android CPU Profiler在小游戏真机环境Profie计算瓶颈
6769
* 提前在Unity环境使用Unity Profiler发现问题
6870
* 物理计算较重的游戏使用Fixed Timestep控制计算频率
69-
* 在中低端机型限制帧率已减轻设备发烫
71+
* 在中低端机型限制帧率以减轻设备发烫
7072

7173
更多信息请阅读:
72-
* [iOS高性能模式](iOSOptimization.md)
74+
* [iOS 高性能与高性能+模式](iOSOptimization.md)
7375
* [使用Android CPU Profiler性能调优](AndroidProfile.md)
7476
* [使用Unity Profiler性能调优](UnityProfiler.md)

Diff for: Design/ReportStartupStat.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -145,5 +145,5 @@ export const launchEventType = {
145145

146146
***注:***
147147

148-
1. 若使用的 `转换插件版本<202211101011`(对应`Unity Loader版本<1.1.2`),数据统计报表需要建联[小游戏研发助手](IssueAndContact.md)获取。
148+
1. 若使用的 `转换插件版本<202211101011`(对应`Unity Loader版本<1.1.2`),数据统计报表需要[联系我们](IssueAndContact.md)获取。
149149
2. 数据报表数据未来会开放到《小游戏数据助手》。

Diff for: Design/SDKInstaller.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@
1414

1515
### 安装指南
1616

17-
`打开游戏工程` -> `团结/Unity Editor 菜单栏` -> `Package Manager` -> `右上方 “+”` -> `Add package from git URL`
17+
`打开游戏工程` -> `Unity/团结引擎 Editor 菜单栏` -> `Package Manager` -> `右上方 “+”` -> `Add package from git URL`
1818
URL地址为:
1919
```
2020
https://github.com/wechat-miniprogram/minigame-tuanjie-transform-sdk.git
2121
```
2222

23-
国内Gitee镜像
23+
或国内Gitee镜像
2424
```
2525
https://gitee.com/wechat-minigame/minigame-tuanjie-transform-sdk.git
2626
```
@@ -37,7 +37,7 @@ https://gitee.com/wechat-minigame/minigame-tuanjie-transform-sdk.git
3737

3838
## 目录结构说明
3939

40-
我们希望SDK与工程代码节藕,如此一来也更方便开发者的代码版本维护。因此 PackageManager 模式下,微信SDK内容将不再存放在游戏工程的Assets目录中。为兼容需要,仍然会自动在 Assets 目录下创建 `WX-WASM-SDK-V2` 数据目录,如需保持相关的应用配置应始终保留该目录内容。
40+
我们希望SDK与工程代码解耦,如此一来也更方便开发者的代码版本维护。因此 PackageManager 模式下,微信SDK内容将不再存放在游戏工程的Assets目录中。为兼容需要,仍然会自动在 Assets 目录下创建 `WX-WASM-SDK-V2` 数据目录,如需保持相关的应用配置应始终保留该目录内容。
4141

4242
## 常见问题
4343

Diff for: Design/ShowCase.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# 转换案例
22

33
文档为使用Unity WebGL适配小游戏方案的部分上线游戏。
4-
> 转换案例目的是分享学习,若作者认为不适合分享,请联系小游戏研发助手删除
5-
> 如开发者希望分享案例,也可通过小游戏开发助手添加
4+
> 转换案例目的是分享学习,若作者认为不适合分享,请联系[联系我们](IssueAndContact.md)删除
5+
> 如开发者希望分享案例,也可通过[联系我们](IssueAndContact.md)添加
66
77
## 无尽冬日
88

Diff for: Design/UsingMemoryProfiler.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
3. 导出内存堆栈数据
1515
- 方式1:点击性能面板左上角的"ProfilingMemory Dump" 完成导出(开启性能面板可通过修改unity-namespace.js-enableProfileStats或C#调用OpenProfileStats)
16-
- 方式2:者在微信开发者工具中选择gameContext, 并在Console输入命令: GameGlobal.memprofiler.onDump()。
16+
- 方式2:在微信开发者工具中选择gameContext, 并在Console输入命令: GameGlobal.memprofiler.onDump()。
1717
<img src='../image/memoryprofiler2.png' width="600"/>
1818

1919
4. 微信开发者工具-“游戏缓存目录/usr/alloc_used.csv”(Android位于data/com.tencent.mm/MicroMsg/wxanewfiles/最近使用时间的目录)拖拽并以csv方式导入sqlite数据库, 推荐使用[DB Browser for SQLite](https://sqlitebrowser.org/)

Diff for: Design/UsingNetworking.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 网络通信适配
22

3-
由于安全性的影响,JavaScript 代码没有直接访问 IP 套接字来实现网络连接。因此,该.NET 网络类(System.Net 命名空间中的一切,特别是**_System.Net.Sockets_**)在 WebGL 中不能工作。UnityEngine.Network\* 类也是这样,编译 WebGL 时将找不到这些类。
3+
由于安全性的影响,JavaScript 代码没有直接访问 IP 套接字来实现网络连接。因此,该.NET 网络类(System.Net 命名空间中的一切,特别是**System.Net.Sockets**)在 WebGL 中不能工作。UnityEngine.Network\* 类也是这样,编译 WebGL 时将找不到这些类。
44

55
## HTTP 通信
66

Diff for: Design/WasmSplit.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ iOS 高性能模式由于加载子包的实现不同,刚开始收集时又基
329329

330330
### 如何查看分包插件日志
331331
当出现问题时,优先排查是否stable版本的微信开发者工具,能解决大部分问题。
332-
若问题仍无法解决,可联系小游戏研发助手8号,提供日志排查。
332+
若问题仍无法解决,[联系我们](IssueAndContact.md),提供日志排查。
333333
日志获取方式:
334334
> 菜单栏-微信开发者工具-调试-调试微信开发者工具,搜索关键字:extension host。可右键保存日志文件
335335

Diff for: Design/WebGL2.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Unity WebGL较多渲染优化特性依赖WebGL2.0, 因此这里需要针对该
2020
- iOS高性能使用WebGL2会存在较多问题,平台暂不保证所有能力完善,开发者务必验证游戏所用到的特性支持情况。
2121
- 对于WebGL2, [高性能+模式](https://developers.weixin.qq.com/minigame/dev/guide/performance/perf-high-performance-plus.html)有更好的兼容性。
2222

23-
如遇到问题请与小游戏研发助手(微信号:minigamedevop08)联系详细排查
23+
如遇到问题请[联系我们](IssueAndContact.md)详细排查
2424

2525
### iOS高性能模式开启GPU Instance,模型闪烁/消失/不绘制等问题
2626
- **原因**:iOS WebKit对webGL2的支持存在问题,当uniform变量过多时,会出现绘制不正确、不绘制、效率变低等现象;

Diff for: Design/iOSOptimization.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171

7272
iOS 端小游戏高性能模式适用于遇到 iOS 环境运行性能不足,运行发烫的小游戏。
7373

74-
- 需要该能力的开发者登录[微信公众平台](https://mp.weixin.qq.com) -> 首页能力地图模块 -> 点击进入"生产提效包" -> 点击开通高性能模式。
74+
- 需要该能力的开发者登录[微信公众平台](https://mp.weixin.qq.com) -> 能力地图 -> 研发能力 -> 生产提效包 -> 点击开通高性能模式。
7575
<img src="../image/mp_addplugin.png"/>
7676
- 开通成功后,过配置 game.json 的 iOSHighPerformance 为 true 则可进入高性能模式,通过去掉此开关可以正常回退到普通模式,以便两种模式对比。
7777

Diff for: README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# 微信小游戏团结/Unity适配方案
1+
# 微信小游戏Unity/团结引擎适配方案
22

3-
欢迎使用 Unity WebGL 小游戏适配方案(又称团结Unity快适配),本方案设计目的是**降低 Unity 游戏转换到微信小游戏的开发成本**。基于WebAssembly技术,无需更换Unity引擎与重写核心代码的情况下将原有游戏项目适配到微信小游戏。
3+
欢迎使用 Unity WebGL 小游戏适配方案(又称Unity/团结引擎快适配),本方案设计目的是**降低 Unity 游戏转换到微信小游戏的开发成本**。基于WebAssembly技术,无需更换Unity引擎与重写核心代码的情况下将原有游戏项目适配到微信小游戏。
44

55
**官方文档:[https://wechat-miniprogram.github.io/minigame-unity-webgl-transform/](https://wechat-miniprogram.github.io/minigame-unity-webgl-transform/)**
66

@@ -20,7 +20,7 @@
2020

2121
## 安装与使用
2222

23-
下载 [Unity插件](https://game.weixin.qq.com/cgi-bin/gamewxagwasmsplitwap/getunityplugininfo?download=1)并导入至游戏项目中,版本更新请查看[更新日志](https://wechat-miniprogram.github.io/minigame-unity-webgl-transform/CHANGELOG.html)团结版 or Package安装请查阅[SDK安装指引](https://wechat-miniprogram.github.io/minigame-unity-webgl-transform/Design/SDKInstaller.html)
23+
下载 [Unity插件](https://game.weixin.qq.com/cgi-bin/gamewxagwasmsplitwap/getunityplugininfo?download=1)并导入至游戏项目中,版本更新请查看[更新日志](https://wechat-miniprogram.github.io/minigame-unity-webgl-transform/CHANGELOG.html)团结版或Package安装请查阅[SDK安装指引](https://wechat-miniprogram.github.io/minigame-unity-webgl-transform/Design/SDKInstaller.html)
2424

2525
- 请查阅[推荐引擎版本](https://wechat-miniprogram.github.io/minigame-unity-webgl-transform/Design/UnityVersion.html),安装时选择WebGL组件
2626
- 前往[微信开发者工具下载](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html)安装Stable版开发者工具【注意:为保证稳定性,请勿使用小游戏版 Minigame Build】

Diff for: image/mp_addplugin.png

-221 KB
Loading

Diff for: index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ layout: home
44
hero:
55
name: "Unity/团结快适配方案"
66
text: "基于WebGL + WebAssembly"
7-
tagline: 无需使用JavaScript重构,快速移植团结/Unity游戏至微信小游戏平台解决方案
7+
tagline: 无需使用JavaScript重构,快速移植Unity/团结引擎游戏至微信小游戏平台解决方案
88
image:
99
src: /image/vitepress/home.png
1010
alt: WeChatGame & Unity

0 commit comments

Comments
 (0)