Baldur's Gate 3 Script Extender
Baldur's Gate 3 Script Extender is a free scripting tool for Baldur's Gate 3 mods.
What Baldur's Gate 3 Script Extender is
Baldur's Gate 3 Script Extender is a free scripting tool for Baldur's Gate 3 mods. It adds Lua and Osiris support: mods can turn on Lua with a feature flag and load scripts for the game server and clients. The extender keeps a separate Lua state for the server and each client, and its console can run Lua code and registered commands. Configuration options provide Lua and Osiris debugger interfaces with configurable listening ports, plus file logging for Osiris activity, runtime output, story compilation, and compilation errors. An EnableAchievements setting can re-enable achievements in modded games. After a crash, the default SendCrashReports setting uploads minidumps to a collection server. Installation involves extracting DWrite.dll into the game's bin directory. The extender updates when the game launches, but it requires patch 5 or later and releases target the latest game version. It supports Windows and Linux via Proton. Its license includes MIT terms and a Commons Clause restriction against selling the software or substantially derived products and services.
Good
- Enables Lua and Osiris scripting in mods.
- Console runs Lua code and registered commands.
- Offers configurable Lua and Osiris debugger interfaces.
- Can log runtime and compilation activity to files.
- Free to obtain under its published license.
Watch out
- Does not run on game versions older than patch 5.
- New releases target the latest game version.
- License restricts selling the software and substantially derived offerings.
- Crash-report uploads are enabled by default.
Who it suits
It suits Baldur's Gate 3 mod creators who want to use Lua or Osiris scripting and related debugging and logging options. Users need patch 5 or later and a supported Windows or Linux-via-Proton setup.
Verdict
Baldur's Gate 3 Script Extender provides mod authors with scripting, console, debugging, and logging capabilities. Check the game-version requirement and license restriction before using it.
Plans and prices
From Baldur's Gate 3 Script Extender's own pricing page, checked 15 Oct 2026.
| Plan | Price | What it gives you |
|---|---|---|
| Baldur's Gate 3 Script Extender | Free | Windows/Linux Proton modding tool · requires Baldur's Gate 3 · version-specific compatibility |
The facts
Each one read from Baldur's Gate 3 Script Extender's own pages, with the date it was checked.
What it does
- Achievements
- The default configuration re-enables achievements for modded games.checked 15 Oct 2026
- Automatic updates
- The updater downloads and applies the matching extender when the game launches, so GitHub releases represent updater changes rather than every extender build.checked 15 Oct 2026
- Build requirements
- Developers are instructed to run first-time-setup.bat from an MSVC x64 Native Tools command prompt and then use Visual Studio.checked 15 Oct 2026
- Client and server
- The extender maintains separate Lua states for the game server and each client.checked 8 Oct 2026
- Console
- The extender provides an interactive console that executes Lua and can invoke Osiris functions.checked 15 Oct 2026
- Console limitation
- The community installation guide says PlayStation and Xbox have no official Script Extender support.checked 15 Oct 2026
- Crash reports
- The SendCrashReports option defaults to true and uploads minidumps to a crash report collection server after a game crash.checked 8 Oct 2026
- Debugger ports
- The documented default ports are 9999 for Osiris debugging and 9998 for Lua debugging.checked 15 Oct 2026
- Debugging
- Configuration supports console logging, runtime logs, compilation logs, an Osiris debugger and a Lua debugger.checked 15 Oct 2026
- Documentation depth
- The Lua API document is about 1,957 lines and includes examples and function behavior details.checked 15 Oct 2026
- Events API
- Lua scripts can subscribe to engine events with priority and one-shot options.checked 15 Oct 2026
- Game data APIs
- Documented modules cover entities, stats, resources, localization, audio, templates, level operations and math.checked 15 Oct 2026
- Game version limit
- The FAQ says the extender does not run on game versions older than patch 5 and new versions are released for the latest game version.checked 8 Oct 2026
- Independent installation support
- BG3 Wiki says the extender can be installed manually or through Baldur's Gate 3 Mod Manager and updates itself at game startup.checked 15 Oct 2026
- Independent praise: ecosystem importance
- A BG3 modding guide presents the extender as the foundation for writing mods with Lua and Osiris scripting.checked 15 Oct 2026
- Independent praise: mod compatibility
- PC Gamer describes the extender as Patch 8 verified and often required for many other Baldur's Gate 3 mods.checked 15 Oct 2026
- Installation
- The official release instructs users to extract DWrite.dll into the game's bin directory.checked 15 Oct 2026
- Intended users
- The documentation describes using the extender in mods, including setting a mod configuration file and Lua feature flag.checked 8 Oct 2026
- Licence
- The repository combines an MIT licence with a Commons Clause condition that excludes selling the software or services whose value substantially derives from it.checked 15 Oct 2026
- License
- The repository license includes the MIT License and a Commons Clause condition that excludes selling the software or substantially derived products and services.checked 8 Oct 2026
- Limit: crash causes
- The official troubleshooting guide says crashes commonly result from game-version incompatibility or incompatible mods after a game update.checked 15 Oct 2026
- Limit: update breakage
- A Reddit discussion reports that automatic updating to version 33 produced an error and users needed developer mode to select version 32.checked 15 Oct 2026
- Logging
- Configuration options can log Osiris activity, runtime output, story compilation, and compilation errors to files.checked 8 Oct 2026
Where it runs
- Linux support
- The community installation guide documents Windows and Linux/Steam Deck use through Proton, with extra launch options required.checked 15 Oct 2026
Alternatives to Baldur's Gate 3 Script Extender
- 1
MelonLoader
Free planOpen sourceAndroidLinuxmacOSWindows7.5Free plan - 2
BepInEx
Free planOpen sourceAPILinuxmacOSWindows7.2Free plan - 3
Satisfactory Mod Loader
Free planLinuxWindows6.4Free plan - 4

SMAPI
Free planAndroidLinuxmacOSWindows6.4Free plan - 5
RED4ext
Free planWindows6.3Free plan - 6
ScriptHookVDotNet
Free planWindows6.3Free plan
