Installation Guide - Battle-Brothers-Legends/Legends-public GitHub Wiki

Installation Guide

Necessary mods to run Legends

  • You will need all the regular Battle Brothers dlcs to run Legends. Backer dlcs are not required

  • Legends - you need both files to run the mod - mod_legends-19.1.0.zip and mod_legends-assets-19.1.0.zip

  • MSU

  • Modern Hooks

  • Mod Hooks is integrated into Legends and you don't need it (Modern Hooks is still required).

How to install

  • Legends version 19.1 and beyond ONLY works with Vanilla 1.5.1 and above. We are not supporting old versions and make sure you're not on a beta channel before going forward.

image

  • Ensure the main Battle Brothers folder looks like below. Do not use it as a folder to place your unneeded mods. Mods placed here may still load with your regular mod list. This is how it's supposed to look like:

image

  • Do not use Vortex. Vortex is simply not a good tool to manage your Battle Brothers mods and can create issues down the line.
  • Never unzip your mods. No mods for Battle Brothers are supposed to be unzipped.
  • Place the required mods in your Battle Brothers/data folder as shown in the screenshot below:

image

  • That's all. If you have followed the steps you're ready to play, but we would strongly suggest you check the additional information below.

Updating Legends

  • We strongly suggest you always update to latest legends versions unless you're playing submods which don't allow it, the next version is marked as not save compatible or you're wrapping up a run. Subsequent versions contain bug fixes which might save your run from the dreaded save corruption.
  • Builds marked as Save Compatible at the top of the release description mean that you can update to them without needing to start a new run. We test these extensively so they don't lead to a corrupted save, but accidents may happen and we apologize in advance.
  • As a general rule our versioning looks like X.Y.Z. X is a very big version and will always be save incompatible, Y is a major version and will usually be save incompatible and Z is a minor version which will be save compatible if not upgrading from a previous major version.

In example: Legends 19.1.0 is a major version update from 19.0.27 and you will need to start a new run, but updating from 19.1.1 to 19.1.7 is perfectly fine since it's a minor version update and in fact encouraged.

  • As of 19.1.0 Legends has what we call a split build. Assets and Code are in separate zip files which allows us to very rarely update the art where the bulk of the mod is. As a result you only need to download and replace the file that looks like mod_legends-19.1.0.zip unless the asset file is included in the release.

Basic Troubleshooting

Compatibility

  • Legends is a huge mod that changes just about every aspect of vanilla and you should build your mod list around it, rather than the other way around. We of course try to ensure it's highly compatible, but sometimes it doesn't work like that.
  • I would suggest completely avoiding mods that have not been updated since or are older than 03.2022. Mods which do not require Mod Hooks or Modern Hooks are almost always not compatible.
  • Legends Compat Check Mod
  • Legends Compatibility Document
  • Recommended Mods