Armory API

Armory API

Armory API is a lightweight library that provides shared code for defining and managing tool sets and armor sets in Minecraft mods.

The project was extracted from XunLib to support Forge independently and keep the API lightweight, modular, and loader-agnostic.

Supported loaders:

• Forge
• NeoForge
• Fabric

Features

• APIs for defining ToolSet and ArmorSet
• Reduced duplication when registering tools and armor
• Loader-independent implementation
• Small scope and minimal dependencies
• Compatibility with modded tool types

FAQs

Can I use only ToolSet or only ArmorSet?
Yes. The systems are independent and can be used separately.

Does this handle item registration automatically?
No. Registration is handled by the consuming mod or loader-specific implementation.

Can I create custom tool or armor behaviors with this?
Yes. Armory API includes helper APIs for implementing custom tool and armor behavior, allowing mods to extend or customize functionality beyond vanilla behavior.

Can I add custom or modded tool types? Yes. ToolPieceType is specifically designed to allow custom tool categories with their own item factories, statistics, properties, and attributes.

Can a ToolSet contain only some tool types? Yes. A ToolSet is no longer limited to the standard vanilla tool collection. Any combination of supported ToolPieceType instances can be included.

Can other libraries or frameworks integrate with Armory API?
Yes. The API is designed to stay lightweight and modular so it can be integrated into larger modding frameworks if needed.

Dependency

Armory API is a library mod and is only required by mods that explicitly depend on it.

Armory API does not replace the loader's item registration system and does not require consuming mods to use a particular registration framework.

Note: The mod ID is armories to avoid conflicts with other mods using similar names.