Oath Framework Config - BG3-Community-Library-Team/OathFramework GitHub Wiki

Configuration

If you're adding new Paladin Oaths, you'll need to supply an OathFrameworkConfig.json file. This file is what allows Oath Framework to register Subclasses for the game to properly identify when breaking or redeeming an Oath. A Sample Config is provided in the repo.

Your file will look something like this:

{
  "FileVersion": 1,
  "Tags": [
    {
      "OathbreakerSubclassData": [
        {
          "SubclassTag": "PALADIN_SUBCLASS_tag-uuid-value",
          "OathbreakerTag": "OATHBREAKER_SUBCLASS_tag-uuid-value",
          "SubclassOathBrokenEventFlag": "FLAG_NAME_VALUE_flag-uuid-value",
          "CrimesToReact": ["Crime", "Another Crime", "Even more Crime"]
        }
      ]
    }
  ]
}

The SubclassTag and OathbreakerTag will typically be required, as will the SubclassOathBrokenEventFlag, when dealing with custom Oaths. CrimesToReact is entirely optional, but may be useful if you want certain crimes to be more likely to break a specific Oath. A full list of valid Crimes for the CrimesToReact field can be found here

Example:

{
  "FileVersion": 1,
  "Tags": [
    {
      "modGuids": [""],
      "OathbreakerSubclassData": [
        {
          "SubclassTag": "PALADIN_ANCIENTS_7c89622b-4194-41df-b2ff-145a5056ee49",
          "OathbreakerTag": "OATHBREAKER_ANCIENTS_d84a8a0b-b648-464c-9bd5-1ed9b965da2a",
          "SubclassOathBrokenEventFlag": "GLO_PaladinOathbreaker_Event_AncientsBrokeOath_7cf0bd9c-f089-45a3-88fb-03087d3d8b95",
          "CrimesToReact": ["Assault", "UseForbiddenItem", "Vandalise"]
        }
      ]
    }
  ]
}