https://github.com/aragas/bannerlord.mboptionscreen

Mod Configuration Menu. A Module for easy Setting integration. Documentation available.
https://github.com/aragas/bannerlord.mboptionscreen

bannerlord bannerlord-mod mod mount-and-blade-bannerlord

Last synced: 16 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/aragas/bannerlord.mboptionscreen
• Owner: Aragas
• License: mit
• Created: 2020-04-14T13:29:52.000Z (over 4 years ago)
• Default Branch: dev
• Last Pushed: 2024-03-13T17:28:47.000Z (8 months ago)
• Last Synced: 2024-05-21T07:57:34.871Z (6 months ago)
• Topics: bannerlord, bannerlord-mod, mod, mount-and-blade-bannerlord
• Language: C#
• Homepage: https://www.nexusmods.com/mountandblade2bannerlord/mods/612
• Size: 12.7 MB
• Stars: 38
• Watchers: 4
• Forks: 10
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.txt
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

README

        


  

  


  

  

  

  

  

  


  

  

  

  


  

  


  

  

  

  

  

  


  

  

  

  

  



AKA MBOptionScreen Standalone.  

Previously, a fork of [ModLib](https://github.com/mipen/ModLib) that was de-forked.  

Sources available at [GitHub](https://github.com/Aragas/Bannerlord.MBOptionScreen)!  

Credits to [Drogean](https://www.nexusmods.com/users/79933) 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](https://mcm.bannerlord.aragas.org/articles/index.html) 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!

```xml

  

    

  

```

## 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](https://forum.nexusmods.com/index.php?showtopic=8605808/#entry118785353)