Zone Settings

The zone configuration file is divided into several sections, each containing a group of settings with common features.

Definition

This part of the config is primarily responsible for the visual representation of the zone.

Parameters:

• Name - Display name.
• Description - Description.
• Icon - Icon.

See also our Text Formation Guide.

Definition:
  Name: Wood
  Description:
  - 'A basic zone with logs for lumberjacks.'
  Icon:
    Material: minecraft:oak_log
    Lore: []

Behavior

This part is responsible for the "behavior" of the zone.

Parameters:

• Permission-Required - If enabled, the player must have a permission to be in and use the zone.
• PvP-Allowed - Allows players to deal damage to each other inside the zone.
• Disabled-Block-Interactions - Prevents players from interacting with the specified blocks.
• Requirements - Requirements for staying inside the zone and receiving rewards for objectives.
• Grind.Multipliers - Modifiers for objective properties, where 1.0 means 100% (no changes).
• Grind.Renewable-Blocks - Configurations of blocks that are allowed to be mined (broken) inside the zone. The number of configurations is unlimited.

Behavior:
  Permission_Required: false
  PvP-Allowed: false
  Disabled-Block-Interactions:
  - 'minecraft:chest'
  Requirements:
    Mode: ANY_JOB
    List:
      allowed-job-ids: [miner, lumberjack]
      job_level:
        min: 5
        max: 25
  Grind:
    Multipliers:
      XP: 1.0
      INCOME: 1.0
      CONTRACT_POINTS: 1.0
      PROBABILITY: 1.0
    Renewable-Blocks:
      logs: # custom name for block list configuration
        Materials:
        - 'minecraft:oak_log'
        - 'minecraft:spruce_log'
        - 'minecraft:birch_log'
        Fallback_Material: 'stripped_oak_log'
        Reset_Time: 360
        Drop_Items: true

Zone Requirements

With requirements, you can restrict which players can be inside the zone and receive rewards for completing objectives within it.

The following types of requirements are supported by default:

Allowed Jobs

The player must be in the specified jobs.

Name: allowed_jobs

Format: allowed-job-ids: [jobId1, jobId2]

Example:

Requirements:
  List:
    allowed_jobs:
      allowed-job-ids: [miner, lumberjack]

Level

The player's job level(s) must be within the specified boundaries.

Name: job_level

Example:

Requirements:
  List:
    job_level:
      min: 0
      max: 30

Renewable Blocks

Parameters:

• Materials - List of blocks for the current configuration allowed for mining.
• Fallback_Material - The block that replaces mined blocks while they regenerate.
• Reset_Time - The regeneration time for mined blocks in seconds.
• Drop_Items - Determines whether loot will drop from the mined blocks.