Rivet is a modding toolkit for Scrap Mechanic. It gives you a clean way to inject DLLs into the game process and to load mods in a structured, discoverable way.
At a high level Rivet consists of:
RivetDoorstop: gets a DLL into the game as early as possible using DLL hijacking. You can imagine this alike to Unity Doorstop.RivetLoader: discovers and loads mods, using metadata and interfaces where available. You can imagine this like BepInEx.RivetLib: the library that mods use to integrate with Rivet, similar in spirit to how BepInEx and Harmony are used for Unity. You can imagine this like BepInEx's API and Harmony.
If you just want to get started, the Installation Guide walks through setting up Rivet for a game, and the Overview explains how these pieces fit together.
Warning
Currently under heavy development, not ready for real use.
Note
Please refer to the Installation Guide to set up Rivet for Scrap Mechanic. There is also an Overview document that explains how Rivet works and what each component does.
This project would not exist without the help and feedback of many people.
- @VeraDev0: For contributing to the repository and helping development
- @QuestionableM: For helping with proxying knowledge (e.g. for prompting me to look into asm thunks for proxying DLL exports).
- @crackx02: For helping debug various issues with the DLL loading process.
- Everyone in the @ReDoIngMods organization for ideas, testing, and general support.