How to mod the game

Windows

1. Change to the previous build
   1. If you’re using Steam, right-click on Opus Magnum
   2. Select Properties
   3. Select Betas, select previous - Public default branch from the dropdown menu

2. Download QuintessentialFirstSetupV1.zip

3. Unzip and copy all contents to Opus Magnum folder

   If you’re using Steam, right-click on Opus Magnum, then select Manage > Browse Local Files to open local Opus Magnum folder

4. Download the latest version of OpusMutatum.exe from github

5. Download the latest version of Quintessential.dll from github

6. Replace both Quintessential.dll and OpusMutatum.exe in your Opus Magnum folder with the downloaded files

7. Run OpusMutatum.exe in Opus Magnum folder

8. If everything went well, there should be a file named ModdedLightning.exe. That is the modded instance of the game. Run it.

   The lower left corner of the start screen should say:

Quintessential v0.5.1 (or later!)
1 mods loaded

9. Now that you have a modded game, add some mods.
   1. Download a zip file from the link. You should download the release, not the source code.
   2. Place it into Opus Magnum\Mods folder that has been generated
   3. Run the modded instance
10. The custom puzzles and solutions will be saved in:
    • Puzzles: C:\Users\[YOU]\Documents\My Games\Opus Magnum\NonSteamUser\custom\
    • Solutions: C:\Users\[YOU]\Documents\My Games\Opus Magnum\NonSteamUser\

Linux

1. Your dependencies are mono and dotnet. You can follow this guide to get dotnet on Linux : https://docs.microsoft.com/en-us/dotnet/core/install/linux. Note that you require both the sdk to build.

2. Change to the previous build

   1. If you’re using Steam, right-click on Opus Magnum
   2. Select Properties
   3. Select Betas, select previous - Public default branch from the dropdown menu

3. Download QuintessentialFirstSetupV1.zip

4. Unzip and copy all contents to Opus Magnum folder

   1. If you’re using Steam, right-click on Opus Magnum, then select Manage > Browse Local Files to open local Opus Magnum folder

5. In a directory that preferably isn't Opus Magnum, run
   git clone https://github.com/QuintessentialOM/OpusMutatum/ and git clone https://github.com/QuintessentialOM/Quintessential.

6. cd OpusMutatum and run dotnet build. Copy the outputs from bin/Debug/net40 into your Opus Magnum folder.

7. Run mono OpusMutatum.exe intermediary in the Opus Magnum folder.

8. Return to the directory in Step 5 and cd Quintessential. Then, open Quintessential.csproj in a text editor.

9. Identify the lines that look like the following,

 <ItemGroup>
   <Reference Include="Ionic.Zip.Reduced">
     <HintPath>Ionic.Zip.Reduced.dll</HintPath>
     <CopyLocal>False</CopyLocal>
   </Reference>
   <Reference Include="Lightning">
     <HintPath>IntermediaryLightning.exe</HintPath>
     <Private>false</Private>
     <CopyLocal>False</CopyLocal>
   </Reference>
   <Reference Include="Mono.Cecil">
     <HintPath>Mono.Cecil.dll</HintPath>
     <CopyLocal>False</CopyLocal>
   </Reference>
   <Reference Include="MonoMod">
     <HintPath>MonoMod.exe</HintPath>
     <CopyLocal>False</CopyLocal>
   </Reference>
   <Reference Include="MonoMod.Common">
     <HintPath>MonoMod.Common.dll</HintPath>
     <CopyLocal>False</CopyLocal>
   </Reference>
   <Reference Include="MonoMod.Utils">
     <HintPath>MonoMod.Utils.dll</HintPath>
     <CopyLocal>False</CopyLocal>
   </Reference>
 </ItemGroup>

Changing the paths in <HintPath> as above. Open your Opus Magnum folder and copy the six files Ionic.Zip.Reduced.dll, IntermediaryLightning.exe, Mono.Cecil.dll, MonoMod.exe, MonoMod.Common.dll and MonoMod.Utils.dll back into your Quintessential folder.

9. Open the Quintessential directory in a terminal and run dotnet build. Copy the outputs from bin/Debug/net452 into your Opus Magnum folder.

10. In your Opus Magnum folder, run mono OpusMutatum.exe.

11. If that went well, you should see several new files. The files named ModdedLightning.bin.x86 and ModdedLightning.bin.x86_64 are the files you will run, depending on your computer's architecture.

12. The lower left corner of the start screen should say

Quintessential v0.4.0
1 mods loaded

13. Solutions are in the directory ~/.local/share/Opus Magnum/NonSteamUser, custom puzzles in the custom subdirectory.