config.yml

Global settings. After editing, run /afkzoneadmin reload (the Commands section needs a restart).

config.yml is read without bundled defaults, so a key you delete stays deleted. A missing Settings, Settings.Number-Format, Wand, Wand.Item, Wand.Outline, Shards, Shards.Boosters, Shop or Commands section is a loud error, not a silent default.

Settings

Settings:
  Check-Interval: 20
  Save-Interval: 300
  Number-Format:
    Default: SEPARATED
    Separated:
      Grouping-Separator: ","
      Decimal-Separator: "."
      Decimals: 2
    Abbreviated:
      Thousands: "K"
      Millions: "M"
      Billions: "B"
      Trillions: "T"
      # ... every scale up to Centillions

Key	Default	Description
Check-Interval	20	Ticks between each player’s zone check (minimum 1). Also the refresh rate of the action bar and boss bar, so keep it at 20 or the action bar fades between updates. Progress is tracked in ticks, so payouts stay exact at any value.
Save-Interval	300	Seconds between saves of player data to the database. 0 turns the timer off (data is then saved on quit and shutdown only).
Number-Format	see below	How shard amounts are printed everywhere ({shards}, prices, placeholders).

Number-Format

Key	Default	Description
Default	SEPARATED	SEPARATED prints 12,500. ABBREVIATED prints 12.5K.
Separated.Grouping-Separator	,	Thousands separator. Exactly one character.
Separated.Decimal-Separator	.	Decimal point used in abbreviated values. Exactly one character.
Separated.Decimals	2	Maximum decimals in an abbreviated value (0 to 8), rounded down. Shards are whole numbers, so separated values never show decimals.
Abbreviated.<Scale>	K, M, B, T, Qa, …	The suffix for each scale, from Thousands up to Centillions. The list must start at Thousands and be contiguous; you can stop early.

Upgrading from an older config

A config.yml without Settings.Number-Format gets the block added automatically. Default is taken from the old Shards.Abbreviate-Numbers, and the old Shards.Format and Shards.Abbreviate-Numbers keys are removed. A custom Shards.Format pattern logs a warning: set the Separated block to match it.

Wand

Wand:
  Outline:
    Enabled: true
    Interval: 10
    Spacing: 0.5
    Max-Points: 600
    Range: 64.0
    Selection-Particle: "HAPPY_VILLAGER"
    Zone-Particle: "END_ROD"
  Item:
    Material: BLAZE_ROD
    Name: "&d&lAFK Wand"
    Glow: true
    Lore:
      - "&8AFK Zone"
      - ""
      - "&dUsage:"
      - "&5 - &7Left-Click: &fPosition 1"
      - "&5 - &7Right-Click: &fPosition 2"
      - ""
      - "&e➥ Run /afkzoneadmin create <zone>!"

Outline controls the particle outline drawn around a wand selection and around zones toggled with /afkzoneadmin outline. Every key except the two particles is required.

Key	Default	Description
Outline.Enabled	true	Draw the outlines at all.
Outline.Interval	10	Ticks between redraws. At least 1.
Outline.Spacing	0.5	Blocks between particles along an edge (smaller is denser). Above 0.
Outline.Max-Points	600	Cap on particles per outline. At least 1.
Outline.Range	64.0	Only draw for players within this many blocks. Above 0.
Outline.Selection-Particle	HAPPY_VILLAGER	Particle for your wand selection.
Outline.Zone-Particle	END_ROD	Particle for /afkzoneadmin outline.
Item	-	The wand item: Material, Name, Lore, Glow and the other standard item fields.

Particle names are resolved through XSeries, so legacy names such as VILLAGER_HAPPY work. Particles that need extra data (such as DUST) are refused when the config loads.

Shards

Shards:
  Enabled: true
  Name-Singular: "Shard"
  Name-Plural: "Shards"
  Boosters:
    Enabled: true
    Permission-Boosters: true
    Permission-Prefix: "optimalafkzone.booster."

Key	Default	Description
Enabled	true	Master switch. When false, zones pay no shards and always run their own Rewards whatever their Reward-Mode, and /afkzone shards and /afkzoneadmin shards reply SHARDS-DISABLED.
Name-Singular	Shard	{currency} when the amount is exactly 1.
Name-Plural	Shards	{currency} otherwise.
Boosters.Enabled	true	Master switch for boosters. When false, every multiplier is 1 and right-clicking a booster item does nothing.
Boosters.Permission-Boosters	true	Read permanent multipliers from permissions.
Boosters.Permission-Prefix	optimalafkzone.booster.	The prefix of a permission booster. The rest of the node is the multiplier, for example optimalafkzone.booster.2 or optimalafkzone.booster.1.5.

A permission booster must be granted explicitly. Its multiplier is a number with up to four digits and up to four decimals; the highest one a player holds is used.

Commands

Commands:
  Player:
    Command: "afkzone"
    Aliases:
      - "afk"
      - "afkzones"
  Admin:
    Command: "afkzoneadmin"
    Aliases:
      - "afkadmin"
      - "afkzonesadmin"
  Shop:
    Command: "shardshop"
    Aliases:
      - "shardsshop"

The names and aliases of the three commands. Use lowercase letters, digits, _ or -, without the leading /. No name or alias may repeat across the three commands, or the plugin refuses to enable.

Key	Default	Description
Player.Command / Player.Aliases	afkzone / afk, afkzones	The player command.
Admin.Command / Admin.Aliases	afkzoneadmin / afkadmin, afkzonesadmin	The admin command. Hidden from tab completion for players without optimalafkzone.admin.
Shop.Command / Shop.Aliases	shardshop / shardsshop	Opens the default shop directly.

The help panels and SHOP-ROTATED show the configured names through {command}, {admin-command} and {shop-command}.

Restart required

Command names are registered at startup. /afkzoneadmin reload does not rename them; restart the server after changing this section. If you rename the admin command, also update console actions that call it, such as the default shop’s afkzoneadmin booster give ....

A config.yml without a Commands section gets the defaults added automatically.

Shop

Shop:
  Enabled: true
  Default-Shop: "shards"
  Confirm-Purchase: true

Key	Default	Description
Enabled	true	Master switch. When false, opening the shop replies SHOP-DISABLED.
Default-Shop	shards	The shops/ file (without .yml) that /shardshop and /afkzone shop open. A name that matches no loaded shop also replies SHOP-DISABLED.
Confirm-Purchase	true	Open the confirm menu before buying. false buys on the first click.

The shop’s flash icons (Insufficient-Funds, Limit-Reached) live in each shop file under Menu.Temporary-Icons, not here. An old Temporary-Icons section in config.yml is ignored.

Inventories-Sounds

Named sounds in "NAME;volume;pitch" form. Names are XSound names, which stay stable across Minecraft versions. Set a key to "" to silence it.

Inventories-Sounds:
  "SHOP-OPEN": "BLOCK_CHEST_OPEN;1;1.2"
  "CONFIRM-OPEN": "UI_BUTTON_CLICK;1;1.4"
  "PURCHASE": "ENTITY_PLAYER_LEVELUP;1;1.6"
  "CLICK": "UI_BUTTON_CLICK;0.6;1.5"
  "PAGE-CHANGED": "ITEM_BOOK_PAGE_TURN;1;1"
  "NO-PAGE-FOUND": "BLOCK_NOTE_BLOCK_PLING;1;0.7"
  "FAILURE": "ENTITY_VILLAGER_NO;1;1"
  "ZONE-REWARD": "ENTITY_EXPERIENCE_ORB_PICKUP;1;1.2"
  "SHARDS-EARNED": "BLOCK_AMETHYST_BLOCK_CHIME;0.7;1.4"
  "BOOSTER-ACTIVATED": "ENTITY_PLAYER_LEVELUP;1;1.2"
  "WAND-SELECT": "BLOCK_NOTE_BLOCK_PLING;0.7;1.8"

Key	Played when
SHOP-OPEN	The shop menu opens.
CONFIRM-OPEN	The confirm menu opens.
PURCHASE	A purchase succeeds.
CLICK	The cancel button in the confirm menu is clicked.
PAGE-CHANGED	A shop [next]/[previous] button turns the page.
NO-PAGE-FOUND	A page button is clicked with no page in that direction.
FAILURE	A purchase is refused (not enough shards, limit reached, not stocked, no permission).
ZONE-REWARD	A zone pays out (every payout).
SHARDS-EARNED	A payout grants shards.
BOOSTER-ACTIVATED	A booster item is redeemed.
WAND-SELECT	A wand corner is set.

Without an Inventories-Sounds section, nothing plays.