1. Addon Requirements

• Must be a Forge 1.20.1 mod.
• Must include Village Recruits as a dependency.
• Must register structures using the TowerAPI.
• Must provide .nbt structure files inside:
  src/main/resources/data/<your_modid>/structures/

2. Required Blocks Inside Every Structure

• Recruit Block: must be placed exactly at the center.
• basic_villager_spawner: must be placed inside the structure.

These blocks are required for NPC spawning, faction creation, and structure activation. If missing, the structure will not function correctly.

3. Before Saving / Placing Villager Spawner

1. Build the structure normally.
2. Run: /vr disable_spawner
3. Place the basic_villager_spawner and the recruit block.
4. Save the structure using a Structure Block.

If you forget to disable the spawner, it will activate and disappear, and will not be saved.

4. Structure Size Limits

• Max recommended size: 11×11 (X/Z)
• Ideal size: 9×9

Larger structures may be destroyed by other generated buildings.

5. Registering Structures in Your Addon

@Mod("your_addon_id")
public class YourAddon {

    public YourAddon() {

        ResourceLocation PLAINS = ResourceLocation.fromNamespaceAndPath("minecraft", "plains");
        ResourceLocation DESERT = ResourceLocation.fromNamespaceAndPath("minecraft", "desert");
        ResourceLocation JUNGLE = ResourceLocation.fromNamespaceAndPath("minecraft", "jungle");

        // Tower in desert and plains
        TowerAPI.addForBiome(
            DESERT,
            ResourceLocation.fromNamespaceAndPath("your_addon_id", "your_tower"),
            10
        );

        TowerAPI.addForBiome(
            PLAINS,
            ResourceLocation.fromNamespaceAndPath("your_addon_id", "your_tower"),
            10
        );

        // Barracks in plains and jungle
        TowerAPI.addForBiome(
            PLAINS,
            ResourceLocation.fromNamespaceAndPath("your_addon_id", "your_barracks"),
            3
        );

        TowerAPI.addForBiome(
            JUNGLE,
            ResourceLocation.fromNamespaceAndPath("your_addon_id", "your_barracks"),
            3
        );
    }
}
  

6. Structure File Placement

Place your .nbt files here:

Example:

• data/recruits_testaddon/structures/barracks.nbt
• data/recruits_testaddon/structures/desert_tower.nbt

package com.example.recruits_testaddon;

import com.example.villagerecruits.api.StructureOverrideAPI;
import net.minecraft.resources.ResourceLocation;
import net.minecraftforge.fml.common.Mod;

public class AddUserVillageStructures {

    public AddUserVillageStructures() {

        ResourceLocation SMALL_HOUSE = ResourceLocation.fromNamespaceAndPath(
            "recruits_testaddon", "small_house"
        );

        ResourceLocation BLACKSMITH = ResourceLocation.fromNamespaceAndPath(
            "recruits_testaddon", "blacksmith"
        );

        ResourceLocation WATCHTOWER = ResourceLocation.fromNamespaceAndPath(
            "recruits_testaddon", "watchtower"
        );

        StructureOverrideAPI.addHouse("plains", SMALL_HOUSE);
        StructureOverrideAPI.addHouse("plains", BLACKSMITH);

        StructureOverrideAPI.addWork("taiga", WATCHTOWER);

        StructureOverrideAPI.addHouse("meadow", SMALL_HOUSE);
        StructureOverrideAPI.addWork("meadow", BLACKSMITH);

        System.out.println("[Recruits Test Addon] Custom user structures added.");
    }
}
  

Removing vanilla buildings:

@Mod("recruits_testaddon")
public class ReplaceAllVillageStructures {

    public ReplaceAllVillageStructures() {

        ResourceLocation SMALL_HOUSE = ResourceLocation.fromNamespaceAndPath("recruits_testaddon", "small_house");
        ResourceLocation BLACKSMITH = ResourceLocation.fromNamespaceAndPath("recruits_testaddon", "blacksmith");
        ResourceLocation WATCHTOWER = ResourceLocation.fromNamespaceAndPath("recruits_testaddon", "watchtower");

        List<String> biomes = List.of(
            "plains", "sunflower_plains", "desert", "savanna", "taiga", "snowy",
            "meadow", "forest", "birch_forest", "old_growth_birch_forest",
            "cherry_grove", "swamp", "mangrove_swamp", "badlands",
            "wooded_badlands", "eroded_badlands", "windswept_hills",
            "windswept_forest"
        );

        for (String biome : biomes) {

            StructureOverrideAPI.replaceHouses(
                biome,
                List.of(SMALL_HOUSE, BLACKSMITH, WATCHTOWER)
            );

            StructureOverrideAPI.replaceWork(
                biome,
                List.of(SMALL_HOUSE, BLACKSMITH, WATCHTOWER)
            );
        }

        System.out.println("[Recruits Test Addon] All vanilla structures replaced.");
    }
}
  

Note: These structures must NOT contain a normal recruit block (unlike tower replacements).