prevnext   » SZS: Wiimms SZS Toolset » wlect: Wiimms LE-CODE Tool » wlect create
Wiimms SZS Tools
Introduction
Features
Change Log
Guides
Download
Privacy Statement
Index
Tools
wszst
wbmgt
wctct
wimgt
wkclt
wkmpt
wlect
wmdlt
wpatt
wstrt
wlect commands
argtest
bin-diff, bindiff
calculate
cat
colors
config
create, cr
decode, dec
distribution, dis
dl
dll
dump, d
encode, enc
error, err
expand
fileattrib, fa
filetype, ft
float
functions
help, h
lpar
patch, p
symbols
test
version

wlect create

Create a file and print it to standard output. Options --dest and --DEST can forc another destination. The kind of file is defined by KEYWORD. The command can create LEX files, a LPAR file or a track listing.

Use the command without keyword to get an extended description.

Contents

1.   Syntax

wlect CREATE [keyword] ...

2.   Options

Options
Option Param Description
-i --ignore Ignore non existing source files without warning.
-H --no-header Suppress the syntax information section in LE text files.
-B --brief Suppress cross reference comments.
-X --export Enable the export mode and create small and machine readable text files for easy post processing.
--no-echo Suppress output of @ECHO commands while scanning text files.
-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.
--lpar file Read a LPAR file to overwrite settings of LE-CODE section LPAR.
--lt-clear Clear LEX section TEST and remove the section if empty. This option is executed before all other --lt-* options.
--lt-online value Set LEX/TEST parameter OFFLINE-ONLINE to this MODE. MODE is one of AUTO (default), NEVER or ALWAYS. If needed, LEX section TEST is created or removed if empty.
--lt-n-players offline,online Set LEX/TEST parameters N-OFFLINE and N-ONLINE to these integer values. If needed, LEX section TEST is created or removed if empty.
--lt-cond-bit bitnum Set LEX/TEST parameter COND-BIT to this integer value. Use -1 to deactivate this COND-BIT. If needed, LEX section TEST are created or removed if empty.
--lt-game-mode mode Set LEX/TEST parameter GAME-MODE to this MODE. MODE is one of AUTO (default), Balloon, COIN, VERSUS or ITEMRAIN. If needed, LEX section TEST is created or removed if empty.
--lt-engine mode Set LEX/TEST parameter ENGINE to this MODE. MODE is one of AUTO (default), BATTLE, 50CC, 100CC, 150CC, 200CC, 150M or 200M. Only track.szs files are modified. If needed, LEX section TEST is created or removed if empty.
--lt-random index Force a random scenario, if between 1 and 8. Value 0 enables auto selection and -1 disables this option. If needed, LEX section TEST is created or removed if empty.
--lex-purge Delete LEX sections without any impact. This option is executed after all --lt-* options.
--rm-features Remove LEX setion FEAT (features) if exists. It is executed after --lex-purge. --lex-rm-features is an alternative name.
--le-define file Use this file as definition file to patch LE-CODE. The file format can be LE-BIN or any supported CT-CODE file (BRRES, TEX0, CT-CODE or CT-TEXT).
--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.
--engine list Define probabilities for engine classes. LIST is a vector for 100cc,150cc,mirror If 200cc is enabled by --200cc, then vector is interpreted as 150cc,200cc,mirror. Any numbers are accepted. They are normalized to get a total of 100 percent. Use 0,1,0 to force 150cc only. Use 0,0,0 to reset to Nintendos VR based choice.
--200cc [=mode] Enable or disable 200cc support. Mode is one of OFF, AUTO (default) or ON (default, if option is used without parameter). LE-CODE hasn't implemented this feature yet!
--perf-mon [=mode] Enable or disable the performance monitor. Mode is one of OFF, AUTO (default, don't change setting), ON (enable it for Wii and Wii U only; default, if option is used without parameter) or FORCE (enable it for Wii, Wii U and for Dolphin).
--custom-tt [=mode] Enable or disable time trial for custom tracks. Mode is one of OFF, AUTO (default) or ON (default, if option is used without parameter).
--xpflags [=mode] Enable or disable support for Extended Presence Flags. Mode is one of OFF, AUTO (default) or ON (default, if option is used without parameter). Disable it only for tests!
--speedometer [=mode] Enable or disable the speedometer. Mode is one of OFF, AUTO (default, don't change setting), ON (default, if option is used without parameter) or FRACTION (=1DIGIT), 2DIGITS and 3DIGITS.
--debug mode Enable or disable the debug output while racing. Mode is one of OFF, AUTO (default, don't change setting), USER or 100 to 199 for predefined setups.

3.   Built-in Help

Below is a copy of the built-in help which can be displayed by wlect create as colored text. It is also available as text file. 

Command »wlect CREATE«

  This command creates text files. The optional argument defines the type of output. The
  general syntax is:

    wlect CREATE
    wlect CREATE SUB_COMMAND option...

  This help is printed if no SUB_COMMAND is used or if it is »HELP«. The sub-commands are
  case sensitive, unique abbreviations are allowed. The sub-commands are logically
  divided into several groups:

    Create a LEX file:   LEX, LEX+, SET1, CANNONS, HIPT, TEST.
    Create another file: LPAR, LE-DEF, PREFIX, CATEGORY.
    Print an information: LE-INFO.

  This help and the generated text files are output via the standard output (stdout) by
  an internal pager. Options --dest, --DEST and --overwrite can change this default.


Create a LEX file:

  The following sub-commands create a LEX file with one or all sections:

    LEX:      Create a LEX file with all known sections except section »TEST«.
    LEX+:     Create a complete LEX text file including section »TEST«.

    FEATURES: Create a LEX text file with section »FEAT« only.
    SET1:     Create a LEX text file with section »SET1« only.
    CANNONS:  Create a LEX text file with section »CANN« only.
    HIPT:     Create a LEX text file with section »HIPT« only.
    TEST:     Create a LEX text file with section »TEST« only.


Create other files:

    LPAR:     Create a LPAR text file (LE-CODE parameters) as template. Option --lpar is
	      recognized to change defaults.
    LE-DEF:   Create a LE-CODE distribution definition file of type LE-DEF as template.
    PREFIX:   Create a machine readable prefix list. https://ct.wiimm.de/export/prefix is
	      the authoritative source for this.
    CATEGORY: Create a machine readable category list.
	      https://ct.wiimm.de/export/category is the authoritative source for this.


Print an information:

    LE-INFO:  Print information about built-in LE-CODE binaries.

4.   Templates

You can find some created templates here.