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

wctct decode

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.

Contents

1.   Syntax

wctct DECODE [source]...

2.   Options

Options
Option Param Description
--write-tracks file 'IDX>MID|NAME' is written for each track. --wtracks is a short cut.
-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 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.
-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.
-B --brief Suppress cross reference comments.
-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.
--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.