ZephMC Docs

Installation

Server software, Java version and dependencies you need before installing.

Requirements

Server softwarePaper 26.2 or newer. Spigot and CraftBukkit are not supported.
JavaJava 25 or newer. Paper 26.1+ requires it; ZyAuctions is built against it.
VaultRequired. ZyAuctions will not enable without it.
An economy pluginRequired — Vault is only a bridge. EssentialsX Economy, CMI, and anything else that registers a Vault economy all work.
Internet access on first startRequired once, to download the database driver. See below.

Paper 26.2 no longer remaps plugins to Spigot mappings. A plugin built for Spigot may load and then break in ways that are hard to diagnose. If you are coming from a Spigot server, move to Paper before installing this.

Steps

  1. Install Vault and an economy plugin, and start the server once so the economy registers itself.
  2. Drop ZyAuctions-1.0.0.jar into plugins/.
  3. Start the server.
  4. Check the console for these lines:
[ZyAuctions] Hooked economy provider: EssentialsX Economy
[ZyAuctions] Loaded 1 locale(s): en_US
[ZyAuctions] Storage: sqlite (auctions.db)
[ZyAuctions] Loaded 0 active listing(s) and 0 collection bin entr(ies).
[ZyAuctions] ZyAuctions 1.0.0 enabled.
  1. Type /ah in game.

The library download

ZyAuctions does not bundle its database driver. Paper downloads it from Maven Central the first time the plugin loads, using the libraries list in the plugin's manifest:

com.zaxxer:HikariCP:7.1.0
org.xerial:sqlite-jdbc:3.53.2.1
com.mysql:mysql-connector-j:26.7.0

They land in the server's libraries/ folder and are reused from then on. This means:

  • The first startup needs outbound network access. After that it does not.
  • On an air-gapped server, copy the libraries/ folder from a machine that has downloaded them once.

If the download fails you will see:

[ZyAuctions] The JDBC driver for storage.type=SQLITE is not on the classpath.

and the plugin will disable itself rather than start without persistence.

Files it creates

plugins/ZyAuctions/
├── config.yml                 your settings
├── auctions.db                the SQLite database (with storage.type: sqlite)
└── lang/
    ├── en_US.reference.yml    rewritten every startup — do not edit
    └── (your language files)

Nothing else on the server is touched. ZyAuctions writes no world data and holds no player data outside its own folder and your economy plugin's balances.

Upgrading

Replace the jar and restart. config.yml and your language files are never rewritten; new options appear with their defaults in the reference file rather than being injected into your copy. Check the release notes for any option worth setting.

Uninstalling

Stop the server, then remove the jar. Leave plugins/ZyAuctions/ in place if there is any chance you will reinstall — it holds listings and unclaimed collection bins, and deleting it means players lose those items with no way to recover them.

Before deleting the data folder for good, revoke zyauctions.sell so no new listings are created, give players a week to empty their collection bins with /ah collect, and only then remove it. Items in a deleted database cannot be recovered.

On this page