prev

next

» SZS: Wiimms SZS Toolset » wkmpt: Wiimms KMP Tool » wkmpt startpos

Wiimms SZS Tools

Privacy Statement

Tools

wkmpt commands

gamemodes, gmodes

startpos, sp

wkmpt startpos

Print an ASCII image or a table of the start positions. The parameter list is a wild mix of filenames, keywords and numbers.

If a parameter contains a slash ('/' or '\'), it is a filename of a KMP or SZS file and a KMP is loaded. The KMP is used to print absolute positions and to find the settings for LEFT/RIGHT and WIDE/NARROW automatically.

A parameter may also be one of the following keywords to define a setting: RESET, IMAGE, TABLE, RELATIVE, ABSOLUTE, LEFT, RIGHT, WIDE, NARROW, AUTO, NO-AUTO, DECIMAL, HEXADECIMAL, Z0, Z1, Z2, Z3. A table or image is only printed on numbers 1 to 12.

Contents

1. Syntax
2. Options
3. Description

1. Syntax

wkmpt STARTPOS [patch-option]... key_or_file...

2. Options

Options
Option		Param	Description
`-c`	`--const`	list	Define constant values, that are used by the internal encoders and by the numeric options as predefined global variables. This option allows a conditional encoding of text files. It can be used multiple times for multiple definitions. The parameter is a comma separated list of terms and a term is 'name=expression'. The expression is calculated by the text parser.
	`--scale`	vector[@origin]	Transform the data: Scale all coordinates and size values by 'vector' relative to the point 'origin'. If the origin is not set, 0,0,0 is used instead. Negative values mirror the coordinates. Each parameter is either a vector expression or a comma separated expression list of coordinates ('x,z' or 'x,y,z'). Transformations are calculated in the order SCALE, SHIFT, ROTATE, TRANSLATE.
	`--shift`	vector	Transform the data: Add 'vector' to all coordinates. It's simlar to `--translate`, but the addition is done before rotation. The parameter is either a vector expression or a comma separated expression list of coordinates ('x,z' or 'x,y,z'). Transformations are calculated in the order SCALE, SHIFT, ROTATE, TRANSLATE.
	`--xss`	x1old,x1new,x2old,x2new	--xss (x-scale-shift) calculates the X values of `--scale` and `--shift`, so that old values are transformed to the new values. The parameters are numbers or expression.
	`--yss`	y1old,y1new,y2old,y2new	--yss (y-scale-shift) calculates the Y values of `--scale` and `--shift`, so that old values are transformed to the new values. The parameters are numbers or expression.
	`--zss`	z1old,z1new,z2old,z2new	--zss (z-scale-shift) calculates the Z values of `--scale` and `--shift`, so that old values are transformed to the new values. The parameters are numbers or expression.
	`--rot`	degree[@origin]	Transform the data: Rotate all coordinates and rotation values by the angle 'degree' (is a vector) around the 3 axes. All 3 axes goes through the point 'origin'. If the origin is not set, 0,0,0 is used instead. Each parameter is either a vector expression or a comma separated expression list of coordinates ('x,y,z'). Option --rot is an alternative for `--xrot`, `--yrot` and `--zrot` to define all 3 rotations in one step. Transformations are calculated in the order SCALE, SHIFT, X-ROTATE, Y-ROTATE, Z-ROTATE, TRANSLATE.
	`--xrot`	degree[@origin]	Transform the data: Rotate all coordinates and rotation values by the angle 'degree' around the x-axis, that goes through the point 'origin'. If the origin is not set, 0,0,0 is used instead. Each parameter is either a vector expression or a comma separated expression list of coordinates ('y,z' or 'x,y,z'). Transformations are calculated in the order SCALE, SHIFT, X-ROTATE, Y-ROTATE, Z-ROTATE, TRANSLATE.
	`--yrot`	degree[@origin]	Transform the data: Rotate all coordinates and rotation values by the angle 'degree' around the x-axis, that goes through the point 'origin'. If the origin is not set, 0,0,0 is used instead. This is a horizontal counterclockwise rotation and the old option name --hrot can also used. Each parameter is either a vector expression or a comma separated expression list of coordinates ('x,z' or 'x,y,z'). Transformations are calculated in the order SCALE, SHIFT, X-ROTATE, Y-ROTATE, Z-ROTATE, TRANSLATE.
	`--zrot`	degree[@origin]	Transform the data: Rotate all coordinates and rotation values by the angle 'degree' around the z-axis, that goes through the point 'origin'. If the origin is not set, 0,0,0 is used instead. Each parameter is either a vector expression or a comma separated expression list of coordinates ('x,y' or 'x,y,z'). Transformations are calculated in the order SCALE, SHIFT, X-ROTATE, Y-ROTATE, Z-ROTATE, TRANSLATE.
	`--ypos`	pos	This option defines an Y position for KMP:CKPT transformations. It has only impact to X and Z rotations (Options `--xrot` and `--zrot`). If not set, the mean y of the active rotation origins are used.
	`--translate`	vector	Transform the data: Add 'vector' to all coordinates. It's simlar to `--shift`, but the addition is done after rotation. The parameter is either a vector expression or a comma separated expression list of coordinates ('x,z' or 'x,y,z'). --trans is a short cut. Transformations are calculated in the order SCALE, SHIFT, ROTATE, TRANSLATE.
	`--null`		Create a neutral transformation without affecting the coordinates. The only influence is, that the dependent values (like maximum) are re-calculated as if a transformation has taken place.
	`--next`		Close the current transformation step with all scaling, shifting, rotation and translation options and open a new step with cleared options. On transformation each step is logical done one by one. In real, one total transformation matrix is calculated and used for fast transformations. If option --next is used, the ability for modifying the scale and rotation vectors (not the positions) of different KMP sections is nearly always lost. A warning is printed if this occurs.
	`--ascale`	factor@dir	Transform the data and do an axis scale: Close the current transformation step like `--next` and scale the data by 'factor' into the direction given by the vector 'dir'. Store the resulting matrix as single transformation step and open a new one. This kind of transformation is EXPERIMENTAL!
	`--arot`	degree[@pos1]@pos2	Transform the data and do an axis rotation: Close the current transformation step like `--next` and rotate the data by 'degree' around the axis defined by the 2 points. If 'pos1' is not set, use 0,0,0 instead. Store the resulting matrix as single transformation step and open a new one. This kind of transformation is EXPERIMENTAL!
	`--tform-script`	script	Load the script and execute it by the text parser. Then for each coordinate (2D and 3D), call the macro TRANSFORM after all other transformations. Call it without parameters and set variable $I with a zero based index of all vertices, variable $D to the dimension (2 or 3) and the variable $P to the vector of the current vertex. If the macro returns a vector, it is the new position. For each file, macro BEGIN is called at the beginning and END after processing all points, but only, if the macros are defined. For END, variable $I is set to the number of processed vertices in the current file. Before each macro call, the private and local variables are cleared and only global parameters are permanent. The zero based index is cleared for each new source. The parameters of the macro calls are defined in the local name space.
	`--kmp`	list	Set global options for KMP processing. Parameter 'list' is a comma separated list of keywords. A minus sign before a keyword disables a setting. Each occurrence of the option will only change entered settings and all other settings are untouched. Keyword DEFAULT resets the default settings and CLEAR disables all. The other allowed keywords are: FORCE, NEW, RM-SPCITEM, LEFT, RIGHT, WIDE, NARROW, FIX-CKPH, FIX-ENPH, FIX-ITPH, FIX-PH, FIX-CKNEXT, FIX-CKJGPT, FIX-CK, FIX-ALL, MASK-PFLAGS, RM-LECODE, PURGE-GOBJ, FULL-DEFOBJ, DUMP-CLASS, DUMP-ONEWAY, DUMP-ALL, 1LAP .. 9LAPS, MAX-LAPS, RM-EMPTY, TINY-0 .. TINY-7, INPLACE, SILENT and LOG.
	`--speed-mod`	factor	The speed modifier is a user extensions to change the basic speed of all vehicles. The speed factor itself is stored into KMP:STGI section of a track. If --speed-mod is set to a value >0.0, then the last 2 bytes of the STGI section are patched. The value 0.0 reset these 2 bytes and deactivates the speed modifier.
	`--ktpt2`	vector	Insert or replace a second KTPT. Use VECTOR as new position. VECTOR is either X,Z or X,Y,Z or an expression. Set Y to 0 for an automatic defined height. If the first 4 characters of VECTOR are 'AUTO' (ignoring case), then the position is calculated automatically and set to the recommendation of command wkmpt KTPT. The tool looks for the nearest lap counter (CKPT with mode 0) and adjust the KTPT: The direction of the lap counter is copied and the KTPT is moved to the lap counter line using the new direction. LE-CODE uses the second KTPT to draw the finish line at another place away from the start position.
	`--tform-kmp`	list	Select KMP sections and objects for a transformation. --tkmp is a short cut. The option expects a comma separated list of keywords. Non ambiguous of keywords are allowed and minus signs within keywords are optional (e.g. GOBJS). A minus sign before a keyword disables transformation of the related section or object. Sections are selected by the KMP section names AREA, CAME, CKPT, CNPT, ENPT, GOBJ, ITPT, JGPT, KTPT, MSPT and POTI. Objects are selected by the keywords AREA-POSITION, AREA-ROTATE, AREA-SCALE, CAME-POSITION, CKPT-POSITION, CNPT-POSITION, CNPT-ROTATE, ENPT-POSITION, ENPT-SCALE, GOBJ-POSITION, GOBJ-ROTATE, GOBJ-SCALE, ITPT-POSITION, ITPT-SCALE, JGPT-POSITION, JGPT-ROTATE, KTPT-POSITION, KTPT-ROTATE, MSPT-POSITION, MSPT-ROTATE and POTI-POSITION. The keywords NONE and ALL (default) complete the field.
	`--repair-xpflags`	file	Load a KMP file and use it to repair the settings of the extended presence flags, if they are destroyed by another KMP tool. --repxpf is a short cut for this option.
	`--rm-gobj`	objlist	Remove objects from the KMP section GOBJ. Therefor a comma separated object list with single values like 'a' or ranges like 'a:b' is expected. 'a' and 'b' are numbers, object names (prefixed by 'o$') or any other parser expressions.
	`--battle`	[=mode]	MODE is either OFF, AUTO (default) or ON. Without value, ON is used. If mode is ON, assume a battle arena and enable a special battle support. If mode is OFF, disable special battle arena support. If mode is AUTO, analyse the KMP and estimate, if it is a battle areana. Modes ON and OFF override KMP parameter BATTLE-MODE.
	`--export-flags`	[=mode]	MODE is either OFF, AUTO (default) or ON. Without value, ON is used. --exflags is an alternative name for the option. If mode is ON, this feature is forced: On creating a KMP text file, the option EXPORT-FLAGS is always set to 1. On creating a binary KMP file, the flags are always exported as lowest byte of the scale factors or x-rotation. If mode is OFF, this feature is totally disabled. If mode is not AUTO, KMP parameter EXPORT-FLAGS is overridden.
	`--route-options`	[=mode]	MODE is either OFF, AUTO (default) or ON. Without value, ON is used. On mode ON, the new commands $PREV and $NEXT are printed for each group of KMP sections ENPT and ITPT. On mode AUTO, the command is only printed, if any option is set or if parameter SHOW-OPTIONS is >0. On mode OFF, this feature is totally disabled to create KMP text files that are compatible with versions <1.60a. This option exists only for a transition period. Its behaviour will be changed in the future. --ropt is a short cut.
	`--wim0`	[=mode]	MODE is either OFF, AUTO (default) or ON. Without value, ON is used. If mode is ON, a KMP section called WIM0 is added on binary KMP creation. The sections contains information for Wiimms tools. If mode is OFF, this feature is totally disabled. If mode is not AUTO, KMP parameter KMP-WIM0 is overridden.
	`--slot`	keyword	Patch a track file to run at the specified slot. KMP and KCL may be modified. BRRES files may be added to or removed from SZS. The main keywords are DAISY, DESERT, SHERBET, SHYGUY, STANDARD and MOST. Slot numbers (except '42' and '4.2') and different other track names are also accepted. For some conversions, the auto-add library is needed.
	`--load-kcl`	file	Load a KCL or OBJ file for reference issues.

3. Description

The command STARTPOS prints out the start positions used by Mario Kart Wii in time trial, grad prix, versus and online races, but not in battles. The real start positions for each player depends on 4 factors:

The 3D start position and 3D start direction vectors in KMP section KTPT.
The number of players. There are 12 different setups.
The narrow mode defined in KMP section STGI. There are 12 more narrow setups.
The pole position defined in KMP section STGI. Mode right is simple or mirrored version of mode left.

The command allows different options:

Parameters for command @STARTPOS@
keyword	Description
/ \	If a parameter is a single slash or backslash, the current KMP is unloaded.
/ \	If a parameter contains a slash or backslash, it is not a keyword, but a filename for a KMP or SZS file. The KMP data is loaded to support absolute values and automatic positioning.
CLEAR RESET	Reset all parameters to their defaults: The KMP is unloaded and the setting are reset to IMAGE, ABSOLUTE, LEFT, WIDE, AUTO, DECIMAL and Z1.
IMAGE I	Use the text image output. The coordinates are always printed as relative positions. This is the default output mode.
TABLE T	Use the table output. The coordinates are printed either as absolute or relative positions.
ABSOLUTE ABS	For table output only: Print the coordinates absolute, if a KMP is loaded and a start position (section KTPT) can be found. This is the default coordiante printing mode.
RELATIVE REL	Print the coordinates always as relative values.
LEFT L	Disable the auto detection for the pole position and set the pole position to the left side. The left pole position is the default, but with enabled auto detection.
RIGHT R	Disable the auto detection for the pole position and set the pole position to the right side.
WIDE W	Disable the auto detection for the narrow mode and disable the narrow mode. The wide mode is the default, but with enabled auto detection.
NARROW N	Disable the auto detection for the narrow mode and enable the narrow mode.
AUTO A	Enable the auto detection for the pole position and for the narrow mode. If no KMP is loaded or a STGI entry can't be found, the last or default settings of LEFT, RIGHT, WIDE and NARROW are used. This is the default.
NO-AUTO NOAUTO	Disble the auto detection for the pole position and for the narrow mode and use always the the last or default settings of LEFT, RIGHT, WIDE and NARROW.
DECIMAL DEC	Print positions as decimal values with fractions. This is the default.
HEXADECIMAL HEX	Print the positions as hexadecimal value int the mode, that the Mario Kart Wii online protocol uses to transmit the positions. The relation is: HEX = int( DEC * 16.0 ) + 0x9f42410
Z0 Z1 Z2 Z3	These 4 keywords have only impact in text image mode (IMAGE). They define the number of columns printed for the z-coordinates. The first column are the coordinates itself. The second column are the differences of the values of the first column. The third column are the differences of the values of the second column. The second and third columns help to find symmetries and the correct values. The default is to print only one column (Z1).
1..12	A table or image is only printed, if a number between 1 and 12 is entered. All other parameters above are only settings for this print out.