Menu
PasterDream模组自定义遗迹注册专用API，提供Facade+Builder模式一键注册自定义结构/遗迹。在需要创建新遗迹结构、配置结构类型/模板池/结构集或生成worldgen JSON时调用。
Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.
Baseado na classificação ocupacional SOC
| name | pasterdream-ruin-api |
| description | PasterDream模组自定义遗迹注册专用API，提供Facade+Builder模式一键注册自定义结构/遗迹。在需要创建新遗迹结构、配置结构类型/模板池/结构集或生成worldgen JSON时调用。 |
本 Skill 提供 PasterDream 模组自定义遗迹注册专用 API 的使用指南，采用 Facade + Builder 模式（与 BlockAPI / DimensionAPI 风格一致），通过链式调用即可完成结构类型的注册、模板池配置、结构集放置配置和资源文件生成。
⚠️ 注意：本 API 专用于"自定义遗迹"（结构），而非结构管理。它专注于单个结构的注册和配置，不涉及整体结构管理体系。
// ====== 1. 创建遗迹结构 ======
RuinResult result = RuinAPI.createRuin("dyedream_ruins")
.biomeTag("pasterdream:is_dyedream") // 生物群系标签
.templatePool("pasterdream:dyedream_ruins_pool") // 起始模板池
.structureClass(DyedreamRuinsStructure.class) // 结构类
.codec(DyedreamRuinsStructure.CODEC) // 结构 MapCodec
.terrainAdaptation("beard_thin") // 地形适应
.step("surface_structures") // 生成阶段
.size(7) // 扩展大小
.startHeight(0) // 起始高度
.build();
// ====== 2. 创建结构集配置 ======
RuinResult resultWithSet = RuinAPI.createRuinSet("dyedream_ruins", "dyedream_ruins_set")
.spacing(32) // 间距（区块数）
.separation(8) // 分离值（区块数）
.salt(12345) // 随机种子盐值
.build();
// ====== 3. 在代码中引用结构 ======
// 获取结构 ResourceKey
ResourceKey<Structure> structureKey = result.structureKey();
ResourceKey<StructureSet> setKey = resultWithSet.setKey();
在 PasterDreamMod 构造函数中注册 RuinAPI 的 REGISTRY：
public PasterDreamMod(IEventBus modEventBus) {
// ... 其他注册器 ...
RuinAPI.REGISTRY.register(modEventBus);
}
RuinAPI ← Facade 门面
├── createRuin(name) ← 工厂方法 → RuinBuilder
├── createRuinSet(ruinName, setName) ← 结构集工厂 → StructureSetBuilder
├── getRuin(name) ← 查询 RuinResult
├── getAllRuins() ← 所有已注册结构
└── hasRuin(name) ← 判断是否已注册
RuinBuilder ← Builder 构建器
├── biomeTag(String) ← 生物群系标签
├── templatePool(String) ← 起始模板池
├── structureClass(Class) ← 结构类
├── codec(MapCodec) ← 结构 MapCodec
├── terrainAdaptation(String) ← 地形适应
├── step(String) ← 生成阶段
├── size(int) ← 扩展大小
├── startHeight(int) ← 起始高度
├── extraFields(JsonObject) ← 自定义额外 JSON 字段
├── generateJson(boolean) ← 是否自动生成 JSON
├── basePath(String) ← 资源文件基础路径
└── build() ← 注册 + 生成 JSON → RuinResult
StructureSetBuilder ← 结构集 Builder
├── spacing(int) ← 间距（区块数）
├── separation(int) ← 分离值（区块数）
├── salt(int) ← 随机种子盐值
├── placementType(String) ← 放置类型（默认 random_spread）
├── generateJson(boolean) ← 是否自动生成 JSON
├── basePath(String) ← 资源文件基础路径
└── build() ← 生成 JSON → RuinResult（带 setKey）
RuinResult ← Record 结果
├── name() → String（结构注册名）
├── typeKey() → ResourceKey<StructureType<?>>
├── structureKey() → ResourceKey<Structure>（用于 JSON 引用）
├── setKey() → ResourceKey<StructureSet>（可能为 null）
├── hasSetKey() → boolean
├── withSetKey(setName, modId) → 新的 RuinResult（带结构集 Key）
└── of(modId, name) → 静态工厂（初始结果）
| 方法 | 参数 | 说明 | 必需 |
|---|---|---|---|
biomeTag(String) | 标签 ID | 生物群系标签（如 pasterdream:is_dyedream，自动加 #） | ❌ |
templatePool(String) | 池 ID | 起始模板池（如 pasterdream:dyedream_ruins_pool） | ❌ |
structureClass(Class) | Class | 结构类（Structure 子类） | ❌ |
codec(MapCodec) | MapCodec | 结构序列化编解码器 | ✅ |
terrainAdaptation(String) | 类型名称 | 地形适应类型（beard_thin, beard_box, none） | ❌ |
step(String) | 阶段名 | 生成阶段（默认 surface_structures） | ❌ |
size(int) | 大小 | 结构扩展大小（默认 7） | ❌ |
startHeight(int) | 高度 | 起始生成高度（默认 0） | ❌ |
extraFields(JsonObject) | JSON | 自定义额外 JSON 字段 | ❌ |
generateJson(boolean) | bool | 是否自动生成 JSON（默认 true） | ❌ |
basePath(String) | 路径 | 资源文件基础路径（默认 src/main/resources） | ❌ |
| 方法 | 参数 | 说明 | 默认值 |
|---|---|---|---|
spacing(int) | 区块数 | 结构生成间距 | 32 |
separation(int) | 区块数 | 结构最小分离距离 | 8 |
salt(int) | 整数 | 随机种子盐值 | 0 |
placementType(String) | 类型 ID | 放置算法类型 | minecraft:random_spread |
generateJson(boolean) | bool | 是否自动生成 JSON | true |
basePath(String) | 路径 | 资源文件基础路径 | src/main/resources |
// 1. 定义结构类
public class DyedreamRuinsStructure extends Structure {
public static final MapCodec<DyedreamRuinsStructure> CODEC = simpleCodec(DyedreamRuinsStructure::new);
public DyedreamRuinsStructure(StructureSettings settings) {
super(settings);
}
@Override
public Optional<GenerationStub> findGenerationPoint(GenerationContext context) {
// 实现结构生成逻辑...
return Optional.empty();
}
@Override
public StructureType<?> type() {
return RuinAPI.getRuin("dyedream_ruins").structureType();
}
}
// 2. 注册
RuinResult dyedream = RuinAPI.createRuin("dyedream_ruins")
.biomeTag("pasterdream:is_dyedream")
.templatePool("pasterdream:dyedream_ruins_pool")
.structureClass(DyedreamRuinsStructure.class)
.codec(DyedreamRuinsStructure.CODEC)
.terrainAdaptation("beard_thin")
.build();
// 3. 配置结构集
RuinAPI.createRuinSet("dyedream_ruins", "dyedream_ruins_set")
.spacing(32)
.separation(8)
.salt(12345)
.build();
// 4. 获取 ResourceKey 用于 JSON 引用
ResourceKey<Structure> key = dyedream.structureKey();
RuinResult underground = RuinAPI.createRuin("deep_ruins")
.biomeTag("minecraft:is_overworld")
.templatePool("pasterdream:deep_ruins_pool")
.structureClass(DeepRuinsStructure.class)
.codec(DeepRuinsStructure.CODEC)
.terrainAdaptation("beard_box")
.step("underground_structures")
.size(12)
.startHeight(-40)
.build();
JsonObject extra = new JsonObject();
extra.addProperty("allow_biome_surface_decoration", true);
extra.addProperty("allow_biome_underground_decoration", true);
RuinResult custom = RuinAPI.createRuin("custom_ruins")
.biomeTag("pasterdream:special_biomes")
.templatePool("pasterdream:custom_ruins_pool")
.structureClass(CustomRuinsStructure.class)
.codec(CustomRuinsStructure.CODEC)
.extraFields(extra)
.build();
// 直接使用 TemplatePoolGenerator 单独生成模板池 JSON
new TemplatePoolGenerator("pasterdream", "dyedream_ruins_pool")
.fallback("minecraft:empty")
.addSingleElement("pasterdream:dyedream_ruins/ruin_1", 3, "rigid", "minecraft:empty")
.addSingleElement("pasterdream:dyedream_ruins/ruin_2", 2, "rigid", "minecraft:empty")
.addSingleElement("pasterdream:dyedream_ruins/ruin_3", 1, "rigid", "minecraft:empty")
.saveToFile("src/main/resources");
src/main/resources/
└── data/{modId}/
└── worldgen/
├── structure/{name}.json ← 结构定义
├── structure_set/{setName}.json ← 结构集配置
└── template_pool/{name}_pool.json ← 模板池定义
{
"type": "pasterdream:dyedream_ruins",
"biomes": "#pasterdream:is_dyedream",
"step": "surface_structures",
"terrain_adaptation": "beard_thin",
"spawn_overrides": {},
"start_pool": "pasterdream:dyedream_ruins_pool",
"size": 7,
"start_height": {
"type": "minecraft:absolute",
"height": 0
},
"project_start_to_heightmap": "WORLD_SURFACE_WG",
"max_distance_from_center": 80
}
{
"structures": {
"pasterdream:dyedream_ruins": 1
},
"placement": {
"type": "minecraft:random_spread",
"spacing": 32,
"separation": 8,
"salt": 12345
}
}
{
"name": "pasterdream:dyedream_ruins_pool",
"fallback": "minecraft:empty",
"elements": [
{
"weight": 3,
"element": {
"element_type": "minecraft:single_pool_element",
"projection": "rigid",
"location": "pasterdream:dyedream_ruins/ruin_1",
"processors": "minecraft:empty"
}
}
]
}
data/{modId}/structure/{name}/{nbt_file}.nbt ← 结构 NBT 文件
例如：
data/pasterdream/structure/dyedream_ruins/ruin_1.nbt
data/pasterdream/structure/dyedream_ruins/ruin_2.nbt
build() 时要求 codec 不能为 null，否则抛出异常(StructureSettings) 构造方法，因为使用的是 simpleCodec 工厂createRuin().build() 注册结构，再调用 createRuinSet()，否则会抛出异常withSetKey() 返回新的 RuinResult 实例，原实例不变generateJson 默认为 true，会在 build 时自动覆盖已有 JSON 文件Guides API-Split multi-module architecture decisions for NeoPasterDream (NeoForge 1.21.1). Invoke when deciding where to place new code (PasterDreamAPI vs PasterDream), creating Builder/Facade/Result/Config classes, or designing new registration systems.
PasterDream模组药水效果注册专用API，提供Facade+Builder模式一键注册自定义MobEffect。在需要创建新状态效果、配置效果属性/着色器/粒子/回调/药水酿造时调用。
PasterDream模组实体注册专用API，提供Facade+Builder模式一键注册自定义实体。在需要创建新实体、配置实体属性/AI/碰撞箱/追踪范围/生物技能、动画系统或注册渲染器时调用。
PasterDream NeoForge 1.21.1 模组开发指南。提供项目结构、注册系统、实体系统、物品系统等的开发规范，以及常见崩溃问题的解决方案。Invoke when developing or modifying PasterDream mod features, creating new items/blocks/entities, fixing crashes, or when needing to understand the mod's architecture.
PasterDream 物品移植 API —— 用于将原 FixPasterDream 模组（MCreator 生成）中的物品系统化移植到 NeoForge 1.21.1。提供 Builder 模式、批量注册、迁移追踪、配方生成、战利品表生成、方块数据生成、创造标签页生成、语言文件生成及超级快速导入器等一站式工具链。Invoke when needing to port items from the old FixPasterDream mod, register new items in PDItems.java, batch-create items with consistent patterns, generate recipes/loot tables/block tags, or create creative tab registration code.
Minecraft NeoForge 1.21.1 方块掉落问题诊断与修复指南。Invoke when user encounters block drop issues, missing loot drops, or needs to implement custom block drops. Covers getDrops() override, BlockItem registration, and loot table JSON troubleshooting.