Modding:Installing mods

From Baldur's Gate 3 Wiki
Revision as of 23:49, 31 May 2024 by Waukeen (talk | contribs) (Fixed some minor grammatical errors, and did some minor text formatting.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Bgwiii.png CommunityGuidesModding

Modding guides
Modding resources

Having trouble with your installed mods? See our Mod Troubleshooting page.

  • Script Extender (bg3se) by Norbyte
    • Latest Version Found here
    • Can be installed manually or by using BG3MM: Tools → Download & Install the Script Extender
    • Updates itself when starting the game
  • BG3 Mod Manager (BG3MM) by LaughingLeader

Baldur's Gate 3 Mod Manager[edit | edit source]

Before doing any of these steps, please ensure that you have downloaded the Baldur's Gate 3 Mod Manager (simply scroll down to the Setup instructions and click on the highlighted "Grab the latest release."). Please note that as of Patch 9 in EA, your profile within the mod manager must be set to "Public" to use the mod manager properly. This option will be at the top left of the mod manager.

  1. Find the mod you would like to download and download the file. This is usually a zip file. When downloading mods from Nexus Mods, make sure to select "Manual Download" to have the file downloaded to your computer.
  2. Open the zip file. This is quite simple, all you need is a folder unarchiving software such as 7zip. Double-click the zip file and open it with the software. The zip file usually contains an info.json JSON file, README text document, and the actual mod itself which will be a .pak file.
  3. In another window, open your file explorer and go to the mod folder for Baldur's Gate 3. The mod folder will be located at a location generally named C:\Users\<yourusername>\AppData\Local\Larian Studios\Baldur's Gate 3\Mods. Please note that the \AppData\ folder is hidden by default. To be able to easily access it as well as other hidden folders, click "View" at the top left of the file explorer and check mark the "Hidden Items." box.
  4. Go back to the window of the zip file, and drag the mod's .pak file into the "Mods" folder for BG3.
  5. Open the BG3 Mod Manager. The mod you just dragged into the Mods folder should appear on the right of the screen. If it does not, try clicking Refresh above it. The Patch 3 Mod Fixer is an exception, and does not appear in the mod manager nor does it need to be activated. Repeat steps 1-4 for all the mods you want.
  6. Click and drag all the mods to the left side of the screen. Please note that load order can be crucial for some mods, so make sure to put mods that other mods are dependent on above them in the load order. Once you have dragged all the mods you would like to use to the left side of the screen, make sure to save your load order by clicking the save button beside the "Mod Order" label.
  7. Export your order to the game by clicking the first icon beside the word "Export" at the top bar.

BONUS STEP FOR DIRECTX 11 USERS: You will need to enable DirectX 11 mode for the mods to work if you are using that version of the game. Simply click "Settings" in the top most bar, click on "Open Preferences", tick "Enable DirectX 11 Mode" then click on "Save" at the bottom.
Launching the game: You will need to launch the game through the mod manager for most of the mods to work properly. At the top bar, beside "Shortcuts", there are a few icons; a file icon that will automatically open the Mods folder mentioned in step 3, an icon that opens the workshop folder, an icon that opens the logs, and the BG3 icon. Click on the BG3 icon to launch the game. The launcher should open, and you should be able to simply press play and enjoy your mods. Note that some mods need you to turn off the sending of analytical data to Larian, which you can do at the launcher by simply going into settings at the bottom left.

For mods that aren't .pak files, you will need to follow any instructions the mod author has posted. Usually, mods that replace base game files need to be placed in the downloaded files, usually in Program Files(x86) then the app you used to download the game, then in Baldurs Gate 3\Data or bin. Be sure to follow the mod author's instructions.

Manually[edit | edit source]

  1. Download the mod(s).
  2. Unzip into the Mods folder using a program like 7zip.
  3. If the mod comes with its modsettings code in the description or pinned in the Posts section use that.
    1. Add the mod to the modsettings.lsx file located in PlayerProfiles/Public.
    2. Save and exit.
  4. If no code is provided you'll have to make it yourself. This is easy.
    1. Open Larian Studios/Baldur's Gate 3/PlayerProfiles/Public/modsettings.lsx.
    2. Copy and paste the GustavDev entry below itself. From <node id="ModuleShortDesc"> to the closing </node>.
    3. Change Name, Folder, and UUID to match the info.json that should have come with the mod you are currently installing.
    4. Save and exit.
  5. Repeat either 3 or 4 as needed for each mod you want to install.
  6. Set modsettings.lsx to read only. If this isn't done, the game will overwrite the file and changes will have to be made again.

If the mod you are installing doesn't come with an info.json, ask the mod author nicely to either provide one or supply the code for manual installation.

Mod Order[edit | edit source]

Some mods have load order requirements. In the example below, the section with <node id="ModOrder"> determines what order your mods are loaded in. BG3MM and Vortex do this automatically, but if you're on Mac or Linux it's very important to set this up correctly if you have lots of mods installed.
Gustav should always be the first item loaded in this file, as it's the whole game.
The mod order you need depends on what the descriptions of each mod you have downloaded states. Please carefully read the description, comments, and bugs sections of any mod you download.

Example Modsettings File[edit | edit source]

File from Basket Full of Equipment. SFW version (Full Release v1.0.8b).

<?xml version="1.0" encoding="UTF-8"?>
  <version major="4" minor="0" revision="8" build="2" />
  <region id="ModuleSettings">
    <node id="root">
        <node id="ModOrder">
            <node id="Module">
              <attribute id="UUID" value="28ac9ce2-2aba-8cda-b3b5-6e922f71b6b8" type="FixedString" />
            <node id="Module">
              <attribute id="UUID" value="b200f917-43ec-45d9-9dff-ac6191d62388" type="FixedString" />
        <node id="Mods">
            <node id="ModuleShortDesc">
              <attribute id="Folder" value="GustavDev" type="LSString" />
              <attribute id="MD5" value="41a80562831251b58df743c05a7af21b" type="LSString" />
              <attribute id="Name" value="GustavDev" type="LSString" />
              <attribute id="UUID" value="28ac9ce2-2aba-8cda-b3b5-6e922f71b6b8" type="FixedString" />
              <attribute id="Version64" value="144396877804629717" type="int64" />
            <node id="ModuleShortDesc">
              <attribute id="Folder" value="BasketEquipmentSFW" type="LSString" />
              <attribute id="MD5" value="" type="LSString" />
              <attribute id="Name" value="BasketEquipmentSFW" type="LSString" />
              <attribute id="UUID" value="b200f917-43ec-45d9-9dff-ac6191d62388" type="FixedString" />
              <attribute id="Version64" value="144115196665790673" type="int64" />

Vortex[edit | edit source]

This section requires instructions.

However, most mods do not recommend using Vortex over BG3MM, as it has been known to cause issues.