Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/butr/bannerlord.butterlib

Extension library for Mount & Blade II: Bannerlord.
https://github.com/butr/bannerlord.butterlib

bannerlord bannerlord-mod library mod mount-and-blade-bannerlord

Last synced: 3 months ago
JSON representation

Extension library for Mount & Blade II: Bannerlord.

Awesome Lists containing this project

README

        

# 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](https://butr.github.io/Bannerlord.ButterLib/articles/DelayedSubModule/Overview.html) - Execute code after specific SubModule method.
* [DistanceMatrix](https://butr.github.io/Bannerlord.ButterLib/articles/DistanceMatrix/Overview.html) - Developer tools to calculate and use distances between different objects in the game.
* [HotKeys](https://butterlib.butr.link/articles/HotKeys/Overview.html) - Event based wrapper around game's HotKey management.
* [MBSubModuleBaseEx](https://butterlib.butr.link/articles/MBSubModuleBaseExtended/Overview.html) - Additional control over crucial parts of game and campaign loading or unloading.
* [SaveSystem](https://butr.github.io/Bannerlord.ButterLib/articles/SaveSystem/Overview.html) - Provides helper methods for the game's save system.
* [SubModuleWrappers](https://butr.github.io/Bannerlord.ButterLib/articles/SubModuleWrappers/Overview.html) - Wraps MBSubModulebase for easier calling of protected internal metods.
* [DependencyInjection](https://butterlib.butr.link/articles/Optional/DependencyInjection/Overview.html) - Tools to work with ButterLib subsystems and services.
* [Logging](https://butterlib.butr.link/articles/Optional/Logging/Overview.html) - Access to Serilog logging through ILogger Interface.

Check the [/Articles](https://butr.github.io/Bannerlord.ButterLib/articles/index.html) section in the documentation to see all available features!

### Outdated features:
* [AssemblyVerifier](https://butterlib.butr.link/articles/AssemblyVerifier/Overview.html) - Basic assembly compatibility checks.
* [CampaignIdentifier](https://butr.github.io/Bannerlord.ButterLib/articles/CampaignIdentifier/Overview.html) - Associates unique string ID with every campaign based on the initial character.

## 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!
```xml



```

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