Installation

HyEssentialsX generates its config and data folders on first server start. The safest setup flow is to boot once, stop cleanly, adjust config files, then start again and verify commands in-game.

1. Install the Plugin

Place the HyEssentialsX plugin jar in your server plugin/mod location for Hytale.
Start the server once so the plugin can create default files.
Stop the server cleanly before editing generated config files.

2. Check Generated Files

mods/HyEssentialsX/config.json

mods/HyEssentialsX/economyConfig.json

mods/HyEssentialsX/rewardsConfig.json

mods/HyEssentialsX/chatConfig.json

mods/HyEssentialsX/scoreboardConfig.json

mods/HyEssentialsX/commands.yml

3. Pick Storage

Leave storage.type on SQLite for most servers. Use MySQL/MariaDB or MongoDB only when you need remote/shared storage.

Persistent plugin data should live in the selected backend. Avoid hand-editing generated database or storage files while the server is running.

4. Assign Permissions

For a rank-based server, enable your permission system and assign the default player permissions from the Permissions page.

Use admin nodes only for trusted staff. Auction listing and duration nodes can be used as rank perks.

Recommended First Checks

Run these after the server starts with your edited config.

Core

/hyessentialsx info /hyessentialsx reload /list

Player Flow

/sethome base /home base /warp

Economy and UI

/money /baltop /auctionhouse

Migration Notes

Only run migrations when you have source data from another plugin.

HyEssentialsX includes migration tooling for several essentials, homes, warps, economy, and playtime plugins. Make a backup before importing and test on a copy of the server first. Supported sources are listed on the Overview and Tutorials pages.

Do not manually copy compiled development jars into the local server runtime unless your build/deploy process explicitly calls for it. Let your normal Hytale server/plugin workflow load the plugin.