Armors API

By
StarmapleFantasyTeam

An API for matching a full set of armor

This mod enables full armor set identification via custom IDs and allows certain abilities to require specific armor sets.

Originally created to configure dedicated armor sets for the Shadow Mist mod, the API is now publicly available for other modders and modpack developers.

The configured equipment is read from the config/armors_api/<id>.json configuration file.

JSON Example:

{
  "id": "shadow_armors",
  "armors_list": {
    "helmet": [
      "shadowlands:enhanced_shadowmetal_helmet"
    ],
    "chestplate": [
      "shadowlands:enhanced_shadowmetal_chestplate"
    ],
    "leggings": [
      "shadowlands:enhanced_shadowmetal_leggings"
    ],
    "boots": [
      "shadowlands:enhanced_shadowmetal_boots"
    ]
  }
}

Commands:

/armors_api add <id> all – Adds all currently equipped armor pieces to the specified set.
/armors_api add <id> <helmet|chestplate|leggings|boots> – Adds the currently equipped <helmet|chestplate|leggings|boots> to the specified set.
/armors_api reload – Reloads the configuration file.
/armors_api list – Lists all registered armor sets.
/armors_api check <id> – Checks whether the player is currently wearing the specified armor set.
/armors_api remove all – Removes all registered armor sets.
/armors_api remove <id> – Removes the armor set data for the specified ID (supports removing all or individual slots: <helmet|chestplate|leggings|boots>).