Difference between revisions of "Wiimms SZS Tools"

From Custom Mario Kart
Jump to navigation Jump to search
(v1.45a released)
m
Line 89: Line 89:
 
   this option multiple times to define more than one search directory.
 
   this option multiple times to define more than one search directory.
  
−
     - wctct --ct-dir: Search files rmc?/mid1.bin, rmc?/mid2.bin, rmc?/ovr1.bin
+
     - wctct --ct-dir: Search files rmc?/mod1.bin, rmc?/mod2.bin, rmc?/ovr1.bin
 
       and rmc?/bad1code.bin.
 
       and rmc?/bad1code.bin.
  

Revision as of 19:59, 31 October 2015

Wiimms SZS Tools
File:Wiimms-SZS-Tools.png
Author: Wiimm
Operating Systems: Linux (i386,x86_64),
Mac (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.
Current Version: v1.45a, 2015-10-31
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 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).

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

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

The tools wctct and wstrt can now use external CT-CODE files, e.g that one created by github.com/Wiimm/wii-ct-code. The internal CT-CODE is now updated to the most current version of the GitHub archive. 

szs v1.45a r6602 - 2015-10-31

 - Option --patch-bmg=id: Better detection of the source file type (Race,
   Event, MenuOther, ... ) especially in SZS files.

 - The KMP compiler can now automatically create respawn points and/or
   automatically connect check points to the nearest respawn point. Both
   together make an initial respawn setup much easier.
   Read http://szs.wiimm.de/info/respawn-setup.html for details.

 - Tool wctct: It is now possible to define hidden tracks (don't appear in
   any cup) by using control letter 'H' instead of 'T'.

 - New option: wctct/wstrt --ct-dir: Define a search directory for CT-CODE
   parts and use the internal copies only, if no valid file is found. Use
   this option multiple times to define more than one search directory.

    - wctct --ct-dir: Search files rmc?/mod1.bin, rmc?/mod2.bin, rmc?/ovr1.bin
      and rmc?/bad1code.bin.

    - wstrt --ct-dir: Search files rmc?/boot_code.bin and rmc?/boot_data.bin
      if option --add-ctcode is used.

 - Tools wctct and wstrt use now the most current CT-CODE version provided by
   https://github.com/Wiimm/wii-ct-code (a fork of Chadderz code with support
   of the SZS Tools). To use the old code of year 2013 download the zip file
   http://szs.wiimm.de/download/ctcode/ctcode-2013-10.zip and use the base
   directory as parameter for the new option --ct-dir (see above).

 - wstrt --add-ctcode: The first free DOL sections are used now. Before only
   sections T2 and D8 were added if not already in use.

 - New option: wstrt --meno: Patch some 'MenuSingle' and 'MenuMulti' strings
   of file StaticR.rel for online usage to 'MenO*' to distinguish between
   offline and online.


szs v1.44a r6558 - 2015-10-17

 - BMG: The `inline mode' for attributes is now enabled by default. It can be
   disabled by option --no-bmg-inline.

 - BMG message id 0 is allowed now.

 - BMG: Support of 1A escapes with up to 254 bytes (before 12 bytes).

 - BMG: Escape sequences \x{}, \u{} and \z{} can now handle comma separated
   lists of parameters. See http://szs.wiimm.de/doc/bmg/esc for details.

 - New option: --x-escapes: Use \x{} escapes instead of \z{} escapes.

 - New option: --old-escapes: To be compatible with v1.43 and earlier, print
   1A escape sequences with total size of >12 bytes as single words. Also
   don't use \x{} and \u{} with parameter lists.

 - BMG supports now attribute vectors up to 20 bytes. MKWii uses only 4 bytes
   for attributes. 

 - New option: --bmg-inf-size (also --inf-size for tool wbmgt):
   Defines the size of section 'INF0'. For MKW it is usually 8.

 - New option: --force-attrib=attrib: Override all BMG attributes with the
   entered value. See http://szs.wiimm.de/doc/bmg/attrib for the syntax.

 - New option: --def-attrib=attrib: Define alternative default attributes for
   new BMG text files. See http://szs.wiimm.de/doc/bmg/attrib for the syntax.

 - New option: --no-attrib: Suppress the output of string attributes at new
   BMG text 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

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

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

Retrieved from "https://wiki.tockdom.com/w/index.php?title=Wiimms_SZS_Tools&oldid=94256"