Economies Configuration

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

Plugin	Type	Supports `currency-name`
Vault	`VAULT`	No
PlayerPoints	`PLAYERPOINTS`	No
BeastTokens	`BEASTTOKENS`	No
ElementalTokens	`ELEMENTALTOKENS`	No
ElementalGems	`ELEMENTALGEMS`	No
CoinsEngine	`COINSENGINE`	Yes
VotingPlugin	`VOTINGPLUGIN`	No
RedisEconomy	`REDISECONOMY`	Yes
RoyaleEconomy	`ROYALEECONOMY`	No
EcoBits	`ECOBITS`	Yes
zEssentials	`ZESSENTIALS`	Yes
zMenu	`ZMENUITEMS`	No
Item (Vanilla)	`ITEM`	No (uses `item` config)
Level (Vanilla)	`LEVEL`	No
Experience (Vanilla)	`EXPERIENCE`	No

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, PRICE_WITHOUT_DECIMAL, PRICE_WITH_REDUCTION
    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

Type	Description
`SELL`	Tax paid by seller when listing
`PURCHASE`	Tax deducted from seller's earnings on sale
`BOTH`	Tax at both listing AND sale
`CAPITALISM`	VAT-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

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

Plugin	Type	Currency Configuration
zEssentials	`ZESSENTIALS`	Uses currency name from zEssentials economy module
EcoBits	`ECOBITS`	Uses EcoBits currency identifier
CoinsEngine	`COINSENGINE`	Uses CoinsEngine currency name
RedisEconomy	`REDISECONOMY`	Uses RedisEconomy 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

CurrenciesAPI​

Supported Economy Types​

Vault Economy​

Tax Types​

Tax Examples​

Item-Specific Tax Rules​

Default Economy​

Price Formatting​

Decimal Format​

Price Reductions (Compact Display)​

Multiple Economies Setup​

Item Economy​

Item Configuration​

Currency Name Economy​

Supported Plugins with Multiple Currencies​

Example: Multiple Currencies from Same Plugin​

Permission-Based Access​

Full Example​