GroupeZ Docs
Configuration

Economies

Configure economy systems in zAuctionHouse V4

zAuctionHouse V4 supports multiple economy systems configured in economies.yml.

CurrenciesAPI

zAuctionHouse uses CurrenciesAPI to handle all economy integrations. This library provides a unified interface for interacting with various economy plugins.

Supported Economy Types

PluginTypeSupports currency-name
VaultVAULTNo
PlayerPointsPLAYERPOINTSNo
BeastTokensBEASTTOKENSNo
ElementalTokensELEMENTALTOKENSNo
ElementalGemsELEMENTALGEMSNo
CoinsEngineCOINSENGINEYes
ExcellentEconomyEXCELLENTECONOMYYes
VotingPluginVOTINGPLUGINNo
RedisEconomyREDISECONOMYYes
RoyaleEconomyROYALEECONOMYNo
EcoBitsECOBITSYes
zEssentialsZESSENTIALSYes
zMenuZMENUITEMSNo
Item (Vanilla)ITEMNo (uses item config)
Level (Vanilla)LEVELNo
Experience (Vanilla)EXPERIENCENo

You can also use REDIRECT to alias one economy to another.

Vault Economy

The most common economy integration:

economies:
  - type: VAULT
    is-enable: true
    name: vault
    display-name: "Vault"
    format: "%price%$"
    symbol: "v"

    # Auto-deposit money to seller immediately
    auto-claim: true

    # Only deposit when seller is online
    must-be-online: false

    # Optional permission to use this economy
    # permission: "zauctionhouse.economy.vault"

    # Economy transaction reasons
    withdraw-reason: "Purchase of %items% (zAuctionHouse)"
    deposit-reason: "Sale of %items% (zAuctionHouse)"

    # Price formatting mode
    # PRICE_WITH_DECIMAL_FORMAT : Uses the 'price-decimal-format' setting
    # PRICE_WITHOUT_DECIMAL     : No decimal places, whole numbers only (e.g., 10000.50 -> 10000)
    # PRICE_WITH_REDUCTION      : Uses the 'price-reductions' settings
    price-format: PRICE_WITH_DECIMAL_FORMAT

    # Price limits
    min-prices:
      auction: 10
      rent: 500
      bid: 500
    max-prices: 10000000000  # 10 billion

    # Tax configuration
    tax:
      enabled: false
      type: SELL
      amount-type: PERCENTAGE
      amount: 5
      bypass-permission: "zauctionhouse.tax.bypass"
      reductions:
        - permission: "zauctionhouse.tax.vip"
          percentage: 50
        - permission: "zauctionhouse.tax.premium"
          percentage: 25
        - permission: "zauctionhouse.tax.member"
          percentage: 10

Tax Types

TypeDescription
SELLTax paid by seller when listing
PURCHASETax deducted from seller's earnings on sale
BOTHTax at both listing AND sale
CAPITALISMVAT-style, buyer pays extra

Tax Examples

SELL Tax:

  • List 1000$ item with 5% tax
  • Seller pays 50$ listing fee upfront
  • Buyer pays 1000$, Seller receives 1000$

PURCHASE Tax:

  • Item sells for 1000$ with 5% tax
  • Buyer pays 1000$, Seller receives 950$

CAPITALISM Tax (VAT):

  • Item listed for 1000$ with 5% VAT
  • Buyer pays 1050$, Seller receives 1000$

Item-Specific Tax Rules

Apply different tax rates for specific items:

tax:
  item-rules:
    enabled: true
    rules:
      - name: "diamond_tax"
        priority: 100
        type: PURCHASE
        amount-type: PERCENTAGE
        amount: 10
        rule:
          type: material
          materials:
            - DIAMOND
            - DIAMOND_BLOCK

      - name: "rare_items"
        priority: 90
        type: CAPITALISM
        amount-type: PERCENTAGE
        amount: 15
        rule:
          type: and
          rules:
            - type: lore
              mode: CONTAINS
              values:
                - "Rare"

Default Economy

Set which economy is used by default:

default-economy:
  auction: vault
  rent: vault
  bid: vault

Price Formatting

The price-format option controls how prices are displayed. Available modes:

ModeDescriptionExample
PRICE_WITH_DECIMAL_FORMATUses the price-decimal-format pattern10000.5 -> 10,000.5
PRICE_WITHOUT_DECIMALRemoves decimals, whole numbers only10000.5 -> 10000
PRICE_WITH_REDUCTIONCompact display with suffixes10000 -> 10.0K

Decimal Format

# Java DecimalFormat pattern
price-decimal-format: '#,###.#'

Examples:

  • #,###.# -> "1,234.5"
  • #,###.## -> "1,234.56"
  • #,### -> "1,234"

Price Reductions (Compact Display)

When using PRICE_WITH_REDUCTION:

price-reductions:
  # 0 - 999: Show as-is
  - format: "#.#"
    max-amount: 1000

  # 1K - 999K
  - format: "%.1fK"
    max-amount: 1000000

  # 1M - 999M
  - format: "%.1fM"
    max-amount: 1000000000

  # 1B - 999B
  - format: "%.1fB"
    max-amount: 1000000000000

  # 1T+ with custom color
  - format: "%.2fT"
    max-amount: 1000000000000000
    display: "<green>%amount%"

  # Quadrillions with custom color
  - format: "%.2fQ"
    max-amount: 100000000000000000
    display: "<red>%amount%"

Multiple Economies Setup

You can have multiple economies active simultaneously:

economies:
  - type: VAULT
    is-enable: true
    name: vault
    # ...

  - type: PLAYERPOINTS
    is-enable: true
    name: points
    # ...

  - type: ITEM
    is-enable: true
    name: diamonds
    # ...

Players choose which economy to use when listing:

/ah sell 1000 64 vault
/ah sell 500 32 points
/ah sell 10 16 diamonds

Item Economy

Use a specific item as currency. Players pay with items from their inventory:

economies:
  - type: ITEM
    is-enable: true
    name: item
    display-name: "Diamonds"
    format: "%price%d"
    symbol: "d"

    # Define the currency item (supports all zMenu item properties)
    item:
      material: DIAMOND
      # Optional: require specific name
      # name: "&bCurrency Diamond"
      # Optional: require specific lore
      # lore:
      #   - "&7Official currency"
      # Optional: require custom model data
      # model-data: 1001

    # Auto-deposit items to seller immediately
    auto-claim: true

    # Transaction reasons
    withdraw-reason: "Purchase of %items% (zAuctionHouse)"
    deposit-reason: "Sale of %items% (zAuctionHouse)"

    # If true, seller must be online to receive items
    # If offline, they must use /ah claim to get their items
    must-be-online: true

    # Price formatting mode
    price-format: PRICE_WITH_REDUCTION

    # Price limits
    min-prices: 1
    max-prices: 64

Item Configuration

The item section supports all item properties available in zMenu:

item:
  material: DIAMOND
  name: "&b&lPremium Diamond"
  lore:
    - "&7Server currency"
    - "&7Cannot be dropped"
  model-data: 1001
  glow: true
  # ... any other zMenu item properties

This allows you to create custom currency items that must match specific criteria.

Currency Name Economy

For plugins that support multiple currencies (zEssentials, EcoBits, CoinsEngine, RedisEconomy), you can specify which currency to use:

economies:
  - type: ZESSENTIALS  # Also works with: ECOBITS, COINSENGINE, REDISECONOMY
    currency-name: "coins"  # The currency name from the plugin
    is-enable: true
    name: coins
    display-name: "Coins"
    format: "%price%c"
    symbol: "c"

    # Auto-deposit to seller immediately
    auto-claim: true

    # Player doesn't need to be online
    must-be-online: false

    # Transaction reasons
    withdraw-reason: "Purchase of %items% (zAuctionHouse)"
    deposit-reason: "Sale of %items% (zAuctionHouse)"

    # Price formatting mode
    price-format: PRICE_WITH_REDUCTION

    # Price limits
    min-prices: 1
    max-prices: 99999

Supported Plugins with Multiple Currencies

PluginTypeCurrency Configuration
zEssentialsZESSENTIALSUses currency name from zEssentials economy module
EcoBitsECOBITSUses EcoBits currency identifier
CoinsEngineCOINSENGINEUses CoinsEngine currency name
RedisEconomyREDISECONOMYUses RedisEconomy currency name
ExcellentEconomyEXCELLENTECONOMYUses ExcellentEconomy currency name

Example: Multiple Currencies from Same Plugin

economies:
  # zEssentials - Main coins
  - type: ZESSENTIALS
    currency-name: "coins"
    is-enable: true
    name: coins
    display-name: "Coins"
    format: "%price% coins"
    symbol: "c"
    auto-claim: true
    must-be-online: false
    price-format: PRICE_WITH_REDUCTION
    min-prices: 1
    max-prices: 999999

  # zEssentials - Premium gems
  - type: ZESSENTIALS
    currency-name: "gems"
    is-enable: true
    name: gems
    display-name: "Gems"
    format: "%price% gems"
    symbol: "g"
    auto-claim: true
    must-be-online: false
    price-format: PRICE_WITH_REDUCTION
    min-prices: 1
    max-prices: 10000

Permission-Based Access

Restrict economy access by permission:

  - type: VAULT
    is-enable: true
    name: premium_economy
    permission: "zauctionhouse.economy.premium"
    # ...

Only players with zauctionhouse.economy.premium can use this economy.

Full Example

Complete economies.yml:

economies:
  # Main Vault economy
  - type: VAULT
    is-enable: true
    name: vault
    display-name: "Money"
    format: "%price%$"
    symbol: "v"
    auto-claim: true
    must-be-online: false
    withdraw-reason: "Purchase of %items% (zAuctionHouse)"
    deposit-reason: "Sale of %items% (zAuctionHouse)"
    price-format: PRICE_WITH_DECIMAL_FORMAT
    min-prices:
      auction: 10
      rent: 500
      bid: 500
    max-prices: 10000000000
    tax:
      enabled: true
      type: SELL
      amount-type: PERCENTAGE
      amount: 5
      bypass-permission: "zauctionhouse.tax.bypass"
      reductions:
        - permission: "zauctionhouse.tax.vip"
          percentage: 50

  # Secondary points economy
  - type: PLAYERPOINTS
    is-enable: true
    name: points
    display-name: "Points"
    format: "%price% pts"
    symbol: "p"
    auto-claim: true
    min-prices:
      auction: 1
    max-prices: 1000000
    tax:
      enabled: false

default-economy:
  auction: vault
  rent: vault
  bid: vault

price-decimal-format: '#,###.#'

price-reductions:
  - format: "#.#"
    max-amount: 1000
  - format: "%.1fK"
    max-amount: 1000000
  - format: "%.1fM"
    max-amount: 1000000000
  - format: "%.1fB"
    max-amount: 1000000000000

Messages

Customize all messages in zAuctionHouse V4

Categories

Configure item categories in zAuctionHouse V4

On this page

CurrenciesAPISupported Economy TypesVault EconomyTax TypesTax ExamplesItem-Specific Tax RulesDefault EconomyPrice FormattingDecimal FormatPrice Reductions (Compact Display)Multiple Economies SetupItem EconomyItem ConfigurationCurrency Name EconomySupported Plugins with Multiple CurrenciesExample: Multiple Currencies from Same PluginPermission-Based AccessFull Example
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.