Difference between revisions of "Wiimms SZS Tools"
(Wiimms SZS Tools v1.62b released (bug fix)) |
(Wiimms SZS Tools v1.62d released) |
||
Line 25: | Line 25: | ||
|- | |- | ||
! Current Version: | ! Current Version: | ||
− | | v1. | + | | v1.62d, 2018-11-11 |
|- | |- | ||
! Website: | ! Website: | ||
Line 95: | Line 95: | ||
<pre> | <pre> | ||
+ | szs v1.62d r7634 - 2018-11-11 | ||
+ | |||
+ | - DOL detection improved. | ||
+ | - Tool wstrt: After patching main.dol for Wiimmfi.de, the HTTP header | ||
+ | "Host: DOMAIN" is not longer sent twice. | ||
+ | - Tool wstrt: Patching and analysing of DOL files improved. | ||
+ | - Tool wstrt automatically patch main.dol to support the new login method | ||
+ | at Wiimmfi.de, when using option --wiimmfi. | ||
+ | |||
+ | |||
+ | szs v1.62c r7630 - 2018-11-10 (not released) | ||
+ | |||
+ | - wstrt --add-section FILE: If a single file is not found and the filename | ||
+ | (not path) contains at least 1 '@' character, then all '@' characters of | ||
+ | it are replaced by the region code (one of P,E,J,K) for a second try. | ||
+ | - New option for Command wstrt HEXDUMP: --sname=LIST: Select addresses to | ||
+ | dump by section names. | ||
+ | |||
szs v1.62b r7624 - 2018-11-08 | szs v1.62b r7624 - 2018-11-08 | ||
Line 126: | Line 144: | ||
status line and exit with an appropriate status code. | status line and exit with an appropriate status code. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
</pre> | </pre> | ||
Revision as of 16:36, 11 November 2018
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. |
Image formats: | I4, I8, IA4, IA8, RGB565, RGB5A3, RGBA32, C4, C8, C14X2, CMPR. |
Current Version: | v1.62d, 2018-11-11 |
Website: | szs.wiimm.de |
Wiimms SZS Tools has a spelling error, you should see but as a brand name.
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.
Last Features
Ignoring small triangles
Sometimes, the imported file contains very small triangles with an area smaller than 1 unit2. They were accidentally inserted into the model by the user. Because of the littleness, the user will not see them in the model view of its 3D Tool. However, machines like the KCL importer of these tools see them and insert them into the KCL — this is not a bug of the tools. The Wii has (mathematical) problems to use them in a correct way with the result of KCL glitches like mini walls on the road.
As of v1.58a there exist 2 new options: --tri-area=EXPR and --tri-height=EXPR[1] to filter out too small triangles.
Option --tri-area=EXPR defines the minimal area size of KCL triangles. The intention is to ignore triangles that are generally to small. EXPR is a floating point number or expression. Triangles are invalidated if their area size is smaller than EXPR. Values between 0.01 and 4.0 are recommended. The careful value 1.0 is used as default. Value 0 disables this filter functionality.
Option --tri-height=EXPR defines the minimal height of KCL triangles. The intention is to ignore deformed triangles (very slim, but long). EXPR is a floating point number or expression. Triangles are invalidated if at least 1 of the 3 heights is smaller than EXPR. Values between 0.01 and 2.0 are recommended. The careful value 1.0 is used as default. Value 0 disables this filter functionality.
The tests for both options are executed after reading files, after transformations, and after calculating normals and lengths.
KMP section WIM0
Version 1.59a supports the new KMP section »WIM0«. The idea is to store settings of a KMP text file into the binary KMP and restore theses settings on extraction.
At the moment, only creation of section WIM0 without payload is possible to check the compaitibily of other tools. The Wii has no problem with additional and unknown sections; it simply ignores them.
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
szs v1.62d r7634 - 2018-11-11 - DOL detection improved. - Tool wstrt: After patching main.dol for Wiimmfi.de, the HTTP header "Host: DOMAIN" is not longer sent twice. - Tool wstrt: Patching and analysing of DOL files improved. - Tool wstrt automatically patch main.dol to support the new login method at Wiimmfi.de, when using option --wiimmfi. szs v1.62c r7630 - 2018-11-10 (not released) - wstrt --add-section FILE: If a single file is not found and the filename (not path) contains at least 1 '@' character, then all '@' characters of it are replaced by the region code (one of P,E,J,K) for a second try. - New option for Command wstrt HEXDUMP: --sname=LIST: Select addresses to dump by section names. szs v1.62b r7624 - 2018-11-08 - Bug fix for new parser STRING support. szs v1.62a r7620 - 2018-11-07 - Windows version only: Update to Cygwin 2.11.1. - Cygwin bug fix: Color support failed, if tools started in a Windows console window or as script outside a Cygwin window. - The text parser (mainly used to scan KMP text files) supports the new data type STRING. Different string functions and command @EXEC added. - Battle arena detection improved. - New command: wstrt HEXDUMP: Dump the content of a DOL file ordered by the memory addres. Enter "wstrt help hexdump" to get a list of the many ouput formatting options. szs v1.61a r7601 - 2018-09-23 - Bug fix for the new route analysis (e.g. wkmpt DRAW): The positions were wrong (e.g. NAN or too large) when analysing ITPT. - New command: wszst ISARENA: Check the arena status of a SZS file, print a status line and exit with an appropriate status code.
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
- Graphical user interfaces (GUI)
- Forums
- Discussion at GBAtemp.net
- Discussion at Wii-Homebrew.com (german forum)
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
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