DOCS: moved voxconvert docs into docs/ folder

master
Martin Gerhardy 2020-06-29 20:43:01 +02:00
parent 35d9e604c6
commit 49aaf1d2bc
5 changed files with 27 additions and 24 deletions

7
docs/voxconvert/Index.md Normal file
View File

@ -0,0 +1,7 @@
# General
Convert voxel volume formats between each other.
Support for loading: vox, qbt, qb, vxm, binvox, cub, kvx, kv6, vxl
Support for writing: vox, qbt, qb, binvox, cub, vxl

15
docs/voxconvert/Usage.md Normal file
View File

@ -0,0 +1,15 @@
# Usage
`./vengi-voxconvert --merge --scale infile outfile`
* `--merge`: will merge a multi layer volume (like vox, qb or qbt) into a single volume of the target file
* `--scale`: perform lod conversion of the input volume (50% scale per call)
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.
`./vengi-voxconvert -set palette /path/to/palette.png infile outfile`
The palette file has to be in the dimensions 1x256. It is also possible to just provide the basename of the palette.
This is e.g. `nippon`. The tool will then try to look up the file `palette-nippon.png` in the file search paths.

View File

@ -25,5 +25,8 @@ nav:
- voxedit/Features.md
- voxedit/Controls.md
- voxedit/Palette.md
- VoxConvert:
- voxconvert/Index.md
- voxconvert/Usage.md
- Game Design:
- GameDesign.md

View File

@ -1,25 +1,3 @@
# Vox-Convert
## Purpose
Convert voxel volume formats between each other.
Support for loading: vox, qbt, qb, vxm, binvox, cub, kvx, kv6
Support for writing: vox, qbt, qb, binvox, cub
## Usage
`./vengi-voxconvert --merge --scale infile outfile`
* `--merge`: will merge a multi layer volume (like vox, qb or qbt) into a single volume of the target file
* `--scale`: perform lod conversion of the input volume (50% scale per call)
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.
`./vengi-voxconvert -set palette /path/to/palette.png infile outfile`
The palette file has to be in the dimensions 1x256. It is also possible to just provide the basename of the palette.
This is e.g. `nippon`. The tool will then try to look up the file `palette-nippon.png` in the file search paths.
[more details](../../../docs/voxconvert/)

View File

@ -13,7 +13,7 @@ my own engine and evolved into something that others might find useful, too.
![image](https://raw.githubusercontent.com/wiki/mgerhardy/engine/images/voxedit-quad-view.png)
[more details](../../../docs/voxedit)
[more details](../../../docs/voxedit/)
## Planned