Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 2.17 KB

README.md

File metadata and controls

33 lines (26 loc) · 2.17 KB

Norbyte's Baldur's Gate 3 Script Extender

Downloads available here

The Script Extender adds Lua/Osiris scripting support to the game. API Documentation

Configuration

The following configuration variables can be set in the ScriptExtenderSettings.json file:

Variable Type Default Description
CreateConsole Boolean false Creates a console window that logs extender internals. Mainly useful for debugging.
EnableLogging Boolean false Enable logging of Osiris activity (rule evaluation, queries, etc.) to a log file.
LogRuntime Boolean false Log extender console and script output to a log file.
LogCompile Boolean false Log Osiris story compilation to a log file.
LogFailedCompile Boolean true Log errors during Osiris story compilation to a log file.
LogDirectory String My Documents\OsirisLogs Directory where the generated Osiris logs will be stored.
EnableExtensions Boolean true Make the Osiris extension functionality available ingame or in the editor.
SendCrashReports Boolean true Upload minidumps to the crash report collection server after a game crash.
DumpNetworkStrings Boolean Not implemented yet Dumps the NetworkFixedString table to LogDirectory. Mainly useful for debugging desync issues.
DeveloperMode Boolean false Enables various debug functionality for development purposes.
DisableModValidation Boolean true Disable module hashing when loading modules.
EnableAchievements Boolean true Re-enable achievements for modded games.
EnableDebugger Boolean false Enables the Osiris debugger interface
DebuggerPort Integer 9999 Port number the Osiris debugger will listen on
EnableLuaDebugger Boolean false Enables the Lua debugger interface
LuaDebuggerPort Integer 9998 Port number the Lua debugger will listen on

Build Instructions

Download the latest external dependencies from here and extract them to the External/ folder.