Pantyhose-X
/
vengi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

DOCS: extracted configuration docs for voxconvert

master
Martin Gerhardy 2021-12-27 13:28:13 +01:00
parent 328d0773f8
commit 5266f7e43e
7 changed files with 28 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/Formats.md
View File

@ -1,7 +1,5 @@
# Formats
> Exporting to ply and obj is also supported.
| Name | Extension | Loading | Saving | Thumbnails | Palette |
| :-------------------- | --------- | ------- | ------ | ---------- | ------- |
| MagicaVoxel | vox | X | X | X | X |
@ -22,3 +20,15 @@
| Nick's Voxel Model | nvm | X | | X | |
| Minecraft Region | mcr | | | | |
| Sproxel | csv | X | X | X | |
## Meshes
Exporting to ply and obj is also supported. A few [cvars](Configuration.md) exists to tweak the output of the meshing:
* `voxformat_ambientocclusion`: Don't export extra quads for ambient occlusion voxels
* `voxformat_mergequads`: Merge similar quads to optimize the mesh
* `voxformat_reusevertices`: Reuse vertices or always create new ones
* `voxformat_scale`: Scale the vertices by the given factor
* `voxformat_quads`: Export to quads
* `voxformat_withcolor`: Export vertex colors
* `voxformat_withtexcoords`: Export texture coordinates

5
docs/voxconvert/Configuration.md Normal file
View File

@ -0,0 +1,5 @@
# Configuration
The [formats](../Formats.md) also have a list of mesh related cvars.
See `./vengi-voxconvert --help` or [configuration](../Configuration.md) for more details.

12
docs/voxconvert/Examples.md
View File

@ -63,18 +63,6 @@ You can export your volume model into a obj or ply.
`./vengi-voxconvert --input infile.vox --output outfile.obj`
Config vars to control the meshing:
* `voxformat_ambientocclusion`: Don't export extra quads for ambient occlusion voxels
* `voxformat_mergequads`: Merge similar quads to optimize the mesh
* `voxformat_reusevertices`: Reuse vertices or always create new ones
* `voxformat_scale`: Scale the vertices by the given factor
* `voxformat_quads`: Export to quads
* `voxformat_withcolor`: Export vertex colors
* `voxformat_withtexcoords`: Export texture coordinates
See `./vengi-voxconvert --help` or [configuration](../Configuration.md) for more details.
## Batch convert
To convert a complete directory of e.g. `*.vox` to `*.obj` files, you can use e.g. the bash like this:

7
docs/voxconvert/Index.md
View File

@ -2,11 +2,12 @@
Convert voxel volume formats between each other or export to obj or ply.
* [Supported voxel formats](../Formats.md)
* [Scripting support](../LUAScript.md)
# Further reading
* [Usage](Usage.md)
* [Configuration](Configuration.md)
* [Examples](Examples.md)
* [Screenshots](Screenshots.md)
* [Supported voxel formats](../Formats.md)
* [Scripting support](../LUAScript.md)
* [Palettes](../Palette.md)

6
docs/voxconvert/Usage.md
View File

@ -6,19 +6,19 @@
* `--filter <filter>`: will filter out layers not mentioned in the expression. E.g. `1-2,4` will handle layer 1, 2 and 4. It is the same as `1,2,4`. The first layer is `0`. See the layers note below.
* `--force`: overwrite existing files
* `--input <file>`: allows to specify input files. You can specify more than one file
* `--merge`: will merge a multi layer volume (like vox, qb or qbt) into a single volume of the target file
* `--merge`: will merge a multi layer volume (like `vox`, `qb` or `qbt`) into a single volume of the target file
* `--mirror <x|y|z>`: allows you to mirror the volumes at x, y and z axis
* `--output <file>`: allows you to specify the output filename
* `--pivot <x:y:z>`: change the pivots of the volume layers. Not all voxel formats support this.
* `--rotate <x|y|z>`: allows you to rotate the volumes by 90 degree at x, y and z axis
* `--scale`: perform lod conversion of the input volume (50% scale per call)
* `--script "<script> <args>"`: execute the given script - see [scripting support](../LUAScript.md) for more details
* `--src-palette`: will use the included palette and doesn't perform any quantization to the default palette
* `--src-palette`: will use the included [palette](../Palette.md) and doesn't perform any quantization to the default palette
* `--translate <x:y:z>`: translates the volumes by x (right), y (up), z (back)
Just type `vengi-voxconvert` to get a full list of commands and options.
Using a different target palette is also possible by setting the `palette` config var.
Using a different target palette is also possible by setting the `palette` [cvar](../Configuration.md).
`./vengi-voxconvert -set palette /path/to/palette.png --input infile outfile`

3
docs/voxedit/Index.md
View File

@ -10,3 +10,6 @@ You can load and save a lot of different [voxel formats](../Formats.md). Its bui
* [Configuration](Configuration.md)
* [Controls](Controls.md)
* [Screenshots](Screenshots.md)
* [Supported voxel formats](../Formats.md)
* [Scripting support](../LUAScript.md)
* [Palettes](../Palette.md)

1
mkdocs.yml
View File

@ -29,6 +29,7 @@ nav:
- VoxConvert:
- voxconvert/Index.md
- voxconvert/Usage.md
- voxconvert/Configuration.md
- voxconvert/Examples.md
- voxconvert/Screenshots.md
- VoxEdit: