Wiimms SZS Tools

Wiimms SZS Tools
File:Wiimms-SZS-Tools.png
Author:	Wiimm
Operating Systems:	Linux (i386,x86_64), Mac (ppc,i386,x86_64), Windows (cygwin).
Software Type:	SZS, BMG, KCL, KMP, StaticR.rel and Image Manager
Compression Formats:	Yaz0, Yaz1, WBZ.
Archive Formats:	SZS, U8, WU8, RARC, BRRES, BREFF, BREFT.
File Formats:	BMG, BTI, KCL, KMP, MDL0, TPL, TEX0, StaticR.rel, PNG, OBJ.
Current Version:	1.11a, 2013-01-01
Website:	szs.wiimm.de

Introduction

Wiimms SZS Tools is a set of different tools to manipulate SZS, U8, RARC, BRRES, BREFF and BREFT archives and BMG, BTI, KCL, KMP, MDL0, TPL, TEX0 and StaticR.rel files. All tools are command line tools and run without any interaction. The tools are available for Linux, Mac and Windows. The main goal is to run them in batch files and scripts to automate recurring jobs. At the moment there are 6 tools:

wszst : Wiimms SZS Tool (handles SZS, U8, RARC, BRRES, BREFF and BREFT archives)
wbmgt : Wiimms BMG Tool (convert and patch BMG files in binary and text format).
wimgt : Wiimms Image Tool (convert and patch image files of Mario Kart Wii).
wkclt : Wiimms KCL Tool (convert raw KCL files from/into obj format).
wkmpt : Wiimms KMP Tool (handles raw and text KMP files, read text files like a compiler).
wstrt : Wiimms StaticR Tool (handles StaticR.rel files of Mario Kart Wii).

One main goal is the fully automated track name replacement. The tools together can do this. Another goal is to extract all sub files recursivley and transforming they into user friendly file formats (like text of png files) and support recreation of the original source files.

There is also an little How To.

Main Features

The tools are command line tools. This means, that there is no GUI support. The main advantage is, that you can place commands into scripts (batch files) for fully automated execution → More about command line.
wszst is the main SZS tool. It has a fast Yaz0 compressor with the best compression rates.
The wszst command CHECK can help you to find bugs in your track.
The new wszst command SLOTS makes a track proposal for working and non working slots.
The KCL tool wkclt can create KCL files from scratch (they become as small as possible) by reading an OBJ file. It can also export an existing KCL to an OBJ file with colors to make a KCL visible.
The KMP tool wkmpt can decode and compile (yes, it's a real compiler with loops and other control structures) KMP files.
- While compiling, it can overide some parameters for debugging or optimization.
- The KMP compiler can use the KCL to find optimal vertical positions of objects and route points. This is good for visual debugging.
The wkmpt command COBJECT creates an OBJ file with KCL and and add route positions and other things.
The wszst command MINIMAP can center the minimap automatically. You can use this command with SZS, U8, BRRES and MDL0 files.
The image tool wimgt can convert images of all formats:
- It can convert the file formats TPL, TEX0, BTI, BREFT and PNG to any other.
- It can convert the Image Formats I4, I8, IA4, IA8, RGB565, RGB5A3, RGBA32, C4, C8, C14X2 and CMPR to any other.
- It supports the palette formats IA8, RGB565 and RGB5A3.
- It can automatically create mipmaps, or it can use user defined mipmaps and create only missed mipmaps automatically.
- It can patch image with other images.

History and Download

Change Log

szs v1.11a r4205 - 2013-01-01

 - If creating the KCL file, the world will be enlarged by the KCL_BLOW value
   to avoid problems at the world border.

 - New parameter for KCL/octree fine tuning: If KCL_MAX_SIZE is set, triangle
   lists are not defined for cubes, that are larger than this parameter.
   Instead new sub cubes with smaller triangle lsits are defined. The maximaum
   and default value for KCL_MAX_SIZE is 1024*1024 (~1 million).

 - New flag for --KCL=list: CENTER: If creating a new octree, adjust the cube
   entrance values so that the real world is centered in the cube world.

 - Some old and for a long time obsolate keywords removed.


szs v1.10a r4186 - 2012-11-17

 - Bug fix: File type printing (e.g. "YAZ0.U8:filename") was reimplemented
   because of the new bzip compression, but with bugs.

 - Command "wszst CHECK" will now accept option --verbose to print some more
   slot hints (negative info about slots 4.2, 6.1 and 6.2).

 - New debug command for all tools: ARGTEST: Print all scanned arguments as
   list. This helps to find out wrong parameters, especially for windows.

 - Cygwin (Windows): Filename handling improved. If using double quotes around
   a filename, backslashes work in a Windows usual way as directory separator.

 - Cygwin (Windows): Windows 'SendTo' support added. It must be (un-)installed
   with the batch files 'sendto-install.bat' and 'sendto-uninstall.bat'.
   Available SendTo jobs:
     - normalize-SZS.bat  : Normalize a file and convert it to SZS.
     - convert-to-WBZ.bat : Convert a SZS file to a WBZ file.
     - convert-to-SZS.bat : Convert a WBZ file to a SZS file.
     - create-autoadd-library.bat : Use it with the extracted Race/Course
       folder to create the autoadd library. It is needed for WBZ conversions.

 - New option: --number or --num: If a destiantion file already exists, 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. Option --number is ignored if --overwrite is set.


Known bugs:

 - Re creating the files Track.szs, Race.szs and other language independent
   szs files of MKWii directory ./Scene/UI will force a black screen. Use the 
   UPDATE command instead.

Links

Tools Overview

wszst (Wiimms SZS Tool)

wszst is a command driven tool to manipulate archives:

Supported archive formats: SZS, U8, RARC, BRRES, BREFF and BREFT.
It can extract all subfiles of any archive.
While extracting some file formats can be decoded (converted to text or PNG files).
It can create all (but not RARC archives) while readind and scanning a directory structure. Decoded files are encoded autoamtically.

→ Tool wszst: Features, commands and options

wbmgt (Wiimms BMG Tool)

wbmgt is a command driven tool to manipulate BMG (message) files.
→ Tool wbmgt: Features, commands and options

wkclt (Wiimms KCL Tool)

wkclt is a command driven tool to convert KCL files into/from binary KCL from/into Wavefront OBJ files.
→ Tool wkclt: Features, commands and options
→ General parser syntax and semantics
→ KCL export and import guide

wkmpt (Wiimms KMP Tool)

wkmpt is a command driven tool to convert KMP files into/from binary from/into text files. A special compiler is used to allow variables, expressions, if..then..else, loops, macros and user defined functions while reading a KMP text file.
→ Tool wkmpt: Features, commands and options
→ General parser syntax and semantics
→ KMP text syntax and semantics
→ KMP parser functions
→ How to edit KMP files

wimgt (Wiimms Image Tool)

wimgt is a command driven tool to convert and aptch graphic images:

wimgt supports the file formats BREFT, BTI, TEX0, TPL and PNG as export and 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).

→ Tool wimgt: Features, commands and options