requirements

requirements

The requirements block specifies requirements of your JSON: .esp/.esm/.esl plugins required for the JSON to be loaded, as well as incompatible plugins, in the presence of which the JSON must not be loaded.

• Even though it's not required, it's recommended to specify the requirements of your JSON, since it prevents a bug that old versions of PapyrusUtil (all pre-AE versions) have - if you referenced a record in your JSON and the plugin that this record is from is missing or disabled, it tries pick the record with the same FormID from Skyrim.esm. Specifying requirements prevents this bug if the user disabled your addon .esp or one of its masters or doesn't even have the required mods installed.
• It's also useful if you want to distribute multiple addons that don't have any .esp-s in a single archive, so that the user installs one package and only the addons for the mods that the user has installed will be loaded.
• You don't need to specify the base game plugins (not counting Creation Club, it's recommended to specify them) or Skyrim Unbound.esp here.
• You don't have to specify all of the required plugins, you can only specify the ones that are enough to check if they're loaded in the game or not. For example, if your addon comes with an .esp "Skyrim Unbound Addon - Cool Sexy Armor.esp" that has "Cool Sexy Armor.esp" and "Skyrim.esm" as masters, it's enough to only specify "Skyrim Unbound Addon - Cool Sexy Armor.esp" in the requirements, since it won't be loaded if any of its masters aren't loaded.

requirements : object (optional)

Properties

required : string[] (optional)

Names of .esp/.esm/.esl plugins (with extensions), all of which are required for this addon. If at least one of these plugins is not found, the JSON won't be loaded.

requiredAny : string[] (optional)

Names of .esp/.esm/.esl plugins (with extensions), at least one of which is required for this addon. If none of these plugins are found, the JSON won't be loaded.

incompatible : string[] (optional)

Names of .esp/.esm/.esl plugins (with extensions) that this addon is incompatible with. If at least one of these plugins is found, the JSON won't be loaded.

Template

{
    "requirements" : 
    {
        "required" : [ "Plugin Name 1.esp", "Plugin Name 2.esp" ],
        "requiredAny" : [ "Plugin Name 3.esp", "Plugin Name 4.esp" ],
        "incompatible" : [ "Plugin Name 5.esp", "Plugin Name 6.esp" ]
    }
}

Examples

Requirements of the Mysticism addon (this addon doesn't have its own .esp, it adds spells from MysticismMagic.esp):

"requirements" : 
{
    "required" : [ "MysticismMagic.esp" ]
}

Requirements of the Orc Strongholds addon (this addon comes with an .esp so it's enough to only specify it):

"requirements" : 
{
    "required" : [ "Skyrim Unbound Addon - Orc Strongholds.esp" ]
}

Requirements of the addon for Balance Adjustments for Apocalypse and Balance Adjustments for Apocalypse - Vokrii - Vokriinator (this addon adds and removes some spells from Apocalypse - Magic of Skyrim.esp, which all of these .esp-s have as a master, but the addon only loads if any of the versions of Balance Adjustments for Apocalypse is installed):

"requirements" : 
{
    "requiredAny" : [ 
        "Apocalypse Adjustments - Vanilla.esp", 
        "Apocalypse Adjustments - Ordinator.esp", 
        "Apocalypse Adjustments - Adamant.esp",
        "Apocalypse Adjustments - Vokrii.esp",
        "Apocalypse Adjustments - Vokriinator.esp" 
    ]
}