Difference between revisions of "Wiimms SZS Tools"

From Custom Mario Kart
Jump to navigation Jump to search
(Wiimms SZS Tools v1.19a)
(Wiimms SZS Tools v1.19b)
Line 22: Line 22:
 
|-
 
|-
 
! Current Version:
 
! Current Version:
−
| 1.19a, 2013-06-02
+
| 1.19b, 2013-06-14
 
|-
 
|-
 
! Website:
 
! Website:
Line 67: Line 67:
 
=== Latest Change Log ===
 
=== Latest Change Log ===
 
<pre>
 
<pre>
 +
szs v1.19b r4482 - 2013-06-14
 +
 +
- Bug fix: If resizing an image (e.g. for mipmaps), an INTERNAL ERROR
 +
  appeared sometimes because of an unhandled combination of image type
 +
  and image size (odd height or width). [Thanx to HelloImYourMind]
 +
 +
 
szs v1.19a r4461 - 2013-06-02
 
szs v1.19a r4461 - 2013-06-02
  

Revision as of 14:13, 14 June 2013

Wiimms SZS Tools
File:Wiimms-SZS-Tools.png
Author: Wiimm
Operating Systems: Linux (i386,x86_64),
Mac (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.19b, 2013-06-14
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 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 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.19b r4482 - 2013-06-14

 - Bug fix: If resizing an image (e.g. for mipmaps), an INTERNAL ERROR
   appeared sometimes because of an unhandled combination of image type
   and image size (odd height or width). [Thanx to HelloImYourMind]


szs v1.19a r4461 - 2013-06-02

 - wszst CHECK: Check existence of minimap bones 'posLD' and 'posRU'.
   Read http://szs.wiimm.de/cmd/wszst/check#desc for a list of all tests.

 - Check commands: KMP objects with presence flag == 0 will be handled as
   non existent. This changes the missing files status and the slot proposals.

 - KCL type names synchchronized to Wiki.

 - Bug fix: If a function was searched and a const was defined with the same
   name, a `segmentation fault´ (or similar) occured.

 - New command: wkmpt STARTPOS: Print the start positions of players in
   various formats. See http://szs.wiimm.de/cmd/wkmpt/startpos for details.

 - Patching option --kmp accepts now the keywords LEFT, RIGHT, WIDE and NARROW
   to modify the start options in section STGI.

 - New global option --de: Use german track and arena names.

 - Command FILETYPE --long: Column with version of file format added.

 - wszst EXTRACT/CREATE: The version number of the archive file format is
   stored in and read from the help file 'wszst-setup.txt' to support version
   dependent file formats.

 - BREFF and BREFT:
    - Version numbers are printed in listings with version support.
    - The file format version number is written to 'wszst-setup.txt' on
      extracting and read from read from 'wszst-setup.txt' on creating.
    - The default aligning for BREFT files depends now on the version number.
      It is 0x20 for versions <10 (MKW=9) and 0x40 for versions >9 (NSMB=11).
      At the moment the new alignment for NSMB is not well tested!


szs v1.18a r4404 - 2013-05-01

 - There is a complete new transformation algorithm: All transforming options
   will be used to create a transformation matrix. If using >1 transformation
   steps (see below), the matrices are multiplied to get a final transformation
   matrix. All transformations are now done using this final transformation
   matrix. This is faster and the internal handling is now much easier.

 - New option --next: This option allows and separates up to 10 transformation
   steps. Logical, each point is transformed step by step in the definition
   order. Internally, a final matrix is calculated and all transformations are
   done in a single step by using this final matrix. There are some issues
   transforming KMP object, see http://szs.wiimm.de/opt/next for details.

 - Command MATRIX is now available for all tools with transformation support.
   It was redesigned to control the impact of the new transformation steps.
   See http://szs.wiimm.de/cmd/matrix

 - New option --rot=deg@origin: Define the rotations for 3 axes by one option.

 - New option --arot=deg[@pt1]@pt2: Do an (axis) rotation around the axis
   specified by the 2 points as single transformation step.
   This option is EXPERIMENTAL! See http://szs.wiimm.de/opt/arot

 - New option --ascale=factor@dir: Do an (axis) scaling into the direction
   specified by the vector 'dir' as single transformation step.
   This option is EXPERIMENTAL! See http://szs.wiimm.de/opt/ascale

 - KMP object database updated.


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. It
   seems, that there are unknown references between the files. Use the UPDATE
   command instead to replace single subfiles.

 - Minimaps with an additional bones layer above 'posLD' and 'posRU' (e.g.
   for scaling) are handled incorrect if adjusting the minimap.

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

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=41874"