Installation

Requirements, the first start, the files you get, and how to verify the install.

uxmEssentials needs Paper 26.2 or newer on Java 25. Folia is supported: every scheduled task goes through Folia-safe schedulers. Older Bukkit and Spigot builds are not supported. An older server refuses to load the jar and says so at startup, rather than starting and failing later on a method it does not have.

Install

Download the uxmEssentials jar. That one jar is the whole plugin.
Put it in plugins/.
Start the server once. The first start creates the data folder, applies the database migrations and writes every config file.

[uxmEssentials] Enabling uxmEssentials...
[uxmEssentials] Database migrations applied
[uxmEssentials] 25 of 35 feature modules enabled
[uxmEssentials] uxmEssentials enabled!

Storage is SQLite by default, in plugins/uxmEssentials/data/. There is nothing to install and nothing to configure. MySQL, MariaDB and PostgreSQL are for networks; see Database.

What the first start writes

plugins/uxmEssentials/
├── config.conf     globals: storage, locale, network, claims, links
├── modules/        one folder per module, each with its own config.conf
├── messages/       player-facing text per language, in MiniMessage
├── commands/       rename, alias or disable any command
├── menus/          your own menus
└── data/           the SQLite database

Files are HOCON, not YAML. An update adds its new keys and keeps your values, and a key you delete falls back to its default. See Core Concepts.

Verify

Command	What it tells you
`/uxmess status`	Every module and whether it is enabled
`/uxmess doctor`	Health checks: database, economy provider, soft-depends, threading, data integrity
`/uxmess help`	The admin subcommands

The admin root is /uxmess, with the aliases /uxmessentials and /uxe. A clean /uxmess doctor means the install is done.

One of those checks reads the whole database looking for rows whose owner is gone, which an interrupted import or a hand-edited database can leave behind. If it reports any, /uxmess doctor repair shows you what would be removed without touching anything, and /uxmess doctor repair confirm does it, inside a transaction that rolls back on failure. Only unambiguous orphans are deleted; a record pointing at a world that is currently missing is reported and kept, because restoring that world makes it valid again. The confirming half needs uxmessentials.admin.doctor.repair.

Companion jars

These are optional and only matter on a network.

Jar	Install on	What it adds
`uxmessentials-velocity`	The Velocity proxy	Cross-server sync of homes, warps, economy and more
`uxmEssentials-redis`	Backend servers	The Redis transport for the same sync
`uxmessentials-discord`	One backend server	The Discord bridge for audit and economy notifications

Installing one changes nothing on its own. Cross-server sync stays off until you enable it in config.conf; see Cross-Server.

If something is missing

A command that does nothing usually belongs to a disabled module. Run /uxmess status, set enabled = true in that module's config.conf, then /uxmess reload <module>.

A plugin that fails to load is almost always a Java version below 25. Check with java -version.

Was this page helpful?