#bg3 script extender

This is a pet project I've been working on for a little while that is finally, I think, ready to see the light of day, and I'm excited to share it with y'all!

Visit http://bg3se.netlify.app for a useful cheat sheet of easily copyable and customizable commands to be used for various purposes in the BG3 Script Extender console mod.

Currently supported:

Quick-copy character UUIDs.

Search for plot flags and generate commands to set/unset/check them.

Search for character tags and generate commands to add/remove/check them.

Search for cutscenes and generate commands to trigger them dynamically with any character in each role. (Currently a non-exhaustive list due to the huge number of scenes in the game, but reach out to me if there's one you need and can't find!)

Search for items and generate commands to spawn them in your inventory.

Generate commands to spawn gold in your inventory, set character hitpoints, trigger a character respec, or set companion approval.

Suggestions very much welcome! Please reach out to me on Tumblr or Github if you have an idea for another feature, encounter a bug, or find some missing data.

So as of today (2/20/2024) Larian released Hotfix #18 to BG3. For those of you that are like me and enjoy modding the game, you've probably found Norbite's Script Extender is broken and a bunch of, if not all of, your mods are broken.

For those unfamiliar, Script Extender is what allows modders to use mods that use files, colors, commands, and models that aren't native to the innate code of the core game. Script Extender allows mod developers to extend the game's code so it will run normally alongside modded codes that alter, add, or remove features from the game.

Norbite has gone on-record saying that they do not know when they'll be able to fix this issue, as they had only just finished updating SE for Patch 6. Hotfix 18 changed some of the fundamental files within the game that will take longer and be more frustrating to fix, and there currently is no estimate for when SE will be fixed for Hotfix 18.

If you play using Steam, here's how you can roll back your game to Patch 6 and get Script Extender and your mods back:

Go into BG3's /bin folder. This is usually found in C:\Program Files (x86)\Steam\steamapps\common\Baldurs Gate 3\bin on most default downloads for PC.

Save/back up the original files in there.

Open your PC's Run menu (Win+R)

Write in the command: steam://open/console

Press Enter

Steam's engine should open automatically. You should see a blank page with a text window at the very bottom. This is Steam's console command menu.

In the command line, type the command: download_depot 1086940 1419652 8231067205656009020 [<delta manifestid>] [<depot flags filter>] : download single depot

Press enter. Steam should begin to download a few MB's worth of files.

Once steam finishes downloading, the same command screen will show you the exact file route where the newly downloaded folders were placed.

Open the new folder. There should be multiple different files of different types.

Copy all of the new files (Ctrl+A + Ctrl+C works)

Go back to BG3's original \bin within your Steam\steamapps\common\Baldurs Gate 3 path (see Step 1)

Paste (Ctrl+V) the new files into your \bin folder.

You should receive a prompt asking if you want to replace the files. Choose yes. (This is why you backed up the original files)

Close out of the folder and run BG3. You should receive a Data Mismatch warning from the LariLauncher. Ignore this and launch the game.

Man I would love to get script extender working but I've yet to crack it.

Unsure if you mean you can't get it installed or can't get commands to run successfully, so super apologies if I'm telling you stuff you already know (but posting this anyway in case it's useful to someone else).

Do you use BG3 Mod Manager? If so, there is an option to download and install the Script Extender quickly through that interface:

Run that command and complete the extraction, and then open the game via mod manager from the Go menu:

This will open the game directly (you may have to click a confirmation within Steam, although lately it hasn't been prompting me), and you will see two windows open at once - the game and also a console window.

Once you're loaded into a particular save, you can tab over to that console; hit enter a couple times and it will present you with the "server Lua console" input prompt:

You can then type any command you want into this prompt:

Still requires sorting through most of the scenes manually to see which ones are worth including in the app; I've automated a great deal of this process (pretty proud of this) and am using characters from my Young Jaheira playthrough to test triggering each scene manually... this is definitely leading to some humorous discoveries:

Has anyone run into the issue where the character you want to swap out for your own character is only partially changed? I was trying to swap out Minthara for my oc in her romance scene, using this command in script extender:

Osi.QRY_StartDialogCustom_Fixed("CAMP_GoblinHuntCelebration_SD_ROM_NightWithDrow_0166176a-2eb4-db38-81b9-003dde80485b", Osi.DB_Avatars:Get(nil)[1][1], "S_Player_Astarion_c7c13742-bacd-460a-8f65-f864fe41f255", 1,1, -1, 1 )