/Bannerlord.ButterLib

Extension library for Mount & Blade II: Bannerlord.

Primary LanguageC#MIT LicenseMIT

Bannerlord.ButterLib


CodeFactor Code Climate maintainability
GitHub Workflow Status (event) GitHub Workflow Status (event)


Extension library for Mount & Blade II: Bannerlord.

Highlighted features:

  • CampaignIdentifier - Associates unique string ID with every campaign based on the initial character.
  • DistanceMatrix - A generic class that pairs given objects of type MBObject and for each pair calculates the distance between the objects that formed it.
  • DelayedSubModule - Execute code after specific SubModule method.
  • SubModuleWrappers - Wraps MBSubModulebase for easier calling of protected internal metods.
  • SaveSystem - Provides helper methods for the game's save system.
  • AccessTools2 - Adds delegate related functions.
  • SymbolExtensions2 - More lambda functions.
  • AlphanumComparatorFast - Alphanumeric sort. This sorting algorithm logically handles numbers in strings.

Check the /Articles section in the documentation to see all available features!

Installation

Players

This module should be one of the highest in loading order. Ideally, it should be second in load order after Bannerlord.Harmony.

Developers

Add this to your .csproj. Please not that IncludeAssets="compile" is very important!

  <ItemGroup>
    <PackageReference Include="Bannerlord.ButterLib" Version="1.0.31" IncludeAssets="compile" />
  </ItemGroup>

For Players

This mod is a dependency mod that does not provide anything by itself. You need to additionaly install mods that use it.