Plugin

This page lists what the API gives you, one section for each part. Text in brackets at the end of a note is extra detail for experienced modders, and you can skip it on a first read.

The framework is itself a BepInEx plugin, a class named Core. It checks which game build is running and reads its own config file. Most of what it offers is on the other pages in this section, and these few members tell you about the game build and about a debug check.

Core the framework's own plugin class

Read IsSupportedBuild or GameBuild to see whether this is the game build the framework supports. PatchingAllowed tells you whether the framework will change game methods.

public class Core : BaseUnityPlugin
{
    public static readonly string GameBuild;
    public static readonly bool IsSupportedBuild;
    public static bool PatchingAllowed { get; }
    public static bool RawAccessAvailable { get; }
}

Property	Type	What it means
`GameBuild`	`string`	The game version and build, such as “0.5.08 (buildid 25969064)”. It reads “buildid unknown” when no Steam manifest is found.
`IsSupportedBuild`	`bool`	`true` when the game is version 0.5.08, and the build id matches when it is known.
`PatchingAllowed`	`bool`	`false` only when the build is unsupported and you turned on `Safety.RefuseUnknownBuild`.
`RawAccessAvailable`	`bool`	`true` when the optional access check passed. `false` when the check did not run.

Things to know

Core is a BepInEx plugin, so its base type depends on which BepInEx you run. Its static members work from framework mods too. The framework mods page lists the other members that depend on the loader.
By default the framework still works on a game build it was not tested on. It logs a warning instead of stopping. If the player wants it to stop, they set [Safety] RefuseUnknownBuild to true, and then PatchingAllowed is false on other builds.
RawAccessAvailable only means something when the access check is turned on. The check runs at start when [Debug] AccessProbe is true. It tries to reach the game’s private members and logs L0 access probe: OK, or L0 access probe: <ExceptionType>: <message>. The save data methods do not depend on it. (“L0” is the framework’s name for plain access to the game’s code with no workaround.)
While the ConfigurationManager window (F1) is open, the player cannot look around or move. The framework freezes mouse-look and movement and keeps the cursor visible. Nothing happens when ConfigurationManager is not installed. Other game menus do not freeze the game this way, and the freeze ends when the window closes. (It sets the game’s GameController.ControlsDisabled.)

Config file settings

The framework’s config file is BepInEx\config\obenseuer.moddingframework.cfg. These are its settings. Players change them in a text editor or in the in-game config window.

Setting	What it does
`[Safety] RefuseUnknownBuild = false`	When true, the framework changes no game method on a build other than 0.5.08 (buildid 25969064). By default an unknown build is changed anyway, and a warning is logged. It takes effect on the next start.
`[Debug] Master = false`	Turns on the framework’s debug trace. The trace is written to `BepInEx\logs\ObenseuerCore.debug.log`. It is also in the Mods menu and in the `core_debug` console command. See Debug.
`[Debug] TraceFilter`	Limits the trace to type names that start with the text you give.
`[Debug] Verbose = false`	When true, `CoreLog.Debug` writes its lines.
`[Debug] AccessProbe = false`	Runs the access check at start and logs the result.
`[Debug] PlayerLookSelfCheck = false`	Runs a self-check of the look limits and gender rules at start, and logs the result.
`[Debug] ModIdsSelfCheck = false`	Runs a self-check of mod ids and save file names at start. It logs `modids self-check ok`, or the first case that failed.
`[Debug] NetBlobSelfCheck = false`	Runs a self-check of the way large data is split into chunks, checked and compressed for the network. It logs `netblob self-check ok`, or the first case that failed.
`[Debug] SaveDataSelfCheck = false`	Adds the `core_savedata_check` console command, which logs `SaveData.SelfCheck()`. It changes the live inventory, so use a scratch save. See Save data (game).
`[Debug] SaveJsonSelfCheck = false`	Runs a self-check of saving and loading a value as text at start. It logs `save json self-check ok`, or the first case that failed.
`[Debug] JsonProbeCommand = false`	Adds the `core_jsonprobe` console command. It logs one test value as the game’s `JsonUtility` writes it and as `SaveData` writes it.
`[Debug] SceneLooksCommand = false`	Adds the `scenelooks` console command, which prints the look index of a scene (`list`, `listall`, `find`, `findchar`, `here`). It only reads the installed game files and changes nothing in the game. See Scene looks. The framework’s own Settings page in the Mods menu also has a `Scene looks` action, `Run scene looks checks`. It needs no flag and no console. It prints the same index for the loaded scene to the menu status line and the log.
`[UI] ThemeConfigManager = true`	Gives the ConfigurationManager window (the in-game config window opened with F1) a dark theme.