Basic hot reload support for mod development #160
Conversation
It seemed to work before but I think calling unity APIs from background threads is undefined behaviour
| /// <para><b>Limitations:</b></para> | ||
| /// <list type="bullet"> | ||
| /// <item><description> | ||
| /// The old assembly does not get unloaded. If you have created any unity game objects or components, |
There was a problem hiding this comment.
This seems rough, not because of needing to destroy stuff in unload but because it makes a reload costly.
There was a problem hiding this comment.
Costly compared to what?
The regular use case should be unchanged, even with EnableHotReload enabled, and only subsequent changes will incur the extra assembly overhead.
And I think even that overhead is not too bad, when developing with scriptengine in nine sols I rarely had to restart the game because it became laggy after too many hot reload cycles.
| string mods = Path.Combine(ManagedPath, "Mods"); | ||
|
|
||
| string[] modDirectories = Directory.GetDirectories(mods) | ||
| .Except([Path.Combine(mods, "Disabled")]) |
There was a problem hiding this comment.
Guessing we are not using modern enough build tooling for c#13 to be supported here
There was a problem hiding this comment.
I can of course revert to the old syntax, it's not a big deal.
However, I think that this is a syntax-only feature and I've been using it locally without problem, so if I were to simply bump dotnet from 6.0 (end of life since November 12, 2024) to 8.0 in the github actions, everything should work even on the old net472 runtime.
There was a problem hiding this comment.
Right, I can't actually make that change in this PR, since the action from main gets used.
|
If you referenced bepinex.scriptengine heavily, make sure everything is on board in terms of licensing. It looks like it probably isn't because
|
I don't think I did? I briefly read their code, but wrote the code here myself. I can of course still add comment crediting the original code for the inspiration. |
jakobhellermann
force-pushed
the
hot-reload
branch
from
26da64d to
0325ec9
Compare
Similar to how BepInEx/ScriptEngine works.
When a file is changed, the old loaded mod will be
Unloaded (only works forIToggleablemods) and the new version of the assembly is loaded next to it. To fix conflicts, the assemblies name gets modified to$originalName-$currentTimestampusing Cecil.Configurable via
EnableHotReload.