Skip to content

Installation

  • Java 21+ - required. The plugin is compiled to Java 21 bytecode; on Java 17 or older it fails with UnsupportedClassVersionError. Check with java -version.
  • Paper / Folia (or a Paper fork). Spigot is not supported.
  • Minecraft 1.20.4 β†’ 1.21.11+, as long as the server runs Java 21. (Most 1.20.4 servers run Java 17 - those must switch to 21 first.)
  • PlaceholderAPI - optional soft dependency, recommended for placeholders.
  1. Confirm java -version reports 21 or higher.
  2. Stop the server.
  3. Drop OptimalAFKZone.jar into plugins/.
  4. (Optional) Add PlaceholderAPI.jar for placeholder support.
  5. Start the server. The plugin generates its files and prints a startup banner.
  6. Run /plugins - OptimalAFKZone should be green.

sqlite-jdbc and XSeries download automatically on first startup via Paper’s library loader, so the first launch needs internet access and may take a few extra seconds.

plugins/OptimalAFKZone/
β”œβ”€ config.yml # global settings
β”œβ”€ messages.yml # every message
β”œβ”€ zones/
β”‚ └─ _template.yml # template new zones copy from (no live zones ship)
β”œβ”€ boosters/
β”‚ β”œβ”€ shard2x.yml
β”‚ └─ shard3x.yml
β”œβ”€ shops/
β”‚ └─ shards.yml # default rotating shop
β”œβ”€ guis/
β”‚ └─ confirm.yml # purchase confirmation menu
└─ data/
└─ data.db # SQLite player data (do not edit by hand)

No zones ship by default - create them in-game. Continue to Creating AFK Zones.