Install Auction House

Requirements

RequirementDetails
ServerPaper or Folia 26.1 or newer
JavaJava 25
Vault + economy pluginRequired. Items are bought and sold with your server’s money (EssentialsX, CMI, ...).
Internet on first startAuction House downloads its libraries once through the server’s library loader: Kotlin, HikariCP, the SQLite, MySQL and MariaDB drivers, the MongoDB driver and Jedis for Redis.
PlaceholderAPIOptional. Enables the Auction House placeholders and placeholders inside messages.
Nexo, Oraxen, ItemsAdderOptional. Their custom items can be searched for and blacklisted by ID.

Single server

  1. Install Vault and an economy plugin if the server doesn’t have them yet.
  2. Place AuctionHouse-1.0.0.jar in the plugins folder.
  3. Start the server once so the default files are created, then stop it.
  4. Paste your license key into license-key in plugins/AuctionHouse/config.yml.
  5. Start the server. The console shows License verified with the product and version.
  6. Hold an item and run /ah sell 100, then open /ah.
No economy found
Without Vault and an economy plugin nobody can buy or sell. Install both and restart.

Several servers

Set type: under storage: to mysql, mariadb or mongodb on every server and point them at the same database. Turn on network with a Redis server so listings, payouts and messages reach the other servers right away. See Cross-server.

Created files

FilePurpose
config.ymlLicense key, storage, network, listing rules, Quick Buy and the blacklist.
menus.ymlEvery menu, button, slot, sound and dialog text.
messages.ymlEvery chat and action bar message.
slang.ymlShort names for search.
auctions.dbThe SQLite database, when type: sqlite under storage: is set.
logs/A daily log of every listing, purchase, cancel and expiry.
.installation-id, .installation-v2.keyIdentify this server for the license. Don’t delete or copy them.