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

wctct 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.

Contents

1.   Syntax

wctct BMG [source]...

2.   Options

Options
Option Param Description
-B --brief Filter the message by tracks, that are used a racing track. If set twice, suppress also tracks created by the 'N' command of CT-TEXT files. If set 3 times, suppress always the output of first 32 tracks.
-l --long Normally, only the track and arena names are exported. The message id (MID) range is 4000-40FF. If set, cup names are exported too as MID 4200-423F. If set twice, cup/track relations are also exported as MID 4300-43FF.
-i --ignore Ignore non existing source files without warning.
--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.

--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.

--full Cancel all previous --list and --rel and enter FULL mode for text output.

FULL mode is a combination of LIST and REF modes.

--hex Normally and if available, names are printed for music and property slots. If this option is set, hex numbers are printed always.
-H --no-header Suppress the syntax information section in CTC text files.
-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.
--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.
--force-attrib attrib Forces, that all attributes are set to this vector.
--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].
--no-attrib Suppress the output of any BMG attributes at text BMG files.
--x-escapes Use \x{} escapes instead of \z{} escapes.
--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.
-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.
--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.
--bmg-colors Force output of '\c{color}' escape sequences with names, even for foreign (not MKWii) BMG files.
--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.
--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.
--write-tracks file 'IDX>MID|NAME' is written for each track. --wtracks is a short cut.
--no-echo Suppress output of @ECHO commands while scanning text files.
-N --no-check Do not make plausibility checks for KCL and KMP files.
--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.

--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.
--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.
--order-all Used together with option --order-by: Re-distribute the tracks of all cups beginning with Mushroom Cup.