Epic - Game Support - Baldurs Gate 3

[LukeNexusMods]

BG3 support

Game files

• Game folder
• Appdata/local/larian/Baldur's Gate 3/

We might want to be a bit more restrictive than that.

Types of mods

Pak mods:

Majority of mods, .pak archives to be installed in Appdata/local/larian/Baldur's Gate 3/Mods

Loose files mods:

Unpacked pak loose files, folder structure will usually have root in Game/data
Should be discouraged, often used for texture replacements. Might cause file conflicts.

Script Extender

Custom install

NativeMods loader

custom install

Native dll mods

dll mods to be installed in game/bin/NativeMods
Might have or generate an attached toml file and will generate a log file for each dll.

Installers

One for each of the mod types

Synchronizer

Startup is slow even when not backing up any files, because indexing (hashing) still takes multiple minutes.

Executables:

Add game executables as run tools
Add option to run Dx11 executable

Health Checks

• Investigate if we can show missing pak mod dependencies

Load ordering

• See Load Order UI/UX design #1959 and Epic: Load Order #1958

Collections

• Check that existing collections work correctly
• In particular regarding handling of loadorder (if this is not done, collections will be useless for multiplayer)

MVP Todo:

• Add BG3 AGame implementation Basic BG3 support #2052
• Define which files to ignore/not backup Basic BG3 support #2052
• Support installing mods Add support for installing BG3 mods #2067
  • pak mods Add support for installing BG3 mods #2067
  • loose files Data mods Add support for installing BG3 mods #2067
  • script extender Add support for installing BG3 mods #2067
  • NativeMods loader Add support for installing BG3 mods #2067
  • NativeMods dlls mods Add support for installing BG3 mods #2067
• BG3: Add game as executable tool Add support for installing BG3 mods #2067
• Fix BG3 paths on Wine: Use mapped filesystem #2110
  • Wine games don't have access to game prefix mapped FileSystem  #2107
• BG3: Implement parsing of pak mods BG3 Pak parsing for Load Order and Health Checks #2144
  • Parse Headers BG3 Pak parsing for Load Order and Health Checks #2144
  • Parse list of contained files BG3 Pak parsing for Load Order and Health Checks #2144
  • Extract the packed meta.lsx file BG3 Pak parsing for Load Order and Health Checks #2144
  • Parse the extracted meta.lsx file BG3 Pak parsing for Load Order and Health Checks #2144
    • Parse dependency list BG3 Pak parsing for Load Order and Health Checks #2144
    • Parse all version formats into semantic version BG3 Health Checks and improvements #2175
• BG3: Load Order support
  • BG3: Add docs for how loadorder works BG3 Pak parsing for Load Order and Health Checks #2144
  • BG3: Implement modsettings.lsx load order Serialization (requires pak parsing) BG3: Add support for serializing and deserializing modsettings.lsx Load Order file #2149
  • BG3: Implement modsettings.lsx load order Deserialization (requires pak parsing) BG3: Add support for serializing and deserializing modsettings.lsx Load Order file #2149
  • BG3: Integrate with Load Order backend and implement BG3 specific behavior
  • BG3: Add option to disable Load Order management (in case of game updates breaking it, or users wanting to use their own solutions to manage it).
  • BG3: Enable newly added Pak files in the load order
• BG3: Detect and show externally added pak files (from in-game mod manager) as mods in the loadout #2215
• Ensure BG3 collections are working correctly (requires BG3 Load Order support)

Extras

• Health Checks:
  • BG3: Add health check for missing pak dependencies (requires pak parsing) BG3 Pak parsing for Load Order and Health Checks #2144
  • BG3: Add health check for outdated pak dependencies (requires pak parsing) BG3 Health Checks and improvements #2175
  • BG3: Add health check for mods requiring Script Extender BG3 Script Extender Health Checks #2206
  • BG3: Add health check for invalid Pak files BG3 Health Checks and improvements #2175
  • BG3: Add health check to tell wine users to add WINEDLLOVERRIDE on steam. BG3 Script Extender Health Checks #2206
• BG3: Add icons or tags for contents of mods: pak, loose, dlls, requires script extender, etc
• BG3: Always run the LariLauncher.exe to allow users to select Vulkan or DX11 renderer BG3 Health Checks and improvements #2175
• BG3: Add way to configure which executable to run (Vulkan, DX11, Launcher)
• BG3: Investigate running BG3SE Linux(Wine) extra install requirements
• BG3: Auto set WINEDLLOVERRIDE env when running BG3SE on Wine.
• BG3: Add DX11 and Vulkan LariLauncher.exe details to BG3 docs BG3 Health Checks and improvements #2175
• BG3: Write docs for how loadorder and pak files work BG3 Pak parsing for Load Order and Health Checks #2144