Registering Items

Creating an Item Registry

After creating the item asset, they need to be registered in code.
To do this, you will need to create a registry for your items. This can be done by creating a singleton object that implements ItemRegistry. In order to not need to implement the getAddon method, you can delegate to ExampleAddon.registry. All items need to be registered during initialization, so you can either load the class from the init block of your addon or annotate your registry with @Init.

Your singleton object might then look like this:

@Init(stage = InitStage.PRE_PACK) // (1)! 
object Items ItemRegistry by ExampleAddon.registry {

    // (2)!

}

1. Nova will load this class during addon initialization, causing your items to be registered.
2. Register your items here

Registering Items

Using the existing methods in ItemRegistry, you can now register your items. For that, you can choose between the builder pattern accessed via item(id) or use the register... methods.

If you don't want your item to have a name, you can use the registerUnnamedItem method.
If you don't want it to pop up in /nova give, register it with registerUnnamedHiddenItem. This can be useful when registering GUI items.

Registering our ruby from before, your Items registry would look like this:

@Init(stage = InitStage.PRE_PACK) // (1)!
object Items : ItemRegistry by ExampleAddon.registry {

    val RUBY = registerItem("ruby")

}

1. Nova will load this class during addon initialization, causing the RUBY field to be initialized and your item to be registered.

Item Categories

In order for your items to appear in the /nova items, they need to be in the item_categories.yml file in your addon resources.
The structure of that file is as follows:

example_category: # (1)!
  icon: example_addon:example_item # (2)!
  name: "menu.example_addon.items.category.example_category" # (3)!
  priority: 0 # (4)!
  items: # (5)!
    - example_addon:example_item
    - example_addon:other_item

1. The id of the category. This can be useful if you want to add items to an existing category, such as misc from Nova or machines, power or crafting from Machines.
2. The tab icon in the /nova items GUI.
3. The tab name in the /nova items GUI.
4. Tabs of categories with a lower priority will be to the left of tabs of categories with a higher priority.
5. The items that will be listed under that category in the /nova items GUI.

You can register as many item categories as you want.