Basic

Collection of basic item properties

Don't forget the namespace! Don't forget to define a namespace for all of your configs!

Enabled

enabled: true

With this setting you can disable an item completely.

If a player has the item in inventory it won't be removed. Same thing for blocks, but when broken they won't drop anymore.

Display name

display_name: "Test"

This is the name user will see on the item

Permission

permission_suffix: myitem
Permission

Lore

lore:
- '&7When you mine a block'
- '&7it drops exp orbs'
- '&750% of times.'

Lore lines of the item

Enchants

enchants:
  - ARROW_FIRE:1
  - anger_artifact:1
  - my_custom_plugin:custom_enchant:6

Enchants of the item. You can set vanilla enchants and custom enchants of other plugins (for example EcoEnchants, GoldenEnchants...). Supports also namespaces (if you are creating custom enchants using Namespaced keys)

Attribute modifiers

attribute_modifiers:
  mainhand:
    attackDamage: 19
    attackSpeed: 1.1
    maxHealth: 1.1
    movementSpeed: -1
    armor: 1.1
    armorToughness: 1.1
    attackKnockback: 1.1
    luck: 1.1
  offhand:
    attackDamage: 19
    attackSpeed: 1.1
    maxHealth: 1.1
    movementSpeed: 1.1
    armor: 1.1
    armorToughness: 1.1
    attackKnockback: 1.1
    luck: 1.1

These are the vanilla attribute modifiers, you can get more info here https://minecraft.gamepedia.com/Attribute#Attributes_available_on_all_living_entities

Durability

durability:
  max_custom_durability: 200
  custom_durability: 32
  disappear_when_broken: false
  unbreakable: false
  usages: 5

There are pretty self explanatory. usages are a special propery which allows you to set a number of usages for the current item. Remember to decrement it using events (check events tutorial).

custom_durability is the durability amount which the item has on crafting (if not specified is the same as max_custom_durability)

max_custom_durability is the max durability the item can reach

Item flags

item_flags:
  - HIDE_ATTRIBUTES
  - HIDE_DESTROYS
  - HIDE_ENCHANTS
  - HIDE_PLACED_ON
  - HIDE_POTION_EFFECTS
  - HIDE_UNBREAKABLE

Special item flags that can hide some vanilla info of the item. You can find a detailed info list here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/ItemFlag.html

blocked_enchants

Special item property that disables enchants for this item, so your users won't be able to enchant it.

blocked_enchants:
      - DAMAGE_UNDEAD
      - DAMAGE_ALL
      - DAMAGE_ARTHROPODS
      - KNOCKBACK
      - DURABILITY
      - SWEEPING_EDGE

events_needed_player_stats

Special attribute to make events work only if the player stat (ItemsAdder player stat, which are usually shown in HUDs) satisfies the set rule.

You can set it to >, < ad =

Example:

Magic wand
  magic_wand:
    display_name: "Magic wand"
    permission: magic_wand
    resource:
      material: DIAMOND_SWORD
      generate: true
      textures:
      - item/example_item.png
    durability:
      max_custom_durability: 512
    attribute_modifiers:
      mainhand:
        attackDamage: 0.1
    blocked_enchants:
    - ALL
    events_needed_player_stats:
      mana: ">0" ### <---- for example. You could also set it to <5 or =1 for example.
    events:
      interact:
        entity:
          target_potion_effect:
            type: GLOWING
            duration: 70
            amplifier: 15
          decrement_player_stat:
            name: mana
            amount: 1

glow

You can make an item glowing when dropped on the ground. Very useful for rare items.

In order to use the glow feature you have to install two APIs.

GlowAPI and PacketListenerAPI

They are needed because this feature is impossible to implement without writing an extremely long code, someone already did it and we can use their API.

Example

items:
  glowing_item:
    display_name: Glowing Item
    resource:
      material: DIAMOND
      generate: true
      textures:
      - item/glowing_item.png
    drop:
      glow:
        enabled: true
        color: DARK_RED

show_name

You can make a drop show its name. Very useful for rare items. Example:

  glowing_item:
    display_name: Glowing Item
    resource:
      material: DIAMOND
      generate: true
      textures:
      - item/glowing_item.png
    drop:
      show_name: true

template

Templates and variants

variant_of

Templates and variants

Use the official files editor to read all the properties

Last updated