> 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/server-setup/essentialsx.md).

# EssentialsX

What EssentialsX does in this setup, which commands players get, and how it fits with ClickEm.

Files: `plugins/Essentials/config.yml`, `kits.yml`, `worth.yml`, `tpr.yml`, `motd.txt`, `custom_items.yml`, and `userdata/` (one file per player).

The jar is `EssentialsX-FreshSMP.jar`, a build shared with other Lethium setups. In the Clicker setup it is kept **small in scope**: private messages for players, and staff tools. **Most of the gameplay is ClickEm, not Essentials.**

### What players can do

Players get only what LuckPerms gives them (see [LuckPerms](/lethium-docs/server-setup/luckperms.md)). The `default` group has:

| Command               | Permission                         |
| --------------------- | ---------------------------------- |
| `/msg`, `/tell`, `/w` | `essentials.msg`                   |
| `/r`, `/reply`        | `essentials.reply`, `essentials.r` |
| `/msgtoggle`          | `essentials.msgtoggle`             |

Other Essentials commands such as `/home`, `/tpa`, `/kit`, `/nick` or `/pay` **exist but no player has the permission for them** unless you grant it. `/me` is explicitly denied.

To give a player-level command, use LuckPerms, for example `/lp group vip permission set essentials.nick true`. The list of commands Essentials treats as "player commands" is in `player-commands` in `config.yml`.

### Economy

Essentials has its **own** money system (`starting-balance: 0`, `currency-symbol: '$'`). **ClickEm Coins are not Essentials money.**

* Essentials' `/eco` and `/economy` commands are disabled (`disabled-commands`).
* Vault can only use **one** economy at a time. ClickEm can register its Coins as the Vault economy (`integrations.vault.enabled`). If you want other plugins to see Coins, make sure ClickEm's is the one Vault selects and that nothing else provides an economy.
* `/balance` and `/pay` from Essentials would read the Essentials economy. Players use **`/coins`** for ClickEm.

{% hint style="warning" %}
Decide which economy Vault should serve and keep only that. Mixing the two makes `[money]` in chat and any shop plugin show the wrong balance.
{% endhint %}

### Teleporting

| Setting                    | Value                                            |
| -------------------------- | ------------------------------------------------ |
| `teleport-delay`           | 5 seconds standing still                         |
| `teleport-cooldown`        | 5 seconds                                        |
| `teleport-invulnerability` | 4 seconds after arriving                         |
| `teleport-safety`          | on, so players are not put inside blocks         |
| `tpr.yml`                  | Random teleport: excludes ocean and river biomes |

ClickEm has its **own** `/spawn`, `/spawn2` to `/spawn5`, `/warp` (opens the zone menu), `/afk` (goes to the AFK spot), `/fly`, `/hub` and others. See Commands that clash.

### AFK

`auto-afk: 300` marks a player AFK in Essentials after 5 minutes. This is separate from ClickEm's [Anti-AFK](/lethium-docs/gameplay/anti-afk.md) and [AFK pool](/lethium-docs/gameplay/idle-earnings.md).

### Chat, joins and messages

* `custom-join-message: "none"` and `custom-quit-message: "none"` turn off the Essentials join and quit lines (DeathControl also blanks them).
* Chat is formatted by **LPC**, not Essentials. See [Chat](/lethium-docs/server-setup/chat.md).
* `motd.txt` is the `/motd` text. The server list MOTD is in MiniMOTD.

### Selling items

`worth.yml` lists sell prices for `/sell`. Nothing in the Clicker gameplay uses this. Leave it unless you add a shop.

### Kits

`kits.yml` holds Essentials' default example kits (`tools`, `dtools`, `notch`, `color`, `firework`). Nobody can use them without the permission `essentials.kits.<name>`.

### Staff

Staff use Essentials for moderation helpers (`/vanish`, `/tp`, `/invsee`, `/socialspy`, `/mute`). Give them through LuckPerms as needed. `socialspy-commands` lists the private-message commands that socialspy watches.

### Backups

`userdata/` stores homes, mail, mute and nick data per player. Back it up with `plugins/Essentials`.


---

# 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/server-setup/essentialsx.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.
