⏹️Buttons

zAuctionHouse Button

zAuctionHouse uses the zMenu API, so you have all the features of zMenu available from. Documentation: https://docs.zmenu.dev/configurations/buttons

We advise you to look at the zMenu documentation to better understand how the configurations work.

To configure the items, go to this page: https://docs.zmenu.dev/configurations/items

In this page you will find all the buttons that zAuctionHouse adds in zMenu.

Attention, if you have the slightest doubt on how to use one of the buttons, please look at the default configuration. If doubt persists please contact us at discord.

---

Auction list

For its buttons you have to specify a list of slots mandatory.

ZAUCTIONHOUSE_AUCTION

Displays the list of items that are currently on sale..

ZAUCTIONHOUSE_EXPIRE

Displays the list of items that have expired for the player.

ZAUCTIONHOUSE_ITEMS

Displays the list of items the player currently has for sale.

ZAUCTIONHOUSE_BUYING

Displays the list of items the player has purchased.

ZAUCTIONHOUSE_SEARCH

Displays the list of items the player requested based on the search filter.

ZAUCTIONHOUSE_CATEGORY

Displays the list of items in the category that the player uses.

ZAUCTIONHOUSE_EXPIRE_AND_BUYING

Allows to display in a single inventory items expired or purchased

ZAUCTIONHOUSE_EXPIRE_AND_BUYING_AND_ITEMS

Allows to display in a single inventory the items bought, expired and on sale.

---

Categories

ZAUCTIONHOUSE_CATEGORY

Open a category, you must specify the name of the catégory in the configuration.

type: ZAUCTIONHOUSE_CATEGORY
category: <category name>

ZAUCTIONHOUSE_CATEGORIES_LORE

Allows categories to be displayed on a single button. This configuration uses button type:

zAuctionHouse - Mc-Complex AuctionHouseBuiltByBit

You must use this button there in the inventory file category.yml

Example:

categories:
  isPermanent: true
  type: ZAUCTIONHOUSE_CATEGORIES_LORE
  categories:
    - 'home'
    - 'blocks'
    - 'potions'
    - 'tools'
    - 'weapons'
    - 'misc'
  enableText: '&a➜ %category%'
  disableText: '&7➜ %category%'
  slot: 47
  item:
    material: CLOCK
    name: '&bCategory: &f%category%'
    lore:
      - ''
      - '&7➜ All Categories'
      - '%blocks%'
      - '%potions%'
      - '%tools%'
      - '%weapons%'
      - '%misc%'
      - ''
      - '&bClick &fto cycle.'

The placeholder %category% allows to display the current category.

ZAUCTIONHOUSE_CATEGORIES_HOME

Allows categories to be displayed on a single button. This configuration uses button type:

zAuctionHouse - Mc-Complex AuctionHouseBuiltByBit

You must use this button there in the inventory file auction.yml

Example

categories:
  isPermanent: true
  type: ZAUCTIONHOUSE_CATEGORIES_HOME
  categories:
    - 'home'
    - 'blocks'
    - 'potions'
    - 'tools'
    - 'weapons'
    - 'misc'
  slot: 47
  item:
    material: CLOCK
    name: '&bCategory: &fAll Categories'
    lore:
      - ''
      - '&a➜ All Categories'
      - '&7➜ Blocks'
      - '&7➜ Potions'
      - '&7➜ Tools'
      - '&7➜ Weapons'
      - '&7➜ Miscellaneous'
      - ''
      - '&bClick &fto cycle.'

---

Remove All

ZAUCTIONHOUSE_REMOVE_ALL_ITEMS

Allows to recover the items that the player has put on sale.

ZAUCTIONHOUSE_REMOVE_ALL_BUYING

Retrieves items that the player has purchased.

ZAUCTIONHOUSE_REMOVE_ALL_EXPIRE

Allows you to retrieve player items that have expired.

---

Show

ZAUCTIONHOUSE_SHOW_REMOVE

Displays the item that the player will remove in the inventory removeConfirm.yml

ZAUCTIONHOUSE_SHOW_BUY

Displays the item that the player will purchase in the inventory buyConfirm.yml

ZAUCTIONHOUSE_SHOW_ADMIN

Displays the item that the player will remove in the inventory adminRemove.yml

---

ZAUCTIONHOUSE_CLAIM

Retrieves the money, does the same as the /ah claim command.

You can use the refresh-placeholder: true option to automatically update the item. If you have a storage in SQLITE, SQL or REDIS, the placeholder will be displayed "Loading", this option allows to update the item and avoid having the loading

---

Sell Inventory

ZAUCTIONHOUSE_SELL_INVENTORY_ACCEPT

Allows the player to sell items at once.

ZAUCTIONHOUSE_SELL_INVENTORY_SLOT

List of slots where the player will be able to place items.

---

ZAUCTIONHOUSE_CHANGE_SORT

Change the sort type for the player.

---

ZAUCTIONHOUSE_CHANGE_SORTING

Change the way categories are sorted.

• Right click to advance in the list

• Left click to go back

  change-sort:
    isPermanent: true
    type: ZAUCTIONHOUSE_CHANGE_SORTING
    sorting:
      - sorting: DECREASING_DATE
        display: "ᴅᴇᴄʀᴇᴀsɪɴɢ ᴅᴀᴛᴇ"
      - sorting: DECREASING_PRICE
        display: "ᴅᴇᴄʀᴇᴀsɪɴɢ ᴘʀɪᴄᴇ"
      - sorting: ASCENDING_DATE
        display: "ᴀsᴄᴇɴᴅɪɴɢ ᴅᴀᴛᴇ"
      - sorting: ASCENDING_PRICE
        display: "ᴀsᴄᴇɴᴅɪɴɢ ᴘʀɪᴄᴇ"
      - sorting: ALPHABETICAL_NAME
        display: "ᴀʟᴘʜᴀʙᴇᴛɪᴄᴀʟ ɴᴀᴍᴇ"
      - sorting: REVERSE_ALPHABETICAL_NAME
        display: "ʀᴇᴠᴇʀsᴇ ᴀʟᴘʜᴀʙᴇᴛɪᴄᴀʟ ɴᴀᴍᴇ"
      - sorting: SELLER_NAME_ALPHABETICAL
        display: "sᴇʟʟᴇʀ ɴᴀᴍᴇ ᴀʟᴘʜᴀʙᴇᴛɪᴄᴀʟ"
      - sorting: SELLER_NAME_REVERSE_ALPHABETICAL
        display: "sᴇʟʟᴇʀ ɴᴀᴍᴇ ʀᴇᴠᴇʀsᴇ ᴀʟᴘʜᴀʙᴇᴛɪᴄᴀʟ"
      - sorting: MATERIAL_TYPE_ALPHABETICAL
        display: "ᴍᴀᴛᴇʀɪᴀʟ ᴛʏᴘᴇ ᴀʟᴘʜᴀʙᴇᴛɪᴄᴀʟ"
      - sorting: MATERIAL_TYPE_REVERSE_ALPHABETICAL
        display: "ᴍᴀᴛᴇʀɪᴀʟ ᴛʏᴘᴇ ʀᴇᴠᴇʀsᴇ ᴀʟᴘʜᴀʙᴇᴛɪᴄᴀʟ"
      - sorting: ITEM_STACK_SIZE_ASCENDING
        display: "ɪᴛᴇᴍ sᴛᴀᴄᴋ sɪᴢᴇ ᴀsᴄᴇɴᴅɪɴɢ"
      - sorting: ITEM_STACK_SIZE_DESCENDING
        display: "ɪᴛᴇᴍ sᴛᴀᴄᴋ sɪᴢᴇ ᴅᴇsᴄᴇɴᴅɪɴɢ"
    enableText: ' #e6fff3➜ %sorting%'
    disableText: ' #8c8c8c➜ %sorting%'
    slot: 49
    item:
      url: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZGIyZWRlYjAxY2RjZTFkMTM1MWQ5YmY3ZmI3NTNiNmY1NzNhNTZiODY0NzcyOTlhNTEwMzNjYWFjODkzOTQwOCJ9fX0="
      name: ""
      lore:
        - "                #92bed8sᴏʀᴛ ᴛʏᴘᴇ"
        - "                    #8c8c8c&m     "
        - ""
        - "%DECREASING_DATE%"
        - "%DECREASING_PRICE%"
        - "%ASCENDING_DATE%"
        - "%ASCENDING_PRICE%"
        - "%ALPHABETICAL_NAME%"
        - "%REVERSE_ALPHABETICAL_NAME%"
        - "%SELLER_NAME_ALPHABETICAL%"
        - "%SELLER_NAME_REVERSE_ALPHABETICAL%"
        - "%MATERIAL_TYPE_ALPHABETICAL%"
        - "%MATERIAL_TYPE_REVERSE_ALPHABETICAL%"
        - "%ITEM_STACK_SIZE_ASCENDING%"
        - "%ITEM_STACK_SIZE_DESCENDING%"
        - ""
        - " #8c8c8c• #92bed8ᴄʟɪᴄᴋ #e6fff3ᴛᴏ ᴄʜᴀɴɢᴇ ᴛʜᴇ sᴏʀᴛ ᴛʏᴘᴇ #8c8c8c• "

You can change the order or remove element in sorting.

Sorting Types

Enum Value	Description
DECREASING_DATE	Sorts items by their expiration date in descending order (latest date first).
DECREASING_PRICE	Sorts items by their price in descending order (highest price first).
ASCENDING_DATE	Sorts items by their expiration date in ascending order (earliest date first).
ASCENDING_PRICE	Sorts items by their price in ascending order (lowest price first).
ALPHABETICAL_NAME	Sorts items alphabetically by their name in ascending order (A-Z).
REVERSE_ALPHABETICAL_NAME	Sorts items alphabetically by their name in descending order (Z-A).
SELLER_NAME_ALPHABETICAL	Sorts items alphabetically by the seller's name in ascending order (A-Z).
SELLER_NAME_REVERSE_ALPHABETICAL	Sorts items alphabetically by the seller's name in descending order (Z-A).
MATERIAL_TYPE_ALPHABETICAL	Sorts items alphabetically by their material type in ascending order (A-Z).
MATERIAL_TYPE_REVERSE_ALPHABETICAL	Sorts items alphabetically by their material type in descending order (Z-A).
ECONOMY_NAME_ALPHABETICAL	Sorts items alphabetically by the associated economy name in ascending order (A-Z).
ECONOMY_NAME_REVERSE_ALPHABETICAL	Sorts items alphabetically by the associated economy name in descending order (Z-A).
ITEM_STACK_SIZE_ASCENDING	Sorts items by their stack size in ascending order (smallest stack first).
ITEM_STACK_SIZE_DESCENDING	Sorts items by their stack size in descending order (largest stack first).

---

ZAUCTIONHOUSE_SHOW_ITEMS

Displays items from an inventory, shulker box or barrel. Is used in sellshow.yml inventory.

---

ZAUCTIONHOUSE_BUY_CONFIRM

Allows to confirm the purchase of an item.

Placeholders:

• %price% - Show price of item

• %seller% - Show seller name

• %timer% - Display the item expiration time

• %money-after-purchase% - Displays the player’s money after purchasing the item

---

ZAUCTIONHOUSE_SHOW_SELLER

Allows to display the head of the player who sells an item, must be used in the inventory buyconfirm.yml

You must do this to add the item in your configuration:

seller:
  type: ZAUCTIONHOUSE_SHOW_SELLER
  slot: 4
  item:
    material: PLAYER_HEAD 
    name: "&f%sellerName%"
    lore:
      - "&8This item is sold by %sellerName%"

---

ZAUCTIONHOUSE_UPDATE

Updates the list of items for sale.

---

ZAUCTIONHOUSE_ADMIN_REMOVE

Remove an item from the sale with several options.

type: ZAUCTIONHOUSE_ADMIN_REMOVE
isSilent: <boolean> # If the player will receive a message
isForceRemove: <boolean> # If the item will be completely removed and not given back to the player.

---

Remove Confirm

ZAUCTIONHOUSE_REMOVE_CONFIRM

Allows to remove an item.

ZAUCTIONHOUSE_REMOVE_CONFIRM_ADMIN

Allows to remove an item as an administrator.

ZAUCTIONHOUSE_ECONOMY

When you have enabled the option for sale configuration inventory, you must use this button to set the economy used when selling the item.

You must define the name of the economy as follows:

type: ZAUCTIONHOUSE_ECONOMY
economy: "vault" # Economy name, use the same that is present in economies.yml

ZAUCTIONHOUSE_SEARCH_INPUT

Opens a search menu. If you have the option search.enable-search-with-protocol-lib enabled and if you have ProtocolLib, the search is done in a sign, otherwise the search will be in the chat.