Store mod instances outside the plugin system

Oct 13, 2025 by talynt.org 13 views

The Curse: Unraveling the Mystery of Harmony Patches

Introduction

Harmony patches are a powerful tool for modding games, allowing developers to modify game code without requiring direct access to the game's source code. However, a recent issue has been reported that affects the behavior of Harmony patches when used in conjunction with multiple assembly mods. In this article, we will delve into the details of this issue, explore its causes, and discuss potential workarounds.

The Issue

The problem arises when two assembly C# mods attempt to patch the same method, using static variables. When the second mod adds its patch, the patch of the first mod begins referencing static variables from the assembly where the first mod was initially loaded. This behavior is not observed when using a single mod at a time, nor when using in-memory mods or hooks instead of patches.

Observations and Analysis

To better understand this issue, we created a set of mods that demonstrate the problem. The mods, available for download, add postfixes to the GameMain.Update method and log the mod instance hash to the console. The log output reveals a peculiar behavior, where the patch of the first mod starts referencing static variables from the assembly where the first mod was initially loaded.

Lua! Version 6da26ff
Cs! Version 6da26ff
[Client] Loading assemblies for CPackage Cursed B
[Client] Assemblies from CPackage Cursed B loaded with Guid 8f55519d-8c06-4e73-94b0-fd4ce2145096.
[Client] Loading assemblies for CPackage Cursed A
[Client] Assemblies from CPackage Cursed A loaded with Guid 40dd2eea-1c9e-459f-a201-98931e1c331e.
[Client] Loading type: ModB
[Client] Loading type: ModA
ModB [33345988] Initialized
ModA [31678442] Initialized
[Client] LuaCsSetup: Completed assembly loading. Total time 661ms.
Using LuaSetup.lua from the Barotrauma Lua/ folder.
patcha
Patch in ModA referencing [31678442]
Patch in ModA referencing [31678442]
Patch in ModA referencing [31678442]
Patch in ModA referencing [31678442]
Patch in ModA referencing [31678442]
Patch in ModA referencing [31678442]
Patch in ModA referencing [31678442]
patchb
Patch in ModB referencing [33345988]
Patch in ModA referencing [31678442]
Patch in ModB referencing [33345988]
Patch in ModA referencing [31678442]
Patch in ModB referencing [33345988]
Patch in ModA referencing [31678442]
Patch in ModB referencing [33345988]
Patch in ModA referencing [31678442]
Patch in ModB referencing [33345988]
Patch in ModA referencing [31678442]
cl_reloadlua
ModB [33345988] Disposed
ModA [31678442] Disposed
Stopping Lua...

Conclusion

The issue described above appears to be a bug in the Harmony patching system or the plugin system. The behavior is not observed when using a single mod at a time, nor when using in-memory mods or hooks instead of patches. This issue prevents the use of two assembly mods that patch the same method, which is a fundamental aspect of Harmony's purpose.

Potential Workarounds

To mitigate this issue, several workarounds can be explored:

Store mod instances outside the plugin system: Mod instances could be stored in a separate location, such as the ModStore, to avoid the issue.
Get the latest assembly and retrieve variables: The latest assembly could be retrieved, and variables could be obtained from there. However, this approach may be too slow for certain use cases, such as updating postfixes.
Use a different patching system: Alternative patching systems, such as hooks, could be used to avoid the issue.

Future Development

To resolve this issue, further investigation and development are required. The Harmony team or plugin system developers should address this bug to ensure seamless modding experiences for users.

Additional Resources

For further information and discussion, please refer to the following resources:

By understanding and addressing this issue, we can create a more robust and efficient modding ecosystem for games like Barotrauma.
The Curse: Unraveling the Mystery of Harmony Patches - Q&A

Introduction

In our previous article, we explored the issue of Harmony patches referencing static variables from the assembly where the first mod was initially loaded. This behavior is not observed when using a single mod at a time, nor when using in-memory mods or hooks instead of patches. In this Q&A article, we will address some of the most frequently asked questions related to this issue.

Q: What is the cause of this issue?

A: The cause of this issue appears to be a bug in the Harmony patching system or the plugin system. Further investigation and development are required to resolve this issue.

Q: Why does this issue only occur when using multiple assembly mods?

A: This issue only occurs when using multiple assembly mods because the Harmony patching system is designed to work with a single mod at a time. When multiple mods are used, the patching system becomes confused, leading to the observed behavior.

Q: Can I use a different patching system to avoid this issue?

A: Yes, alternative patching systems, such as hooks, can be used to avoid this issue. However, this may require significant changes to your mod code and may not be compatible with all mods.

Q: How can I store mod instances outside the plugin system?

A: Mod instances can be stored in a separate location, such as the ModStore, to avoid the issue. However, this may require additional development and testing to ensure compatibility with all mods.

Q: What are the potential workarounds for this issue?

A: Several workarounds can be explored, including:

Store mod instances outside the plugin system: Mod instances could be stored in a separate location, such as the ModStore, to avoid the issue.
Get the latest assembly and retrieve variables: The latest assembly could be retrieved, and variables could be obtained from there. However, this approach may be too slow for certain use cases, such as updating postfixes.
Use a different patching system: Alternative patching systems, such as hooks, could be used to avoid the issue.

Q: How can I report this issue to the Harmony team or plugin system developers?

A: You can report this issue to the Harmony team or plugin system developers by creating a new issue on the Harmony GitHub page or by posting on the Barotrauma Modding Community forums.

Q: What is the current status of this issue?

A: The current status of this issue is that it is being investigated and developed upon. Further updates will be provided as more information becomes available.

Conclusion

The issue of Harmony patches referencing static variables from the assembly where the first mod was initially loaded is a complex problem that requires further investigation and development. By understanding and addressing this issue, we can create a more robust and efficient modding ecosystem for games like Barotrauma.

Additional Resources

For further information and discussion, please refer to the following resources:

By working together, we can resolve this issue and create a better modding experience for all users.