8,290
edits
Modding:Harmony: Difference between revisions
m
Softened the language a bit. These are good points, but I think it's going too far to say that Harmony is buggy. A well-implemented Harmony patch will be efficient, resilient against game updates, and compatible with other mods.
(Added details on when to avoid Harmony Patches) |
m (Softened the language a bit. These are good points, but I think it's going too far to say that Harmony is buggy. A well-implemented Harmony patch will be efficient, resilient against game updates, and compatible with other mods.) |
||
| Line 6: | Line 6: | ||
For a primer on using Harmony to patch game methods, see [https://harmony.pardeike.net/articles/patching.html this article]. | For a primer on using Harmony to patch game methods, see [https://harmony.pardeike.net/articles/patching.html this article]. | ||
While Harmony Patches are powerful and are often the easiest and most | While Harmony Patches are powerful and are often the easiest and most direct way to modify behaviour, they are more prone to incompatibility with other mods and future updates, and they can be more difficult to debug or troubleshoot if something goes wrong. A Harmony patch should be considered a last resort only if the desired functionality cannot otherwise be achieved by using the existing part and event infrastructure available in the game, or another similar solution. | ||
That said, there do remain some situations in which | That said, there do remain some situations in which Harmony patches are required in order to affect certain functionality. In these cases, Postfix patches tend to be the most compatibility friendly, followed by non-blocking Prefix patches. Prefix patches that prevent the main function from running or Transpiler Patches that modify the IL Code of a function are often more likely to conflict with other mods and should be avoided unless they are the only option. | ||
== Example: Chaotic-Colored Message Text == | == Example: Chaotic-Colored Message Text == | ||