update doc english part

This commit is contained in:
yyc12345 2024-02-13 12:06:16 +08:00
parent 02a1222210
commit 5a5053440c
18 changed files with 114 additions and 21 deletions

View File

@ -4,4 +4,4 @@
BBP NG, abbr **B**allance **B**lender **P**lugin **N**ext **G**eneration.
For an introduction to this plugin, installing it, compiling it, reporting bugs, etc., see the GitHub Page for this project: https://yyc12345.github.io/BallanceBlenderHelper
For an introduction to this plugin, installing it, compiling it, reporting bugs, etc., see the GitHub Page of this project: https://yyc12345.github.io/BallanceBlenderHelper

View File

@ -0,0 +1,4 @@
# Add Floor
!!! info "Work in Progress"
This part of manual still work in progress.

View File

@ -0,0 +1,4 @@
# Compile and Distribute Plugin
!!! info "Work in Progress"
This part of manual still work in progress.

View File

@ -0,0 +1,4 @@
# Add Component
!!! info "Work in Progress"
This part of manual still work in progress.

View File

@ -0,0 +1,4 @@
# Configure Plugin
!!! info "Work in Progress"
This part of manual still work in progress.

View File

@ -0,0 +1,4 @@
# Group Operation
!!! info "Work in Progress"
This part of manual still work in progress.

View File

@ -0,0 +1,4 @@
# Import and Export Virtools Document
!!! info "Work in Progress"
This part of manual still work in progress.

View File

@ -1,7 +1,7 @@
# Ballance Blender Plugin User Manual
!!! info "Work in Progress"
This part of manual still work in progress.
!!! info "May Outdated"
This document has been translated from other languages and may not always be up to date.
Welcome to the Ballance Blender Plugin, the user manual for the free and open source Ballance map creation suite.
@ -13,22 +13,26 @@ Therefore, choosing Blender with BBP for mapping is not only choosing freedom an
## Getting Started
* Installing Plugin
* Configuring Plugin
* [Install Plugin](./install-plugin.md)
* [Configure Plugin](./configure-plugin.md)
## Basics
## Features
* Virtools Properties
* Importing and Exporting Virtools Documents
* Operating by Groups
* Advanced UV
* Adding Prefabricated Structures
* Adding Rails
* Adding Components
* [Virtools Properties](./virtools-properties.md)
* [Import and Export Virtools Document](./import-export-virtools.md)
* [Group Operation](./group-operations.md)
* [Legacy Alignment](./legacy-align.md)
* [Naming Convention](./naming-convention.md)
* [UV Mapping](./uv-mapping.md)
* [Add Floor](./bme-adder.md)
* [Add Rail](./rail-adder.md)
* [Add Component](./component-adder.md)
## Advanced
## Misc
* Compiling and distributing plugins
* [Compile and Distribute Plugin](./compile-distribute-plugin.md)
* [Report Issue](./report-bugs.md)
* [Technical Information](./tech-infos.md)
!!! info "These are not all"
This manual only documents the relevant operations regarding this plugin and does not explain how to make a Ballance map here. For detailed information on how to make a Ballance map with Blender and BBP, please search for content on Bilibili or YouTube.

View File

@ -0,0 +1,4 @@
# Install Plugin
!!! info "Work in Progress"
This part of manual still work in progress.

View File

@ -0,0 +1,4 @@
# Legacy Alignment
!!! info "Work in Progress"
This part of manual still work in progress.

View File

@ -0,0 +1,4 @@
# Naming Convention
!!! info "Work in Progress"
This part of manual still work in progress.

View File

@ -0,0 +1,4 @@
# Add Rail
!!! info "Work in Progress"
This part of manual still work in progress.

View File

@ -0,0 +1,4 @@
# Report Issue
!!! info "Work in Progress"
This part of manual still work in progress.

View File

@ -0,0 +1,4 @@
# Technical Information
!!! info "Work in Progress"
This part of manual still work in progress.

View File

@ -0,0 +1,4 @@
# UV Mapping
!!! info "Work in Progress"
This part of manual still work in progress.

View File

@ -0,0 +1,4 @@
# Virtools Properties
!!! info "Work in Progress"
This part of manual still work in progress.

View File

@ -1,8 +1,5 @@
# Virtools属性
!!! info "制作中..."
手册的这部分还在制作当中。稍安勿躁。
## Virtools组
BBP插件为每一个Blender物体添加了新的属性被称为Virtools Group。与Virtools中的组具有相同的功能。选择一个物体在`Object`属性面板可以找到`Virtools Group`面板。
@ -25,16 +22,38 @@ BBP还在Blender的其它菜单提供了对Virtools组的访问具体内容
`Virtools Material`面板同样提供把`Virtools Material`面板中的材质数据反应到Blender材质上的功能以在Blender中获得可视的效果。点击顶部的`Apply`按钮即可执行此功能。当你在Blender中保存Virtools文档时Virtools文档中的材质数据将从`Virtools Material`面板中指定的数值获取而不会从Blender材质中获取。这意味一个正确的材质设置过程是先在`Virtools Material`面板中编辑材质参数,然后使用`Apply`按钮将其反映到Blender材质上而不是直接去编辑Blender材质。
TODO: 添加有关贴图选择按钮的帮助内容
`Virtools Material`面板提供了材质修复功能,这个功能来源于[Ballance Virtools Plugin](https://github.com/yyc12345/BallanceVirtoolsHelper)。材质修复按钮位于`Preset`按钮和`Apply`按钮的右侧是一个带有扳手图标的按钮。点击后需要再次确认才能使用防止误操作。材质修复功能会根据当前材质引用的贴图文件的文件名判定它是哪一种类型的材质再根据我们预设的修复设定从游戏中获取将其他参数修改得符合视觉要求。这通常用于一些游戏中看起来材质错误的物体的修复例如发黑的Stopper等。
!!! info "还有一个全局材质修复功能"
3D视图中菜单`Ballance - Fix Material`与材质修复功能类似,但其会修复当前文档内所有材质。除非你确定当前文档内所有材质都需要修复,否则不要使用这个功能,因为它可能会将一些原本特殊设置的,正确的材质设置回你不想要的通用数值。
全局材质修复功能点击后也需再次确认才能使用,以防止误操作。
`Virtools Material`面板中的Texture贴图属性不仅可以通过点击它来选择文档内的材质还可以通过点击右侧的文件夹按钮打开贴图文件浏览器直接从文件系统中选择你想要的贴图比从Shading菜单中选取更加快速。文件浏览器默认位于Ballance的Texture目录下以方便Ballance材质的选取。
## Virtools贴图
TODO...
BBP插件为所有Blender贴图实际上是Image添加了新的属性称为Virtools Texture。它在Virtools贴图与Blender图片之间架起联系。
与Blender材质不同的是由于Blender的实现原因贴图没有单独的属性面板因此我们只能在`Virtools Material`面板中通过一种非直接的方式访问Virtools贴图属性。首先参照Virtools材质章节的说明找到`Virtools Material`面板,然后在`Virtools Material`面板中的材质插槽中选择一个贴图或打开一个贴图就可以发现在材质的贴图属性下方额外显示了Virtools贴图属性如下图高亮部分所示。
![](../imgs/virtools-texture.png)
其中Save Option表示贴图在Virtools中的存储方式常见的存储方式有这几种
* External外部存储文件只存储引用的文件名。所有Ballance原生贴图都应该使用此模式。
* Raw Data原始数据贴图存储在文件内缺点是会导致文件很大。所有非原生Ballance贴图都应该使用此模式。
* Use Global使用全局设定。除非是正在修改地图否则我们不建议使用此方式。我们建议在这里就明确指定各个贴图的存储方式而不要使用全局值。全局设定在导出Virtools文档时被确定下来。
而Video Format表示贴图在Virtools中的渲染模式常用的模式有这几种
* 32 Bits ARGB8888带有透明度的各类贴图的存储方式例如柱子渐变部分。
* 16 Bits ARGB1555不带有透明度的各类贴图的存储方式例如路面。
## Virtools网格
TODO...
BBP插件为所有Blender贴图实际上是Image添加了新的属性称为Virtools Mesh。转到`Data`属性面板,即可以找到`Virtools Mesh`面板。
![](../imgs/virtools-mesh.png)
Virtools网格目前只是作为兼容来使用的。其只有Lit Mode一个属性可以设置。多数早期地图由于不知道如何正确设置材质导致路面发黑所以经常将Lit Mode设置为Prelit以让路面正常显示。此属性是为了兼容这种设计而存在的用户通常无需设置此选项。

View File

@ -8,6 +8,20 @@ nav:
- 「 」: 'index.md'
- English:
- 'Start': 'en/index.md'
- 'Install Plugin': 'en/install-plugin.md'
- 'Configure Plugin': 'en/configure-plugin.md'
- 'Virtools Properties': 'en/virtools-properties.md'
- 'Import and Export Virtools Document': 'en/import-export-virtools.md'
- 'Group Operation': 'en/group-operations.md'
- 'Legacy Alignment': 'en/legacy-align.md'
- 'Naming Convention': 'en/naming-convention.md'
- 'UV Mapping': 'en/uv-mapping.md'
- 'Add Floor': 'en/bme-adder.md'
- 'Add Rail': 'en/rail-adder.md'
- 'Add Component': 'en/component-adder.md'
- 'Compile and Distribute Plugin': 'en/compile-distribute-plugin.md'
- 'Report Issue': 'en/report-bugs.md'
- 'Technical Information': 'en/tech-infos.md'
- 简体中文:
- '开始': 'zh-cn/index.md'
- '安装插件': 'zh-cn/install-plugin.md'