v0.30.0

What's Changed

• Extract non-ML specific helpers into their own package and included in the Game Pack by @Banane9 in #176
• Fix Slot OrderOffset field references by @Banane9 in #180

Full Changelog: v0.29.0...v0.30.0

Installation

To update just the Game Pack, place the provided MonkeyLoader.GamePacks.Resonite.nupkg files into your MonkeyLoader/GamePacks/ folder. You can do the same for the MonkeyLoader.GamePacks.ResoniteModLoader.nupkg if you want to update the RML compatibility package too.

However, it is recommended to do a full install to get all the latest dependencies.
Please follow the instructions below for your operating system.

Windows

• Download the MonkeyLoader-v0.29.0+Resonite-v0.30.0+RML-v4.2.0.1-Windows.zip file.
• Unzip its contents into Resonite's install folder.
• Make sure to remove the -LoadAssembly argument for ResoniteModLoader.dll from your Steam launch options.

You should now have a MonkeyLoader folder and some hookfxr / hostfxr and MonkeyLoaderWrapper files inside your Resonite install. MonkeyLoader will be run automagically when you launch Resonite. You can disable it by adding --hookfxr-disable to your launch options. If you want to keep it there for quick use, you can change it to --hookfxr-disabl for example, and MonkeyLoader will be run once again.

Linux

• Download the MonkeyLoader-v0.29.0+Resonite-v0.30.0+RML-v4.2.0.1-Linux.tar.gz file.
• Extract its contents into Resonite's install folder.
• Prepend ./run_monkeyloader.sh %command% to your Steam launch settings.
• Make sure to remove the -LoadAssembly argument for ResoniteModLoader.dll from your Steam launch options.

You should now have a MonkeyLoader folder and a run_monkeyloader.sh file as well as some MonkeyLoaderWrapper.Linux files inside your Resonite install. MonkeyLoader will be run automagically when you launch Resonite. You can disable it by adding --hookfxr-disable to your launch options. If you want to keep it there for quick use, you can change it to --hookfxr-disabl for example, and MonkeyLoader will be run once again.

Development

If you want to develop mods for MonkeyLoader / Resonite Integration - or applications for Resonite in general - your best approach is using the Remora.Resonite.Sdk. Detailed instructions are available in the readme there. The MonkeyLoader.GamePacks.Resonite.Core package is now available for cross-loader usage as well.

First Launch Notice

If your Resonite Dash looks like this on your first launch with this update, worry not. This update contains a Monkey to force update system facets (anything with a *FacetPreset component). It is implemented such, that it will only be activated by default when your Settings facet is outdated (Yellow-Dog-Man/Resonite-Issues#4701). Simply navigate to the Settings tab and press the refresh icon in the top right corner. This will make resettable item groups available in your settings, which are used by most vanilla settings and the MonkeyLoader mod settings as well.
If you ever need to refresh a system facet again, you can activate the Monkey again in the settings for the Resonite Game Pack.
It can also help you find any system facets on your Dash that are missing the *FacetPreset component. However, they can't be replaced with the templates from the Resonite Essentials folder, as those also don't have them.

v0.29.0

What's Changed

• zh-cn:Polish the keys by @modimobeikete in #172
• Fix for mawk on Ubuntu by @ColinTimBarndt in #173
• Fix SharpFont loading by @Banane9 in #174
• Refactor for the Remora.Rsonite.Sdk by @Banane9 in #175

What's Changed with the RML Compatibility

• Update for Remora.Resonite.Sdk by @Banane9 in ResoniteModdingGroup/MonkeyLoader.GamePacks.ResoniteModLoader#41

Full Changelog: v0.28.1...v0.29.0
Full Changelog for RML Compatibility: ResoniteModdingGroup/MonkeyLoader.GamePacks.ResoniteModLoader@v4.2.0.0...v4.2.0.1
Full Changelog for MonkeyLoader: MonkeyModdingTroop/MonkeyLoader@v0.28.2...v0.29.0

Installation

To update just the Game Pack, place the provided MonkeyLoader.GamePacks.Resonite.nupkg files into your MonkeyLoader/GamePacks/ folder. You can do the same for the MonkeyLoader.GamePacks.ResoniteModLoader.nupkg if you want to update the RML compatibility package too.

However, it is recommended to do a full install to get all the latest dependencies.
Please follow the instructions below for your operating system.

Windows

• Download the MonkeyLoader-v0.29.0+Resonite-v0.29.0+RML-v4.2.0.1-Windows.zip file.
• Unzip its contents into Resonite's install folder.
• Make sure to remove the -LoadAssembly argument for ResoniteModLoader.dll from your Steam launch options.

You should now have a MonkeyLoader folder and some hookfxr / hostfxr and MonkeyLoaderWrapper files inside your Resonite install. MonkeyLoader will be run automagically when you launch Resonite. You can disable it by adding --hookfxr-disable to your launch options. If you want to keep it there for quick use, you can change it to --hookfxr-disabl for example, and MonkeyLoader will be run once again.

Linux

• Download the MonkeyLoader-v0.29.0+Resonite-v0.29.0+RML-v4.2.0.1-Linux.tar.gz file.
• Extract its contents into Resonite's install folder.
• Prepend ./run_monkeyloader.sh %command% to your Steam launch settings.
• Make sure to remove the -LoadAssembly argument for ResoniteModLoader.dll from your Steam launch options.

You should now have a MonkeyLoader folder and a run_monkeyloader.sh file as well as some MonkeyLoaderWrapper.Linux files inside your Resonite install. MonkeyLoader will be run automagically when you launch Resonite. You can disable it by adding --hookfxr-disable to your launch options. If you want to keep it there for quick use, you can change it to --hookfxr-disabl for example, and MonkeyLoader will be run once again.

Development

If you want to develop mods for MonkeyLoader / Resonite Integration - or applications for Resonite in general - your best approach is using the Remora.Resonite.Sdk. Detailed instructions are available in the readme there.

First Launch Notice

If your Resonite Dash looks like this on your first launch with this update, worry not. This update contains a Monkey to force update system facets (anything with a *FacetPreset component). It is implemented such, that it will only be activated by default when your Settings facet is outdated (Yellow-Dog-Man/Resonite-Issues#4701). Simply navigate to the Settings tab and press the refresh icon in the top right corner. This will make resettable item groups available in your settings, which are used by most vanilla settings and the MonkeyLoader mod settings as well.
If you ever need to refresh a system facet again, you can activate the Monkey again in the settings for the Resonite Game Pack.
It can also help you find any system facets on your Dash that are missing the *FacetPreset component. However, they can't be replaced with the templates from the Resonite Essentials folder, as those also don't have them.

v0.28.1

What's Changed

• POSIX compliant Linux script by @ColinTimBarndt in #161
• Update ML dependency and projects for .net 10 and new version by @Banane9 in #163
• Add facet loaded hook and events by @Banane9 in #165
• Add fix for settings root category list not being scrollable. by @Banane9 in #166
• Use resettable config sections by @Banane9 in #153
• Fix load progress by @Nytra and @Banane9 in #151
• Fix stuck loading screen on Linux / with bad fixed phase count by @Banane9 in #167
• Fix Steam API not being loaded by @Nytra and @Banane9 in #168

What's Changed with the RML Compatibility

• Fix incompatible version handling being ignored by @Banane9 in ResoniteModdingGroup/MonkeyLoader.GamePacks.ResoniteModLoader#39
• Adjust contents for RML 4.2.0 by @Banane9 in ResoniteModdingGroup/MonkeyLoader.GamePacks.ResoniteModLoader#40

What's Changed with MonkeyLoader

• Add Console Window Start-Up Style by @ShadowDragon128 in MonkeyModdingTroop/MonkeyLoader#75
• Update to include support for net10 by @Banane9 in MonkeyModdingTroop/MonkeyLoader#79
• Add virtual HandleIncompatibleVersions method to ConfigSection to replace IncompatibilityHandling by @Banane9 in MonkeyModdingTroop/MonkeyLoader#80
• Fix shutdown not working by @Nytra and @Banane9 in MonkeyModdingTroop/MonkeyLoader#73
• Add AssemblyLoadLoadStrategy for pre-net5 by @Banane9 in MonkeyModdingTroop/MonkeyLoader#81

New Contributors

• @ColinTimBarndt made their first contribution in #161
• @ShadowDragon128 made their first contribution in MonkeyModdingTroop/MonkeyLoader#75

Full Changelog: v0.27.3...v0.28.1
Full Changelog for RML Compatibility: ResoniteModdingGroup/MonkeyLoader.GamePacks.ResoniteModLoader@v4.0.0.0...v4.2.0.0
Full Changelog for MonkeyLoader: MonkeyModdingTroop/MonkeyLoader@v0.27.2...v0.28.2

Installation

To update just the Game Pack, place the provided MonkeyLoader.GamePacks.Resonite.nupkg files into your MonkeyLoader/GamePacks/ folder. You can do the same for the MonkeyLoader.GamePacks.ResoniteModLoader.nupkg if you want to update the RML compatibility package too.

However, it is recommended to do a full install to get all the latest dependencies.
Please follow the instructions below for your operating system.

Windows

• Download the MonkeyLoader-v0.28.2+Resonite-v0.28.1+RML-v4.2.0.0-Windows.zip file.
• Unzip its contents into Resonite's install folder.
• Make sure to remove the -LoadAssembly argument for ResoniteModLoader.dll from your Steam launch options.

You should now have a MonkeyLoader folder and some hookfxr / hostfxr and MonkeyLoaderWrapper files inside your Resonite install. MonkeyLoader will be run automagically when you launch Resonite. You can disable it by adding --hookfxr-disable to your launch options. If you want to keep it there for quick use, you can change it to --hookfxr-disabl for example, and MonkeyLoader will be run once again.

Linux

• Download the MonkeyLoader-v0.28.2+Resonite-v0.28.1+RML-v4.2.0.0-Linux.tar.gz file.
• Extract its contents into Resonite's install folder.
• Prepend ./run_monkeyloader.sh %command% to your Steam launch settings.
• Make sure to remove the -LoadAssembly argument for ResoniteModLoader.dll from your Steam launch options.

You should now have a MonkeyLoader folder and a run_monkeyloader.sh file as well as some MonkeyLoaderWrapper.Linux files inside your Resonite install. MonkeyLoader will be run automagically when you launch Resonite. You can disable it by adding --hookfxr-disable to your launch options. If you want to keep it there for quick use, you can change it to --hookfxr-disabl for example, and MonkeyLoader will be run once again.

Development

If you want to develop mods for MonkeyLoader / Resonite Integration, you can reference the MonkeyLoader.GamePacks.Resonite package from NuGet. For the Resonite dependencies, you'll have to reference your local install or the reference packages from this GitHub Organization. However, there'll soon be an SDK available through NuGet too.

First Launch Notice

If your Resonite Dash looks like this on your first launch with this update, worry not. This update contains a Monkey to force update system facets (anything with a *FacetPreset component). It is implemented such, that it will only be activated by default when your Settings facet is outdated (Yellow-Dog-Man/Resonite-Issues#4701). Simply navigate to the Settings tab and press the refresh icon in the top right corner. This will make resettable item groups available in your settings, which are used by most vanilla settings and the MonkeyLoader mod settings as well.
If you ever need to refresh a system facet again, you can activate the Monkey again in the settings for the Resonite Game Pack.
It can also help you find any system facets on your Dash that are missing the *FacetPreset component. However, they can't be replaced with the templates from the Resonite Essentials folder, as those also don't have them.

v0.28.0

There's a critical bug (on some systems) here, please download v0.28.1 instead.

v0.27.3 (preliminary .net 10)

What's Changed

• Change shebang to bash in LinuxBootstrap.sh by @phil-flip in #160
• Update for .net 10 - this is a preliminary release until the proper upgrades to the workflow are done

New Contributors

• @phil-flip made their first contribution in #160

Full Changelog: v0.25.2...v0.27.3

Install

To install the latest versions of MonkeyLoader, the Game Packs for Resonite, and the ResoniteModLoader compatibility package, unzip the provided MonkeyLoader-v0.27.3+Resonite-v0.25.2+RML-v4.0.0.zip (Windows) or .tar.gz (Linux) into Resonite's install folder.
Make sure to remove the -LoadAssembly argument for ResoniteModLoader.dll if you've been using it before.

Alternatively, to update just the Game Pack, place the provided MonkeyLoader.GamePacks.Resonite.nupkg files into your MonkeyLoader/GamePacks/ folder.

To develop with, add the following to your project file or Directory.Build.props file and reference the necessary packages through NuGet:

<PropertyGroup>
        <RestoreAdditionalProjectSources>
            https://nuget.pkg.github.com/MonkeyModdingTroop/index.json;
            https://nuget.pkg.github.com/ResoniteModdingGroup/index.json
        </RestoreAdditionalProjectSources>
</PropertyGroup>

You may also need to add the URLs https://nuget.pkg.github.com/MonkeyModdingTroop/index.json and https://nuget.pkg.github.com/ResoniteModdingGroup/index.json as package sources inside VS and set up package mappings.

v0.25.2

What's Changed

• Fix a bug in CustomInspectorInjector, and a design change by @Nytra in #152
• Check for --hookfxr-disable in Linux bootstrap script by @Nytra in #155
• Fix linux startup (SoundFlow) by @Nytra in #157
• Updated RML game pack to v4.0.0 (NOTE: the zip file is named incorrectly)

Full Changelog: v0.25.1...v0.25.2

Install

To install the latest versions of MonkeyLoader, the Game Packs for Resonite, and the ResoniteModLoader compatibility package, unzip the provided MonkeyLoader-v0.27.2+Resonite-v0.25.2+RML-v3.0.7.zip or .tar.gz into Resonite's install folder.
Make sure to remove the -LoadAssembly argument for ResoniteModLoader.dll if you've been using it before.

Alternatively, to update just the Game Pack, place the provided MonkeyLoader.GamePacks.Resonite.nupkg files into your MonkeyLoader/GamePacks/ folder.

To develop with, add the following to your project file or Directory.Build.props file and reference the necessary packages through NuGet:

<PropertyGroup>
        <RestoreAdditionalProjectSources>
            https://nuget.pkg.github.com/MonkeyModdingTroop/index.json;
            https://nuget.pkg.github.com/ResoniteModdingGroup/index.json
        </RestoreAdditionalProjectSources>
</PropertyGroup>

You may also need to add the URLs https://nuget.pkg.github.com/MonkeyModdingTroop/index.json and https://nuget.pkg.github.com/ResoniteModdingGroup/index.json as package sources inside VS and set up package mappings.

v0.25.1

What's Changed

• Fixed run_monkeyloader.sh line endings and provide .tar file for Linux

Install

To install just the Game Pack, place the provided MonkeyLoader.GamePacks.Resonite.nupkg files into your MonkeyLoader/GamePacks/ folder.
Alternatively, unzip the provided MonkeyLoader-v0.27.2+Resonite-v0.25.1+RML-v3.0.7.zip or .tar.zip into Resonite's install folder to install the latest versions of MonkeyLoader, the Game Packs for Resonite, and the ResoniteModLoader compatibility package.

To develop with, add the following to your project file or Directory.Build.props file and reference the necessary packages through NuGet:

<PropertyGroup>
        <RestoreAdditionalProjectSources>
            https://pkg.munally.com/MonkeyModdingTroop/index.json;
            https://pkg.munally.com/ResoniteModdingGroup/index.json
        </RestoreAdditionalProjectSources>
</PropertyGroup>

You may also need to add the URLs https://pkg.munally.com/MonkeyModdingTroop/index.json and https://pkg.munally.com/ResoniteModdingGroup/index.json as package sources inside VS and set up package mappings.

v0.25.0

What's Changed with the RML Compatibility

• Adjust rml mod loading to load all assemblies before initializing the mods by @Banane9 in ResoniteModdingGroup/MonkeyLoader.GamePacks.ResoniteModLoader#33
  • This should fix any missing dependencies between mods
• Fix ModLoader.IsHeadless property throwing an error by @Banane9 in ResoniteModdingGroup/MonkeyLoader.GamePacks.ResoniteModLoader#34
  • In particular, this fixes ResoniteIkCulling throwing an exception on every IK-Update, every frame

What's Changed with the Integration

• Add new language Simplified Chinese (zh-cn) by @modimobeikete in #146
• Add Linux compatibility by @Banane9 and @l-2-j in #147
  • This requires Resonite to be launched from Steam with Proton enabled
  • Change the steam launch options to ./run_monkeyloader.sh %command%
  • If it's not starting, make sure that the run_monkeyloader.sh and MonkeyLoaderWrapper.Linux.dll are set as executable (chmod +x)

New Contributors

• @modimobeikete made their first contribution in #146

Full Changelog: v0.24.1...v0.25.0

Install

To install just the Game Pack, place the provided MonkeyLoader.GamePacks.Resonite.nupkg files into your MonkeyLoader/GamePacks/ folder.
Alternatively, unzip the provided MonkeyLoader-v0.27.2+Resonite-v0.25.0+RML-v3.0.7.zip into Resonite's install folder to install the latest versions of MonkeyLoader, the Game Packs for Resonite, and the ResoniteModLoader compatibility package. Make sure you followed the special Splittening™ instructions at the top!

To develop with, add the following to your project file or Directory.Build.props file and reference the necessary packages through NuGet:

<PropertyGroup>
        <RestoreAdditionalProjectSources>
            https://pkg.munally.com/MonkeyModdingTroop/index.json;
            https://pkg.munally.com/ResoniteModdingGroup/index.json
        </RestoreAdditionalProjectSources>
</PropertyGroup>

You may also need to add the URLs https://pkg.munally.com/MonkeyModdingTroop/index.json and https://pkg.munally.com/ResoniteModdingGroup/index.json as package sources inside VS and set up package mappings.

v0.24.1 - The Splittening™ and Localizening™

The Splittening™ Instructions

Because this is a significant change from the previous all-Unity version of Resonite, there's some special instructions you have to follow for this upgrade only:

• Remove all Doorstop files from the Resonite folder:
  • .doorstop_version
  • doorstop_config.ini
  • libdoorstop.so
  • run_monkeyloader.sh
  • winhttp.dll
• Remove the netstandard.dll from Resonite/MonkeyLoader
• Remove the old Game Packs from Resonite/MonkeyLoader/GamePacks
  • MonkeyLoader.GamePacks.Unity.nupkg
  • MonkeyLoader.GamePacks.Resonite.Unity.nupkg

Sadly, this is also a Windows-only release for now. We still need to figure out why things are not quite working on Linux. Any help is welcome.

The Localizening™

All of MonkeyLoader and the Resonite Integration is now fully available in the following languages:

• English (@Banane9 & @Nytra)
• German (@Banane9)
• French (@brodokk)
• Japanese (@kazu0617)

Special thanks to @brodokk and @kazu0617 for contributing!
I hope everyone enjoys the extra localizations!

What's Changed with MonkeyLoader

• Add subscribable base events by @Banane9 in MonkeyModdingTroop/MonkeyLoader#62
• Combine Name + Description properties into a Displayable interface. Add it to Loader, Monkeys, and Config Section + Keys by @Banane9 in MonkeyModdingTroop/MonkeyLoader#63
• Implement compatibility with modern .NET by @Banane9, @Nytra, and @goaaats in MonkeyModdingTroop/MonkeyLoader#69

What's Changed

• Make old shared config slots non-persistent by @Nytra in #114
• Don't use world._keys for shared config by @Nytra in #115
• Reenable InstantResoniteLog and make it proxy for UniLog.FlushEveryMessage by @Banane9 in #117
• Make save buttons show up for just monkey toggles as well and add warning if there's unsavable sections by @Banane9 in #118
• Generalize context menu items generation events with bonus InteractionHandler menu features by @Banane9 in #119
• Add ja.json by @kazu0617 in #123
• Allow fallback locale data for mods to be exported from their settings page by @Banane9 in #126
• Make locale loading locations more flexible and split up locale files by @Banane9 in #127
• Add all locale messages for (US) English and German by @Banane9 in #131
• Add French locale by @brodokk in #133
• Add TryOpenTooltipWithDelay method to TooltipManager by @Banane9 in #132
• Implement the Splittening™ by @Banane9, @Nytra, and @goaaats in #144

New Contributors

• @kazu0617 made their first contribution in #123
• @brodokk made their first contribution in #133

Full Changelog: v0.23.1...v0.24.1

Install

To install just the Game Packs, place the provided MonkeyLoader.GamePacks.Resonite.nupkg files into your MonkeyLoader/GamePacks/ folder.
Alternatively, unzip the provided MonkeyLoader-v0.27.2+Resonite-v0.24.1+RML-v3.0.6.zip into Resonite's install folder to install the latest versions of MonkeyLoader, the Game Packs for Resonite, and the ResoniteModLoader compatibility package. Make sure you followed the special Splittening™ instructions at the top!

To develop with, add the following to your project file or Directory.Build.props file and reference the necessary packages through NuGet:

<PropertyGroup>
        <RestoreAdditionalProjectSources>
            https://pkg.munally.com/MonkeyModdingTroop/index.json;
            https://pkg.munally.com/ResoniteModdingGroup/index.json
        </RestoreAdditionalProjectSources>
</PropertyGroup>

You may also need to add the URLs https://pkg.munally.com/MonkeyModdingTroop/index.json and https://pkg.munally.com/ResoniteModdingGroup/index.json as package sources inside VS and set up package mappings.

v0.24.0

THE SPLITTENING / TESTENING pre-release

This is a pre-release for MonkeyLoader + Resonite Integration + RML Integration. Expect errors in the logs, and mods not working (they need to be updated / recompiled), because some things have been moved around. See below for known issues. You don't need to clean up any files when switching between this version and the stable branch - just extract the other version over it again. Mods will need to be replaced too, if they had to make changes.

This currently requires .NET 9.0.6, since the assembly locations are hardcoded for the moment!

What's Changed

• Upgrade injection and setup for .NET 9.0
• Fix locale data injector by @Nytra in #136
• Fix context menu by @Nytra in #137
• Lots more, which will be listed in detail in the proper release!

Full Changelog: v0.23.1...v0.24.0

Install

To install just the Game Packs, place the provided MonkeyLoader.GamePacks.Resonite.nupkg and file into your MonkeyLoader/GamePacks/ folder.
Alternatively, unzip the provided MonkeyLoader-v0.27.0+Resonite-v0.24.0+RML-v3.0.6.zip into Resonite's install folder to install the latest versions of MonkeyLoader, the Game Pack for Resonite, and the ResoniteModLoader compatibility package.

To develop with, add the following to your project file or Directory.Build.props file and reference the necessary packages through NuGet:

<PropertyGroup>
        <RestoreAdditionalProjectSources>
            https://pkg.munally.com/MonkeyModdingTroop/index.json;
            https://pkg.munally.com/ResoniteModdingGroup/index.json
        </RestoreAdditionalProjectSources>
</PropertyGroup>

You may also need to add the URLs https://pkg.munally.com/MonkeyModdingTroop/index.json and https://pkg.munally.com/ResoniteModdingGroup/index.json as package sources inside VS and set up package mappings.

Known Issues

• Integration with Renderite has not been implemented yet - as such there is no fancy loading indicator
• Resolving of dependencies is not working right - mods have been tweaked to ignore dependencies for now
• You may need to delete 0Harmony.dll from the rml_libs folder if you have it.

Known broken Mods

These mods have issues, which may range from simply not working to crashing the game.

• Community Bug-Fix Collection
• FixAltEnter (Unity Dependency)
• LogCleaner
• ResoniteIKCulling (Moved Types)
• ResoniteMetricsCounter
• ShowDelegates (Moved Types)
• TransparentCameraEnabled (Unity Dependency)

Reporting and Discussion

There's a discussion page attached to this pre-release - please make use of it to discuss any problems. If something turns out to be a problem with MonkeyLoader or its Game Packs, please file an issue with the important details and a reference to the discussion thread for it. If you have any ideas or suggestions, please voice them there as well.
We will do what we can to honor your wishes and requests.

Thanks

... to @Nytra for helping getting things up to speed, and @goaaats in particular for the injector idea and application.
This was some pain to debug and get to work, but here we go.