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, KMP, StaticR.rel and Image Manager
Archive Formats:	SZS, U8, RARC, BRRES, BREFF, BREFT.
File Formats:	BMG, BTI, KCL, KMP, MDL0, TPL, TEX0, StaticR.rel, PNG, OBJ.
Current Version:	0.37a, 2012-06-02
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.

History and Download

KCL stuff again:

KCL object exporter+importer has been improved.
- The KCL importer works not corret! Exporting and reimporting works fine for the most tracks, but not for all. The octree generation seems to be good, but he calculation of the normals by the given triangle points will sometimes results in wrong directions (sign problems).
Read the new KCL Guide before using the new KCL features.

Change Log

szs v0.37a r3748 - 2012-06-02

 - Read "Known Bugs" or http://szs.wiimm.de/doc/kcl about KCL issues.

 - Command "wkclt dump" prints now more octree statistics.
   As the result of the analysis of these statstics, the octree generation has
   been optimized and some new parameters have been established.

 - New command: wkclt TRIANGLES: It's like DUMP, but it print only 1 line
   for each triangle data. The goal is to compare the data with other dumps.

 - New option: --kcl-sort: Sort the triangles by length and positions to make
   a dump more and easier compareable.
   the octree. This helps to clean the KCL of custom tracks.

 - New option: --kcl-drop: Remove all triangles, that are not referenced by
   the octree. This helps to clean the KCL of custom tracks.

 - The OBJ exporter creates Wavefront OBJ files compatible with "3ds Max" and
   "Google SketchUp" (TIG's OBJ-importer plugin) and maybe with more 3D tools.
   The exported data contains now also 'vn' vectors (normals).

 - The OBJ importer read Wavefront OBJ files created by "3ds Max" and by
   "Google SketchUp" (TIG's OBJ-exporter plugin) and maybe by other 3D tools.


szs v0.36a r3720 - 2012-05-28

 - It the tools 'wkmpt' or 'wkclt' opens a SZS file, they use the internal
   files 'course.kmp' or 'course.kcl' as source.

 - New command: wszst KCL: Open the sub file @course.kcl@, decode and print it.

 - KCL object exporter improved.

 - New command: wkclt DUMP: Dumps the raw KCL records in human readable format.

 - New command: wkclt OCTREE: Traverse and test the octree by using the entered
   points. Logging of steps and triangles is controlled by --long and --brief.

 - wkclt ENCODE: Import an OBJ file and create a new KCL from scratch. The
   internal octree generator works fine and can be controlled by different
   constants. See http://szs.wiimm.de/doc/kcl#encode for more details.

 - If a KCL obj file with name NAME.EXT is scanned, a file name NAME.flag.txt
   is scanned to find relations between group names and flags.
   See http://szs.wiimm.de/doc/kcl#def-flag for more details.

 - Read the new KCL export and import How-To: http://szs.wiimm.de/doc/kcl


Known bugs:

 - The whole KCL creation is under development and EXPERIMENTAL!
   Exporting and reimporting works fine for the most tracks, but not for all.
   The octree generation seems to be good, but he calculation of the normals
   by the given triangle points will sometimes results in wrong directions
   (sign problems).

 - 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

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