If you hadn't already heard, the 0.15.0 update makes some modifications to hit effects that break many existing mods. Specifically, CrewCapacity/CrewIdler have been replaced by CrewSource, OverrideTargetNineSlice/OverrideTargetLine/CoverageLine have been modified, ammo now requires a NameKey, and PartCrew/AmmoConsumer "Priorities" has been renamed to "DefaultPriority" and expects a single integer value. While the required changes are pretty straightforward to make, I realize that doing so could be a big hassle for large mods, so I've made another Mod Upgrader to automatically handle those changes.
Note: This upgrader only works with mods that are already compatible with 0.14.15. It will not work with mods that aren't yet compatible with that game version. It is also not really intended to be used by anyone other than the author(s) of a mod. If your favorite mod hasn't been updated to work with 0.15.0, you're welcome to try the upgrader on it, but expect issues.
There are also a few things that the mod upgrader won't handle that you want/need to fix yourself:
- If you're using any custom priorities in the old 3-value format, you'll need to upgrade those by hand to a new single 1-10 value, because the mod upgrader can't read your mind and know what priority you want to use.
- The mod upgrader will automatically add
NameKey = "Misc/Unknown" to all your ammo types so that at least a missing NameKey won't crash the game, but if you don't want your ammo to be called "Unknown", then you'll want to change that to your own name.
- While the mod upgrader should successfully upgrade OverrideTargetNineSlice/OverrideTargetLine/CoverageLine blocks, it tends to mangle the formatting of those pretty bad, so you might want to fix that by copying over the vanilla blocks.
If you would like to use the Mod Upgrader on your mod, follow these steps:
Backup your mod! The Mod Upgrader makes its own copy of a mod when upgrading it in case something goes wrong, but you can never be too safe, so I highly advise you backup your mod before using the upgrader.
Download and install the 0.15.0 update (or latest RC) of Cosmoteer.
Download CosmoteerModUpgrader_0.15.0_v1.zip and extract it to somewhere on your computer. (Do not extract it to your Cosmoteer install folder.)
CosmoteerModUpgrader.exe program! You will first be asked to enter the path of Cosmoteer's installation folder. (That's usually
C:\Program Files\Cosmoteer.) You can either type in the path manually, or (tip!) you can simply click-and-drag the folder straight into the command window to copy the folder path to it. Press enter to confirm the path.
You will next be asked to enter the path of the mod you want to upgrade. (Again, you can simply click-and-drag the folder into the command window.)
The upgrader will then make a copy of your mod by adding a
_upgraded after its folder name. (So if your mod's folder is
MyAwesomeMod, the upgrader will make a copy of it in a folder right next to it called
MyAwesomeMod_upgraded) WARNING: If there is already a folder of that name, IT WILL BE DELETED and replaced with a new copy!
The mod upgrader will now attempt to upgrade the mod! Depending on the size of your mod, this will take between a few seconds to a few minutes, and you should see a bunch of text whizzing by as it upgrades. With any luck, it will finish without crashing.
If the upgrade completes successfully, you should now test your mod to make sure it loads and works properly in 0.15.0. Move it into your
Mods folder (if it's not already there), turn it on, and restart the game. (You may want to also temporarily remove the old version of the mod, just to be 100% sure that you're testing the upgraded version.) Test your mod for any crashes during loading or gameplay or other issues. If something isn't working, please post here describing the problem and providing a link to download your mod so that I can look into fixing the upgrader.
You may have some additional things you need to fix by hand, but hopefully not too many if the upgrader has done its job. Note that the upgrader sometimes produces code that, while it might work just fine, can be pretty ugly and non-ideal, which you may want to clean up. (You may want to use a tool like WinMerge to see what was changed.)
Hopefully this tool will make upgrading existing mods for 0.15.0 much easier. Again, if something's not working right or it screws up an upgrade, please let me know! (And post a link to your mod so I can test it.)