Originally posted by Ipsquiggle on the official forums
Hello modders!
Over the course of this last year, many in this community have requested that we update the version of Harmony that we ship with the game, in order to smooth out mod development and make sure modders have access to the latest features the Harmony API provides!
In the testing period beginning June 10th, we will be shipping Harmony 2.0.4.0 on the Public Testing branch.
This upgrade will require modders to update all .dll mods!
It is also the case that the major code changes we're doing right now are going to break a significant number of mods, and later when the Vanilla and DLC codebases are finally fully merged, all the existing Vanilla .dll mods will have broken anyways. We'd rather not break any mods at all, but since it's going to happen, we're opting to put all the breakage into a single update, and this gives you some time to prepare.
The Mergedown Process -- Use mod_info.yaml
As we unify the codebases, all these changes (including the Harmony 2.0 update) will slowly roll down through various versions of the game, like this:
Spaced Out Public Testing -> Spaced Out (all players) -> Oxygen Not Included Public Testing -> Oxygen Not Included (all players)
So mods running on Spaced Out will have to be updated first, and will have this testing period to get updated before all Spaced Out players see the code changes.
The changes to the base game will happen some time after that, though specific dates are still being determined.
Once your mod has been made compatible, it will remain compatible for the rest of the Mergedown. (Breakage from normal ongoing development aside ;) ) Be sure to use mod_info.yaml and the archive folder to separate the versions of your mod and make the transition seamless for your users! (More details below)
How do I update my mod?
There are three key changes you'll need to make:
- Change all using Harmony; to using HarmonyLib; in your code
- If you use OnLoad(HarmonyInstance harmony), change it to OnLoad(Harmony harmony)
- Install the .net 4.8 developer pack, and retarget your project at .net 4.8.
Additionally:
- A number of methods in Harmony have changed signature or scope, so various compile errors will have to be resolved
- As always, a number of changes have happened in the ONI code, so those errors will have to be resolved
- Update your mod_info.yaml as described below for best compatibility. NOTE! If you're currently using a single version of your mod that runs on Vanilla and Expansion1, you will likely want to two versions of the mod for the duration of this Harmony 2.0 rollout.
- Finally, upload the new version of your mod!
So what's new, anyways?
Here's the official Harmony update information.
Here's the full list of patch notes (Reminder, we're on 2.0.4.0, catching up from 1.2.0.1).
The full Harmony 2.0 documentation.
In Conclusion
Please let me know if there are any gotchas or missing steps I should include in this post!
A huge thanks to everyone in this community! I know from personal experience how much work it is to keep modding a game that is in active development, but the champions here nonetheless have made a workshop full of amazing mods! It's always exciting to browse through and see what's new, and to get the chance to play visions of the game that are different than our own. How cool is it that these things can co-exist side-by-side? So again, THANK-YOU!
mod_info.yaml for Hamony changes can be found on the post on our official forums here.