From 030a2f186ad4a533855a2a78be7f886b7b6258d3 Mon Sep 17 00:00:00 2001 From: Vitalii Mikhailov Date: Tue, 18 Jul 2023 09:48:44 +0300 Subject: [PATCH 01/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f40dc1c6..1df07867 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,6 @@ Requires `Bannerlord.Harmony`, `Bannerlord.UIExtenderEx`, `Bannerlord.ButterLib` Add this to your `.csproj`. Please not that `IncludeAssets="compile"` is very important! ```xml - + ``` From ef8dbee6526bc6ae075028487b983bb8c53e81ce Mon Sep 17 00:00:00 2001 From: Vitalii Mikhailov Date: Sun, 23 Jul 2023 11:32:00 +0300 Subject: [PATCH 02/11] Update README.md --- README.md | 133 +++++++++++++++++++++++++----------------------------- 1 file changed, 62 insertions(+), 71 deletions(-) diff --git a/README.md b/README.md index 1df07867..a5f96ae8 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. -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 @@ -82,9 +43,18 @@ It provides 5 types of options: * 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`. @@ -92,6 +62,27 @@ Requires `Bannerlord.Harmony`, `Bannerlord.UIExtenderEx`, `Bannerlord.ButterLib` 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 Bannerlord.MBOptionScreen.*\bin\Win64_Shipping_Client\*.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) From aa78b85e57093fba4d8a742e753dae6c08cee357 Mon Sep 17 00:00:00 2001 From: Vitalii Mikhailov Date: Sun, 23 Jul 2023 11:32:13 +0300 Subject: [PATCH 03/11] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a5f96ae8..af9c14c8 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Code Climate maintainability -
+
GitHub Workflow Status (event) GitHub Workflow Status (event) @@ -31,8 +31,8 @@ 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 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! @@ -43,7 +43,7 @@ It provides 5 types of options: * 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: From 1e5e8de2eb97c601cfa275a0324a0fb514b1698c Mon Sep 17 00:00:00 2001 From: Vitalii Mikhailov Date: Sun, 23 Jul 2023 11:32:49 +0300 Subject: [PATCH 04/11] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index af9c14c8..794755a0 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,9 @@ 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: From 5bd92ca1f93350e142370261c337b17b09cc3346 Mon Sep 17 00:00:00 2001 From: Vitalii Mikhailov Date: Sun, 23 Jul 2023 11:55:22 +0300 Subject: [PATCH 05/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 794755a0..fca28157 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ Add this to your `.csproj`. Please not that `IncludeAssets="compile"` is very im ### Unblocking DLL's -You may need to right click on every Bannerlord.MBOptionScreen.*\bin\Win64_Shipping_Client\*.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. +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 From 26b7e022f9ff9a3bb53edd8c2096d6d5a4a3c53f Mon Sep 17 00:00:00 2001 From: Vitalii Mikhailov Date: Sun, 23 Jul 2023 12:14:46 +0300 Subject: [PATCH 06/11] Update README.md --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fca28157..1e4586e9 100644 --- a/README.md +++ b/README.md @@ -71,14 +71,16 @@ Add this to your `.csproj`. Please not that `IncludeAssets="compile"` is very im 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: - -
+

+

+ 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. From 4a008d7c78accf13b93f832015b2a7049486f361 Mon Sep 17 00:00:00 2001 From: Vitalii Mikhailov Date: Fri, 28 Jul 2023 22:09:15 +0300 Subject: [PATCH 07/11] Update source file sta_strings.xml --- .../ModuleData/Languages/EN/sta_strings.xml | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/src/MCM.Publish/_Module/ModuleData/Languages/EN/sta_strings.xml b/src/MCM.Publish/_Module/ModuleData/Languages/EN/sta_strings.xml index 6a95416c..8dcc8cd1 100644 --- a/src/MCM.Publish/_Module/ModuleData/Languages/EN/sta_strings.xml +++ b/src/MCM.Publish/_Module/ModuleData/Languages/EN/sta_strings.xml @@ -38,19 +38,5 @@ - - - - - - - - - - - - - - \ No newline at end of file From 62736f5122bd9bdecf964e2f922e58634825a123 Mon Sep 17 00:00:00 2001 From: Vitalii Mikhailov Date: Fri, 28 Jul 2023 22:09:18 +0300 Subject: [PATCH 08/11] New translations sta_strings.xml (Japanese) --- src/MCM.Publish/_Module/ModuleData/Languages/JP/sta_strings.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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..d2fd85d5 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 @@ - + From 302b264539dea6354abe0d412c5d1de0538ef3d5 Mon Sep 17 00:00:00 2001 From: Vitalii Mikhailov Date: Sun, 30 Jul 2023 19:48:20 +0300 Subject: [PATCH 09/11] Update source file sta_strings.xml --- .../ModuleData/Languages/EN/sta_strings.xml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/MCM.Publish/_Module/ModuleData/Languages/EN/sta_strings.xml b/src/MCM.Publish/_Module/ModuleData/Languages/EN/sta_strings.xml index 8dcc8cd1..6a95416c 100644 --- a/src/MCM.Publish/_Module/ModuleData/Languages/EN/sta_strings.xml +++ b/src/MCM.Publish/_Module/ModuleData/Languages/EN/sta_strings.xml @@ -38,5 +38,19 @@ + + + + + + + + + + + + + + \ No newline at end of file From 7e9f8291861d549180b2283b5ab1301ce909ef25 Mon Sep 17 00:00:00 2001 From: Vitalii Mikhailov Date: Mon, 21 Aug 2023 18:51:53 +0300 Subject: [PATCH 10/11] New translations sta_strings.xml (Japanese) --- .../ModuleData/Languages/JP/sta_strings.xml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) 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 d2fd85d5..e93054be 100644 --- a/src/MCM.Publish/_Module/ModuleData/Languages/JP/sta_strings.xml +++ b/src/MCM.Publish/_Module/ModuleData/Languages/JP/sta_strings.xml @@ -37,5 +37,19 @@ + + + + + + + + + + + + + + From 6f072d5dd42c520cb1e240b7f45de605b0b737ee Mon Sep 17 00:00:00 2001 From: Vitalii Mikhailov Date: Sat, 9 Sep 2023 05:43:54 +0300 Subject: [PATCH 11/11] New translations sta_strings.xml (Spanish) --- .../ModuleData/Languages/SP/sta_strings.xml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) 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 @@ + + + + + + + + + + + + + +