🗡️ 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 Premium Exclusive

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

client-bound-model Optional Default: by config.yml Premium Exclusive

Makes custom-model-data and item-model client-side by default. This provides several benefits. For example, you can update model values dynamically without causing inconsistencies for players' existing items. The main drawback is that plugins relying on custom-model-data for item identification will not work correctly, as this data is not present in the server-side item stack.

data Optional

Item Data refers to the NBT (Named Binary Tag) of an item in older versions, or the item Components in version 1.20.5 and above. Through this data, we can customize various aspects of an item such as its name, description, attributes, and other functionalities provided by vanilla Minecraft.

client-bound-data Optional Premium Exclusive

The client-bound-data exists exclusively on the client side, with no server-side components involved. Using the client-side item component, you can effortlessly update item descriptions in real time—including properties like item_model and custom_model_data. Additionally, unlike other plugins, CraftEngine items remain permanently unaltered in creative mode!

behavior(s) Optional
settings Optional

Unlike data, the contents within settings pertain to special mechanisms processed by the plugin.

model / legacy-model Optional
events Optional
category Optional
oversized-in-gui (1.21.6+) Optional Default: true
hand-animation-on-swap Optional Default: true

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