Skip to content

Configuration

joogiebear edited this page Jul 14, 2026 · 1 revision

Configuration

Everything lives in plugins/RoyalAuctions/config.yml. Run /ah reload after edits. Categories, tiers, and menus each have their own page — this one covers storage and the listing/bidding rules.

Storage

storage:
  type: SQLITE            # or MYSQL for a network / shared setup
  sqlite-file: auctions.db
  mysql:
    host: localhost
    port: 3306
    database: royalauctions
    username: root
    password: ""
    properties: "useSSL=false&characterEncoding=utf8&allowPublicKeyRetrieval=true"
    pool-size: 10

See Storage & Data for details.

Listing rules

listings:
  durations:
    - { label: "1 Hour",  hours: 1,  icon: RED_TERRACOTTA }
    - { label: "6 Hours", hours: 6,  icon: ORANGE_TERRACOTTA }
    - { label: "12 Hours", hours: 12, icon: YELLOW_TERRACOTTA }
    - { label: "1 Day",   hours: 24, icon: LIME_TERRACOTTA }
    - { label: "2 Days",  hours: 48, icon: PINK_TERRACOTTA }
  default-duration-hours: 24
  default-type: BIN            # BIN (buy-it-now) or AUCTION
  max-per-player: 7            # royalauctions.limit.<n> overrides; -1 = unlimited
  min-price: 1.0
  max-price: -1                # -1 disables the upper bound
  fee:
    percent: 0.02             # 2% of the sale price
    minimum: 5.0              # floor, regardless of percent
  instant-deliver-purchases: true
Key Meaning
durations The choices on the Auction Duration screen. Each has a label, hours, and icon.
default-duration-hours Duration a new listing defaults to — must match one of the hours values above.
default-type What a new listing opens as: BIN or AUCTION.
max-per-player Max active listings per player. royalauctions.limit.<n> overrides it; -1 = unlimited.
min-price / max-price Price bounds in Vault currency. max-price: -1 disables the upper bound.
fee.percent / fee.minimum Listing fee taken from the seller immediately on posting — the larger of the percentage and the minimum. Non-refundable.
instant-deliver-purchases true = a bought item goes straight to the buyer's inventory when there's room, overflowing to the collection only when full. false = all purchases go to the collection to claim manually.

Bidding

bidding:
  min-increment: 10.0
  increment-percent: 0.05

Each new bid must beat the current bid by at least the larger of min-increment (flat) and increment-percent (fraction of the current bid). When someone is outbid their money is refunded automatically. When an auction ends, the highest bidder wins and the seller is paid the winning bid. See Buying, Selling & Bidding.

Sorting & expiry

default-sort: NEWEST          # NEWEST, OLDEST, PRICE_LOW, PRICE_HIGH
expiry-sweep-minutes: 5       # how often expired listings are swept

default-sort is the sort a freshly opened browser uses; players cycle it with the Sort button. expiry-sweep-minutes controls how often the plugin returns expired listings to their sellers' collections.

Confirmations

confirmations:
  bid: true
  cancel: true
  purchase: true

Each irreversible action can be gated behind a confirm screen. Set one to false and the code falls straight through to the action — no screen is rendered, so you pay nothing for the feature. See Buying, Selling & Bidding.

A note on formatting

config.yml is YAML — keep the two-space indentation, don't use tabs, and quote values with special characters. If the file fails to load, RoyalAuctions names the line in the console.

Clone this wiki locally