Skip to content

Latest commit

 

History

History
90 lines (78 loc) · 7.65 KB

README.md

File metadata and controls

90 lines (78 loc) · 7.65 KB
Raw


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


Steam Mod Configuration Menu Steam Downloads Steam Views Steam Subscriptions Steam Favorites

AKA MBOptionScreen Standalone.
Previously, a fork of ModLib that was de-forked.
Sources available at GitHub!
Credits to Drogean for the MCM Logos!

MCM is a Mod Options screen library designed to let modders use its API for defining the options.

MCM supports three setting types - Global, PerCampaign and PerSave. Global are shared across characters and saves, PerCampaign are persistent within a single campaign, 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.

MCM uses the following 3 framework level libraries:

  • Harmony is used to have a single 0Harmony.dll across the game.
  • ButterLib is a general modding library that eases mod development.
  • UIExtenderEx is an general UI manipulation library.

See the Docs for more details!

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>

FAQ

How do I install it?

  1. Find the Modules folder in your Bannerlord installation location. For Steam users, this is usually here: C:\Program Files (x86)\Steam\steamapps\common\Mount & Blade II Bannerlord\Modules
  2. Download the latest version of this mod and drop the folder inside Modules from the archive into your game's Modules folder.
  3. Start the Mount & Blade II: Bannerlord launcher and select all Mod Configuration Menu mods to be loaded.

Your Modules folder structure should look something like this:
Your mod order in the launcher should look something like this:

Unblocking DLL's

You may need to right click on every *.dll files, click Properties, and click Unblock if you extracted the zip file with Windows Explorer or other programs that try to secure extracted files.

Harmony installation issues:

Check Harmony's Troubleshooting for more info on how to fix it.

Crashes on v1.0.0-v1.0.3 with Vortex used

Check this comment