Install

What you need

  1. Obenseuer 0.5.08 (Steam build 25969064).
  2. BepInEx, the free tool that loads mods into the game. Get 5.4.23 or later (Mono, x64), or BepInEx 6 Unity.Mono, x64, be.788, the tested build. Newer BepInEx 6 builds usually work. BepInEx 6 is a pre-release, so a new build can break mods. If something breaks, use be.788. For BepInEx 5, download the zip from the BepInEx releases page. Its name starts with BepInEx_win_x64_5.4. For BepInEx 6, download it from builds.bepinex.dev. This game is a 64-bit Windows game that runs on Unity’s Mono, so pick “Mono” and “x64”. Do not pick the IL2CPP or x86 files.
  3. The framework zip from the GitHub releases page. It holds a BepInEx 6 build and a BepInEx 5 build.
  4. Only if you make mods: the .NET 10 SDK, the free tool that builds your code into a mod. Players do not need it.

Use either BepInEx version. The framework zip works with both.

Install for players

  1. Close the game.
  2. In the game folder, the folder that holds Obenseuer.exe, extract the BepInEx zip, so that the BepInEx folder and winhttp.dll sit next to Obenseuer.exe. The default Steam path is C:\Program Files (x86)\Steam\steamapps\common\Obenseuer. In Steam, right-click the game, choose Manage, then Browse local files, to open it.
  3. Start the game once, so BepInEx creates its folders. Then close it. If it worked, the game folder now has a BepInEx\plugins folder and a BepInEx\LogOutput.log file. If it did not, check that winhttp.dll sits next to Obenseuer.exe and not one folder deeper.
  4. Extract the framework zip into the game folder. The zip contains a BepInEx folder, so its files land in BepInEx\plugins\ObenseuerCore\. The zip holds a BepInEx 6 build (ObenseuerCore.dll) and a BepInEx 5 build (ObenseuerCore.BepInEx5.dll), and BepInEx loads the one that matches. ObenseuerCore is the framework’s file and code name.
  5. Start the game. The framework adds a “MODS” button to the main menu.

If you use ConfigurationManager or UnityExplorer, they need the builds for your BepInEx version.

Updating

Close the game first. Then delete BepInEx\plugins\ObenseuerCore\, and BepInEx\plugins\ObenseuerCore.WebUi\ if it exists, before you extract the new zips. Extracting over the old folders does not remove files that a newer version dropped. For example, ObxWebView.dll and the web folder came with the framework zip in 0.9.0-beta, and moved to the WebUi zip in 0.10.0-beta. Your settings in BepInEx\config\ are kept. If the log then reports an error about the other loader’s copy, see BepInEx 5 or 6?.

Optional: WebUi

WebUi lets mods show HTML pages. It also gives the framework’s Mods menu its web look, styled like the game’s own menu. Without it, the framework still runs and the Mods menu opens as the classic window. Install it if you want the web Mods menu, or if a mod asks for it. Extract the WebUi zip from the releases page into the game folder. Its files land in BepInEx\plugins\ObenseuerCore.WebUi\, with a BepInEx 6 build (ObenseuerCore.WebUi.dll) and a BepInEx 5 build (ObenseuerCore.WebUi.BepInEx5.dll). WebUi also needs the Microsoft Edge WebView2 Runtime. Windows 10 and 11 have it already.

Check it worked

Open BepInEx\logs\ObenseuerCore.log. The first line names the framework version, the game build and the loader (BepInEx 5 or 6) it runs on. If the file is missing, see my mod does not load.

Make mods

Do the steps above first, including the framework zip, because a mod project builds against the framework files in your game folder. Then go to Your first mod. It starts from the Starter folder in the repository, which builds on its own once the game, BepInEx and the framework are installed. The framework does not ship a build.cmd. Build your mod with dotnet build.

Where to go next

Next: Your first mod.

This site uses Just the Docs, a documentation theme for Jekyll.