prevnext   » SZS: Wiimms SZS Toolset » wctct: Wiimms CT-CODE Tool

wctct: Wiimms CT-CODE Tool

Wiimms CT-CODE Tool : Manage the CT-CODE extension. BRRES, TEX0, CT-CODE and CT-TEXT files are accepted as input.

Contents

1.   Syntax

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

2.   Features of wctct

Read »Features« for features of the whole toolset.

3.   Commands

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 completly ignored.
COLORS Ignore all parameters and print clored 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').
SYMBOLS Print predefined symbols of text parser to standard output. The CTCODE specific symbols are included.
FUNCTIONS Print a list with all parser functions including the CTCODE 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.
FLOAT This commands helps to convert hex value into floating point numbers. 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. All conversions are done using big endian.
D DUMP Print an information dump for the CT-CODE of each source file. BRRES, TEX0, CT-CODE and CT-TEXT files are accepted as input.
CAT Read the source files and print the CT-CODE part them as decoded text files to standard output. The output of all source files is concatenated. BRRES, TEX0, CT-CODE and CT-TEXT files are accepted as input.
BMG Read the source files and print a BMG message listing to standard output. BRRES, TEX0, CT-CODE and CT-TEXT files are accepted as input.
TRACKS Read the source files and print a track listing to standard output. BRRES, TEX0, CT-CODE and CT-TEXT files are accepted as input.
DECODE DEC Read the source files and decode them to CT-TEXT files. The default destination is '%P/%N.txt'. BRRES, TEX0, CT-CODE and CT-TEXT files are accepted as input.
CREATE C Read the source files, scan the CT-CODE part and create an output file contolled by the keyword. BRRES, TEX0, CT-CODE and CT-TEXT files are accepted as input. Possible keywords are: CUP1, CRS1, r-MOD1, r-MOD2, r-OVR1, r-BAD1CODE, r-BAD1DATA (=r-CODE), r-TEX0, r-BRRES, r-SZS, BMG, TRACKS, LIST, REF and FULL. 'r' defines the region and is one of EU, RMCP, US, RMCE, JP, RMCJ, KO or RMCK.

The Korean support needs external CT-CODE files. Use option --ct-dir to define at least one search path.

PATCH P Read each source file, find and scan the CT-CODE part and patch it. BRRES, TEX0, CT-CODE and CT-TEXT files are accepted as input.

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.

--allow-slots list Allow and disallow slots for automatic slot assigning. A comma separated list of slots (A), slot ranges (A:B) or keywords is expected. If preceded by a minus sign, the slots are disabled. The keywords are: TRACKS (slots 0:0x1f), ARENAS (0x20:0x29) and SPECIAL (0x36:0x3a).
--bmg-colors Force output of '\c{color}' escape sequences with names, even for foreign (not MKWii) BMG files.
--bmg-inf-size size Defines the 'INF0' size of new BMG files between 4 and 1000. The first 4 bytes of a INF0 record is a pointer to the string and the remaining bytes the string attributes. However, maximal 20 attribute bytes are supported and additional bytes are assumed to be NULL. All BMG files of MKW have a size of 8.
--bmg-inline [DEPRECATED] Print BMG values between message name and the equal sign using the format '[...]'. The output for the standard value (usually 0x01000000) is always suppressed. Since v1.44, the inline mode is the default. It can be disabled by option --no-bmg-inline to be compatible with versions until v1.39.
-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.
--color Force colorized text. This is the default, if an output file is a terminal. But colorized text is only supported for a few messages.

If a command is prefixed by 'C-', then this option is set automatically.

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

--crs1 value Store this value into all 8 members of the property array of the CRS1 header if reading a CT-TEXT. The default value is 0x800.
--ct-code Enable the CT-CODE modus.
--ct-dir dir Define a search directory for CT-CODE parts and use the internal copies only, if no valid file is found. Each file is searched without and then with extension '.bz2'. For both cases bzip2 files are detected and decompressed. Only files with correct file type are accepted.

wctct will search in the sub directory 'rmc[pujk]/' for files 'mod1.bin', 'mod2.bin', 'ovr1.bin' and 'bad1code.bin'.

Use this option multiple times to define more than one search directory.

--de Use german track and arena names.
--def-attrib attrib Define the default attributes for BMG files. If not set, the default attributes are estimated. On text output, strings with default attributes are printed without attribute vector. The usual default attribute for MKW is [1].
-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$'.
-X --export Enable the export modus and create small and machine readable text files for easy post processing. The option works similar like -HB for CT-CODE output.
--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! <<<

--force-attrib attrib Forces, that all attributes are set to this vector.
--full Cancel all previous --list and --rel and enter FULL mode for text output.

FULL mode is a combination of LIST and REF modes.

-h --help Stop parsing the command line, print a help message and exit.
--hex Normally and if available, names are printed for music and property slots. If this option is set, hex numbers are printed always.
-i --ignore Ignore non existing source files without warning.
--images dir If creating a CT-CODE BRRES or SZS file, then search the 8 strap images in the specified directory. The images are searched with extensions .png, .tex, .tex0 and without extension in this order until a valid image is found. All images will be resized to the correct width and height and converted to format TEX.RGB565 without mipmaps. If no valid image is found, a hard coded default image is used.
--list Cancel all previous --rel and --full and enter LIST mode (default) for text output.

In LIST mode only a track list is generated. On scanning the tracks are automatically distributed to the cups. This makes rearanging very simple.

--load-bmg file Load immediately the file to fill an internal message pool. The option can be used multiple times to fill the message pool by different sources. A later message overrides the previous message.

The internal message pool is patched by all --patch-bmg options.

-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.
--no-attrib Suppress the output of any BMG attributes at text BMG files.
--no-bmg-colors If set, suppress the output of '\c{color}' escape sequences for colors definitions in BMG text output to be compatible with old versions of the tools.
--no-bmg-inline Print BMG values as separate line before the message definition to be compatible with versions until v1.39. The output for the standard value 0x01000000 is always suppressed. This was the default until v1.43. Since v1.44, --bmg-inline is the default.
-N --no-check Do not make plausibility checks for KCL and KMP files.
--no-color 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.
-P --no-param Disable parameter support in decoded KMP text files.
--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.
--old-escapes To be compatible with v1.43 and earlier, print 1A escape sequences with total size of >12 bytes as single words using \x{}. Also don't use \x{} and \u{} with parameter lists.
--old-spiny Disable the new feature to hold a Spiny Shell at the tail.
--order-all Used together with option --order-by: Re-distribute the tracks of all cups beginning with Mushroom Cup.
--order-by bmg Load the BMG file and filter track names. Then before creating output files, re-distribute the tracks of the additonal cups (9-) to the same cups by the order of the read track names. Tracks without BMG reference are placed at the end of all tracks. This option modifes only the track order of the cups, but will not change any name.
-o --overwrite Overwrite already existing files without warning and ignore option --number.
--patch-bmg mode[=param] This option specifies a BMG patch mode. Some of the modes need a parameter or a file name of a BMG patch file (raw or text BMG), both separated by an equal sign. Modes with required file names are PRINT, REPLACE, INSERT, OVERWRITE, DELETE, MASK, EQUAL and NOTEQUAL. A mode with text parameter is FORMAT. Standalone modes are ID, ID-ALL, UNICODE, RM-ESCAPES, RM-CUPS, CT-COPY, CT-FORCE-COPY and CT-FILL. Unique abbreviations are allowed.

If this option is used multiple times, all patch files will be processed in the entered order.

--patch-names If set, the names of the CUP1 and CSR1 sections are patched by the loaded BMG files directly after loading the source files.
-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.
--raw Print BMG messages as UTF-8 text without escape sequences.
--ref Cancel all previous --list and --full and enter REFERENCE mode for text output.

In REFERENCE mode all tracks and cups are printed separatly. After scanning the cup and track layout is the same as the original code file.

-r --remove-dest Remove already existing files before creating it. If set, --overwrite is ignored. --rm-dest is a short cut.
--sections Print in machine readable sections and parameter lines.
-1 --single-line If set, don't print continuation lines for BMG text output. If set twice, print only single text lines but not value lines.
-t --test Run in test mode, modify nothing.

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

-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.
--write-tracks file 'IDX>MID|NAME' is written for each track. --wtracks is a short cut.
--x-escapes Use \x{} escapes instead of \z{} escapes.
--xhelp Stop parsing the command line and print a help message with all commands included. Exit after printing.