diff --git a/docs/voxconvert/Index.md b/docs/voxconvert/Index.md new file mode 100644 index 000000000..63e3e8623 --- /dev/null +++ b/docs/voxconvert/Index.md @@ -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 diff --git a/docs/voxconvert/Usage.md b/docs/voxconvert/Usage.md new file mode 100644 index 000000000..598477aec --- /dev/null +++ b/docs/voxconvert/Usage.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml index 0645641df..7ef8553fc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 diff --git a/src/tools/voxconvert/README.md b/src/tools/voxconvert/README.md index 70a9ddcfc..5351ff60f 100644 --- a/src/tools/voxconvert/README.md +++ b/src/tools/voxconvert/README.md @@ -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/) diff --git a/src/tools/voxedit/README.md b/src/tools/voxedit/README.md index 114a60b68..13c000f50 100644 --- a/src/tools/voxedit/README.md +++ b/src/tools/voxedit/README.md @@ -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