BG3DevouringAndDigesting

A comprehensive vore mod for Baldur's Gate 3

Development

Setting up development environment

1. Install Visual Studio Code.
2. Clone this repository and open it with Visual Studio Code.
3. Install Lua plugin by sumneko.
4. Install vscode-lua-format plugin by Koihik.

   Modding tools

5. Install Python version 3.10 or newer.
6. Install tools: run InstallTools.bat.

   Setting up and usage of Lua debugger

7. Install modding tools.
8. Create symlink (run CMD as Admin):

   mklink /D "<BG3 Install Path>\Data\Mods\DevouringAndDigesting" "<This Repo Path>\Mods\DevouringAndDigesting\Mods\DevouringAndDigesting"

9. Add "EnableLuaDebugger": true in the script extender configuration file ScriptExtenderSettings.json in the bin folder of your game.
10. Download the BG3 Lua Debugger extension for VSCode: https://bg3se-updates.norbyte.dev/Stuff/bg3-lua-debugger-1.0.0.vsix. In VSCode open File -> Preferences -> Extensions and drag the VSIX file to the extension pane to install.
11. Launch the game.
12. Press F5 in VSCode.
13. See also: https://github.com/Norbyte/bg3se/blob/main/Docs/Debugger.md

Lua code style

• Pretty much http://lua-users.org/wiki/LuaStyleGuide, but:
  • 4 spaces indentation;
  • camelCase variables;
  • capitalized CamelCase functions with "SP_" prefix;
  • comments on a separate line, short comments may be an exception;
  • use annotations to describe functions: https://luals.github.io/wiki/annotations/;
• Format Lua files with "Format Document" (Shift+Alt+F), vscode-lua-format does not fork with "Format Selection" for some reason.