Installation

1. Install Vault and an economy plugin

   Gavel needs a balance to move. Vault plus any economy plugin (EssentialsX, CMI, CoinsEngine via the provider interface) is enough.

   Without an economy provider Gavel will load but refuse to process purchases.

2. Drop the jar in

   Put Gavel-1.0.0.jar into plugins/ and restart.

   On first start, Paper's library loader fetches HikariCP, the SQLite driver and — only if you configure them — the MySQL driver and Jedis. Nothing is shaded into the jar, so the first boot needs internet access; later boots use the cached copies.

3. Set your server name

   general:  server-name: "survival-1"  default-language: "en"  follow-client-locale: true

   server-name is stamped onto every listing so you can tell where something was listed. Keep it unique per server even if you are not running a network yet.

4. Pick your fees

   The defaults are deliberately mild: a 1% listing fee and 5% sales tax, both going nowhere (a currency sink).

   auction:  listing-fee:    percent: 1.0    flat: 0.0  sales-tax-percent: 5.0  tax-destination: NOTHING

   ✦NOTHING is usually right

   NOTHING removes the money from the economy. On most servers that is the point — an auction house without a sink is an inflation engine. Use ACCOUNT only if you have a reason to pay the fees to a specific player.

5. Give out permissions

   The player-facing permissions default to true, so a fresh install already works. What you do need to set are the per-rank limits:

   lp group default permission set gavel.limit.5 truelp group vip permission set gavel.limit.15 truelp group vip permission set gavel.tax.2 truelp group vip permission set gavel.duration.72 true

   Full list on Permissions.

6. Open it

   /ah

   The browse menu opens. /ah sell 5000 lists the item in your hand for 5,000.

Languages

Every player-facing string lives in plugins/Gavel/lang/<code>.yml. English and German ship with the plugin.

general:  default-language: "en"  follow-client-locale: true

With follow-client-locale: true, a player whose Minecraft client is set to German automatically gets de.yml if it exists. /ah lang <code> always overrides both.

To add a language, copy en.yml to e.g. fr.yml and translate it. The file name is the code.

Menus

Menu layouts live in plugins/Gavel/gui/: browse.yml, sell.yml, price.yml, market.yml, confirm.yml, filters.yml, inspect.yml, listing.yml, mailbox.yml, my-listings.yml, offers.yml, watchlist.yml and menu.yml. Slot positions, materials and lore are all editable.

Upgrading

1. Stop the server.
2. Remove the old jar — do not leave two versions in plugins/.
3. Drop the new one in and start.

Database schema migrations run automatically on boot. Your config.yml, lang/ and gui/ files are not overwritten, so new options fall back to their defaults until you add them.

Going cross-server

If you plan to share one market between several servers, read Cross-server before you let players list anything. Switching from SQLite to MySQL later means migrating live listings, which is avoidable work.