promotional bannermobile promotional banner

WorldGenOverlayLib

A library mod for Hytale that provides shared worldgen overlay functionality, allowing multiple mods to coexist and merge their ore generation without conflicts.

WorldGenOverlayLib

Aetherhaven Orbis Origins AbilityAPI Dragonlings  Machinaria Pathfinder Star Slinger

Discord Buy me a coffee

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

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.

The WorldGenOverlayLib Team

profile avatar
Owner
  • 27
    Followers
  • 13
    Projects
  • 89.2K
    Downloads
Donate

More from HexvaneView all

  • Cozy Tales - Fishing project image

    Cozy Tales - Fishing

    A relaxed shadow-based fishing mod for Hytale, part of the **Cozy Tales** series by **Hexvane**.

    • 828
    • July 27, 2026
  • Machinaria project image

    Machinaria

    Machinaria adds a new fragment of orbis to explore called the Rusted Expanse! A scrapyard biome of colossal gears, rusted arches, and clockwork threats. Explore the ruins and craft mechanical gadgets from what remains using the Mechanics Workbench.

    • 2.1K
    • July 23, 2026
  • Aetherhaven project image

    Aetherhaven

    Aetherhaven is a town-building add-on built around laying out plots, growing a settlement with named locals, and following quests that push your town forward.

    • 14.8K
    • July 23, 2026
  • Wraith Busters project image

    Wraith Busters

    Wraith Busters is a multiplayer horror hide-and-seek set inside a haunted mansion.

    • 94
    • July 3, 2026
  • Cozy Tales - Fishing project image

    Cozy Tales - Fishing

    A relaxed shadow-based fishing mod for Hytale, part of the **Cozy Tales** series by **Hexvane**.

    • 828
    • July 27, 2026
  • Machinaria project image

    Machinaria

    Machinaria adds a new fragment of orbis to explore called the Rusted Expanse! A scrapyard biome of colossal gears, rusted arches, and clockwork threats. Explore the ruins and craft mechanical gadgets from what remains using the Mechanics Workbench.

    • 2.1K
    • July 23, 2026
  • Aetherhaven project image

    Aetherhaven

    Aetherhaven is a town-building add-on built around laying out plots, growing a settlement with named locals, and following quests that push your town forward.

    • 14.8K
    • July 23, 2026
  • Wraith Busters project image

    Wraith Busters

    Wraith Busters is a multiplayer horror hide-and-seek set inside a haunted mansion.

    • 94
    • July 3, 2026