config.yml

After changing the file, use /szpontafkzone reload. The options that need a restart say so below.

Caution

Do not change config-version. The plugin uses it to update the file automatically.

General

Key	Default	Description
language	en	Language of all messages: the file lang/<language>.yml is used. en and pl are included, and you can add your own (see Languages and messages). New zone files are written in this language too: en or pl, and any other language gets the English template.
text-format	LEGACY	How texts are written: LEGACY (&a codes, hex, gradients) or MINIMESSAGE. See Text formatting.
debug	false	Extra [debug] lines in the console: players entering and leaving zones, why a player is not earning, and every reward roll. Useful while setting up zones; keep it off on a live server.

Caution

All shipped texts use LEGACY. After switching to MINIMESSAGE, rewrite your texts with MiniMessage tags, otherwise codes such as &a are shown as plain text.

update-checker

Checks once at startup, in the background, whether a new version of SzpontAFKZone is out. See Updates.

Key	Default	Description
enabled	true	true checks and logs the result to the console, false never checks. Changes need a server restart.
notify-on-join	true	Also tells players with the szpontafkzone.notify.update permission (operators by default) when they join. false tells only the console.

commands

Key	Default	Description
aliases	[afkzone]	Extra names for /szpontafkzone: only a-z, 0-9, - and _, no letters with diacritics. [] means none. Changes need a server restart. A name that another plugin already uses is skipped with a console warning.
subcommand-aliases	set: [ustaw]	Extra names for subcommands, for example translations, written as <subcommand>: [names]. Letters (also with diacritics, e.g. usuń), digits, - and _, no spaces. The English names always work. {} means none. Changes apply after reload.

Subcommands that can get aliases: help, reload, wand, pos1, pos2, create, set, delete, enable, disable, list, info, tp, show.

commands:
  aliases:
    - afkzone
  subcommand-aliases:
    set:
      - ustaw

hooks

An integration is used only when that plugin is installed. false ignores the plugin even when it is installed.

Key	Default	Description
placeholderapi	true	Placeholders of other plugins (%...%) work in all texts and actions, and SzpontAFKZone adds its own. See PlaceholderAPI.
worldguard	true	A zone can use a WorldGuard region as its area. With false, such zones stay inactive. See WorldGuard.

progress

What happens to the reward timers of a player. More on Progress and anti-abuse.

Key	Default	Description
on-leave	PAUSE	When the player leaves a zone: PAUSE stops the timers of that zone, and they continue on the next visit. RESET makes them start from zero on the next visit.
on-quit	SAVE	When the player logs out: SAVE saves the timers with the player’s data, and they continue after the next join, also after a restart. RESET makes them start from zero after the next join.

anti-abuse

Key	Default	Description
allowed-gamemodes	[SURVIVAL, ADVENTURE]	Game modes in which players earn rewards: SURVIVAL, CREATIVE, ADVENTURE, SPECTATOR. With an empty list ([]) nobody earns rewards.
reward-vanished-players	false	Whether vanished players earn rewards. false treats them as outside every zone.
ip-limit.enabled	false	Turns on the limit of players from one IP address in the same zone.
ip-limit.max-players	1	How many players from one IP address can earn in the same zone at once. At least 1.

displays

Key	Default	Description
join-separator	' &8| '	Put between the texts of several reward tracks when more than one of them shows an action bar or a title (a player sees only one of each at a time). Written in the text-format syntax.

Boss bars, action bars and titles are set up for each reward track in the zone files. See Boss bar, action bar and title.

wand

The selection wand (/szpontafkzone wand).

Key	Default	Description
item	BLAZE_ROD	Item used as the wand: a material name (BLAZE_ROD) or an id (minecraft:blaze_rod). Only wands given by /szpontafkzone wand select corners. Other items of this type work as usual.
particle	FLAME	Particle that draws selections and zone borders. Only particles that need no extra data work, e.g. FLAME, SOUL_FIRE_FLAME, END_ROD, ELECTRIC_SPARK.
preview-seconds	10	How long borders are drawn after a corner is set and after /szpontafkzone show, in seconds. 1–300.