Configuration

Auction House has four files in plugins/AuctionHouse. Colors use &a, &l and &#RRGGBB. Apply changes with /ah reload. Storage and network changes need a full restart.

File	What’s in it
`config.yml`	License key, storage, network, listing rules, Quick Buy, the blacklist and number format.
`menus.yml`	Every menu title, size, slot, item, name and lore line, the sounds and the confirm, price and search screens.
`messages.yml`	Every message. Messages listed under `action-bar` also show above the hotbar. Leave one empty to not send it.
`slang.yml`	Short names for search. See Search & slang.

Listing rules

Key (auction)	Default	Meaning
`listing-duration-hours`	`24`	How long a listing stays before it expires.
`default-slots`	`18`	Listing slots every player has.
`max-slots`	`90`	Slots shown in Your Items. Also the most a permission can give.
`min-price`	`1`	Lowest allowed price.
`max-price`	`0`	Highest allowed price. 0 means no limit.
`sales-tax-percent`	`0`	Percent of every sale kept as tax (0-100).
`pay-offline-sellers`	`true`	Pay sellers who are offline right away.
`action-cooldown-ms`	`300`	Minimum time between two purchases or listings by the same player.
`transaction-history`	`450`	Most transactions kept per player.
`log-to-file`	`true`	Write every listing, purchase, cancel and expiry to `logs/`.

Storage

Key (storage)	Meaning
`type`	`sqlite` (a file in the plugin folder), `mysql`, `mariadb` or `mongodb`.
`table-prefix`	Prefix for every table or collection (`ah_`).
`mysql.*`	Host, port, database, username, password, SSL and pool size. Also used for MariaDB.
`mongodb.uri`, `mongodb.database`	MongoDB connection.

Blacklist

Items that match any of these can’t be listed.

Key (blacklist)	Blocks
`materials`	Item types, for example `BEDROCK`. Command blocks, barriers and similar are listed by default.
`custom-items`	Custom items as `nexo:<id>`, `oraxen:<id>` or `itemsadder:<namespace>:<id>`.
`data-keys`	Items carrying a plugin data key, for example `myplugin:drill`. `myplugin:*` blocks every key of that plugin.
`nbt-contains`	Items whose raw data contains this text.
`name-contains`, `lore-contains`	Items whose name or lore contains this text. Not case sensitive.
`check-containers`	Also check the contents of shulker boxes and bundles.
`max-item-data`	Largest item data allowed (40000). Stops oversized books and shulkers that kick players who view them. 0 turns it off.

yaml

blacklist:
  materials:
    - BEDROCK
  custom-items:
    - nexo:ruby_sword
  data-keys:
    - myplugin:*
  name-contains:
    - "admin"

Other settings

Key	Default	Meaning
`compact: true` under `numbers:`	`true`	Show prices as 1.2K and 3.4M instead of 1,200 and 3,400,000.
`icons: true` under `choose-item:`	`true`	Item icons next to the names in the Quick Buy item list.

Menus

In menus.yml every menu has its own section (auction, your-items, transactions, quick-buy, insert-item). Change titles, rows, slots and lore there. Set a button’s slot to -1 to hide it. Listing slots are written as ranges, for example "0-44".

The sounds are under sounds: click, page-turn, sort, refresh, listed, purchase and deny. Each one can be a single sound or a list of sounds that play together.

yaml

sounds:
  sort:
    - sound: "minecraft:ui.loom.take_result"
      volume: 1.0
      pitch: 1.0
    - sound: "minecraft:ui.button.click"
      volume: 1.0
      pitch: 1.0

Default config

Open raw config.yml

yaml

# Paste your license key below, then restart the server.
# No key yet? Join my Discord: https://discord.gg/nRjDw9k2vJ
license-key: "AP-XXXX-XXXX-XXXX-XXXX"

storage:
  # sqlite, mysql, mariadb or mongodb. Use mysql, mariadb or mongodb when several servers share one auction house.
  type: sqlite
  # Prefix for every table or collection.
  table-prefix: "ah_"
  mysql:
    host: localhost
    port: 3306
    database: auctionhouse
    username: root
    password: ""
    use-ssl: false
    pool-size: 6
  mongodb:
    uri: "mongodb://localhost:27017"
    database: auctionhouse

network:
  # Share listings, payouts and messages between servers through Redis. Needs mysql, mariadb or mongodb storage.
  enabled: false
  # A unique name for this server.
  server-name: "survival"
  channel: "auctionhouse"
  redis:
    host: localhost
    port: 6379
    username: ""
    password: ""
    database: 0
    use-ssl: false

auction:
  # How long a listing stays on the auction house, in hours.
  listing-duration-hours: 24
  # Listing slots every player has. More with the permission auctionhouse.slots.<amount>.
  default-slots: 18
  # Slots shown in Your Items. Slots above a player's limit are shown as locked.
  max-slots: 90
  min-price: 1
  # Highest allowed price. 0 means no limit.
  max-price: 0
  # Percentage of every sale kept as tax (0-100).
  sales-tax-percent: 0
  # Pay sellers who are offline right away. With network enabled, offline sellers are paid when they next join.
  pay-offline-sellers: true
  # Minimum time between two purchases or listings by the same player, in milliseconds.
  action-cooldown-ms: 300
  # Most transactions kept per player in Transactions.
  transaction-history: 450
  # Write every listing, purchase, cancel and expiry to plugins/AuctionHouse/logs, with the full item data.
  log-to-file: true

quick-buy:
  enabled: true
  # /shop opens Quick Buy when no other plugin has a /shop command.
  shop-alias: true
  # Buy straight away from Quick Buy, without the confirm screen.
  skip-confirm: true
  # Items a player can save in Quick Buy (9-45).
  slots: 45
  # Only buy items that are not damaged.
  only-undamaged: true

blacklist:
  # Items that can never be listed.
  materials:
    - BEDROCK
    - BARRIER
    - COMMAND_BLOCK
    - CHAIN_COMMAND_BLOCK
    - REPEATING_COMMAND_BLOCK
    - COMMAND_BLOCK_MINECART
    - STRUCTURE_BLOCK
    - STRUCTURE_VOID
    - JIGSAW
    - LIGHT
    - DEBUG_STICK
    - KNOWLEDGE_BOOK
  # Custom items, written as nexo:<id>, oraxen:<id> or itemsadder:<namespace>:<id>.
  custom-items: []
  # Plugin data keys, for example myplugin:drill. myplugin:* blocks every key of that plugin.
  data-keys: []
  # Blocks items whose raw item data contains this text, for example "drill_size".
  nbt-contains: []
  # Blocks items whose name or lore contains this text. Not case sensitive.
  name-contains: []
  lore-contains: []
  # Also check the contents of shulker boxes and bundles.
  check-containers: true
  # Largest item data allowed, in characters. Stops oversized books and shulkers that kick players who view them.
  # A normal full shulker is far below this. 0 turns the check off.
  max-item-data: 40000

numbers:
  # Show prices as 1.2K and 3.4M. false shows 1,200 and 3,400,000.
  compact: true

choose-item:
  # Item icons next to the names in the Quick Buy item list.
  icons: true
  item-atlas: "minecraft:items"
  block-atlas: "minecraft:blocks"

Other default files

Open raw menus.yml Open raw messages.yml Open raw slang.yml