BannerColorPersistence with BannerPaste
BannerColorPersistence provides a variety of fixes that allow the continued use of complex banners including those generated via web based banner editor[bannerlord.party] and pasted into your game as well as custom banners configured via other mods. Some such problems include:
- Banner icons changing to background color
- Banners being ruined on joining a kingdom
- Clothing/armor colors not aligning with your banner colors while in a kingdom
- Crash to desktop when opening an inventory or trade screen while using a banner with multiple icon layers
The default behavior of this mod is to prevent your banner and clothing colors from changing when you join a kingdom. There are configuration options to permit the color change but using them is recommended only if you have a good understanding of how the banner colors are applied and have built a banner to specifically work with the change.
BannerColorPersistence comes with BannerPaste built in! Courtesy of and with permission of gooboon, original creator of the BannerPaste mod, this is the only mod you’ll need for pasting your custom banner codes into the game.
You must have the latest version of Harmony installed and loaded prior to BannerColorPersistence
If you have ever installed BannerColorPersistence or Harmony via NexusMods and are now subscribing to them via Steam Workshop, I strongly suggest you REMOVE those mods from the Bannerlord/Modules folder. Steam does not save mods to the same folder and structure so by Subscribing to a mod and having it installed in your Modules directory you will be causing conflicts and are susceptible to crashes.
In the context of this mod, a "custom banner" refers to a banner created with multiple icon layers to create a more detailed and complex design. These banners are largely created by using the web editor[bannerlord.party] and pasting the generated code in the in-game editor or via the xml files. Pasting the code in-game requires the BannerPaste functionality, which is now provided by BannerColorPersistence.
Please visit the r/BannerlordBanners subreddit to see a wide array of custom banners created by the community and check out the pinned tutorial there as well.
BannerColorPersistence includes a few configuration options for those who need it. For most users, these should be left to the default values. Modification of these values for the SteamWorkshop is currently trickier than intended. You’ll need to navigate to your SteamLibrary/steamapps/workshop/content folder and then located the folder containing BCP. From there, navigate to binWin64_Shipping_Client and open the config.json file in your preferred editor. Replace the true or false values with your preference, save the file, and restart the game.
I am currently in the process of adding these configuration options to the Mod Configuration Menu for use in later releases.
ignoreKingdomColorChanges – defaults to true, prevents all kingdom color changes to your banner. Set to false if you want to allow background color changes when you change kingdoms. Essentially disables the mod.
preventNPCBannerColorChanges – defaults to false, should really only be set to true if you’re running custom banners for your NPCs via some other mod such as CBU or POC
allowColorChangeOnIconsMatchingBackgroundColor – defaults to false. This one may work well for you or it may not. It’s completely dependent upon your specific banner. The idea here is that if you’re allowing background color changes on kingdom change, sometimes your custom banner uses icons in the same color as the background in order to block out and modify other icons. If you’re only changing background color, those icons now become visible when they remain the original color and make your banner look wonky. This config option will attempt to change the color of those icons as well. BUT – and this is a very big but – the icons must match the background colors EXACTLY, and must match BOTH of the colors. Each background and icon have TWO colors associated to them and if both colors don’t align, the change won’t occur. This means that banners using multi-colored backgrounds probably won’t change properly. It also means that if your banner was created without close attention to the secondary color of the icons, it also probably won’t change properly. All that said, try this config out if you really want to see your banner changing with your kingdom change, but ignore it otherwise cause there’s probably a pretty low chance of it actually working perfectly. Some people were asking for it though, so here it is.
If you’re running older versions of Bannerlord and need this mod, you’ll have to access it via Nexus[www.nexusmods.com]
If you experience a crash please try the following things:
- Read the important note I added to this page just a few sections above. TL;DR make sure you don’t have previous versions of BannerColorPersistence or Harmony installed in your Modules folder. If you’ve subscribed to a mod via Steam, don’t keep the mod in your Modules folder.
- Double check your versions. When you start the game, click the Mods tab and verify the version numbers on BannerColorPersistence, Harmony, and Native. As of this writing Harmony should be 2.2.2.140, BCP should be 1.4.0.x and Native should be 1.0.0.x. If those aren’t what you have read the previous note again and make sure you’ve done that.
- Utilize a tool such as ButterLib or BetterExceptionWindow to provide a detailed crash report
- Visit BCP on NexusMods[www.nexusmods.com] and provide a description of your problem and the saved crash report in the POSTS or BUGS tab.
If you experience bugs, leave a comment here or visit BCP on NexusMods[www.nexusmods.com] and make a POST or BUG report. Please include a detailed description of the bug to the best of your ability as well as the versions of Bannerlord, BCP, and any other mods you’re running.
If you have any requests or suggestions to make this mod better, leave a comment or visit BCP on NexusMods[www.nexusmods.com] and leave a POST.
