Fabric Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Adding Structure Features [1.16.3] ======
:!: //**For versions 1.18 and beyond, the Fabric Structure API no longer exists and structures can be done entirely in datapacks. See [[https://minecraft.wiki/w/Tutorials/Custom_structures|tutorials in Minecraft Wiki]]. ** //

We’re going to look at registering and placing structures in your world.

To view examples of vanilla structures in action, ''IglooFeature'' and ''IglooGenerator'' are a good place to start. However, the growing standard for making new structures is using Jigsaw Structures which can be easier to work with and lets you deal with less structure code. [[jigsaw_old|Read more on Jigsaw Structures here and how to make them.]]

You are going to need a feature and generator for the most basic structure.
The feature handles the process of registering the structure and loading it in when the world is generating.
The generator handles the placement of blocks or loading in a structure file if you choose to do so.

Note that this tutorial depends on [[https://github.com/FabricMC/fabric/pull/1097|Biome Modification API in Fabric API]] which is marked as experimental.
If the API doesn't work, consider using [[start?rev=1599808070|the mixin version]].

===== Creating a Feature =====
To create a basic feature, we recommend creating a class that extends ''StructureFeature<DefaultFeatureConfig>''.
Various vanilla structures, such as shipwrecks, igloos, and temples, use ''StructureFeature<DefaultFeatureConfig>'' as a base.

You will have to override ''getStructureStartFactory'' method.
For ''getStructureStartFactory'', most vanilla structures make a class that extends ''StructureStart'' inside their feature class.

<code java>
public class MyFeature extends StructureFeature<DefaultFeatureConfig> {
  public MyFeature(Codec<DefaultFeatureConfig> codec) {
    super(codec);
  }

  @Override
  public StructureFeature.StructureStartFactory<DefaultFeatureConfig> getStructureStartFactory() {
    return Start::new;
  }

  public static class Start extends StructureStart<DefaultFeatureConfig> {
    public Start(StructureFeature<DefaultFeatureConfig> feature, int chunkX, int chunkZ, BlockBox box, int references,
        long seed) {
      super(feature, chunkX, chunkZ, box, references, seed);
    }

    // Called when the world attempts to spawn in a new structure, and is the gap between your feature and generator.
    public void init(DynamicRegistryManager registryManager, ChunkGenerator chunkGenerator, StructureManager manager, int chunkX,
        int chunkZ, Biome biome, DefaultFeatureConfig config) {
      int x = chunkX * 16;
      int z = chunkZ * 16;
      int y = chunkGenerator.getHeight(x, z, Heightmap.Type.WORLD_SURFACE_WG);
      BlockPos pos = new BlockPos(x, y, z);
      BlockRotation rotation = BlockRotation.random(this.random);
      MyGenerator.addPieces(manager, pos, rotation, this.children);
      this.setBoundingBoxFromChildren();
    }
  }
}
</code>

===== Creating a Generator =====
As you have probably noticed, we need to create a generator.

This is where structure files and generating straight from a ''generate'' method part ways. There are two ways to go about this:

  * If you want, you can simply override ''generate'' in your piece class and use ''addBlock'' to place blocks directly in the world. This is a valid option and was popular pre-1.13.
  * Use structure files. These are rather powerful at this point and are highly recommended.

In this tutorial, we'll use a structure file.
It doesn't need to override anything, but does require the following:
  * An identifier that points to your structure file; use ''"igloo/top"'' if you need an example.
  * Some sort of setup method - ''addPieces'' is a good name.

<code java>
public class MyGenerator {
  private static final Identifier IGLOO_TOP = new Identifier("igloo/top");

  public static void addPieces(StructureManager manager, BlockPos pos, BlockRotation rotation, List<StructurePiece> pieces) {
    pieces.add(new MyPiece(manager, pos, IGLOO_TOP, rotation));
  }
}
</code>

In your ''addPieces'' method, you can choose which structure pieces are added to your generation process.

We're now going to create the piece we just referenced; make a class called ''MyPiece'' that extends ''SimpleStructurePiece'' //within your generator class//.

Override required methods, and add a constructor that takes in a ''StructureManager'', ''BlockPos'', ''Identifier'' and ''Rotation''.
**toNbt isn't required but is available if you need it**.
We're also implementing ''initializeStructureData'', which is not an override.
We also have 2 constructors: 1 for our own pieces, and one for registry.
A basic template would be:

<code java>
public static class MyPiece extends SimpleStructurePiece {
  private final BlockRotation rotation;
  private final Identifier template;

  public MyPiece(StructureManager structureManager, CompoundTag compoundTag) {
    super(ExampleMod.MY_PIECE, compoundTag);
    this.template = new Identifier(compoundTag.getString("Template"));
    this.rotation = BlockRotation.valueOf(compoundTag.getString("Rot"));
    this.initializeStructureData(structureManager);
  }

  public MyPiece(StructureManager structureManager, BlockPos pos, Identifier template, BlockRotation rotation) {
    super(ExampleMod.MY_PIECE, 0);
    this.pos = pos;
    this.rotation = rotation;
    this.template = template;

    this.initializeStructureData(structureManager);
  }

  private void initializeStructureData(StructureManager structureManager) {
    Structure structure = structureManager.getStructureOrBlank(this.template);
    StructurePlacementData placementData = (new StructurePlacementData())
      .setRotation(this.rotation)
      .setMirror(BlockMirror.NONE)
      .addProcessor(BlockIgnoreStructureProcessor.IGNORE_STRUCTURE_BLOCKS);
    this.setStructureData(structure, this.pos, placementData);
  }

  protected void toNbt(CompoundTag tag) {
    super.toNbt(tag);
    tag.putString("Template", this.template.toString());
    tag.putString("Rot", this.rotation.name());
  }

  @Override
  protected void handleMetadata(String metadata, BlockPos pos, ServerWorldAccess serverWorldAccess, Random random,
      BlockBox boundingBox) {
  }
}
</code>
    
''handleMetadata'' is where you look at data blocks within your structure and can do tasks based on what you find.
This can be good for dynamic stuff such as placing certain mobs based on what mod is on and so on.

In vanilla structures, data blocks are placed above chests so they can be filled with loot in this method. 
HOWEVER, you do not need to use datablocks to place chests with loot. Instead, use this command to set a north facing chest with a loottable. 
Save this chest into your structure's nbt file and it will generate loot when opened for the first time. (Don't open the chest before saving to the nbt file!)
<code>/setblock ~ ~ ~ minecraft:chest[facing=north]{LootTable:"modid:loottable"}</code>

We set the ''StructurePieceType'' to ''ExampleMod.MY_PIECE''; this is the variable that holds your registered structure piece. 

===== Registering Structures =====
The last step is to register our structures. We're going to need to register:

  * structure
  * piece
  * configured structure

<code java>
public class ExampleMod implements ModInitializer {
  public static final StructurePieceType MY_PIECE = MyGenerator.MyPiece::new;
  private static final StructureFeature<DefaultFeatureConfig> MY_STRUCTURE = new MyFeature(DefaultFeatureConfig.CODEC);
  private static final ConfiguredStructureFeature<?, ?> MY_CONFIGURED = MY_STRUCTURE.configure(DefaultFeatureConfig.DEFAULT);

  @Override
  public void onInitialize() {
    Registry.register(Registry.STRUCTURE_PIECE, new Identifier("tutorial", "my_piece"), MY_PIECE);
    FabricStructureBuilder.create(new Identifier("tutorial", "my_structure"), MY_STRUCTURE)
      .step(GenerationStep.Feature.SURFACE_STRUCTURES)
      .defaultConfig(32, 8, 12345)
      .adjustsSurface()
      .register();

    RegistryKey<ConfiguredStructureFeature<?, ?>> myConfigured = RegistryKey.of(Registry.CONFIGURED_STRUCTURE_FEATURE_WORLDGEN,
        new Identifier("tutorial", "my_structure"));
    BuiltinRegistries.add(BuiltinRegistries.CONFIGURED_STRUCTURE_FEATURE, myConfigured.getValue(), MY_CONFIGURED);
  }
}
</code>

===== Adding a configured feature to biomes =====
In this tutorial, we add our structure to all biomes.

<code java>
public class ExampleMod implements ModInitializer {
  [...]
 
  @Override
  public void onInitialize() {
    [...]

    BiomeModifications.addStructure(BiomeSelectors.all(), myConfigured);
  }
}
</code>

===== Result =====
You should be met with igloos.
You can use below command to find your structure in the world.

<code>
/locate tutorial:my_structure
</code>

{{tutorial:structures.png?800}}