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.39a, 2012-06-09
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 are now ready for use.
• Read the new KCL Guide before using the new KCL features.

Change Log

szs v0.39a r3799 - 2012-06-09

 - The KCL code was cleaned and the internal triangle data base has a new
   optimized data structure. The new KCL tool will create the same KCL as
   the previous r3774. Only the output of some dump commands and also
   the created OBJ files have changed.

 - Three new parser functions for the --kcl-script script:
     tri$create()    : Create a new triangle.
     tri$scale()     : Scale all points of a triangle.
     tri$hRot()      : Rotate all points of a triangle horizontally.
     tri$unremove()  : Clear 'REMOVED' marker
     tri$isRemoved() : Get 'REMOVED' status.
   Call "wkclt func tri$" for complete list of all 12 triangle functions.

 - Command "wkclt OCTREE" renamed to "wkclt TRAVERSE".

 - New command: wkclt COPY <source> <dest>
   Copy and convert source collision file (KCL or OBJ) to dest. The default
   destination file format is selected by scanning the file extension of the
   destination. This is an alternative for the ENCODE and DECODE commands
   for single copy operations.

 - Optimization: If input and output are binary KCL files and only KCL flags
   were changed, then the original KCL data is copied 1:1 to the output file
   and only the flag values are modifed. Use --kcl=new to build always a new
   binary KCL and to disable this optimization.


szs v0.38a r3774 - 2012-06-05

 - OBJ import and KCL creation tested with different tracks without issues.

 - New option --kcl=list: 'list' is a comma separated list with keywords to
   define options for the KCL processing. Allowed options are: RESET, FAST,
   NORMALS, OUT-SWAP, IN-SWAP, AUTO, CLIP, DROP, SORT and DEFAULT.
   See http://szs.wiimm.de/opt/kcl for details.

 - The transforming options  --shift, --scale, -xss, -yss, -zss and --hrot
   are now available for KCL processing.

 - Option --kcl-parse renamed to --kcl-script.

 - Three new parser functions for the --kcl-script script:
     tri$setPt()  : Define new triangle points.
     tri$shift()  : Shift all points of a triangle.
     tri$remove() : Remove a triangle from the list.
   If one of these function is used, a new octree is calculated.

 - New parser functions: sec(), mSec(), uSec()

 - Several small bugs in the KCL creation removed.


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.


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

• Complete History
• Downloads
• Source code
• KMP Object Query

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

wstrt (Wiimms StaticR Tool)

wstrt is a command driven tool to manipulate StaticR files of Mario Kart Wii.
→ Tool wstrt: Features, commands and options

Links

• How To
  • General How To
  • KMP How To
• Wiimms SZS Tools
  • Features, commands and options: wszst, wbmgt, wkmpt, wimgt, wstrt,
  • Downloads
• KMP & KCL Parser
  • General parser syntax and semantics
  • KMP text syntax and semantics
  • KMP parser functions
  • KCL export and import guide

• Forums
  • Discussion at MarioKartWii.com
  • Discussion at GBAtemp.net
  • Discussion at Wii-Homebrew.com (german forum)

Custom Track Tutorials

Main Tutorials
Introduction – Textures – Scale – Modeling ⇒ Using Blender – BRRES: CTools
BRRES: BrawlBox – BRRES: RiiStudio – Minimap – Solidity – KCL: Wiimms Tools – KMP Editing
Object Editing – Cameras – Cannons – Post-effects – Videos

Battle Arenas
Battle Arenas – Enemy routes in battle arenas ⇒ Using Wiimm's Tools – Coins

Misc. Tutorials
Getting Files – BrawlBox Tricks – Animations – Shadows – Mipmaps
Custom Effects – Moving Terrain – Music – Ports – Paint Remakes – Tutorial Archive
Extended presence flags: Track Tutorial – LE-CODE Track FAQ

Testing and Reviewing
Testing a Track – Visual Review – Track Transformation – Fixing Errors

Software
3D Tools – BrawlBox – CTools Pack – KMP3D – KMP Cloud – KMP Modifier
Lorenzi's KMP Editor – MagicY – Material Tool – Post-Effect Editor – Wiimms SZS Tools – Wiimm's Tool Manager

Other
KMP Objects – Custom Objects – Model Database – Tutorial Archive

By the same author: Wiimm

Custom Track Distributions:
Years 2010 – 2021
Wiimms Mario Kart Fun 2022-05 — Wiimms Mario Kart Fun 2022-11 — Wiimms Mario Kart Textures 2022-12
Download and Install

Custom Tracks:
Alpine Mountain — N64 Frappe Snowland — N64 Kalimari Desert — N64 Koopa Troopa Beach — N64 Wario Stadium
Custom Track Updates

Custom Arena:
Bash 'n' Dash 'n' Battle

Software:
Wiimms SZS Tools — Wiimms ISO Tools — Wiimms ISO Patcher — WBZ Converter — mkw-ana — LE-CODE

Cheat Codes:
License Unlock — Clear Profile ID — Item Cheat

Websites:
szs.wiimm.de — wit.wiimm.de — ct.wiimm.de — wiimm.de — wiimmfi.de