Skip to main content

Configuration

Every option below is in plugins/SigmaOrders/config-auction.yml unless noted. Player-visible text is in lang/auction/messages.yml, and the screens' slot positions and icons are in gui/auction.yml and gui/auction-create.yml.

Reloading

/auction reload (permission sigmaorders.admin) reloads the configuration and adds any settings that are new in your version. Command aliases are re-applied too, but a restart is the reliable way to fully drop an alias you removed.

Module and aliasesโ€‹

SettingDefaultMeaning
modules.auction in config.ymltrueTurns the whole Auction House on or off
command-aliasesauc, auctions, marketExtra aliases for /auction. /ah is built in. Removing an alias is only fully reliable after a restart

Listing slots, price and timeโ€‹

Where a setting has -overrides, each entry is a permission and a value. When a player matches several entries, the rule below decides which applies.

SettingDefaultOverride keyOverride rule
max-listings-per-player10 (-1 = unlimited)max-listings-overrides (limit)Highest wins
min-listings-per-player0min-listings-overrides (limit)Highest wins. A minimum above the maximum wins
listing-duration (minutes)10080 (7 days)listing-duration-overrides (minutes)Longest wins
creation-cooldown (seconds)5cooldown-overrides (seconds)Lowest wins
min-price0.01min-price-overrides (price)Lowest wins
max-price1000000.0max-price-overrides (price)Highest wins
auction:
max-listings-per-player: 10
max-listings-overrides:
- permission: "sigmaorders.rank.vip"
limit: 20
listing-duration: 10080
listing-duration-overrides:
- permission: "sigmaorders.rank.vip"
minutes: 20160 # 14 days

Permissions that skip a rule entirely: sigmaorders.auction.unlimited (listing limit), sigmaorders.auction.bypass-cooldown (cooldown), sigmaorders.auction.bypass-tax (tax).

Taxโ€‹

SettingDefaultMeaning
tax-percentage5.0The tax rate. It is charged once, as a fee when a listing is created; nothing is deducted when it sells (how)
tax-overrides (percentage)nonePer-permission rate. The lowest matching rate wins

Expiry, collecting and earningsโ€‹

SettingDefaultMeaning
auto-return-expiredtrueReturn expired items to their owner automatically (details)
purge-after-days0Days to keep uncollected expired items and unclaimed earnings. 0 = forever
auto-claim-earningsfalsePay sale earnings automatically instead of waiting for the seller to claim (details)
allow-buy-ownfalseLet players buy their own listings
expire-duration (minutes)1440A fallback lifetime used only when a listing is created with no duration at all, which does not happen with the default listing-duration
announcements-enabledtrueAnnounce new listings in chat to players with sigmaorders.auction.announce
notify-on-jointrueInclude sold items in the "while you were away" join message
notify-expired-on-jointrueInclude expired listings in that message

Buyingโ€‹

quick-buy:
enabled: true
permission: "sigmaorders.quickbuy"

Players with the permission can Shift + left-click a listing to buy it without a confirmation screen. Nobody except operators has sigmaorders.quickbuy until you grant it.

World and game-mode restrictionsโ€‹

auction-restrictions:
disabled-worlds: []
disabled-gamemodes: []
SettingEffect
disabled-worldsThe auction cannot be opened in these worlds. Players with sigmaorders.auction.bypass-world skip it
disabled-gamemodesPlayers in these game modes cannot create listings (for example CREATIVE). They can still browse and buy

Blacklistโ€‹

blacklist:
enabled: true
players: [] # UUIDs or names
items:
- COMMAND_BLOCK
- "*_SPAWN_EGG"
KeyMeaning
enabledMaster switch for both lists
playersPlayers (UUID or name) who cannot create listings or buy. They can still collect, claim and remove what they already have
itemsItems that cannot be listed. Entries can be materials, wildcards, custom item IDs, or nbt-key: entries (syntax)

Renamed items and shulker boxesโ€‹

SettingDefaultMeaning
block-renamed-itemstrueRefuse items with a custom display name
renamed-item-exceptions*_BANNERItems allowed even though renamed. Same entry syntax as the blacklist
shulker-listingtrueAllow shulker boxes to be listed
shulker-previewtrueLet buyers right-click a shulker listing to preview its contents

Soundsโ€‹

gui:
open-sound:
enabled: false
sound: BLOCK_CHEST_OPEN
volume: 0.5
pitch: 1.2
click-sound:
enabled: false
sound: UI_BUTTON_CLICK
volume: 0.3
pitch: 1.0

The open sound plays when the main auction opens; the click sound plays on button clicks. Use sound names such as BLOCK_CHEST_OPEN.

Notificationsโ€‹

notifications:
enabled: true
methods: [CHAT, ACTION_BAR]
sound-on-buy: true
sound-on-sell: true
sound-name: ENTITY_EXPERIENCE_ORB_PICKUP
sound-volume: 0.5
sound-pitch: 1.0

Controls how buyers and sellers are told about purchases and sales.

Logging and Discordโ€‹

SettingDefaultMeaning
transaction-logging.enabledfalseWrite a log of listings, sales and removals
transaction-logging.filetransactions-auction.logThe log file
transaction-logging.formatDETAILEDSIMPLE, DETAILED or JSON
transaction-logging.log-listing, log-sales, log-removalstrueWhich events are logged
discord-webhook.enabledfalsePost events to a Discord webhook
discord-webhook.urlplaceholderThe webhook URL
discord-webhook.min-delay1Seconds between webhook calls
discord-webhook.events.*created, sold, expired on; removed offWhich events are posted

Embed layout is configured in webhook-auction.yml.

Currencyโ€‹

Currency settings are shared with the Orders module. economy.currency-symbol overrides the symbol shown in prices, and a currencies: block enables several currencies. If both config-orders.yml and config-auction.yml define them, config-orders.yml wins. See Economy.

Options that currently have no effect

The auction-gui section (update-interval, listings-per-page, container-preview, show-item-lore) is present in the file but is not read by the plugin. The screens always show 36 listings per page, and the shulker preview is controlled by shulker-preview above.