Configurations

Feature toggles, cooldowns, warmups, languages, storage, and formatting.

Back to HyEssentialsX Wiki

Table of Contents

Jump to a section

Wiki Home

📌 Overview

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

›

Configuration Overview

HyEssentialsX is built around clean toggles + sensible defaults for modern servers.

Feature Toggles

HyEssentialsX supports enabling/disabling major modules to fit your server style.

Toggleable Features

homes, warps, kits, msg, near, motd, rules, rtp, broadcast, spawn, tpa, adminchat, playershops

Cooldowns & Warmups

Per-command cooldowns + bypass permissions. Warmups supported for /home, /warp, /rtp, /spawn, /back.

Config Files

HyEssentialsX splits config into focused JSON files:

config.json - core settings + toggles
economyConfig.json - economy, rewards, paychecks
rankupConfig.json - rankup tiers, costs, requirements
chatConfig.json - chat, join/leave, MOTD, rules, broadcasts
commands.yml - custom text commands

💵 Paychecks

Time-based paychecks with a default payout and permission-based tiers using: hyessentialsx.paycheck.amount.<amount>.

⬆️ Rankups

Rankups can require playtime, currency, or both. Uses /rankup confirm to prevent accidental payments.

Color Support

Classic: & color codes
Hex: &#RRGGBB
Alt Hex: <#RRGGBB>
Formatting: &l (bold), &o (italic)
Symbol support: §
Supported in config and plugin messages

Spawn Protection

Configurable spawn protection radius with per-action toggles (break/place/damage/interact) and a bypass permission: hyessentialsx.spawn.bypass

🛏️ Sleep Percentage

Configure required sleep percentage in config, or update it live with: /sleeppercent <percent> (alias /sp).

Shops

Player shop settings live under playerShops in config.json:

enabled - toggle player shops
maxShopsPerPlayer - per-player shop limit (0 = unlimited)
shopCreationCost - cost to create a shop NPC
chestLinkRadius - max distance to link storage chests

Admin shop stock limits, money pools, and reset timers are configured per-shop in the admin shop UI.

Storage

HyEssentialsX supports SQLite (default), MySQL/MariaDB, or JSON fallback. For networks, MySQL/MariaDB is recommended.

Storage Types

sqlite, mysql, or json

Language Support

Server default + per-player override: /hyessentialsx language <code> (English fallback + custom language files supported)

Type	Supported
Built-in	English, Chinese (Simplified), Spanish, Hindi, Arabic, Bengali, Portuguese (Brazil), Russian, Japanese, Punjabi, German
Custom	You can add custom language files and use them via language code.