🔍Match Item Format

An example of match item format:

  items:
    - 'diamond_sword'
  has-name: true
  has-lore: true
  contains-lore:
    - 'test'
  contains-name:
    - 'test'

By default, all Match Rules need to be met, and you can also use the ANY Match Rule to avoid this. These are all clearly introduced below.

  any:
    material:
      - 'iron_sword'
    has-lore: true

Match Item Rule List

None

No item will match, very useful for apply items.

match-item: # or black-item:
  none: true

NOT

If item didn't meet the match rule you set in NOT section, we will consider this rule as meet the rule.

match-item: # or black-item:
  not:
    items:
      - 'diamond_sword'

ANY

If item meet any of those match item rules, we will consider it meet the rule.

match-item: # or black-item:
  any:
    rarity: COMMON
    material:
      - 'diamond'

ANY Of

If item meet any of those match item rule GROUPS, we will consider it meet the rule.

match-item: # or black-item:
  any:
    1: # Group 1
      contains-name:
        - 'Hello'
      contains-lore:
        - 'Oh'
    2: # Group 2
      contains-lore:
        - 'What'

Items

match-item: # or black-item
  # Type item ID here, support third item plugins item ID.
  items:
    - 'diamond_sword'
    - 'superior_sword'
  use-tier-identify: true

Type item ID or vanilla material ID only, no item type.

For MMOItems: Please note that the item ID needs to be capitalized.

For ItemsAdder: Namespace is required, like namespace_test:item_id_here.

For MMOItems and EcoItems plugin, there is also a use-tier-identity option available in config.yml file, which represents whether to use item ID or item tier. If changed to true, you can use tier IDs such as RARE here instead of the previous item ID.

For list of supported item plugins, please see here.

Material

Require item material must be the value of this list. This is very similar to items rule, but this rule will only use vanilla item material type.

match-item: # or black-item
  material:
    - 'diamond'
    - 'diamond_sword'

Material Tag

Supports item tag or block tag.

match-item: # or black-item
  material-tag:
    - 'swords'

Contains Name/Contains Lore

You shoud not put color code here if you enabled ignore-color-code option at config.yml file.

match-item: # or black-item
  contains-lore:
    - 'test1'
  contains-name:
    - 'test1'

Contains Enchants/Stored Enchants

Similar to has-enchants, but require the enchantment level must be greater than the value you set.

match-item: # or black-item
  contains-enchants:
    POWER: 1

Contains specified levels enchants/stored Enchants

If you want to make only specified enchantment level take effect, you can use int list at here. For example, I want to make only item has Power level 1 enchantment match, then you should set this section like this:

match-item: # or black-item
  contains-enchants:
    POWER: [1] 
    OTHER: [1,2,5] # Means level1, 2 and 5.

Min Enchants Amount

The item must has at least 5 enchantments in this example.

match-item: # or black-item
  contains-enchants-amount: 5

Contains Enchants Amount

This means item must has 3 or 5 enchantments in this example, if the item has 4 enchantments or other number of enchantments, it will not being matched.

match-item: # or black-item
  contains-enchants-amount: [3, 5]

Contains NBT

Require NBTAPI, download it here.

Use ;; distinguish key value hierarchy.

match-item: # or black-item
  contains-nbt: 
    - 'PublicBukkitValues;;mythicchanger:apply_item_id'

Has name

Whether only items with custom display names will match.

match-item: # or black-item
  has-name: true

Has lore

Whether only items with lores will match.

match-item: # or black-item
  has-lore: true

Has Slot

Matches an item whose EnchantmentSlots slot amount is at least the configured number.

match-item:
  has-slot: 1

Has Any Enchants

match-item: # or black-item
  has-enchants:
    - '*'

Has Enchants

match-item: # or black-item
  has-enchants:
    - 'POWER'

Has Stored Enchants

match-item: # or black-item
  has-stored-enchants:
    - 'POWER'

Enchantable

This item can be enchanted by any of those enchantments.

match-item: # or black-item
  enchantable:
    - respiration

Rarity (1.20.5+)

Require item must have specified rarity. Rarity require you extra set in item, by default all items don't have rarity, for item don't have custom rarity, plugin will use "NONE" as result.

This is just mean vanilla item's ratity, NOT means ratity/tier from custom plugins.

match-item: # or black-item
  rarity: NONE

NBT String

Require NBTAPI, download it here.

Require specifed NBT type must be STRING.

Use ;; distinguish key value hierarchy.

The value after the last ;; symbol represents the required NBT value.

match-item: # or black-item
  # Require this NBT value to be A.
  nbt-string:
    - 'PublicBukkitValues;;mythicchanger:apply_item_id;;A'

NBT Int/NBT Double/NBT Byte

Require NBTAPI, download it here.

Similar to NBT String, but should has comparison symbols.

Comparsion symbols support:

• >=

• <=

• >

• <

• ==

match-item: # or black-item
  nbt-double:
    - 'PublicBukkitValues;;mythicchanger:test;;>=;;5'