Difference between revisions of "Wiimms SZS Tools"

From Custom Mario Kart
Jump to navigation Jump to search
(Wiimms SZS Tools v1.01a)
(Wiimms SZS Tools v1.02a)
Line 19: Line 19:
 
|-
 
|-
 
! Current Version:
 
! Current Version:
| 1.01a, 2012-07-22
+
| 1.02a, 2012-08-01
 
|-
 
|-
 
! Website:
 
! Website:
Line 40: Line 40:
 
== History and Download ==
 
== History and Download ==
  
* The [[KMP]] tool (command "wkmpt COBJECT") can now create OBJ files to have a 3D view of check points, enemy and item routes and also of cannon shoot and landing points. It is also possible to include the KCL.
+
=== Change Log ===
 +
<pre>
 +
szs v1.02a r3992 - 2012-08-01
 +
 
 +
- KCL: Detect invalid triangles (e.g. length=0) on OBJ import.
 +
 
 +
- Option --kcl: There are now 2 groups of removing commands:
 +
    - 'DROP*' drop unused, invalid or fixed triangles (bad triangles).
 +
    - 'RM*' remove triangles with special characteristics. At this moment
 +
        RM-FACEDOWN is the only command of the 'RM*' class: It will remove all
 +
        face down drivable triangles to avoid KCL glitches.
  
* The KCL creation has been improved. It seem to be necessary to include triangles of neighbor cubes into the triangles lists while creating the octree. This is now done and can be controlled by the constant [http://szs.wiimm.de/doc/kcl#KCL_BLOW KCL_BLOW] and by the option [http://szs.wiimm.de/doc/kcl#SMALL --kcl=small] or [url=http://szs.wiimm.de/doc/kcl#CHARY --kcl=chary].
+
- File DB: Sub files 'kinoko_*.kcl' are now assigned to object group 'kinoko'.
 +
 
 +
- Update of the KMP Object database.
  
If you have created a KCL with a previous version of my tools, use this command to create a new octree. The file ''course.kcl'' will be overwritten with a new and repaired version:
 
wkclt encode course.kcl --kcl drop,new --overwrite
 
  
=== Change Log ===
 
<pre>
 
 
szs v1.01a r3987 - 2012-07-22
 
szs v1.01a r3987 - 2012-07-22
  
Line 58: Line 66:
 
   map of SZS, U8, BRRES and MDL0 files.
 
   map of SZS, U8, BRRES and MDL0 files.
 
   See http://szs.wiimm.de/opt/auto for details.
 
   See http://szs.wiimm.de/opt/auto for details.
 
 
szs v1.00a r3958 - 2012-07-14
 
 
- wkmpt COBJECT --draw=modelist:
 
    - Mode 'JGPT': Draw arrows at respawn positions.
 
    - Mode 'CJGPT' does what the old 'JGPT' did: Draw connections between
 
      check points and respawn positions.
 
    - Mode 'CNPT': Draw arrows instead of lines.
 
 
- New command "wszst MINIMAP": Print and optional patch the releavant minimap
 
  data of a SZS, U8, BRRES or MDL file. Supported patching options: --touch,
 
  --xcenter, --ycenter, --zcenter, --center, --scale, --shift, --xss, --yss
 
  and --zss.
 
  
  
Line 86: Line 80:
 
* [http://szs.wiimm.de/download.html Downloads]
 
* [http://szs.wiimm.de/download.html Downloads]
 
* [http://szs.wiimm.de/#l-sources Source code]
 
* [http://szs.wiimm.de/#l-sources Source code]
* [http://szs.wiimm.de/cgi/mkw/object KMP Object Query]
+
* [http://szs.wiimm.de/doc/cli Command Line Interface (CLI)]
  
 
== Tools Overview ==
 
== Tools Overview ==

Revision as of 04:24, 1 August 2012

Wiimms SZS Tools
File:Wiimms-SZS-Tools.png
Author: Wiimm
Operating Systems: Linux (i386,x86_64),
Mac (ppc,i386,x86_64),
Windows (cygwin).
Software Type: SZS, BMG, KCL, 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, OBJ.
Current Version: 1.02a, 2012-08-01
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.

History and Download

Change Log

szs v1.02a r3992 - 2012-08-01

 - KCL: Detect invalid triangles (e.g. length=0) on OBJ import.

 - Option --kcl: There are now 2 groups of removing commands:
     - 'DROP*' drop unused, invalid or fixed triangles (bad triangles).
     - 'RM*' remove triangles with special characteristics. At this moment
        RM-FACEDOWN is the only command of the 'RM*' class: It will remove all
        face down drivable triangles to avoid KCL glitches.

 - File DB: Sub files 'kinoko_*.kcl' are now assigned to object group 'kinoko'.

 - Update of the KMP Object database.


szs v1.01a r3987 - 2012-07-22

 - Command "wszst MINIMAP" can now automatically adjust the minimap, if the
   new option --auto is set. It analyses MDL section 2 (vertex list) to find
   the minimum and maximum values. Then it makes the ranges 4% wider, store
   the calculated values in 'posRU' and 'posLD' of the MDL and calculate the
   transformation matrices. The command is very flexible and can modify the
   map of SZS, U8, BRRES and MDL0 files.
   See http://szs.wiimm.de/opt/auto for details.


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. Use the 
   UPDATE command instead.

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