Hytale Modding Docs

By modders, for modders.

Asset Development Items, blocks, NPCs, and effects through JSON. No Java required.

Plugin Development Java plugins with events, commands, and full API access.

A Quick Taste

import com.hypixel.hytale.server.core.plugin.JavaPlugin;
import com.hypixel.hytale.server.core.plugin.JavaPluginInit;
import com.hypixel.hytale.server.core.event.events.player.PlayerConnectEvent;

public class MyPlugin extends JavaPlugin {
    public MyPlugin(JavaPluginInit init) {
        super(init);
    }

    @Override
    protected void setup() {
        getEventRegistry().register(PlayerConnectEvent.class, event -> {
            getLogger().info("Welcome, " + event.getPlayerRef().getUsername() + "!");
        });
    }
}

{
  "Parent": "Template_Weapon_Sword",
  "Model": "Items/Weapons/Sword/Custom.blockymodel",
  "Quality": "Rare",
  "MaxDurability": 150,
  "InteractionVars": {
    "Swing_Left_Damage": {
      "DamageCalculator": { "BaseDamage": { "Physical": 18 } }
    }
  }
}

Where to Go Next

New here? Set up your environment → extract the server → build your first plugin.

Already know what you’re looking for:

Event system — react to game state
Items & weapons — swords, tools, armor, recipes
NPCs — models, behaviors, spawning
ECS — the entity-component-system underneath it all
Built-in plugins — 31 official plugins you can study