Getting Started

Getting Started

This guide will help you install and configure EliteEssentials on your Hytale server.

Server Compatibility

EliteEssentials 2.0.8 and newer are built for Hytale Update 5 (server 0.5.1) and accept any 0.5.x server via a SemverRange (^0.5.1). Older 2.0.x builds will fail on an Update 5 server with NoSuchMethodError because of breaking API changes in the network and ECS layers, so update the plugin alongside your server. If you are still on a pre-Update 5 server, stay on the matching older plugin build until you upgrade.

Installation

Step 1: Download

Download the latest version of EliteEssentials from CurseForge.

Step 2: Install

Place the EliteEssentials.jar file into your server's mods folder:

your-server/
  mods/
    EliteEssentials.jar

Step 3: First Start

Start your server. EliteEssentials will automatically:

• Create the mods/EliteEssentials/ data folder
• Generate a default config.json with sensible defaults
• Create empty data files for warps, spawn, and other features
• Create the players/ folder for per-player data

Step 4: Configure

Edit mods/EliteEssentials/config.json to customize the mod to your needs. See the Configuration page for all available options.

Step 5: Reload

After making changes to the configuration, you can apply them without restarting the server:

/eliteessentials reload

File Structure

After installation, EliteEssentials creates the following file structure:

mods/
  EliteEssentials/
    config.json           - Main configuration file
    messages.json         - All customizable messages
    warps.json            - Server warp locations
    spawn.json            - Per-world spawn locations
    kits.json             - Kit definitions
    motd.json             - Message of the Day content
    rules.json            - Server rules content
    discord.json          - Discord info content
    autobroadcast.json    - Auto broadcast configuration
    groupchat.json        - Group chat channels
    aliases.json          - Command aliases
    activity_log.json     - Admin action audit log
    playtime_rewards.json - PlayTime reward definitions
    players/              - Per-player data folder
      <uuid>.json         - Individual player data files

Default Configuration

On first run, EliteEssentials generates a configuration with these defaults:

Feature	Default Value
Max Homes	3 per player
RTP Range	100-5000 blocks
RTP Cooldown	30 seconds
TPA Timeout	30 seconds
Warmup Time	3 seconds (most commands)
Sleep Percentage	50%
Advanced Permissions	Disabled (Simple Mode)
Economy	Disabled
Spawn Protection	Disabled
Mail System	Enabled
PlayTime Rewards	Disabled

Verifying Installation

To verify EliteEssentials is working correctly:

1. Join your server
2. Run /eehelp to see available commands
3. Run /homes to see your home list (should be empty)
4. Run /sethome test to create a test home
5. Run /home test to teleport to it
6. Run /delhome test to clean up

If all commands work, the installation is successful.

Essential First Steps

1. Set Server Spawn

As an admin, go to where you want spawn to be and run:

/setspawn

This sets the spawn point for /spawn and enables spawn protection (if configured).

2. Create Warps

Create useful warps for your server:

/warpadmin create shop
/warpadmin create arena
/warpsetdesc shop Welcome to the server shop!

3. Create a Starter Kit

Hold the items you want new players to receive, then:

/kit create starter 0 yes

This creates a one-time kit that new players automatically receive on first join.

You can also add commands to kits by editing kits.json directly. Add a "commands" array to run server commands when the kit is claimed:

"commands": ["eco add {player} 100", "broadcast Welcome {player}!"]

4. Configure MOTD

Edit mods/EliteEssentials/motd.json to customize your welcome message:

{
  "lines": [
    "",
    "&e&lWelcome to My Server, {player}!",
    "&7Type &a/help &7for commands.",
    ""
  ]
}

5. Set Up Rules

Edit mods/EliteEssentials/rules.json:

{
  "lines": [
    "&c&l=== Server Rules ===",
    "&a1. &7Be respectful",
    "&a2. &7No cheating",
    "&a3. &7Have fun!"
  ]
}

Setting Up Permissions

Simple Mode (Default)

No setup required! Commands work based on:

• Everyone - All players can use basic commands
• Admin - OP players can use admin commands

Advanced Mode (LuckPerms)

1. Set "advancedPermissions": true in config.json
2. Run /ee reload
3. Set up permissions using LuckPerms

See the LuckPerms Setup Guide for ready-to-use commands.

Enabling Optional Features

SQL Database Storage

EliteEssentials supports three storage backends. By default, JSON files are used. To switch to SQL:

SQLite (Embedded, zero setup):

"storage": {
  "storageType": "sqlite"
}

MySQL/MariaDB (Multi-server):

"storage": {
  "storageType": "mysql",
  "mysql": {
    "host": "localhost",
    "port": 3306,
    "database": "eliteessentials",
    "username": "root",
    "password": ""
  }
}

After switching, restart the server and run /eemigration sql to transfer existing JSON data. Then /eemigration cleanup to archive the old JSON files. See Data Storage for details.

Economy System

1. Edit config.json:

"economy": {
  "enabled": true,
  "currencyName": "coin",
  "startingBalance": 100.0
}

2. Run /ee reload
3. Players can now use /wallet, /pay, /baltop

Spawn Protection

1. Set spawn with /setspawn
2. Edit config.json:

"spawnProtection": {
  "enabled": true,
  "radius": 50,
  "disablePvp": true
}

3. Run /ee reload

PlayTime Rewards

1. Edit config.json:

"playTimeRewards": {
  "enabled": true
}

2. Edit playtime_rewards.json to define rewards
3. Run /ee reload

Updating

To update EliteEssentials:

1. Stop your server (recommended) or prepare for a reload
2. Replace the old JAR file with the new version
3. Start the server or run /eliteessentials reload

Your configuration and data files are preserved during updates. New configuration options are automatically added with default values.

Troubleshooting

Commands Not Working

• Ensure the mod is in the correct mods folder
• Check server logs for error messages
• Verify the command is enabled in config.json

Permission Denied

• In Simple Mode, check if the command requires Admin access
• In Advanced Mode, verify the player has the correct permission node
• Admins need eliteessentials.admin.* or OP status

Configuration Not Loading

• Validate your JSON syntax (use a JSON validator)
• Check for missing commas or brackets
• Review server logs for parsing errors

LuckPerms Not Detected

• Ensure LuckPerms is installed and loaded
• Check server logs for LuckPerms registration messages
• EliteEssentials retries detection for 10 seconds on startup

Next Steps

• Commands - Learn all available commands
• Configuration - Customize every aspect of the mod
• Permissions - Set up permission-based access control
• LuckPerms Setup - Ready-to-use permission commands