GameServerGuides
    🎮Hytale Server Guide

    Server Settings Wiki

    Complete reference guide for configuring your Hytale dedicated server. Understand every config.json setting and server command.

    22 Settings
    •
    config.json
    •
    43 Commands
    Config BuilderAll Hytale Guides

    Hytale Server Authentication Required

    Hytale servers require authentication with your Hytale account. Each account can create up to 100 servers. Use the /auth login device command in the server console to authenticate.

    Server

    Server Name

    serverName

    The display name of your Hytale server shown in the server browser and connection screens.

    Type: string
    Default: "My Hytale Server"

    Maximum Players

    maxPlayers

    The maximum number of players that can be connected to your server simultaneously.

    Type: number
    Default: 16
    Min: 1
    Max: 100

    Server Description

    serverDescription

    A brief description of your server displayed to players before joining.

    Type: string
    Default: "Welcome to my Hytale server!"

    Default Game Mode

    gameMode

    The default game mode for new players joining the server. Can be changed per-player with /gamemode command.

    Type: select
    Default: "Adventure"

    Allow Operator Commands

    allowOp

    Permits use of operator commands from in-game once permissions are set via /op command.

    Type: boolean
    Default: false

    Note: Corresponds to --allow-op launch flag.

    Accept Early Plugins

    acceptEarlyPlugins

    Loads experimental plugins that might not be fully supported yet. Use with caution on production servers.

    Type: boolean
    Default: false

    Note: Corresponds to --accept-early-plugins launch flag.

    Network

    Server Port

    port

    The UDP port your server listens on. Hytale uses the QUIC protocol over UDP. Default is 5520.

    Type: number
    Default: 5520
    Min: 1024
    Max: 65535

    Note: Requires UDP port forwarding for external access. TCP is not used.

    Bind Address

    bindAddress

    The IP address the server binds to. Use 0.0.0.0 to listen on all network interfaces.

    Type: string
    Default: "0.0.0.0"

    Note: Format: IP:PORT (e.g., 0.0.0.0:5520). Set via --bind launch option.

    Authentication Mode

    authMode

    Controls how players authenticate. 'authenticated' requires Hytale account login, 'offline' allows unauthenticated connections.

    Type: select
    Default: "authenticated"

    Note: Set via --auth-mode launch option. Authenticated mode is required for official features.

    Disable Crash Reporting

    disableSentry

    Disables crash reporting to Hytale servers. Recommended for development servers.

    Type: boolean
    Default: false

    Note: Set via --disable-sentry launch option.

    Permissions

    Whitelist Enabled

    whitelist

    When enabled, only players in whitelist.json can join the server. Managed with /whitelist command.

    Type: boolean
    Default: false

    NPC Spawning

    npcSpawning

    Controls whether NPCs spawn naturally in the world. Can be toggled with /spawning command.

    Type: boolean
    Default: true

    Note: Useful for debugging mob density or creating controlled encounters.

    World

    World Name

    worldName

    The name of the world/universe that players will explore. Worlds are saved in universe/worlds/[WorldName]/ directory.

    Type: string
    Default: "world"

    Time Progression

    timeProgression

    Whether the day/night cycle progresses naturally. Can be overridden with /time command.

    Type: boolean
    Default: true

    Weather Enabled

    weatherEnabled

    Controls whether weather effects occur in the world. Weather states affect visibility and ambience.

    Type: boolean
    Default: true

    Note: Can be controlled at runtime with /weather command.

    Performance

    Initial Memory (GB)

    initialMemory

    The initial heap size for the Java Virtual Machine. Set via -Xms JVM option.

    Type: number
    Default: 4
    Min: 1
    Max: 64

    Note: Example: -Xms4G for 4GB initial memory.

    Maximum Memory (GB)

    maxMemory

    The maximum heap size for the Java Virtual Machine. Set via -Xmx JVM option.

    Type: number
    Default: 4
    Min: 1
    Max: 64

    Note: Example: -Xmx8G for 8GB maximum memory. Increase for more players.

    Use G1 Garbage Collector

    useG1GC

    Enables the G1 garbage collector, which generally suits servers with 8GB or more memory.

    Type: boolean
    Default: true

    Note: Set via -XX:+UseG1GC JVM option.

    Use AOT Cache

    useAOTCache

    Uses the Ahead-Of-Time cache file shipped with the server to reduce warmup time and improve startup speed.

    Type: boolean
    Default: true

    Note: Set via -XX:AOTCache=HytaleServer.aot JVM option.

    Backup

    Automatic Backups

    backupEnabled

    Enables periodic automatic backups of world data to protect against data loss.

    Type: boolean
    Default: false

    Note: Set via --backup launch option.

    Backup Directory

    backupDirectory

    The directory where automatic backups are stored.

    Type: string
    Default: "./backups"

    Note: Set via --backup-dir launch option.

    Backup Frequency (minutes)

    backupFrequency

    How often automatic backups are created, in minutes.

    Type: number
    Default: 60
    Min: 5
    Max: 1440

    Note: Set via --backup-frequency launch option.

    Server File Structure

    .cache/

    Cache for optimized files

    logs/

    Server log files

    mods/

    Installed mods (.jar or .zip files)

    universe/

    World and player save data

    universe/worlds/

    Individual world folders

    bans.json

    Banned players list

    config.json

    Main server configuration

    permissions.json

    Permission configuration

    whitelist.json

    Whitelisted players

    Server Commands

    Admin Commands

    /auth login device

    Authenticate server with your Hytale account using device code flow

    /auth logout

    Log out the server from your Hytale account

    /stop

    Gracefully stop the server, flushing world and player data to disk

    /kick <player>

    Disconnect a player without banning them

    /ban <player>

    Block a player from joining the server. Written to bans.json

    /unban <player>

    Remove a player from the ban list

    /whitelist add <player>

    Add a player to the whitelist (whitelist.json)

    /whitelist remove <player>

    Remove a player from the whitelist

    /op <player>

    Grant operator-level access to a player

    /perm <player> <permission>

    Adjust fine-grained permissions for users or groups

    /gamemode <mode> [player]

    Switch a player between Adventure or Creative mode

    /give <player> <item> [amount]

    Spawn items directly into a player's inventory

    /heal <player>

    Restore a character to maximum health and stamina

    /sudo <player> <command>

    Execute a command as if another player typed it

    /tp <player> <target|x y z>

    Teleport players to coordinates or to each other

    /spawning [on|off]

    Control NPC spawning for debugging or controlled encounters

    /plugin <action>

    Manage plugin lifecycle and options

    World Commands

    /time <set|add> <value>

    Shift the in-game clock, overriding day/night cycle

    /weather <clear|rain|storm>

    Force specific weather states

    /world <action>

    Handle global world management

    /block <action>

    Operate on block states, toggle debug data

    /chunk <action>

    Inspect and control chunk loading

    /fluid <action>

    Manipulate liquids including flow behavior

    /lighting <action>

    Adjust lighting configuration and rendering

    /path <action>

    Edit NPC patrol routes for scripted encounters

    Builder Commands

    /pos1

    Set the first corner of a selection box

    /pos2

    Set the second corner of a selection box

    /copy

    Copy blocks within selection to clipboard

    /cut

    Copy and remove the selection

    /paste

    Place clipboard contents at current position

    /fillblocks <block>

    Fill selection with a specific block type

    /replace <from> <to>

    Swap one block type for another in selection

    /editprefab

    Enter prefab editing mode

    /prefab <save|load|list|delete>

    Manage prefabs for reusable builds

    /undo

    Revert the last change

    Player Commands

    /spawn

    Teleport back to the world's spawn point

    /warp <location>

    Move to predefined locations set by staff

    /ping

    Show latency and tick information

    /whoami

    Print your identity and permission context

    /help

    List available commands

    /emote <name>

    Trigger character animations

    /mount

    Handle mounting and dismounting

    /kill [player]

    Kill and respawn (admin-only for other players)

    Launch Options

    --assets <path>

    Points to Assets.zip, required to load game content

    Default: None (required)
    --bind <ip:port>

    Sets the IP address and UDP port the server listens on

    Default: 0.0.0.0:5520
    --auth-mode <mode>

    Switches between authenticated and offline modes

    Default: authenticated
    --backup

    Enables periodic backups of world data

    Default: Disabled
    --backup-dir <path>

    Sets where backups are written

    Default: ./backups
    --backup-frequency <mins>

    Controls backup interval in minutes

    Default: 60
    --disable-sentry

    Disables crash reporting (recommended for dev servers)

    Default: Enabled
    --allow-op

    Permits use of operator commands from in-game

    Default: Disabled
    --accept-early-plugins

    Loads experimental plugins

    Default: Disabled

    JVM Options

    -Xms<size>

    Set initial heap size (e.g., -Xms4G for 4GB)

    Example: -Xms4G
    -Xmx<size>

    Set maximum heap size (e.g., -Xmx8G for 8GB)

    Example: -Xmx8G
    -XX:+UseG1GC

    Enable G1 garbage collector (recommended for 8GB+ RAM)

    Example: -XX:+UseG1GC
    -XX:AOTCache=HytaleServer.aot

    Use AOT cache for faster startup

    Example: -XX:AOTCache=HytaleServer.aot