Use »wszst patch --patch-bmg ...« to patch BMG files within a SZS file.
Options | |||
---|---|---|---|
Option | Param | Description | |
-d | --dest | path | Define a destination path (directory/file). The destination
The path may contain escape sequences:
A |
-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 |
-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 maximal existing index+1. |
||
-r | --remove-dest | Remove already existing files before creating it. If set, --overwrite is ignored. |
|
-u | --update | Create only files that do not exist. Already existing files are ignored without warning. 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 |
|
-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-color | 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. | ||
-l | --long | Print long numeric message IDs instead of alternative message names like Txx, Uxx or Mxx. | |
-X | --export | Enable the export modus and create small and machine readable text files for easy post processing. The option works similar like |
|
-i | --ignore | Ignore non existing source files without warning. | |
-P | --patch-bmg | mode[=param] | This option specifies a BMG patch mode. Some of the modes need 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
If this option is used multiple times, all patch files will be processed in the entered order. |
--msg | list | If this option is set, the BMG messages are filtered by this list. Only enabled messages are exported to the ouput 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, PARAM, CUPS, TRACKS, ARENAS, CHAT, CTCODE, CTTRACKS or |
|
--align | size | Define an align value for the sub sections in the archive. The value must be a power of 2 and the default value is 32 (0x20) |
The mode describes how to patch the source file by the current patch file. wbmgt supports 8 patching modes with source files, abbreviations are allowed:
Patching Modes with source files | ||||
---|---|---|---|---|
Mode | Copy ... if | |||
only insource |
only inpatch |
source !=patch |
source ==patch |
|
REPLACE | source | — | patch | both |
INSERT | source | patch | source | both |
OVERWRITE | source | patch | patch | both |
DELETE | source | — | — | — |
MASK | — | — | source | both |
EQUAL | — | — | — | both |
NOT-EQUAL | — | — | source | — |
source | — |
There are some more modes, that do not use any source file.
FORMAT=string acts like PRINT=file, but us the same format string for all printings. ID and ID-ALL insert the MID of each message to identifiy it while playing.
Modes RM-CUPS, CT-COPY, CT-FORCE-COPY and CT-FILL support CT-CODE.
The new string is created like a printf function call. Is a escape sequence is found, it is replaced by its (calculated content). The format of escape sequences is one of:
'%' CONV_LETTER '%' LEN CONV_LETTER '%' BEGIN ':' END CONV_LETTERAn escape sequence starts always with a percent sign and ends with a conversion letter (
The following conversion letters are supported:
Mode
Each defined and non empty message is prefixed by a letter representing the SZS filename (examples: T=Titel, E=Event, S=MenuSingle, ...) and the message id as hex number and a colon.
Example:
This mode helps to identify the messages while running the game.
Each defined message including empty messages is prefixed by a letter representing the SZS filename (examples: T=Titel, E=Event, S=MenuSingle, ...) and the message id as hex number and a colon.
Example:
All defined racing cup names in the MID range 23F0–23F7 are removed.
All defined track and arena name message are copied to the messages in the MID range 4000–4029, but only, if the destinaton message is not defined or empty.
All defined track and arena name message are copied to the messages in the MID range 4000–4029. Existing messages are overwritten.
All messages of MID range 4000–40ff, that are not defined or empty,
will be defined and set to the message
The definitions will only be done, if at least one track or arena name message is alrrady defined.
Patching Modes with source files | ||
---|---|---|
Name | MID Range | Description |
NONE | all | Clar the filter at deny all messages. |
ALL | all | Allow all messages. |
PARAM | 3FF0 – 3FFF | A range used for messages to other tools like mkw-ana. |
CUPS | 23F0 – 23F7 2489 – 248A 4200 – 423F 4300 – 43FF |
Names of racing and battle cups. The last 2 ranges are only used, if CT-CODE is active. |
TRACKS | xxxx – xxxx | |
ARENAS | xxxx – xxxx | |
CHAT | xxxx – xxxx | |
CTCODE | xxxx – xxxx | |
CTTRACKS | xxxx – xxxx |