Skip to content

Commit 4f96eaf

Browse files
SkyBlade1978SkyBlade1978
authored
Merge pull request #198 from SkyBlade1978/master-1.18
improve help info and move to new namespace
2 parents 3df2f93 + 2ca454d commit 4f96eaf

137 files changed

Lines changed: 830 additions & 461 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Modpacks can override a provider with `config/<modid>-orespawn.json`. A present
5858
override is authoritative and fails closed when invalid, so a broken pack file
5959
cannot silently disable another mod's native ore generation.
6060

61-
Only `com.mcmoddev.orespawn.api` is supported Java API. API major version `1`
61+
Only `zone.moddev.mc.orespawn.api` is supported Java API. API major version `1`
6262
is also recorded in the jar manifest as `OreSpawn-API-Version`.
6363

6464
Start with:

‎docs/AGENTS.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# OreSpawn Integration Notes For Coding Agents
22

33
OreSpawn 4.0 is a required Forge mod and declarative world-generation engine.
4-
Public API major version 1 consists only of `com.mcmoddev.orespawn.api`. Treat
4+
Public API major version 1 consists only of `zone.moddev.mc.orespawn.api`. Treat
55
every other Java package as internal and unstable.
66

77
Integration entry points:
@@ -68,7 +68,7 @@ Compatibility defaults:
6868
- The Overworld is the conventional geology target, but a provider must opt it
6969
in. Nether and End terrain remain untouched unless explicitly configured.
7070
- Mineralogy 6 is a provider, not a public-API compatibility facade. Do not use
71-
removed `com.mcmoddev.mineralogy.api` classes.
71+
removed `zone.moddev.mc.mineralogy.api` classes.
7272

7373
Common tasks are documented in `API.md`, `PROVIDERS.md`, `FEATURES.md`,
7474
`TEMPLATES.md`, `BIOMES.md`, and `DIMENSIONS.md`. Start with

‎docs/API.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Java API
22

3-
Only `com.mcmoddev.orespawn.api` is supported API. Every other package is an
3+
Only `zone.moddev.mc.orespawn.api` is supported API. Every other package is an
44
implementation detail. API major version is available as
55
`OreSpawnApi.API_VERSION` and in the jar manifest as
66
`OreSpawn-API-Version`.

‎docs/DEVELOPER_GUIDE.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,12 +79,12 @@ side="BOTH"
7979
Submit immutable definitions during `InterModEnqueueEvent`:
8080

8181
```java
82-
import com.mcmoddev.orespawn.api.GeologyFamily;
83-
import com.mcmoddev.orespawn.api.OreHeightDistribution;
84-
import com.mcmoddev.orespawn.api.OreDimensionSelector;
85-
import com.mcmoddev.orespawn.api.OrePattern;
86-
import com.mcmoddev.orespawn.api.OreSpawnApi;
87-
import com.mcmoddev.orespawn.api.WorldgenProvider;
82+
import zone.moddev.mc.orespawn.api.GeologyFamily;
83+
import zone.moddev.mc.orespawn.api.OreHeightDistribution;
84+
import zone.moddev.mc.orespawn.api.OreDimensionSelector;
85+
import zone.moddev.mc.orespawn.api.OrePattern;
86+
import zone.moddev.mc.orespawn.api.OreSpawnApi;
87+
import zone.moddev.mc.orespawn.api.WorldgenProvider;
8888
import net.minecraft.resources.ResourceLocation;
8989
import net.minecraftforge.fml.event.lifecycle.InterModEnqueueEvent;
9090

@@ -107,7 +107,7 @@ private void enqueueWorldgen(InterModEnqueueEvent event) {
107107
}
108108
```
109109

110-
Only `com.mcmoddev.orespawn.api` is stable. Do not call classes in
110+
Only `zone.moddev.mc.orespawn.api` is stable. Do not call classes in
111111
`worldgen`, `integration`, `client`, or other implementation packages.
112112

113113
Use `.quantity(8)` when every attempt should have a fixed budget. The selector

‎docs/PLAYER_GUIDE.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ For a normal game:
1212
3. Open **Help & Guide** for a plain-language tour of the controls.
1313
4. Press **Done**, then create the world normally.
1414

15+
Hover over unfamiliar controls for a short explanation. The same explanations
16+
are collected in **Help & Guide**, so a setting can be learned either while
17+
editing it or one topic at a time.
18+
1519
There is no requirement to use rock strata. Ore-only mods can use OreSpawn to
1620
place ores in ordinary vanilla stone while every geology control remains idle.
1721
When no provider supplies rocks, **Configure Rock Strata...** starts with a
@@ -50,6 +54,12 @@ safely instead of breaking world creation.
5054
style. Namespace scope protects other biome mods unless a pack deliberately
5155
opts them in.
5256

57+
**World Materials** applies across an entire dimension. **Aquifer Fluid**
58+
changes the normal below-sea-level fluid, while **Deep Aquifer** can use a
59+
second fluid below a chosen Y level. Snow and ordinary ice can also be replaced.
60+
Use **Fluid Deposits**, not World Materials, for occasional underground lakes
61+
or pockets.
62+
5363
## Rocks, Ores, And Other Mods
5464

5565
The material picker lists blocks from installed mods by full registry ID, for

‎gradle.properties‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ mod_version=4.0.1
5252
# The group ID for the mod. It is only important when publishing as an artifact to a Maven repository.
5353
# This should match the base package used for the mod sources.
5454
# See https://maven.apache.org/guides/mini/guide-naming-conventions.html
55-
mod_group_id=com.mcmoddev
55+
mod_group_id=zone.moddev.mc.orespawn
5656
# The authors of the mod. This is a simple text string that is used for display purposes in the mod list.
5757
mod_authors=SkyBlade1978, dshadowwolf, the MMD Team
5858
# The description of the mod. This is a simple multiline text string that is used for display purposes in the mod list.

src/main/java/com/mcmoddev/orespawn/OreSpawn.java renamed to src/main/java/zone/moddev/mc/orespawn/OreSpawn.java

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
package com.mcmoddev.orespawn;
2-
3-
import com.mcmoddev.orespawn.integration.WorldgenIntegrationManager;
4-
import com.mcmoddev.orespawn.init.OreSpawnPatterns;
5-
import com.mcmoddev.orespawn.worldgen.OreSpawnOreGeneration;
6-
import com.mcmoddev.orespawn.worldgen.GeomeConfig;
7-
import com.mcmoddev.orespawn.worldgen.GeomeDistributionSampler;
8-
import com.mcmoddev.orespawn.worldgen.FluidDepositFeature;
9-
import com.mcmoddev.orespawn.worldgen.StoneReplacer;
10-
import com.mcmoddev.orespawn.worldgen.WorldGeologyProfileManager;
11-
import com.mcmoddev.orespawn.worldgen.FormationSettings.Preset;
12-
import com.mcmoddev.orespawn.OreSpawnConfig.GeologyMode;
13-
import com.mcmoddev.orespawn.worldgen.WorldGeologyProfile;
14-
import com.mcmoddev.orespawn.worldgen.WorldgenBenchmark;
15-
import com.mcmoddev.orespawn.worldgen.FlatBedrockFeature;
16-
import com.mcmoddev.orespawn.worldgen.OreRetrogenManager;
17-
import com.mcmoddev.orespawn.worldgen.BiomeSurfaceFeature;
18-
import com.mcmoddev.orespawn.worldgen.BiomeWorldgenBootstrap;
19-
import com.mcmoddev.orespawn.worldgen.WorldMaterialWeather;
20-
import com.mcmoddev.orespawn.commands.OreSpawnCommands;
21-
import com.mcmoddev.orespawn.documentation.DocumentationExporter;
1+
package zone.moddev.mc.orespawn;
2+
3+
import zone.moddev.mc.orespawn.integration.WorldgenIntegrationManager;
4+
import zone.moddev.mc.orespawn.init.OreSpawnPatterns;
5+
import zone.moddev.mc.orespawn.worldgen.OreSpawnOreGeneration;
6+
import zone.moddev.mc.orespawn.worldgen.GeomeConfig;
7+
import zone.moddev.mc.orespawn.worldgen.GeomeDistributionSampler;
8+
import zone.moddev.mc.orespawn.worldgen.FluidDepositFeature;
9+
import zone.moddev.mc.orespawn.worldgen.StoneReplacer;
10+
import zone.moddev.mc.orespawn.worldgen.WorldGeologyProfileManager;
11+
import zone.moddev.mc.orespawn.worldgen.FormationSettings.Preset;
12+
import zone.moddev.mc.orespawn.OreSpawnConfig.GeologyMode;
13+
import zone.moddev.mc.orespawn.worldgen.WorldGeologyProfile;
14+
import zone.moddev.mc.orespawn.worldgen.WorldgenBenchmark;
15+
import zone.moddev.mc.orespawn.worldgen.FlatBedrockFeature;
16+
import zone.moddev.mc.orespawn.worldgen.OreRetrogenManager;
17+
import zone.moddev.mc.orespawn.worldgen.BiomeSurfaceFeature;
18+
import zone.moddev.mc.orespawn.worldgen.BiomeWorldgenBootstrap;
19+
import zone.moddev.mc.orespawn.worldgen.WorldMaterialWeather;
20+
import zone.moddev.mc.orespawn.commands.OreSpawnCommands;
21+
import zone.moddev.mc.orespawn.documentation.DocumentationExporter;
2222

2323
import net.minecraftforge.common.MinecraftForge;
2424
import net.minecraftforge.fml.common.Mod;

src/main/java/com/mcmoddev/orespawn/OreSpawnConfig.java renamed to src/main/java/zone/moddev/mc/orespawn/OreSpawnConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.mcmoddev.orespawn;
1+
package zone.moddev.mc.orespawn;
22

33
import org.apache.commons.lang3.tuple.Pair;
44

src/main/java/com/mcmoddev/orespawn/api/BiomePlacementMode.java renamed to src/main/java/zone/moddev/mc/orespawn/api/BiomePlacementMode.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.mcmoddev.orespawn.api;
1+
package zone.moddev.mc.orespawn.api;
22

33
import java.util.Locale;
44

src/main/java/com/mcmoddev/orespawn/api/BiomeRegionSize.java renamed to src/main/java/zone/moddev/mc/orespawn/api/BiomeRegionSize.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.mcmoddev.orespawn.api;
1+
package zone.moddev.mc.orespawn.api;
22

33
import java.util.Locale;
44

0 commit comments

Comments
 (0)