Difference between revisions of "Modding Bannerlord with Vortex"

From Nexus Mods Wiki
Jump to: navigation, search
 
(22 intermediate revisions by the same user not shown)
Line 9: Line 9:
 
|engine=Custom
 
|engine=Custom
 
|nxm=https://www.nexusmods.com/mountandblade2bannerlord
 
|nxm=https://www.nexusmods.com/mountandblade2bannerlord
}} <!--https://staticdelivery.nexusmods.com/Images/games/4_3/tile_3174.jpg--> This guide is designed to help you set up Vortex to install and manage mods for Mount & Blade II: Bannerlord.
+
}} <!--https://staticdelivery.nexusmods.com/Images/games/4_3/tile_3174.jpg-->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.
  
 
&nbsp;
 
&nbsp;
Line 15: Line 15:
 
== Requirements ==
 
== Requirements ==
  
Before we get started, this guide assumes that you have installed [https://www.gog.com/game/kenshi Kenshi] and [https://www.nexusmods.com/about/vortex/ Vortex] at their default locations. You will also need to be [[Logging_in_via_Vortex|logged in to your Nexus Mods account]] in Vortex.
+
Before we get started, this guide assumes that you have installed [https://store.steampowered.com/app/261550/Mount__Blade_II_Bannerlord/ Bannerlord] and [https://www.nexusmods.com/about/vortex/ Vortex] at their default locations. You will also need to be [[Logging_in_via_Vortex|logged in to your Nexus Mods account]] in Vortex.
 +
 
 +
&nbsp;
  
 
== Getting Set Up ==
 
== Getting Set Up ==
  
To begin, open up Vortex and navigate to the games section. If you don’t already see Kenshi under the “Managed” tab, check the “Discovered” section. Use the “Manage” button on the game tile to add it to your managed games.
+
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.
 +
 
 +
[[File:Manage1Bannerlord.JPG|800px|Manage1Bannerlord.JPG]]
  
[[File:Kenshi1.JPG|800px|Kenshi1.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.
  
If you can’t see Kenshi, you can [[Adding_a_new_game_to_Vortex|scan for it or define it manually]].
+
[[File:Manage2Bannerlord.JPG|500px|Manage2Bannerlord.JPG]]
  
The first time you activate support for the game, Windows may prompt you to allow Vortex to make changes to the files on your computer. Accept this prompt to continue.
+
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.
  
[[File:VortexUACPrompt.jpg|250px|VortexUACPrompt.jpg]]
+
[[File:ExtensionInstalled.JPG|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.
 +
 
 +
[[File:ActivateBannerlord.JPG|800px|ActivateBannerlord.JPG]]
  
 
&nbsp;
 
&nbsp;
  
&nbsp;
 
  
 
== Installing Mods ==
 
== Installing Mods ==
  
For Kenshi, all mods follow a predictable install pattern meaning there are no additional considerations for different types of mods.
+
In the [https://www.nexusmods.com/mountandblade2bannerlord Nexus Mods Bannerlord section], navigate to a mod you would like to download (Example: [https://www.nexusmods.com/mountandblade2bannerlord/mods/49 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.
 +
 
 +
[[File:BannerlordMod.JPG|800px|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.
 +
 
 +
[[File:BannerlordInstall.JPG|800px|BannerlordInstall.JPG]]
  
To get started you'll need to visit the Nexus Mods page for [https://nexusmods.com/Kenshi Kenshi] and choose a mod you'd like to download.
+
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.
  
On the mod page, there are two buttons that will download the mod directly through Vortex.
+
[[File:BannerlordEnable.JPG|RTENOTITLE]]
  
[[File:ModPageKenshi.JPG|600px|ModPageKenshi.JPG]]
+
'''Optional'''
  
One button, in the top right, will download the primary file for this mod immediately. Alternatively, if you'd rather check which file you're downloading, head to the "Files" tab of the mod page and use the "Mod Manager Download" button on the file.
+
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.
  
[[File:InstallPageKenshi.JPG|800px|InstallPageKenshi.JPG]]
+
[[File:Automation.JPG|RTENOTITLE]]
  
Once the file has downloaded via Vortex, click the "Install" button in the notification or navigate to the "Mods" section within Vortex and click on the "Never installed" button. Once the installation is complete, the button will change to say "Disabled". Click on it again to enable the&nbsp;mod (or use the button in the notification).
+
&nbsp;
  
You can now start the game by pressing the "Play" button on the game art in the top left of Vortex. This will bring up the game's launcher. Please make sure to tick the box next to the mods you have enabled in Vortex for them to be able to be loaded correctly.
+
And that's it! The mod is now ready to be used ingame.
  
[[File:KenshiLauncher1.JPG|KenshiLauncher.JPG]]
+
[[File:LaunchGame.JPG|800px|LaunchGame.JPG]]
  
To verify that your mods are installed, check the mods menu in-game. For new levels, you'll need to speak to the Mafia in the Mail Room of your ship (requires the Ice Hat and 8 Time Pieces to access it).
+
For Vortex 1.2.0 and above: Lastly, make sure to use the play button in the top left to run Bannerlord in Single Player mode. This will skip the game's launcher&nbsp;and ensure that the load order you set in Vortex is loaded.
  
[[File:KenshiModsIngame.jpg|800px|KenshiModsIngame.jpg]]
+
&nbsp;
  
== Troubleshooting ==
+
== Managing your Bannerlord Load Order ==
  
=== Does Vortex work with the Steam version of Kenshi? ===
+
{{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. &nbsp;
  
Yes. Vortex can install and manage mods for both the Steam and GOG.com versions of the game. Only mods installed from Nexus Mods (or manually dropped into Vortex) will be visible in the app though. You can still use mods from Steam Workshop together with mods installed through Vortex, but you will have to manually manage those or use the workshops subscription system if you want to un- or re-install those.
+
*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.  
  
 
&nbsp;
 
&nbsp;
  
=== I'm getting a security prompt each time I install a mod, can I stop that? ===
+
[[File:BANNERLORDLoadOrder.JPG|1050px|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>"''
 +
 
 +
[[File:BannerlordMissingDependencies.JPG|700px|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":
 +
 
 +
[[File:BannerlordDependencyFixed.JPG|600px|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&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:
 +
 
 +
#Mods are sorted by dependencies. A mod dependent on another mod will be sorted after its requirement.
 +
#Other than that, mods will be sorted in alphabetical order based on the '''Module ID''' defined in the SubModule.xml file.
 +
 
 +
== Troubleshooting ==
 +
 
  
Depending on your settings, Vortex may select "[[Deployment_Methods#Symlink_Deployment|Symlink Deployment (Run as Administrator)]]" as the default. This is perfectly fine to use but will require you to accept a security prompt from Windows each time you deploy or change your mods.
+
=== Should I be using the Game launcher to rearrange mods? ===
  
To avoid this, you may want to go to Settings > Mods and change the deployment method to "[[Deployment_Methods#Hardlink_Deployment_(Default)|Hardlink deployment]]", then click "Apply". This will require one final security prompt to save the change.
+
No, if you are using Vortex to manage the game then you should always launch the game directly through Vortex. This will bypass the game's launcher.
  
''See also: [[Deployment_Methods|Deployment Methods]]''
+
=== Placeholder ===
  
[[Category:Pages with broken file links]] [[Category:Vortex]] [[Category:Getting Started]] [[Category:Kenshi]] [[Category:Modding Guides]]
+
[[Category:Vortex]] [[Category:Getting Started]] [[Category:Bannerlord]] [[Category:Modding Guides]]

Latest revision as of 13:47, 31 August 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

 

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

LaunchGame.JPG

For Vortex 1.2.0 and above: Lastly, make sure to use the play button in the top left to run Bannerlord in Single Player mode. This will skip the game's launcher and ensure that the load order you set in Vortex is loaded.

 

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. Mods are sorted by dependencies. A mod dependent on another mod will be sorted after its requirement.
  2. Other than that, mods will be sorted in alphabetical order based on the Module ID defined in the SubModule.xml file.

Troubleshooting

Should I be using the Game launcher to rearrange mods?

No, if you are using Vortex to manage the game then you should always launch the game directly through Vortex. This will bypass the game's launcher.

Placeholder