Home - MSUTeam/MSU GitHub Wiki
Modding Standards & Utilities (MSU)
MSU intends to not only make the Battle Brothers modding experience easier and more efficient, but also standardize many of its aspects to allow modders to write cleaner and more inter-mod compatible code. MSU does this by adding many useful features:
- Many utilities that allow faster coding, cleaner code and better functionality.
- Several systems that allow mods to create their own settings and keybinds while providing enhanced debugging capabilities. MSU also makes implementing save-breaking changes across mod versions a breeze thanks to the serialization system.
- A Persistent Data system enabling mods to save data and settings across play sessions.
- Groundbreaking functionality for skills modding for maximum inter-mod compatibility and greatly enhanced skill modding possibilities including incremental changes, a new Damage Type system, several new skill events and an easy way to add new events and much more.
- Flag based serialization and deserialization which allows safely adding/removing mods and serialized content from saved games.
- Automated update checking for mods to notify users about mod updates and download links in-game.
- Many new functions in BB objects such as actor, items, weapons etc. and others.
- New squirrel classes such as weighted-container and ordered-map.
- Various Vanilla Fixes for bugs that are still present in vanilla Battle Brothers.
Use the sidebar to read about all the different features in MSU. For new feature requests and providing feedback/bug reports please create issues.
See the Getting Started page to begin making a mod with MSU in mind.
- NOTE: MSU guarantees backwards compatibility for documented features and code only. Undocumented features/code of MSU may be changed at any time without notice, so we advise against using/referencing such code in your projects.