Rules Configuration

Control which items can be sold in the auction house using blacklist and whitelist rules. Rules are configured in rules.yml.

How Rules Work

• Blacklist: Prevents specific items from being sold. All items are allowed except those matching the rules.
• Whitelist: Only allows specific items to be sold. All items are blocked except those matching the rules.
• Blacklist is checked before whitelist
• If an item matches a blacklist rule, it is blocked regardless of whitelist

warning

When whitelist is enabled, ONLY items matching whitelist rules can be sold.

File Structure

blacklist:
  enabled: true
  rules:
    - [rule definitions]

whitelist:
  enabled: false
  rules:
    - [rule definitions]

Rule Types Reference

Material Rule

Match items by exact Minecraft material name:

- type: material
  materials:
    - BEDROCK
    - BARRIER
    - COMMAND_BLOCK

Material Suffix Rule

Match materials ending with a specific suffix:

- type: material-suffix
  suffixes:
    - "_SWORD"       # DIAMOND_SWORD, IRON_SWORD, etc.
    - "_HELMET"      # All helmets
    - "_SPAWN_EGG"   # All spawn eggs

Material Prefix Rule

Match materials starting with a specific prefix:

- type: material-prefix
  prefixes:
    - "DIAMOND_"     # DIAMOND_SWORD, DIAMOND_PICKAXE, etc.
    - "NETHERITE_"   # All netherite items
    - "GOLDEN_"      # All golden items

Name Rule

Match items by display name:

- type: name
  mode: CONTAINS  # CONTAINS or EQUALS
  values:
    - "Admin"
    - "Untradeable"
    - "[Soulbound]"

Mode	Description
CONTAINS	Name contains the value anywhere
EQUALS	Name exactly equals the value

When using EQUALS mode, you can configure the ignore-case option to ignore case sensitivity during comparison (enabled by default):

- type: name
  mode: EQUALS
  ignore-case: true  # true by default
  values:
    - "Excalibur"

Lore Rule

Match items by lore content:

- type: lore
  mode: CONTAINS  # CONTAINS or EQUALS
  values:
    - "Soulbound"
    - "Cannot be traded"
    - "Personal Item"

Custom Model Data Rule

Match items by CustomModelData value:

- type: custom-model-data
  ranges:
    - min: 100
      max: 110
  values:
    - 1001
    - 1002
    - 5000

Tag Rule

Match items using Bukkit/Paper item tags:

- type: tag
  tags:
    - BLOCKS
    - ITEMS

Combination Rules

AND Rule

All rules must match:

- type: and
  rules:
    - type: material
      materials:
        - NETHER_STAR
    - type: name
      mode: CONTAINS
      values:
        - "Voucher"

OR Rule

Any rule must match:

- type: or
  rules:
    - type: lore
      mode: CONTAINS
      values:
        - "Soulbound"
    - type: lore
      mode: CONTAINS
      values:
        - "Untradeable"

Custom Item Plugin Rules

All custom item plugin rules support wildcard patterns using *:

ItemsAdder

- type: itemsadder
  items:
    - "namespace:item_id"       # Exact match
    - "namespace:*"             # All items from namespace
    - "mynamespace:rare_*"      # Items starting with "rare_"

Oraxen

- type: oraxen
  items:
    - "custom_sword"
    - "*_armor"                 # Items ending with "_armor"
    - "event_*"                 # Items starting with "event_"

Nexo

- type: nexo
  items:
    - "mythic_blade"
    - "special_*"
    - "*_soulbound"

MMOItems

- type: mmoitems
  items:
    - "SWORD:CUTLASS"           # TYPE:ID format
    - "SWORD:*"                 # All items of type SWORD
    - "*:LEGENDARY_ITEM"        # Any type with this ID
    - "TOOL:*"                  # All tools

ExecutableItems

- type: executableitems
  items:
    - "custom_wand"
    - "voucher_*"
    - "admin_*"

EcoItems

- type: ecoitems
  items:
    - "packmaster_tear"
    - "charm_*"

Slimefun

- type: slimefun
  items:
    - "ELECTRIC_MOTOR"
    - "*_INGOT"
    - "CARGO_*"

HeadDatabase

- type: headdatabase
  items:
    - "12345"                   # By ID
    - "123*"                    # IDs starting with 123

Nova

- type: nova
  items:
    - "machines:electric_furnace"
    - "machines:*"              # All from machines addon
    - "*:solar_panel"           # Any addon with solar_panel

Denizen

- type: denizen
  items:
    - "items-tags"

CraftEngine

- type: craftengine
  items:
    - "custom-woods"

ExecutableBlocks

- type: executableblocks
  items:
    - "block-id"

Blacklist Example

blacklist:
  enabled: true
  rules:
    # Block administrative blocks
    - type: material
      materials:
        - BEDROCK
        - BARRIER
        - COMMAND_BLOCK

    # Block items with "Untradeable" in lore AND model data 1001
    - type: and
      rules:
        - type: lore
          mode: CONTAINS
          values:
            - "Untradeable"
        - type: custom-model-data
          values:
            - 1001

    # Block specific ItemsAdder items
    # - type: itemsadder
    #   items:
    #     - "namespace:*"

    # Block specific Oraxen items
    # - type: oraxen
    #   items:
    #     - "event_*"

    # Block all MMOItems swords
    # - type: mmoitems
    #   items:
    #     - "SWORD:*"

Whitelist Example

Create a specialized auction house (e.g., only vouchers):

whitelist:
  enabled: true
  rules:
    # Only allow Nether Stars with "Voucher" in name
    - type: and
      rules:
        - type: material
          materials:
            - NETHER_STAR
        - type: name
          mode: CONTAINS
          values:
            - "Voucher"

    # Or only weapons
    # - type: material-suffix
    #   suffixes:
    #     - "_SWORD"
    #     - "_AXE"

    # Or items with "Tradeable" lore
    # - type: lore
    #   mode: CONTAINS
    #   values:
    #     - "Tradeable"

Full Example

Complete rules.yml:

blacklist:
  enabled: true
  rules:
    # Block admin blocks
    - type: material
      materials:
        - BEDROCK
        - BARRIER
        - COMMAND_BLOCK
        - CHAIN_COMMAND_BLOCK
        - REPEATING_COMMAND_BLOCK
        - STRUCTURE_BLOCK
        - STRUCTURE_VOID
        - JIGSAW
        - LIGHT
        - DEBUG_STICK

    # Block spawn eggs
    - type: material-suffix
      suffixes:
        - _SPAWN_EGG

    # Block soulbound items
    - type: lore
      mode: CONTAINS
      values:
        - "Soulbound"
        - "Cannot be traded"
        - "Untradeable"

    # Block items with admin tags
    - type: name
      mode: CONTAINS
      values:
        - "[Admin]"
        - "[Staff]"

whitelist:
  enabled: false
  rules:
    # Example: Only allow weapons and armor
    - type: material-suffix
      suffixes:
        - "_SWORD"
        - "_AXE"
        - "_HELMET"
        - "_CHESTPLATE"
        - "_LEGGINGS"
        - "_BOOTS"

Tips

Saving Items

You can save items in Base64 format using /zmenu save <item name> then reference them in your rules for exact item matching.

Reload

After modifying rules, reload with /ah admin reload. Existing listings are not affected - they remain until expired or purchased.

Bypass Permission

Players with this permission can sell blacklisted items:

zauctionhouse.bypass.blacklist