Getting Started

Getting Started

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

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 homes, warps, and back locations

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
    homes.json          - Player home locations
    warps.json          - Server warp locations
    back.json           - Player back locations
    spawn.json          - Per-world spawn locations
    kits.json           - Kit definitions
    kit_claims.json     - Kit claim tracking
    motd.json           - Message of the Day content
    rules.json          - Server rules content
    discord.json        - Discord info content
    autobroadcast.json  - Auto broadcast configuration
    aliases.json        - Command aliases
    players.json        - Player data cache (economy, play time)
    first_join.json     - First join tracking

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

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.

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.

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

Next Steps

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