Git Product home page Git Product logo

harmony's Introduction

Harmony

v1.1.0 Documentation

A library for patching, replacing and decorating .NET and Mono methods during runtime.


Harmony gives you an elegant and high level way to alter the functionality in applications written in C#. It works great in games and is in fact well established in games like

  • Rimworld
  • BattleTech
  • The Long Dark
  • Oxygen Not Included
  • Subnautica
  • 7 Days To Die
  • Cities: Skylines
  • Kerbal Space Program
  • Besiege
  • Stardew Valley
  • Staxel
  • Total Miner
  • Ravenfield
  • The Ultimate Nerd Game

It is also used in unit testing Windows Presentation Foundation controls and in many other areas.

If you develop in C# and your code is loaded as a module/plugin into a host application, you can use Harmony to alter the functionality of all the available assemblies of that application. Where other patch libraries simply allow you to replace the original method, Harmony goes one step further and gives you:

  • A way to keep the original method intact

  • Execute your code before and/or after the original method

  • Modify the original with IL code processors

  • Multiple Harmony patches co-exist and don't conflict with each other

Please check out the documentation on the GitHub Wiki or join us at the official discord server

Also, an introduction to Transpilers: Simple Harmony Transpiler Tutorial


Help by promoting this library so other developers can find it. One way is to upvote this stackoverflow answer. Or spread the word in your developer communities. Thank you!

For more information from me and my other open source projects, follow me on twitter: @pardeike

Hope you enjoy Harmony!


Email: andreas@pardeike.net Twitter: @pardeike MIT License

harmony's People

Contributors

0x0ade avatar amperl avatar bugproof avatar kittyfisto avatar pardeike avatar wasabii avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.