Quick Start:
------------------
If you want to work on the HPK LUA source code of the game..
Use: Tool-Menu.bat
The Initialization script will take care of it all for you.
Everything will be placed into the [source] folder.
------------------

That same tool menu also let's you manually Backup/Restore Unpack/Pack and Decompile.
It will ask you for an HPK pack name. So if you want to Unpack Lua.hpk, just type Lua.

You can still use hpk.exe and java unluac.jar however you want.
I just made this tool to simplify the process, to bake it into a standard all-in-one process.
And to remove powershell as a dependency.

This CAN be used to overwrite HPK's in the game folder.
But we warned: the decompiler isn't perfect -- you will encounter problems.
Which is why I made the DLC...


## SAD Enabler DLC
------------------
If you want the bundled DLC that enables mods and allows customization of Max Characters from pre-game-setup..
Use: deploy-dlc.bat
This will drop the DLC hpk into the games DLC folder.
Which upon autorun.lua execution, enables mods by default.
The game's options menu now has a new tab called [X] (to be short), with customizations to toggle stuff.
------------------

Features:
- Enable Mod Manager
- Force Load All Mods
- Allow customization of Max Survivors. Use game Options menu to configure it.
- Toggle switch for:
- Enable Developer
- Enable Cheats

## True Modding
------------------
If you want to deploy mods to the game easily..
Use: deploy-mods.bat
This will deploy the Mods in the Mods\ folder as-is, so you can enable them in-game.

This package came with two mods, the ones I made for myself.
They are customizable (from Options menu in-game).
------------------

Features:
- HumanTweaks
Allows customization of the humans a bit.. Movement speed only affects survivors who aren't undergoing an ailment. Intentional, to keep gameplay mechanics decent. Tweak it if you don't like it. :)
- RecipeTweaks
Allows customization of some recipes..

you can modify the ones I made included in this bundle.
You can also create a new folder inside Mods\ for your own mod. It's the same as Surviving Mars functionally, so just el-goog search for guides.


Note:
If you goto the in-game options menu and the new [X] tab, and set the [Always Load Mods] feature to [ON], then the "Mod Manager" will disappear from the Main Menu.
This is intentional.
Because you are forcing all mods to load, as opposed to choosing them with the Mod Manager. What's the point of a mod manager if all mods are running?
By default it's off. So you will see "Mod Manager" in the menu upon first boot.

Mod Manager:
This feature is a work in progress by the game developers. NOT by me.
I found the underlying UI, and am forcing it to be shown; which is not what they intended whatsoever.
But it works, barely.
!! WARNING !!
!! IMPORTANT !!
DO NOT click the "Close Mod Editor" at the bottom left. I don't know why it's broken. It just is. Hard freezes the game..
Just push Escape (ESC) key when you are done to return to main menu after toggling whatever mods you want on or off.

I coded this with future support in mind, in the case that the developers release the inevitable "Modding" dlc.
There's explicit references to it in their LUA, so yea.
When it's detected, this feature will self disable.




Oh.. almost forgot.
The tools\ folder contains the source code for the ModHelper tool, as well as setup scripts to compile HPK and luadec from scratch.
You don't need to worry about it, unless you do. If you know what I mean.

The code is yours, do what you need/want with it. :)