Documentation

AuctionCore

An auction house with buy it now and bidding, fully configurable in game.

v1.0.01.14 - 26.2Spigot / PaperFolia supportedReleased
AuctionCore overview

AuctionCore is a full auction house: list an item at a fixed price or run it as a timed auction with real bidding, browse by category, and collect what you won or earned from one screen.

Seven player screens plus an admin hub, every one of them laid out room for room and editable in game. Fees, limits, categories and durations are settings, not code.

Listing slots come from permissions, so a rank can sell more than a default player without any extra configuration.

What it does

Buy it now and bidding
Sell at a fixed price or run a timed auction with live bids. Both live in the same house and the same screens.
Categories you control
Shelves are yours to define and edit in game, with their own colours and counts on the browser rail.
Slots from permissions
A slots permission decides how many listings a player may run at once, largest held wins, with an unlimited node for staff.
Nothing gets lost
Items you won and money you earned wait in a collection screen, so a full inventory or an offline sale never eats anything.
Fees and limits
Listing fees, sale cuts, durations and limits are all settings on a board you edit in game rather than numbers in a file.
Admin control of any listing
Browse everything, force a listing off by id, or sweep everything past its time in one action.

Installation

  1. Drop AuctionCore.jar into your server's plugins folder.
  2. Restart the server. The plugin writes its own configuration on first start.
  3. Run /ah admin hub in game to set everything up. There is no file editing step.
iEverything ships in one jar. The shared framework is shaded in, so AuctionCore does not depend on any other Core plugin and any number of them run side by side.

Optional integrations

All of these are soft dependencies. AuctionCore loads and runs with none of them installed.

PluginWhat it adds
VaultReads or provides the server economy, depending on the mode you choose.
PlaceholderAPIRegisters the placeholder expansion listed below.
ItemsCoreCustom ItemsCore items are understood and displayed properly.
LuckPermsPermission driven limits resolve for offline players too.

Commands

Generated from the plugin's own command registry at version 1.0.0, so this list cannot drift out of date.

/ahThe auction house/auction/auctionhouse
Usage
UsagePermissionDescription
/ahauctioncore.useThe auction house
/ah <player>auctioncore.use.othersOpen the auction house for somebody else
Subcommands
UsagePermissionPlayer onlyDescription
/ah sellauctioncore.sellyesOpen the sell screen
/ah browseauctioncore.useyesOpen the auction browser
/ah mineauctioncore.useyesOpen your listings
/ah bidsauctioncore.useyesOpen your bids and collection
/ah claimauctioncore.useyesTake back everything waiting for you
/ah statsauctioncore.useyesOpen your auction stats
/ah view <player>auctioncore.useyesOpen another player's auctions
/ah admin [action] [id]auctioncore.adminnoEverything, in one screen
/ah admin actions
UsagePermissionDescription
/ah admin hubauctioncore.adminOpen the admin hub, which reaches everything
/ah admin feesauctioncore.admin.settingsEdit the fees and limits
/ah admin categoriesauctioncore.admin.categoriesEdit the categories
/ah admin listingsauctioncore.admin.manageBrowse and force off any listing
/ah admin cancel <id>auctioncore.admin.manageForce one listing off by id
/ah admin sweepauctioncore.admin.manageClose everything past its time now
/ah admin menusauctioncore.admin.menusEdit any menu in game
/ah admin settingsauctioncore.admin.settingsEdit the settings in game
/ah admin messagesauctioncore.admin.settingsEdit any player facing message
/ah admin reloadauctioncore.admin.reloadReload the configuration

Permissions

everyone is granted to all players, operator only to ops, and nobody must be granted explicitly by a permissions plugin.

NodeDefaultDescription
auctioncore.*operatorGrants every auctioncore permission
auctioncore.adminoperatorUse the admin commands
auctioncore.admin.categoriesoperatorEdit the categories in game
auctioncore.admin.manageoperatorCancel or remove anybody's listing
auctioncore.admin.menusoperatorEdit the menus in game
auctioncore.admin.reloadoperatorReload the configuration
auctioncore.admin.settingsoperatorEdit the settings in game
auctioncore.buyeveryoneBuy and bid
auctioncore.selleveryoneList an item
auctioncore.slots.<amount>nobodyList up to <amount> at once, largest held wins
auctioncore.unlimitedoperatorList any number of items at once
auctioncore.useeveryoneOpen the auction house
auctioncore.use.othersoperatorOpen the auction house for somebody else, for npc commands

Placeholders

Requires PlaceholderAPI. Turn the expansion off with integrations.placeholderapi: false.

Every key below is walked by the plugin's own self test, which fails if one stops resolving, so this list cannot quietly go out of date.

Server wide

These need no player.

PlaceholderExampleNotes
%auctioncore_listings%142active listings right now, across everybody
%auctioncore_categories%7how many shelves are configured

Per player

PlaceholderExampleNotes
%auctioncore_selling%3listings this player has running
%auctioncore_slots%5how many they may run, unlimited shows as an infinity sign
%auctioncore_bidding%2auctions they hold a live bid on
%auctioncore_claims%1items waiting in their collection
%auctioncore_sold_waiting%4sold listings whose money they have not been paid yet

Menu placeholders, on any listing tile

Separate from PlaceholderAPI. Every button in menus/*.yml may use these in its name or lore, and they are filled whether or not PlaceholderAPI is installed.

PlaceholderExampleNotes
%item%diamond sword
%amount%1
%price%$12,000
%price_label%top bid
%start%$10,000
%seller%TastyCake
%bidder%Notch
%bids%4
%type%auction
%category%weapons
%rarity%legendary
%ends%2h 14m
%id%a4f1c9

Menu placeholders on the other screens

On the hub: player, balance, listings, max, bids and claims.

On the browser: category, count, colour and state on a rail tile; search, options, page and pages on the filter row; from, to and total on the rail scroll button.

On the sell screen: type, price, price label, duration, fee, cut, amount and options. On the fee board: value on every tile, already formatted as a percent or as money to suit the setting.

What they return when they cannot answer

A per player key with no player is left unresolved, so PlaceholderAPI leaves the text as it is.

Slots for an offline player gives the configured free amount, since permissions are not loaded.

An unknown key is left unresolved rather than answering 0, so a typo is visible instead of looking like an answer.