prev

next

» SZS: Wiimms SZS Toolset » wbmgt: Wiimms BMG Tool » wbmgt decode

Wiimms SZS Tools

Privacy Statement

Tools

wbmgt commands

decode, dec

wbmgt decode

Read the entered message files and decode them to text files. All BMG files of a single archive (SZS,...) are concatenated to 1 source. This command is similar to PATCH, but the result is always decoded. The default destination is '%P/%N.txt'. Wildcards and pipe characters are parsed.

Contents

1. Syntax
2. Options

1. Syntax

wbmgt DECODE [szs]...

2. Options

Options
Option		Param	Description
	`--no-wildcards`		Disable wildcard parsing and use each filename exactly as specified.
	`--in-order`		Process the input files in order of the command line and don't delete duplicates.
`-i`	`--ignore`		Ignore non existing source files without warning.
`-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$'.
`-o`	`--overwrite`		Overwrite already existing files without warning and ignore option `--number`.
	`--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.
`-r`	`--remove-dest`		Remove already existing files before creating it. If set, `--overwrite` is ignored. --rm-dest is a short cut.
`-u`	`--update`		Update only existing files and don't create new files. If set, `--overwrite` and `--remove-dest` are ignored.
`-p`	`--preserve`		Preserve file times (atime+mtime) while converting or copying files.
`-H`	`--no-header`		Suppress the syntax information section in BMG text files.
`-B`	`--brief`		If set, the information header in decoded text files is suppressed (for historical reasons same as `--no-header`). If set at least twice, all comments are suppressed and the output is packed without empty lines. If set 3 times, the #BMG file indentification is also suppressed.
	`--endian`	name	Force an endian for new BMG files. Accepted values are BIG or BE for big endian, LITTLE or LE for little endian and AUTO for automatic detection (default). Mario Kart Wii uses big endian; the default if no other endian is defined.
	`--encoding`	name	Force an encoding for new BMG files. Accepted encoding names are CP-1252, UTF-16BE (or UTF-16), SHIFT-JIS, UTF-8 and AUTO for automatic detection (default). Same keywords without minus signs are accepted too. Mario Kart Wii uses encoding UTF-16BE; the default if no other encoding is defined.
	`--inf-size`	size	Defines the 'INF1' size of new BMG files between 4 and 1000. The first 4 bytes of a INF1 record is an offset into the string pool and the remaining bytes the attributes. Maximal 40 attribute bytes are supported and additional bytes are assumed to be NULL. All BMG files of MKW have a size of 8.
	`--bmg-mid`	[mode]	Control the creation of BMG section MID1. Suppress the creation, if mode is OFF. Force the creation, if mode is ON. On mode AUTO (default), the source is analysed for the decision.
	`--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 if creating BMG text 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 and suppress attributes like option `--no-attrib` does it.
	`--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 attributes 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.
`-l`	`--long`		Print long numeric message IDs instead of alternative message names like Txx, Uxx or Mxx.
`-X`	`--export`		Enable the export mode and create small and machine readable text files for easy post processing. The option works similar like -HBl11 for BMG text files.
`-P`	`--patch-bmg`	mode[cond][=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. Modes with text parameter are FORMAT, REGEXP and RM-REGEXP. Standalone modes are ID, ID-ALL, UNICODE, RM-ESCAPES, RM-CUPS, CT-COPY, CT-FORCE-COPY, CT-FILL, LE-COPY, LE-FORCE-COPY, LE-FILL, X-COPY, X-FORCE-COPY and X-FILL. Unique abbreviations are allowed. The optional condition COND is either '?MID' or '!MID'. In case of '?MID', the patch is only applied if the message id MID already exists. In case of '!MID', the patch is only applied if the message id MID does not exists. If this option is used multiple times, all patch files will be processed in the entered order. --patch is a short cut.
	`--macro-bmg`	file	Load a BMG file and add the messages to the macro library; already existing entries are replaced. The macro library is accessed by escape sequence \m{MID} as fallback, if the active file has not already defined the message MID by itself.
	`--filter-bmg`	list	If this option is set, the BMG messages are filtered by this list. Only enabled messages are exported to the output BMG file (binary or text). The parameter is a list of message ids (short MID, 'Txx' or 'Uxx' or Mxx' or hex number) or message ranges (MID:MID) or one of the keywords NONE, IDENT (=ID), PARAM, CUPS, TRACKS, ARENAS, CHAT, CTCODE (=CT), CTUPS, CTTRACKS, CTARENAS, CTREFS, LECODE (=LE), LEUPS, LETRACKS, LEARENAS, LEREFS, XCODE (=X), XUPS, XTRACKS, XARENAS, XREFS, ALLCODE, ALLUPS, ALLTRACKS, ALLARENAS, ALLREFS, GENERIC or ALL. If an element is preceded by a minus sign, it is removed from the filter list (disabled). With v2.01a, this option was renamed from --msg to the more meaningful name --filter-bmg. The old name is still available.