Difference between revisions of "Modding Bannerlord with Vortex"

From Nexus Mods Wiki
Jump to: navigation, search
Line 74: Line 74:
  
 
 
 
 
 +
  
  
Line 80: Line 81:
 
{{VortexVersion|1.2.4 and above}}As of Vortex version 1.2.4, you can manage your Bannerlord load order directly in Vortex via the "Load Order" tab.  
 
{{VortexVersion|1.2.4 and above}}As of Vortex version 1.2.4, you can manage your Bannerlord load order directly in Vortex via the "Load Order" tab.  
  
*Using Auto-Sort is strongly recommended, as this will sort your mods according to dependencies.  
+
*Using Auto Sort is strongly recommended, as this will sort your mods according to dependencies.  
*Make sure to deploy after changing the load order (Vortex will prompt you to deploy after changing the load order)
 
 
*The game must be run via the Play button in the top left corner to ensure the load order shown in Vortex is applied.  
 
*The game must be run via the Play button in the top left corner to ensure the load order shown in Vortex is applied.  
 +
*If a mod you installed is not in this list, it means that the mod doesn't come with a SubModule.xml. Not every mod has or needs one.
  
 
[[File:BANNERLORDLoadOrder.JPG|1050px|BANNERLORDLoadOrder.JPG]]
 
[[File:BANNERLORDLoadOrder.JPG|1050px|BANNERLORDLoadOrder.JPG]]
Line 100: Line 101:
 
[[File:BannerlordDependencyFixed.JPG|600px|BannerlordDependencyFixed.JPG]]
 
[[File:BannerlordDependencyFixed.JPG|600px|BannerlordDependencyFixed.JPG]]
  
=== Auto-Sorting Logic ===
+
=== Auto Sorting Logic ===
  
 
To ensure that the load order created by Vortex is functional and stable, Vortex will parse the SubModule.xml files of the mods you have installed and sort them according to dependencies.
 
To ensure that the load order created by Vortex is functional and stable, Vortex will parse the SubModule.xml files of the mods you have installed and sort them according to dependencies.
  
For example: if Mod B declares under <DependedModules> in its SubModule.xml that it requires Mod A (the entry would read&nbsp;<DependedModule Id="ModA"/> or similar) then Auto Sort will ensure Mod B loads after Mod A (and therefore create an order where Mod B is sorted below Mod A).
+
For example: if Mod B declares under <DependedModules> in its SubModule.xml that it requires Mod A (the entry would read&nbsp;<DependedModule Id="ModA"/> or similar) then Auto Sort will ensure '''Mod B loads after Mod A''' (and therefore create an order where Mod B is sorted below Mod A).
 +
 
 +
While the sorting algorithm is more sophisticated, it can be described with a few rules:
 +
 
 +
#Every mod is going to be sorted after the official module named "Native". "Native" is locked in position 1 and cannot be moved.
 +
#Mods are sorted by dependencies. A mod dependent mod will be sorted after its required mod.
 +
#Other than that, mods will be sorted in alphabetical order based on the Module ID defined in the SubModule.xml file.
  
 
== Troubleshooting ==
 
== Troubleshooting ==

Revision as of 14:27, 17 April 2020

Banner.jpg
Mount & Blade II: Bannerlord

Mount & Blade II: Bannerlord is an action role-playing video game developed by TaleWorlds Entertainment.

Released: 2020

Genre: ARPG

Engine: Custom

Nexus Mods

This guide is designed to help you set up Vortex to install and manage mods for Mount & Blade II: Bannerlord. Please note that Vortex support for Bannerlord is actively being worked on and may soon include new features.

 

Requirements

Before we get started, this guide assumes that you have installed Bannerlord and Vortex at their default locations. You will also need to be logged in to your Nexus Mods account in Vortex.

 

Getting Set Up

To begin, open up Vortex and navigate to the games section. In the search bar at the top, type in "Bannerlord" and click the "Manage" button on the game tile.

Manage1Bannerlord.JPG

A dialogue will appear asking you to confirm the download of the game extension for Bannerlord. Click "Download" in the bottom right to proceed.

Manage2Bannerlord.JPG

Once the extension is installed (which should only take a few seconds) click "Restart now" in the notification that will appear in the top right corner.

RTENOTITLE

Go back to the Games tab (click "Games" in the side menu) and search for Bannerlord again. This time, the button on the game tile should read "Activate". Click it and Vortex will be ready and set up to manage mods for Bannerlord.

ActivateBannerlord.JPG

 

Installing Mods

In the Nexus Mods Bannerlord section, navigate to a mod you would like to download (Example: Bannerlord Tweaks). In the top right, you will see a button that reads "Download: Vortex". Click it and confirm to open the link with Vortex if your browser asks you for confirmation.

BannerlordMod.JPG

Once the mod is downloaded via Vortex (which for this example should only take a few seconds), click "Install" in the notification in the top right.

BannerlordInstall.JPG

After the mod is installed, you can enable the mod for example by clicking the "Enable" button in the next notification that is raised by Vortex, again in the top right corner.

RTENOTITLE

Optional

Tip: You can skip this step and simply auto-enable mods you have just installed by changing your Vortex settings. In the side menu, go to "Settings" and on the rider "Interface" toggle the option that says "Enable Mods when installed (in current profile)". This will make it so mods are immediately enabled as soon as they are installed.

RTENOTITLE

 

Lastly, you need to run Bannerlord (click the play button in the top left) and tick the checkbox next to the mod we just installed and enabled in the game's launcher so it becomes active the next time you play.

LaunchGame.JPG

Once the launcher appears, navigate to "Mods" and make sure to tick the checkbox next to the mod we just installed and enabled.

LauncherEnable.JPG

 

And that's it! The mod is now ready to be used ingame.

 


Managing your Bannerlord Load Order

VortexLogoSmall.png This content applies to Vortex 1.2.4 and above.

As of Vortex version 1.2.4, you can manage your Bannerlord load order directly in Vortex via the "Load Order" tab.  

  • Using Auto Sort is strongly recommended, as this will sort your mods according to dependencies.
  • The game must be run via the Play button in the top left corner to ensure the load order shown in Vortex is applied.
  • If a mod you installed is not in this list, it means that the mod doesn't come with a SubModule.xml. Not every mod has or needs one.

BANNERLORDLoadOrder.JPG

Mods/Modules with missing Dependencies

If a mod in your load order cannot find a mod it depends on, Vortex will disable it and mark the mod with an X. On hover, the missing mod dependency will be displayed.

Note: This is because Vortex will parse the SubModule.xml files for the mods in your load order and sort them according to the entries under "<DependedModules>"

BannerlordMissingDependencies.JPG

This tells us that we need to install and enable "BannerLib". Otherwise "Custom Campaign Options" won't load.

Once we have installed and enabled "BannerLib", all dependencies are fulfilled and we can enable "Custom Campaign Options":

BannerlordDependencyFixed.JPG

Auto Sorting Logic

To ensure that the load order created by Vortex is functional and stable, Vortex will parse the SubModule.xml files of the mods you have installed and sort them according to dependencies.

For example: if Mod B declares under <DependedModules> in its SubModule.xml that it requires Mod A (the entry would read <DependedModule Id="ModA"/> or similar) then Auto Sort will ensure Mod B loads after Mod A (and therefore create an order where Mod B is sorted below Mod A).

While the sorting algorithm is more sophisticated, it can be described with a few rules:

  1. Every mod is going to be sorted after the official module named "Native". "Native" is locked in position 1 and cannot be moved.
  2. Mods are sorted by dependencies. A mod dependent mod will be sorted after its required mod.
  3. Other than that, mods will be sorted in alphabetical order based on the Module ID defined in the SubModule.xml file.

Troubleshooting

Placeholder

Placeholder