Bannerlord.MBOptionScreen icon indicating copy to clipboard operation
Bannerlord.MBOptionScreen copied to clipboard

Mod Configuration Menu. A Module for easy Setting integration. Documentation available.

CodeFactor Code Climate maintainability GitHub Workflow Status (event) GitHub Workflow Status (event)

AKA MBOptionScreen Standalone.
Previously, a fork of ModLib that was de-forked.

MCM is a Mod Options screen library designed to let modders use its API for defining the options.
It can also display settings from other API's like ModLib, pre 1.3 and post 1.3, MBOv1/MCMv2, by using the compatibility layer modules.

MCM supports two setting types - Global and PerSave. Global are shared across characters and saves, PerSave are stored within the save file!

It provides 5 types of options:

  • Bool
  • Int Slider / Textbox
  • Float Slider / Textbox
  • Textbox
  • Dropdown
  • Button

The settings can be defined at compile time by using the Attribute API and at runtime by using the Fluent Builder.

Installation

Players

Requires Bannerlord.Harmony, Bannerlord.UIExtenderEx, Bannerlord.ButterLib.

Developers

Add this to your .csproj. Please not that IncludeAssets="compile" is very important!

  <ItemGroup>
    <PackageReference Include="Bannerlord.MCM" Version="4.3.16" IncludeAssets="compile" />
  </ItemGroup>