neo forge 1.20.6 port

Author: SkyBlade1978

README.md

@@ -80,7 +80,7 @@ Use Java 21 from the repository root:
 
 ```powershell
 .\gradlew.bat test processResources build javadoc --no-daemon
-.\gradlew.bat genEclipseRuns eclipse --no-daemon
+.\gradlew.bat eclipse --no-daemon
 ```
 
 Machine-specific `AGENTS.md` and `agent-notes/` files are intentionally ignored.

build.gradle

@@ -1,6 +1,6 @@
 # OreSpawn Integration Notes For Coding Agents
 
-OreSpawn 4.0 is a required Forge mod and declarative world-generation engine.
+OreSpawn 4.0 is a required NeoForge mod and declarative world-generation engine.
 Public API major version 1 consists only of `zone.moddev.mc.orespawn.api`. Treat
 every other Java package as internal and unstable.
 
@@ -32,7 +32,7 @@ Configuration contracts:
 
 Lifecycle and ownership:
 
-- Forge setup is parallel. Never mutate OreSpawn internals directly.
+- NeoForge setup is parallel. Never mutate OreSpawn internals directly.
 - A pack override file is authoritative over packaged and API definitions for
   the same provider. A malformed override fails closed.
 - Provider rule IDs use the provider namespace. A rule's `block` or weighted

docs/AGENTS.md

@@ -6,12 +6,12 @@ implementation detail. API major version is available as
 `OreSpawn-API-Version`.
 
 Provider mods must depend on the full OreSpawn mod at compile time and
-runtime. In `mods.toml` use a mandatory dependency, for example:
+runtime. In `neoforge.mods.toml` use a required dependency, for example:
 
 ```toml
 [[dependencies.examplemod]]
 modId="orespawn"
-mandatory=true
+type="required"
 versionRange="[4.0.0,5.0.0)"
 ordering="AFTER"
 side="BOTH"
@@ -34,7 +34,7 @@ patterns, and host tags, see `DEVELOPER_GUIDE.md`.
 
 Definitions are immutable after `build()`. Registry references remain
 `ResourceLocation` values until OreSpawn validates and bakes them. Provider
-messages are processed through Forge IMC and frozen at load completion; direct
+messages are processed through NeoForge IMC and frozen at load completion; direct
 cross-mod mutation during parallel setup is unsupported.
 
 Ore dimensions use `quantity(int)` for fixed budgets or
@@ -77,17 +77,25 @@ WorldgenProvider provider = WorldgenProvider.builder("examplemod", 1)
 `OilDefinition` and template `.oil(...)` remain deprecated migration adapters
 for one legacy oil rule. New integrations should use `FluidDepositDefinition`.
 
-Register custom biomes with Forge as usual. `OreSpawnBiomes.copyAndRegister`
-provides a small optional convenience for cloning a known biome:
+NeoForge 20.6 biomes are data-driven registry entries. Package biome JSON under
+`data/<modid>/worldgen/biome/`, or generate it with a
+`DatapackBuiltinEntriesProvider`. `OreSpawnBiomes.copyAndRegister` is an
+optional bootstrap/datagen convenience for cloning a known biome:
 
 ```java
-RegistryObject<Biome> candyPlains = OreSpawnBiomes.copyAndRegister(
-    BIOMES, "candy_plains",
-    () -> ForgeRegistries.BIOMES.getValue(new ResourceLocation("minecraft", "plains")),
-    builder -> builder.temperature(0.8F).downfall(0.4F));
+public static final ResourceKey<Biome> CANDY_PLAINS = ResourceKey.create(
+    Registries.BIOME, new ResourceLocation("examplemod", "candy_plains"));
+
+public static final RegistrySetBuilder BIOME_BUILDER = new RegistrySetBuilder()
+    .add(Registries.BIOME, context -> {
+        HolderGetter<Biome> biomes = context.lookup(Registries.BIOME);
+        OreSpawnBiomes.copyAndRegister(context, CANDY_PLAINS, biomes, Biomes.PLAINS,
+            builder -> builder.temperature(0.8F).downfall(0.4F));
+    });
 ```
 
-Then declare placement and materials through the same provider:
+The generated biome JSON remains owned by the child mod. Declare placement and
+materials through the same OreSpawn provider:
 
 ```java
 WorldgenProvider provider = WorldgenProvider.builder("examplemod", 1)
@@ -130,7 +138,7 @@ Y query. Sampling is read-only and is intended for gameplay decisions,
 diagnostics, and compatible generation outside OreSpawn's block loops.
 Callbacks inside OreSpawn generation loops are intentionally unsupported.
 
-Custom pattern mods create a Forge `DeferredRegister<OrePatternType>` using
+Custom pattern mods create a NeoForge `DeferredRegister<OrePatternType>` using
 `OreSpawnPatternRegistry.REGISTRY_NAME`. An `OrePatternType` contains a codec
 and a compiler from decoded settings to `CompiledOrePattern`. Reference it from
 an ore dimension with `pattern(patternId, settingsJson)`. OreSpawn decodes and

docs/API.md

@@ -2,8 +2,8 @@
 
 OreSpawn can place provider biomes and replace their visible world materials.
 It does not register biomes for a child mod: the provider still registers
-ordinary Forge `Biome` objects, then supplies declarative placement and
-material rules to OreSpawn.
+ordinary NeoForge data-driven `Biome` entries, then supplies declarative
+placement and material rules to OreSpawn.
 
 This feature is optional. Ore-only providers and existing Mineralogy profiles
 with no biome palettes use Minecraft's original biome source unchanged.
@@ -93,20 +93,28 @@ default states contain real fluids.
 
 ## Registration Helper
 
-`OreSpawnBiomes.copyAndRegister` copies a known biome's complete builder before
-applying small changes. This is useful for a simple content mod:
+Biomes are loaded from `data/<modid>/worldgen/biome/` when a world loads. A
+child mod may write those JSON files directly or generate them with
+`DatapackBuiltinEntriesProvider`. `OreSpawnBiomes.copyAndRegister` copies a
+known biome's complete builder inside a `RegistrySetBuilder` bootstrap:
 
 ```java
-RegistryObject<Biome> candyPlains = OreSpawnBiomes.copyAndRegister(
-    BIOMES, "candy_plains",
-    () -> ForgeRegistries.BIOMES.getValue(new ResourceLocation("minecraft", "plains")),
-    builder -> builder.temperature(0.8F).downfall(0.4F));
+public static final ResourceKey<Biome> CANDY_PLAINS = ResourceKey.create(
+    Registries.BIOME, new ResourceLocation("examplemod", "candy_plains"));
+
+public static final RegistrySetBuilder BIOME_BUILDER = new RegistrySetBuilder()
+    .add(Registries.BIOME, context -> {
+        HolderGetter<Biome> biomes = context.lookup(Registries.BIOME);
+        OreSpawnBiomes.copyAndRegister(context, CANDY_PLAINS, biomes, Biomes.PLAINS,
+            builder -> builder.temperature(0.8F).downfall(0.4F));
+    });
 ```
 
 `blankAndRegister` starts from an empty builder and is intended for advanced
-providers that deliberately supply every required climate, effects, spawn, and
-generation field. Both helpers only register content; placement belongs in the
-provider declaration.
+datagen that deliberately supplies every required climate, effects, spawn, and
+generation field. Both helpers create datapack content; live placement belongs
+in the provider declaration. Do not use a static `DeferredRegister<Biome>`:
+NeoForge 20.6 biomes belong to the dynamic world registry.
 
 ## Surfaces And Materials
 

docs/BIOMES.md

@@ -25,13 +25,13 @@ world. Restart after editing JSON by hand.
 | `geology_mode` | `geome`, `legacy` | Sky/geome engine or Cyano legacy engine |
 | `place_fluid_deposits` | boolean | Master switch for configured fluid-deposit rules |
 | `manage_vanilla_ores` | boolean | Lets OreSpawn suppress and replace claimed vanilla ore features |
-| `suppress_all_ore_features` | boolean | Suppresses all standard Forge ore features; use only in complete packs |
+| `suppress_all_ore_features` | boolean | Suppresses all standard NeoForge ore features; use only in complete packs |
 | `default_template` | registry ID or empty string | Template selected for newly created server worlds |
 | `formations` | object | Shape controls used only when terrain strata are active |
 | `rocks` | object keyed by rule ID | Eligible rock definitions |
 | `geomes` | object keyed by geome ID | Geological province weights |
 | `biomes` | object keyed by biome ID | Explicit biome-to-geome weights |
-| `biome_dictionary` | object keyed by Forge biome type | Fallback biome-to-geome weights |
+| `biome_dictionary` | object keyed by NeoForge biome tag/type name | Fallback biome-to-geome weights |
 | `terrain_dimensions` | object keyed by dimension ID | Dimensions and hosts eligible for terrain replacement |
 | `biome_palettes` | object keyed by provider-owned rule ID | Optional native-biome overlays and surfaces |
 | `dimension_materials` | object keyed by provider-owned rule ID | Aquifer fluid, snow, and ice substitutions |

docs/CONFIGURATION.md

@@ -7,7 +7,7 @@
 | Add ores to vanilla stone | Ore-only provider with explicit host tags |
 | Let a modpack tune another mod's rules | `config/<modid>-orespawn.json` |
 | Ship rocks, geomes, or custom terrain | Full packaged provider |
-| Construct definitions in Java | API provider sent through Forge IMC |
+| Construct definitions in Java | API provider sent through NeoForge IMC |
 | Offer an optional world style | Named template in a provider |
 | Add covered underground oil or another fluid | Provider schema 3 fluid deposit |
 | Add or place biomes without a framework dependency | Provider schema 4 biome palette |
@@ -65,12 +65,12 @@ a custom dimension, a biome palette, world materials, and a selectable template.
 
 ## Java API Quick Start
 
-Declare OreSpawn as a mandatory dependency in `mods.toml`:
+Declare OreSpawn as a required dependency in `neoforge.mods.toml`:
 
 ```toml
 [[dependencies.examplemod]]
 modId="orespawn"
-mandatory=true
+type="required"
 versionRange="[4.0.0,5.0.0)"
 ordering="AFTER"
 side="BOTH"
@@ -86,7 +86,7 @@ import zone.moddev.mc.orespawn.api.OrePattern;
 import zone.moddev.mc.orespawn.api.OreSpawnApi;
 import zone.moddev.mc.orespawn.api.WorldgenProvider;
 import net.minecraft.resources.ResourceLocation;
-import net.minecraftforge.fml.event.lifecycle.InterModEnqueueEvent;
+import net.neoforged.fml.event.lifecycle.InterModEnqueueEvent;
 
 private void enqueueWorldgen(InterModEnqueueEvent event) {
     ResourceLocation tin = new ResourceLocation("examplemod", "tin_ore");

docs/DEVELOPER_GUIDE.md

@@ -29,7 +29,7 @@ the codec object below are equivalent:
 }
 ```
 
-Other mods may register `OrePatternType` values in the Forge registry named by
+Other mods may register `OrePatternType` values in the NeoForge registry named by
 `OreSpawnPatternRegistry.REGISTRY_NAME`. Each type supplies a Mojang `Codec`
 and compiles decoded settings into a `CompiledOrePattern`. Compilation occurs
 during profile baking. The generation loop invokes only the compiled object.
@@ -58,5 +58,5 @@ Retrogen records a deterministic profile revision in chunk NBT under
 bounded by `chunks_per_tick`; no terrain strata retrogen exists.
 
 Flat bedrock is disabled by default. When enabled it flattens the configured
-number of bottom layers and, in the Nether, the ceiling. It uses normal Forge
+number of bottom layers and, in the Nether, the ceiling. It uses normal NeoForge
 features and chunk events, with no reflection.

docs/FEATURES.md

@@ -1,6 +1,6 @@
 # Worldgen Providers
 
-Provider mods may contribute through Forge IMC, a packaged resource at
+Provider mods may contribute through NeoForge IMC, a packaged resource at
 `data/<provider-modid>/orespawn/provider.json`, or a pack override at
 `config/<provider-modid>-orespawn.json`. A valid override is authoritative. A
 present malformed override leaves that provider inactive instead of silently
@@ -81,8 +81,8 @@ An enabled ore dimension requires a Y range, expected attempts per chunk in
 quantity and a complete range are both present, the range is authoritative; a
 lone range bound is invalid. Host arrays accept either registry-ID strings or weighted
 objects such as `{ "block": "minecraft:stone", "weight": 1.0 }` and
-`{ "tag": "forge:stone", "weight": 0.5 }`. Biome include/exclude IDs and
-Forge biome-dictionary names may further restrict a rule.
+`{ "tag": "c:stones", "weight": 0.5 }`. Biome include/exclude IDs and
+NeoForge biome tag/type names may further restrict a rule.
 
 For OS3-compatible placement in ordinary modded dimensions, put a rule under
 `dimension_selectors.orespawn:all_except_nether_end`. It applies to every
@@ -105,11 +105,11 @@ Existing worlds merge newly introduced provider rule IDs but do not overwrite
 world edits. Disabled and unassigned rules remain tombstones; removed provider
 rules remain in the self-contained snapshot.
 
-Biome providers can add Forge biomes normally, then declare where those biomes
-belong through `biome_palettes`. The overlay wraps the dimension's existing
-biome source, so it composes after vanilla or another installed source instead
-of taking a compile-time dependency on it. Use `minecraft_only` scope when the
-provider should leave other mods' biomes alone.
+Biome providers package their biomes in the standard dynamic-registry path
+`data/<modid>/worldgen/biome/`, then declare where those IDs belong through
+`biome_palettes`. The overlay wraps the dimension's existing biome source, so
+it composes after vanilla or another installed source. Use `minecraft_only`
+scope when the provider should leave other mods' biomes alone.
 Use `required_similar_biomes` only when an output truly cannot work without a
 referenced biome; ordinary compatibility hints belong in `similar_biomes`.
 

docs/PROVIDERS.md

@@ -1,6 +1,6 @@
 # OreSpawn 4 Documentation
 
-OreSpawn is a required Forge mod and a declarative world-generation engine.
+OreSpawn is a required NeoForge mod and a declarative world-generation engine.
 The normal jar is both the compile-time and runtime dependency; there is no
 shaded or embeddable engine artifact.