Minecolonies Logo

Schematics


Schematics

Schematics are files containing block and entity information of a certain area a player scanned with the Scan Tool in-game. You can use the Scan Tool and scan ANY building or structure you like in singleplayer or multiplayer and then have your Builder build it for you (provided that you give them all the materials needed, of course).

A Schematic World

While you can build and scan schematics in any world, it's strongly recommended to create a separate creative world to design and build them, separate from your regular colony worlds. It's also often easier to design and build in single-player, though you can of course do it on a server if you want to collaborate with others. It's also recommended to do your builds outside of any existing colony (typically you would not create any colonies at all in that world) and even to disable mobs/weather/ticks to reduce disturbance of your builds.

If you're designing a full style pack, then on the Discord server you can find a player-created world download that contains build "pads" for most of the building types, along with a command-block-based auto-scanning system to help speed things up -- though of course you can do things a different way if you prefer.

It's recommended to enable the blueprintbuildmode setting in the MineColonies server config file; this makes it a bit easier to do certain things without creating a colony.

If you're a Patreon, you have access to the official schematic server, and can request a plot area to make your own blueprints there, which may be useful if you want to collaborate with other Patreons.

Scanning a New Structure

Once you have a structure or area you want to scan to have your Builder build, you need to determine the exact area that needs to be scanned.

If the area you want to scan contains multiple anchor blocks (hut blocks, Tag Anchor , or Decoration Controller ; also including some special blocks like the Stash ) you should shift-left-click the correct anchor block (e.g. the Barracks hut block in a Barracks schematic) first, before selecting corners.

TestBuilding

Using the Scan Tool , left-click on the bottom-left corner of your blueprint.

ScanPoint1

Next, right-click on the top-right corner of your blueprint. It's often helpful to place a Placeholder there so that you have something convenient to click on, without disturbing your actual build.

ScanPoint2

Then click in the air to see the entire structure.

ScanFull

Once you have the full area set, you can press Escape and the white outline of the scan area will stay in place. Go around it to double-check that everything you want is in the scan area. When you are ready, you can right-click in the air again to get the GUI to display where you can enter your scan name. Then press the green checkmark to save the scan.

Special note:

  1. Do not rename the file after scanning. It must be scanned with the correct name.
  2. If you include two or more of anchor blocks in your structure you must set which will be your anchor for the schematic by sneak left clicking on the desired anchor block.
  3. Hut buildings use the associated hut block as the anchor, upgradable decorations should use the Decoration Controller as the anchor and non upgradable decorations should use the Tag Anchor block as the anchor.
    • If you want non upgradeable decorations acting as leisure sites, you must use a Decoration Controller as only those sites are selected to be leisure sites.

Scans are saved in ../minecolonies/scan/new/....

Once the scans are saved, they need to be moved to the ../structurize/schematics/(folder)/file if they are a custom hut.

Scans are saved in */blueprints/<yourplayername>/scans.

Once the scans are saved, they need to be placed in a style pack, preferably in the correct folder. See the style packs chapter for more details.

Placing a Schematic.

Once you have scanned a structure, you can use the Build Tool to have your Builder build it for you. Once you right-click with the build tool, you will have to select "My Schematics" (in the left dropdown menu) and on the right dropdown menu you will see the scans that you have made. There is also a Rename button where you can change the name of the scan. You can also delete any of your saved scans.

Schematic

The scanned structure can be found in the Build Tool under the style pack with your own name. Click "Switch Pack" -> "<yourplayername>" (icon looks like the Scan Tool ) -> "scans".

Style packs

Styles are now structured in so-called style packs. This is similar to a resource pack or data pack, in that it has a file with some metadata about the style (the name, a description, optionally a link to an image, etc.), and a folder structure with the actual files.

Stylepacks live in the blueprints folder, within your Minecraft folder. This folder already contains one style pack: One with your player's name. This style pack will contain your scanned files, and can be used to test schematics. In order to make a new style, you need to make a new schematic pack.

The pack.json

This json file contains metadata describing the style:

Key NameTypeDescription
"version"numberPack version, start at 1, increase it whenever you make a new version of the pack
"pack-format"numberDescriptor for the pack format, needs to be 1 at the moment
"desc"stringDescription of the style. This will be visible in the build tool to explain what your style is about
"authors"array of stringsNames of the authors, in order to credit them. This is visible in the build tool
"mods"array of stringsNames of used mods (ids). The style is not visible if one of those mods is not installed, to prevent broken schematics
"name"stringThe name of the style pack
"icon"stringThe name of the file with an icon which is showed in the style packs selection screen

You have to increase the version number whenever you release your pack for others to use. You don't need to increase it when testing changes purely in single-player. In particular, whenever the pack is installed on a server, it must have a higher version than what other players already have, or they won't be sent the updates automatically.

The folder structure

There are several folders, separating the buildings and decorations in categories. Each of the folders at the highest level can have a couple of icons, named icon.png and icon_disabled.png. Those are shown in the button bar right above the hot bar.

You can download a template folder structure from github (template.zip), which contains the icons used for the official styles already. That github page also contains examples how different styles are structured. An overview with which buildings go into which folders can also be found here.

With a few specific exceptions, you don't have to strictly follow the standard folder structure -- but it's recommended to stick to it when possible to make it easier for others to find specific buildings and decorations. But you're free to make extra folders to help group separate but related sets together, especially if you don't want them to appear directly as alternate buildings. E.g. if you have two styles of roads, one for early game and one for later game, you could put them in infrastructure/roads/simple/ and infrastructure/roads/nice/.

Note: It's strongly recommended to have each folder only contain files or subfolders, but not both. While it is possible to mix them, the build tool doesn't display it as nicely.

FAQ

This is a FAQ section to answer common questions regarding schematics in MineColonies.

How do I install custom schematics I just downloaded?

Those custom schematics go in */structurize/schematics. Unzip the zip you downloaded, and put all subfolders in the schematics folder. That folder should contain folders like <stylename>, decorations, walls, supplycamps etc. (depending on which style you installed)

The style pack goes in the "blueprints" folder. Unzip the zip, and find the folder containing the pack.json (either the unzipped folder, or a folder directly under it, depending on how the zip was made). This folder needs to be placed in */blueprints directly, not any subfolder thereof -- i.e. you should have "blueprints/onestyle/pack.json", "blueprints/anotherstyle/pack.json", etc.

What and where is the scans folder?

The scans folder is where the schematics are saved after performing a scan using the Scan Tool in MineColonies.

This is a client-side-only directory which is located in Minecraft's folder under: */structurize/scans/. Freshly scanned schematics can be found in */structurize/scans/new/ unless they have been renamed in-game. (If they aren't there, look in */minecolonies/scans/new.) This directory is shared between all your singleplayer games and multiplayer games.

This is located in your own style pack in Minecraft's folder under: */blueprints/<yourplayername>/scans/. This folder is shared between all your singleylayer and multiplayer games.

Where is the schematic folder?

Custom schematics need to be copied inside the schematic folder. For both singleplayer and multiplayer games, the folder is under */structurize/schematics/.

Custom schematics need to be placed in a (custom) style pack. For more information about that, look there.

I have a "*/minecolonies/01e6a291-8a01-4763-bcae-f3a8797b1d52/cache/" folder, what is that for?

When playing on a server, the server needs to send the schematics to the players so that the build tool's preview works. Those schematics are saved in Minecraft's directory under */structurize/{ServerUUID}/cache/, where ServerUUID is the unique identifier of the server. Those directories can be safely removed as they are automatically created by the server when needed.

This was previously used to save schematics from a server and was automatically created as needed. However, this is no longer needed in 1.19.2 and later, so this folder can be removed safely.

I have a "/blueprints/clients/" folder, what is that for?

On a server, this folder holds a cached copy of the decorations and shapes used by your players -- possibly even including entire style packs that they've installed themselves (though note that for game balance purposes they won't be able to make functional buildings this way; these must be installed "properly" on the server to be usable).

You can delete these folders at any time (though preferably when the player is not logged in); they will be re-created as needed.

Can I just build my own buildings and then get the colonists to "move in"?

No. Functional buildings must be constructed by the Builder. You have to either use one of the prefabs provided by existing style packs (either included in the mod or via various addons installed separately), or design your own custom huts as an explicitly separate step (typically in a special creative designing world), before getting the builder to place them in your real colony. MineColonies is more like an RTS than it is like classic Minecraft building.

How to create custom huts?

To create new schematics, there are some guidelines that you must follow: the scans must have the same footprint for each level of the hut; the scans must contain the hut's block, for example the Builder's Hut block for the Builder's Hut ; the hut block need to be exactly at the same place and have the same rotation for each level.

Ensure you are building your custom hut outside of any colony borders. When placing the hut block inside the custom schematic, shift+right click to place it without activating it. Then you can scan and save the schematic.

The scans' filenames need to follow the naming convention: {StyleName}/{HutName}{HutLevel}.blueprint. For example, for the Builder's Hut with the MyOwn style, we would have:

myown/builder1.blueprint myown/builder2.blueprint myown/builder3.blueprint myown/builder4.blueprint myown/builder5.blueprint

  • Note: In the Build Tool , the extension is hidden. HutName can be any of the listed huts below. The maximum level is 5 (except for the Tavern ; its max level is 3).

Alternative designs can be placed under a style name like "myownalternative", or a subfolder like myown/alt/*.

Once ready, move the myown folder into the blueprints folder and start your game. You should be able to see it with the the build tool.

Note: Remember that you need the appropriate hut in your inventory to be able to see the schematics in the build tool.

The naming for the buildings is not strict anymore. The only things that are important are that they are named consistently, that their names end with the hut level, and that you only use lowercase letters in the hut names (avoid capitals, spaces, or other punctuation). Alternate designs can just have a different name than the primary one. E.g. if you named the level 1 Builder's Hut "builder1", an alternative version could be called "altbuilder1" or "builderalt1" or even something completely different ("constructionworker1"). Don't use numbers anywhere in the name except right at the end for the level. E.g. "alt1builder1" won't work as expected.

Once ready, you need to make a style pack out of them. The schematics are visible in the build tool without the hut block, but you can't view them in survival mode (their button is greyed out, with an error message that you need to have the hut block).

[1.18] Custom Hut Filenames

Here is a full list, up-to-date as of 14 October 2022, of the building names. Please note do not use capital letters in hut names.

As previously noted, you don't need to stick to these names if you have something better, as long as you're consistent at each level.

Level 1Level 2Level 3Level 4Level 5
archery1archery2archery3archery4archery5
alchemist1alchemist2alchemist3alchemist4alchemist5
baker1baker2baker3baker4baker5
barracks1barracks2barracks3barracks4barracks5
barrackstower1barrackstower2barrackstower3barrackstower4barrackstower5
beekeeper1beekeeper2beekeeper3beekeeper4beekeeper5
blacksmith1blacksmith2blacksmith3blacksmith4blacksmith5
builder1builder2builder3builder4builder5
chickenherder1chickenherder2chickenherder3chickenherder4chickenherder5
citizen1citizen2citizen3citizen4citizen5
combatacademy1combatacademy2combatacademy3combatacademy4combatacademy5
composter1composter2composter3composter4composter5
concretemixer1concretemixer2concretemixer3concretemixer4concretemixer5
cook1cook2cook3cook4cook5
cowboy1cowboy2cowboy3cowboy4cowboy5
crusher1crusher2crusher3crusher4crusher5
deliveryman1deliveryman2deliveryman3deliveryman4deliveryman5
dyer1dyer2dyer3dyer4dyer5
enchanter1enchanter2enchanter3enchanter4enchanter5
farmer1farmer2farmer3farmer4farmer5
fisherman1fisherman2fisherman3fisherman4fisherman5
fletcher1fletcher2fletcher3fletcher4fletcher5
florist1florist2florist3florist4florist5
glassblower1glassblower2glassblower3glassblower4glassblower5
graveyard1graveyard2graveyard3graveyard4graveyard5
guardtower1guardtower2guardtower3guardtower4guardtower5
hospital1hospital2hospital3hospital4hospital5
library1library2library3library4library5
lumberjack1lumberjack2lumberjack3lumberjack4lumberjack5
mechanic1mechanic2mechanic3mechanic4mechanic5
miner1miner2miner3miner4miner5
mysticalsite1mysticalsite2mysticalsite3mysticalsite4mysticalsite5
netherworker1netherworker2netherworker3netherworker4netherworker5
plantation1plantation2plantation3plantation4plantation5
rabbithutch1rabbithutch2rabbithutch3rabbithutch4rabbithutch5
sawmill1sawmill2sawmill3sawmill4sawmill5
school1school2school3school4school5
shepherd1shepherd2shepherd3shepherd4shepherd5
sifter1sifter2sifter3sifter4sifter5
smeltery1smeltery2smeltery3smeltery4smeltery5
stonemason1stonemason2stonemason3stonemason4stonemason5
stonesmeltery1stonesmeltery2stonesmeltery3stonesmeltery4stonesmeltery5
swineherder1swineherder2swineherder3swineherder4swineherder5
tavern1tavern2tavern3N/AN/A
townhall1townhall2townhall3townhall4townhall5
university1university2university3university4university5
warehouse1warehouse2warehouse3warehouse4warehouse5

Custom Supply Ships and Camps

The process for custom Supply Camp and Ship is slightly different:

Camp or ShipFile Name and Path
Campstructurize/schematics/supplycamp/myownsupplycamp
Shipstructurize/schematics/supplyship/myownsupplyship

So, for example, the path would be structurize/schematics/wildwest/builder1 for the Builder's Hut level 1 and structurize/schematics/supplycamp/wildwestsupplycamp for the supply camp.

Camp or ShipFile Name and Path
Campblueprints/<myownstyle>/decorations/supplies/supplycamp
Shipblueprints/<myownstyle>/decorations/supplies/supplyship
Nether Shipblueprints/<myownstyle>/decorations/supplies/nethership

So, for example, the path would be blueprints/wildwest/fundamentals/builder1 for the Builder's Hut level 1 and blueprints/wildwest/decorations/supplies/supplycamp for the supply camp.

Because these have a fixed name, you can't have more than one per style and type.

You should always apply a groundlevel tag using the Tag Tool when making a supply camp/ship. The rules for guessing where the ground level is without the tag change depending whether they're placed by the Build Tool or the Supply Camp and Ship, for legacy reasons.

Hut Requirements

Some buildings may also require tags to be set on certain blocks using the Tag Tool .

BuildingRequirementsSuggested
Archery 1 practice dummy (a target block); 1 bed per levelat least 1 standing position per level (a glowstone block, or any block tagged with work)
Alchemist Laboratory 1 brewing stand per level; 2 soul sand per level starting at level 2 (with 4 soul sand); leaves next to logs, i.e. "trees"
Bakery 1 furnace
Barracks 1 Barracks Tower per level (up to level 4)
Barracks Tower 1 bed per level
Builder's Hut 1 rack per level
Combat Academy 1 practice dummy per level (a pumpkin on top of a bale of hay); 1 bed per level
Composter's Hut 1 Compost Barrel per level
Concrete Mixer's Hut 3 blocks of flowing water with solid blocks below and air blocks above, which the worker can stand next to
Dyer's Hut 1 furnace
Fisher's Hut At least 7 blocks wide, 7 blocks long and 2 blocks deep unobstructed body of water if integrating fishing location in the schematic
Flowershop 4 Compost per level
Glassblower's Hut 1 furnace per level
Graveyard Named Graves, with the amount increasing per level14 named graves at level 1, 18 named graves at level 2, 27 named graves at level 3, 36 named graves at level 4, 50 named graves at level 5
Guard tower 1 bed for aesthetics
Hospital 1 bed per level
House Residence 1 bed per level
Library Bookshelves
Mine A few starting ladders where the shaft's ladders will go with the tags [cobble] and [ladder]
Nether Mine A nether portal, and an enclosed 1x1x2 room
Plantation 12 per level, 4 for each of sugar cane, cactus and bamboo
Restaurant 1 furnace per level
School 2 carpets per level4 carpets per level
Smeltery 1 furnace per level
Stone Smeltery 1 furnace per level
Tavern 4 beds and a dining roomBarrels
University Bookshelves
Warehouse Rack (more each level)

It's usually recommended to include a few Rack s in the various crafter's huts (and more in the Builder's Hut ). A rough guide might be to include 0-1 at level 1, then add 1-2 per level — but you can vary this quite a bit based on your design, layout, and playtesting.

Level Requirements for Overworld Styles

LevelRequirements
Level 1Very Easy - Wooden
Level 2Easy - Iron
Level 3Medium - Nether
Level 4Difficult - Ocean
Level 5Very Difficult - End

Level Requirements for Nether Styles

LevelRequirements
Level 1Very Easy - Nether
Level 2Easy - Rarer Nether
Level 3Medium - Overworld
Level 4Difficult - Ocean
Level 5Very Difficult - End

Plantation Fields

In 1.19.2 and beyond, the plantation has been changed to include fields, just like the Farmer . However, unlike the Farmer , these fields can be completely free-form and created by the style designers. Each field has certain requirements for the Planter to do their work successfully.

Each plant has 2 separate tags: a field tag and a work tag. The field tags are given to the plantation field block to define what plants this field handles. The work tag is given based on the implementation of the field.

A field can have as many field tags as you want, but not 2 of the same.

PlantField tagWork tagMaximum work tags
Sugar canesugar_fieldsugar20
Cactuscactus_fieldcactus20
Bamboobamboo_fieldbamboo20
Cocoacocoa_fieldcocoa5 (totalling 20 positions; details below)
Vinevine_fieldvine20
Kelpkelp_fieldkelp20
Seagrassseagrass_fieldseagrass121 (11 x 11 area)
Sea Picklesseapickle_fieldseapickle10
Glow Berriesglowb_fieldglowb_vine20
Weeping Vinesweepv_fieldweepv_vine20
Twisting Vinestwistv_fieldtwistv_vine20
Crimson Plantscrimsonp_fieldcrimsonp_ground121 (11 x 11 area)
Warped Plantswarpedp_fieldwarpedp_ground121 (11 x 11 area)

The Planter will always attempt to walk to any adjacent air block around the planting position. If none of the adjacent positions are air, the planter will attempt to walk to the block itself. This prevents the Planter from standing on the block itself whilst, for example, placing a block down like cactus, after which the Planter would be standing inside of the plant.

Note: Make sure that the Planter can always get within about 4 blocks of the desired position. If not, they will teleport around to reach the position, which may not always work.

Note: Kelp is an exception to this behaviour. To prevent planters from diving into the water, the planter will walk to the first air block above the work tagged block and look up 26 blocks from the work tagged block. If this is not possible, they will not be able to harvest this plant, so ensure there is air above the water above the work tagged block.

Kelp field movement explanation

  • The red X is the position where the planter will walk to in the example image.
  • The blue X is the position where the work tag of the block is.

For downwards-growing plants, the planter will attempt to stand above the work tagged block and harvest below them. Make sure the planter can reach the top of the stem.

Vertically Growing Plants (Upwards and Downwards)

A "vertically growing plant" is a plant that grows in a single line, either upwards or downwards; for example, Sugar Cane is a vertically growing plant that grows upwards. These plants always break fully when their root blocks are broken. The planter will break these at the second block from the root.

Each of these plants have a minimum and sometimes a maximum growth height. The planter can only harvest them when they reach the minimum. If plants have a maximum height, the planter will have an increasingly higher chance to harvest the plant the taller it gets. Plants are only required to grow to the minimum height within the bounds of the schematic.

PlantMinimum heightMaximum height
Sugar cane3N/A
Cactus3N/A
Bamboo616
Kelp225
Glowberries3N/A
Weeping vines225
Twisting vines225

Treeside Plants

Treeside plants grow directly on the sides of trees. For these plants, you only need to tag the tree's stem; the working positions will automatically be set to every horizontally adjacent block of the tagged stem. Currently this is only used for Cocoa beans.

Note that this means that the amount of tags you can actually place is the amount of working positions divided by 4!

Bonemealed Fields

Bonemealed fields will tell the planter to use bonemeal somewhere on the ground to grow plants as if the player had used bonemeal.

The amount of planting positions on these fields are usually unlimited because bonemealing the ground has a set area of effect. However, it is suggested not to make the fields too big; an area around 7x7 is lightly suggested.

Every bonemealed plant works slightly differently.

PlantWork tag location
SeagrassThe block directly below the water should tagged; the planter will bonemeal the tagged block itself. Red Xs are where the planter will attempt to walk. Blue Xs are the blocks that are tagged with the work tag.Seagrass explanation
Sea picklesThe block directly below the water should tagged. The planter will initially place the pickles, then bonemeal the pickles to let them grow. Red Xs are where the planter will attempt to walk. Blue Xs are the blocks that are tagged with the work tag.Sea Pickle explanation
Crimson plantsTag all the nylium ground blocks where the plants are supposed to grow.
Warped plantsTag all the nylium ground blocks where the plants are supposed to grow.

Percentage-based Harvesting

Percentage based harvesting fields will attempt to place a minimum percentage of plants down on given spots. These plants — such as vines — should then naturally spread to their surroundings without the player's help. The planter has no involvement in this process.

PlantTag location
VineTag all the positions where the vines themselves can spread to, NOT the blocks where the vines are attached to.

Tips on Building

Do

  • Make all levels of a hut have the same footprint for x, y, and z
  • Place the hut block in the same location with the same rotation
  • Make sure all Rack and furnaces are in the same location through all levels (to prevent the contents spilling out when they're getting moved)
  • Use Placeholder Blocks where you want to keep any existing block (including from level to level), like the Barracks Tower in the Barracks schematic
  • Use Placeholder Blocks at or below ground level
  • Place a groundlevel tag at ground level if your hut isn't sitting directly on the ground.
  • Use only vanilla blocks or Structurize blocks (for official styles)
  • Use a Written Book on a lectern if you want to include some instructions. (Keep a copy of the original book and quill elsewhere, so you can edit it for pack updates!)
  • If you do use blocks from additional mods, and your buildings would look weird if those blocks simply vanished, then list the mod's id in your pack.json.

Don't

  • Use unobtainable items in builds (no command blocks, petrified wood, infested blocks, or mob heads (including player heads))
  • Change someone else's style (officially) unless specifically asked to do so
  • Rename schematics after scanning
  • Rename, move, or delete existing buildings after a style pack has been released (it will cause problems for existing colonies)
  • Use capital letters or punctuation (or spaces) in your schematic names; all lower-case is preferred.
  • Put a number anywhere in the schematic name except right at the end to indicate level
  • Put a unique item (something with special data, such as a written book or a patterned banner) into an item frame, chest, or other container (lecterns are ok). Also avoid putting complex-dyed armor anywhere; single-dyed is ok but remember that the player will have to figure out and duplicate it.

Additional Information

How to override some built-in schematics?

Simply create a schematic file with the same style/name. For instance, to override the Builder's Hut wooden level 1, create a schematic file name called wooden/builder1.blueprint.

Unfortunately, this is not possible, unless you override the entire style (make a style pack with the same name as an existing style pack, in that case).

However, you can create an "addon pack" with only a few buildings and/or decorations, intended to be used with the original pack; players will be able to mix'n'match from all packs.

How to use custom huts?

The custom huts need to be copied in the schematics folder.

The custom huts need to be copied into a style pack.

Once copied, you can start your singleplayer or multiplayer game as usual. You should see them in the Build Tool (if you have the hut block in your inventory).

How to allow my players to use their own huts' schematics on my server?

You will have to copy them yourself in the blueprints folder on the server and restart it.

How to allow my players to use their scanned decoration schematics on my server?

This is enabled by default, but if you want to change this, edit the Structurize configuration file at minecraft/config/structurize-common.toml and set allowPlayerSchematics to true. This allows the player to use their own decorations. It is not possible for the player to use their own huts' schematics. You can also limit the number of players' schematics at any given time by editing maxCachedSchematics (default is 100). When the limit is reached, the server will start deleting unused schematics.

How to disable built-in schematics completely?

Edit the Structurize configuration file at minecraft/config/structurize-common.toml and set ignoreSchematicsFromJar to true. Be aware: things will break if some huts' schematics are missing.

How to create upgradable decoration schematics?

Add the Decoration Controller somewhere in the schematic with the name of the schematic, where you'll put it in the file directory, and its level. Make sure to actually put the decoration in that file path, but only after scanning - don't include the path in the scan name.

Put the Decoration Controller somewhere in the schematic, and make sure the name of the schematic ends with a number while scanning. The decoration controller will automatically find the decoration in the same folder with the next number.

Contrary to the image below, you don't need to enter anything into the deco controller's GUI before scanning any more -- but the rest of that image is still useful.

Upgradable Decos

How to use custom mineshafts in style packs?

The size must be 9 x 4 x 9 blocks. They must be named and oriented exactly the same (i.e. do not rotate at all) as in the default style pack (careful: the names aren't entirely consistent with the layout, so make careful note which is which!) Use an existing style pack as a template along with the Scan Tool to create the blueprints.

The custom mineshafts need to be at schematics/yourstyle/miner/*.

The custom mineshafts need to be at `blueprints/yourstyle/infrastructure/mineshafts/*.

It's recommended that you use the Tag Anchor to make the mineshafts invisible. Take care that the anchor is in the same position as in the original mineshafts -- the very center bottom block.

How to make custom quarries in style packs?

The Quarry is split into a "top part" and a "bottom part". Both parts only have one level each (but unlike decorations, are expected to still include the level number in the filename).

The top part is constructed by the Builder and is the part outside of the quarry pit -- decorative walls, fences, cranes, racks, etc. This contains the actual Quarry hut block itself , which should pretty much always be on the second y level up from the bottom (i.e. the bottom layer is the ground level, then the hut is on the next layer up), although with some caveats this is not absolutely required.

The bottom part is constructed by the Quarrier and is the actual quarry pit itself, consisting mostly of placeholders, air blocks, and decorative elements. While you can also set the anchor manually, it's recommended to use a Tag Anchor . The anchor should normally be at the very top layer, although with some caveats it can be elsewhere.It's also recommended to tag this as invisible to avoid cluttering the build menu -- it usually doesn't make sense to let it be built as a decoration.

The top parts must be named simplequarry1 and mediumquarry1, and the corresponding bottom parts are simplequarryshaft1 and mediumquarryshaft1.

The top part can be in any folder and name that you like (and you can have more than one alternate), but the canonical names are infrastructure/mineshafts/simplequarry1 and infrastructure/mineshafts/mediumquarry1. Players will usually expect to find them in this folder.

The bottom part should usually be in the same folder and with the matching name but with shaft before the number -- e.g. infrastructure/mineshafts/simplequarryshaft1 and infrastructure/mineshafts/mediumquarryshaft1.

Alternatively, you can put a shaft= tag on the top part's Quarry block to specify a different name -- e.g. shaft=bighole1 to look for bighole1 in the same folder as the quarry, or shaft=decorations/quarrypit1 to look in a different folder.

Importantly: when built, the two schematics are aligned such that the anchor of the bottom part is exactly two blocks below the anchor of the top part. You should carefully align them when designing. It may be helpful to build them directly on top of each other when designing and simply scan them as two separate parts.

It is permitted for the quarry to be a slightly different size from the default versions, but it's strongly encouraged (for game balance reasons) to make each one approximately the same size as the originals, and in particular to have the same amount of air blocks in the bottom part, since this affects the final yield of cobble or other stone.

Can I make dedicated buildings for specific jobs within the same building type?

Nope.

Using the Tag Tool , you can place one or more job= tags on the hut block to limit which jobs can actually work there. Currently, the only sensible combinations are:

  • Guard tower : one or more of job=knight, job=ranger, job=druid. You can use these if you want to decorate your towers with specific themes (e.g. archery motifs).
  • Mine : one of job=miner or job=quarrier. You can use this if you want to make a large building with a mineshaft for the Miner and a smaller one without for the Quarrier .

How to create parent/child buildings or decorations?

The Barracks and Barracks Tower always have a parent/child relationship (i.e. the Barracks Towers are embedded within the Barracks , not directly built separately with the build tool). It's also possible to do the same with other buildings -- either putting one or more buildings into a containing decoration (e.g. a "district" of related buildings) or even embedding buildings within other buildings.

Some popular combinations are to embed couriers within the warehouse, and fields within the farmer. Other combinations are possible, depending on your goals for the style -- but don't go too overboard! Some players like combination buildings since they fit nicely together, but others don't like them since they can take away flexibility and creativity when building a colony.

When designing parent/child schematics, the key is the Placeholder . The parent schematic needs to contain the child hut block in the correct position and rotation, along with Placeholder s wherever there should be a block from the child, and the parent's own blocks. Similarly, the child schematic needs its own hut block and other blocks, and Placeholder s wherever there should be a block from the parent. It can be helpful to make a temporary scan of either the parent or child and overlay them over the other to help line things up, or to build both together and then duplicate it and split apart the designs.

While strictly speaking it's only mandatory to include the child hut at the level that it's introduced into the parent and you could put only a Placeholder at higher levels, it's strongly recommended to always include the child hut in every higher level of the parent. This works better when someone moves or repairs the parent, or skips levels and pastes it directly at a higher level.

Also remember that the child building can't be upgraded to a higher level than the parent building. This limit doesn't apply if the parent is a non-upgradeable decoration.

Be careful of "research loops" -- if the player needs to build a child before they can unlock a parent, that's a problem (unless you also have an alternate standalone of the child).

Since the parent will contain multiple hut blocks, you will always need to explicitly specify the anchor block (the main parent hut block if a building, or a Scan Tool , otherwise you'll get an error that the anchor was ambiguous and it will not work correctly.

Since you can only have one version of each building in each folder, combinations should be used very sparingly. The parent and child need to be in the same folder.

To place the child hut in the parent, you can simply shift-click it, just like when placing it in the child itself. Be sure to get the location and rotation correct -- the child hut will be built with the matching orientation relative to that.

The parent and child need to be in the same folder. This doesn't mean that you can't combine buildings that are normally in different folders -- just that the version that's intended to be the child must be in the same folder as the parent. You may still have another version of the child (to be used by itself, not as a child) in the original folder if you like.

It's not supported to have a child contain additional children of its own -- you're limited to just the two layers (though the parent can contain multiple children of either the same or different types).

Regardless of which method you use to build, be sure to get the location and rotation of the child hut correct when placing it in the parent -- the building will be built with the matching orientation relative to that.

If you've used the default folder and filenames for your child, then you can simply shift-click the child hut to place it into the parent, similar to older versions. However this is not the most recommended way to do things any more.

The preferred method is to make another level of your child containing only the hut block, giving it the same folder and name as your actual child, but level 0 (e.g. craftsmanship/storage/mycourier0). You can make it the same size as your real child (surrounded by Placeholder s) if you wish, but scanning a 1x1x1 is fine too. After scanning, you need to move this to its final location in your actual style pack, and then paste it from there (not from your scans!) into your parent. It doesn't matter whether you use schematic or constructed paste. Paste the same level 0 into all levels of the parent. After it's pasted, you can delete the level 0 blueprint -- it should not be included in your final released style pack. (Note that when you go to paste it, the build tool labels it as "level 1" of 6. You can confirm you have the right one by checking the tooltip name.)

Another option is called "auto-levelling". This is where instead of making and pasting a level 0 into each level of the parent, you instead paste the actual matching child level (i.e. level 1 child in the level 1 parent, level 2 child in the level 2 parent, etc). Again it doesn't matter whether you use schematic or constructed paste, but either way you'll probably have to fix up some of the overlapping blocks afterward. You do still need to include the child hut's blueprints in your released style pack, and you do still have to paste it from your actual style pack and not your scans folder.

With auto-levelling, the builder will upgrade the child at the same time as upgrading the parent, instead of the player needing to explicitly build or upgrade one after the other. While this may sound simpler, there are some downsides: the biggest is that won't work well for child buildings that have required functional blocks (such as beds, furnaces, racks, etc), although purely decorative ones are fine. You also should not use this where the child is locked behind research, unless you can be absolutely certain that it's already unlocked (e.g. if the parent is unlocked after the child -- though still be careful of loops). The "level 0" method doesn't have these issues.

Since you can have multiple alternates of buildings (in the same or separate folders), it's possible to make a particular building type have both a standalone version as well as a version embedded as a child. It's strongly recommended to use the Tag Tool to mark any blueprint intended for use only as a child (in the child schematic itself) as invisible so that it doesn't show up for building standalone -- especially as child versions are often simpler or cheaper and may be missing walls or other things intended to be provided by the parent, so won't look good on their own or might break game balance. It's also possible to have each child of a parent be its own unique blueprint -- but that requires even more scans and more care when pasting to use the right alternate.

What if I have another question?

The #schematics-design channel in the Discord is for asking questions about designing your own schematics.


If changes are needed or you think there is content missing, feel free to edit this page or submit an issue for us to make edits. - MineColonies Wiki Team