🗡️ Item

Overview

A complete item configuration contains the following sections:

material Required

The material serves as the foundational template of the item, such as paper or wooden_sword.

client-bound-material Optional

The client-bound-material used for this item. You can use this feature to assign completely different base material for items on the server/client side, thereby affecting their specific behaviors in server/client contexts.

custom-model-data Optional

The custom-model-data is a positive integer, and custom items of the same material should possess distinct custom-model-data values. The custom-model-data determines the model displayed for the item and is crucial for the model section below.

item-model (1.21.2+) Optional

Defines the item model resource location of this item. For instance default:custom_book

tip

Using custom model data has better version compatibility because it has been released since 1.14 while item_model requires at least 1.21.2

You can use custom-model-data and item-model at the same time

caution

When configuring the model section, you must specify either custom-model-data or item-model. If your resource pack supports version 1.21.2 or later, the plugin will automatically use the item ID as the value for item-model.

client-bound-model Optional Default: the global value in config.yml
oversized-in-gui (1.21.6+) Optional Default: true
hand-animation-on-swap Optional Default: true
data / client-bound-data Optional
behavior(s) Optional
settings Optional
model / legacy-model Optional
events Optional
category Optional

Full Config Overview

items:
  default:palm_log:
    material: paper
    custom-model-data: 1000
    item-model: default:palm_log
    settings:
      fuel-time: 300
      tags:
        - "default:palm_logs"
        - "minecraft:logs"
        - "minecraft:logs_that_burn"
    data:
      display-name: "<!i>Palm Log"
    model:
      type: "minecraft:model"
      path: "minecraft:item/custom/palm_log"
      generation:
        parent: "minecraft:block/custom/palm_log"
    oversized-in-gui: true
    hand-animation-on-swap: true
    client-bound-model: false
    behavior:
      type: block_item
      block: default:palm_log

Overview​

Overview