Skip to content

BUTR/Bannerlord.ButterLib

Repository files navigation

Bannerlord.ButterLib


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


Steam Mod Configuration Menu Steam Downloads Steam Views Steam Subscriptions Steam Favorites

Extension library for Mount & Blade II: Bannerlord.

Highlighted features:

  • DelayedSubModule - Execute code after specific SubModule method.
  • DistanceMatrix - Developer tools to calculate and use distances between different objects in the game.
  • HotKeys - Event based wrapper around game's HotKey management.
  • MBSubModuleBaseEx - Additional control over crucial parts of game and campaign loading or unloading.
  • SaveSystem - Provides helper methods for the game's save system.
  • SubModuleWrappers - Wraps MBSubModulebase for easier calling of protected internal metods.
  • DependencyInjection - Tools to work with ButterLib subsystems and services.
  • Logging - Access to Serilog logging through ILogger Interface.

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

Outdated 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 note 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.