Wiimms SZS Tools

From Custom Mario Kart

Wiimms SZS Tools

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.
Current Version:	0.34a, 2012-05-12
Website:	szs.wiimm.de

Contents 1 Introduction 2 History and Download 2.1 Change Log 2.2 Links 3 Tools Overview 3.1 wszst (Wiimms SZS Tool) 3.2 wbmgt (Wiimms BMG Tool) 3.3 wkmpt (Wiimms KMP Tool) 3.4 wimgt (Wiimms Image Tool) 3.5 wstrt (Wiimms StaticR Tool) 4 Links

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 (decode only KCL files into text/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 v0.34a r3659 - 2012-05-12

 - KMP text parser extensions:

    - New commands:
       @INCLUDE "filename": include text files.
       @RETURN [val]: returns from the current input file.
       @EXIT: exit the parser execution.
       @ASSERT condition: exit execution, if 'condition' is false.
       @MACRO .. @ENDMACRO: Define named macros.
       @FUNCTION .. @ENDFUNCTION: Like @MACRO, but can also be used as
          function in numerical expressions.
       @CALL macroname(...): Call a previos defined macro with parameters.
          '@:macroname(...)' is a short cut for '@CALL macroname(...):'
       @DOIF (condition) anytext: Execute 'anytext', if 'condition' is true.

    - New private variable name space: @PDEF
       - P-Variables are only defined for the current source file or function.
       - Loop variables (@FOR,@FOREACH) and macro parameters are defined in
         this new private name space.

 - New options for command FUNCTIONS (list parser functions):
    - Option --long: The entered keys are compared against the description.
    - Option --verbose: The description is printed too.

 - Bug fix: Parser function minMax() returned wrong results.


szs v0.33a r3627 - 2012-05-02

 - Because of an update of the internal object & file database, redo the
   command "wszst AUTOADD ./path_to/Race/Course/" to add more files to the
   autoadd database -> see http://szs.wiimm.de/doc/autoadd for more info.

 - wszst CHECK: Detect "optional files".

 - KMP: New command '@HSNAP-TO-ENPT' is similar to '@SNAP-TO-ENPT', but
   ignoring the vertical value of the enemy points.

 - The text parser supports 5 kinds of nested loops (EXPERIMENTAL):
     @LOOP    ... @ENDLOOP   : umlimted loop
     @REPEAT  ... @ENDREPEAT : loop with a predefined repeat count
     @FOR     ... @ENDFOR    : classical 'for' with iterator variable
     @FOREACH ... @ENDEACH   : for each element in list
     @WHILE   ... @ENDWHILE  : classical 'while' with condition
   There are also conditional @BREAK and @CONTINUE.

 - The KMP syntax and semantics documentation is now online available:
    -> http://szs.wiimm.de/doc/kmp/syntax
   The inline documentation in decoded KMP files is now much shorter.

 - Command SYNTAX removed. Use page http://szs.wiimm.de/doc/syntax instead.

 - The backtracking algorithm for analyzing of CKPH + ENPH + ITPH pathes has
   been modified and optimized, because a test version of "Toad's Turnpike"
   has 105 ITPH groups and needs much to much steps and time to calculate
   about 10^28 pathes total.

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

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 Parser
  • General parser syntax and semantics
  • KMP text syntax and semantics
  • KMP parser functions
• Forums
  • Discussion at MarioKartWii.com
  • Discussion at GBAtemp.net
  • Discussion at Wii-Homebrew.com (german forum)