Modding Hytale

When to use this skill

• When the user asks to create a Hytale mod, plugin, or server script.
• When the user mentions “Hytale”, “Prefabs”, “ECS”, “Server”, “Blockbench”, “World Gen V2”, “HyUI”, or “HTML UI”.
• When creating custom entities, blocks, or modifying world generation logic.

Workflow

1. Determine the Domain:

   • Server Logic (Commands, Events, Entities) -> See server_development.md
   • World Generation (Biomes, Noise, Density) -> See world_generation.md
   • Assets & UI (Models, Textures, NoesisGUI, HyUI) -> See assets_and_client.md or See hyui_documentation.md

2. Environment Check & Setup:

   • Java 25 (OpenJDK/Adoptium) + Maven 3.9.12+.
   • Install HytaleServer.jar to local Maven cache.

3. Execute Logic:

   • Follow the specific patterns in the linked resource files.
   • Use “Server-First” thinking: assume the client is just a screen, all logic is on the server.

Instructions

1. Environment Setup (Critical)

• Java: JDK 25 (Adoptium recommended).
• Maven: 3.9.12+.
• HytaleServer.jar: Must be manually installed.

PowerShell Install Command:

mvn install:install-file -Dfile="PATH_TO_JAR/HytaleServer.jar" -DgroupId="com.hypixel.hytale" -DartifactId="HytaleServer-parent" -Dversion="1.0-SNAPSHOT" -Dpackaging="jar"

Note: Wrap arguments in quotes if PowerShell throws parsing errors.

2. Quick References

Server & ECS

• Entity: com.hypixel.hytale.server.core.entity.Entity
• World: com.hypixel.hytale.server.core.universe.world.World
• Player: com.hypixel.hytale.server.core.entity.entities.Player
• Command Context: com.hypixel.hytale.server.core.commands.info.CommandContext

Common Pitfalls

• Spawning Entities: Do NOT use new Entity(). Use PrefabSpawnerModule or EntityModule.
• Async Events: Do NOT modify the world in IAsyncEvent.
• UI Latency: UI interactions make a round-trip to the server. Design accordingly.

Resources

• Server Development Guide
• World Generation Guide
• Assets & Client Guide
• HyUI Documentation (HTML UI)
• Official Hytale Modding Docs