> For the complete documentation index, see [llms.txt](https://lethium.gitbook.io/lethium-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lethium.gitbook.io/lethium-docs/gameplay/zones.md).

# Zones

How zones, worlds, unlock requirements and zone borders work, and how to edit them.

A **zone** is one fighting area: a WorldGuard region with its own mobs. The game has five worlds (`World1` to `World5`) with 24 zones each, plus one boss arena per world. Players unlock zones one by one, and each zone pays more than the last.

Files: `plugins/ClickEmCore/modules/zones.yml`. Module id: `zones`. Commands: `/zones`, `/clickem zones`.

{% hint style="success" %}
**Quick start**

* Change a zone's price: `requirements.min-currency` in `zones.yml`.
* Sell a zone with a permission: `required-permission`.
* Rename a zone: its key in `lang/en_us.yml`.
* Unlock one for a player: `/ceadmin zones grant <player> <zone>`.
* Reload: `/clickem module reload zones`.
  {% endhint %}

### What a player sees

* Every locked zone has a **landmark hologram** at its entrance with what lives there, how their element matches up, what it pays, and a checklist of requirements. The closer they walk, the more detail it shows.
* A **border** stops them walking into a zone they have not unlocked. It pushes them back and denies teleports into it. A particle curtain marks it.
* `/zones` (or `/clickem zones buy`) opens the unlock menu with one confirm button.
* Staff with `clickem.zones.bypass` walk through every border.

### How a zone is unlocked

Each zone lists its gates under `requirements:`. **Every gate that is set must be met.**

| Key                    | Meaning                                                                                                                         |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `min-currency`         | Coins the player pays to unlock.                                                                                                |
| `min-level`            | Profile Level needed.                                                                                                           |
| `min-rebirth`          | Rebirths needed. World 2's first zone needs 1, World 3's needs 3, and so on (see [Rebirth](/lethium-docs/gameplay/rebirth.md)). |
| `required-zone`        | The zone that must be unlocked first.                                                                                           |
| `required-permission`  | A permission node. Good for selling a zone or giving it to a rank.                                                              |
| `required-achievement` | An achievement id that must be unlocked.                                                                                        |

Leave a gate as `0` or `""` to not use it.

### One zone entry

```yaml
zones:
  w1_zona2:
    world: World1
    regions: [zona2]
    display-name: "clickem.zones.w1_zona2.name"
    requirements:
      min-currency: 1500
      min-rebirth: 0
      min-level: 1
      required-zone: "w1_zona1"
      required-permission: ""
      required-achievement: ""
    allowed-mobs: [W1Z2f1, W1Z2f2, W1Z2f3]
    hologram:
      title: "clickem.zones.w1_zona2.hologram"
      x: 764.5
      y: 131
      z: 552.5
      scale: 4
```

| Key             | Meaning                                                                                                                        |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `world`         | The Minecraft world folder name.                                                                                               |
| `regions`       | The WorldGuard region ids that make up the zone.                                                                               |
| `display-name`  | A language key, resolved in `lang/en_us.yml`. You can also put plain text.                                                     |
| `allowed-mobs`  | Only these MythicMobs pay out in this zone. A mob not listed here pays nothing.                                                |
| `hologram`      | Where the landmark panel floats. `title` is a language key.                                                                    |
| `rebirth.kills` | (Last zone of each world) how many kills in this zone are needed to rebirth. See [Rebirth](/lethium-docs/gameplay/rebirth.md). |

The order of the `zones:` list matters. It is the progression order, the order in the teleport menu and the order used for tooltip rarity, which runs from Common (first) to Ancient (last).

### Settings at the top of the file

| Key                                           | What it does                                                                                                                                                           |
| --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `presentation.hologram.enabled`               | Show the landmark panels.                                                                                                                                              |
| `presentation.hologram.preview.*`             | Distances where more detail appears, the panel text size, direction and height.                                                                                        |
| `presentation.border.enabled`                 | The walls that block locked zones.                                                                                                                                     |
| `presentation.border.particle` and `distance` | Border particle and how far away it shows.                                                                                                                             |
| `farm-window.zones`                           | Anti-farm. Rare drops (Echoes, Roll Fragments, pet tickets, Essence) only drop in the player's latest N unlocked zones. Coins and XP pay everywhere. `0` turns it off. |
| `gui.unlock.*`                                | Rows, slot and icons of the unlock menu.                                                                                                                               |

### How to

{% tabs %}
{% tab title="Change a zone's price" %}
Edit `requirements.min-currency` of that zone, then run `/clickem module reload zones`. Zones already bought stay bought.
{% endtab %}

{% tab title="Sell a zone with a rank or permission" %}
Set `required-permission: "clickem.zone.vipzone"` (any node name) on the zone. Give the node through LuckPerms: `/lp group vip permission set clickem.zone.vipzone true`. Players without it see the permission item unticked on the hologram.
{% endtab %}

{% tab title="Let a rank skip a gate" %}
Gates are the same for everyone. To skip them for one player, use `/ceadmin zones grant <player> <zone>`. For staff, give `clickem.zones.bypass`.
{% endtab %}

{% tab title="Rename a zone" %}
Open `lang/en_us.yml`, search for `clickem.zones.<zone id>.name` and change the text. Run `/clickem reload`.
{% endtab %}

{% tab title="Move the landmark hologram" %}
Change `hologram.x`, `y` and `z` of the zone. Reload the module.
{% endtab %}
{% endtabs %}

### Zone permissions

ClickEm automatically gives every player the permission `clickem.zone.<zone id>` for each zone they own (and all of them with `clickem.zones.bypass`). Other plugins can use this. The setup's ExcellentCrates star crates use it to lock rewards by zone. See [Crates](/lethium-docs/server-setup/excellentcrates.md).

### Staff commands

| Command                                                      | Use                                                                                       |
| ------------------------------------------------------------ | ----------------------------------------------------------------------------------------- |
| `/ceadmin zones grant <player> <zone or all>`                | Unlock.                                                                                   |
| `/ceadmin zones revoke <player> <zone or all>`               | Re-lock.                                                                                  |
| `/clickem zones list`                                        | List every zone.                                                                          |
| `/clickem zones deploy <template> [gridX] [gridZ] [spacing]` | Paste a zone arena template (needs FastAsyncWorldEdit). Location-relative, typed in game. |

### Placeholders

`%clickem_zone_id%`, `%clickem_zone_name%`, `%clickem_zone_unlocked_count%`, `%clickem_zone_total%`, `%clickem_zone_next_name%`, `%clickem_zone_next_cost%`, `%clickem_zone_can_unlock%`, `%clickem_zone_next_blocked_by%`, `%clickem_zone_progress_percent%`. Full list on the [zone placeholders](/lethium-docs/placeholders/zones.md) page.

### Adding a whole new zone

See [Add a zone](/lethium-docs/how-to/add-a-zone.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://lethium.gitbook.io/lethium-docs/gameplay/zones.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.