Brought to you by Mike1072 and CamDawg

This utility is designed to simplify the creation of mod packages for different operating systems. Once everything has been set up, you will be able to create a Windows, OS X, and Linux package for your mod with one double-click.

This was created in conjunction with Real Mod, a fully-functioning mod that exists to showcase how to use this packaging utility and demonstrate the current best practices for audio conversion, character set handling, and tileset decompression. When packaging your mod for the first time, you will need to copy and modify some of the files included in Real Mod.

1. Place the contents of this repository in a folder named ModPackaging.
2. In the directory that contains the ModPackaging folder, create a folder for your mod. Place the files and folders for your mod that would normally be extracted to the IE game directory there. You do not need to include WeiDU.
3. In the directory that contains the ModPackaging folder, create a folder named RealMod and place the contents of Real Mod there.

When that's done, you should have one directory containing 3 folders: ModPackaging, RealMod, and YourModNameHere.

1. The G3 icons were officially updated in 2015, so make sure to grab the latest .bmp and .ico files from the RealMod\real_mod\style directory. The banner file format had to be changed, so your mod needs the new files for packaging to succeed.
2. Modern versions of OS X cannot run the old sox and tisunpack programs that are included in many mods. If your mod has audio, grab the latest sox from the RealMod\real_mod\audio directory. If it has tilesets, grab the latest tisunpack from the RealMod\real_mod\tiz\osx directory.

1. Create a copy of RealMod\package_mod.bat and place it in the folder for your mod.
2. Use a text editor to open package_mod.bat in the folder for your mod. Follow the included instructions to modify the file so that it reflects the properties of your mod.
3. Run package_mod.bat in the folder for your mod to create mod packages for all appropriate operating systems.

For future updates to the mod, you only need to update the version number in package_mod.bat and then run it.

1. Make sure you have the following tools available in your $PATH: sed, tar, gzip and zip. Unlike the Windows version, they are not included with the mod. On most Linux distributions, they are likely already there. If not, follow your distribution's instructions for installing the appropriate packages.
2. Create a copy of RealMod/package_mod.sh and place it in the folder for your mod.
3. Use a text editor to open package_mod.sh in the folder for your mod. Follow the included instructions to modify the file so that it reflects the properties of your mod.
4. Run bash package_mod.sh in the folder for your mod to create mod packages for all appropriate operating systems.

For future updates to the mod, you only need to update the version number in package_mod.sh and then run it.

Notes for Linux:

• Creating a Windows self-extracting archive on Linux is currently not possible. The Windows archive will be a regular zip file instead.
• The option to lower-case all filenames is disabled by default, as messing with case tends to do bad things on Linux, especially in EE games. If you enable it, make sure you have the tolower tool from WeiDU in your path.

Comments about the packaging utility can be directed to this forum thread. If the thread is inaccessible, you can contact Mike1072 on the Gibberlings Three forums.

Version 13 - December 13, 2019

• Added md2html for generating HTML versions of any Markdown files in the root directory of the mod and including them in the mod folder during packaging.

Version 12 - March 2, 2019

• If you want zip files instead of SFX packages for Windows, you can use the new build_windows_zip parameter instead of build_windows. For non-Windows users there is no change since the tool has always built zip files for Windows.

Version 11 - January 27, 2019

• Tool now supports tile2ee formats with new tile2ee_folder parameter

Version 10 - October 25, 2018

• Changed format of Linux and Mac packages from .tar.gz to .zip

Version 10 - October 25, 2018

• Changed format of Linux and Mac packages from .tar.gz to .zip

Version 9 - August 10, 2018

• Updated to WeiDU v246

Version 8 - March 31, 2018

• Updated to WeiDU v244
• Now supports spaces in version numbers (e.g. "Beta 1")

Version 7 - October 3, 2016

• Updated to WeiDU v240

Version 6 - September 13, 2016

• Updated to WeiDU v239

Version 5 - December 29, 2015

• Rewrote .bat files so they will function when called from a separate folder

Version 4 - March 7, 2015

• Updated to WeiDU v238
• Added option to prevent lowercasing filenames
• Fixed archive creation when .tp2 is outside of mod folder

Version 3 - February 15, 2015

• Replaced fnr with sed to improve compatibility under Wine, thanks to AstroBryGuy

Version 2 - January 6, 2015

• Updated to WeiDU v237
• Replaced OS X version of tisunpack with a more compatible one provided by StefanO

Version 1 - October 3, 2014

• Initial release packaged with WeiDU v236