CoalMod

A data-driven mod for Hytale that adds coal ore to world generation using only JSON files - no Java code required!

Overview

CoalMod demonstrates how to add custom ores to Hytale using WorldGenOverlayLib. This mod is completely JSON-based and serves as a perfect example for resource pack creators who want to add ores to their worlds.

Features

• No Java Code Required - Completely JSON-based
• Coal Ore Generation - Adds coal ore across all zones (Zone0-Zone4)
• Multiple Block Variants - Stone, Basalt, Sandstone, Shale, Volcanic variants
• Automatic Integration - Uses WorldGenOverlayLib for seamless worldgen merging

Requirements

WorldGenOverlayLib is required! Make sure to install WorldGenOverlayLib before installing CoalMod.

• WorldGenOverlayLib - Required dependency

Installation

1. Install WorldGenOverlayLib first
2. Place CoalMod JAR in your server's mods/ folder
3. Restart your server

The mod will automatically register coal ore generation when the server starts.

How It Works

CoalMod uses WorldGenOverlayLib's auto-discovery feature:

1. Overlay configuration is defined in Server/WorldGenOverlays/overlays.json
2. WorldGenOverlayLib automatically discovers and registers the overlay
3. Coal ore files are placed in the Ores/ZoneX/ structure
4. Placement references are automatically merged into Caves.json files

Documentation

• WorldGenOverlayLib Documentation - Learn how the library works
• CoalMod Source Code - View the complete example

For Mod Developers

This mod serves as a complete example of the data-driven approach to adding ores. You can use it as a template for creating your own ore mods. All the JSON files are included in the mod JAR for reference.

Support

For issues, suggestions, or questions, join the Hexvane's Mods Discord for support.

Note: This mod requires WorldGenOverlayLib to function. Make sure both mods are installed.