Difference between revisions of "Wiimms SZS Tools"

Revision as of 20:08, 8 September 2012

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.
Archive Formats:	SZS, U8, RARC, BRRES, BREFF, BREFT.
File Formats:	BMG, BTI, KCL, KMP, MDL0, TPL, TEX0, StaticR.rel, PNG, OBJ.
Current Version:	1.04a, 2012-09-08
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

Change Log

szs v1.04a r4050 - 2012-09-08

 - Bug fix for v1.03a: With some option combinations, the KCL generator failed
   and created an invalid KCL (if modifying an existing KCL) or a valid KCL
   with some unwanted triangles (if importing from OBJ).

 - Option --kcl: Better handling of DROP modes.

 - Option --kcl: Correct handling, if 'DROP-UNUSED' and 'NEW' are set together.
   (Same message as before, but now I have fixed one forgotten special case).

 - "wszst CHECK" will now compare the number of cannons in KCL and KMP.

 - New option: "wszst NORMALIZE --minimap": If --minimap is set, the minimap
   is automatically adjusted like "wszst MINIMAP --auto" does it. All other
   options like --scale are ignored for this kind of minimap processing.

 - New option: "wszst minimap --set-flags=flags": Set the MDL flags to an user
   defined value (default 0x31f).

 - The tools accept now 'Yaz1' files in the exact same manner as 'Yaz0' files
   hoping that the data structure and the compression method are the same.

 - New options: --yaz0 and --yaz1: Force the magic of new created YAZ files
   to 'Yaz0' or 'Yaz1'.

 - Object database updated.


szs v1.03a r4002 - 2012-08-11

 - New global option: --force: The tools analyse input files and reject files
   with invalid data structures. If --force is set, little repairable issues
   are ignored or repaired and a warning is printed.
   >>> THE RESULT MAY BE INVALID OUTPUT FILES!

 - Option --kcl: If no 'DROP*' mode is set, the tools drops automatically all
   bad triangles. For an existing octree, it is only 'DROP-UNUSED'.

 - Option --kcl: Correct handling, if 'DROP-UNUSED' and 'NEW' are set togehter.

 - wszst MINIMAP --auto: The Y-translation is also calculated to make very
   high faces visible.


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