vengi/contrib/installer/linux/voxconvert.man.in

50 lines
1.6 KiB
Groff
Raw Normal View History

.\" This man page was written by Martin Gerhardy in May 2020. It is provided
.\" under the GNU General Public License 3 or (at your option) any later version.
.TH @COMMANDLINE@ 14 "May 2020" "@COMMANDLINE@" "games"
.SH NAME
2020-10-03 04:10:42 -07:00
@COMMANDLINE@ \- convert voxel volume formats or export as mesh
.SH SYNOPSIS
.PP
\fB@NAME@\fR [\fIoption\fR] --input infile --output outfile
.SH DESCRIPTION
\fB@COMMANDLINE@\fP is a command line application that can convert several voxel
volume formats into others. Supported formats are e.g. cub (CubeWorld), qb/qbt
2020-05-24 12:35:02 -07:00
(Qubicle), vox (MagicaVoxel), vmx (VoxEdit Sandbox), kvx (Build engine), kv6 (SLAB6),
2020-10-03 04:10:42 -07:00
binvox and others. It can also export to mesh formats like obj and ply with a number
of options.
.SH OPTIONS
.TP
2020-10-03 04:10:42 -07:00
\fB\--trace|--debug|--info\fR
Enable trace, debug or info logging
2020-05-24 09:22:01 -07:00
.TP
\fB\--merge|-m\fR
Merge all layers into one. Some destination formats only support one layer - for
2020-10-03 04:10:42 -07:00
those formats this is an explicit parameter. If you are going to export to a mesh
format like wavefront obj, this option changes the behaviour of the exporter, too.
2020-05-24 09:22:01 -07:00
.TP
\fB\--scale|-s\fR
Save the target volume with a down-sampled version of the input volume.
2020-10-03 04:10:42 -07:00
.TP
\fB\-set <varname> <value>\fR
Change the value of a config variable. \fB-set palette /path/to/palette.png\fR is
going to use a different palette for importing and exporting the voxels. It should
have the dimensions 1x256.
.TP
\fB\--version|-v\fR
Print the version of the application.
.TP
\fB\--help\fR
2020-10-03 04:10:42 -07:00
Print usage information with a a full list of cvars
.SH HOMEPAGE
https://github.com/mgerhardy/engine
.SH COPYRIGHT
Copyright \[co] 2015\-2022 by Martin Gerhardy.