GroupeZ Docs

Placeholders

All placeholders available in zAuctionHouse V4

zAuctionHouse V4 provides placeholders for use in messages, lore, and with PlaceholderAPI.

Requirements

For PlaceholderAPI placeholders, you need PlaceholderAPI installed on your server.

Internal Placeholders

These placeholders are used within zAuctionHouse configuration files (item lore, messages, etc.):

Item Display Placeholders

Used in item-lore section of config.yml:

PlaceholderDescription
%seller%Name of the player who listed the item
%buyer%Name of the player who bought the item
%price%Formatted price of the item
%price-price-raw%Raw price value
%price-price-with-decimal-format%Price with decimal formatting (e.g. 10 000)
%price-price-without-decimal%Price without decimals (e.g. 10000)
%price-price-with-reduction%Price with reduction (e.g. 10.0k)
%time-remaining%Time until the listing expires
%formatted-expire-date%Formatted expiration date
%date%Transaction date
%status%Dynamic action message (buy/retrieve)
%item_count%Total item count in the listing
%economy-name%Economy internal name
%economy-display-name%Economy display name
%items%Item display names
%type%Log entry type
%player%Player involved in the action
%target%Target player (admin operations)

Performance

Only the placeholders actually used in your lore templates are computed at render time. The plugin pre-detects which placeholders each lore section references when the configuration is loaded.

Inventory Placeholders

Used in inventory files:

PlaceholderDescription
%page%Current page number
%max-page%Total number of pages
%zauctionhouse_category_name%Current category name
%expired-items%Number of expired items
%purchased-items%Number of purchased items
%selling-items%Number of items on sale
%s%Pluralization suffix ("" for 1, "s" for 2+)

Message Placeholders

Used in messages.yml:

PlaceholderDescriptionUsed In
%version%Current plugin versionVersion messages
%latest%Latest available versionVersion messages
%syntax%Command syntaxError messages
%inventory-name%Missing inventory nameError messages
%name%Economy nameEconomy messages
%items%Item descriptionTransaction messages
%tax%Tax amountTax messages
%percentage%Tax percentageTax messages
%max-price%Maximum allowed pricePrice error
%min-price%Minimum required pricePrice error
%max-items%Maximum items allowedLimit error
%amount%Amount valueClaim messages
%economy%Economy nameClaim messages
%count%Count of itemsNotification messages
%total%Total valueNotification messages
%key%Cache key nameAdmin cache
%value%Cache valueAdmin cache
%source%Migration sourceMigration messages
%details%Migration detailsMigration messages
%progress%Migration progressMigration messages
%players%Migrated players countMigration messages
%transactions%Transaction countMigration messages
%errors%Error countMigration messages
%duration%Operation duration (ms)Migration messages
%current%Current progressGenerate messages
%time%Time taken (ms)Generate messages

Item Format Placeholders

Used in item-display section:

PlaceholderDescription
%amount%Item quantity
%item-translation-key%Minecraft language key
%item-name%Custom item name

Sell Inventory Placeholders

Used in sell inventory buttons:

PlaceholderDescription
%price%Current listing price
%economy%Display name of selected economy
%economy_name%Internal name of selected economy
%item_count%Number of items being sold
%selected%ZAUCTIONHOUSE_SELL_ECONOMY only: true when the button's economy is the selected one
%left_click_amount%Price adjustment on left click
%right_click_amount%Price adjustment on right click
%shift_left_click_amount%Price adjustment on shift+left click
%shift_right_click_amount%Price adjustment on shift+right click

Shulker Placeholders

Used in shulker content buttons:

PlaceholderDescription
%shulker_current%Current shulker number (1-based)
%shulker_total%Total number of shulkers

Sell Command Placeholders

PlaceholderDescription
%max-stack-size%Item's maximum stack size

PlaceholderAPI Placeholders

All PlaceholderAPI placeholders use the prefix zauctionhouse_:

Global Placeholders

PlaceholderDescription
%zauctionhouse_listed_items%Total number of items currently listed
%zauctionhouse_category_count_<category>%Number of items in a specific category (e.g., %zauctionhouse_category_count_weapons%)

Player Placeholders

PlaceholderDescription
%zauctionhouse_expired_items%Number of expired items for the player
%zauctionhouse_selling_items%Number of items the player is currently selling
%zauctionhouse_purchased_items%Number of purchased items for the player
%zauctionhouse_sorting_value%Current sort type value (e.g., DECREASING_DATE)
%zauctionhouse_sorting_name%Current sort type display name
%zauctionhouse_category_name%Current category display name
%zauctionhouse_category_id%Current category ID (defaults to main)
%zauctionhouse_pending_money%Total pending money (formatted with currency)
%zauctionhouse_pending_money_raw%Total pending money (raw number)
%zauctionhouse_pending_money_<economy>%Pending money for a specific economy (e.g., %zauctionhouse_pending_money_coins%)
%zauctionhouse_has_pending_money%true or false whether the player has pending money
%zauctionhouse_option_<option>%Player option value (true/false), e.g., %zauctionhouse_option_broadcast_sell%
%zauctionhouse_sell_price%Price of the sale in progress in the sell inventory (raw number)
%zauctionhouse_sell_price_formatted%Price of the sale in progress, formatted with the selected economy
%zauctionhouse_sell_economy%Display name of the economy selected for the sale in progress
%zauctionhouse_sell_economy_name%Internal name of the economy selected for the sale in progress
%zauctionhouse_sell_amount%Amount requested with /ah sell (0 = the whole stack held in hand)

Discord Webhook Placeholders

Used in discord.yml webhook configuration:

Item Placeholders

PlaceholderDescription
%item_id%Internal item ID
%item_material%Material name (lowercase)
%item_display%Item display name with formatting
%item_amount%Stack size
%item_lore%Item lore
%item_enchantments%List of enchantments
%item_custom_model_data%CustomModelData value
%item_dominant_color%Extracted dominant color
%item_image_url%URL to item image

Player Placeholders

PlaceholderDescription
%seller_name%Seller's username
%seller_uuid%Seller's UUID
%buyer_name%Buyer's username (purchase only)
%buyer_uuid%Buyer's UUID (purchase only)

Price Placeholders

PlaceholderDescription
%price%Raw price number
%formatted_price%Price with economy formatting
%economy_name%Economy internal name
%economy_display_name%Economy display name

Time Placeholders

PlaceholderDescription
%created_at%When listing was created
%expires_at%When the listing expires — output as a Discord dynamic timestamp (<t:unix_seconds:f>), rendered in each viewer's local timezone
%remaining_time%Time until expiration
%timestamp%Current timestamp

Server Placeholders

PlaceholderDescription
%server_name%Server name (from config)

Category Placeholders

PlaceholderDescription
%category_names%Comma-separated category names
%category_count%Number of matching categories

Usage Examples

Inventory Lore

# In inventories/auction.yml
item:
  material: BELL
  name: "#2CCED2Auction Information"
  lore:
    - "#92ffffNumber of items: #2CCED2%zauctionhouse_listed_items%"
    - "#92ffffSort type: #2CCED2%zauctionhouse_sorting_name%"
    - ""
    - "#8c8c8c• #2CCED2Click to refresh"

Item Lore in Config

# In config.yml
item-lore:
  listed-auction-item:
    - ""
    - "<white>⌂ #92ffffSeller#8c8c8c: #2CCED2%seller%"
    - "<white>☆ #92ffffPrice#8c8c8c: #2CCED2%price%"
    - "<white>⌚ #92ffffExpire#8c8c8c: #969696%time-remaining%"
    - ""
    - "%status%"

Discord Webhook

# In discord.yml
embed:
  title: "New Item Listed!"
  description: "**%seller_name%** has listed an item for sale"
  fields:
    - name: "Item"
      value: "%item_display%"
      inline: true
    - name: "Price"
      value: "%formatted_price%"
      inline: true

Custom Messages

# In messages.yml
item-sold: "#e6fff3You just sold %items% #e6fff3for #92bed8%price%#e6fff3."

item-bought-seller: "#ffacd5%buyer% #e6fff3just bought %items% #e6fff3for #92bed8%price%#e6fff3."

sales-notification:
  - "<click:run_command:/ah history>#e6fff3While you were away, %count% of your items were sold for a total of %total%!"
  - "<click:run_command:/ah history>#8c8c8c• #2CCED2Click here to view your sales history</click>"

Color Formatting

zAuctionHouse V4 supports:

  • MiniMessage format: <red>, <bold>, <gradient:red:blue>
  • Hex colors: #RRGGBB or #RGB
  • Legacy codes: &c, &l, etc. (MiniMessage recommended)
  • Custom shortcuts: <primary>, <secondary>, <error>, <success> (defined in config.yml)
# Example using custom shortcuts
message: "<primary>Welcome <secondary>to the auction house!"
# Becomes: "#24d65d Welcome #656665 to the auction house!"

Commands & Permissions

Complete list of commands and permissions for zAuctionHouse V4

Multi Server

Connect multiple servers with zAuctionHouse Redis addon

On this page

RequirementsInternal PlaceholdersItem Display PlaceholdersInventory PlaceholdersMessage PlaceholdersItem Format PlaceholdersSell Inventory PlaceholdersShulker PlaceholdersSell Command PlaceholdersPlaceholderAPI PlaceholdersGlobal PlaceholdersPlayer PlaceholdersDiscord Webhook PlaceholdersItem PlaceholdersPlayer PlaceholdersPrice PlaceholdersTime PlaceholdersServer PlaceholdersCategory PlaceholdersUsage ExamplesInventory LoreItem Lore in ConfigDiscord WebhookCustom MessagesColor Formatting
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.