OreSpawn 4

OreSpawn 4 Documentation

OreSpawn 4 is a declarative world-generation engine for Forge. Other mods and modpacks tell it which rocks, ores, fluids, biomes, and materials they own. OreSpawn validates those declarations, combines them into one world profile, and performs the configured generation.

On its own, OreSpawn is passive unless a player or pack deliberately configures standalone features. Content mods such as Minecraft Mineralogy or Base Metals can provide ready-to-play defaults.

Start here

Players and server owners

Read the Player and Server Guide for world creation, Recommended Defaults, the in-game Help and Guide, saved world profiles, dedicated servers, and existing chunks.

To understand how OreSpawn creates broad underground geology, read Geomes and Formations.

Modpack authors

Use these pages when tuning a pack:

• Configuration Reference
• Ore Patterns and Runtime Features
• Biomes and World Materials
• Terrain Dimensions
• Geology Templates
• Migration
• Troubleshooting

Mod developers

Mods should integrate through OreSpawn's supported provider format or public API:

• Worldgen Providers
• Developer Guide
• Java API

What OreSpawn 4 can manage

• Broad geological provinces called geomes
• Stable rock strata and the classic Cyano layer engine
• Provider-owned rocks and terrain hosts
• Configurable ore patterns, heights, quantities, hosts, biomes, and dimensions
• Covered underground fluid deposits
• Optional management of vanilla ores
• Biome palettes, surface materials, aquifer fluids, snow, and ice
• Custom dimensions
• Pack templates and self-contained per-world profiles
• Bounded ore and flat-bedrock retrogen
• Player-facing configuration screens and help
• JSON providers and a public Java API for other mods

Which documentation is authoritative?

This wiki is the public guide to the OS4 family. Exact fields can differ between releases.

Every OS4 jar exports the documentation, validated examples, and JSON Schemas matching that build to:

config/orespawn-guide/

Use that exported guide when checking an exact installed version. The current public source documentation is also available in the canonical master-1.20 branch.

Validated reference files are kept with the source:

• JSON Schemas
• Complete examples

For Minecraft 1.10/1.12 installations, use the OreSpawn 3 Legacy Documentation instead.