Tag Framework Config - BG3-Community-Library-Team/TagFramework GitHub Wiki

Configuration

Whether you're adding new Races, or new exclusion tags or meta tags for existing races, you'll need to supply a TagFrameworkConfig.json file. This file is what allows Tag Framework to register these tags into the game. A Sample Config is provided in the repo.

Your file will look something like this: In Mods/ModName/ScriptExtender/TagFrameworkConfig.json:

{
  "FileVersion": 1,
  "Tags": [
    {
      "modGuids": ["(optional) UUID-of-required-mod"]
      "Type": "Race, Background, or Deity",
      "Tag": "TAG_NAME_tag-uuid-value",
      "ReallyTag": "TAG_NAME_tag-uuid-value",
      "TagsToExclude": ["reference to undesired tag"],
      "RaceMetaTags": ["reference to desired meta tags"],
      "DeityCleric": "Cleric Deity tag",
      "DeityPaladin": "Paladin Deity tag",
      "DeityAlignment": "Good, Evil or Neutral"
    }
  ]
}

Example:

{
  "FileVersion": 1,
  "Tags": [
    {
      "modGuids": ["bfc31d95-8fd5-4bdc-a92b-ec3bfce13f86"],
      "Type": "Race",
      "Tag": "Ghouls_Dunmer_f34cadf5-ccfb-4e56-9596-356619569108",
      "ReallyTag": "REALLY_Ghouls_Dunmer_6a018dee-2f04-4bda-93c4-958422c3ed0a",
      "TagsToExclude": ["Baldurian"],
      "RaceMetaTags": ["Planar"]
    },
    {
      "Type": "Deity",
      "Tag": "Tyr",
      "DeityCleric": "TyrCleric",
      "DeityPaladin": "PALADIN_TYR_b8aec881-85fe-4e6e-8a28-7052ecd88899",
      "DeityAlignment": "Good"
    }
  ]
}

The values of TagsToExclude and RaceMetaTags can be set up as either the UUIDs of the relevant tags, or in a format like TAG_NAME_tag-uuid as seen in the Tag and ReallyTag fields, or in simple text. A list of the supported simple text options can be found in our Tag Dictionary