Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yyc12345 committed Jun 15, 2020
1 parent 81d1ce1 commit 7696264
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 21 deletions.
41 changes: 31 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@ Support Virtools 3.5 and 5.0
### Shortcomings

* Right-hand left-hand coordinate system conversion only support swaping YZ axis.
* For avoiding same name, all export objects will be attach a unique prefix.
* Use group to split each object and don't provide any option for changing this.
* No smooth group
* Only export 3d object. Don't support 2 dimension structure such as Line and etc.
* Couldn't detect original texture format and save it automatically

## Usage

Expand All @@ -36,6 +34,36 @@ Support Virtools 3.5 and 5.0
1. Click menu`Vtobj`-`Export object`
1. Set all options in dialog and click OK to export objects.

## Export config description

### General Setting

* Export mode: `An object`, `A group` and `All`. For `An object` and `A group`, you should pick a item in following Combobox.
* File mode: `All objects in one file` and `One file per object`. For the first option, file will be named as `all`. For the second option, file name is object name. This option only affect obj and mtl files' count.
* Export folder:It should be a existed folder. And you should pay attention to that the conflict file will be overwritten directly.

### Object Setting

* Omit object transform data: Suggest check. This option is only served for the compability with original `vt2obj`.
* Convert to right-hand coordinate system: Convert to Blender and 3ds Max's coordinate system.
* Add name prefix: Add a unique name prefix to avoid name conflict.

### Reposition Script

If you don't check `Omit object transform data` or `Convert to right-hand coordinate system`, this sector's options are disabled.

Repostion means that restore object's original move, rotation and scale.

* Generate 3ds Max script (3dsmax.ms)
* Generate Blender script (blender.py)

### Material Setting

* Export mtl file: If you don't check it, the following options are disabled.
* Export texture map in mtl: If you don't check it, all object's texture will be omitted and only keep light effect, such as reflect rate. And following options are disabled.
* Copy texture file: Copy texture into your export folder. If you have existing texture folder, you can close this option to reduce the usage of storages and reduce useless IO operation.
* Custom texture map format: If you check this and write a new suffix, all texture will be change to new format.

## Import tips

There are some tips for importing obj files generated by this plugin in 3ds Max and Blender. Following tips is under default setting (the initial settings when you first launch this plugin)
Expand Down Expand Up @@ -66,11 +94,4 @@ It is strongly not recommended that you compile by yourself unless you know Virt

## Develop plan

The following functions will be added in the future:

* Add option for cancel object and material name's prefix which originally is designd for avoiding naming problem.
* Add more options for texture export.
* No suffix (Available now).
* Universal suffix (Available now).
* Specific suffix for each texture via configuration file.
* Auto detect file suffix via specificing external texture path.
Current version is v1.3. There are no plan for futher development.
14 changes: 3 additions & 11 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@ Virtools Obj 插件
### 缺点

* 左右手翻转只能支持YZ轴翻转。
* 为了避免命名重复,物体名会被加上一个固定前缀。
* 使用组来分割物体,并且不提供任何其他选项修改。
* 平滑组没有考虑。
* 只能导出3D物体,不能导出线等二维结构
* 不能探测贴图原始格式并自动以原始格式保存。

## 操作方法

Expand All @@ -48,10 +46,11 @@ Virtools Obj 插件

* Omit object transform data:忽略世界变换矩阵,建议勾选。此选项仅仅是为了提供向vt2obj兼容的功能而存在。
* Convert to right-hand coordinate system:转为右手坐标系,特指Blender和3ds Max类型的右手坐标系。
* Add name prefix:增加唯一的名称前缀以规避名称冲突。

### Reposition Script

如果`Object Setting`中任意一项不勾选,那么下述两项将不可用。
如果`Object Setting`中前两项中的任意一项不勾选,那么下述两项将不可用。

* Generate 3ds Max script (3dsmax.ms):生成3ds Max的重定位脚本
* Generate Blender script (blender.py):生成Blender的重定位脚本
Expand Down Expand Up @@ -93,11 +92,4 @@ Virtools Obj 插件

## 开发计划

在未来,以下功能将被加入:

* 添加选项使得可以取消物体和材质的防重名前缀
* 对材质贴图导出增加更多选项
* 不修改(当前版本可用)
* 统一的后缀(当前版本可用)
* 通过配置文件手动指定各个贴图的后缀名
* 通过指定贴图路径自动探测贴图后缀名
当前版本 v1.3,没有下一步的开发计划。

0 comments on commit 7696264

Please sign in to comment.