https://github.com/Norbyte/bg3se

Baldur's Gate 3 Script Extender
https://github.com/Norbyte/bg3se

Last synced: about 2 months ago
JSON representation

Baldur's Gate 3 Script Extender

• Host: GitHub
• URL: https://github.com/Norbyte/bg3se
• Owner: Norbyte
• License: other
• Created: 2021-01-31T10:39:13.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-28T17:43:37.000Z (8 months ago)
• Last Synced: 2024-05-29T05:25:11.297Z (8 months ago)
• Language: C++
• Size: 3.93 MB
• Stars: 992
• Watchers: 102
• Forks: 58
• Open Issues: 80
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-modding - Norbyte's Baldur's Gate 3 Script Extender - Baldur's Gate 3 Script Extender. (Larian Studios Games / Baldur's Gate 3)

README

        
# Norbyte's Baldur's Gate 3 Script Extender

[Downloads available here](https://github.com/Norbyte/bg3se/releases)

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

[API Documentation](https://github.com/Norbyte/bg3se/blob/master/Docs/API.md)

### 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](https://nb-stor.s3.eu-central-1.amazonaws.com/bg3/External.7z) and extract them to the `External/` folder.