Skip to content

Commit

Permalink
doc: update english documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yyc12345 committed Jul 21, 2024
1 parent 512e7e8 commit 1661f82
Show file tree
Hide file tree
Showing 4 changed files with 88 additions and 8 deletions.
29 changes: 27 additions & 2 deletions docs/docs/en/configure-plugin.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,29 @@
# Configure Plugin

!!! info "Work in Progress"
This part of manual still work in progress.
!!! info "The plugin must be configured first"
Some of the configurations of the BBP plugin are closely related to the use of the plugin, and only when the BBP plugin is correctly configured can the full functionality of the BBP plugin be used.

**Whether installing for the first time or updating**, reconfiguring the plugin is essential to ensure that the settings are correct.

## Open the Configuration Panel

Open Blender, select `Edit - Preferences`, in the window that opens go to the `Add-ons` tab and find the BBP plugin in the list. Its name is `Ballance Blender Plugin`. Make sure that the checkbox next to the name is checked, which means that the plugin is enabled. Click on the triangular arrow to the left of the checkbox to expand the plugin details to enter the configuration panel as shown in the figure.

![](../imgs/config-plugin.png)

## Start to Configure

The BBP plugin currently has 2 settings to configure.

### External Texture Folder

Please fill in the `Texture` directory of Ballance, from which the plugin will use the external texture files (i.e. the ones Ballance originally came with). Click on the folder button on the right to browse the folders and select it.

This is crucial for BBP to work properly, and only if it is filled out correctly will BBP not make errors during operation.

### No Component Collection

When importing and exporting BM files, objects that are in a collection with this name will be forced to be specified as No Component. leaving this blank means that this feature is not needed. This feature is usually used for forced element model replacement.

!!! warning "This setting is not required at this time"
Since BBP 4.0 supports native import/export of Virtools files, the BM file import/export function is no longer used. Therefore, this field is no longer useful and does not need to be filled in.
2 changes: 1 addition & 1 deletion docs/docs/en/install-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ In addition, you can also get this plugin in the mapping tutorial web disk provi
!!! warning “Do not download this repository directly for use”
Please do not download this project's repository directly for use. First of all, because the latest commit is not guaranteed to be stable and available. The second reason is that this project contains some C++ code that needs to be compiled, and must be compiled before it can be used. See [Compile and Distribute Plugin](./compile-distribute-plugin.md) for more information.

## Installing Plugin
## Install Plugin

Open Blender, click `Edit - Preferences`, in the window that opens go to the `Add-ons` tab, click on the arrow at the top right of the window and then click on the `Install from Disk.... ` button, select the ZIP archive you just downloaded, and the installation will be completed. If you don't see it in the list you can click the Refresh button or restart Blender.

Expand Down
59 changes: 57 additions & 2 deletions docs/docs/en/virtools-properties.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,59 @@
# Virtools Properties

!!! info "Work in Progress"
This part of manual still work in progress.
## Virtools Group

The BBP plugin adds a new property to every Blender object, called Virtools Group. has the same functionality as Group in Virtools. Select an object and the `Virtools Group` panel can be found in the `Object` properties panel.

![](../imgs/virtools-group.png)

In the `Virtools Group` panel, you can click Add to group objects. After clicking the Add button, you can select Predefined and then select one of all legal Ballance group names to add. Or select Custom and enter the group name you want to add. The selected Virtools group can also be deleted by clicking the Delete button. Finally, all group data for this object can be deleted at once by clicking the Trash icon button (which will let you confirm before deleting).

BBP also provides access to Virtools groups in Blender's other menus, see [Group Operation](./group-operations.md).

## Virtools Material

The plugin adds a new property to every Blender material, called Virtools Material, which bridges the gap between Virtools materials and Blender materials. Go to the `Material` properties panel and select a material to find the `Virtools Material` panel.

![](../imgs/virtools-material.png)

You can set material properties in the `Virtools Material` panel, just like in Virtools. All material parameters in the `Virtools Material` panel are maps of the material parameters in Virtools and will be accurately reflected in the final saved Virtools document.

The `Virtools Material` panel provides a preset function, which can be started by clicking the `Preset` button at the top. The preset function allows the user to use some preset material settings, such as the material data for the top surface of the road, the sides, etc., for ease of use. Note that using a preset does not affect the material's texture options, and you will still need to set the material's texture manually once the preset has been applied.

The `Virtools Material` panel also provides the ability to convert the material data in the `Virtools Material` panel to the Blender material for a visual effect in Blender. Click the `Apply` button at the top to perform this function. When you save a Virtools document in Blender, the material data in the Virtools document will be retrieved from the values specified in the `Virtools Material` panel and not from the Blender material. This means that a proper procedure for setting up a material is to edit the material parameters in the `Virtools Material` panel and then use the `Apply` button to convert them to the Blender material, instead of editing the Blender material directly.

The `Virtools Material` panel provides material repair functionality, which is inherited from the [Ballance Virtools Plugin](https://github.com/yyc12345/BallanceVirtoolsHelper). The Material repair button is located to the right of the `Preset` button and the `Apply` button, and is a button with a wrench icon. Clicking it requires reconfirmation to prevent misuse. The material repair function determines which type of material the current material is based on the filename of the texture file it references, and then modifies the other parameters to make it visually appealing based on our preset repair settings (taken from the game). This is usually used for fixing objects that look like they have the wrong material in the game, such as a black Stopper, etc.

!!! info "There is also a global material fix function"
In the 3D view, the menu `Ballance - Fix Material` is similar to the material fix function, but it will fix all materials within the current document. Don't use this feature unless you are sure that all materials in the current document need to be fixed, as it may set some of the originally special, correct materials back to generic values that you don't want.

The Global Material Repair function also needs to be reconfirmed after clicking on it before it can be used, to prevent misuse.

The Texture property in the `Virtools Material` panel not only allows you to select a texture within a document by clicking on it, but also opens the Texture File Browser by clicking on the folder button on the right side, which allows you to select the texture you want directly from the file system (much faster than selecting it from the Shading tab). The file browser is navigated in Ballance's Texture directory by default, to make it easier to select Ballance materials.

## Virtools Texture

The BBP plugin adds a new property to all Blender textures (actually Images) called Virtools Texture, which creates a link between Virtools textures and Blender images.

Unlike Blender materials, due to Blender's implementation there is no separate properties panel for textures, so we can only access Virtools texture properties in an indirect way in the `Virtools Material` panel. First find the `Virtools Material` panel by referring to the instructions in the `Virtools Material` chapter, then select a texture or open a texture in the material slot in the `Virtools Material` panel, and you'll see that the Virtools texture attributes are displayed additionally underneath the texture attributes of the material, as shown in the highlighted portion of the image below.

![](../imgs/virtools-texture.png)

Among them, Save Option indicates how the texture is stored in Virtools, and these are the common storage methods:

* External: The file only stores the name of the referenced file. All Ballance native textures should use this mode.
* Raw Data: The texture is stored inside the file, the disadvantage is that it will lead to a large file. All non-native Ballance maps should use this mode.
* Use Global: Use global settings. We do not recommend using this unless you are modifying an existing map. We recommend explicitly specifying how individual textures are stored right here, rather than using global values. The global setting is determined when exporting the Virtools document.

The Video Format indicates the rendering mode of the texture in Virtools, and these are the commonly used modes:

* 32 Bits ARGB8888: The storage mode for all kinds of textures with transparency, such as the column gradient part.
* 16 Bits ARGB1555: The way to store all kinds of maps without transparency, such as floor.

## Virtools Mesh

The BBP plugin adds a new property to all Blender meshes called Virtools Mesh. go to the `Data` properties panel to find the `Virtools Mesh` panel.

![](../imgs/virtools-mesh.png)

The Virtools Mesh is currently only used as a compatibility feature. It has only one property, Lit Mode, that can be set. Most early maps had black floor issue because they didn't know how to set the material correctly, so the Lit Mode was often set to Prelit to get the floor to show up properly. This attribute exists for compatibility with this compromise and the user usually does not need to set this option.
6 changes: 3 additions & 3 deletions docs/docs/zh-cn/virtools-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ BBP还在Blender的其它菜单提供了对Virtools组的访问,具体内容

`Virtools Material`面板提供了预设功能,点击顶部的`Preset`按钮即可开始进行预设。预设功能允许用户使用一些预设的材质设置,例如路面顶面,侧面的材质数据等,方便使用。需要注意的是,使用预设不会影响材质的贴图选项,当应用预设后,你仍然需要手动设置材质的贴图。

`Virtools Material`面板同样提供把`Virtools Material`面板中的材质数据反应到Blender材质上的功能,以在Blender中获得可视的效果。点击顶部的`Apply`按钮即可执行此功能。当你在Blender中保存Virtools文档时,Virtools文档中的材质数据将从`Virtools Material`面板中指定的数值获取,而不会从Blender材质中获取。这意味一个正确的材质设置过程是:先在`Virtools Material`面板中编辑材质参数,然后使用`Apply`按钮将其反映到Blender材质上,而不是直接去编辑Blender材质。
`Virtools Material`面板同样提供把`Virtools Material`面板中的材质数据转换到Blender材质上的功能,以在Blender中获得可视的效果。点击顶部的`Apply`按钮即可执行此功能。当你在Blender中保存Virtools文档时,Virtools文档中的材质数据将从`Virtools Material`面板中指定的数值获取,而不会从Blender材质中获取。这意味一个正确的材质设置过程是:先在`Virtools Material`面板中编辑材质参数,然后使用`Apply`按钮将其转换到Blender材质上,而不是直接去编辑Blender材质。

`Virtools Material`面板提供了材质修复功能,这个功能来源于[Ballance Virtools Plugin](https://github.com/yyc12345/BallanceVirtoolsHelper)。材质修复按钮位于`Preset`按钮和`Apply`按钮的右侧,是一个带有扳手图标的按钮。点击后需要再次确认才能使用,防止误操作。材质修复功能会根据当前材质引用的贴图文件的文件名判定它是哪一种类型的材质,再根据我们预设的修复设定(从游戏中获取)将其他参数修改得符合视觉要求。这通常用于一些游戏中看起来材质错误的物体的修复,例如发黑的Stopper等。

Expand All @@ -29,7 +29,7 @@ BBP还在Blender的其它菜单提供了对Virtools组的访问,具体内容

全局材质修复功能点击后也需再次确认才能使用,以防止误操作。

`Virtools Material`面板中的Texture(贴图)属性不仅可以通过点击它来选择文档内的材质,还可以通过点击右侧的文件夹按钮打开贴图文件浏览器,直接从文件系统中选择你想要的贴图(比从Shading菜单中选取更加快速)。文件浏览器默认位于Ballance的Texture目录下,以方便Ballance材质的选取。
`Virtools Material`面板中的Texture(贴图)属性不仅可以通过点击它来选择文档内的贴图,还可以通过点击右侧的文件夹按钮打开贴图文件浏览器,直接从文件系统中选择你想要的贴图(比从Shading菜单中选取更加快速)。文件浏览器默认位于Ballance的Texture目录下,以方便Ballance材质的选取。

## Virtools贴图

Expand All @@ -43,7 +43,7 @@ BBP插件为所有Blender贴图(实际上是Image)添加了新的属性,

* External:外部存储,文件只存储引用的文件名。所有Ballance原生贴图都应该使用此模式。
* Raw Data:原始数据,贴图存储在文件内,缺点是会导致文件很大。所有非原生Ballance贴图都应该使用此模式。
* Use Global:使用全局设定。除非是正在修改地图,否则我们不建议使用此方式。我们建议在这里就明确指定各个贴图的存储方式,而不要使用全局值。全局设定在导出Virtools文档时被确定下来。
* Use Global:使用全局设定。除非是你正在修改一张已经存在地图,否则我们不建议使用此方式。我们建议在这里就明确指定各个贴图的存储方式,而不要使用全局值。全局设定在导出Virtools文档时被确定下来。

而Video Format表示贴图在Virtools中的渲染模式,常用的模式有这几种:

Expand Down

0 comments on commit 1661f82

Please sign in to comment.