Skip to content

ghostboats/bg3_mod_helper

Repository files navigation

BG3 Mod Helper - A VSCod(e/ium) Extension

Created by ghostboats and khbsd, this VSCod(e/ium) extension is designed to help mod authors speed up their mod creation workflows. The extension includes multiple useful utilities such as:

  • Mod Packing/Unpacking
  • UUID/Handle Generation
  • UUID Mapping
  • Handle Management
  • LSX/XML/LOCA/ETC File Conversions
  • Generate Mod Templates
  • Atlas Generation
  • And More!

This tool is very functional and follows the philosophy of “Few clicks, few tabs,” enabling modding without frequent tabbing out and minimizing the number of clicks needed. It’s available for both VSCode and VSCodium.

Getting Started

Install the extension:

  1. Open VSCode.
  2. Click on the View tab on the top ribbon.
  3. Click on Extensions.
  4. In the Search Extensions in Marketplace search box, enter bg3_mod_helper.
  5. Click Install on the correct extension.

Setup Extension Settings:

  1. Click on “File” in the top ribbon in VSCode.
  2. Click on “Preferences” and then “Settings”.
  3. Search for bg3 in the settings search bar.

Adjust paths:

  1. Ensure LSLib.dll is in the folder specified in your settings.
  2. Set the Root Mod Path to your workspace folder.
  3. Configure other paths such as Mod Destination Path and Game Install Location.

Use the Data Provider:

Access the data provider from the VSCode sidebar for a quick one-stop shop for the extension’s main functionalities.

For detailed setup instructions, features, and usage, please refer to our wiki page.

Requirements

  • Visual Studio Code
  • LSLib

Limitations

  • Unable to work with multiple workspaces in one VSCode window.
  • Unable to edit PNGs/DDS files directly in VSCode.
  • May encounter bugs when using multiple VSCode windows or having other folders within your workspace.
  • Possible lag due to folder/file size.
  • No references to base game UUIDs/handles (coming soon).

Support and Community