GroupeZ Docs
Inventories

Buttons

All available button types for zAuctionHouse inventories

This page lists all button types available in zAuctionHouse. Each button type has specific functionality and configuration options.

All inventories in zAuctionHouse are powered by zMenu. For general zMenu button configuration (items, slots, lore, etc.), refer to the zMenu documentation.

Item Display Buttons

These buttons display and handle auction items.

TypeDescriptionUsed In
ZAUCTIONHOUSE_LISTED_ITEMSDisplays all listed auction items with paginationAuction
ZAUCTIONHOUSE_EXPIRED_ITEMSDisplays player's expired itemsExpired Items
ZAUCTIONHOUSE_PURCHASED_ITEMSDisplays player's purchased itemsPurchased Items
ZAUCTIONHOUSE_SELLING_ITEMSDisplays player's items on saleSelling Items
ZAUCTIONHOUSE_COMBINED_ITEMSCombines selling, expired, and purchased items in one viewCombined Items
ZAUCTIONHOUSE_HISTORY_ITEMSDisplays player's sales historyHistory

ZAUCTIONHOUSE_LISTED_ITEMS

Displays all items currently listed for sale in the auction house. Supports pagination, category filtering, and sorting.

Configuration:

PropertyTypeDescription
slotsListSlots where items are displayed (e.g., 9-17, 18-26)
empty-slotNumberSlot for the "no items" placeholder
itemItemPlaceholder shown when no items exist

Example:

displayItems:
  type: ZAUCTIONHOUSE_LISTED_ITEMS
  empty-slot: 22
  slots:
    - 9-17
    - 18-26
    - 27-35
    - 36-44
  item:
    material: BARRIER
    name: '#ff0000&nNo items found'

ZAUCTIONHOUSE_EXPIRED_ITEMS

Displays expired items that the player can retrieve. Click an item to claim it back.

Configuration:

PropertyTypeDescription
slotsListSlots where items are displayed
empty-slotNumberSlot for the "no items" placeholder
itemItemPlaceholder shown when no items exist

Example:

items:
  type: ZAUCTIONHOUSE_EXPIRED_ITEMS
  empty-slot: 22
  slots:
    - 9-17
    - 18-26
    - 27-35
    - 36-44
  item:
    material: BARRIER
    name: '#ff0000&nNo items found'

ZAUCTIONHOUSE_PURCHASED_ITEMS

Displays items the player has purchased but not yet claimed.

Configuration:

PropertyTypeDescription
slotsListSlots where items are displayed
empty-slotNumberSlot for the "no items" placeholder
itemItemPlaceholder shown when no items exist

Example:

items:
  type: ZAUCTIONHOUSE_PURCHASED_ITEMS
  empty-slot: 22
  slots:
    - 9-17
    - 18-26
    - 27-35
    - 36-44
  item:
    material: BARRIER
    name: '#ff0000&nNo items found'

ZAUCTIONHOUSE_SELLING_ITEMS

Displays items the player currently has listed for sale. Click to remove an item from sale.

Configuration:

PropertyTypeDescription
slotsListSlots where items are displayed
empty-slotNumberSlot for the "no items" placeholder
itemItemPlaceholder shown when no items exist

Example:

items:
  type: ZAUCTIONHOUSE_SELLING_ITEMS
  empty-slot: 22
  slots:
    - 9-17
    - 18-26
    - 27-35
    - 36-44
  item:
    material: BARRIER
    name: '#ff0000&nNo items found'

ZAUCTIONHOUSE_COMBINED_ITEMS

Combines selling, expired, and purchased items into a single paginated view. Click action automatically adapts to the item's storage type.

Configuration:

PropertyTypeDescription
slotsListSlots where items are displayed (e.g., 9-17, 18-26)
empty-slotNumberSlot for the "no items" placeholder (-1 to disable)
include-sellingBooleanInclude items currently listed for sale (default: true)
include-expiredBooleanInclude expired items (default: true)
include-purchasedBooleanInclude purchased items (default: true)
itemItemPlaceholder shown when no items exist

Example:

items:
  type: ZAUCTIONHOUSE_COMBINED_ITEMS
  empty-slot: 22
  include-selling: true
  include-expired: true
  include-purchased: true
  slots:
    - 9-17
    - 18-26
    - 27-35
    - 36-44
  item:
    material: BARRIER
    name: '#ff0000&nNo items found'

Click behavior:

  • Selling items (status AVAILABLE): Removes/cancels the listing
  • Expired items (status REMOVED): Claims the item back
  • Purchased items (status PURCHASED): Claims the purchased item

Each item type automatically uses its corresponding lore from config.yml (selling-item, expired-item, purchased-item, being-purchased-item).


ZAUCTIONHOUSE_HISTORY_ITEMS

Displays the player's sales history (items they have sold).

Configuration:

PropertyTypeDescription
slotsListSlots where items are displayed
loading-slotNumberSlot for the loading indicator
itemItemLoading placeholder
elseObjectConfiguration when no history exists

Example:

items:
  type: ZAUCTIONHOUSE_HISTORY_ITEMS
  loading-slot: 22
  slots:
    - 9-17
    - 18-26
    - 27-35
    - 36-44
  item:
    material: BARRIER
    name: "#ff0000Loading..."
  else:
    slots:
      - 22
    item:
      material: BARRIER
      name: '#ff0000&nNo Sales Found'

These buttons open other inventories.

TypeDescriptionUsed In
ZAUCTIONHOUSE_EXPIRED_INVENTORYOpens expired items inventoryAuction
ZAUCTIONHOUSE_PURCHASED_INVENTORYOpens purchased items inventoryAuction
ZAUCTIONHOUSE_SELLING_INVENTORYOpens selling items inventoryAuction
ZAUCTIONHOUSE_HISTORY_INVENTORYOpens sales history inventoryAuction
ZAUCTIONHOUSE_CATEGORYOpens auction filtered by categoryCategories
ZAUCTIONHOUSE_CATEGORY_SWITCHERCycles through categories with left/right clickAuction
ZAUCTIONHOUSE_SEARCHOpens chat-based search inputAuction
ZAUCTIONHOUSE_CLEAR_SEARCHClears active search filterAuction

ZAUCTIONHOUSE_EXPIRED_INVENTORY

Opens the expired items inventory. Displays different items based on whether the player has expired items.

Configuration:

PropertyTypeDescription
slotNumberButton position
itemItemShown when player HAS expired items
else.itemItemShown when player has NO expired items
open-when-emptyBooleanOpen the inventory even when the list is empty (default: false). Set it on the else button, with the same type, so the "no items" button can still be clicked

Placeholders:

  • %expired-items% - Number of expired items
  • %s% - Pluralization suffix ("" for 1, "s" for 2+)

Example:

expired-items:
  type: ZAUCTIONHOUSE_EXPIRED_INVENTORY
  slot: 45
  item:
    url: "eyJ0ZXh0dXJlcy..."
    name: "#2CCED2<bold>ᴇxᴘɪʀᴇᴅ ɪᴛᴇᴍs"
    lore:
      - "#92ffffYou have #2CCED2%expired-items% #92ffffexpired item%s%."
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto open"
  else:
    type: ZAUCTIONHOUSE_EXPIRED_INVENTORY
    open-when-empty: true
    item:
      url: "eyJ0ZXh0dXJlcy..."
      name: "#2CCED2<bold>ᴇxᴘɪʀᴇᴅ ɪᴛᴇᴍs"
      lore:
        - "#ff3535You have no expired items."

ZAUCTIONHOUSE_PURCHASED_INVENTORY

Opens the purchased items inventory.

Configuration:

PropertyTypeDescription
slotNumberButton position
itemItemShown when player HAS purchased items
else.itemItemShown when player has NO purchased items
open-when-emptyBooleanOpen the inventory even when the list is empty (default: false). Set it on the else button, with the same type, so the "no items" button can still be clicked

Placeholders:

  • %purchased-items% - Number of purchased items
  • %s% - Pluralization suffix

Example:

purchased-items:
  type: ZAUCTIONHOUSE_PURCHASED_INVENTORY
  slot: 46
  item:
    url: "eyJ0ZXh0dXJlcy..."
    name: "#2CCED2<bold>ᴘᴜʀᴄʜᴀsᴇᴅ ɪᴛᴇᴍs"
    lore:
      - "#92ffffYou have #2CCED2%purchased-items% #92ffffbought item%s%."
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto open"
  else:
    type: ZAUCTIONHOUSE_PURCHASED_INVENTORY
    open-when-empty: true
    item:
      url: "eyJ0ZXh0dXJlcy..."
      name: "#2CCED2<bold>ᴘᴜʀᴄʜᴀsᴇᴅ ɪᴛᴇᴍs"
      lore:
        - "#ff3535You have no purchased items."

ZAUCTIONHOUSE_SELLING_INVENTORY

Opens the inventory showing items the player currently has on sale.

Configuration:

PropertyTypeDescription
slotNumberButton position
itemItemShown when player HAS items on sale
else.itemItemShown when player has NO items on sale
open-when-emptyBooleanOpen the inventory even when the list is empty (default: false). Set it on the else button, with the same type, so the "no items" button can still be clicked

Placeholders:

  • %selling-items% - Number of items on sale
  • %s% - Pluralization suffix

Example:

selling-items:
  type: ZAUCTIONHOUSE_SELLING_INVENTORY
  slot: 53
  item:
    url: "eyJ0ZXh0dXJlcy..."
    name: "#2CCED2<bold>ʏᴏᴜʀ ɪᴛᴇᴍs"
    lore:
      - "#92ffffYou have #2CCED2%selling-items% #92ffffitem%s% on sale."
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto open"
  else:
    type: ZAUCTIONHOUSE_SELLING_INVENTORY
    open-when-empty: true
    item:
      url: "eyJ0ZXh0dXJlcy..."
      name: "#2CCED2<bold>ʏᴏᴜʀ ɪᴛᴇᴍs"
      lore:
        - "#ff3535You have no items for sale."

ZAUCTIONHOUSE_HISTORY_INVENTORY

Opens the sales history inventory.

Configuration:

PropertyTypeDescription
slotNumberButton position
itemItemButton appearance

Example:

history:
  type: ZAUCTIONHOUSE_HISTORY_INVENTORY
  slot: 47
  item:
    material: BOOK
    name: "#2CCED2<bold>sᴀʟᴇs ʜɪsᴛᴏʀʏ"
    lore:
      - "#92ffffView your sales history."
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto open"

ZAUCTIONHOUSE_CATEGORY

Opens the auction house filtered by a specific category.

Configuration:

PropertyTypeDescription
slotNumberButton position
categoryStringCategory name (must match categories.yml)
itemItemButton appearance

Special Categories:

  • all - Shows all items (no filtering)

Placeholders:

  • %zauctionhouse_category_count_<name>% - Number of items in category

Example:

weapons:
  type: ZAUCTIONHOUSE_CATEGORY
  category: weapons
  slot: 20
  item:
    material: DIAMOND_SWORD
    name: "#ff5555<bold>ᴡᴇᴀᴘᴏɴs"
    lore:
      - "#92ffffCombat equipment"
      - ""
      - "#92ffffItems#8c8c8c: #2CCED2%zauctionhouse_category_count_weapons%"
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto browse"

ZAUCTIONHOUSE_CATEGORY_SWITCHER

Cycles through categories using left/right click. Displays a dynamic lore showing the enable/disable state for each category.

Configuration:

PropertyTypeDescription
slotNumberButton position
enable-textStringFormat for the currently selected category
disable-textStringFormat for unselected categories
categoriesListList of category IDs to cycle through
itemItemButton appearance

Placeholders:

  • %category% - Current category display name
  • %<category-id>% - Replaced by enable-text or disable-text for each category

Example:

category-switcher:
  type: ZAUCTIONHOUSE_CATEGORY_SWITCHER
  slot: 49
  enable-text: "&a● %category%"
  disable-text: "&7○ %category%"
  categories:
    - "main"
    - "weapons"
    - "armor"
    - "tools"
    - "blocks"
    - "consumables"
    - "resources"
    - "enchanted-books"
    - "misc"
  item:
    material: COMPASS
    name: "&6Categories &7(&f%category%&7)"
    lore:
      - ""
      - "%main%"
      - "%weapons%"
      - "%armor%"
      - "%tools%"
      - "%blocks%"
      - "%consumables%"
      - "%resources%"
      - "%enchanted-books%"
      - "%misc%"
      - ""
      - "&7Left-click &8» &fNext"
      - "&7Right-click &8» &fPrevious"

Use "main" as a category ID to represent "All Items" (no filtering).


Search Buttons

TypeDescriptionUsed In
ZAUCTIONHOUSE_SEARCHOpens chat-based search inputAuction
ZAUCTIONHOUSE_CLEAR_SEARCHClears active search filterAuction

Opens a chat-based search input. When clicked, the player's inventory closes and they can type a search query in chat. Supports advanced filter operators for targeted searches.

Configuration:

PropertyTypeDescription
slotNumberButton position
none-valueStringText shown in %search_query% when no search is active. Defaults to None; ships localized per language (FR Aucune, ES Ninguna, IT Nessuna, TH ไม่มี).
active-valueStringText shown in %search_active% when a search is active. Defaults to true.
inactive-valueStringText shown in %search_active% when no search is active. Defaults to false.
itemItemButton appearance

Placeholders:

  • %search_query% - Current search query (or the configurable none-value, default None / localized, when no search is active)
  • %search_active% - Whether a search is active (the configurable active-value / inactive-value, default true / false)

Search Operators:

OperatorDescription
~Contains (case-sensitive)
=Exact match (case-sensitive)
~=Contains (ignore case)
==Exact match (ignore case)

Searchable Fields: name, material, lore, seller

Example:

search:
  type: ZAUCTIONHOUSE_SEARCH
  slot: 47
  is-permanent: true
  # Value shown in %search_query% when no search is active.
  none-value: "None"
  # Value shown in %search_active% when a search is active.
  active-value: "true"
  # Value shown in %search_active% when no search is active.
  inactive-value: "false"
  item:
    material: COMPASS
    name: "#2CCED2<bold>sᴇᴀʀᴄʜ"
    lore:
      - ""
      - "#92ffffCurrent search#8c8c8c: #2CCED2%search_query%"
      - ""
      - "#92ffffFilters#8c8c8c:"
      - "#8c8c8c  name #76CDCD~ #8c8c8cvalue    #555555(contains)"
      - "#8c8c8c  name #76CDCD= #8c8c8cvalue    #555555(exact)"
      - "#8c8c8c  name #76CDCD~= #8c8c8cvalue   #555555(contains, ignore case)"
      - "#8c8c8c  name #76CDCD== #8c8c8cvalue   #555555(exact, ignore case)"
      - ""
      - "#92ffffFields#8c8c8c: #76CDCDname#8c8c8c, #76CDCDmaterial#8c8c8c, #76CDCDlore#8c8c8c, #76CDCDseller"
      - ""
      - "#92ffffExamples#8c8c8c:"
      - "#8c8c8c  seller #76CDCD= #8c8c8cNotch"
      - "#8c8c8c  name #76CDCD~ #8c8c8cDiamond"
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto search"

Without an operator, the search performs a case-insensitive substring match on item name, material, lore, and seller name simultaneously.


Clears the active search filter. This button is only visible when the player has an active search query.

Configuration:

PropertyTypeDescription
slotNumberButton position
itemItemButton appearance

Placeholders:

  • %search_query% - Current search query

Example:

clear-search:
  type: ZAUCTIONHOUSE_CLEAR_SEARCH
  slot: 48
  is-permanent: true
  item:
    material: BARRIER
    name: "#ff6b6b<bold>ᴄʟᴇᴀʀ sᴇᴀʀᴄʜ"
    lore:
      - ""
      - "#92ffffSearching for#8c8c8c: #2CCED2%search_query%"
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto clear search"

Claim Button

TypeDescriptionUsed In
ZAUCTIONHOUSE_CLAIMDisplays pending money and allows claimingAuction

ZAUCTIONHOUSE_CLAIM

Displays the player's pending money from sales and allows them to claim it with a single click. Shows per-economy amounts using dynamic placeholders and supports a loading state while data is being fetched.

Configuration:

PropertyTypeDescription
slotNumberButton position
loading-itemItemShown while pending money data is loading
itemItemNormal button appearance with pending money placeholders

Placeholders:

PlaceholderDescription
%pending_total%Total pending money across all economies (formatted)
%pending_<economy_name>%Pending money for a specific economy (e.g., %pending_vault%)
%has_pending%true or false

The economy name corresponds to the name field defined in your economies.yml configuration. For example, if you have an economy with name: vault, use %pending_vault%.

Example:

claim-money:
  type: ZAUCTIONHOUSE_CLAIM
  slot: 48
  loading-item:
    material: CLOCK
    name: "#2CCED2<bold>ᴄʟᴀɪᴍ ᴍᴏɴᴇʏ"
    lore:
      - "#8c8c8c• #ff3535Loading, please wait..."
  item:
    material: GOLD_INGOT
    name: "#2CCED2<bold>ᴄʟᴀɪᴍ ᴍᴏɴᴇʏ"
    lore:
      - ""
      - "#92ffffPending money#8c8c8c: #2CCED2%pending_total%"
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto claim your money"

Multi-economy example:

claim-money:
  type: ZAUCTIONHOUSE_CLAIM
  slot: 48
  loading-item:
    material: CLOCK
    name: "#2CCED2<bold>ᴄʟᴀɪᴍ ᴍᴏɴᴇʏ"
    lore:
      - "#8c8c8c• #ff3535Loading, please wait..."
  item:
    material: GOLD_INGOT
    name: "#2CCED2<bold>ᴄʟᴀɪᴍ ᴍᴏɴᴇʏ"
    lore:
      - ""
      - "#92ffffVault#8c8c8c: #2CCED2%pending_vault%"
      - "#92ffffTokens#8c8c8c: #2CCED2%pending_tokens%"
      - "#92ffffTotal#8c8c8c: #2CCED2%pending_total%"
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto claim your money"

Sort Buttons

TypeDescriptionUsed In
ZAUCTIONHOUSE_CHANGE_SORTChanges auction item sort orderAuction
ZAUCTIONHOUSE_HISTORY_SORTChanges history sort orderHistory

ZAUCTIONHOUSE_CHANGE_SORT

Cycles through available sort options for the auction house.

Configuration:

PropertyTypeDescription
slotNumberButton position
sortsListAvailable sort options
enable-textStringFormat for selected sort option
disable-textStringFormat for unselected sort options
loading-itemItemShown while sorting
itemItemButton appearance

Sort Options:

  • DECREASING_DATE - Newest first
  • INCREASING_DATE - Oldest first
  • DECREASING_PRICE - Most expensive first
  • INCREASING_PRICE - Cheapest first

Example:

change-sort:
  type: ZAUCTIONHOUSE_CHANGE_SORT
  slot: 52
  sorts:
    - DECREASING_DATE
    - DECREASING_PRICE
    - ASCENDING_DATE
    - ASCENDING_PRICE
  enable-text: ' #F27438➜ %sorting%'
  disable-text: ' #76CDCD➜ %sorting%'
  loading-item:
    material: HOPPER
    name: "#2CCED2<bold>sᴏʀᴛ ᴛʏᴘᴇ"
    lore:
      - "#8c8c8c• #ff3535Loading, please wait"
  item:
    material: HOPPER
    name: "#2CCED2<bold>sᴏʀᴛ ᴛʏᴘᴇ"
    lore:
      - "#92ffffAvailable sort types:"
      - "%DECREASING_DATE%"
      - "%DECREASING_PRICE%"
      - "%ASCENDING_DATE%"
      - "%ASCENDING_PRICE%"
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto change the sort type"

ZAUCTIONHOUSE_HISTORY_SORT

Cycles through sort options for sales history.

Configuration:

PropertyTypeDescription
slotNumberButton position
sortsListAvailable sort options
sort-namesMapDisplay names for sort options
enable-textStringFormat for selected sort option
disable-textStringFormat for unselected sort options
itemItemButton appearance

Sort Options:

  • DATE_DESC - Newest first
  • DATE_ASC - Oldest first
  • PRICE_DESC - Highest price first
  • PRICE_ASC - Lowest price first
  • BUYER_ASC - Buyer name A-Z
  • BUYER_DESC - Buyer name Z-A

Example:

sort:
  type: ZAUCTIONHOUSE_HISTORY_SORT
  slot: 51
  enable-text: ' #F27438➜ %sorting%'
  disable-text: ' #76CDCD➜ %sorting%'
  sorts:
    - DATE_DESC
    - DATE_ASC
    - PRICE_DESC
    - PRICE_ASC
  sort-names:
    DATE_DESC: "Newest First"
    DATE_ASC: "Oldest First"
    PRICE_DESC: "Highest Price"
    PRICE_ASC: "Lowest Price"
  item:
    material: HOPPER
    name: "#2CCED2<bold>sᴏʀᴛ"
    lore:
      - "#92ffffAvailable sort types:"
      - "%DATE_DESC%"
      - "%DATE_ASC%"
      - "%PRICE_DESC%"
      - "%PRICE_ASC%"
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto change the sort type"

Sell Inventory Buttons

These buttons are used in the sell inventory.

TypeDescriptionUsed In
ZAUCTIONHOUSE_SELL_SHOW_ITEMDisplays selected itemsSell
ZAUCTIONHOUSE_SELL_PRICEAdjusts listing priceSell
ZAUCTIONHOUSE_SELL_ECONOMYSelects economy typeSell
ZAUCTIONHOUSE_SELL_CONFIRMConfirms the saleSell
ZAUCTIONHOUSE_SELL_CANCELCancels the saleSell

ZAUCTIONHOUSE_SELL_SHOW_ITEM

Displays items selected for sale.

Configuration:

PropertyTypeDescription
slotsListSlots for displaying items
empty-slotNumberSlot for "no item" placeholder
itemItemPlaceholder when no item selected

Example:

show-item:
  type: ZAUCTIONHOUSE_SELL_SHOW_ITEM
  slots:
    - 9-44
  empty-slot: 22
  item:
    material: BARRIER
    name: "#ff0000<bold>No Item Selected"
    lore:
      - ""
      - "#8c8c8cHold an item in your hand"
      - "#8c8c8cor select items from your inventory"

ZAUCTIONHOUSE_SELL_PRICE

Adjusts the listing price with different amounts per click type.

Configuration:

PropertyTypeDescription
slotNumberButton position
amountsMapPrice changes per click type
itemItemButton appearance

Click Types:

  • left-click - Regular left click
  • right-click - Regular right click
  • shift-left-click - Shift + left click
  • shift-right-click - Shift + right click

Placeholders:

  • %price% - Current listing price

Example (Decrease):

price-decrease:
  type: ZAUCTIONHOUSE_SELL_PRICE
  slot: 48
  amounts:
    left-click: -500
    right-click: -100
    shift-left-click: -1000
    shift-right-click: -2500
  item:
    url: eyJ0ZXh0dXJlcy...
    name: "#ff3333-1,000"
    lore:
      - ""
      - "<white>Current price#8c8c8c: #2CCED2%price%"
      - ""
      - "#8c8c8c• #92ffffLeft click#8c8c8c: -500"
      - "#8c8c8c• #92ffffRight click#8c8c8c: -100"
      - "#8c8c8c• #92ffffShift+Left#8c8c8c: -1,000"
      - "#8c8c8c• #92ffffShift+Right#8c8c8c: -2,500"

Example (Increase):

price-increase:
  type: ZAUCTIONHOUSE_SELL_PRICE
  slot: 50
  amounts:
    left-click: 500
    right-click: 100
    shift-left-click: 1000
    shift-right-click: 2500
  item:
    url: eyJ0ZXh0dXJlcy...
    name: '#00cc00+1,000'
    lore:
      - '<white>Current price#8c8c8c: #2CCED2%price%'
      - ''
      - '#8c8c8c• #92ffffLeft click#8c8c8c: +500'
      - '#8c8c8c• #92ffffRight click#8c8c8c: +100'
      - '#8c8c8c• #92ffffShift+Left#8c8c8c: +1,000'
      - '#8c8c8c• #92ffffShift+Right#8c8c8c: +2,500'

ZAUCTIONHOUSE_SELL_ECONOMY

Cycles through available economies.

With the economy option the button no longer cycles: clicking it selects that economy. Add one button per economy to let the player pick directly.

Configuration:

PropertyTypeDescription
slotNumberButton position
itemItemButton appearance
economyStringOptional. Economy selected on click instead of cycling (name from economies.yml)

Placeholders:

  • %economy% - Display name of the economy (the button's economy with economy, otherwise the selected one)
  • %economy_name% - Internal name of that economy
  • %price% - Listing price formatted in that economy
  • %selected% - true when this economy is the selected one

Example:

select-economy:
  type: ZAUCTIONHOUSE_SELL_ECONOMY
  slot: 49
  item:
    url: eyJ0ZXh0dXJlcy...
    name: "#ffd700<bold>Economy"
    lore:
      - ""
      - "<white>Current#8c8c8c: #2CCED2%economy%"
      - ""
      - "#8c8c8c• #92ffffLeft click#8c8c8c: Next economy"
      - "#8c8c8c• #92ffffRight click#8c8c8c: Previous economy"

One button per economy:

select-money:
  type: ZAUCTIONHOUSE_SELL_ECONOMY
  economy: vault
  slot: 48
  item:
    material: GOLD_INGOT
    name: "#ffd700<bold>Money"
    lore:
      - "<white>Price#8c8c8c: #2CCED2%price%"
      - "<white>Selected#8c8c8c: #2CCED2%selected%"

select-levels:
  type: ZAUCTIONHOUSE_SELL_ECONOMY
  economy: level
  slot: 50
  item:
    material: EXPERIENCE_BOTTLE
    name: "#7cfc00<bold>Levels"
    lore:
      - "<white>Price#8c8c8c: #2CCED2%price%"
      - "<white>Selected#8c8c8c: #2CCED2%selected%"

ZAUCTIONHOUSE_SELL_CONFIRM

Confirms the sale and lists the items.

With the economy option the button always sells with that economy, whatever economy is selected: one confirm button per economy lists the item in a single click. The price limits of that economy still apply: a price outside them is refused. If the economy does not exist, a warning is logged when the inventory loads and the click sends sell-error-economy.

Configuration:

PropertyTypeDescription
slotNumberButton position
itemItemButton appearance
economyStringOptional. Always sell with this economy (name from economies.yml)

Placeholders:

  • %economy% - Economy of the sale (the button's economy with economy, otherwise the selected one)
  • %economy_name% - Internal name of that economy
  • %price% - Listing price
  • %item_count% - Number of items

Example:

confirm:
  type: ZAUCTIONHOUSE_SELL_CONFIRM
  slot: 53
  item:
    material: LIME_STAINED_GLASS_PANE
    name: "#00ff00<bold>CONFIRM SALE"
    lore:
      - ""
      - "<white>Economy#8c8c8c: #2CCED2%economy%"
      - "<white>Price#8c8c8c: #2CCED2%price%"
      - "<white>Items#8c8c8c: #2CCED2%item_count%"
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto confirm the sale"

One confirm button per economy:

sell-for-money:
  type: ZAUCTIONHOUSE_SELL_CONFIRM
  economy: vault
  slot: 52
  item:
    material: GOLD_INGOT
    name: "#00ff00<bold>Sell for %price%"

sell-for-levels:
  type: ZAUCTIONHOUSE_SELL_CONFIRM
  economy: level
  slot: 53
  item:
    material: EXPERIENCE_BOTTLE
    name: "#00ff00<bold>Sell for %price%"

ZAUCTIONHOUSE_SELL_CANCEL

Cancels the sale and returns items to the player.

Configuration:

PropertyTypeDescription
slotNumberButton position
itemItemButton appearance

Example:

cancel:
  type: ZAUCTIONHOUSE_SELL_CANCEL
  slot: 45
  item:
    material: RED_STAINED_GLASS_PANE
    name: "#ff0000<bold>CANCEL"
    lore:
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto cancel and return items"

Confirmation Buttons

TypeDescriptionUsed In
ZAUCTIONHOUSE_CONFIRM_PURCHASEConfirms a purchasePurchase Confirm
ZAUCTIONHOUSE_CONFIRM_REMOVE_LISTEDConfirms removing a listingRemove Confirm
ZAUCTIONHOUSE_SHOWDisplays the auction itemConfirmations

ZAUCTIONHOUSE_CONFIRM_PURCHASE

Confirms the purchase of an item.

Configuration:

PropertyTypeDescription
slotsListButton slots (larger click area)
itemItemButton appearance

Example:

confirm:
  type: ZAUCTIONHOUSE_CONFIRM_PURCHASE
  slots:
    - 0-2
    - 9-11
    - 18-20
  item:
    material: GREEN_STAINED_GLASS_PANE
    name: "#2CCED2<bold>ᴘᴜʀᴄʜᴀsᴇ"
    lore:
      - "#92ffffPurchase this item."
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto purchase"

ZAUCTIONHOUSE_CONFIRM_REMOVE_LISTED

Confirms removing an item from sale.

Configuration:

PropertyTypeDescription
slotsListButton slots
itemItemButton appearance

Example:

remove:
  type: ZAUCTIONHOUSE_CONFIRM_REMOVE_LISTED
  slots:
    - 0-2
    - 9-11
    - 18-20
  item:
    material: GREEN_STAINED_GLASS_PANE
    name: "#2CCED2<bold>ʀᴇᴍᴏᴠᴇ"
    lore:
      - "#92ffffRemove this item."
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto remove"

ZAUCTIONHOUSE_SHOW

Displays the auction item being confirmed.

Configuration:

PropertyTypeDescription
slotNumberDisplay position

Example:

show:
  type: ZAUCTIONHOUSE_SHOW
  slot: 13

Container Content Buttons

These buttons display the contents of container items (shulker boxes, AxShulkers, etc.). The system is extensible via the ItemContentProvider API, allowing plugins to register custom container types.

TypeDescriptionUsed In
ZAUCTIONHOUSE_SHULKER_OPENOpens container content viewerConfirmations
ZAUCTIONHOUSE_SHULKER_CONTENTDisplays container contentsShulker Content
ZAUCTIONHOUSE_SHULKER_INFOShows container informationShulker Content
ZAUCTIONHOUSE_SHULKER_NAVIGATIONNavigates between containersShulker Content

Supported container types:

  • Vanilla shulker boxes - built-in, no extra plugin required
  • AxShulkers - requires AxShulkers plugin

External plugins can register additional container types via the API:

AuctionPlugin api = getServer().getServicesManager().load(AuctionPlugin.class);
api.getItemContentManager().registerProvider(new MyCustomContentProvider());

ZAUCTIONHOUSE_SHULKER_OPEN

Opens the container content preview. Only visible when the item contains recognized container items (shulker boxes, AxShulkers, etc.).

Configuration:

PropertyTypeDescription
slotNumberButton position
itemItemButton appearance

Example:

shulker:
  type: ZAUCTIONHOUSE_SHULKER_OPEN
  slot: 4
  item:
    material: SHULKER_BOX
    name: "#2CCED2<bold>ᴠɪᴇᴡ sʜᴜʟᴋᴇʀ ᴄᴏɴᴛᴇɴᴛ"
    lore:
      - "#92ffffView the content of shulker boxes."
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto view content"

ZAUCTIONHOUSE_SHULKER_CONTENT

Displays the contents of the current shulker box.

Configuration:

PropertyTypeDescription
slotsListSlots for displaying contents

Example:

content:
  type: ZAUCTIONHOUSE_SHULKER_CONTENT
  slots:
    - 9-17
    - 18-26
    - 27-35
    - 36-44

ZAUCTIONHOUSE_SHULKER_INFO

Displays information about the current shulker.

Configuration:

PropertyTypeDescription
slotNumberButton position
itemItemButton appearance

Placeholders:

  • %shulker_current% - Current shulker number
  • %shulker_total% - Total shulkers

Example:

shulker-info:
  type: ZAUCTIONHOUSE_SHULKER_INFO
  slot: 4
  item:
    material: SHULKER_BOX
    name: "#2CCED2<bold>sʜᴜʟᴋᴇʀ ʙᴏx"
    lore:
      - "#92ffffViewing shulker #2CCED2%shulker_current% #92ffffof #2CCED2%shulker_total%"

ZAUCTIONHOUSE_SHULKER_NAVIGATION

Navigates between shulkers in bulk sales.

Configuration:

PropertyTypeDescription
slotNumberButton position
directionStringprevious or next
itemItemButton appearance

Example:

previous:
  type: ZAUCTIONHOUSE_SHULKER_NAVIGATION
  direction: previous
  slot: 48
  item:
    material: ARROW
    name: "#2CCED2<bold>ᴘʀᴇᴠɪᴏᴜs sʜᴜʟᴋᴇʀ"
    lore:
      - "#92ffffView the previous shulker box."

next:
  type: ZAUCTIONHOUSE_SHULKER_NAVIGATION
  direction: next
  slot: 50
  item:
    material: ARROW
    name: "#2CCED2<bold>ɴᴇxᴛ sʜᴜʟᴋᴇʀ"
    lore:
      - "#92ffffView the next shulker box."

Bulk Item Buttons

TypeDescriptionUsed In
ZAUCTIONHOUSE_ITEM_CONTENTDisplays all items in a bulk salePurchase Inventory Confirm, Remove Inventory Confirm

ZAUCTIONHOUSE_ITEM_CONTENT

Displays all items in a bulk sale. Used in confirmation inventories for bulk purchases and removals.

Configuration:

PropertyTypeDescription
slotsListSlots for displaying items

Example:

item-content:
  type: ZAUCTIONHOUSE_ITEM_CONTENT
  slots:
    - 9-44

Remove All Buttons

TypeDescriptionUsed In
ZAUCTIONHOUSE_REMOVE_ALL_EXPIREDRetrieves all expired items at onceExpired Items
ZAUCTIONHOUSE_REMOVE_ALL_SELLINGRetrieves all selling items at onceSelling Items
ZAUCTIONHOUSE_REMOVE_ALL_PURCHASEDRetrieves all purchased items at oncePurchased Items

ZAUCTIONHOUSE_REMOVE_ALL_EXPIRED

Retrieves all expired items at once. Items are given one by one and the process stops when the player's inventory is full (if player-inventory-must-have-free-space is enabled under remove-expired-item in config.yml).

Example:

remove-all:
  type: ZAUCTIONHOUSE_REMOVE_ALL_EXPIRED
  is-permanent: true
  slot: 47
  item:
    material: CHEST
    name: "#2CCED2<bold>Retrieve All"
    lore:
      - "#92ffffRetrieve all expired items."
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto retrieve all"

ZAUCTIONHOUSE_REMOVE_ALL_SELLING

Retrieves all selling items at once. Cancels listings and returns items to the player. Items currently being purchased by another player are skipped.

Example:

remove-all:
  type: ZAUCTIONHOUSE_REMOVE_ALL_SELLING
  is-permanent: true
  slot: 47
  item:
    material: CHEST
    name: "#2CCED2<bold>Retrieve All"
    lore:
      - "#92ffffRetrieve all selling items."
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto retrieve all"

ZAUCTIONHOUSE_REMOVE_ALL_PURCHASED

Retrieves all purchased items at once. Items are given one by one and the process stops when the player's inventory is full (if player-inventory-must-have-free-space is enabled under purchased-item in config.yml).

Example:

remove-all:
  type: ZAUCTIONHOUSE_REMOVE_ALL_PURCHASED
  is-permanent: true
  slot: 47
  item:
    material: CHEST
    name: "#2CCED2<bold>Retrieve All"
    lore:
      - "#92ffffRetrieve all purchased items."
      - ""
      - "#8c8c8c• #2CCED2Click #92ffffto retrieve all"

Admin Buttons

Item Display Buttons

TypeDescriptionUsed In
ZAUCTIONHOUSE_ADMIN_SELLING_ITEMSDisplays target's selling itemsAdmin Selling Items
ZAUCTIONHOUSE_ADMIN_EXPIRED_ITEMSDisplays target's expired itemsAdmin Expired Items
ZAUCTIONHOUSE_ADMIN_PURCHASED_ITEMSDisplays target's purchased itemsAdmin Purchased Items
ZAUCTIONHOUSE_ADMIN_LOGSDisplays action logsAdmin Logs
ZAUCTIONHOUSE_ADMIN_TRANSACTIONSDisplays transactionsAdmin Transactions

Filter Buttons

TypeDescriptionUsed In
ZAUCTIONHOUSE_ADMIN_LOGS_FILTER_TYPEFilters logs by action typeAdmin Logs
ZAUCTIONHOUSE_ADMIN_LOGS_FILTER_DATEFilters logs by date rangeAdmin Logs
ZAUCTIONHOUSE_ADMIN_TRANSACTIONS_FILTER_STATUSFilters transactions by statusAdmin Transactions
ZAUCTIONHOUSE_ADMIN_TRANSACTIONS_FILTER_DATEFilters transactions by dateAdmin Transactions

ZAUCTIONHOUSE_ADMIN_HISTORY_MAIN

Displays target player information (player head).

Configuration:

PropertyTypeDescription
slotNumberButton position
itemItemButton appearance

Example:

target:
  type: ZAUCTIONHOUSE_ADMIN_HISTORY_MAIN
  slot: 13
  item:
    player-head: '%target%'
    name: '#2CCED2<bold>%target%'

ZAUCTIONHOUSE_ADMIN_HISTORY_EXPIRED

Opens the admin expired items inventory for the target player.

Placeholders:

  • %target% - Target player name
  • %expired-items% - Number of expired items
  • %s% - Pluralization suffix

ZAUCTIONHOUSE_ADMIN_HISTORY_PURCHASED

Opens the admin purchased items inventory for the target player.

Placeholders:

  • %target% - Target player name
  • %purchased-items% - Number of purchased items
  • %s% - Pluralization suffix

ZAUCTIONHOUSE_ADMIN_HISTORY_SELLING

Opens the admin selling items inventory for the target player.

Placeholders:

  • %target% - Target player name
  • %selling-items% - Number of selling items
  • %s% - Pluralization suffix

ZAUCTIONHOUSE_ADMIN_HISTORY_LOGS

Opens the admin logs inventory for the target player.


ZAUCTIONHOUSE_ADMIN_HISTORY_TRANSACTIONS

Opens the admin transactions inventory for the target player.


ZAUCTIONHOUSE_ADMIN_LOGS_FILTER_TYPE

Cycles through log type filters.

Configuration:

PropertyTypeDescription
slotNumberButton position
typesListAvailable log types to filter
type-namesMapDisplay names for each type
enable-textStringFormat for selected type
disable-textStringFormat for unselected types
all-types-nameStringDisplay name for "all" option

Log Types:

  • SALE - Item was listed for sale
  • PURCHASE - Item was purchased
  • REMOVE_LISTED - Item removed from active listing
  • REMOVE_SELLING - Item retrieved from selling inventory
  • REMOVE_EXPIRED - Item retrieved from expired inventory
  • REMOVE_PURCHASED - Item retrieved from purchased inventory

ZAUCTIONHOUSE_ADMIN_LOGS_FILTER_DATE

Cycles through date range filters.

Configuration:

PropertyTypeDescription
slotNumberButton position
filtersListAvailable date filters
filter-namesMapDisplay names for each filter
enable-textStringFormat for selected filter
disable-textStringFormat for unselected filters

Date Filters:

  • ALL - All time
  • TODAY - Today only
  • THIS_WEEK - Last 7 days
  • THIS_MONTH - Last 30 days
  • THIS_YEAR - Last 365 days

ZAUCTIONHOUSE_ADMIN_TRANSACTIONS_FILTER_STATUS

Cycles through transaction status filters.

Configuration:

PropertyTypeDescription
slotNumberButton position
statusesListAvailable statuses
status-namesMapDisplay names for each status
enable-textStringFormat for selected status
disable-textStringFormat for unselected statuses
all-statuses-nameStringDisplay name for "all" option

Statuses:

  • PENDING - Money not yet claimed
  • RETRIEVED - Money has been claimed

ZAUCTIONHOUSE_ADMIN_TRANSACTIONS_FILTER_DATE

Cycles through date range filters for transactions.

Configuration:

Same as ZAUCTIONHOUSE_ADMIN_LOGS_FILTER_DATE.


zMenu Built-in Buttons

These buttons are provided by zMenu and work in all inventories.

TypeDescription
PREVIOUSGoes to the previous page
NEXTGoes to the next page
BACKReturns to the previous inventory
inventoryOpens another inventory

See zMenu documentation for more details.

On this page

Item Display ButtonsZAUCTIONHOUSE_LISTED_ITEMSZAUCTIONHOUSE_EXPIRED_ITEMSZAUCTIONHOUSE_PURCHASED_ITEMSZAUCTIONHOUSE_SELLING_ITEMSZAUCTIONHOUSE_COMBINED_ITEMSZAUCTIONHOUSE_HISTORY_ITEMSNavigation ButtonsZAUCTIONHOUSE_EXPIRED_INVENTORYZAUCTIONHOUSE_PURCHASED_INVENTORYZAUCTIONHOUSE_SELLING_INVENTORYZAUCTIONHOUSE_HISTORY_INVENTORYZAUCTIONHOUSE_CATEGORYZAUCTIONHOUSE_CATEGORY_SWITCHERSearch ButtonsZAUCTIONHOUSE_SEARCHZAUCTIONHOUSE_CLEAR_SEARCHClaim ButtonZAUCTIONHOUSE_CLAIMSort ButtonsZAUCTIONHOUSE_CHANGE_SORTZAUCTIONHOUSE_HISTORY_SORTSell Inventory ButtonsZAUCTIONHOUSE_SELL_SHOW_ITEMZAUCTIONHOUSE_SELL_PRICEZAUCTIONHOUSE_SELL_ECONOMYZAUCTIONHOUSE_SELL_CONFIRMZAUCTIONHOUSE_SELL_CANCELConfirmation ButtonsZAUCTIONHOUSE_CONFIRM_PURCHASEZAUCTIONHOUSE_CONFIRM_REMOVE_LISTEDZAUCTIONHOUSE_SHOWContainer Content ButtonsZAUCTIONHOUSE_SHULKER_OPENZAUCTIONHOUSE_SHULKER_CONTENTZAUCTIONHOUSE_SHULKER_INFOZAUCTIONHOUSE_SHULKER_NAVIGATIONBulk Item ButtonsZAUCTIONHOUSE_ITEM_CONTENTRemove All ButtonsZAUCTIONHOUSE_REMOVE_ALL_EXPIREDZAUCTIONHOUSE_REMOVE_ALL_SELLINGZAUCTIONHOUSE_REMOVE_ALL_PURCHASEDAdmin ButtonsNavigation ButtonsItem Display ButtonsFilter ButtonsZAUCTIONHOUSE_ADMIN_HISTORY_MAINZAUCTIONHOUSE_ADMIN_HISTORY_EXPIREDZAUCTIONHOUSE_ADMIN_HISTORY_PURCHASEDZAUCTIONHOUSE_ADMIN_HISTORY_SELLINGZAUCTIONHOUSE_ADMIN_HISTORY_LOGSZAUCTIONHOUSE_ADMIN_HISTORY_TRANSACTIONSZAUCTIONHOUSE_ADMIN_LOGS_FILTER_TYPEZAUCTIONHOUSE_ADMIN_LOGS_FILTER_DATEZAUCTIONHOUSE_ADMIN_TRANSACTIONS_FILTER_STATUSZAUCTIONHOUSE_ADMIN_TRANSACTIONS_FILTER_DATEzMenu Built-in Buttons
GroupeZ MCP

Documentation in your AI

MCP lets your AI search GroupeZ documentation and read current examples to help you configure your plugins.

Read-only · No documentation API key needed

1. Copy the server URL

Transport: HTTP (Streamable HTTP). Authentication: none. Your tool uses its own model and subscription limits.

  1. Open Plugins in ChatGPT on the web, then + → Add custom MCP server.
  2. Name it ‘GroupeZ Documentation’, paste the URL above and choose ‘No authentication’. Create and install the plugin.
  3. In a conversation, type @ and select the plugin before asking. If needed, enable search, get_page and list_pages in its settings.
Official setup guide

3. Ask a question

Use GroupeZ MCP to help me create a zMenu inventory. Search relevant pages, read the examples and cite your sources.
Other clients and troubleshooting

For clients using mcpServers, adapt this example to their format:

{
  "mcpServers": {
    "groupez-docs": {
      "url": ""
    }
  }
}

Available tools are search, get_page and list_pages. Refresh the connector’s tools after updates. If your AI cannot access them, check that the connector is enabled in the conversation and your account allows custom MCP servers. Opening the URL in a browser is not an MCP test.