Baldur's Gate 3 update for Vortex (now live)

insomnious · October 17, 2023

Hi Baldur's Gate 3 fans!

It's been a lot of work over the last few weeks to get this extension working better than ever before and I can't thank the testers enough who joined the discord channel to help get this ready for the masses.

Restart Vortex and it will show an update as being available. It will then download the update and then need a restart.

This is a big update and so I can't stress enough that if you have spent a lot of time and effort on your perfect load order for 100s of mods, then please please make a backup of your game's modsettings.lsx file (located in %APPDATA%\Local\Larian Studios\Baldur's Gate 3\PlayerProfiles\Public\). The new extension will also make a backup just in case.

Happy modding!

insomnious

---

Requirements

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 (https://modding.wiki/en/vortex/users/modding-baldurs-gate-3-with-vortex)

Getting Set Up

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).

Migration

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.

Dependencies

Mod Fixer

As Baldur's Gate 3 doesn't have official mod support (yet - https://larian.com/support/faqs/mod-information_77), 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 (https://www.nexusmods.com/baldursgate3/mods/141?tab=description) on Nexus Mods to download it.

LSLib

In the majority of cases, mods for Baldur's Gate 3 will require a 3rd party tool called LSLib (https://github.com/Norbyte/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.

Settings

Found in Settings > Mods when Baldur's Gate 3 is selected

Auto export load order (Defaults to On)

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

Troubleshooting

See below for known problems and fixes to common modding problems

Known Issues

This extension has been tested with all of the most popular mods, installers, script extenders, mod fixers etc. Please see this Mod Compatibility List (https://forums.nexusmods.com/index.php?/topic/13287213-baldurs-gate-3-mod-compatibility-megathread/) 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.

Load Orders

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.

Launching using Vulkan (and not the default DX11)

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".

Full release issues

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 (https://larian.com/support/faqs/mod-information_77) 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.

Further Support

Mod Compatibility List (Nexus Forums) (https://forums.nexusmods.com/index.php?/topic/13287213-baldurs-gate-3-mod-compatibility-megathread/)
Vortex Support (Nexus Forums) (https://forums.nexusmods.com/index.php?/forum/4306-vortex-support/)
Vortex Support (Discord) (https://discord.com/channels/215154001799413770/408252140533055499)

Thanks!

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.

What's New

[1.3.7] - 2023-10-18

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.
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.
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 (https://www.nexusmods.com/baldursgate3/mods/141) to fix notification showing when it's already installed
Added installer and modtype for BG3 Script Extender (https://github.com/Norbyte/bg3se)
Updated testing documentation and mod compatibility (https://forums.nexusmods.com/index.php?/topic/13287213-baldurs-gate-3-mod-compatibility-megathread/)

Petruusa · October 19, 2023

Hi, I am having a problem with the load order. I keep getting a "Failed load order operation" error. On the mods section everything seems enabled, and when I click deploy in there it seems fine, no errors pop up. But when I go to the load order page it's empty. It justr says " You don't have any orderable entries. Please make sure to deploy" and when I click refresh it sends out the "failed load order operation" error. When I clicked for more info and the details it said " TypeError: Cannot read properties of undefined (reading 'id')" and then the first 3 entries were at C:\Users\[name]\AppData\Roaming\Vortex\plugins\Vortex Extension Update - Baldur's Gate 3 v1.3.7\loadOrder.js:122:36

at Array.forEach (<anonymous>)

at C:\Users\[name]\AppData\Roaming\Vortex\plugins\Vortex Extension Update - Baldur's Gate 3 v1.3.7\loadOrder.js:119:23

at Generator.next (<anonymous>)

at fulfilled (C:\Users\[name]\AppData\Roaming\Vortex\plugins\Vortex Extension Update - Baldur's Gate 3 v1.3.7\loadOrder.js:28:58)

This was not a problem yesterday. I have tried disabling and then enabling every single mod. I have disinstalled and then reinstalled the mods. I have tired to look at the paths, all are in order. I even stopped managing the game and then managed it again. The only thing I can think about trying is uninstalling both Vortex and BG3 and try to reinstall them both, but I really don't want to do that. So I hope someone is able to help me

LucienW · October 19, 2023

I've been using vortex to load mods for over 1 month，recently I cant install new mods. so I re-intall LSlib.Now vortex can't load any mods. I've made sure the game extension version is 1.3.7(attach files)

TypeError: Cannot read properties of undefined (reading 'id')

at C:\Users\zodia\AppData\Roaming\Vortex\plugins\Vortex Extension Update - Baldur's Gate 3 v1.3.7\loadOrder.js:122:36

at Array.forEach (<anonymous>)

at C:\Users\zodia\AppData\Roaming\Vortex\plugins\Vortex Extension Update - Baldur's Gate 3 v1.3.7\loadOrder.js:119:23

at Generator.next (<anonymous>)

at fulfilled (C:\Users\zodia\AppData\Roaming\Vortex\plugins\Vortex Extension Update - Baldur's Gate 3 v1.3.7\loadOrder.js:28:58)

at tryCatcher (C:\Program Files\Black Tree Gaming Ltd\Vortex\resources\app.asar\node_modules\bluebird\js\release\util.js:16:23)

at Promise._settlePromiseFromHandler (C:\Program Files\Black Tree Gaming Ltd\Vortex\resources\app.asar\node_modules\bluebird\js\release\promise.js:547:31)

at Promise._settlePromise (C:\Program Files\Black Tree Gaming Ltd\Vortex\resources\app.asar\node_modules\bluebird\js\release\promise.js:604:18)

at Promise._settlePromise0 (C:\Program Files\Black Tree Gaming Ltd\Vortex\resources\app.asar\node_modules\bluebird\js\release\promise.js:649:10)

at Promise._settlePromises (C:\Program Files\Black Tree Gaming Ltd\Vortex\resources\app.asar\node_modules\bluebird\js\release\promise.js:729:18)

at _drainQueueStep (C:\Program Files\Black Tree Gaming Ltd\Vortex\resources\app.asar\node_modules\bluebird\js\release\async.js:93:12)

at _drainQueue (C:\Program Files\Black Tree Gaming Ltd\Vortex\resources\app.asar\node_modules\bluebird\js\release\async.js:86:9)

at Async._drainQueues (C:\Program Files\Black Tree Gaming Ltd\Vortex\resources\app.asar\node_modules\bluebird\js\release\async.js:102:5)

at Async.drainQueues (C:\Program Files\Black Tree Gaming Ltd\Vortex\resources\app.asar\node_modules\bluebird\js\release\async.js:15:14)

ac90909 · October 19, 2023

I'm having the same exact problem as Petruusa since updating the Vortex extension to v 1.3.7 today. I get the "Failed load order operation" message and the Load Order section of Vortex says "You don't have any orderable entries." Loading my save games gives me the missing mods error. All my pak files are in the mods folder, but they have all been disabled now.

I've tried purging and then deploying but that didn't do anything.

I also tried importing the backup of the modsettings.lsx from 2 days ago, but I get a "Failed to import load order" message in Vortex, so I can't even go back to how things were before this extension update.

Edit: All the Vortex errors remain, but I renamed the backup modsettings.lsx file and the game reads it. So my previous mod settings from 2 days ago does load in to the game without the missing mods error. However, if I try to add any new pak mod in Vortex, after deploying, my load order section is still empty ("no orderable entries"), and the new mod doesn't seem to show in game. But I can get the new mod working by adding it manually and using BG3 Mod Manager for the load order so I'll stick with that for now

Edited October 19, 2023 by ac90909

MoratJG · October 20, 2023

Same issues with load order errors as those above.

"failed order operation"

TypeError: Cannot read properties of undefined (reading 'id')

at C:\Users\sherf\AppData\Roaming\Vortex\plugins\Vortex Extension Update - Baldur's Gate 3 v1.3.7\loadOrder.js:122:36

at Array.forEach (<anonymous>)

at C:\Users\sherf\AppData\Roaming\Vortex\plugins\Vortex Extension Update - Baldur's Gate 3 v1.3.7\loadOrder.js:119:23

at Generator.next (<anonymous>)

at fulfilled (C:\Users\sherf\AppData\Roaming\Vortex\plugins\Vortex Extension Update - Baldur's Gate 3 v1.3.7\loadOrder.js:28:58)