SZS Features

1. SZS (Wiimms SZS Toolset) is a set of command line tools.

Wiimms SZS Toolset is a set of command line tools to manipulate Nintendos SZS and BGM files. Command line means that you have to open a text console (cmd for windows) to execute the commands. An other way is to write little scripts (windows: *.bat or *.cmd files) that call one of the tools with all needed options and parameters.

1.1 Summary of tools

wszst (Wiimms SZS Tool):
This is the archive manipulation tool : List, compare, (de-)compress, extract and create SZS, U8, PACK, BRRES, BREFF, BREFT and RARC archives. It is also a wrapper to all other tools.
wbmgt (Wiimms BMG Tool):
This is the main BMG manipulation tool : Convert and patch raw and text BMG (message) files.
wimgt (Wiimms Image Tool):
This is the image manipulation and conversion tool : Extract and convert graphic images. The file formats TPL, TEX, BTI, BREFT and PNG are supported.
wkclt (Wiimms KCL Tool):
This is the main KCL conversion tool : Analyze, modify, export and create KCL and OBJ files.
wkmpt (Wiimms KMP Tool):
This is the main KMP conversion tool : Analyze, modify, export and create (compile) KMP files.
wmdlt (Wiimms MDL Tool):
This is the main MDL conversion tool : Decode raw MDL and encode text MDL files. At the moment, it can only be used for analysis.
wpatt (Wiimms PAT Tool):
This is the main PAT conversion tool : Decode raw PAT and encode text PAT files.
wstrt (Wiimms StaticR Tool):
This is the StaticR.rel and main.dol manipulation tool : Manipulate the 'main.dol' and 'StaticR.rel' files of Mario Kart Wii.
wctct (Wiimms CT-CODE Tool):
This command supports the CTGP Revolution extensions, which allow more than 200 custom tracks in only one image.

2. wszst (Wiimms SZS Tool) is the SZS manipulation tool.

wszst is the SZS manipulation tool:

wszst supports compressed and uncompressed SZS files. Uncompressed files are good for analysis. Supported archive formats are U8, WU8, PACK, BRRES, BREFF, BREFT and RARC. The format of each source file is detected independent of the file name.
»wszst LIST« lists the content of a SZS, U8, WBZ, WU8, PACK, BRRES, BREFF, BREFT and RARC archives and directories, if wanted recursive. It lists also extracted file systems to preview the creation process.
»wszst MEMORY« prints a memory dump of all known archives and file types, if wanted recursive. Normal files are cutted into section and peaces, if option --cut is set. This helps to find location of individual parts of the files.
»wszst NORMALIZE« read an U8 archive, compressed or not, and write it back in a normalized form:
- The files are sorted in a Nintendo like order.
- Unused data holes are removed.
- If directory '.' is available it becomes the root directory for all others.
- Compressed sources are compressed again with maximum compression (level 9).
- The destination is only written if any data changed.
»wszst COMPRESS« and »wszst DECOMPRESS« convert SZS files from and to compressed format.
»wszst EXTRACT« extract the directories and files to the local file system to make access very easy. Recursive extraction and automatic decoding of some file formats is also possible.
»wszst EXTRACT« can extract known archives reclusively and can decode BMG files and graphic images on the fly.
»wszst CREATE« creates SZS files from directory structures. All files are included, include and exlcude lists are supported. Recursive creation and automatic encoding of some file formats is also possible.
»wszst CAT« allow to access one or more sub files within SZS files. The output of all sources is concatenated and written to stdout.
Extrating a SZS file and creating again results in the same SZS file. Only the internal order of the files may be changed.
»wszst DIFF« compares 2 archive files on file level. This comparing is independent of the compression and of file order.

3. wbmgt (Wiimms BMG Tool) is the BMG manipulation tool.

wbmgt is the BMG manipulation tool:

wbmgt supports raw and text BMG files. Raw BMG is the file format needed by Nintendos software. Text BMG is a user readable and editable format. Each text export contains a syntax documentation.
When reading a file, wbmgt detect the format of each source file independent of the file name. This make the usage of raw and text BMG files interchangeable.
wbmgt may read BMG files directly from SZS files. Just enter the path and assume that the SZS file is a directory.
Example, where path/to/my.szs is the SZS file: path/to/my.szs/message/Common.bmg
»wbmgt LIST« lists the contained strings for a fast preview.
»wbmgt DIFF« compares the strings of 2 BMG files and reports the differences.
»wbmgt PATCH« patches each source by using a list of patch files. There are several patching modes: REPLACE, INSERT, OVERWRITE, DELETE, MASK, EQUAL and NONEQUAL. Like every source, raw and text BMG files are accepted as patch.
»wbmgt DECODE« converts each source file into text mode. Patching while decoding is possible.
»wbmgt ENCODE« converts each source file into raw mode. Patching while encoding is possible.
Decoding a raw BMG file and encoding again results in the same BMG file.

4. wimgt (Wiimms Image Tool) extract and converts MKWii images.

wstrt is the image manipulation tool:

wimgt supports the file formats BREFT, BTI, TEX, TPL and PNG (as export/import type).
wimgt supports the internal image formats I4, I8, IA4, IA8, RGB565, RGB5A3, RGBA32, C4, C8, C14X2 and CMPR (and also different PNG formats).
When reading a file, wimgt detect the image format of each source file independent of the file name.
wimgt may read images directly from SZS files. Just enter the path and assume that the SZS file is a directory.
Example, where path/to/my.szs is the SZS file: path/to/my.szs/german.tpl
»wimgt LIST« lists the images of a directory and print out geometry data for each image.
»wimgt DECODE« converts each image into a PNG file.
»wimgt ENCODE« converts each source to any internal file and image format. The conversion can be controlled with option --transform. Patching while encoding is possible.
»wimgt COPY« is an alternative easy to use command to copy image data from one file to another. Converting and transforming is done on the fly.
Decoding an internal IMG file and encoding it again results in the same IMG file.

5. wkclt (Wiimms KCL Tool) is the KCL manipulation tool.

wkclt is the KCL import, export and patching tool:

wkclt will support raw (binary) KCL files and Wavefront OBJ files. Raw KCL is the file format needed by Nintendos software. Wavefront OBJ is general 3D import and export file format.
When reading a file, wkclt detect the format of each source file independent of the file name. This make the usage of raw KCL and OBJ files interchangeable.
wkclt may read KCL files directly from SZS files. Just enter the SZS path as source file.
»wkclt DECODE« converts each source file into a Wabefrom OBJ file. These OBJ files can be read by any 3D Tool to view the collision modell.
»wkclt ENCODE« converts each source file into raw (binary) KCL file. Creating the octree is done automatically.
»wkclt COPY« is an alternative easy to use command to copy a KCL or OBJ file to another KCL or OBJ. Converting and transforming is done on the fly.
»wkclt DUMP« prints an info dump of all entered KCL or OBJ file.
»wkclt FLAGS« prints a flag summary of all entered KCL or OBJ file.

6. wkmpt (Wiimms KMP Tool) is the KMP manipulation tool.

wkmpt is the KMP manipulation tool:

wkmpt supports raw and text KMP files. Raw KMP is the file format needed by Nintendos software. Text KMP is a user readable and editable format.
When reading a file, wkmpt detect the format of each source file independent of the file name. This make the usage of raw and text KMP files interchangeable.
wkmpt may read KMP files directly from SZS files. Just enter the SZS path as source file.
»wkmpt DECODE« converts each source file into text mode. These text files can be edited with any text editor and it's complete power. Also script or other text tools may manipulated theses text files.
»wkmpt ENCODE« converts each source file into raw mode. Indexing and grouping are done automatically. Some other automatic calculations can be enabled by switches in the text files.
To make reorganisation (inserting, deleting and reordering entries) easier, the KMP text scanner supports global variables for inter sections links (CAME+GOBJ to POTI, CKPT to JGPT).
Decoding a raw KMP file and encoding again results in the same KMP file. The only difference may be floating point numbers because of rounding of the least significant bits.

7. wmdlt (Wiimms MDL Tool) is the MDL manipulation tool.

wmdlt is the MDL manipulation tool:

wmdlt supports raw and text MDL files. Raw MDL is the file format needed by Nintendos software. Text MDL is a user readable and editable format.
However, the development of wmdlt is at the beginning and the usage of the tool experimental.
When reading a file, wmdlt detect the format of each source file independent of the file name. This make the usage of raw and text MDL files interchangeable.
wmdlt may read MDL files directly from SZS files. Just enter the SZS path as source file.
»wmdlt DECODE« converts each source file into text mode. These text files can be edited with any text editor and it's complete power. Also script or other text tools may manipulated theses text files.
»wmdlt STRINGS« print all strings of the MDL.

8. wpatt (Wiimms PAT Tool) is the PAT manipulation tool.

wpatt is the PAT manipulation tool:

wpatt supports raw and text PAT files. Raw PAT is the file format needed by Nintendos software. Text PAT is a user readable and editable format.
Two modes of text files are supported: SIMPLE and COMPLEX. All PAT data can be printed in complex mode, but most PAT files use a simple data structure and can be printed in a more simple way. Option »--pat list« controls the output mode.
When reading a file, wpatt detect the format of each source file independent of the file name. This make the usage of raw and text PAT files interchangeable.
wpatt may read PAT files directly from SZS files. Just enter the SZS path as source file.
»wpatt DECODE« converts each source file into text mode. These text files can be edited with any text editor and it's complete power. Also script or other text tools may manipulated theses text files.
»wpatt ENCODE« converts each source file into raw mode. Indexing and grouping are done automatically. Some other automatic calculations can be enabled by switches in the text files.
To make reorganisation (inserting, deleting and reordering entries) easier, the PAT text scanner supports global variables for inter sections links.
Decoding a raw PAT file and encoding again results in the same PAT file. The only difference may be floating point numbers because of rounding of the least significant bits.

9. wstrt (Wiimms STR Tool) is the StaticR manipulation tool.

wstrt is the StaticR manipulation tool:

wstrt can analyze and patch StaticR files of Mario Kart Wii (PAL and NTSC).
»wstrt ANALYZE« analyzes StaticR files and detects CTGP 4.4 patches and modifications of track and arena orders. A possible patch is virtually applied before printing.
»wstrt PATCH« modifies the track and arena order of StaticR files. So it is possible to move tracks with special features (like snow or fog) to other slots.
»wstrt TRACKS« and »wstrt ARENAS« print a list of tracks or arenas with slots and filenames (track and sound files). If a StaticR file is entered, the track/arena order of that StaticR is used. A possible patch is virtually applied before printing.
»wstrt FILES« prints a list of filenames of all tracks and arenas in machine readable format. If a StaticR file is entered, the track and arena order of that StaticR is used. A possible patch is virtually applied before printing.

10. Advanced shell support.

All tools are designed to support scripting:

Exit codes are explained by the commands »wszst ERROR«.
The options --quiet and --verbose control the verbosity level.
Many commands may produce machine readable output. The option --sections enables a special machine readable output format.
The tools can read parameters from files.
Different environment variables are supported.