Skip to content

Commit

Permalink
Update documentation [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
pardeike-bot committed Mar 3, 2024
1 parent 0126028 commit e29e6ff
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 38 deletions.
62 changes: 31 additions & 31 deletions docs/articles/new.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,41 +71,41 @@ <h1 id="whats-new">What's New</h1>

<p>Harmony 2 has come a long way since the last release 1.2.0.1. Here are all the changes:</p>
<h4 id="new">New</h4>
<p>CI/CD on Azure, Travis and AppVeyor<br>
Switched to <code>MonoMod.Common</code> for shared low level patching with MonoMod project<br>
Works with more .NET versions<br>
Inline prevention for Mono<br>
4th patch type: <code>Finalizer</code> - for handling and manipulating exceptions<br>
Reverse Patching (original onto one of your stub methods)<br>
Convenience extension methods for <code>CodeInstruction</code><br>
Selective debug log with <code>[HarmonyDebug]</code> annotation - works even with future changes of the method<br>
<code>Prepare</code>/<code>Cleanup</code> will be called even with exceptions during patching<br>
Cleanup can now receive and return the current Exception during patching<br>
Better exception reporting with <code>HarmonyException</code><br>
Automatic documentation generated to <code>https://harmony.pardeike.net</code><br>
AccessTools has methods for declared members<br>
<code>FastAccess</code> now deals with generics<br>
<code>Manipulator</code> transpiler helper<br>
Get IL code from a method<br>
<p>CI/CD with GitHub Actions
Switched to <code>MonoMod.Core</code> for shared low level patching with MonoMod project
Works with more .NET versions
Inline prevention for Mono
4th patch type: <code>Finalizer</code> - for handling and manipulating exceptions
Reverse Patching (original onto one of your stub methods)
Convenience extension methods for <code>CodeInstruction</code>
Selective debug log with <code>[HarmonyDebug]</code> annotation - works even with future changes of the method
<code>Prepare</code>/<code>Cleanup</code> will be called even with exceptions during patching
Cleanup can now receive and return the current Exception during patching
Better exception reporting with <code>HarmonyException</code>
Automatic documentation generated to <code>https://harmony.pardeike.net</code>
AccessTools has methods for declared members
<code>FastAccess</code> now deals with generics
<code>Manipulator</code> transpiler helper
Get IL code from a method
Support for IL InlineSignature (patching methods with CALLI)</p>
<h4 id="fixed">Fixed</h4>
<p>Priority field spelling<br>
<code>Traverse</code> can handle static members<br>
Methods returning struct types are now patchable<br>
Main API is now properly divided into static/instance methods<br>
<code>HarmonyMethod</code> and other high level API throws on null input<br>
Patch sorting<br>
DeepCopy works with nullable types<br>
Patch annotations API cleaned up<br>
<code>FieldRef</code> covers more cases and is simplified<br>
<code>__result</code> assignability checks<br>
Handling <code>__state</code> without Prefix<br>
Debug log writes out full type names<br>
Documentation now uses compiled code snippets for correctness<br>
<p>Priority field spelling
<code>Traverse</code> can handle static members
Methods returning struct types are now patchable
Main API is now properly divided into static/instance methods
<code>HarmonyMethod</code> and other high level API throws on null input
Patch sorting
DeepCopy works with nullable types
Patch annotations API cleaned up
<code>FieldRef</code> covers more cases and is simplified
<code>__result</code> assignability checks
Handling <code>__state</code> without Prefix
Debug log writes out full type names
Documentation now uses compiled code snippets for correctness
<code>Traverse</code> works with inherited fields, properties and methods</p>
<h4 id="changes">Changes</h4>
<p>Removed Self-patching<br>
Renamed <code>Add()</code> extension on <code>IEnumerable&lt;T&gt;</code> and <code>T[]</code> to <code>AddItem()</code> to avoid conflicts<br>
<p>Removed Self-patching
Renamed <code>Add()</code> extension on <code>IEnumerable&lt;T&gt;</code> and <code>T[]</code> to <code>AddItem()</code> to avoid conflicts
<code>HarmonyInstance</code> is now called <code>Harmony</code> and <code>Harmony</code> namespace is now called <code>HarmonyLib</code></p>
</article>
</div>
Expand Down
11 changes: 6 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,11 @@ <h2 id="introduction">Introduction</h2>
<p>Harmony gives you an elegant and high level way to <strong>alter functionality</strong> in applications written in C#. It does this at <strong>runtime</strong> by monkey patching methods unlike other solutions that change the content of dll files.</p>
<p>It supports <strong>Mono</strong> and <strong>.NET</strong> environments on Windows, Unix and macOS except when Unity uses the stripped down NetStandard profile (.NET 4.x profile works fine). Harmony is used in mainstream Unity games and many other applications.</p>
<p>Designed to be used by multiple users (usually called Mods) that would otherwise override each others hooks, it was originally created for the game <a href="https://rimworldgame.com">RimWorld</a> and its large modding community by <a href="https://www.patreon.com/pardeike">Andreas Pardeike</a>.</p>
<p>Enjoy!<br>
<p>Enjoy!
/Andreas Pardeike</p>
<h1 id="getting-started">Getting Started</h1>
<p>Installation is usually done by copying and referencing <a href="https://github.com/pardeike/Harmony/releases">0Harmony.dll</a> from your project or by using the <a href="https://www.nuget.org/packages/Lib.Harmony">Lib.Harmony</a> nuget package.</p>
<p>If you want a single file, dependency-merged assembly, you should use the <a href="https://www.nuget.org/packages/Lib.Harmony">Lib.Harmony</a> nuget package. This is the <strong>preferred</strong> way.</p>
<p>If you instead want to supply the dependencies yourself, you should use the <a href="https://www.nuget.org/packages/Lib.Harmony.Thin">Lib.Harmony.Thin</a> nuget package. You get more control but you are responsible to make all references available at runtime.</p>
<h1 id="documentation">Documentation</h1>
<p>You can learn more about Harmony by using the top menu links. The main section [<a href="articles/intro.html">Harmony</a>] brings you to the full documentation that explains everything about Harmony and gives you lots of high level examples. In the second section [<a href="api/index.html">API Documentation</a>] you can browse the public API and all its methods and classes.</p>
<p>If you find a factual error or if you have feedback about the documentation you are welcome to</p>
Expand All @@ -84,11 +85,11 @@ <h2 id="community">Community</h2>
<p>If you feel stuck or have questions that this site does not answer, feel free to join the official <a href="https://discord.gg/xXgghXR">Discord Server</a> or file a <a href="https://github.com/pardeike/Harmony/issues">GitHub Issue</a>.</p>
<p>Help by promoting this library so other developers can find it. One way is to upvote <a href="https://stackoverflow.com/questions/7299097/dynamically-replace-the-contents-of-a-c-sharp-method/42043003#42043003">this stackoverflow answer</a>. Or spread the word in your developer communities. Thank you!</p>
<h1 id="contact">Contact</h1>
<p>Andreas Pardeike<br>
[email protected]<br>
<p>Andreas Pardeike
[email protected]
twitter: @pardeike</p>
<h2 id="donations">Donations</h2>
<p>Donations keep me going:<br>
<p>Donations keep me going:
<a href="https://www.patreon.com/pardeike">https://www.patreon.com/pardeike</a></p>
</article>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -861,7 +861,7 @@
"output": {
".html": {
"relative_path": "articles/new.html",
"hash": "TxZ1W6tAON14wnGIhKz1hhpvlm5svvi3FrD/yHXrqV0="
"hash": "JJMJFE3U10OyOg55zOqQnGpM28EInGDd4ocMMpYSnCg="
}
},
"is_incremental": false,
Expand Down Expand Up @@ -1076,7 +1076,7 @@
"output": {
".html": {
"relative_path": "index.html",
"hash": "arONXyny3QgSGGjRlj2FdKeCSeq75Z8dEbobnz7tpss="
"hash": "oHE+wstPm/Fz0ced4JwDCZ85ehEu2a2f6hld0CY4MaY="
}
},
"is_incremental": false,
Expand Down

0 comments on commit e29e6ff

Please sign in to comment.