|VERSION||Print program name and version and exit.|
|HELP||H||Print help for commands and options.|
|ARGTEST||This debug command accepts all kinds of parameters and prints one line for each parameter.|
|TEST||This debugging command accepts all options and parameters and prints a list of the internal option values. The command is designed to test the option parameters. The non option parameters are completely ignored.|
|COLORS||Ignore all parameters and print colored text for testing.|
|ERROR||ERR||Translate an exit code to a message name. If no exit code is entered, print a table with all error messages.|
|FILETYPE||FT||Scan the header of the entered files and print file type and path for each file as list.|
|FILEATTRIB||FA||Print a table with attributes for all known file types. If at least one keyword is entered, only matching file types are printed. A keyword is either a file type (like 'BRRES' or 'BMG') or one of the printed keywords (like 'ARCHIVE' or 'EXTRACT').|
|LIST||LS||List images files and print file and image type.|
|LIST-L||LL||List images files and print file and image type and geometry data. 'LIST-L' is a short cut for »LIST --long«.|
|LIST-LL||LLL||List images files and print file and image type and advanced geometry data. 'LIST-LL' is a short cut for »LIST --long --long«.|
|DECODE||DEC||Decode (export) the entered image files into PNG files. The default destination is
|ENCODE||ENC||Encode (import) the entered PNG files and convert them to to an internal image format (TPL, TEX, BREFT). The default destination is
|CONVERT||CV||Convert the entered image files into new file and image formats. The old file is replaced by the new one. The difference to ENCODE is only the default file name handling.|
|COPY||CP||Copy and convert an image from 'source' to 'dest'. Multiple sources can be used, if 'dest' is a directory or contains at least one %-pattern.
This is an alternative for the ENCODE and DECODE commands. The default destination file format is selected by scanning the file extension of the destination. Option --transform may override this.
|-a||--all||Convert all files and not only the files with changed file or image formats.|
|--allow-all||Usually commands accept only options with impact to the command. All other options fire a syntax error. But if
This makes changing the command of a long command line without removing useless options easier. It also helps to override wrong option permissions.
|-B||--brief||Create smaller output.|
|--chdir||dir||Set a new working directory for all following options, for all parameters and for the command execution. This option can be used multiple times, but for parameter parsing and for command execution only the last usage is relevant. Nevertheless,
|--colors||[=modus]||Define the modus for colored text output. Allowed keywords are:
If a command is prefixed by
|--compatible||vers||The option expects a version number (format '#.##' or 'v#.##') or a revision number (format 'r#') as parameter. If set, the tools try to create BMG and KMP text files, that are compatible to the entered version of the tools. This may override other legacy options.|
|-c||--const||list||Define constant values, that are used by the internal encoders and by the numeric options as predefined global variables. This option allows a conditional encoding of text files. It can be used multiple times for multiple definitions.
The Parameter is a comma separated list of terms and a term is '
|--ct-code||Enable the CT-CODE mode.|
|--de||Use german track and arena names.|
|-d||--dest||path||Define a destination path (directory/file). The destination
The path may contain escape sequences:
|-D||--DEST||path||Like --dest, but create the directory path automatically.|
|-E||--esc||char||Define an alternative escape character for destination files. The default is '%'. For Windows batch files it is a good choice to set
|--force||The tools analyse input files and reject files with invalid data structures. If --force is set, little repairable issues are ignored and a warning is printed.
Option »--kmp force« does the same, but only for KMP files.
>>> THE RESULT MAY BE INVALID OUTPUT FILES! <<<
|-h||--help||Stop parsing the command line, print a help message and exit.|
|-i||--ignore||Ignore non existing source files without warning.|
|-l||--long||Print long numeric message IDs instead of alternative message names like Txx, Uxx or Mxx.|
|-M||--max-file-size||size||This security option defines the maximum file size for input files; larger files are ignored with a warning. The default unit is MiB and the default size is 100 MiB; that should be enough for standard usage.|
|--mipmap-size||num||Define the minimal width and minimal height of a generated mipmap. The default is 16. Tools before v1.49 used 1 as not alterable value.
|--mipmaps||If reading a source, scan for mipmaps and load them too. For PNG files, files named
|--n-mipmaps||num||Force the number of mipmaps. Values between 0 and 20 are allowed. Value
|--no-colors||Deactive colorized text. This is the default, if an output file is not a terminal.|
|-H||--no-header||Suppress the syntax information section in BMG text files.|
|--no-mipmaps||If reading a source, ignore mipmaps. This disables not the creation of mipmaps (see -n-mipmaps).
|--number||If a file already exist, append a number directly before the file extension to make the filename unique. If other numbered files already exist (ignoring case), use the maximum existing index+1.
|-o||--overwrite||Overwrite already existing files without warning and ignore option --number.|
|-P||--patch||mode1.mode2...=file||This option specifies patch mode list and a file, separated by an equal sign. Mode is a point separated list of the keywords:
Abbreviations are allowed. The default is
|--pre-convert||Convert the image before the image format for the destination file is selected. This results in a perhaps worser graphic and is only useful to control graphic conversions.|
|-p||--preserve||Preserve file times (atime+mtime) while converting or copying files.|
|-q||--quiet||Be quiet and print only error messages. Multiple usage is possible. The impact is command dependent.|
|-r||--remove-dest||Remove already existing files before creating it. If set, --overwrite is ignored.
|--sections||Print in machine readable sections and parameter lines.|
|--smart||If resizing an image, use the new smart resize function. The new function is much slower (factor 2-4) than the old function, but creates much better resized images. This is only relevant for creating mipmaps with odd width or height.|
|-t||--test||Run in test mode, modify nothing.
>>> USE THIS OPTION IF UNSURE! <<<
|-x||--transform||list||Convert image formats when reading. A comma separated list with terms is expected. A term have the syntax
Allowed file formats are:
All terms are managed as list. For each graphic the list is iterated until the first SRC tuple of a term matches the graphic. Then the destination tuple is used for the transformation.
|-u||--update||Create only files that do not exist. Already existing files are ignored without warning. If set, --overwrite and --remove-dest are ignored.|
|-v||--verbose||Be verbose and print more progress information. Multiple usage is possible. The impact is command dependent.|
|-V||--version||Stop parsing the command line, print a version info and exit.|
|--width||width||Define the width (number of columns) for help and some other messages and disable the automatic detection of the terminal width.|
|--xhelp||Stop parsing the command line and print a help message with all commands included. Exit after printing.|