search

ResoniteModdingGroup / MonkeyLoader.GamePacks.ResoniteModLoader

MonkeyLoader Game Pack that provides compatibility for ResoniteModLoader.
GNU Lesser General Public License v3.0
4 stars 1 forks source link
harmony mod mods monkeyloader monkeyloader-gamepack resonite rml

readme

ResoniteModLoader Compatibility Game Pack

This Game Pack for MonkeyLoader provides compatibility for ResoniteModLoader (RML).

This means that any RML mods from the rml_mods folder can be loaded directly through MonkeyLoader, without adding RML as a library that Resonite should load. Any libraries from the rml_libs folder will be loaded as well.

Installation

  1. Download MonkeyLoader-v...+Resonite-v....zip from the latest Resonite gamepack release
  2. Extract the zip into Resonite's install folder (C:\Program Files (x86)\Steam\steamapps\common\Resonite)
  3. Download MonkeyLoader.GamePacks.ResoniteModLoader.nupkg gamepack from it's latest release to MonkeyLoader/GamePacks
  4. Remove RML's library launch option from Steam if you had set it up previously

Settings Integration

Because the RML mods are loaded as fully integrated MonkeyLoader mods, they are integrated into the MonkeyLoader Settings Category inside Resonite as well.
The settings files will be created under ./MonkeyLoader/Configs however, so any customized settings will have to recreated or manually copied into the json file.

Screenshot of the Resonite Settings with an RML mod opened in the MonkeyLoader category.

Contributing

Issues can and should be opened here instead of the mods' issue trackers if they're designed for RML, and work with it, but not with this gamepack. The GitHub issues can also be used for feature requests.

For code contributions, getting started is a bit involved due to Resonite-Issues#456. The short summary of it is:

  1. Setup a private nuget feed.
  2. Generate the game's reference assemblies.
  3. Add the nuget feeds (nuget sources Add -Name ... -Source ..., local and either https://pkg.munally.com/MonkeyModdingTroop/index.json & https://pkg.munally.com/ResoniteModdingGroup/index.json)
  4. Run dotnet build, or build with your IDE of preference.

The long version is that you'll probably want to set it up privately on GitHub nuget packages. Though this isn't legal advice and you should check that Resonite's TOS allows it. The feeds can also be directly used from GitHub, though that requires authentication using a PAT.