Activator: clickItem

clickItem opens the menu when the player right-clicks an item that matches the spec while holding it. Useful for “Magic Wand” UIs, custom-named tools that pop up menus, compass-based navigation, etc.

intermediate

Features: clickItem-activatorno-command

Open: (right-click item)

menu.conf

# Snippet: clickItem activator - open menu by right-clicking an item in hand
# Docs: https://abstractmenus.github.io/docs/en/examples/snippets/activator-clickitem
# Open: hold a NETHER_STAR named "Menu Wand" and right-click it.
# (To get one for testing: /give @s minecraft:nether_star{display:{Name:'{"text":"Menu Wand"}'}})
# Requires: -

include required(file("./plugins/AbstractMenus/menus/example/_shared/templates.conf"))

title: "&6Menu opened by item click"
size: 1

activators {
  clickItem {
    material: NETHER_STAR
    name: "&6Menu Wand"
  }
}

items: [
  {
    slot: 4
    material: BOOK
    name: "&aIt worked"
    lore: [
      "&7You opened this menu by right-clicking"
      "&7a NETHER_STAR named &6Menu Wand&7 in your hand."
      ""
      "&7See activators docs for clickEntity, clickBlockType,"
      "&7clickNPC, regionJoin, and others."
    ]
  }
  ${buttonClose} { slot: 8 }
]

_shared/templates.conf

# AbstractMenus example pack - shared templates
# Reusable HOCON snippets referenced from menus via ${blockName} substitution.
# Docs: https://abstractmenus.github.io/docs/en/examples

# Sound presets (Paper 1.21+ registry keys)
clickSound:    "ui.button.click"
openSound:     "block.chest.open"
closeSound:    "block.chest.close"
successSound:  "entity.experience_orb.pickup"
failSound:     "block.note_block.bass"
deniedSound:   "block.anvil.land"

# Deny action snippets (use as: denyActions: ${denyNoMoney})
denyNoMoney {
  sound:   ${deniedSound}
  message: "&cYou don't have enough money."
}
denyNoPerm {
  sound:   ${deniedSound}
  message: "&cYou don't have permission."
}
denyCooldown {
  sound:   ${deniedSound}
  message: "&cYou're on cooldown. Try again later."
}

# Border items (use as: ${borderBlack} { slot: "0-8" })
borderBlack {
  material: BLACK_STAINED_GLASS_PANE
  name: " "
}
borderGray {
  material: GRAY_STAINED_GLASS_PANE
  name: " "
}
borderBlue {
  material: BLUE_STAINED_GLASS_PANE
  name: " "
}

# Navigation buttons (use as: ${buttonClose} { slot: 22 })
buttonClose {
  material: BARRIER
  name: "&cClose"
  click {
    closeMenu: true
  }
}
buttonBack {
  material: ARROW
  name: "&eBack"
  lore: ["&7Return to previous menu"]
  click {
    closeMenu: true
  }
}
buttonNext {
  material: ARROW
  name: "&eNext page"
  click {
    pageNext: 1
  }
}
buttonPrev {
  material: ARROW
  name: "&ePrevious page"
  click {
    pagePrev: 1
  }
}

# Rule shortcut snippets (use as: rules: ${rulesAdmin})
rulesAdmin   { permission: "abstractmenus.admin" }
rulesVip     { permission: "abstractmenus.vip" }
rulesDonator { permission: "abstractmenus.donator" }

# Common decorative header (use as: ${commonHeader} { slot: 4 })
commonHeader {
  material: NETHER_STAR
  name: "&6&lExample Menu"
  lore: ["&7Welcome to the AbstractMenus example pack"]
}

↓ menu.conf ↓ Bundle (.zip)

Bundle includes _shared/templates.conf and INSTALL.txt.

Usage

activators {
  clickItem {
    material: NETHER_STAR
    name: "&6Menu Wand"
  }
}

All listed properties must match for the activator to fire. The example above requires both the material AND the exact item name. If the player right-clicks a NETHER_STAR with a different name, nothing happens.

For just material match, drop the name: field. For multiple item triggers, use a list:

activators {
  clickItem: [
    { material: COMPASS }
    { material: NETHER_STAR, name: "&6Menu Wand" }
  ]
}

The plugin sets %activator_item_*% placeholders inside the menu, exposing the clicked item’s data. See Activator context for the full extractor table.

Other “by-the-world” activators

Same shape, different sources:

• clickBlock - click a specific block at known coordinates
• clickBlockType - click any block of a given material
• clickEntity / shiftClickEntity - click an entity (mob, armor stand, item frame)
• clickNPC - click a Citizens NPC by id
• regionJoin / regionLeave - WorldGuard region triggers
• button / lever / plate - vanilla redstone interactables

Mix and match in the same activators {} block - a menu can be opened via command, item-click, AND region-enter, all at once.