n-epifanov / ONI-Modloader

A modloader for Oxygen Not Included

ONI-Modloader

A modloader for Oxygen Not Included based in Harmony

Example mods for ONI-Modloader: https://github.com/javisar/ONI-Modloader-Mods

Forums in Klei: https://forums.kleientertainment.com/topic/88186-mod01-oni-modloader/

This project uses source code of and is based on:

• https://github.com/zeobviouslyfakeacc/ModLoaderInstaller
• https://github.com/spaar/besiege-modloader
• https://github.com/pardeike/Harmony
• https://forums.kleientertainment.com/topic/81296-mod159-materialcolor-onionpatcher/

Projects

• Injector: It injects the call to the modloader in 'Assembly-CSharp.dll'.
• ModLoader: The modloader itself.
• OnionHook: Just a helper to generate IL code for the Injector.

Example Mods

https://github.com/javisar/ONI-Modloader-Mods

Change Log

• 0.4.0
  • Cosmic Upgrade compatible
  • Merged Killface1980 pull request
    • javisar#8
  • Split repositories for Modloader and Example Mods
• 0.3.3
  • The Mods are no longer included in the Release file
  • Cleanup
  • Added CritterNumberSensor
  • Fixed issues
    • javisar#6
    • javisar#7
• 0.3.2
  • Refactoring. Make Injector independent from Onion patches.
  • Added NoSteamMod
  • Deleted not working mods from the release.
• 0.3.1
  • Added Onion Mods and other mods from Killface1980
  • Added CameraControllerMod
  • Added CustomWorldMod
  • Added DraggablePanelMod
  • Added ImprovedGasColourMod
  • Added MaterialColor Mod
  • Added ONI-Common
  • Added PressureDoorMod
  • Added SensorsMod
  • Added StorageLockerMod
• 0.3
  • First stable version.

Installation

Make sure you're using a fresh install of ONI, meaning you'll need the original/unpatched Assembyl-CSharp.dll and Assembly-CSharp-firstpass.dll as it comes with a clean install. Note: You'll need to re-run the injector every time ONI gets updated.

Click "Clone or Download" for the current version as the releases are currently not up to date.

1. Copy the contents of the "Managed" folder to: ...\OxygenNotIncluded_Data\Managed\
2. Execute 'Injector.exe'. It will create a backups of 'Assembly-CSharp.dll' and Assembly-CSharp-firstpass.dll with the extension ".orig" and a new patched set of dlls.
3. You should now find a folder called "Mods" in your ONI main directory. Otherwise, create "Mods" folder in the ONI main directory.
4. Move or copy all the mods you'd like to use to the newly created "Mods" in the ONI main directory. You can find some mods in https://github.com/javisar/ONI-Modloader-Mods
5. Run the game and check ../OxygenNotIncluded_Data/output_log.txt for any errors.

Please don't report bugs you encounter while mods are active. People at Klei work hard and shouldn't be bothered with bug reports which might originate from mods.

Alternative Installation

1. Download last version in Release section.
2. Unzip in the ONI main directory.
3. Execute 'Injector.exe' (only if you have the unpatched dlls )
4. Copy all wanted mods to "Mods" folder.

Uninstallation

Just rename 'Assembly-CSharp.dll.orig' to 'Assembly-CSharp.dll' and 'Assembly-CSharp-firstpass.dll.orig' to 'Assembly-CSharp-firstpass.dll'

Requirements

• .NET Framework 3.5
• Harmony Patcher
• Mono.Cecil
• Visual Studio 2015

Creating a Mod

1. Copy the following files from ONI folder to the solution folder '\Source\lib'
   • Assembly-CSharp.dll
   • Assembly-CSharp-firstpass.dll
   • Assembly-UnityScript-firstpass.dll
   • UnityEngine.dll
   • UnityEngine.UI.dll
2. Open the solution with Visual Studio.
3. Create a new mod or modify the 'Patches' project.
4. Compile it to generate the mod dll file.

Dlls will be recognized by the mod loader if • they reside in the main mod directory OR • they are inside a subfolder inside a subfolder names 'Assemblies'

Downloads

Choose 'Clone or download'. See Releases section.

Harmony Tutorials

• https://github.com/pardeike/Harmony/wiki/
• https://github.com/roxxploxx/RimWorldModGuide/wiki/SHORTTUTORIAL:-Harmony
• https://github.com/UnlimitedHugs/RimworldHugsLib/wiki/Introduction-to-Patching
• https://github.com/UnlimitedHugs/RimworldHugsLib/wiki/Detouring
• https://oxygennotincluded.gamepedia.com/Guide/Working_with_the_Game_Files

Disclaimer

We do not take any responsibility for broken saves or any other damage. Use this software at your own risk.