A program to help simplify the process of setting up Kirby Hats for EX Characters in Project+Ex builds, based on DesiacX's EX Kirby Hat Quick Start Guide.
Note that this program currently only performs Steps 1, 2, 3, and 5 of the linked guide, and that's about it. As a result, you'll still need to manually perform any other steps involved in the process of getting your hats up and running. Importantly, that means you'll still need to manually edit your characters' "FighterXX.dat" files, copy and rename your source character's hat files, edit "Source/ProjectM/CloneEngine.asm" (if you're working with a Lucario or Samus hat), and compile your GCTs with GCTRM yourself. See included "readme.txt" for more specific use instructions. Additionally, like is mentioned in the guide, there is a limit to how many hats you can add this way. I don't know what that limit is, but it DOES exist, so be mindful of that if you start running into issues.
Important Note: Kirby Hat compatibility is still extremely spotty, most source characters simply don't work. While this may change as fixes are developed for other hats, things are (and will remain) remarkably limited for the time being. For preliminary compatibility information, see this chart.
-
Download the most recent release.
-
Extract the zipped folder into your build's base folder. For instance, P+EX builds would place it into the "Project+" folder (ie. such that the entire folder is where your "pf", "rp", and "Source" folders are).
-
Copy your "KirbyHatEX.asm", "KirbyHat.kbx", and "ft_kirby.rel" files into the program's folder. Ideally, start from fresh, stock P+EX versions of these.
-
Add entries to the included "EX_KirbyHats.txt", as specified in that file.
-
Run the appropriate version of the program for your build (use the "NETPLAY" version for builds using "NETPLAY.GCT" and "NETBOOST.GCT").
-
For each file that the program produces, it will search for that file in the appropriate location in your build. If it's found, it will offer to backup the existing file and copy over the newly edited one. Additionally, if it replaces your "KirbyHatEX.asm" file, and also detects the GCTRM executable, it will offer to run that as well.
Note: If the program replaces your "KirbyHatEX.asm" but doesn't prompt you to run GCTRM, it's because it couldn't find "RSBE01.txt" and "BOOST.txt" (or "NETPLAY.txt" and "NETBOOST.txt", when using the "NETPLAY" version). Make sure those exist in your "Project+" folder, then run the program again.
The program supports 6 boolean command line arguments to affect the program's interactive choices and file output. In order, these are:
- KBXOverride
- RELOverride
- ASMOverride
- GCTOverride
- PressButtonToCloseDisable
- ASMNamesDisable
The first four can be set to either 1 or 0 to force the associated decision to process a value of "Yes" or "No" respectively, or they may be set to "-" to leave the interactive choice intact.
The fifth argument can be set to 1 to remove the need to press a key to close the program after it finishes running.
The sixth argument can be set to 1 to prevent character names from being written into ASM files generated by the program.
So, for instance, the following program call...
"./lavaKirbyHatManager - OFFLINE.exe" 1 1 0 0 1 -
... would force the program to replace the KBX and REL files, not replace the ASM or GCT Files, and skip the "press key to exit" prompt, all without any interaction from the user. Another example would be the following call...
"./lavaKirbyHatManager - OFFLINE.exe" - - - 1 0 -
... which would leave the choices for replacing the KBX, REL, and ASM files intact, but would force the GCT files to be built, and leave the "press key to exit" prompt in place. A final example would be the following...
"./lavaKirbyHatManager - OFFLINE.exe" - - - - - 1
... which would just disable the output of character names in the ASM file generated by the program, leaving all other functionality unaffected.
Lastly, note that all of these command line arguments can be invoked using batch (.bat) files. Just save the command (exactly as you would type it into the command line) into a batch file, then run that file to invoke the program with the specified options! Quite useful if you frequently need to run the program with the same options.