prevnext   » SZS: Wiimms SZS Toolset » wpatt: Wiimms PAT Tool

wpatt: Wiimms PAT Tool

Wiimms PAT Tool : Decode raw PAT and encode text PAT files.

Contents

1.   Syntax

wpatt [option]... command [option|parameter|@file]...

2.   Features of wpatt

Read »Features« for features of the whole toolset.

3.   Commands

VERSION V Print program name and version and exit.
HELP H Print help for commands and options.
CONFIG Show all information about the search for the configuration file and its content.
ARGTEST This debug command accepts all kinds of parameters and prints one line for each parameter. All tools know the ARGTEST command.
EXPAND This debug command accepts (like ARGTEST) all kinds of parameters and prints one line for each parameter. After that, the parameter is treated as a filename with wildcards and all matching files are searched. All tools know the EXPAND command.
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. All tools know the ERROR command.
FILETYPE FT Scan the header of the entered files and print file type and path for each file as list. Wildcards and pipe characters are parsed. All tools know the FILETYPE command.
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'). All tools know the FILEATTRIB command.
SYMBOLS Print predefined symbols of text parser to standard output. The PAT specific symbols are included.
FUNCTIONS Print a list with all parser functions including the PAT specific functions. If one key ore more key entered, then only functions that match at least one key are printed.
CALCULATE Calculate each expression and print the result to standard output. Many tools know the CALCULATE command.
FLOAT This commands helps to convert hex values into floating point numbers and vice versa. For each non empty parameter, a line with 4 bytes hex and a float, 8 bytes hex and a double float, and the parameter itself is printed. If a parameter begins with 'x' or '0x', it is a hex string, otherwise it is a floating point number.

The special parameters "+" and "-" mean: Increment or decrement the previous value by the smallest possible value. Use different increments for floats and doubles.

All conversions are done using big endian.

CAT Read the entered PAT files (text or binary) and print them as decoded text files to standard output (stdout). Wildcards and pipe characters are parsed. The output of all source files is concatenated.
DECODE DEC Read the entered PAT files (text or binary) and decode them to text files. Wildcards and pipe characters are parsed. The default destination is '%P/%N.txt'.
ENCODE ENC Read the entered PAT files (text or binary) and encode (compile) them to binary files. Wildcards and pipe characters are parsed. The default destination is '%P/%N.pat'.

4.   Options in alphabetic order

Options
Option Param Description
--allow-all Usually commands accept only options with impact to the command. All other options fire a syntax error. But if --allow-all is set, all commands accept all options.

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 Suppress cross reference comments.
--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, '@param' values are scanned while reading the command line.
--colors [=modus] Define the modus for colored text output. Allowed keywords are: OFF or NO-COLORS to disable colors, AUTO (default) for automatic detection, ON for automatic detection but never OFF, 8-COLORS and 256-COLORS to force 8 or 256 color support. Without parameter, ON is used.

AUTO will enable colorized output only for terminals. AUTO and ON use environment variable TERM to find the correct color modus.

If a command is prefixed by 'C-', then --color=ON is used implicitly as default.

--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.
--config file Define a configuration file or a directory as source. In later case, file 'wiimms-szs-tools.conf' is searched.

If option is not not set, then file 'wiimms-szs-tools.conf' is searched in different directories. Use command 'wszst CONFIG' to get more details.

-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 'name=expression'. The expression is calculated by the text parser.

--ct-code Enable CT-CODE support.
--de Use german track and arena names.
-d --dest path Define a destination path (directory/file). The destination - means: write to standard output.

The path may contain escape sequences: %Q is replaced by the fully qualified source name. %P and %F are replaced by the source path or by the filename. %N and %E are replaced by source filename without extension or by the source extension. Finally, %T is replaced by the default extension of the destination format.

A '?' direct behind '%' in %E and %T conversions avoid that the same extension is used twice in row.

-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 '-E$'.
-Y --extended-errors Enable extended error messages. This includes a source file and line reference. Logging level 1 activates it too. --xerr is a short cut.
--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.
--in-order Process the input files in order of the command line and don't delete duplicates.
--le-04x Use format %04x instead of %03x for LE-CODE slots to enable uniform slot numbers if slots >4095 are used.
--le-code [=param] This option is completely ignored by wlect. It only exists due to compatibility with the other tools.
-L --logging This debug option enables the logging of internal lists and maps. Set it up to three times to be more verbose.
-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 (2 GiB for LTA); that should be enough for standard usage.
--max-width maxwidth Define the maximum terminal width (number of columns) for help and some other messages. The default is 120. This option is ignored if --width is set.
-N --no-check Do not make plausibility checks for KMP files.
--no-colors Deactive colorized text. This is the default, if an output file is not a terminal.
--no-echo Suppress output of @ECHO commands while scanning text files.
-H --no-header Suppress the syntax information section in BMG text files.
--no-pager Forbid the internal usage of a pager.
-P --no-param Disable parameter support in decoded KMP text files.
--no-wildcards Disable wildcard parsing and use each filename exactly as specified.
--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. --num is a short cut.
-o --overwrite Overwrite already existing files without warning and ignore option --number.
--pat list Set global options for PAT processing. Parameter 'list' is a comma separated list of keywords. A minus sign before a keyword disables a setting. Each occurrence of the option will only change entered settings and all other settings are untouched.

Keyword DEFAULT resets the default settings and CLEAR disables all. The other allowed keywords are: AUTO, SIMPLE, COMPLEX, BOTH, SILENT and LOG.

-p --preserve Preserve file times (atime+mtime) while converting or copying files.
-q --quiet Be quiet and print only error messages. Multiple use is possible. Previous use of --verbose is reverted. The impact is command dependent. If set at least three times, almost all error messages will be suppressed.
-r --remove-dest Remove already existing files before creating it. If set, --overwrite is ignored. --rm-dest is a short cut.
--repair-magics [=mode] Control the reparing of missing or wrong magics of files and sub-files by analysing file path and file extension. MODE is one of OFF (default), ANALYZE or REPAIR (default, if set without mode). OFF disables this feature, ANALYZE enables it for analysis only, and REPAIR repairs all magics while reading the files. Keyword FNAME can be appended (separated by a comma) to give filename scanning the highest priority.

>>> THE RESULT MAY BE INVALID OUTPUT FILES! <<<

--round Print additional lines with rounded values (to 3 and 2 bytes for floats and 7 and 6 bytes for doubles).
--sections Print in machine readable sections and parameter lines.
-t --test Run in test mode, modify nothing.

>>> USE THIS OPTION IF UNSURE! <<<

--timing Activate the timing of some operations. Logging level 3 activates them too.
-u --update Update only existing files and don't create new files. If set, --overwrite and --remove-dest are ignored.
-v --verbose Be verbose and print more progress information. Multiple use is possible. Previous use of --quiet is reverted. The impact is command dependent.
-V --version Stop parsing the command line, print a version info and exit.
-W --warn list Enable or disable warnings. Parameter 'list' is a comma separated list of keywords. A minus sign before a keyword disables a warning. Each occurrence of the option will only change entered warning and all other warnings are untouched.

Keyword DEFAULT resets the default settings, OFF disables and ALL enables all. The other allowed keywords are: INVALID-OFFSET.

--width width Define the terminal 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.
-z --zero This option affects the exit status of the programs. Instead of an exit status, the value 0 is returned for OK. This happens for notices (-v, status<15), warnings (-vv, status<29), errors (-vvv, status<115) and fatal errors (-vvvv). The exit status for INTERRUPT (112) is never replaced.

5.   Options

5.1   --pat list

Set global options for PAT processing. Parameter 'list' is a comma separated list of keywords. A minus sign before a keyword disables a setting. Each occurrence of the option will only change entered settings and all other settings are untouched. Keyword DEFAULT resets the default settings and CLEAR disables all. The other allowed keywords are: AUTO, SIMPLE, COMPLEX, BOTH, SILENT and LOG.
The option --pat expects a comma separated list of keywords to define global settings for the PAT processing. If a keyword is preceded by a minus sign, it is disabled. Each occurrence of the option will only change the current settings. To reset all settings, use either CLEAR or DEFAULT.

The following table shows all keyword:

Keywords for option --pat
Keyword Description
CLEAR This keyword clears (disables) all other keywords. This includes AUTO.
DEFAULT This keyword resets all keywords to their default status. At the moment, it is the same as CLEAR.
SIMPLE If creating a PAT text file, force the creation of a PAT text file in SIMPLE mode. Some informations maybe lost, if the PAT data is complex. Most PAT files can be displayed in SIMPLE mode without data loss.
COMPLEX If creating a PAT text file, force the creation of a PAT text file in COMPLEX mode. The COMPLEX mode allows more modifications and complex links.
BOTH If creating a PAT text file, create SIMPLE and COMPLEX sections. There is also a switch to select one of both modes on scanning. Try this option if you want to comapre both modes.
AUTO Disable SIMPLE, COMPLEX and BOTH and let the tool decide about SIMPLE or COMPLEX. SIMPLE is only used, if no data is lost. This is the best choice and also the default.
SILENT If set, the default logging of all PAT patching actions is suppressed. If LOG is set, SILENT is ignored.
LOG This is a debugging mode. If set, the tools create a trace log about the main PAT reading, modifying (patching) and writing steps.