On this page
v1.0-BETA

NxEquipements API

Developer guide for the NxEquipements API — give custom equipment, detect it in an inventory, browse sets, and react to reloads from your own plugin.

The NxEquipements API lets your own plugin work with equipment somebody built in the editor — give it out, spot it in an inventory, and react when it changes.

What you can do

TaskPage
Give a player a piece of custom equipmentGive items
Check whether an item came from NxEquipementsDetect items
Work out which set and piece an item isDetect items
List every set and piece on the serverBrowse sets
Run code when equipment is reloadedEvents
Read custom tags off an itemCustom data
Give a bonus for wearing a full setFull example

What you need

  • Java 21
  • Paper or Folia 1.21.4+
  • Maven or Gradle
No licence key needed to build against the API. The API artifact is published openly. You can ship it inside your own plugin and sell that plugin. Your users still need their own NxEquipements licence to run the plugin itself.

Start at Add the dependency.

Last updated August 11, 2026