Harmony

Description

Some mods use something called "Harmony" which helps authors change the existing game code. It's an open-source library and is updated periodically, meaning two mods may be using different versions. The current workflow is to put the 0Harmony.dll file directly in your Mods folder. This can cause a problem if one mod is relying on a newer version of Harmony and you install a different mod that includes a different Harmony version. Of course, this could lead to unexpected errors and mostly comes down to which mod loaded first.

On the other hand, if an author didn't include Harmony at all in their mod files and required a manual install, it won't automatically notify the user in game if Harmony isn't present since it can't be named as a dependency. This will also cause problems with the mod.

Note

This is an unofficial distribution of the original Harmony library, created as an easier way to manage the external Harmony dependency for mod projects. It is open-source, repository at Daggerfall. Harmony.

Installation

This mod should always be at the top of your load order. Any other mod that says it should be at or near the top, should be loaded after this one. This ensures any mods using Harmony that don't add it as an explicit dependency don't cause problems. This mod cannot be used with the android version of Daggerfall Unity.

For Players

You probably don't need this mod if you weren't directed to install it by a mod in your mod list. It is only intended to ensure all mods in a mod list are using the latest version of Harmony to limit conflicts.

For Modders

You should reference the 0Harmony.dll in your C# project, or preferably use the Lib. Harmony NuGet package. You do not need to include 0Harmony.dll in your final .dfmod. You do not need to - and should not - include 0Harmony.dll in your distributed mod, for instance by trying to place it in the StreamingAssets\Mods or Managed folders. This mod handles the player side for you.

You do need to add "daggerfall.harmony" as a dependency for your mod when building your mod in Unity. The resulting dfmod.json should then add an entry that looks like

"Dependencies": [

"Name": "daggerfall.harmony",

"IsOptional": false,

"IsPeer": false

Version Explanation

The mod version combines the current Harmony version used and adds our build id after it. For instance, 2. 4. 2. 1 indicates the Harmony version of 2. 4. 2 and the current Daggerfall. Harmony build id is 1.

Documentation

Check out the docum