-
Notifications
You must be signed in to change notification settings - Fork 137
MODDINGWIKI Users GameGuides Modding Baldur's Gate 3 with Vortex
Before we get started, this guide assumes that you have installed Baldur's Gate 3 and Vortex at their default locations. You will also need to be logged in to your Nexus Mods account in Vortex.
Please see: Getting Started with Vortex
Open up Vortex and navigate to the Games page. Use the 'Manage' button on the game tile to add it to your managed games. If you can’t see Baldur's Gate 3, you can scan for it or define it manually.
On first load, you will be prompted to install LSLib and the recommended, but optional, 'Mod Fixer' mod (see below Dependencies).
If migrating from an existing version (older than 0.3), there are some extra things to be aware of.
-
A backup is made of the game's load order file,
modsettings.lsx
, as a fallback in case anything goes wrong. This is located in the same folder as the original at%APPDATA%\Local\Larian Studios\Baldur's Gate 3\PlayerProfiles\Public\modsettings.lsx.backup
-
The original
modsettings.lsx
is then imported so Vortex can attempt to match the Game's load order for future changes to stay in sync. This isn't perfect but may help not to have to completely rearrange 100s of mods. -
Vortex defaults to keeping the game's
modsettings.lsx
file in sync with it's own load order as this is what the majority of users will expect. If you don't want this to be the case, see the Settings section below to turn it off and use the backup made above to put your original game load order back. Please note: when this setting is off, the game's load order is never set.
As Baldur's Gate 3 doesn't have official mod support (yet), a fix is needed so that certain mod types work. Some mods already include this fix as part of what they are doing anyway and there is no harm in having this fix multiple times. Vortex will notify you of 'Recommended Mods' and will link to Baldur's Gate 3 Mod Fixer on Nexus Mods to download it.
In the majority of cases, mods for Baldur's Gate 3 will require a 3rd party tool called LSLib to manipulate game files. When you first manage the game, Vortex should popup and give you the option to download and install this tool automatically. If that has already been dismissed, it can be accessed again via the 'Re-install LSLib/Divine' button on the toolbar in the Mods page of Vortex.
Please ensure that the tool is always enabled and deployed on the mods page. Some Anti-Virus software may flag this tool as malicious due to the nature of what it does. We suggest you ensure that your security software is configured to allow this tool to install.
Found in Settings > Mods when Baldur's Gate 3 is selected
Name | Description | Default |
---|---|---|
Auto export load order | If on, Vortex will update the Game's load order automatically. If off, the Game's load order will need manually Exporting using the buttons on the toolbar | On |
See below for known problems and fixes to common modding problems
-
This extension has been tested with all of the most popular mods, installers, script extenders, mod fixers etc. Please see this Mod Compatibility List forum post for details.
-
When installing mods in previous versions of the extension, some workarounds were necessary that are no longer needed. Fox example, Mod types being manually set as an Engine Injector was common. This shouldn't break a working setup but when mods are updated or reinstalled they will be installed correctly. If mods do seem to be in a wrong folder, then reinstalling that mod should fix this. This is easily done by finding the mod
-
Rarely, during mod updating or purging, Vortex spams errors saying about failure to read PAK files. This is nothing to worry about, they can be dismissed and will be fixed in next version.
Most load order issues can be fixed with a Purge and then Deploy. This removes PAK files from the Mods folder and then Deploy re-writes them with a fresh load order. Please note: the load order will be reset and so will require a reordering.
Vortex does have the ability to launch the Vulkan version of the game instead of the default DX11 but it does require setting Vulkan as primary launch method.
On the Dashboard, find the "Tools" dashlet and there should be a Vulkan option there. Click the little menu button and select "Set as primary".
Baldur's Gate 3 had a huge mod-breaking update on August 3rd 2023 when the game left early access. Some of the files that Vortex (and other mod managers) were relying on changed and have possibly become corrupted while we were updating our Vortex support for it. Most mods will also need to be updated to support the latest version of the game. Vortex uses these files and automatically edits them when managing mods.
The below instructions should reset the game files and allow you to continue your modding adventure. Larian Studios, the developers of Baldur's Gate 3, also recommend doing the below if having any problems starting the game.
- Make sure the Baldur's Gate 3 extensions in Vortex is the latest version. You can check by going Vortex > Extensions > Click 'Show bundled' > Game: Baldur's Gate 3 > Version should be greater than 1.2.2.
- Close Vortex
- Delete all files in
%AppData%\Local\Larian Studios\Baldur's Gate 3\Mods
- Delete
modsettings.lsx
in%AppData%\Local\Larian Studios\Baldur's Gate3\PlayerProfiles\Public
- Run Baldur's Gate 3 at least once (for the deleted files to be recreated).
- Load Vortex and Re-deploy your mods.
Thank you to all members of the #vortex-baldursgate3 discord channel that have spent time and effort to help test this extension before we send out into the wild. It's a pretty big update and their input has been invaluable when trying to find those niche issues and to just have more eyes on. We have plenty of plans to further Baldur's Gate 3 support and hopefully everyone will be just as willing to test and help make decisions around the best way to tackle it.
- Added activity notification when importing load order
- Fixed importing missing mods name comparison
- Removed some spamming console logs
- Load Order now uses pak filename to uniquely identify
- Fixes potential import issue where 'Name' was being compared 'Folder'
- Catching of non-response from LSLib CLI
- Fix handling of duplicates during importing but a warning is still shown just in case.
- Extra logging for tracking down of random locking bug.
- Removed cache when accessing a pak files meta.lsx file which allows fix for random locking by purging/deploying.
- Backup of
modsettings.lsx
is created on initial managing of BG3 - Initial import of
modsettings.lsx
happens when a backup isn't found (should solve migration issues)
- Mods containing multiple PAK files can load order each individual pak
- Buttons for importing load order from file or direct from BG3
- Buttons for exporting load order to file or direct to BG3
- Toggle in Settings (Settings > Mods) to disable auto exporting load order to game (defaults to enabled)
- Re-written load ordering so that Vortex has it's own data and doesn't rely on the game's
modsettings.lsx
file. - Added 'Export to Game' button on Load Order page to write the game's
modsettings.lsx
file.
- Fixed default
modsettings.lsx
having outdated Name and UUID - Fixed Engine Injector installer so no longer needing manual setting when installing mods to the Game root folder.
- Updated extension game art
- Updated installer and modtype for mods that need deploying to the
%GAMEROOT\Data
folder. - Added installer for Mod Fixer to fix notification showing when it's already installed
- Added installer and modtype for BG3 Script Extender
- Updated testing documentation and mod compatibility
- Support for full release
This wiki and the Vortex Readme document contains a lot of information, please take your time and read these instructions carefully.
We provide detailed changes for each Vortex release.
If you have any questions about Vortex usage or want to share some information with the Vortex community, please go to one of the following places:
- About
- Install
- Troubleshooting
- Troubleshooting
- Developers
- Troubleshooting
- Developers
- Valheim
- Bannerlord
- BepInEx
- How to test a game extension
- How to package a game extension
- How to upload an extension to Nexus
- How to submit a game extension for review
Warning
The below documentation has not been checked for quality since migrating to GitHub Wiki and the information contained is potentially out of date and\or repeated.
- Frequently Asked Questions
- Getting Started
- Deployment Methods
- Downloading from Nexus Mods
- Managing File Conflicts
- Managing your Load Order
- Managing Save Games
- Setting up Profiles
- Keyboard Shortcuts
- How to create mod installers
- External Changes
- The Vortex Approach to Load Order
- Moving Vortex to a new PC
- Modding Skyrim Special Edition with Vortex
- Modding Mount & Blade II: Bannerlord with Vortex
- Modding Monster Hunter: World with Vortex
- Modding The Witcher 3 with Vortex
- Modding Baldur's Gate 3 with Vortex
- Modding Stardew Valley with Vortex
- Modding Valheim with Vortex
- Error Messages
- Misconfigured Documents Folder
- .NET 6 Install Issues
- Downgrading Extensions
- Command Line Parameters
- Introduction to Vortex extensions
- Creating a game extension (JavaScript)
- Creating a theme
- Game detection
- Adding a main page
- Adding a load order page
- Building UI with Vortex and React
- Packaging an extension
- Introduction
- Packaging extensions
- Project management
- Harmony Patcher Exectuable
- Vortex Harmony Mod Loader
- Setting up your dev environment
- Creating a theme
- Creating a game extension