WBZ Converter

From Custom Mario Kart
Jump to: navigation, search

WBZ-Converter is a toolset by Wiimm to simplify the conversions between WBZ files and SZS files.



System Requirements

The toolset is script (batch file) based and runs under Linux, Mac and Windows. It needs no installation, but only a single setup to create the needed patch library. The toolset is portable. You can copy and move the directory to any places, this includes an USB stick. Moving from one operating system to an other or sharing over network between operating systems is also possible.

Setup

Linux and Mac user shall execute the following command once: chmod a+x *.sh

For the very first time, an auto-add library must be created. It contains files needed for the WBZ/SZS patching. The files are extracted from the original track files of an image copy of any original Mario Kart Wii DVD. All SZS files of the DVD directory ./Race/Course/ are needed.

The user has 2 choices:

Use an image 
Copy an image of an original Mario Kart Wii DVD to the subdirectory ./original-image/'. ISO, CISO, WBFS, WDF and WIA files are supported. The toolset will extract the needed track files to ./original-race-course and continues with the next step.
Use SZS files 
Copy all SZS files of './Race/Course/' to the subdirectory ./original-race-course. The tools will create the auto-add library by extracting all needed sub files of the tracks.

If you have done one of above, call create-patch-library.bat for Windows or create-patch-library.sh for all other systems. Read the output for diagnostics.

General Usage

After setup you can use the scripts to convert WBZ file to SZS files or SZS files to WBZ files. Read the console logging output for diagnostics.

convert-WBZ-to-SZS

Place your WBZ files into the subdirectory ./WBZ-to-SZS/ and call (or click) convert-WBZ-to-SZS.bat for Windows or convert-WBZ-to-SZS.sh for all other systems. The script will convert all *.WBZ files to SZS and overwrites already existing SZS files.

Remove unneeded files after conversion.

convert-SZS-to-WBZ

Place your SZS files into the subdirectory ./SZS-to-WBZ/ and call (or click) convert-SZS-to-WBZ.bat for Windows or convert-SZS-to-WBZ.sh for all other systems. The script will convert all *.SZS files to WBZ and overwrites already existing WBZ files.

Remove unneeded files after conversion.

Directories

Here is an overview about all sub directories:

./bin/ 
Place of the tools, dlls and some scripts. Don't touch it.
./original-image 
This directory is only needed during setup. Original images are searched here. It can be deleted after setup.
./original-race-course/ 
This directory is only needed during setup. The original track files are stored here. It can be deleted after setup.
./auto-add/ 
This is the patch library. It is created by the setup and needed for the conversion. Don't touch it.
./WBZ-to-SZS/ 
This directory is used for the conversion from WBZ to SZS. Place your WBZ files here and remove unneeded files after conversion.
./SZS-to-WBZ/ 
This directory is used for the conversion from SZS to WBZ. Place your SZS files here and remove unneeded files after conversion.

History

2013-04-12, ALPHA
  • The idea was born.
  • First fast and dirty implementation based on the ISO Patcher for Wiimms Mario Kart Fun.
2013-04-14, BETA1
  • Unneeded tools removed.
  • Scripts optimized (error handling improved).
  • Doku written.
2013-04-xx, comming soon
  • Wrong logging message in convert-WBZ-to-SZS fixed.
  • Planning some more scripts like center-minimap, fix-kcl, drop-facedown, remove-aiparam. It's so easy to implement them with the toolset environment.


Download and Discussion