Enhance your Baldur's Gate 3 modding workflow with the bg3-mod-helper extension. This tool streamlines the creation and management of UUIDs and handles, facilitating efficient mod development. Can also pack mods, convert to loca, add icons to atlas, convert to from png/dds, provide function info on hover, and more! Still being updated regularly!
Permissions and credits
Credits and distribution permission
Other user's assetsAll the assets in this file belong to the author, or are from free-to-use modder's resources
Upload permissionYou are not allowed to upload this file to other sites under any circumstances
Modification permissionYou must get permission from me before you are allowed to modify my files to improve it
Conversion permissionYou are not allowed to convert this file to work on other games under any circumstances
Asset use permissionYou must get permission from me before you are allowed to use any of the assets in this file
Asset use permission in mods/files that are being soldYou are not allowed to use assets from this file in any mods/files that are being sold, for money, on Steam Workshop or other platforms
Asset use permission in mods/files that earn donation pointsYou are not allowed to earn Donation Points for your mods if they use my assets
Author notes
This author has not provided any additional notes regarding file permissions
File credits
This author has not credited anyone else in this file
Donation Points system
Please log in to find out whether this mod is receiving Donation Points
Changelogs
Version 1.2.100
Mod templating added, create file structures based of what you want (generate required files to make a class mod, etc) only class creation implemented atm, more to come
Cleanup but still very messy. Expected refactoring to come. Possible less new content until refactoring and more templates added in
Version 1.1.100
Autocomplete test seems to be fine, will move forward adding in more templates for it and other templates in next few updates
Custom png image resize available, on the same right click menu as other png resize options
Checks for pythonnet(clr) when converting xml to loca and will properly raise error for it instead of saying file is converted even when it wasnt due to missing package
Check that game is not open before packing to stop launch error which would clear settings.
Version 1.0.902
Fixed critical bug making packing mods impossible (autosetting path to roaming instead of local)
Testing suggested data entry values, not fully implemented. Alpha phase only
Version 1.0.202
Proper .pak movement to allow for movement between different drives
Version 1.0.111
When launching game, new setting added to toggle loading the current save right away (default toggled off)
Version 1.0.0
Icon atlas can now be generated as well as its corresponding .dds and merged.lsx file. You need to provide a directory of icons and it will take those icons and put them on the .dds texture for the atlas as well as update your atlas on the location of where the images are placed.
Image conversion (png<->dds) as well as resize png/dds images.
ALOT of refactoring to have code nicer and tidey to release. My tests show everything working so far but expecting bugs and will be monitoring.
Added setting to autolaunchgame on pack conversion (found in settings defaults off)
Added setting to shorten pack time to speed things up (sometimes files get moved before all the merged files are converted, resulting in old files being packed. If you dont see any changes reflected in game after packing, try to increase the time on this, maybe its converting too fast. If you are having times over 8-9 seconds, something else is going on. Can usually leave at 4-7, maybe less.)
Version 0.9.999
Can now convert merged files to lsf, works with icon atlas now, didnt before
Add delay to allow proper conversion before packing (was requiring a double pack before, sorry for any confusion it caused)
Mods folder is now looked for when searching for a meta, not Mods/modname. Uses the name of the first folder in there as the mod name and will look in it for meta.lsx
Moved create bg3 file lower so handles and uuid is up top
Version 0.9.997
Can now convert merged files to lsf files. Will autoconvert when packing mod
Version 0.9.995
Functions can be hovered over for information on what they do and their parameters. Still working on collecting more functions, have added in a few so far.
Auto set root mod folder correctly so its not global (fixed it from swapping folders if you opened a new window). DO NOT CHANGE THE ROOT MOD FOLDER SETTINGS FOR USER, CHANGE THEM FOR WORKSPACE IN THE SETTINGS.
Delete .vscode folder so it doesnt get packed and recreate after packing
fix gotouuidhandle via right click (was broken)
More cleanup and tidying of folders/files for a smooth launch
Version 0.9.992
Auto set mod folder when opening visual studio code based of set workplace. If working with multiple mods in one workspace, be sure to change this to your main mod folder that you want to pack.
Testing function hovers, dont worry about it for now
Version 0.9.991
No more searching on all words. Uuid and handle patterns more strict, fixing performance by removing unnecessary and accidental search's on non uuid's and handles.
Proper usage of maxfilesreturned so stops searching when max file limit is reached rather than searching all and then cutting via maxfiles
Version 0.9.989
Formatting fixes for hover
Proper display of lines for certain special lines
Version 0.9.988
Will now allow you to autoconvert all xml files in your Localization folder (and subfolders) to .loca files, allowing for multiple language folders essentially. Can no longer convert loca to xml but will add that in again later as its not as important atm.
New setting to allow single file loca conversion should you only need to alter one file for some reason.
Search page now retains data if you leave the tab (previously refreshed the tab, losing results).
Version 0.9.985
The debug update, minor real changes, mostly adding proper logging to help users with issues.
Version 0.9.952
hot fix loca file stopping search since binary
Removal of workspace setting. Auto using vs code workspace. If you want to have multiple mods in one workspace, you should create one folder with all your mods inside that you want to be searchable when looking for instances. Then, the main mod you are working on in that workspace should be what you make as your root mod folder.
Autopack and convert localization files one button. Please ensure you only have either one xml or one loca file in your mods Localization folder/subfolder. (You can have 1 loca and 1 xml, i mean you cant have something like 0 loca and 2 xml or 2 loca and 1 xml). Change any .loca.xml files to jus .xml if you have issues as well.
Optimization fixes, hopefully fixing lag issues. Testing needed.
Settings update dynamically now, no more restarts of vscode required.
Backend logic fixes.
Version 0.9.951
Pressing the left side icon (looks like a box that says b3) opens a menu that lets you do three things currently. You can launch the game, convert xml to loca file, or pack your mod. Make sure you specify your mods root folder as well as the location of your divine.exe. PYTHON REQUIRED TO WORK AS WELL AS EXPORT TOOLS. NOT WELL TESTED YET
Version 0.9.930
By specifying "< !--press control shift a to quick spawn a line below" and "end custom attribute lines-->" as well as "< !--press control shift 2 to quick spawn a line below" and "end ctrl shift 2 clipboard-->" (remove the space before the !), you can use their respective commands to quickly get a dropdown of items between the rows, which helps quick add lines. Some templates come with it, looking to the community for help filling them all out with all their respective attribute lines. Control shift 2 is just there as a bonus clipboard for you.
Version 0.9.920
Updated patch versioning, using triple digits moving forward, sorry for confusion before this if patch/change logs are out of order
Decent amount of refactoring for the future
More templates added
Version 0.9.901
More templates and template format fixes
Version 0.9.81
You can now use the export tools (stats validator, lsx validator, search engine) in a visual studio tab for ease. Will copy your highlighted text if you have something highlighted when you press one of the tool, for easier use
bug fixes and dumb mistakes by me
Version 0.9.71
changed text on instance not found for clarity
Version 0.9.55
moved create bg3 file button so its below create file and create folder since those would be used more i guess
Version 0.9.9
Added more file templates and greatly fixed how it works, can filter search now. Easier to add future templates now as well
Version 0.9.8
You can now use the export tools (stats validator, lsx validator, search engine) in a visual studio tab for ease. Will copy your highlighted text if you have something highlighted when you press one of the tool, for easier use
Version 0.9.7
Better root mod folder integration. You can now have multiple mods in the same workspace but when you hover it will only look for uuids/handles in that folder and its subfolders. If you want multiple mods to be searched when hovering, move the mods in your workspace into one location and make that location folder your root.
Formatting hover for better readability and usage
fix go to action (was not working :p)
caching for uuids/handles to stop rapidswapping on hovers
less resource intensive (it already wasnt) and accounting for memory leaks. Performance fixes, need to be wary about this update incase I made a memory leak while trying to secure it :p
autohighlight uuid/handle when you go to uuid/handle
Version 0.9.6
Can now use keyboard shortcuts to spawn uuids and handles (uuids: 'control + shift + u', handles: 'control + shift + h')
Version 0.9.5
Create a new right click menu button when clicking on the file explorer, Create BG3 File, that when hovered over will display template files that the user can click to rapidly make a new mod file (limited options atm, adding more soon)
Version 0.9.4
Changed insert to generate on right click menu
Added settings for extension
Can limit amount of lines showing in hover by accessing settings
Can now use multiple mod project directories in a workspace and generate handles without adding into multiple .loca.xml files. Will only update the project folder for the mod you added the handle into.
Version 0.9.3
group right click menu at top (might revert if too disruptive
Version 0.9.2
moved add uuid and add handle right click menu options up to top of menu for ease of access and grouping
code cleanup/restructure
Version 0.9.1
better formatting on hover
removing full path for readability
Version 0.9.0
Intial beta release
Add uuids and handles via right clicking
hover over uuids or handles to see where else they can be found (excluding the current file)
right click uuids or handles and then click Go To UUID/handle to open up files and go to it
bg3-mod-helper: A Visual Studio Code Extension for Baldur's Gate 3 Modding
Introducing bg3-mod-helper, a Visual Studio Code extension that I created to help mod developers in the Baldur's Gate 3 community. This tool was made to streamline your modding workflow, making it more efficient and less time-consuming.
IMPORTANT: Please ensure you modify the settings for the extension. The extension will not load up properly if the various path settings are not set in the settings.
Key Features:
UUID and Handle Generation: Easily generate UUIDs and handles with a simple right-click in your workspace (control shift u and control shift h will also spawn uuids and handles respectively).
Hover over functions to get information on their parameters (still in beta, looking for help collecting function parameters information)
Instance Finder: Quickly locate where a UUID or handle is used in your project with a handy tooltip that appears when you hover over an identifier.
Quick Navigation: Right-click on a UUID or handle to access a list of files where it's used. This allows you to jump directly to any instance for editing or review.
.loca.xml File Integration: Automatically updates .loca.xml files with new handles, creating blank entries for seamless integration.
Generate file templates from right clicking on file explorer and clicking "Create BG3 File" which will display a drop-down of file templates to create, which can be filtered by typing (limited selection as I slowly add in more of these and more functions, if you urgently want one, please message me)
If you have an internet connection, right click in the editor and hover over the export tools to access the stats/lsx validator tools and search tool in visual studio. (If you click it while having text highlighted it will autocopy the text so you can easily paste as well)
By specifying "< !--press control shift a to quick spawn a line below" and "end custom attribute lines-->" as well as "< !--press control shift 2 to quick spawn a line below" and "end ctrl shift 2 clipboard-->" (remove the space before the !), you can use their respective commands to quickly get a dropdown of items between the rows, which helps quick add lines. Some templates come with it, looking to the community for help filling them all out with all their respective attribute lines. Control shift 2 is just there as a bonus clipboard for you.
Right clicking on a a dds or png image will allow you to convert that image to the opposite (dds->png or png->dds) Also allowed for resizeing of png/dds images.
Pressing the left side icon (looks like a box that says b3) opens a menu that lets you do a couple of quick actions which are as followed:
Pack your mod directly in visual studio code and have it sent to the mods folder.
Launch the game directly from visual studio (working on removing the launcher)
Convert all your xml localization files to loca files
Create an icon atlas, its corresponding .dds, and its corresponding merged.lsx. You need to provide a directory of icons you wish to have added to the atlas and .dds.
Reach Me/Help: DM me on discord or on the WIP page for the extension on discord where you can make feature requests and bug reports. Likewise, the same can be done on the github page. For general modding guidance and resources, check out the BG3 Modding Community Wiki. DM me on discord or on this mod page itself if you have any questions, bugs, or requests.
Lots of thanks and appreciation to those who tolerated my questions as I tried to figure out different aspects of this extension since its my first time making something like this!
This extension was created by both myself and khbsd, please check out his profile for his other incredible works!
