WorldGenOverlayLib

A library mod for Hytale that allows multiple mods to add custom ores to world generation without conflicts. No Java code required - add ores using only JSON files!

Quick Start

For Resource Pack Creators

1. Create Server/WorldGenOverlays/overlays.json in your resource pack:

{
  "Overlays": [
    {
      "Name": "My Ores Overlay",
      "Generator": "Default",
      "Ores": ["Coal", "Diamond"],
      "Zones": ["Zone0", "Zone1", "Zone2", "Zone3", "Zone4"]
    }
  ]
}

1. Create your ore files in Server/World/Default/Ores/ZoneX/:

   • OreName.json - Defines ore structure
   • OreNamePlacement.json - Defines placement settings

2. Add dependency to your manifest.json:

{
  "Dependencies": {
    "Hexvane:WorldGenOverlayLib": "1.0.0",
    "Hytale:WorldGen": "*"
  }
}

That's it! The library automatically discovers and registers your ores.

Features

• No Java Required - Completely JSON-based
• Multiple Ores - Define multiple ores in one config
• Auto-Discovery - Automatically finds and registers overlays
• Mod Compatibility - Multiple ore mods can coexist
• Automatic Merging - Handles Caves.json merging automatically

Example

See CoalMod for a complete working example - it adds coal ore using only JSON files!

Documentation

• Full Documentation - Complete guide with examples
• Quick Start Guide - Step-by-step tutorial
• GitHub Repository - Source code and issues

For Mod Developers

If you're writing a Java mod, you can also register overlays programmatically. See the GitHub repository for API documentation.

Requirements

• Hytale server with WorldGen support
• Java 25

Need help? Check the GitHub repository for documentation, examples, and support.