diff --git a/README.md b/README.md index f40dc1c6..1e4586e9 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,40 @@

- - - - - CodeFactor - - - Code Climate maintainability - - - - - - - -
- - GitHub Workflow Status (event) - - - GitHub Workflow Status (event) - - - - -
- - - -
- - - - - - - - - - - - - - - -
- - Steam Mod Configuration Menu - - - Steam Downloads - - - Steam Views - - - Steam Subscriptions - - - Steam Favorites - -
- -
- + +
+ + 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](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. -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! + +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 @@ -85,6 +46,15 @@ It provides 5 types of options: 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`. @@ -95,3 +65,26 @@ Add this to your `.csproj`. Please not that `IncludeAssets="compile"` is very im ``` + +## 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) diff --git a/src/MCM.Publish/_Module/ModuleData/Languages/JP/sta_strings.xml b/src/MCM.Publish/_Module/ModuleData/Languages/JP/sta_strings.xml index f4f64ce4..e93054be 100644 --- a/src/MCM.Publish/_Module/ModuleData/Languages/JP/sta_strings.xml +++ b/src/MCM.Publish/_Module/ModuleData/Languages/JP/sta_strings.xml @@ -21,7 +21,7 @@ - + @@ -37,5 +37,19 @@ + + + + + + + + + + + + + + diff --git a/src/MCM.Publish/_Module/ModuleData/Languages/SP/sta_strings.xml b/src/MCM.Publish/_Module/ModuleData/Languages/SP/sta_strings.xml index 7a1294e9..bb8fdc6a 100644 --- a/src/MCM.Publish/_Module/ModuleData/Languages/SP/sta_strings.xml +++ b/src/MCM.Publish/_Module/ModuleData/Languages/SP/sta_strings.xml @@ -37,5 +37,19 @@ + + + + + + + + + + + + + +