Baldur's Gate 3 Script Extender
github.com
- Free plan
- Open source
- Windows
- Linux
- API
What Baldur's Gate 3 Script Extender is
Baldur's Gate 3 Script Extender adds Lua and Osiris scripting support for Baldur's Gate 3 mods. Mod creators can enable Lua with a feature flag and load bootstrap scripts for the client and server. The extender keeps separate Lua states for the game server and each client, and its console can run Lua code and registered commands. Configuration options include Lua and Osiris debugger interfaces, configurable listening ports, and logging for Osiris activity, runtime output, story compilation, and compilation errors. An EnableAchievements option can re-enable achievements in modded games. The extender updates when the game launches by downloading and applying an update, but it does not run on game versions older than patch 5; releases target the latest game version. Installation requires extracting DWrite.dll into Baldur's Gate 3's bin directory. It is free to obtain under a published license that includes the MIT License and a Commons Clause restriction on selling the software or substantially derived products and services. The listed platforms are Windows and Linux via Proton.
Who it suits
This tool suits Baldur's Gate 3 mod creators who want to use Lua or Osiris scripting. It is intended for mod use and requires game patch 5 or later.
Good to know, and what to watch
- Adds Lua and Osiris scripting support.
- Includes a console for Lua code and commands.
- Offers debugger and logging configuration options.
- Can re-enable achievements for modded games.
- Does not run on game versions older than patch 5.
- Installation requires extracting a file into the game's bin directory.
- The Commons Clause restricts certain sales.
Plans
Every plan and priceBaldur's Gate 3 Script Extender
Free plan
Getting started
- Open the project website
- Use Baldur's Gate 3 on Windows or Linux through Proton
- Extract DWrite.dll into the Baldur's Gate 3 bin directory
- Enable Lua in a mod configuration file with its feature flag
- Load client and server bootstrap scripts
Limits to check
The extender does not run on Baldur's Gate 3 versions older than patch 5. New releases are made for the latest game version.
The Club's review
Baldur’s Gate 3 Script Extender is a free development tool for mods that need Lua or Osiris scripting in Baldur’s Gate 3. It is best suited to mod authors who want scripting and troubleshooting tools; players who do not use mods have little reason to install it. Its focused capabilities cost nothing, but compatibility follows the game’s latest version and its license restricts commercial use.
Overview
This extender gives Baldur’s Gate 3 mods access to Lua and Osiris, plus tools for running and diagnosing scripts. It is a practical choice when a mod needs behavior beyond what the game provides by itself, but it is not a general-purpose utility for ordinary play.
Installation requires extracting DWrite.dll into the game’s bin directory. The extender auto-updates when the game launches, while its version support has a clear boundary: it will not run on game versions older than patch 5, and new releases target the latest game version. That keeps support aligned with current releases, but can complicate work on mods tied to older game builds.
Key features
Lua and Osiris scripting
Mods can enable Lua through a feature flag and load bootstrap scripts for the client and server. Separate Lua states for the game server and each client give authors distinct scripting contexts, which is useful for mods that need to handle both sides of multiplayer. This setup is aimed at people building or configuring mods, not players looking for a ready-made gameplay feature.
Console and debugging
The console can execute Lua code and registered commands, providing a direct way to run scripts and commands during development. Configurable Lua and Osiris debugger interfaces, with listening ports, add options for diagnosing script behavior. These tools make the extender more useful to authors maintaining complex mods, though they presuppose familiarity with scripting and debugging.
Logging and achievements
Configuration options can write Osiris activity, runtime output, story compilation, and compilation errors to files. This gives mod authors several useful records for tracing failures rather than relying on a single stream of output. An EnableAchievements option can re-enable achievements in modded games, a targeted benefit for players who want achievements while using supported mods.
Crash reporting
SendCrashReports defaults to true and uploads minidumps to a crash report collection server after a game crash. That can help collect diagnostic data, but users who do not want crash dumps uploaded should review this setting.
Pricing
The Baldur’s Gate 3 Script Extender plan is free: free. It includes the extender’s scripting and development capabilities without a paid tier to weigh against them. There are no seat counts or usage quotas to factor into the choice.
The license combines the MIT License with a Commons Clause condition that excludes selling the software, or substantially derived products and services. That makes the free plan suitable for personal modding and development, but not for a commercial product whose value substantially derives from the extender. The software is provided as is, without warranties including merchantability or fitness for a particular purpose.
Platforms
The supported game is Baldur’s Gate 3, with Windows and Linux via Proton support. Its mod loading method is script, so it is a focused fit for mods built around its scripting support rather than a general loader for unrelated games.
Who it's for
Choose it if you create or maintain Baldur’s Gate 3 mods that need Lua or Osiris, want separate client and server scripting contexts, or need configurable debugging and logs. The console and reporting options are particularly useful when diagnosing mod behavior. If you only play without mods, or need to support an older game version, this is not the right tool.
Pros and cons
- Pros: Lua and Osiris support, separate client and server Lua states, and a console make it a capable scripting foundation for Baldur’s Gate 3 mods.
- Pros: Configurable debugger interfaces and detailed logging options give authors practical ways to investigate script and compilation issues.
- Pros: The extender is free, and automatic updates apply when the game launches.
- Cons: It does not run on game versions older than patch 5, and releases target the latest version, which limits support for older builds.
- Cons: Setup requires placing a DLL in the game’s bin directory, and its mod configuration and scripting features are aimed at authors rather than casual players.
- Cons: The Commons Clause restricts selling the software or substantially derived products and services; crash-report uploads are enabled by default.
Alternatives
If you are comparing tools for another game, Game Mod Loaders is a useful place to browse. For a different target or approach, consider these free options:
- Satisfactory Mod Loader is for Satisfactory and offers Windows client and server support plus Linux server support, with no required dependencies.
- MWSE welcomes contributions including ideas, bug fixes, documentation, and new features; choose it if you want to contribute to that project instead.
- SMAPI supports Android, Linux, macOS, and Windows, and requires Stardew Valley 1.6.14 or later on Linux, macOS, Windows, or Steam Deck.
- MelonLoader is a free option with Android, Linux, macOS, and Windows support under Apache License 2.0.
- BepInEx is a free, open-source option with manual installation and stable and bleeding-edge builds for Linux, macOS, and Windows.
- Hollow Knight Modding API is a free option for Linux, macOS, and Windows.
- ModTek is a free mod loader for the BattleTech PC game.
- RED4ext is a free script extender and plugin manager for Cyberpunk 2077 on Windows.
Verdict
Baldur’s Gate 3 Script Extender is the right choice for mod authors who need Lua or Osiris support, debugging, and logging for Baldur’s Gate 3 without paying for a development tool. Its main drawback is version sensitivity, compounded by a license that rules out certain commercial uses. Look elsewhere if you need an older game build, a tool for another game, or software you can sell as part of a substantially derived product.
The verdict
The Script Extender provides scripting, debugging, and logging options for Baldur's Gate 3 mods. Check the game's patch level and license restriction before using it.
Questions people ask
How much does it cost?
The plan is free at no cost.
Which platforms are supported?
It supports Windows and Linux through Proton.
What game does it support?
It supports Baldur's Gate 3.
How is it installed?
Extract DWrite.dll into the Baldur's Gate 3 bin directory.
Does it update automatically?
Yes. It downloads and applies an update when the game launches.
Is it open source?
The repository license includes the MIT License and a Commons Clause condition restricting sales of the software and substantially derived products and services.
What the maker publishes
- Achievements
- The configuration includes an EnableAchievements option to re-enable achievements for modded games. source
- Achievements
- The default configuration re-enables achievements for modded games. source
- 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. source
- Build requirements
- Developers are instructed to run first-time-setup.bat from an MSVC x64 Native Tools command prompt and then use Visual Studio. source
- Client and server
- The extender maintains separate Lua states for the game server and each client. source
- Console
- The extender provides a console that can execute Lua code and registered console commands. source
- Console
- The extender provides an interactive console that executes Lua and can invoke Osiris functions. source
- Console limitation
- The community installation guide says PlayStation and Xbox have no official Script Extender support. source
- Crash reports
- The SendCrashReports option defaults to true and uploads minidumps to a crash report collection server after a game crash. source
- Debugger ports
- The documented default ports are 9999 for Osiris debugging and 9998 for Lua debugging. source
- Debugging
- Configuration options include Osiris and Lua debugger interfaces, with configurable listening ports. source
- Debugging
- Configuration supports console logging, runtime logs, compilation logs, an Osiris debugger and a Lua debugger. source
- Documentation depth
- The Lua API document is about 1,957 lines and includes examples and function behavior details. source
- Events API
- Lua scripts can subscribe to engine events with priority and one-shot options. source
- Game data APIs
- Documented modules cover entities, stats, resources, localization, audio, templates, level operations and math. source
- 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. source
- 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. source
- Independent praise: ecosystem importance
- A BG3 modding guide presents the extender as the foundation for writing mods with Lua and Osiris scripting. source
- Independent praise: mod compatibility
- PC Gamer describes the extender as Patch 8 verified and often required for many other Baldur's Gate 3 mods. source
- Installation
- The release instructions say to extract DWrite.dll into the Baldur's Gate 3 bin directory. source
- Installation
- The official release instructs users to extract DWrite.dll into the game's bin directory. source
- Intended users
- The documentation describes using the extender in mods, including setting a mod configuration file and Lua feature flag. source
- 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. source
- License
- The repository license includes the MIT License and a Commons Clause condition that excludes selling the software or substantially derived products and services. source
Checked against the maker's pages on 15 Oct 2026.