Docs/EmberPvP/EmberAFKZone

EmberAFKZone

Earn Gems on autopilot. EmberAFKZone provides configurable cuboid AFK zones, timed rewards, a built-in Gem economy, a category-based GUI shop, console commands on zone events, JSON/MySQL balance storage, and polished audiovisual feedback built for the legacy 1.8 client.

Requirements

  • Spigot or compatible server for Minecraft 1.8.8/1.8.9
  • Java 8 or newer
  • No required plugin dependencies

Minecraft 1.8.9 uses the Spigot 1.8.8-R0.1-SNAPSHOT server API.

Installation

  1. Stop the server.
  2. Put EmberAFKZone-1.1.0.jar in the server's plugins directory.
  3. Start the server once to generate the configuration files.
  4. Edit plugins/EmberAFKZone/config.yml as desired.
  5. Run /afkzone reload or restart the server.

The first launch uses zero-setup JSON storage. Balances are stored in plugins/EmberAFKZone/balances.json.

Creating a zone

  1. Run /afkzone wand.
  2. Left-click one corner and right-click the opposite corner.
  3. Run /afkzone create <region>.

Players inside a zone receive the configured Gem reward every reward-interval-seconds.

The wand draws a temporary particle outline after both corners are selected. Entering, leaving, earning rewards, and purchasing shop items each have their own configurable sound and particle feedback.

AFK zone commands

  • /afkzone help
  • /afkzone wand
  • /afkzone create <region>
  • /afkzone delete <region>
  • /afkzone list
  • /afkzone command add <region> [enter|reward|leave] <command>
  • /afkzone command remove <region> [enter|reward|leave] <command>
  • /afkzone command list <region>
  • /afkzone reload

The phase is optional and defaults to reward, preserving the shorter command syntax. Commands run as console. Use {player} anywhere a player's name should be inserted.

Examples:

/afkzone command add spawn-afk enter say {player} entered the AFK zone
/afkzone command add spawn-afk reward give {player} gold_ingot 1
/afkzone command add spawn-afk leave say {player} left the AFK zone

Gem commands

  • /gem help
  • /gem shop
  • /gem balance [name]
  • /gem set <name> <amount>
  • /gem reset <name>
  • /gem give <name> <amount>
  • /gem remove <name> <amount>
  • /gems convert <json|mysql>

/gem and /gems are aliases of the same command.

Permissions

PermissionPurposeDefault
emberafkzone.adminZone creation, commands, deletion, and reloadOP
emberafkzone.gem.adminChange balances and convert storageOP
emberafkzone.shopOpen and use the Gem ShopEveryone
emberafkzone.balanceView own balanceEveryone
emberafkzone.balance.othersView another balanceOP

Shop configuration

The generated config.yml contains two example categories. Each shop item has a slot, display material, price, lore, and one or more console commands. Replace the example commands with commands supported by your server.

Legacy item data values are supported with MATERIAL:data, such as WOOL:14.

The shop includes animated borders, a live balance display, category panels, and a confirmation screen before Gems are spent. These features can be toggled with shop.animated-border and shop.confirm-purchases.

Sounds and particles

The effects section in config.yml controls all audiovisual feedback. Sounds and particles can be disabled globally or changed individually using Spigot 1.8 enum names. Invalid names are ignored safely and logged to console.

MySQL storage

  1. Fill in storage.mysql in config.yml.
  2. While the server is running, execute /gems convert mysql.

Conversion copies all currently loaded balances before changing the configured storage type. To move back, execute /gems convert json.

Back up the plugin data directory and database before production migrations.

Building from source

mvn clean package

The distributable jar is created at target/EmberAFKZone-1.1.0.jar.

PreviousCustomSetsNextEmberEnvoys