Difference between revisions of "Wiimms SZS Tools"

Revision as of 13:39, 28 March 2013

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.15a, 2013-03-28
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

Wiimm started the development of his SZS Tools in March 2011. The first goal was to automate the insertions of the track names for Wiimms Mario Kart Fun distributions. Therefore 2 tools are needed: A SZS extractor and creator and a BMG manipulator. The 2 tools wszst and wbmgt were ready in April 2011. After this, Wiimm implemented an Image-Tool (wimgt), an StaticR.rel tool (wstrt), a KMP tool (wkmpt) and a KCL tool (wkclt). All tools are command line tools to support Scripts and fully automated manipulation.

Latest Change Log

szs v1.15a r4300 - 2013-03-28

 - New docu file: INSTALL.txt

 - Mac+Linux+Unix: Script 'install.sh' will call itself with 'sudo' if not
   started by user 'root'. Read INSTALL.txt for details.

 - Windows: Cygwin updated.

 - Better detection of UTF-8 files with byte order mark (BOM). Tool wbmgt will
   accept those files now.

 - Bug fix: wbmgt CAT: The option --patch is now processed.

 - Bug fix: wbmgt ENCODE: Wrong file naming fixed.

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

 - Check KCL+KMP: The checks are now done after patching.

 - New option --kmp=modes: It works like --kcl=modes to define KMP jobs and
   modes. The first modes are:
    - NEW        : Scan KMP and create a new one.
    - RM-SPCITEM : Clear 'special items for players' setting of the 6 item box
                   object types.
    - FIX-CKPH   : Fix the section CKPH.
    - FIX-ENPH   : Fix the section ENPH.
    - FIX-ITPH   : Fix the section ITPH.
    - FIX-PH     : Short cut for: FIX-CKPH,FIX-ENPH,FIX-ITPH.
    - INPLACE    : Force inplace replacing of KMP files (old mode).
    - LOG        : Debug: Enable KMP specific logging.
   The fix modes are EXPERIMENTAL!
   See http://szs.lemmi/opt/kmp for details.


szs v1.14a r4274 - 2013-03-14

 - wkmpt CHECK (and all commands calling this function internally):
   4 new tests for sections CKPH, ENPH and ITPH:
    - The section must not be empty (WARNING).
    - Only ITPH: The first 'next' link must be valid (WARNING).
    - Each group must have at least one valid 'next' link (WARNING).
    - Each group must have at least one valid 'prev' link (HINT).
   See http://szs.wiimm.de/cmd/wkmpt/check#testlist for all tests.

 - Option --kcl-script can now be used multiple times to execute multiple
   kcl script in the entered order.

 - Two new parser functions to identify the source within a script: isKCL()
   and isKMP(). Both functions return 0 for false, 1 for true or 2 for true,
   if the source is named 'course.*' (main KCL/KMP file).


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