Welcome to ItemAPI’s documentation!
The aim of ItemAPI is to both standardize and simplify the definition of Minecraft items in configuration files.
The entire API was written with simplicity and readibility in mind.
Warning
This API was only built to support Minecraft versions 1.12 and above. While ItemAPI theoretically should support versions lower than 1.12, there is no guarantee of full functionality no support will be offered.
For Users
View documentation for how to define items here. Note: all documentation on this site assumes you will be defining items in your config according to the YAML specification index. Because this project also supports JSON, HOCON, and XML as well, contact the specific developer on instructions for how to use these formats to define items.
Documentation on how to define general metadata such as name and lore can be found on the metadata page. For more item-specific metadata, see the Navigation section below.
If you encounter any issues with parsing your config and you are using the YAML format, I highly recommend passing your config through a YAML parser such as this one. This will allow you to quickly identify any issues with formatting.
For Developers
Javadocs for this project can be viewed here.
Including the library in your own projects is outlined on the ItemAPI’s GitHub Repository.
This project also supports Configurate, meaning JSON, HOCON, and XML formats are also supported in addition to the traditional Bikkit YAML format. For information on Configurate, see the Javadocs as well as the Configurate Github Page.
For licensing information, see the License page.