Description
BannerColorPersistence was originally created to prevent one small issue with custom banners being broken on save/load. It has since expanded to resolve a variety of issues associated with custom banners in an attempt to keep our complex banners working as Bannerlord develops. If you have any issues with your custom banners, BannerColorPersistence seeks to fix them, including:
- Banner icons changing to background color on load
- Banners being ruined by joining a kingdom
- Clothing/armor colors not aligning with your banner colors when in a kingdom
- Crash to desktop when opening trade or inventory menu while using a banner with multiple icons
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.
As of 1.2.5 BannerColorPersistence now includesBannerPaste logic!
Originally created by gooboon, BannerPaste has served the community well for many BL releases, but 1.7.2 included breaking changes. With gooboon's permission, I've included the original code in BCP as well as the fixes for those problems. By popular demand I've also backported the BannerPaste logic into the BCP 1.2.5 release for 1.7.1. Make sure you use the correct version with your version of Bannerlord!
Requirements
As of BCP 1.3.1 (for Bannerlord version 1.8.0+), Harmony is now a required mod.
I've always tried to keep things as simple as possible to help users of the mod and in the past that meant packaging the Harmony dll with BCP. However, this practice is rather outdated and could be causing issues with users who have been running BCP while also having Harmony installed separately for other mods. In an effort to reduce the possibility of conflicts and issues, BCP will no longer be providing Harmony included as of version 1.3.1. Please make sure to download and install the correct version of Harmony if it is necessary for the version of Bannerlord and BCP that you are running. And don't forget, Harmony should be at the top of your load order.
Custom Banner Info
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 athttps://bannerlord.party/banner/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 BannerlordBannerssubredditto see a wide array of custom banners created by the community and check out the pinned tutorial there as well.
Configuration
BannerColorPersistence includes a few configuration options for those who need it. For most users, these should be left to the default values.
enableBannerColorPersistence- defaults to true. Set to false if you do not want the banner color persistence logic to be run. This will allow only the BannerPaste functionality and basic crash fixes to function. Use at your own risk.
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.
Has been tested and works on 1.5.4, 1.5.5, 1.5.6, 1.5.7, 1.5.8, 1.5.9, 1.5.10, 1.6.0, 1.6.1. 1.6.2, 1.6.3, 1.6.4, 1.6.5, 1.7.0, 1.7.1, 1.7.2, 1.8.0 , 1.8.1, 1.9.0, 1.0.0, 1.0.1, 1.0.2, 1.0.3. 1.1.0
Please report any bugs or oddities you find and any suggestions you may have.
