Difference between revisions of "Wiimms SZS Tools"

Revision as of 08:05, 25 May 2019

Wiimms SZS Tools
File:Wiimms-SZS-Tools.png
Author:	Wiimm
Operating Systems:	Linux (i386,x86_64), Windows (Cygwin).
Software Type:	File manager, decoding and encoding toolset.
Compression Formats:	Yaz0, Yaz1, WBZ.
Archive Formats:	SZS, U8, WU8, PACK, RARC, BRRES, BREFF, BREFT.
File Formats:	BMG, BTI, KCL, KMP, MDL0, PAT0, TPL, TEX0, PNG, OBJ, StaticR.rel, main.dol, CT-CODE, LE-CODE.
Image formats:	I4, I8, IA4, IA8, RGB565, RGB5A3, RGBA32, C4, C8, C14X2, CMPR.
Current Version:	v2.03a, 2019-05-25
Website:	szs.wiimm.de

Wiimms SZS Tools has a spelling error, you should see but as a brand name.

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 8 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).
wpatt : Wiimms PAT Tool (handles raw and text PAT0 files, read text files like a compiler).
wstrt : Wiimms StaticR Tool (handles StaticR.rel and main.dol files of Mario Kart Wii).
wctct : Wiimms CT-CODE Tool (handles CT(GP)-CODE to allow >32 tracks).
wlect : Wiimms LE-CODE Tool (handles the LE-CODE extension by Leseratte)

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

There is also a 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 DRAW creates an OBJ file with KCL and add route positions and other objects of the KMP.
The wszst command PATCH can transform whole tracks inkl. KCL, KMP, MODEL, MINIMAP and VRCORN. Transforming means any combinations of scaling, rotating and shifting with different factors for each axis.
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 images with other images.

Last Features

LE-CODE

LE-CODE is a new MKW extension and works like CT-CODE. To support it, the new tool wlect was created. The tool and the complete LE-CODE support is experimental. No documentation is available, support will be denied for the moment, and there currently is no way for normal end users to create a LE-CODE distribution.

Mipmaps

With version v1.65a, the mipmap creation and the related options changed. Follow the links to SZS Docu for more details:

General mipmap discussion
- Options to control mipmaps
- Resize algorithm (used to create mipmaps)

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 have been 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 operations.

Latest Change Log

szs v2.03a r7854 - 2019-05-25

 - Command wszst CHECK: Hints about special files in subdirectory ./Common/.

 - Command wszst/wkmpt CHECK: Hints about special GOBJ settings, that are
   recognized by LE-CODE only.

 - Bug fix for wszst ANALYZE --json: Object names are enclosed by quotes now.

 - New option: --macro-bmg=file: Load a BMG file and add or overwrite the
   messages to the macro library. The macro library is accessed by escape
   sequence \m{MID} as fallback.

 - New escape sequence for BMG text files: \M{a,b,...}: Each parameter is
   interpreted as message id. If a message with given ID is defined by the
   macro library, then insert the text of the message.

 - New command: wkmpt KTPT: Analyse the start positions (KMP:KTPT) and lap
   counters (KMP:CKPT) and print a simple information list. Use enemy points
   (KMP:ENPT) to find recommendations. This command is dedicated to LE-CODE,
   which supports an alternative position for the finish line at the minimap.

 - New patch option for wszst and wkmpt: --ktpt2=vector
   Insert or replace a second KTPT. Use VECTOR as new position. Then find
   nearest lap counter (CKPT with mode 0) and adjust position and direction.


szs v2.02a r7827 - 2019-05-04

 - New option for wlect: --move1-tracks: Files with more than one hard link
   are copied and removed and not moved to create an unique version of the
   file.

 - New assigning operator for BMG text files: "MID1 : MID2": Copy attributes
   and text of message MID2 to message MID1. Forward and chained references
   are allowed. Multi message ids like 'T12' are supported on both sides.

 - New escape sequence for BMG text files: \m{a,b,...}: Each parameter is
   interpreted as message id. If a message with given ID exists (must be
   defined before and must not have an assigned value), then insert the text
   of the message.

 - New option for wszst EXTRACT: --basedir=DIRECTORY: Extract only files from
   archives, that are below the DIRECTORY. Leading points and slashes and
   trailing slahes are removed from the parameter. --bdir is short cut.  

 - New command: wszst XCOMMON: Scan archives and extract files from archives,
   that are below directory 'common'. Command XCOMMON is a short cut for
   EXTRACT --basedir=common.

 - New command: wszst ANALYZE: Analyse track files and print resulta in
   machine readable format.


szs v2.01b r7802 - 2019-03-21

 - Bug fix for v2.01a: The string support of the text parser had an memory
   allocation bug. wctct uses the new string functions since v2.01 and
   produces occasional (~25%) wrong CT-CODE files (strap files).

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 automatically.

→ 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