Installation

How to install HyEssentialsX and verify it is working.

Back to HyEssentialsX Wiki

Table of Contents

Jump to a section

What it is, features, and goals

› 🧰 Installation

Install steps + recommended setup

› ⌨️ Commands

Command list + examples

› 🔐 Permissions

Permission nodes and rank setup

› ⚙️ Configurations

Config options and details

› 🎓 Tutorials

Common setups and how-to guides

› 👤 Author & Support

Contact, bugs, feedback, links

Install Guide

Quick, clean setup — plus storage options for networks.

1) Download

Download the latest HyEssentialsX release from CurseForge.

2) Install the Plugin

Place HyEssentialsX into your server’s mod folder.
Restart the server (recommended over hot reload for first boot).

3) First Boot (Generate Config)

On first startup, HyEssentialsX will generate default config files: config.json, economyConfig.json, rankupConfig.json, chatConfig.json, and commands.yml for Custom Commands.
Stop the server after first boot if you want to edit configs safely before players join.

4) Choose Storage (Recommended)

HyEssentialsX supports multiple storage backends:

Type	Best For	Notes
SQLite	Most servers / simple setup	Default option. Great performance and easiest to maintain.
MySQL / MariaDB	Networks / multiple servers	Best for central storage and scaling. MariaDB supported.
JSON	Fallback / testing	Not recommended for big servers long-term.

5) Verify Everything Works

Join your server and run: /motd, /rules, or /spawn.
Check that messages are formatted correctly and permissions behave as expected.
If something doesn’t work, jump to Author & Support with logs and steps to reproduce.

Tip: If you’re setting up homes/warps for a live network, configure permissions and cooldowns early so you don’t have to rebalance later.