Difference between revisions of "Wiimms SZS Tools"

From Custom Mario Kart
Jump to navigation Jump to search
(Wiimms SZS Tools v2.42a released)
 
(267 intermediate revisions by 16 users not shown)
Line 1: Line 1:
 +
{| class="textbox float-right grid"
 +
|+ Wiimms SZS Tools
 +
| colspan=2 style="text-align:center" | [[File:Wiimms SZS Tools Logo.png]]
 +
|-
 +
! Author:
 +
| [[user:Wiimm|Wiimm]]
 +
|-
 +
! Operating Systems:
 +
| Linux (i386/x86_64),<br/>Windows (Cygwin), <br/>Mac (x86_64).
 +
|-
 +
! Software Type:
 +
| File manager, decoding and encoding toolset.
 +
|-
 +
! Compression Formats:
 +
| [[Yaz0]], Yaz1, XYZ, BZ, BZIP2, LZ, LZMA, [[WBZ]], [[WLZ]], [[YBZ]], [[YLZ]].
 +
|-
 +
! Archive Formats:
 +
| [[SZS]], [[U8]], [[WU8]], [[LTA]], [[LFL]], PACK, [[RARC]], [[BRRES]], [[BREFF]], [[BREFT]].
 +
|-
 +
! File Formats:
 +
| [[BMG]], [[BTI]], [[KCL]], [[KMG]], [[KMP]], [[MDL0]], [[PAT0]], [[TPL]], [[TEX0]], [[PNG]], [[OBJ]], [[StaticR.rel]], [[main.dol]], [[CT-CODE]], [[LE-CODE]], [[LEX]], [[LPAR]], [[ObjFlow.bin|ObjFlow]], [[GeoHitTableItem.bin|GeoHit]], [[ItemSlot.bin|ItemSlot]], [[minigame.kmg|minigame]].
 +
|-
 +
! Image formats:
 +
| I4, I8, IA4, IA8, RGB565, RGB5A3, RGBA32, C4, C8, C14X2, CMPR.
 +
|-
 +
! Current Version:
 +
| v2.42a, 2024-03-26
 +
|-
 +
! Website:
 +
| [https://szs.wiimm.de/ szs.wiimm.de]
 +
|}
 +
 +
'''Wiimms SZS Tools''' has a punctuation error, but you should see it as a brand name.
 +
 
== Introduction ==
 
== Introduction ==
  
−
'''Wiimms SZS Tools''' should be a set of different tools to manipulate SZS files. All tools are command line tools and run without any interaction. The main goal is to run them in batch files and scripts to automate recurring jobs. At this moment there is only one tool:
+
'''Wiimms SZS Tools''' is a set of different tools to manipulate [[SZS]], [[U8]], [[WU8]], [[LTA]], [[LFL]], [[RARC]], [[BRRES]], [[BREFF]] and [[BREFT]] archives and [[BMG]], [[BTI]], [[KCL]], [[KMP]], [[MDL0]], [[TPL]], [[TEX0]], [[DOL]] 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 9 tools:
−
* '''wszst''' : Wiimms SZS Tool
+
* '''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-CODE]] and [[LE-CODE]] files).
 +
* '''wlect''' : Wiimms LE-CODE Tool (handles [[LE-CODE]], [[LPAR]] and [[LEX]] files)
 +
One main goal is the fully automated [[Wiimms SZS Tools/How To#Replace Track Names|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 [[Wiimms SZS Tools/How To|how to]].'''
  
−
A second tool to change the content of message files is planned.
+
== Main Features ==
−
Both tools together can be used to change the track names of all message files of all languages without interaction.
 
  
−
This toolset will not replace the [[SZS Modifier]] or [[CTools|SZS Explorer]], because they are interative tools with GUI support.
+
* 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 &rarr; [https://szs.wiimm.de/info/cli 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, [[Rotation|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.
  
−
== wszst (Wiimms SZS Tool) ==
+
== Last Features ==
  
−
'''wszst''' is a command driven tool.
+
=== <span id=bmg>Cygwin</span> ===
−
Only a few commands are implemented yet; other will follow.
 
  
−
=== wszst HELP ===
+
As of v2.21a, 2 Cygwin version are supported: One for 32-bit Windows and one for 64-bit Windows.
  
−
The HELP command print the built in help. Type <tt>wszst HELP</tt> for a general help. Add a command to print command specific help:
+
=== <span id=bmg>Porting and other address calculations</span> ===
  
−
<pre>
+
As of v2.25a, tool ''wstrt'' supports address porting from one to all other regions. Therefore the new commands [https://szs.wiimm.de/cmd/wstrt/port PORT] and [https://szs.wiimm.de/cmd/wstrt/port WHERE] were implemented.
  
−
wszst : Wiimms SZS Tool : It can list, analyze, extract and compose
+
As of v2.26a, both commands are improved in many ways. Entered addresses can be real addresses, or file offsets, or cheat codes. By options the user can define the output format (with or without ''0x'' prefix, with or without file offsets, with or without table headers).
−
        SZS files.
 
  
−
Syntax: wszst [option]... command [option|parameter|file]...
+
Please read [https://szs.wiimm.de/cmd/wstrt/port#desc wstrt PORT] and [https://szs.wiimm.de/cmd/wstrt/port#desc wstrt WHERE] for details.
  
−
Commands:
+
== History and Download ==
  
−
  VERSION          : Print program name and version and exit.
+
[[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'''). Other tools were added later. The last added tool is '''wlect''' to manage [[LE-CODE]] and [[LEX]] files. All tools are command line tools to support scripts and fully automated operations.
−
  HELP      | H  : Print help and exit. If the first non option is
 
−
                    a valid command name, then a help for the given
 
−
                    command is printed.
 
−
  TEST            : Test options: All options are allowed, some are
 
−
                    printed.
 
−
  ERROR      | ERR : Translate exit code to message or print a table
 
−
                    with all error messages if not exit code is
 
−
                    given.
 
  
−
  LIST      | LS  : List all sub files of SZS and U8 files.
+
=== Latest Change Log ===
−
  LIST-L    | LL  : List all sub files with size. 'LIST-L' is a
 
−
                    shortcut for 'LIST --long.
 
−
  LIST-LL    | LLL : List all sub files with offset and size.
 
−
                    'LIST-LL' is a shortcut for 'LIST --long
 
−
                    --long'.
 
  
−
  DECOMPRESS | DEC : Decompress SZS files. The default destination is
+
<pre>
−
                    '%P/%N.u8'.
+
szs v2.42a r8989 - 2024-03-26
−
  COMPRESS  | COM : Create compressed SZS files. The default
 
−
                    destination is '%P/%N.szs'.
 
−
  EXTRACT    | X  : Extract all sub files of SZS and U8 files. The
 
−
                    default destination is '%P/%N.d/'.
 
−
  CREATE    | C  : Create SZS files by adding all files of the
 
−
                    directory structure. The default destination is
 
−
                    '%P/%N.szs'.
 
  
−
Type 'wszst HELP command' to get command specific help.
+
- Updated prefix database: Added CTGPS, EX, EXTR, GK2, GK3, GK7, HGSS, HWTA,
 +
  SBSPLCP, SKK, TGO. Removed LCP.
  
−
</pre>
+
- Bug fix for option --lex-purge: The tools occasionally crashed when
 +
  attempting to delete an existing but unneeded LEX file.
 +
 
 +
- Added support for compression methods YBZ and YLZ (Yaz0 header, but
 +
  alternative compressions bzip2 or LZMA). Use one of the new options --cybz,
 +
  --ybz, --cylz or --ylz to select the new methods. LE-CODE supports YLZ.
  
−
=== wszst LIST ===
+
- New option --zero (-z): This option affects the exit status of the
 +
  programs. Instead of an exit status, the value 0 is returned for OK. This
 +
  happens for notices (-v, status<15), warnings (-vv, status<29), errors
 +
  (-vvv, status<115) and fatal errors (-vvvv). The exit status for INTERRUPT
 +
  (112) is never replaced.
  
−
The command '''LIST''' list the sub files of [[SZS File]]s.
+
- Information only: wszst now knows 243 different options.
  
−
<pre>
 
−
wszst LIST|LS : List all sub files of SZS and U8 files.
 
  
−
Syntax: wszst LIST [source]...
+
szs v2.41b r8971 - 2024-02-23
  
−
Options:
+
- Cygwin only: Fixed a silent stack overflow if reordering the tracks.
  
−
  -l --long      If set, the size of each file is printed. If set
+
- New image format TPLx: Technically, TPLx is a TPL file with 2 extensions.
−
                  twice, offset and size are printed.
+
  The main feature is the conversion of width and height so that images with
−
  -H --no-header  Suppress printing of header and footer.
+
  a height >65535 lines can be used. Cup icons are an example of this.
  
−
</pre>
+
- New virtual image type CUPICON: Alias for TPLx.CMPR.
  
−
=== wszst DECOMPRESS ===
 
  
−
The command '''DECOMPRESS''' decompresses a [[SZS File]] and stores the decompressed data into file.
+
szs v2.41a r8953 - 2024-02-17
  
−
<pre>
+
- Update to LE-CODE build 40.
−
wszst DECOMPRESS|DEC : Decompress SZS files. The default destination
 
−
                      is '%P/%N.u8'.
 
  
−
Syntax: wszst DECOMPRESS [szs]...
+
- Updated prefix database: Added LEGO_Racers, Muppet_RM, POD, PP2WB, SR,
 +
  Spyro_1, Wii_U, Zelda_OoT, Zelda_TP, Zelda_WW.
  
−
Options:
+
- wszst ANALYSE prints attribute "license" if file "license.txt" is detected.
  
−
  -d --dest path    Define a destination path (directory/file).
+
- File format LTA supports now an optional list with file extensions. The
−
                      The path may contain escape sequences: %Q is
+
  idea is that tools show the correct file extensions without having to load
−
                    replaced by the fully qualified source name. %P
+
   the entire LTA file for analysis.
−
                    and %F are replaced by the path or by the
 
−
                    filename. %N and %E are replaced by filename
 
−
                    without extension or by the extension.
 
−
  -D --DEST path   Like --dest, but create the directory path
 
−
                    automatically.
 
−
  -E --esc char    Define an alternative escape character for
 
−
                    destination files. The default is '%'. For
 
−
                    Windows (CYGWIN) it is a good choice to set
 
−
                    '-E$'.
 
  
−
  -o --overwrite    Overwrite already existing files without warning.
+
- Command wlect DISTRIB:
−
  -r --remove-dest  Remove already existing files before creating it.
+
    - WU8, WBZ and WLZ files are accepted now.
−
                    If set, --overwrite is ignored.
+
    - Support of new file type USE-LTA (redirection file for LE-CODE).
−
  -u --update       Create only files that do not exist. Already
+
      Instruction lta= of command wlect DISTRIB creates such a file with
−
                    existing files are ignored without warning. If
+
      filename lta.szs if option REDIR is set.
−
                    set, --overwrite and --remove-dest are ignored.
+
    - The new processing options +PR0, +PR1 to +PR60 control the output of
−
</pre>
+
       progress messages.
 +
    - New options for instruction lta=: EXT, REDIR, PR0, PR1 .. PR60.
  
−
=== wszst COMPRESS ===
+
- Command wszst WILDCARDS supports options --sh and --bash to quote results.
  
−
The command '''COMPRESS''' compresses a binary file and creates [[SZS File]].
+
- Command wstrt PATCH and option --add-section:
 +
    - GCT text files are now accepted now and converted to binary data if the
 +
      very first 4 characters are "#GCT".
 +
    - The memory map output with options -vv has been completely revised.
  
−
<pre>
+
- Bug fix for commands wszst NORMALIZE and wszst PATCH: If the content has
−
wszst COMPRESS|COM : Create compressed SZS files. The default
+
  not been changed, then the compression has not been checked. Therefore the
−
                    destination is '%P/%N.szs'.
+
  file was not always normalized.
  
−
Syntax: wszst COMPRESS [source]...
+
- Bug fix for wszst PATCH: A copy to the non existing cache was created even
 +
  if --cache was not set.
  
−
Options:
+
- Implemented support for LE-CODE with 8192 tracks and 2048 cups. For this
 +
  purpose, the BMG messages for mkw-ana had to be moved to other areas.
  
−
  -d --dest path    Define a destination path (directory/file).
+
- wlect dump: Warnings are issued if the tool can manage fewer LPAR settings
−
                      The path may contain escape sequences: %Q is
+
  or fewer track slots than the LE-CODE image offers.
−
                    replaced by the fully qualified source name. %P
 
−
                    and %F are replaced by the path or by the
 
−
                    filename. %N and %E are replaced by filename
 
−
                    without extension or by the extension.
 
−
  -D --DEST path    Like --dest, but create the directory path
 
−
                    automatically.
 
−
  -E --esc char    Define an alternative escape character for
 
−
                    destination files. The default is '%'. For
 
−
                    Windows (CYGWIN) it is a good choice to set
 
−
                    '-E$'.
 
  
−
  -o --overwrite    Overwrite already existing files without warning.
+
  - New global option --le-04x: Use format %04x instead of %03x for LE-CODE
−
  -r --remove-dest Remove already existing files before creating it.
+
  slots to enable uniform slot numbers if slots >4095 are used.
−
                    If set, --overwrite is ignored.
 
−
  -u --update      Create only files that do not exist. Already
 
−
                    existing files are ignored without warning. If
 
−
                    set, --overwrite and --remove-dest are ignored.
 
  
 +
- New LPAR setting: SLOT-04X.
 
</pre>
 
</pre>
  
−
=== wszst EXTRACT ===
+
=== Links ===
  
−
The command '''EXTRACT''' extracts the sub file of source files and copy the files into a directory structure.
+
* [https://szs.wiimm.de/changelog.html Complete History]
 +
* [https://szs.wiimm.de/download.html Downloads]
 +
* [https://szs.wiimm.de/#l-sources Source code]
 +
* [https://szs.wiimm.de/doc/cli Command Line Interface (CLI)]
 +
* [https://github.com/Wiimm/wii-ct-code GitHub: Wiimm/wii-ct-code]
  
−
<pre>
+
== Tools Overview ==
−
wszst EXTRACT|X : Extract all sub files of SZS and U8 files. The
 
−
                  default destination is '%P/%N.d/'.
 
  
−
Syntax: wszst EXTRACT [source]...
+
=== wszst (Wiimms SZS Tool) ===
  
−
Options:
+
'''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.
 +
&rarr; [https://szs.wiimm.de/wszst Tool wszst: Features, commands and options]
  
−
  -d --dest path    Define a destination path (directory/file).
+
=== wbmgt (Wiimms BMG Tool) ===
−
                      The path may contain escape sequences: %Q is
 
−
                    replaced by the fully qualified source name. %P
 
−
                    and %F are replaced by the path or by the
 
−
                    filename. %N and %E are replaced by filename
 
−
                    without extension or by the extension.
 
−
  -D --DEST path    Like --dest, but create the directory path
 
−
                    automatically.
 
−
  -E --esc char    Define an alternative escape character for
 
−
                    destination files. The default is '%'. For
 
−
                    Windows (CYGWIN) it is a good choice to set
 
−
                    '-E$'.
 
  
−
  -o --overwrite    Overwrite already existing files without warning.
+
'''wbmgt''' is a command driven tool to manipulate [[BMG]] (message) files.
−
  -r --remove-dest  Remove already existing files before creating it.
+
<br/>&rarr; [https://szs.wiimm.de/wbmgt Tool wbmgt: Features, commands and options]
−
                    If set, --overwrite is ignored.
 
−
  -u --update      Create only files that do not exist. Already
 
−
                    existing files are ignored without warning. If
 
−
                    set, --overwrite and --remove-dest are ignored.
 
−
</pre>
 
  
−
=== wszst CREATE ===
+
=== wkclt (Wiimms KCL Tool) ===
  
−
The command '''CREATE''' creates a [[SZS file]] by adding all files of the directory structure.  
+
'''wkclt''' is a command driven tool to convert [[KCL]] files into/from binary KCL from/into Wavefront OBJ files.
 +
<br/>&rarr; [https://szs.wiimm.de/wkclt Tool wkclt: Features, commands and options]
 +
<br/>&rarr; [https://szs.wiimm.de/doc/syntax General parser syntax and semantics]
 +
<br/>&rarr; [https://szs.wiimm.de/doc/kcl KCL export and import guide]
  
−
<pre>
+
=== wkmpt (Wiimms KMP Tool) ===
−
wszst CREATE|C : Create SZS files by adding all files of the
 
−
                directory structure. The default destination is
 
−
                '%P/%N.szs'.
 
  
−
Syntax: wszst CREATE [source_dir]...
+
'''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.
 +
<br/>&rarr; [https://szs.wiimm.de/wkmpt Tool wkmpt: Features, commands and options]
 +
<br/>&rarr; [https://szs.wiimm.de/doc/syntax General parser syntax and semantics]
 +
<br/>&rarr; [https://szs.wiimm.de/doc/kmp/syntax KMP text syntax and semantics]
 +
<br/>&rarr; [https://szs.wiimm.de/doc/kmp/func KMP parser functions]
 +
<br/>&rarr; [[Wiimms SZS Tools/KMP|How to edit KMP files]]
  
−
Options:
+
=== wimgt (Wiimms Image Tool) ===
  
−
  -d --dest path    Define a destination path (directory/file).
+
'''wimgt''' is a command driven tool to convert and aptch graphic images:
−
                      The path may contain escape sequences: %Q is
+
* '''wimgt''' supports the file formats [[BREFT]], [[BTI]], [[TEX0]], [[TPL]] and [[PNG]] as export and import type.
−
                    replaced by the fully qualified source name. %P
+
* '''wimgt''' supports the internal image formats I4, I8, IA4, IA8, RGB565, RGB5A3, RGBA32, C4, C8, C14X2 and CMPR (and also different PNG formats).
−
                    and %F are replaced by the path or by the
+
&rarr; [https://szs.wiimm.de/wimgt Tool wimgt: Features, commands and options]
−
                    filename. %N and %E are replaced by filename
 
−
                    without extension or by the extension.
 
−
  -D --DEST path    Like --dest, but create the directory path
 
−
                    automatically.
 
−
  -E --esc char    Define an alternative escape character for
 
−
                    destination files. The default is '%'. For
 
−
                    Windows (CYGWIN) it is a good choice to set
 
−
                    '-E$'.
 
  
−
  -o --overwrite    Overwrite already existing files without warning.
+
=== wstrt (Wiimms StaticR Tool) ===
−
  -r --remove-dest  Remove already existing files before creating it.
 
−
                    If set, --overwrite is ignored.
 
−
  -u --update      Create only files that do not exist. Already
 
−
                    existing files are ignored without warning. If
 
−
                    set, --overwrite and --remove-dest are ignored.
 
−
  -8 --u8          Create an uncompressed U8 file instead of a
 
−
                    compressed SZS file. The default destination
 
−
                    changes to '%P/%N.u8'.
 
−
  -L --logging      Print the internal file list like command LIST.
 
−
</pre>
 
  
−
== Tests ==
+
'''wstrt''' is a command driven tool to manipulate [[StaticR]] files of [[Mario Kart Wii]].
 +
<br/>&rarr; [https://szs.wiimm.de/wstrt Tool wstrt: Features, commands and options]
  
−
I have made several tests with the following files:
+
=== wctct (Wiimms CT-CODE Tool) ===
−
* All files of <tt>Scene/UI/</tt>, but not <tt>Title.szs</tt> (does not work).
 
−
* Some (custom) tracks of <tt>Race/Course/</tt>
 
  
−
The tests:
+
'''wctct ''' is a command driven tool to manage [[CT-CODE]] distributions. It also supports [[LE-CODE]] distributions.
−
* Decompress and compress and decompress again SZS files and compare the results.
 
−
* Extract all files, create SZS and extract again. The both extracted file system are equal.
 
−
* Extract some of the files with SZS Explorer and compare them to my extracted files.
 
−
* Extract all files and create a new SZS files. Then create a new ISO image with the new SZS files and play it.
 
  
−
== Download ==
+
=== wlect (Wiimms LE-CODE Tool) ===
  
−
Download '''Beta Version 0.01a''' of '''Wiimms SZS Tools''':
+
'''wlect ''' is a command driven tool to manage [[LE-CODE]] distributions. See [[LE-CODE/Distribution Tutorial|LE-CODE Distribution Tutorial]] for details.
−
* [http://wit.wiimm.de/download/szs-v0.01a.beta-r2385-cygwin.zip Windows (Cygwin)]
 
−
* [http://wit.wiimm.de/download/szs-v0.01a.beta-r2385-i386.tar.gz Linux/i386 (32 bit)]
 
−
* [http://wit.wiimm.de/download/szs-v0.01a.beta-r2385-x86_64.tar.gz Linux/x86_64 (64 bit)]
 
−
* [http://wit.wiimm.de/download/szs-v0.01a.beta-r2385-mac.tar.gz Mac (universal binary)]
 
  
−
Source:
 
−
* [http://opensvn.wiimm.de/viewvc/wii/branches/public/wiimms-szs-tools/ Browse source (SVN repository)]
 
−
* [http://opensvn.wiimm.de/wii/branches/public/wiimms-szs-tools/ SVN repository (public checkout)]
 
  
 
== Links ==
 
== Links ==
−
* [http://www.mariokartwii.com/f72/wiimms-szs-tools-75689.html Discussion at MarioKartWii.com]
+
* How To
−
* [http://gbatemp.net/t286476-wiimms-szs-tools?view=findpost&p=3559819 Discussion at GBAtemp.net]
+
** [[Wiimms SZS Tools/How To|General How To]]
−
* [http://forum.wii-homebrew.com/board197-pc-tools/p319981-wiimms-szs-tools/#post319981 Discussion at Wii-Homebrew.com] (german forum)
+
** [[Wiimms SZS Tools/KMP|KMP How To]]
 +
** [[Creating a KCL with Wiimms Tools]]
 +
** [[wkmpt DRAW]]
 +
 
 +
* [https://szs.wiimm.de/ Wiimms SZS Tools]
 +
** Features, commands and options: [https://szs.wiimm.de/wszst wszst], [https://szs.wiimm.de/wbmgt wbmgt],  [https://szs.wiimm.de/wkmpt wkmpt], [https://szs.wiimm.de/wimgt wimgt], [https://szs.wiimm.de/wstrt wstrt], [https://szs.wiimm.de/wctct wctct]
 +
** [https://szs.wiimm.de/download.html Downloads]
 +
 
 +
* Graphical user interfaces (GUI)
 +
** [[Wiimm's Tool Manager]]
 +
** [[Speed & Lap Modifier Tool]]
 +
 
 +
* [[KMP]] & [[KCL]] Parser
 +
** [https://szs.wiimm.de/doc/syntax General parser syntax and semantics]
 +
** [https://szs.wiimm.de/doc/kmp/syntax KMP text syntax and semantics]
 +
** [https://szs.wiimm.de/doc/kmp/func KMP parser functions]
 +
** [https://szs.wiimm.de/doc/kcl KCL export and import guide]
 +
** [https://szs.wiimm.de/info/respawn-setup.html Automatic setup of respawn points]
 +
 
 +
* Forums
 +
** [https://gbatemp.net/threads/wiimms-szs-tools.286476/ Discussion at GBAtemp.net]
 +
** [https://forum.wii-homebrew.com/index.php/Thread/28447-Wiimms-SZS-Tools/ Discussion at Wii-Homebrew.com] (german forum)
 +
 
 +
* Misc.
 +
** [[Automated height correction]]
  
 
{{User-Wiimm-Link}}
 
{{User-Wiimm-Link}}
 
[[category:Software]]
 
[[category:Software]]
 +
[[category:Wiimms SZS Tools]]
 +
[[category:LE-CODE]]

Latest revision as of 09:58, 26 March 2024

Wiimms SZS Tools
Wiimms SZS Tools Logo.png
Author: Wiimm
Operating Systems: Linux (i386/x86_64),
Windows (Cygwin),
Mac (x86_64).
Software Type: File manager, decoding and encoding toolset.
Compression Formats: Yaz0, Yaz1, XYZ, BZ, BZIP2, LZ, LZMA, WBZ, WLZ, YBZ, YLZ.
Archive Formats: SZS, U8, WU8, LTA, LFL, PACK, RARC, BRRES, BREFF, BREFT.
File Formats: BMG, BTI, KCL, KMG, KMP, MDL0, PAT0, TPL, TEX0, PNG, OBJ, StaticR.rel, main.dol, CT-CODE, LE-CODE, LEX, LPAR, ObjFlow, GeoHit, ItemSlot, minigame.
Image formats: I4, I8, IA4, IA8, RGB565, RGB5A3, RGBA32, C4, C8, C14X2, CMPR.
Current Version: v2.42a, 2024-03-26
Website: szs.wiimm.de

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

Introduction

Wiimms SZS Tools is a set of different tools to manipulate SZS, U8, WU8, LTA, LFL, RARC, BRRES, BREFF and BREFT archives and BMG, BTI, KCL, KMP, MDL0, TPL, TEX0, DOL 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 9 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-CODE and LE-CODE files).
  • wlect : Wiimms LE-CODE Tool (handles LE-CODE, LPAR and LEX files)

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

Cygwin

As of v2.21a, 2 Cygwin version are supported: One for 32-bit Windows and one for 64-bit Windows.

Porting and other address calculations

As of v2.25a, tool wstrt supports address porting from one to all other regions. Therefore the new commands PORT and WHERE were implemented.

As of v2.26a, both commands are improved in many ways. Entered addresses can be real addresses, or file offsets, or cheat codes. By options the user can define the output format (with or without 0x prefix, with or without file offsets, with or without table headers).

Please read wstrt PORT and wstrt WHERE for details.

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). Other tools were added later. The last added tool is wlect to manage LE-CODE and LEX files. All tools are command line tools to support scripts and fully automated operations.

Latest Change Log

szs v2.42a r8989 - 2024-03-26

 - Updated prefix database: Added CTGPS, EX, EXTR, GK2, GK3, GK7, HGSS, HWTA,
   SBSPLCP, SKK, TGO. Removed LCP.

 - Bug fix for option --lex-purge: The tools occasionally crashed when
   attempting to delete an existing but unneeded LEX file.

 - Added support for compression methods YBZ and YLZ (Yaz0 header, but
   alternative compressions bzip2 or LZMA). Use one of the new options --cybz,
   --ybz, --cylz or --ylz to select the new methods. LE-CODE supports YLZ.

 - New option --zero (-z): This option affects the exit status of the
   programs. Instead of an exit status, the value 0 is returned for OK. This
   happens for notices (-v, status<15), warnings (-vv, status<29), errors
   (-vvv, status<115) and fatal errors (-vvvv). The exit status for INTERRUPT
   (112) is never replaced.

 - Information only: wszst now knows 243 different options.


szs v2.41b r8971 - 2024-02-23

 - Cygwin only: Fixed a silent stack overflow if reordering the tracks.

 - New image format TPLx: Technically, TPLx is a TPL file with 2 extensions.
   The main feature is the conversion of width and height so that images with
   a height >65535 lines can be used. Cup icons are an example of this.

 - New virtual image type CUPICON: Alias for TPLx.CMPR.


szs v2.41a r8953 - 2024-02-17

 - Update to LE-CODE build 40.

 - Updated prefix database: Added LEGO_Racers, Muppet_RM, POD, PP2WB, SR,
   Spyro_1, Wii_U, Zelda_OoT, Zelda_TP, Zelda_WW.

 - wszst ANALYSE prints attribute "license" if file "license.txt" is detected.

 - File format LTA supports now an optional list with file extensions. The
   idea is that tools show the correct file extensions without having to load
   the entire LTA file for analysis.

 - Command wlect DISTRIB:
    - WU8, WBZ and WLZ files are accepted now.
    - Support of new file type USE-LTA (redirection file for LE-CODE).
      Instruction lta= of command wlect DISTRIB creates such a file with
      filename lta.szs if option REDIR is set.
    - The new processing options +PR0, +PR1 to +PR60 control the output of
      progress messages.
    - New options for instruction lta=: EXT, REDIR, PR0, PR1 .. PR60.

 - Command wszst WILDCARDS supports options --sh and --bash to quote results.

 - Command wstrt PATCH and option --add-section:
    - GCT text files are now accepted now and converted to binary data if the
      very first 4 characters are "#GCT".
    - The memory map output with options -vv has been completely revised.

 - Bug fix for commands wszst NORMALIZE and wszst PATCH: If the content has
   not been changed, then the compression has not been checked. Therefore the
   file was not always normalized.

 - Bug fix for wszst PATCH: A copy to the non existing cache was created even
   if --cache was not set.

 - Implemented support for LE-CODE with 8192 tracks and 2048 cups. For this
   purpose, the BMG messages for mkw-ana had to be moved to other areas.

 - wlect dump: Warnings are issued if the tool can manage fewer LPAR settings
   or fewer track slots than the LE-CODE image offers.

 - New global option --le-04x: Use format %04x instead of %03x for LE-CODE
   slots to enable uniform slot numbers if slots >4095 are used.

 - New LPAR setting: SLOT-04X.

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

wctct (Wiimms CT-CODE Tool)

wctct is a command driven tool to manage CT-CODE distributions. It also supports LE-CODE distributions.

wlect (Wiimms LE-CODE Tool)

wlect is a command driven tool to manage LE-CODE distributions. See LE-CODE Distribution Tutorial for details.


Links

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