The Legacy Voyage

Tutorials

Practical setup guides for the systems most server owners configure first.

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
 ›
Setup paths Admin commands Common rank patterns

Use these as launch checklists.

These guides focus on what to enable, which permissions matter, and which command or UI opens the system. Exact values should be tuned for your server economy and progression pace.

Set Up Economy

  1. Enable economy.enabled in economyConfig.json.
  2. Set currency name, symbol, decimal places, and starting balance.
  3. Grant players hyessentialsx.balance, hyessentialsx.pay, and hyessentialsx.baltop.
  4. Use /money, /pay, and /baltop to test.
  5. Grant admins hyessentialsx.ecoadmin and hyessentialsx.money.admin.

Build Admin Shops

  1. Enable adminShops.enabled.
  2. Grant players hyessentialsx.adminshop.use.
  3. Grant shop admins hyessentialsx.adminshop.admin.
  4. Create/manage shops through /adminshop and the editor UI.
  5. Use bulk buy/sell quantities to verify stock, price, and stack-limit behavior.

Enable Player Shops

  1. Enable playerShops.enabled and optionally playerShops.directoryEnabled.
  2. Set playerShops.maxShopsPerPlayer, creation cost, and chest link radius.
  3. Grant hyessentialsx.playershop.use, hyessentialsx.playershop.create, and hyessentialsx.playershop.delete.
  4. Use /shop to open the directory and create shops.
  5. Link containers for real stock and test buy/sell quantities.

Launch Auction House

  1. Enable economy, then enable auctionHouse.enabled.
  2. Set default listing time, max listing time, max listings, and listing cost.
  3. Grant hyessentialsx.auctionhouse.use and hyessentialsx.auctionhouse.sell.
  4. Use rank perks like hyessentialsx.auctionhouse.listings.25 and hyessentialsx.auctionhouse.duration.72.
  5. Place NPCs with /auctionhouse npc spawn using hyessentialsx.auctionhouse.admin.

Create Rank Progression

  1. Enable playtime and rankup systems in rewardsConfig.json.
  2. Define requirements using playtime, money, or both.
  3. Grant players hyessentialsx.playtime and hyessentialsx.rankup.
  4. Use /playtime, /rankup, and /rankup confirm.
  5. Use admin tools with hyessentialsx.playtime.admin.

Use Stats and Leaderboards

  1. Enable stats.enabled.
  2. Grant hyessentialsx.stats and hyessentialsx.leaderboard.
  3. Use /stats to inspect player stats.
  4. Use /leaderboard for default boards or /leaderboard player_kills for a specific stat.
  5. Give staff/devs hyessentialsx.leaderboard.exempt to keep them off boards.

Add Respawn Protection

  1. Enable respawnInvulnerability.enabled.
  2. Set different values for bedSeconds and worldSeconds.
  3. Enable cancelOnAttack if protected players should lose protection when fighting.
  4. Test bed respawn and no-bed/world respawn separately.

Expand the World Border Over Time

  1. Enable worldBorder.enabled.
  2. Set center and starting radius.
  3. Enable worldBorder.expansion.enabled.
  4. Set amount, intervalSeconds, and maxRadius.
  5. Use /worldborder status to verify live state.

Migration Checklist

Use this before importing data from another essentials plugin.

1. Back Up

Back up the server and the source plugin data. Test imports on a copy first.

2. Pick Storage

Set HyEssentialsX storage before importing so data lands in the backend you plan to use.

3. Import

Use the import/migration command path, then verify homes, warps, balances, and playtime in-game.