Configuring a Schematic

NOTE: The process of configuring a schematic is different starting with 1.0.3.0BETA. See the appropriate information below.

Once you have created a schematic and placed it into the ./minecraft/config/restructured/schematics folder you need to start your client once so that entries in the schematic.cfg can be created. You can then edit the schematics.cfg and adjust the settings for the schematic.

Schematic.cfg

Each schematic in the ./minecraft/config/restructured/schematics folder will have an entry in schematics.cfg that looks something like the following:

swineherd {
    # List of biome IDs [default: 24;10;11;0;7;6;16]
    S:biomeList=24;10;11;0;7

    # Treat the biome list as a blacklist vs. whitelist [default: true]
    B:biomeListAsBlacklist=true

    # What chest generation hook to use when filling chests [default: ]
    S:chestContents=swineherdChest

    # The number of stacks to pull from the generation table [range: 0 ~ 2147483647, default: 1]
    I:chestContentsCount=2

    # List of dimension IDs [default: 1;-1]
    S:dimensionList=1;-1

    # Treat the dimension list as a blacklist vs. whitelist [default: true]
    B:dimensionListAsBlacklist=true

    # Options for generation [default: suppressFire;suppressEggs]
    S:generationOptions=suppressFire;suppressEggs

    # The number of blocks below ground the structure extends [range: 0 ~ 2147483647, default: 1]
    I:groundOffset=1

    # Maximum number of this type of structure to have in a village [range: 0 ~ 2147483647, default: 1]
    I:limit=1

    # Chance that a spawner will be preserved when placed [range: 0 ~ 100, default: 15]
    I:spawnerEnableChance=15

    # Relative selection weight for village structure generation [range: 0 ~ 2147483647, default: 10]
    I:villageWeight=10

    # Number of villagers to spawn for the structure (-1 random) [range: -1 ~ 2147483647, default: 1]
    I:villagerCount=1

    # Villager profession: -1 random, 0 farmer, 1 librarian, 2 priest, 3 smith, 4 butcher [range: -1 ~ 4, default: -1]
    I:villagerProfession=4

    # Relative selection weight for world generation [range: 0 ~ 2147483647, default: 0]
    I:worldWeight=0
}

• swineherd - root name of the schematic file as found in the schematics folder.
• biomeList and biomeListAsBlackList - Controls what biomes the structure can spawn in. This only applies if worldWeight is greater than 0.
• chestContents - the possible content of the chest based on the associated entry in chests.cfg.
• chestContentCount - the number of selections that are to be made from the chestContents item list when filling a chest with loot. This applies to each chest in the schematic.
• dimensionList and dimensionListAsBlackList - controls what dimensions the structure can spawn in. This only applies if worldWeight is greater than 0.
• generationOptions - list of options to apply when generating the structure. Table of options can be found below.
• groundOffset - Y value adjustment when generating the structure. The default value assumes the schematic includes the blocks under the “players” feet. This is provided so that elevation can be tweaked when using schematics that are provided for other purposes.
• limit - The maximum number of structures of the given type that will be generated per village.
• spawnerEnableChance - The chance a spawner within the schematic will be placed during world generation in terms of a percentage. If the generation logic determines the spawner will not be placed it uses an air block instead.
• villageWeight - The relative weight the schematic will have when the generation logic randomly selects a structure to place. The higher the weight the more common the structure.
• villagerCount - The number of villagers to generate for this structure. Spawn location of the villagers will be in the center of the structure at ground level.
• villagerProfession - Profession of the villagers that are generated. This determines the trades that will be available to a player.
• worldWeight - Similar to villageWeight, this determines the relative weight of the structure when world gen decides to place a structure in the wild. 0 means that the structure is not eligible for world generation. It is possible to have a structure eligible for both village as well as world generation.

generationOptions

Option	Comment
suppressFire	All sources of burning are removed during generation. This includes lava as well as fire blocks.
suppressEgg	Monster egg blocks are removed and replaced with their mundane counterparts.
randomCrops	Crops planted on farm blocks will be randomized based rather than directly transcribed from the schematic. When randomized the planted crops could included modded crops.

Chests.cfg

This file contains a set of weight tables that are created using the ChestHook mechanism of Minecraft. If you are not familiar with weight tables I suggest you spend some time searching the internet.

swineherdChest {
    "minecraft:porkchop"=1,4,10
    "minecraft:carrot"=1,4,10
    "minecraft:leather_boots"=1,1,5
    "minecraft:wooden_hoe"=1,1,5
}

Each table is named (e.g. swineherdChest) and will have a ChestHook entry created within the Minecraft data space. Each entry in the list will have a weighted entry created in the ChestHook profile.

An entry has a specific format. The quoted string before the = matches a item name within the Minecraft configuration. The items are not limited to just Minecraft items - you could include items from other mods. However, if this is done the schematic is pretty much tied to packs that have that item defined.

The information after the = tells how many items to generate, and the relative weight for selection. For example, “minecraft:porkchop” has a relative weight of 10 to generate, and if selected will have 1-4 items generated. “minecraft:wooden_hoe” has a relative weight of 5 for selection, and will only have 1 item generated.

1.0.3.0BETA+

Starting with this release the preferred method of installing schematics is via a Schematic Pack. A Schematic Pack is a zip file containing a collection of schematics as well as default schematics.cfg and chests.cfg files for those schematics. As a regular user all you would have to do is drop the Schematic Pack ZIP file into the ./minecraft/config/restructured directory and start up Minecraft.

For those wishing to make their own Schematic Packs please see this page.