GroupeZ Docs
Inventories

Auction

Main auction house inventory configuration

The main auction house inventory displays all items currently listed for sale. Players access it via /ah command.

File: plugins/zAuctionHouse/inventories/auction.yml

Description
DescriptionDescription

Preview

The auction inventory includes:

  • Item display area (36 slots)
  • Category selection button
  • Expired items button
  • Purchased items button
  • Your items (selling) button
  • Search button
  • Clear search button
  • Pagination buttons
  • Sort button
  • Information button

Default Configuration

name: "%zauctionhouse_category_name% (%page%/%max-page%)"
size: 54

patterns:
  - 'zauctionhouse-decoration'

items:

  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'

  categories:
    slot: 4
    type: inventory
    plugin: "zAuctionHouse"
    inventory: "categories"
    is-permanent: true
    item:
      material: CHEST
      name: "#2CCED2<bold>ᴄᴀᴛᴇɢᴏʀɪᴇs"
      lore:
        - ""
        - "#8c8c8c• #2CCED2Click #92ffffto open"

  expired-items:
    type: ZAUCTIONHOUSE_EXPIRED_INVENTORY
    slot: 45
    item:
      url: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZjdhYWRmZjlkZGM1NDZmZGNlYzZlZDU5MTljYzM5ZGZhOGQwYzA3ZmY0YmM2MTNhMTlmMmU2ZDdmMjU5MyJ9fX0="
      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: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZjdhYWRmZjlkZGM1NDZmZGNlYzZlZDU5MTljYzM5ZGZhOGQwYzA3ZmY0YmM2MTNhMTlmMmU2ZDdmMjU5MyJ9fX0="
        name: "#2CCED2<bold>ᴇxᴘɪʀᴇᴅ ɪᴛᴇᴍs"
        lore:
          - "#ff3535You have no expired items."

  purchased-items:
    type: ZAUCTIONHOUSE_PURCHASED_INVENTORY
    slot: 46
    item:
      url: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZjM3Y2FlNWM1MWViMTU1OGVhODI4ZjU4ZTBkZmY4ZTZiN2IwYjFhMTgzZDczN2VlY2Y3MTQ2NjE3NjEifX19"
      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: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZjM3Y2FlNWM1MWViMTU1OGVhODI4ZjU4ZTBkZmY4ZTZiN2IwYjFhMTgzZDczN2VlY2Y3MTQ2NjE3NjEifX19"
        name: "#2CCED2<bold>ᴘᴜʀᴄʜᴀsᴇᴅ ɪᴛᴇᴍs"
        lore:
          - "#ff3535You have no purchased items."

  selling-items:
    type: ZAUCTIONHOUSE_SELLING_INVENTORY
    slot: 53
    item:
      url: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMjU4MDdjYzRjM2I2OTU4YWVhNjE1NmU4NDUxOGQ5MWE0OWM1ZjMyOTcxZTZlYjI2OWEyM2EyNWEyNzE0NSJ9fX0="
      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: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMjU4MDdjYzRjM2I2OTU4YWVhNjE1NmU4NDUxOGQ5MWE0OWM1ZjMyOTcxZTZlYjI2OWEyM2EyNWEyNzE0NSJ9fX0="
        name: "#2CCED2<bold>ʏᴏᴜʀ ɪᴛᴇᴍs"
        lore:
          - "#ff3535You have no items for sale."

  previous:
    is-permanent: true
    type: PREVIOUS
    slot: 48
    item:
      url: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNjllYTFkODYyNDdmNGFmMzUxZWQxODY2YmNhNmEzMDQwYTA2YzY4MTc3Yzc4ZTQyMzE2YTEwOThlNjBmYjdkMyJ9fX0="
      name: "#2CCED2<bold>ᴘʀᴇᴠɪᴏᴜs ᴘᴀɢᴇ"
      lore:
        - "#92ffffGo to the previous page."
        - ""
        - "#8c8c8c• #2CCED2Click #92ffffto open"
    else:
      item:
        material: LIGHT_BLUE_STAINED_GLASS_PANE
        name: "<white>"

  next:
    is-permanent: true
    type: NEXT
    slot: 50
    item:
      url: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvODI3MWE0NzEwNDQ5NWUzNTdjM2U4ZTgwZjUxMWE5ZjEwMmIwNzAwY2E5Yjg4ZTg4Yjc5NWQzM2ZmMjAxMDVlYiJ9fX0="
      name: "#2CCED2<bold>ɴᴇxᴛ ᴘᴀɢᴇ"
      lore:
        - "#92ffffGo to the next page."
        - ""
        - "#8c8c8c• #2CCED2Click #92ffffto open"
    else:
      item:
        material: LIGHT_BLUE_STAINED_GLASS_PANE
        name: "<white>"

  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"

  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"

  informations:
    slot: 49
    is-permanent: true
    item:
      material: BELL
      name: "#2CCED2<bold>ᴀᴜᴄᴛɪᴏɴ ɪɴғᴏʀᴍᴀᴛɪᴏɴ"
      lore:
        - "#92ffffWelcome to the auction house."
        - "#92ffffTrade items with other players."
        - ""
        - "#92ffffUsage#8c8c8c:"
        - "#2CCED2/ah sell #92ffff<price> [<amount>]"
        - ""
        - "#92ffffNumber of items#8c8c8c: #2CCED2%zauctionhouse_listed_items%"
        - "#92ffffSort type#8c8c8c: #2CCED2%zauctionhouse_sorting_name%"
        - ""
        - "#8c8c8c• #2CCED2Click #92ffffto refresh the items"

  change-sort:
    type: ZAUCTIONHOUSE_CHANGE_SORT
    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"
    slot: 52
    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"

Buttons Used

ButtonTypeDescription
displayItemsZAUCTIONHOUSE_LISTED_ITEMSDisplays auction items
categoriesinventoryOpens categories menu
expired-itemsZAUCTIONHOUSE_EXPIRED_INVENTORYOpens expired items
purchased-itemsZAUCTIONHOUSE_PURCHASED_INVENTORYOpens purchased items
selling-itemsZAUCTIONHOUSE_SELLING_INVENTORYOpens selling items
previousPREVIOUSPrevious page
nextNEXTNext page
searchZAUCTIONHOUSE_SEARCHSearch items
clear-searchZAUCTIONHOUSE_CLEAR_SEARCHClear active search
informations(static)Information display
change-sortZAUCTIONHOUSE_CHANGE_SORTSort selector

Admin Removal

Players with the zauctionhouse.admin.remove.inventory permission can press Q (drop) or middle click on a listing to open the admin removal confirmation. From there, they choose whether the seller is notified, whether the item goes to the seller's expired items and whether they receive a copy, then confirm the removal.

This only works on listings currently on sale. While the confirmation is open, the listing is reserved: it disappears from the other players' auction house (on every server of the cluster) and can no longer be bought or removed by its seller. Closing the inventory or clicking Cancel makes it available again.

For these players, the Q / middle click is checked before the container preview: if action.container-preview.click is set to DROP or MIDDLE, admins open the removal confirmation instead of the preview. It also takes precedence over the purchase and removal of their own listings.

Placeholders

PlaceholderDescription
%page%Current page number
%max-page%Total number of pages
%zauctionhouse_category_name%Current category name
%zauctionhouse_listed_items%Total items listed
%zauctionhouse_sorting_name%Current sort type name
%expired-items%Player's expired item count
%purchased-items%Player's purchased item count
%selling-items%Player's selling item count
%s%Pluralization suffix
%search_query%Current search query
%search_active%Whether a search is active

Buttons

All available button types for zAuctionHouse inventories

Categories

Category selection inventory configuration

On this page

PreviewDefault ConfigurationButtons UsedAdmin RemovalPlaceholders
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.