Skip to content

Latest commit

 

History

History
121 lines (88 loc) · 6.13 KB

README.md

File metadata and controls

121 lines (88 loc) · 6.13 KB

BG3 Modding ToolBox

What it is

This is a command-line utility tool to simplify Baldur's Gate 3 modders' lifes.

I know I didn't properly analyze the domain area, most of the things this toolbox does at the moment must have been solved ages ago. But I just wanted to code a little, plus I do have big plans with this project.

What it does

This toolset provides various utilities designed to make my (or yours) life better. If I come up with a mod idea my first thought is "Can I make my ideas so clear to a computer that it just processes them and moves results to the game, so that I (or a scheduler) can repeat this process every release with ease". As always the answer is "work fot it". The results of my work are as follows:

DB module

Allows to search and analyze game database

Command Description Examples
db:find {Resource} Search for text in sourcefiles Find all armor that grants stealth:
node bg3 db:find Data/Armor.txt 'Skill(Stealth'
Or try to find a hat:
node bg3 db:find Data/Armor.txt Hat
Narrow down your last search as many times as you want
node bg3 db:find last wiz
node bg3 db:find last rich
Find anything anywhere (As long as it is a bg3 file) node bg3 db:find 'C:\Downloads\Armor.txt'Save results in mod-bound datasets (see mod module documentation)
db:values Analyze values of a property node bg3 db:values Data/Armor.txt Boosts

You can configure how much entries are shown in console (doesn't affect commands, only presentation).

node bg3 config show 10

You can dump any output (the real result of a function, not what is shown due to config show param):

node bg3 db:find Data/Armor.txt --dump test/Armor.csv

This, for example, will pop out a csv file containing all armors found in configured paths. You can import it into Excel or Google Docs for analysis.

Dump respects file extention - csv will produce a csv, txt extention should produce gamefiles for txt-stored objects (like Armor, Inventory, etc), lsx would make proper game resources.

Mod module

Provides mod building, testing and publishing commands

Command Description Examples
mod:config Configure a variable (mod-bound) node bg3 mod:config author timeurg
mod:new Creates a new mod in the working directory using template from ./.mod_bp/ node bg3 mod:new AwesomeMod
mod:ls Lists mods found in the working directory node bg3 mod:ls
mod:set_active Start or resume working on a mod in your working directory Can look like node bg3 mod:set_active AwesomeMod<v5> if you have multiple versions of same mod in working directory
mod:lsx_locate Finds lsx file by uuid. Uses active mod and configured pathes node bg3 mod:lsx_locate 0c0c1031-4a04-4e8f-ba8a-8aafa2a396e8
mod:test Launches the game with your AwesomeMod enabled, as much files uncompiled and pushed into game Data as we can. Some additional informartion on game session run can be found in ./logs, so analyze that))
I highly recommend Skip Startup Videos and No Press Any Key Menu for this, great mods. I plan to study bg3se to maybe utilize it as well.		 node bg3 mod:test

Dataset submodule

Make use of your db:finds with or without inbuilt and user defined mutations inside your AwesomeMod.
See example

Command Description Examples
mod:dataset:ls Lists active mod's datasets node bg3 mod:dataset:ls
mod:dataset:new Makes a new dataset in .bgwip directory of mod folder. You can edit it manually node bg3 mod:dataset:new Boots Data/Armor.txt boots
mod:dataset:mutate But manual is not our thing, is it? node bg3 mod:dataset:mutate Boots setProp:Weight:0:1 toCampClothes
mod:dataset:from Combines new and mutate node bg3 mod:dataset:from Hats Data/Armor.txt hat setProp:Weight:0:1 toCampClothes

Sequences

This comes with a basic sequence runner that can run CLI and node,js commands from a list one-by-one.

See example, try it out: node sequence.js ./.doc/sequence-example.js, write your own

How to use

  1. You have to know how to use https://github.com/Norbyte/lslib at the moment. Unpack and run batch lsf -> lsx conversion on Patch1.pac, Gustav.pak, Shared.pak at the minimum, add directories as you see fit later.
  2. Install Node.js https://nodejs.org/en/download/current
  3. Download and place this directory somewhere convinient.
  4. Press Win + R, type cmd, a terminal will open
  5. type chcp 65001, hit enter
  6. type cd /d WHERE_YOU_PLACED_THIS, hit enter
  7. type npm i, hit enter
  8. type node bg3, if everything went well you will be propted for pathes to neccessary directories, once all is set this command produces a help message with available commands.
  9. run npm test to see if all modules work as intended

Credits

Huge thanks to

  • Larian for making an amazing game
  • AnteMaxx for making amazing mods that inspired me to delve into modding
  • Norbyte for his great tools

Plans

mod

  • declarative style mod building and publication (already published BG3 Transmog Camp Clothes using a prototype of this toolset)
  • publish
  • merge-unmerge-humanize lsx
  • container, treasuretable generation
  • visuals database scrapping and mix-and-match item generation
  • savegame analyzer
  • localization capabilities
  • lslib integration?

db

  • Models for
    • armor
    • treasuretable, inventory
    • loc
    • spells
    • weapons
    • GameObjects
    • npc
    • sfx
  • Notable objects
    • Shared.pak\Mods\Shared\EquipmentSettings\EquipmentSlots.lsx

Roadmap

  • mod:add:container
  • mod:uuid2human
  • mod:test
  • mod:publish
  • wardrobe module that will blow your panties off
  • save:get
  • wardrobe:save

Cool things to analyze