Reward tracks and tiers

Reward tracks

The rewards section of a zone file holds the reward tracks. Each track has its own timer, displays and tiers and runs independently of the others. The template has two tracks:

• guaranteed: given every time the timer ends (a 100% chance in every tier);
• bonus: works the same way, but the reward is given only with the chance of the player’s tier.

The track ids are up to you: rename, add or remove tracks freely. An id is 1–32 characters long: lowercase a-z, digits and single dashes, no letters with diacritics and no spaces. It appears in placeholders such as %szpontafkzone_time_left_bonus%.

Key	Default	Description
enabled	true	Turns the track on or off.
interval-seconds	600	Time in the zone needed for one reward, in seconds (600 = 10 minutes). At least 1.
visible-without-tier	false	What players without a matching tier see. false: nothing, because the track is hidden and its timer does not run. true: the displays and the timer, but no reward.
boss-bar, action-bar, title		Progress displays. See Boss bar, action bar and title.
tiers		Tiers of this track (below).

Tiers

Tiers decide who gets which reward. A player gets the tier with the highest priority among those whose permission they have. Tier ids follow the same rules as track ids.

Key	Default	Description
priority	0	A higher number wins when a player matches several tiers. Any whole number.
display-name	the tier id	Name shown as {tier_name}.
permission	''	Permission needed for this tier. '' means every player.
chance-percent	100	Chance to get the reward when the timer ends, in percent: 0–100, decimals allowed with a dot or a comma (e.g. 12.5 or 12,5). 100 means always.
actions	[]	Run when the timer ends and the chance roll succeeds.
fail-actions	[]	Run when the chance roll fails (only with a chance-percent below 100).

Caution

Tier permissions default to false, so operators do not get them automatically. Grant them explicitly, e.g. /lp group vip permission set szpontafkzone.tier.vip true.

Example

A bonus every 10 minutes: a 10% chance for everyone, 45% for VIPs.

rewards:
  bonus:
    enabled: true
    interval-seconds: 600
    visible-without-tier: false
    boss-bar:
      enabled: true
      text: '&6Bonus reward in &e{time_left} &8- &7chance: &e{chance}%'
      color: YELLOW
    tiers:
      default:
        priority: 10
        display-name: 'Player'
        permission: ''
        chance-percent: 10
        actions:
          - '[console] give {player} gold_ingot 1'
          - '[sound] minecraft:ui.toast.challenge_complete;0.5;1.0'
        fail-actions:
          - '[message] {prefix}No bonus reward this time &8(&7chance: &e{chance}%&8)&7.'
      vip:
        priority: 20
        display-name: 'VIP'
        permission: szpontafkzone.tier.vip
        chance-percent: 45
        actions:
          - '[console] give {player} gold_ingot 2'

Real rewards are usually console commands, e.g. [console] give {player} diamond 1 or [console] eco give {player} 100 (money, needs an economy plugin). Read the [console] warning in Actions.