Skip to main content

๐Ÿ”ง Item Settings

Introductionโ€‹

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

Typesโ€‹

fuel-timeโ€‹

Determines how many ticks can be burned.

fuel-time: 100

tagsโ€‹

Tags used in recipes.

tags:
- "default:palm_logs"
- "minecraft:logs"
- "minecraft:logs_that_burn"

equipmentโ€‹

Apply the equipment to this item.

equipment:
#
# Required Argument
#
asset-id: default:topaz

#
# Optional Argument. Defaults to the global client-bound-model option in config.yml
#
client-bound-model: true

#
# Optional Arguments on 1.21.2 and above
# Option 'slot' is required for these options to work
#
slot: head # head / chest / legs / feet / body (animal armor) / saddle
# The resource location of the overlay texture to use when equipped. The directory this refers to is assets/<namespace>/textures/<id>.
camera-overlay: "namespace:id"
# Whether the item can be dispensed by using a dispenser.
dispensable: true
# Whether this item is damaged when the wearing entity is damaged.
damage-on-hurt: true
# Whether the item can be equipped into the relevant slot by right-clicking.
swappable: true
# >= 1.21.5
# Whether this item can be equipped onto a target mob by pressing use on it (as long as this item can be equipped on the target at all)
equip-on-interact: true

repairableโ€‹

Decides if the item can be repaired through crafting table/anvil. (Default: true)

repairable: true

anvil-repair-itemโ€‹

Determines how much durability a given item provides when repairing.

anvil-repair-item:
- target: "#topaz_tools" # use tags
amount: 20 # restores fixed durability
- target:
- "minecraft:iron_pickaxe"
- "minecraft:shears"
percent: 0.25 # 0.25 = 25%, restores n% total durability

renameableโ€‹

Determines if the item can be renamed in anvil. (Default: true)

renameable: false

projectileโ€‹

Creates a custom projectile entity based on the item. It supports trident, arrow, snowball and more.

projectile:
item: default:topaz_trident # the item to display
translation: 0,0,0
rotation: 1,1,1,1
display-transform: NONE
scale: 0.5

How to Model

The way you model directly affects the rotation arguments in the configuration file.

No matter which modeling method you use, the most important thing is to make the sharp part of the trident in the position shown in the picture above to ensure the best hitting point.

dyeableโ€‹

Decides if the item can be dyed in crafting tables. (Default: undefined)

dyeable: true

foodโ€‹

Plugin-based alternative implementation for the food component.

food:
nutrition: 5 # 0~20, integer
saturation: 3.5 # 0~10, float
caution

Better to use food components on a 1.20.5+ server

consume-replacementโ€‹

Set the return item after consuming the item. For example, after the player drinks the water bottle, the empty bottle will be returned. (Default: null)

consume-replacement: minecraft:apple

craft-remaining-itemโ€‹

Choose whether items should return other items when the crafting recipe is finished.

craft-remaining-item: bucket

invulnerableโ€‹

invulnerable:
- lava
- fire_tick
- block_explosion # respawn anchor
- entity_explosion # creeper, tnt
- lightning
- contact # cactus

enchantableโ€‹

This option lets you block certain items from being used on the enchantment table. Tip: setting it to true wonโ€™t magically make unenchantable items enchantable. (Default: true)

enchantable: false

compost-probabilityโ€‹

This setting controls how likely it is for composting to succeed (Default: 0.5).

compost-probability: 0.5

respect-repairable-componentโ€‹

This controls if the items listed in repairable component can fix this item in anvil gui. (Default: false)

respect-repairable-component: false

dye-colorโ€‹

This determines what color it provides in the dyeing recipe.

dye-color: 255,140,0

firework-colorโ€‹

This determines what color it provides in the firework star fade recipe.

firework-color: 255,140,0