# uxmEssentials **The all-in-one essentials suite for modern Paper servers Homes, Economy, Kits, Vaults, Moderation, a Staff Mode, Holograms, NPCs, Worlds, Ranks, cross-server Trade, and 24 more, in one cohesive plugin.** [![Read the Documentation](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/documentation/gitbook_vector.svg)](https://docs.uxplima.com/minecraft/plugins/uxmessentials/getting-started/welcome/) [![Chat with us on Discord](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/social/discord-plural_vector.svg)](https://discord.gg/uxplima) [![See us on GitHub](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/social/github-plural_vector.svg)](https://github.com/UXPLIMA/uxmEssentials) ![Available for Paper](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/supported/paper_vector.svg) ![Available for Purpur](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/supported/purpur_vector.svg) ![Available for Velocity](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/supported/velocity_vector.svg) [![Available on Modrinth](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/available/modrinth_vector.svg)](https://modrinth.com/plugin/uxmessentials) [![Available on Hangar](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/available/hangar_vector.svg)](https://hangar.papermc.io/UXPLIMA/uxmEssentials) ![Built with Java 25](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/built-with/java25_vector.svg) **Paper 26.2+ · Folia ready · 35 modules · one config style, one message system, one permission scheme, one database**

## One plugin instead of a patchwork of ten uxmEssentials replaces the stack of separate plugins most servers glue together an essentials core, an economy, a kit plugin, a vault plugin, a moderation toolkit, a hologram plugin, an NPC plugin, a multi-world manager with **one cohesive suite**. Every feature shares the same configuration style, the same message system, the same permission scheme, and the same database, so your server behaves predictably instead of like a patchwork of plugins that each do things their own way. It is built **Paper 26.2 only, on purpose** the current API used the way it is meant to be, **Folia-ready from line one**, with economy balances and player vaults stored in a real database so they survive world rollbacks. And the best part: every module ships with an **in-game management GUI**. You configure holograms, NPCs, warps, vaults, and punishments by clicking not by editing files and restarting. ## Why uxmEssentials - **Genuinely modular.** 35 feature modules, each toggled on its own. A disabled module wires nothing: no commands, no listeners, no database tables, no overhead. Run only what you need. - **Configure in-game.** Every module has a management GUI from `/uxmess gui`. Every screen in the plugin renders through one data-driven menu engine, so the grids, slots, and icons are themselves config values. - **Build your own menus.** Beyond the built-in screens, `/menu` loads operator-authored menu files from `menus/*.conf` and opens them with `/menu open ` the same engine, a generic action vocabulary, custom GUIs without code. - **Nothing hardcoded.** Every player-facing string lives in a per-locale catalog; every command can be renamed, aliased, or disabled; every layout, cost, cooldown, and limit is a config value. - **Twelve languages out of the box.** English, Turkish, German, Russian, Spanish, Brazilian Portuguese, French, Polish, Ukrainian, Simplified Chinese, Japanese, and Korean, all editable on disk. A player picks their own with `/lang`; a line a translation is missing falls back to the English wording. - **Rollback-proof data.** Balances and vaults live in the database never in item NBT so a world rollback never duplicates money or items. - **Folia-ready.** Nothing schedules through the legacy scheduler; work is dispatched to the correct region thread. The same code runs unchanged on Paper and Folia. - **Adventure-native.** All text is MiniMessage through one shared theme no legacy colour codes anywhere. ## What's inside 35 modules

Player essentials homes, warps, player-warps, teleport

- **Homes** a slot-based GUI: click an empty cell to set a home, click a home to teleport / rename / relocate / re-icon. Home visibility + invites (`/visit`, `/invite`), an optional economy charge, a death-respawn chain (home, bed, spawn), unsafe / blacklisted-world guards, and land-claim gating across nine providers (Lands, GriefPrevention, uxmClaims, and more). - **Warps** per-warp cost, permission, password lock, welcome message, warmup / cooldown overrides, departure / arrival sounds and particles, and a rating system. - **Player-warps** player-owned warps with per-rank quotas, public / private visibility, password locks, visitor counts, and custom icons. - **Teleport** `/tpa`, `/tpahere`, `/back`, `/rtp` (a pre-warmed safe-search queue, so random teleports are instant), `/spawn`, move-cancels-warmup, per-rank cooldowns, and configurable arrival effects.

Economy and progression economy, kits, vaults, ranks, trade

- **Economy** a serious, multi-currency, database-backed economy: `/pay`, `/balance`, a cached `/baltop`, shared banks with interest, a loan system, a currency exchange, physical banknotes (anti-dupe), per-command costs, salary and daily rewards. Registers with Vault / Treasury or runs on its own native ledger. - **Kits** far beyond items on a cooldown: categories, per-rank variants, one-time and first-join grants, costs, requirements, a typed action engine (titles, sounds, particles, commands), rotation and scheduled availability, global stock, buy-to-unlock, and a full editor GUI. - **Vaults** database-backed player storage (survives rollbacks) with per-player vault counts and per-vault sizes via quota nodes, an item blacklist, per-vault name and icon, overflow rescue, and inactive-vault purge. - **Ranks** `/rankup`, `/prestige`, and autorank driven by configurable command-actions (or LuckPerms groups + permission nodes), with economy costs, placeholder requirements, a prestige loop, and a `/ranks` GUI. - **Trade** a secure player-to-player trade window (`/trade`): both sides stake items and money, both confirm, and any change resets the confirmation (anti-scam). Multi-currency, an item blacklist, request / accept flow, distance and cooldown limits, an audit log, and **cross-server trading** between backends that share a database.

Survival and gameplay survival, poses, villagers

- **Survival** a grab-bag of survival mechanics, each independently toggled and permissioned (several player-toggleable by command): tree-feller (`/treefeller`), veinminer (`/veinminer`), fast-leaf-decay, farm protection (`/farmprotect`), farm assist (auto-replant), one-player-sleep, head drops, and auto-pickup / auto-smelt / auto-sell / auto-tool. - **Poses** sit, sit-on-players, lay, belly-flop, spin, and crawl, with region / WorldGuard gating, a settings GUI, and cooldowns. - **Villagers** infinite trading, restock timers, a trade manager, trade disabling, villager protection, villager-in-a-bucket, follow and leash, instant restock, and click-to-trade.

Staff and security moderation, staff mode, vanish, inventory rollback, security, command control

- **Moderation** bans, IP-bans, temp-bans, mutes, kicks, warns, jails, with silent sanctions, duration tiers, warn escalation, alt detection, IP history, punishment templates, staff analytics + Discord notifications, and a unified `/history`, `/checkban`, `/checkmute` plus a management GUI and a LiteBans importer. - **Staff Mode** a dedicated mode: toggle with loadout swap, examine, freeze, follow, navigator, staff chat, an online-staff list, alerts, flight, sanction rollback, server lockdown, and targeted socialspy. - **Vanish** packet-level invisibility over the in-house packet layer: fake join / quit, silent chest / shulker / ender-chest access, an item-pickup toggle, night-vision and flight, layered see / interact levels, an action-bar indicator, `/vanish list`, mob-targeting suppression, cross-server + Folia. - **Inventory rollback** snapshots every death and logout (main, armor, offhand, ender-chest) with a configurable retention window; `/invrestore` opens a GUI of a player's past snapshots to restore from. - **Security** server-side account security (no login/auth): two-factor with a PIN GUI or TOTP (`/2fa`, `/pin`), op-command protection, same-IP alt detection (`/ipalts`), and client-brand detection / blocking. Secrets are database-hashed. - **Command control** command whitelisting, tab-completion filtering, plugin-list hiding (`/plugins`, `/pl`, `/?`, `/help`), a custom unknown-command message, and `namespace:command` bypass blocking permission-driven, with Geyser / Folia / cross-server support. It works transparently, with no command of its own.

Chat and social messaging, communication, presence, player-state

- **Messaging** private messages (`/msg`, `/r`), a mailbox with offline fallback and `/mail sendall`, AFK notices, and a per-player ignore list. - **Communication** public chat formatting (LuckPerms prefix / suffix + MiniMessage + PlaceholderAPI), per-cause death messages, per-rank join messages, a first-join welcome and MOTD, a killer-weapon placeholder, plus multi-channel scheduled announcements (conditional, with placeholders), broadcasts, clear-chat, custom advancement notifications, and data-driven `/info`, `/rules`, `/discord` pages. - **Presence** nicknames, presence status, and display-name management. - **Player-state** gamemode, heal, feed, fly, god, speed, plus offline-capable `/invsee` and `/endersee`.

Visual and engagement holograms, NPCs, scoreboard, tablist, nametags, vote, skins

- **Holograms** Display-entity holograms: multi-line, multi-page (per-viewer click-to-cycle), provider-driven leaderboards, click-action chains, inline animations, per-player visibility and blacklists, glow and opacity, link-to-NPC follow, plus FancyHolograms / DecentHolograms importers. - **NPCs** packet-based NPCs over an in-house packet layer: players, mobs, and display entities; skins by name / MineSkin / URL; click-action chains; equipment, glow, poses, deep per-type variants; per-owner quotas and a command blocklist. - **Scoreboard** per-player, condition-selected sidebars by priority, with animated and conditional lines and hidden score numbers. - **Tablist** per-player tab name formatting and sorting, animated header / footer, fixed-slot layouts with filler. - **Nametags** above-head display-entity nametags, per-viewer and vanish-aware. - **Vote** a full vote-rewards engine: Votifier intake, totals and a leaderboard, a cross-server vote party with escalation, streaks, per-site cooldowns and reminders, multi-channel broadcasts, and Discord webhook notifications. - **Skins** `/skin `, `/skin url`, `/skin clear`: a player wears any account's skin or an image you host, and it survives a rejoin. MineSkin signs the uploads, Bedrock players keep the skin Geyser knows them by, a per-source switch and a blocklist say what is allowed, and the module ships off.

World and utility worlds, regions, itemworld, server tweaks, discord-link, custom menus

- **Worlds** a full multi-world manager: create / import / delete (confirm-staged), per-world properties and gamerules, built-in void and flat generators, access gating with economy entry fees, cross-world portals, a world-editor GUI, pre-generation, backup / restore, and idle auto-unload. - **Regions** a WorldGuard region-management GUI: list, create (two-position selection), edit flags, manage members / owners, and set priority. WorldGuard is a soft-dependency; without it the module stays inert. - **Itemworld** the everyday utility surface: an `/itemedit` editor (rename, lore, enchants, flags, attributes, durability, custom-model-data, unbreakable), open-shulker-from-inventory, virtual workstations (anvil, crafting, and more, anywhere), powertool, mob and entity tools, time / weather aliases, inventory cleanup, and admin-fun each an independently disableable sub-group. - **Server tweaks** small opt-in infrastructure toggles: a custom F3 server brand, console-spam filtering, no-chat-reports, and SignedVelocity coordination. Each ships off. - **Discord-link** link a Minecraft account to Discord, sync roles, and push audit / economy notifications (with the Discord add-on). - **Custom menus** build your own GUIs over the built-in menu engine: drop a `menus/.conf` file and open it with `/menu open `, using a generic action vocabulary (close, open another menu, run a command, send a message). No code; the privileged console action is gated off by default.

## Configure it all in-game `/uxmess gui` opens a hub linking to every module's editor. Entity modules (holograms, NPCs, warps, vaults, moderation, regions) get a list, then an editor pick an entity, then flip its properties with toggles, steppers, text / number / enum editors, a colour picker, and list editors. Settings modules get a panel of switches. Under the hood it is all one **data-driven menu engine**: every screen including the GUI that opens when you run a bare command like `/eco`, `/jail`, or `/list` is a spec plus type-safe bindings, behind a single window holder and listener with no per-menu code. So you can re-skin every screen without touching code, and operators can build entirely new menus of their own with `/menu`. ## Permissions and placeholders you can look up Both are declared once inside the plugin and checked against the running code on every build, so the published reference is generated rather than remembered. - **508 permission nodes**, each with its description, its default and its shape (fixed, quota, tier, label). Delegation goes all the way down to the capability: `/npc create` apart from `/npc delete`, `/bank deposit` apart from `/bank withdraw`, `/heal ` apart from `/gamemode `. `/uxmess permissions` lists them in game and `/uxmess permissions export` writes them to a file. - **338 PlaceholderAPI keys**, covering every module plus the player themselves: health, ping, playtime, coordinates, biome, the item in hand, the whole vanilla statistic family, any cooldown by label, formatting helpers, `p__` for somebody else, and the relational `rel_` form for per-viewer formats. `/uxmess placeholders` lists them and `/uxmess placeholders export` writes them out. Full lists: [permission reference](https://docs.uxplima.com/minecraft/plugins/uxmessentials/permissions/reference/) and [placeholder reference](https://docs.uxplima.com/minecraft/plugins/uxmessentials/placeholders/reference/). ## For developers uxmEssentials publishes a developer API you compile against like any other library, with javadocs and a versioned coordinate. - **Events** ninety-odd of them, covering everything the plugin does, plus nine you can cancel before they happen. - **Query API** ask what is true right now: homes, balances, punishments, playtime, who is away, across twenty-seven contexts. - **Action API** change it: set a home, pay a player, hand over a kit, ban somebody, across twenty-three contexts. - **Menu API** teach the GUI engine your own actions, requirements, placeholders, list sources, and icons. - **REST add-on** the same reach over HTTP and WebSocket, for the programs that are not plugins. The published surface is written down and compared on every build, and a sample consumer plugin is compiled in CI against the artifacts each commit publishes, so a removed method or a broken coordinate fails on the commit that broke it rather than on somebody's server months later. Full reference at [docs.uxplima.com](https://docs.uxplima.com/minecraft/plugins/uxmessentials/developer/overview/). ## Migrating in? One command. `/uxmess import ` runs a one-shot, **idempotent** migration with a dry-run preview and a documented conflict policy: | Source | Imports | |---|---| | **EssentialsX** | homes (into the slot model), warps, kits, economy | | **FancyHolograms / DecentHolograms** | holograms | | **LiteBans** | bans, IP-bans, mutes, warns | | **Vault / PlayerPoints** | economy balances | ## Requirements | | | |---|---| | **Server** | Paper **26.2** (or a Paper fork Folia / Purpur / Pufferfish) | | **Java** | **25** | | **Database** | SQLite by default (zero setup). MySQL, MariaDB, and PostgreSQL optional. | | **Optional** | PlaceholderAPI, Vault / Treasury, LuckPerms, WorldGuard, a Votifier listener all auto-detected. | > Spigot and CraftBukkit are **not** supported uxmEssentials uses `paper-plugin.yml`, Brigadier, and bundled Adventure. Clients on older versions can still connect through a server-side ViaVersion. ## Getting started 1. Drop `uxmEssentials-0.8.0.jar` into your server's `plugins/` folder and start the server. 2. Config is generated per module under `plugins/uxmEssentials/modules/`. Toggle any module from its `config.conf`. 3. Run `/uxmess doctor` to confirm the database, economy provider, and integrations are healthy. 4. Migrating? Try `/uxmess import essentialsx` (dry-run first). The admin root is `/uxmess` (aliases `/uxe`, `/uxmessentials`). **Optional companion jars** - **[uxmEssentials-velocity](https://hangar.papermc.io/UXPLIMA/uxmEssentials-Velocity)** a Velocity proxy broker that syncs homes, warps, economy, vaults, trade, vanish, and more across a network. - **[uxmEssentials-redis](https://hangar.papermc.io/UXPLIMA/uxmEssentials-Redis)** the same cross-server sync over Redis pub/sub, with no proxy required. - **[uxmEssentials-discord](https://hangar.papermc.io/UXPLIMA/uxmEssentials-Discord)** a JDA bridge for account linking and audit / economy notifications. - **[uxmEssentials-rest](https://hangar.papermc.io/UXPLIMA/uxmEssentials-REST)** an HTTP and WebSocket API for panels, bots, and scripts that are not plugins. You only need the main jar to get started; add the companions when your setup calls for them. ## Documentation and support

[![Read the Documentation](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/documentation/gitbook_vector.svg)](https://docs.uxplima.com/minecraft/plugins/uxmessentials/getting-started/welcome/) [![Chat with us on Discord](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/social/discord-plural_vector.svg)](https://discord.gg/uxplima) [![See us on GitHub](https://raw.githubusercontent.com/intergrav/devins-badges/v3/assets/cozy/social/github-plural_vector.svg)](https://github.com/UXPLIMA/uxmEssentials/issues)

The documentation carries an install guide, a page per module with its commands, permissions, settings and placeholders, the full permission and placeholder references, and the developer API. Ask on Discord when a page does not answer it; open an issue when something is broken. `/uxmess doctor` and your server log are the fastest path to a fix. ## Notes uxmEssentials is open source (GPL-3.0) and under active development. Feature requests and feedback are genuinely welcome, and every release is written up on the changelog tab before it lands here.

uxmEssentials

0.8.0

0.7.0

0.6.0

0.5.2

0.5.0

0.4.0

0.2.0