update document

yyc12345 · Apr 6, 2024 · 9c548e0 · 9c548e0
1 parent 3396947
commit 9c548e0
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 2 deletions.
diff --git a/docs/docs/en/ballance-properties.md b/docs/docs/en/ballance-properties.md
@@ -0,0 +1,4 @@
+# Ballance Properties
+
+!!! info "Work in Progress"
+    This part of manual still work in progress.
diff --git a/docs/docs/en/index.md b/docs/docs/en/index.md
@@ -19,6 +19,7 @@ Therefore, choosing Blender with BBP for mapping is not only choosing freedom an
 ## Features
 
 * [Virtools Properties](./virtools-properties.md)
+* [Ballance Properties](./ballance-properties.md)
 * [Import and Export Virtools Document](./import-export-virtools.md)
 * [Group Operation](./group-operations.md)
 * [Legacy Alignment](./legacy-align.md)

diff --git a/docs/docs/imgs/ballance-properties.png b/docs/docs/imgs/ballance-properties.png
diff --git a/docs/docs/zh-cn/ballance-properties.md b/docs/docs/zh-cn/ballance-properties.md
@@ -0,0 +1,29 @@
+# Ballance属性
+
+Ballance属性有别于Virtools属性，它是专门为Ballance制图服务的一系列属性。这些属性寄宿于场景，在同一场景中（制图不会涉及Blender中的场景切换），这些属性不会改变。在`Scene`属性面板可以找到Ballance属性相关的面板，如下图所示，分别是：
+
+* `Ballance Elements`面板（红色箭头），对应Ballance机关
+* `BME Materials`面板（绿色箭头），对应BME材质
+* `Ballance Map`面板（蓝色箭头），对应Ballance地图信息
+
+其中，只有Ballance地图信息是你需要重点关注的，其它属性在通常情况下不需要关注，除非地图中的某些材质或网格出现错误后，才需要关注这些属性。
+
+![](../imgs/ballance-properties.png)
+
+## Ballance地图信息
+
+Ballance地图信息目前只有一个选项，Sector（地图小节数）。此属性指示了当前地图的最终期望小节数。这个属性主要是用于解决导出地图Bug的，具体Bug内容可参考导入导出Virtools文档章节。
+
+你需要做的唯一一件事就是在导出最终地图前检查此字段是否是你期望的小节数。需要注意的是，尽管你可以在创建地图的一开始就设置此字段，然而BBP中的其它一些功能可能会修改此字段，比如：添加机关，导入Virtools文档等。例如当你的地图小节指定为3，你正在添加一个归属于第4小节的机关，那么此值会自动增加到4。同理，在导入一个总共4小节的Ballance地图时，此值也会增加到4（如果先前值小于4的话）。这主要是为了用户可以在没有感知到此值的情况下使用此插件，尤其是在对某些现有地图进行略微修改时。然而如此操作，可能会在某些情况下不能满足用户的需求，所以仍建议你在导出前检查此字段。
+
+## Ballance机关
+
+Ballance机关记录了你所有使用BBP添加机关功能添加的机关的网格。在3D文件中，通常而言网格占据了最大的数据量，因此减少网格的数量，即通过在各个相同形状的物体之间共享网格，可以大幅减少地图文件所占用的大小。当你使用BBP添加机关相关功能时，会首先尝试从这里获取机关的网格，如果没有对应网格，则加载并记录在这里。
+
+这个面板只供查看，不可编辑。当你不小心修改了BBP添加的机关的网格（它们本不该被修改）后，想要恢复其原有形状时，只需点击`Reset Ballance Elements`即可将列表中的所有机关网格重置为正确状态。
+
+## BME材质
+
+与Ballance机关类似，记录了使用BME添加路面时使用的材质。这也是为了可以复用材质而设计的，这样就不需要每创建一个物体就创建一套与之相关的材质，大大减少了重复材质的数量。
+
+这个面板只供查看，不可编辑。当你不小心修改了BME相关的材质（它们本不该被修改）后，想要恢复其原有材质时，只需点击`Reset BME Materials`即可将列表中的所有材质重置为正确状态。
diff --git a/docs/docs/zh-cn/import-export-virtools.md b/docs/docs/zh-cn/import-export-virtools.md
@@ -46,3 +46,10 @@ Global Texture Save Option（全局贴图保存选项）决定了那些设置了
 
 Use Compress（使用压缩）属性指定保存的文档是否压缩存储。压缩可以显著减少文档体积，且在现代计算机平台上，压缩所造成的性能损失几乎可以忽略不计。当选择使用压缩后，一个额外的Compress Level（压缩等级）属性将会显示，用于指定压缩的级别，数值越高，压缩率越大，文件越小。
 
+### Ballance参数
+
+Ballance Params（Ballance参数）章节包含针对Ballance特有内容，对导出过程进行优化的参数。
+
+Successive Sector（小节连续）是一个解决导出小节组时出现的Bug的选项。由于某些原因，如果一个小节中没有任何机关（实际上是某小节组中没有归入任何物体），导出插件会认为该小节组不存在，因而遗漏导出。且由于Ballance对最终小节，即飞船出现小节的判定是从1开始递增寻找最后一个存在的小节组，所以二者叠加，会导致Ballance错误地认定地图的小节数，从而在错误的小节显示飞船，这也就是导出Bug。当勾选此选项后，导出文档时会预先按照当前Blender文件中Ballance地图信息中指定的小节数预先创建所有小节组，然后再进行导出，这样就不会遗漏创建某些小节组，飞船也会在正确的小节显示。
+
+这个选项通常在导出可游玩的地图时选中，如果你只是想导出一些模型，那么需要关闭此选项，否则会在最终文件中产生许多无用的小节组。
diff --git a/docs/docs/zh-cn/index.md b/docs/docs/zh-cn/index.md
@@ -16,6 +16,7 @@ Ballance Blender Plugin（后文简称BBP）是一款关注Ballance自制地图
 ## 特性
 
 * [Virtools属性](./virtools-properties.md)
+* [Ballance属性](./ballance-properties.md)
 * [导入导出Virtools文档](./import-export-virtools.md)
 * [按组操作](./group-operations.md)
 * [传统对齐](./legacy-align.md)

diff --git a/docs/docs/zh-cn/legacy-align.md b/docs/docs/zh-cn/legacy-align.md
@@ -8,7 +8,7 @@
 
 ## 使用方法
 
-传统对齐支持将多个物体对一个物体的对齐，操作方法是先依次选中需要被对齐的物体，然后在最后选中对齐参考对象（也就是使其称为活动物体），然后点击`Ballance - 3ds Max Align`，即可弹出传统对齐面板，之后便可开始对齐操作。
+传统对齐支持将多个物体对一个物体的对齐，操作方法是先依次选中需要被对齐的物体，然后在最后选中对齐参考对象（也就是使其成为活动物体），然后点击`Ballance - 3ds Max Align`，即可弹出传统对齐面板，之后便可开始对齐操作。
 
 ## 面板介绍
 

diff --git a/docs/docs/zh-cn/virtools-properties.md b/docs/docs/zh-cn/virtools-properties.md
@@ -52,7 +52,7 @@ BBP插件为所有Blender贴图（实际上是Image）添加了新的属性，
 
 ## Virtools网格
 
-BBP插件为所有Blender贴图（实际上是Image）添加了新的属性，称为Virtools Mesh。转到`Data`属性面板，即可以找到`Virtools Mesh`面板。
+BBP插件为所有Blender网格添加了新的属性，称为Virtools Mesh。转到`Data`属性面板，即可以找到`Virtools Mesh`面板。
 
 ![](../imgs/virtools-mesh.png)
 

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -11,6 +11,7 @@ nav:
     - 'Install Plugin': 'en/install-plugin.md'
     - 'Configure Plugin': 'en/configure-plugin.md'
     - 'Virtools Properties': 'en/virtools-properties.md'
+    - 'Ballance Properties': 'en/ballance-properties.md'
     - 'Import and Export Virtools Document': 'en/import-export-virtools.md'
     - 'Group Operation': 'en/group-operations.md'
     - 'Legacy Alignment': 'en/legacy-align.md'
@@ -27,6 +28,7 @@ nav:
     - '安装插件': 'zh-cn/install-plugin.md'
     - '配置插件': 'zh-cn/configure-plugin.md'
     - 'Virtools属性': 'zh-cn/virtools-properties.md'
+    - 'Ballance属性': 'zh-cn/ballance-properties.md'
     - '导入导出Virtools文档': 'zh-cn/import-export-virtools.md'
     - '按组操作': 'zh-cn/group-operations.md'
     - '传统对齐': 'zh-cn/legacy-align.md'