BG3-Community-Library-Team / BG3-Compatibility-Framework

An API-based Driven Compatibility Framework for Baldur's Gate 3 Mods
MIT License
44 stars 13 forks source link

Dictionary Entries for Races.lsx & Children Fields #66

Open NellsRelo opened 11 months ago

NellsRelo commented 11 months ago

Now that we support insertion/removal of child fields in Races.lsx entries, it would be useful to have dictionaries set up for each race defined in Shared, SharedDev, Gutav, and GustavDev. We'd probably also want to set up dictionaries for Tags, Gods, Visuals, and other things that are referenced.

Gods will probably draw from the UUIDs defined in Gods.lsx, and along with Races, should be an exhaustive list.

There are way too many tags and visuals to account for all of them, so it may be worth just setting up entries for the ones that are already referenced in races.lsx, and add more as needed.

These dictionaries should be fairly simple, just a single level deep:

{
  DescriptiveName = "UUID"
}

We'll also need to ensure we have API Endpoints to retrieve and/or register them.

RandoRuda commented 11 months ago

I am one that can really get bogged down in the details, so sorry for this. If you could provide a clear direction, Glorious Leader, I can jump into this repetitive/monotonous task.


Query:

How would you like it within /CompatibilityFramework/Mods/SubclassCompatibilityFramework/ScriptExtender/Lua/Globals/Dictionaries/ ?

Options:

My first thoughts...

1) Add a races subfolder and then break them down into tags.lua visuals.lua etc? 2) Don't get too bogged down in sorting it out yet and start collecting the UUIDs together in races.lua


This is the kind of task I can fall into for hours when I'm feeling worn out, unable to make decisions, so I'm looking forward to confirming the best way forward.

NellsRelo commented 11 months ago

Since things like visuals and tags may end up being useful beyond races, it might be good to just have a gods.lua, races.lua, tags.lua, etc, I think