NPC Vendor

clickNPC from Citizens is a popular activator on RPG servers. The player walks up to a vendor NPC, right-clicks, and a shop menu opens. The menu can read NPC context via %activator_npc_*% placeholders - this example puts the NPC’s name in the menu title for a personal-feeling vendor.

intermediate

Features: clickNPC-activatorCitizens-integration%activator_npc_*%-placeholdersmoney-rule

Requires: CitizensVault

Open: (right-click NPC)

menu.conf

# NPC Vendor - shop opened by clicking a Citizens NPC
# Docs: https://abstractmenus.github.io/docs/en/examples/shops/npc-vendor
# Open: right-click the Citizens NPC with id 1 (replace with your NPC's id)
# Requires: Citizens, Vault

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

title: "&6Trader %activator_npc_name%"
size: 3

activators {
  clickNPC: [1]
}

items: [
  ${borderBlack} { slot: "0-8" }
  ${borderBlack} { slot: "18-26" }

  {
    slot: 4
    material: EMERALD
    name: "&aWelcome, traveler"
    lore: ["&7Buy goods from %activator_npc_name%."]
  }

  {
    slot: 11
    material: BREAD
    count: 8
    name: "&6Bread x8"
    lore: ["&ePrice: &a$30"]
    click {
      rules { money: 30 }
      actions {
        takeMoney: 30
        itemAdd { material: BREAD, count: 8 }
        sound: ${successSound}
      }
      denyActions: ${denyNoMoney}
    }
  }
  {
    slot: 13
    material: COOKED_BEEF
    count: 4
    name: "&6Steak x4"
    lore: ["&ePrice: &a$50"]
    click {
      rules { money: 50 }
      actions {
        takeMoney: 50
        itemAdd { material: COOKED_BEEF, count: 4 }
        sound: ${successSound}
      }
      denyActions: ${denyNoMoney}
    }
  }
  {
    slot: 15
    material: GOLDEN_APPLE
    name: "&6Golden Apple"
    lore: ["&ePrice: &a$200"]
    click {
      rules { money: 200 }
      actions {
        takeMoney: 200
        itemAdd { material: GOLDEN_APPLE }
        sound: ${successSound}
      }
      denyActions: ${denyNoMoney}
    }
  }

  ${buttonClose} { slot: 22 }
]

_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.

What it teaches

• The clickNPC activator with a Citizens NPC ID
• The %activator_npc_name% placeholder for personalized titles
• How activator-context placeholders propagate through to menu items

Setup

This activator only works when Citizens is installed and at least one NPC exists with the specified ID. To find a NPC’s ID:

1. Look at the NPC.
2. Run /npc sel.
3. Run /npc to see selected NPC info, including ID.

Replace clickNPC: [1] with your actual NPC ID. For multiple NPCs that all open the same shop:

clickNPC: [1, 5, 12]

NPC context placeholders

Inside the menu, %activator_npc_*% exposes the clicked NPC:

Placeholder	Returns
%activator_npc_id%	Numeric NPC ID
%activator_npc_name%	NPC’s display name
%activator_npc_world%	World the NPC is in

The example uses %activator_npc_name% in the title, so the menu title becomes “Trader BlacksmithBob” or whatever the NPC is named.

Why this beats command: for vendors

A /shop command is universal - everyone uses the same syntax to open the same menu. A right-click on an NPC ties the shop to a specific in-world location and gives the vendor visual personality. Players also can’t accidentally open the shop from anywhere - they have to physically walk to the NPC. Better roleplay, less command spam.

For a hybrid (open via NPC click OR command), put both in the activators block:

activators {
  command: "ame_vendor"
  clickNPC: [1]
}

Try it

1. Install Citizens.
2. Spawn an NPC: /npc create Bob then look at it, /npc sel, /npc to confirm ID.
3. Drop the bundle into plugins/AbstractMenus/menus/example/. Update clickNPC: [1] to your NPC’s ID.
4. /am reload.
5. Right-click the NPC.