Details

Target: Obenseuer 0.5.08 (buildid 25969064), Unity 6000.0.77f1 Mono, BepInEx 6 Unity.Mono (be.788, the tested build) or BepInEx 5 (5.4.23 or later). Namespace: ObenseuerCore. Logs go to BepInEx\logs\obenseuer.moddingframework.webui.log.

Everything not listed in this reference is internal and may change without notice.

If something fails to set up

The framework does not change the game’s own methods for this part of the API. What can fail is the shim: if it is missing, or it cannot start, WebUi.IsAvailable is false, Open gives null, and LastError tells you why. Its name in the log is obenseuer.moddingframework.webui.

When you can call it

  • Call everything from your mod’s normal code (OnLoad, event handlers, Update), not from a background thread you started. The game and Unity only run safely on the main thread (see the glossary). From another thread, Open gives null, the calls that return a bool give false, and Close does nothing.

Bad values

  • A mod id that is not valid throws an error. Open throws an ArgumentException when modId is not 1 to 64 characters of letters, digits, ., _ or -, as the other framework calls do.
  • A folder or page that is not valid gives null. Open gives null when folder is not a folder that exists, or when page is not a relative path (see Navigation).
  • Nothing else throws an error. A call into the shim that fails gives false or null, and LastError then holds the shim’s error text.