Minecraft Forums

# BASICS
# This file is designed to be copied into the mods/resources/ruins folder and be
# edited to create a new template. It is functional as-is; you can use it as
# a placeholder for future templates after renaming it.
#
# Templates have a .tml extension and the mod will attempt to load any and
# all files with that extension if they reside in the <minecraft root>/
# mods/resources/ruins folder. Whether it does so successfully or not can be
# checked in the log file (<minecraft root>/mods/ruins_log.txt). The mod will also
# load any templates found in the biome folders within
# <minecraft root>/mods/resources/ruins.
#
# These template files are a simple text file; simply open them in your
# favorite text editor to make changes or create new ones.
#
# There are three sections to each template file:
# VARIABLES define how the template is generated.
# BLOCK RULES define how the layers are generated.
# LAYERS tells the mod how to place blocks using BLOCK RULES.
#
# You can specify a comment by placing a "#" character at the beginning of the
# line. You technically /don't/ have to do this, since the mod only looks for
# particular line starts when loading a template, but I consider it good form
# because it increases readability and you prevent any errant line reads.

# VARIABLES
#
# biomesToSpawnIn=<name1>,<name2>,<name3>...
# Adds the Template being loaded (regardless which folder it is in) to a Ruins Biome
# found in the Minecraft Biomelist so that <namex> matches the Biome's name.
# If you don't know a Biome's name, find it's folder. The foldername equals the
# Biome name. Case insensitive. A Template cannot be added to a Biome more than once.
# The Template is still added to the corresponding folder it was loaded from (if not already in).
# example: biomesToSpawnIn=forest,foresthills,taiga
# Optional. You can use the folders as before, or use this to save space, or both.
#
# weight=<weight>
# Weight is how much weight this template has during random generation. When
# the mod asks for a template to place it adds up the weights of all templates
# that are currently loaded and generates a random number based off of that
# total, then checks to see what template to load. If the mod loads five
# templates with weights 1, 5, 5, 10 and 10, the template with weight 10 has a
# 10 in 31 chance of being generated, while the template with weight 1 has a 1
# in 31 chance of being generated. A template only has weight in its biome.
# Defaults to 1.
#
# embed_into_distance=<number of layers>
# Specifies how many layers to embed into the target blocks. This is useful
# for creating basements or dungeons.
# Defaults to 1.
#
# acceptable_target_blocks=<blockID>,<blockID>,<etc...>
# This is a comma-delimited list of block IDs that this template can spawn on.
# Only the top layer of blocks where the template will spawn are checked.
# Optional line. Defaults to accept any block.
#
# unacceptable_target_blocks=<blockID>,<blockID>,<etc...>
# This is a comma-delimited list of block IDs that this template can NOT spawn on.
# Only the top layer of blocks where the template will spawn are checked.
# Optional line. Defaults to accept any block.
#
# dimensions=<height>,<width>,<length>
# Defines how big this template is. Height is the number n
# of layers that are used, not the height that sticks out n
# above the ground. Width is the north-south width, and www*eee
# length is the east-west width. For reference, north in s
# the template is the top of the text file. s
# All default to 0.
#
# allowable_overhang=<overhang>
# Specifies the allowed number of blocks in the potential build site that do not have
# a surface within a reasonable distance, leaving the template "hanging" over an edge
# Defaults to 0.
#
# max_leveling=<leveling>
# Specifies the maximum surface noise / height difference, within the build site,
# that will be accepted when considering a potential build location.
# The site will then be levelled prior to spawning the template.
# If there is overhang allowed, also specifies how much "support" blocks are put
# under the template when building it overlapping a surface edge.
# Defaults to 2.
#
# leveling_buffer=<lbuffer>
# The distance around the build site that will also be levelled. Values higher
# than 5 will use 5, since the world would otherwise be mangled pretty badly.
# Defaults to 0.
# Ruins 12.8 introduces a setting of -1, which will prevent any(!) site leveling
#
# preserve_water=<yes/no>
# If set to 1 all site checking rules will treat water as air so that the ruin
# can be generated beneath/in water. Any rules that replace a block with air
# will respect water and not replace it. If set to 0, water is treated like
# any other block.
# Defaults to 0/no.
#
# preserve_lava=<yes/no>
# If set to 1 all site checking rules will treat lava as air so that the ruin
# can be generated beneath/in lava. Any rules that replace a block with air
# will respect lava and not replace it. If set to 0, lava is treated like
# any other block.
# Defaults to 0/no.
#
# preserve_plants=<yes/no>
# If set to 1 all site checking rules will treat trees, leaves, and cactus as
# air so that the ruin can be generated in and around them. Any rules that
# replace a block with air will respect trees, leaves, and cactus and not
# replace them. If set to 0, trees, leaves, and cactus are treated like
# any other blocks. Cactus adjacent to other blocks will break down, so you
# may not actually see cactus in your structure.
# Defaults to 0/no
#
# random_height_offset=<min>,<max>
# Specifies block range in which the Ruin will be randomly shifted up or down
# on an established valid location before actually being built.
# Defaults to 0,0/no random shifting
#
# NOTE: When using preserve_water and preserve_lava it is advised that you
# restrict the cut_in_buffer as much as possible, preferably to 0. If it is
# more than 0 you may get some unexpected fluid dynamics if the structure
# does not spawn completely in water/lava.
#
# Ruins 13.8 adds optional variable "uniqueMinDistance" which overrides global templateInstancesMinDistance
# uniqueMinDistance=1500
# defaults to 0. values of 0 are handled as if no value was specified at all.
#
# Ruins 13.9 adds optional variable "preventRotation" which keeps a template in the specified direction
# preventRotation=1
# defaults to 0. values of 0 are handled as if no value was specified at all.
#
# Ruins 14.3 adds the optional repeatable variable "adjoining_template" which lets you spawn adjacent templates
# these will not be checked for minimal distances against ANY other ruins, make sure your spacings are big enough
# these will also not be checked for circular dependencies, you build an infinite loop, you wait it out
# these will be checked against the rules the template itself contains
# Ruins will use its spawning algorithm to determine a fitting y coordinate to the xz you provide
# adjoining templates will be randomly rotated, you can disable this in their templates if you want
# syntax: adjoining_template=<template>;<relativeX>;<allowedYdifference>;<relativeZ>[;<spawnchance>]
# <template> is the full filepath relative to the resources/ruins folder, so, working like /testruin
# <relativeX> and <relativeZ> are the relative coords from the host x,z spawnpoint to the adjoining x,z
# <allowedYdifference> states how much the computed adjoining template height may absolutely differ before aborting
# <spawnchance> is optional and does what the name implies, [0-100] values allowed
#
# Example: adjoining_template=generic/MoaiHead;-25;10;25;33
#

weight=5
embed_into_distance=1
acceptable_target_blocks=stone,grass,dirt,sand,gravel,clay
dimensions=4,7,5
allowable_overhang=0
max_leveling=2
leveling_buffer=0
preserve_water=0
preserve_lava=0
preserve_plants=0

# BLOCK RULES
# Each rule must be formatted carefully:
# rule<number>=<condition>,<chance to appear>,<list of blocks>
#
# rule<number>
# The mod does not care what you call these and will number the rules in the
# order they are loaded (sequentially from 1), so long as the line start with
# "rule". I suggest using "rule#" as a mnemonic, such as "rule1", "rule2",
# "rule12", etc... Once the templates are loaded, the first rule in the list
# becomes rule #1 for the purposes of building a layer, the second becomes rule
# #2, and so on.
#
# The mod uses a special rule, 0, which defines the Air block with a 100% spawn
# rate and no conditional. You can use this rule in the layers to "blank out"
# certain areas (providing space for mobs, for instance).
#
# <condition>
# A conditional to the block being placed, aside from randomness.
# 0 = Normal, spawns first
# ±1 = Checks block under, spawns delayed
# ±2 = Checks block adjacent, spawns delayed
# ±3 = Checks block above, spawns last
# 7 = Spawns last
# Where the negative cases for 1,2,3 denote NOT. In other words, 2 means the block will only spawn
# if there is a block next to it, while -2 will NOT spawn if there are any blocks next to it.
#
# Adjacent in this case is not diagonal, only along the cardinal directions.
#
# Adjacent blocks are processed after 0 and 1 conditionals have been placed,
# and "under blocks" are processed after all other blocks have been placed.
# Please note that these blocks are still processed in an order dependent on
# the rotation of the site. For a normal, north-facing site, the block rules
# are processed for each line from the left and from the bottom template to the
# top.
#
# DO NOT CHAIN CONDITIONS. That results in undefined behaviour.
#
# <chance to appear>
# The chance that this block will appear, out of 100, depending on whether the
# condition above is met.
#
# <list of blocks>
# A comma-delimited set of minecraft blockIDs. This will determine what block
# will actually spawn in the location. Each blockID is given the same weight,
# so you can skew the odds of a certain blockID appearing by adding it multiple
# times. You can specify block metadata by adding a "-<metadata>" after the
# blockID. For instance, to place a cobblestone stairs block ascending to the
# east, use stone_stairs-3. To place a wood half-block (slab), use stone_slab-2.
#
# You can find a list of blockIDs and commonly-used metadata via Google.
# There is also one included, idmappings.txt
#
#
# Example 1: rule1=0,100,0,cobblestone,mossy_cobblestone
# This spawns either air, cobblestone, or a mossy cobblestone 100% of the time.
#
# Example 2: rule1=1,50,mossy_cobblestone
# This spawns a mossy cobblestone 50% of the time but only if another block
# is underneath it.
#
# Example 3: rule1=2,100,stone_slab-2,planks
# This spawns either a stone slab or a plank block, but only if there is an
# adjacent block on the same level.
#
# Example 4: rule1=0,100,torch-5
# This spawns a torch standing on the ground.
#
# Example 5: rule1=0,25,MediumChest
# This spawns a Medium Chest (see above) 25% of the time.
#
# Example 6: rule1=0,50,MobSpawner:Villager
# This spawns a Mob Spawner with Entity Id "Villager" 50% of the time
# Entity Id's are case sensitive! Mod added Mobs are allowed. Use a tool like Simply Hax to get correct Entity Id's
#
# Ruins 9.0 exposes minecraft ChestGenHook for your meddling. Usage:
#
# Example 7: rule1=0,100,ChestGenHook:chests/simple_dungeon:10
# This spawns a chest and tells the Minecraft generator to fill it with "10" itemstacks of the "chests/simple_dungeon" loot preset.
# This might include extremely powerful items added by mods. Note: The algorithm spreads out the itemstacks, it might be more than 10
# items in this particular case, e.g. 5 pieces of bread count as 1 itemstack, yet will be spread out over 5 slots.
#
# see http://minecraft.gamepedia.com/Loot_table#List_of_loot_tables for possible loot tables (as of MC 1.9)
#
# As of 10.6, all chest rules can also append a metadata/rotation int similar to a chest block ID
# example: rule1=0,100,ChestGenHook:chests/simple_dungeon:10-5
# for a chest filled with dungeon chest loot and rotated to meta 5.
#
#
# Ruins 10.3 adds Command Block Support. Usage:
# Example 8: rule1=0,100,CommandBlock:command:sender
# command being the Command string to be executed and sender being the Command sender (a player name, Rcon...)
# you can provide several alternative command blocks seperated by commata, however you may not mix command blocks and other blocks in one rule
#
# Ruins 12.1 adds Standing Signs. Usage:
# Example 9: rule1=0,100,StandingSign:a|b|c|d-4
# a,b,c,d are the 4 Strings/lines you can write on a sign. The metadata/rotation of the sign is affixed as usual.
#
# Ruins 12.2 adds IInventory block support. Usage: IInventory;<blockName>;<itemList>-<blockrotation>
# where <blockName> is the registry name of the Block that sports an inventory
# where <itemList> is a list of elements seperated by '+', each element is a block or item registry name
# optionally followed by #stacksize OR #stacksize#metadata OR #stacksize#metadata#inventoryslot
# Example 10: rule1=0,100,IInventory;chest;red_flower+arrow#10+wool#3#15-5
# this spawns a chest rotated to 5, which will contain a single red flower, 10 arrows, and 3 wool of color red (meta 15)
# Example 11: rule1=0,100,IInventory;dispenser;arrow#10+snowball#20+egg#3-1
# this spawns a dispenser rotated to 1, with 10 arrows 20 snowballs and 3 eggs
# you may use this for items added by mods. names not found in the registry will simply be skipped over.
# you may also use this for container blocks added by mods. invalid anythings should be skipped.
# the Ruins Parser will do this for you when you parse an IInventory block. Empty chests get hooked with dungeon loot
# automatically. If you want to prevent this, either edit the template afterwards or place some dirt in the chest.
# if you specify the same slot index multiple times, only the first itemstack gets put in
#
# Ruins 15.0 adds ChestGenHook (see above) as valid <itemList> entry for IInventory rules
# Example: rule1=0,100,IInventory;dispenser;ChestGenHook:dungeonChest:5-1
#
# Ruins 14.3 adds the -addbonemeal flag to use on IGrowable blocks such as saplings or most plants
# simply append -addbonemeal to a block which is an IGrowable (and only those!)
# note this overrides certain checks done before hand application of bonemeal, such as darkness checks for shrooms
# also note /undo does NOT take growing things into account when cleaning up your shenanigans
# below example is for oak and dark oak saplings
# Example 12: rule1=0,100,0,sapling-addbonemeal,sapling-5-addbonemeal
#
# Ruins 14.9 adds support for item NBT data. the json nbt string replaces 'stacksize' in the format, as nbt capable items are never stackable
# Example 13: rule1=0,100,IInventory;minecraft:chest;minecraft:diamond_sword#{RepairCost:2,display:{Name:"Choppa"}}#0#0
#
# Ruins 15.0 adds support for tile entity NBT data. This is best achieved by adding the blockname to the global "teblock" variable in ruins.txt
# Usage: teBlock;<blockName>;<nbttag json>-<blockrotation>
# Example: rule1=0,100,teBlock;minecraft:trapped_chest;{x:-156,y:65,z:72,Items:[0:{Slot:12b,id:5s,Count:1b,Damage:0s},1:{Slot:13b,id:24s,Count:1b,Damage:1s}],id:"Chest"}-2
# Note: "Chain" and "Repeat" Command Blocks are classified as such by default
#

rule1=0,100,preserveBlock
rule2=0,80,brick_block,brick_block,dirt,stone,gravel
rule3=0,100,brick_block

# LAYERS
# Each layer is a comma-delimited list of rules, one for each block. There
# must be as many layers as the height, and each layer must have "layer" before
# the rules and end with "endlayer". There are as many rows as the length, and
# as many rules as the width. If you want the block blanked out use 0, which
# represents the Air-block rule.

layer
2,2,2,2,2
2,1,1,1,2
2,1,1,1,2
2,1,1,1,2
2,1,1,1,2
2,1,1,1,2
2,2,2,2,2
endlayer

layer
3,3,3,3,3
3,0,0,0,3
3,0,0,0,3
3,0,0,0,3
3,0,0,0,3
3,0,0,0,3
3,3,3,3,3
endlayer

layer
3,3,3,3,3
3,0,0,0,3
3,0,0,0,3
3,0,0,0,3
3,0,0,0,3
3,0,0,0,3
3,3,3,3,3
endlayer

layer
3,3,3,3,3
3,0,0,0,3
3,0,0,0,3
3,0,0,0,3
3,0,0,0,3
3,0,0,0,3
3,3,3,3,3
endlayer

--------------------------------------------
Guide to Making Templates for Ruins Mod:
--------------------------------------------

Since directing players to specific forum posts can be slowed by the forum site itself,
I've consolidated my posts so new players can benefit now.

===========================================================

Block-Lists

This list is only needed for templates expected to be put in the "Generic" folder
In March 2015, Sinhika suggested clouds from Natura be put in the default list
This is my most complete list for Generic templates:

unacceptable_target_blocks=flowing_water,water,flowing_lava,lava,ice,bedrock,netherrack,nether_brick,nether_brick_fence,soul_sand,quartz_ore,gravel,end_stone,obsidian,iron_bars,cloud,flesh,ash_block,slime_grass,slime_congealed,slime_dirt

---

This is broken into sections that are useful for different things:

Overworld:
flowing_water,water,flowing_lava,lava,ice

Nether/End crossover prevention:
(only needed for templates in the "Generic" folder)

bedrock,netherrack,nether_brick,nether_brick_fence,soul_sand,quartz_ore,gravel,end_stone,obsidian,iron_bars,flesh,ash_block

Overworld silly spawn-sites:
slime_grass,slime_congealed,slime_dirt,cloud

----------

Templates can be moved out of generic into specific biome folders, if there is
enough content to ensure filling the world with a good variety of structures.

==========================================================

Gillymoth Tip #2677 (page 134)

Extra spaces at the end of lines in the Layers can break a template:
Grab the text with the mouse to highlight spaces at the end of lines.

"Here's a quick tip when a ruins file is "broken" but it looks perfect in the code:

layer
3,3,3,3
3,3,3,3
3,3,3,3
endlayer

select the above block of 3's to reveal the extra spaces at the end of each line. I've had this happen
to me and it took a while to find it, let alone realize that such a seemingly minor detail could break the code."

This can only happen when handbuilding the template,
like if a cat walks across the keyboard (very common in some places)

-------

Gillymoth Tip #2681 (page 134)

"if you click on blocks with a stick, it says in chat the blocknames and metadata"

This is a stock feature of Ruins Mod, and is useful in getting block-names
to use with the /fill command, and for manually editing template

-------

Gillymoth Tip #2659 (page 133)

"This keeps blocks the same during the building phase where in the data the rule is specified:
rule1=0,100,preserveBlock

but the above happens after leveling the ground (filling in) for building, which can be turned off with a -1 value here:
leveling_buffer=-1

This is useful for exposing the foundations of buildings on the side of a hill, but still have them flat on plains."

-------

Gillymoth Tip#2931 (page 146)

"you could do it the same way as I do exposed foundations for my buildings,
tree roots would be handled exactly the same, just use these three together:

embed_into_distance="how deep you want the roots"
max_leveling="how deep you want the roots" (same as number for embed_into_distance)
leveling_buffer=-1

setting the leveling buffer to -1 keeps it from filing ANY land (above the first layer),
and when used in conjunction with embed into distance, you get exposed foundations, and it still places on rough land.

After finishing the structure design, build a water-tight tub around the roots and fill it with water,
the water spread will make filling the area easy and you can change the water rule to "preserveBlock" in the file itself,
(provided the structure wasn't actually supposed to be a lake)."

I discovered that these settings for these three rules are optimal,
and should be used in most cases for new templates

-------

Gillymoth Tip #2821 (page 132)

Use water-spread to quickly fill in areas for making the preserveBlock rule:

"someone mentioned (wanting the option for) the templateparser to use preserveBlock instead of air (as a default setting),
because their template was too massive to do it by hand.

Anyway, I used water spread to fill in the area I wanted to use for preserveBlock,
and just replaced the water-rule with preserveBlock."

*Picture titled "DomeInTub" with my spawn dome inside, the area around it filled with water

---

This tip is still useful in current versions, just use it to fill up the much smaller inside "air" areas by hand,
before using "/fill replace" to turn air into the preserveBlock material, and then change the water back to air.

-------

Gillymoth Tip #3054 (page 152)

"You don't have to make a solid baseplate, just a rectangle that defines the outer edge.
A filled baseplate would still be useful if you wanted it to hold in water.
I like to use water to fill in my "preserveBlock" rule, in combination with
orange wool for the feathering to blend it into the land."

(in 1.12+, orange wool is too bright to look at in large areas)

---

Gillymoth Tip #3123 (page 156)

Build a ring of wool under your structure and type "/parseruin filenamegoeshere" and break a wool under the building.
Then test spawn in an open space with "/testruin samefilenameasbefore" and make adjustments as needed,
using placeholder blocks for "preserveBlock", etc

-------

Gillymoth Tip #2974 (page 148)

"I still prefer 1.8 commands for this purpose:

/fill ~12 ~3 ~12 ~-12 ~-3 ~-12 farmland 7 replace grass
/fill ~12 ~3 ~12 ~-12 ~-3 ~-12 wheat 7 replace tallgrass

The above is from my 1.8 wheat field template design"

This makes farms that conform to the surface with a single set of commands

-------

The above tips are shown to speed up the process, so others can benefit from
things learned from the experience of designing hundreds of completed templates.

-------

Important Tip:

Included in the Ruins installation is the "template_rules" file.
It contains all the information needed to assemble all kinds of fancy builds.

=============================================================================

-------------------
Template Size
-------------------

Templates under 20-30K generate nearly instantly, and I suggest not going over a 50K file size,
any larger and it takes an increasingly noticeable amount of time to generate that structure.
Minecraft generation can much more easily handle vertical structures that generate in fewer chunks,
than ones that spread over a wide area.

20-30 blocks sideways (under two chunks) is a good size to build in for fast generation,
and I suggest 15-20 blocks across as larger foundations are more difficult to keep a build grounded
on any random surface.

Templates with dimensions in odd numbers are easier to align into multi-structure builds,
as they align at the center of a block.

Templates with Even numbers for dimensions can be used for a little extra randomness.

=============================================================================

-----------------
Lag-Busting
-----------------

Another lag-busting tip is to try to void overusing blocks or entities that minecraft does extra checks on.

Several common detailing blocks have entities attached to them to store extra data, the minecraft wiki
has a complete list. Using them in builds is fine, just be aware of how much lag they produce in
massive quantities.

Since Ruins is usually played in heavily modded worlds, expect the other mods to have already used up most
or all of the leeway in this area. It's best to tread as lightly as possible when using such blocks.

Also expect that the player is going to want to place down a lot of things like chests and furnaces where
they decide to make a base, and they commonly choose these builds to do so.

===========================================================================

----------------
Foundations
----------------

Layers under the floor level of a build are important in blending a structure into the ground.

embed_into_distance= (place number of layers under surface here, and negative numbers for flying builds)

Foundations should be at least 4 blocks deep for anything with a small footprint around 8x8,
and 7-8 blocks deep for buildings around 20x20

I also suggest breaking up anything too much larger into parts that can generate separately.
This opens up using the parts as a construction set, that can be assembled in many different ways.

============================================================================

-------------------------------
Blending the Structure in
-------------------------------

max_leveling=
embed_into_distance=

I suggest setting max_leveling to the same number to match embed_into_distance, at most.

max_leveling determines exactly how hilly a surfce can be to accept a build location,
so a higher number increases the chances of spawning, but if it exceeds the depth of
the foundation, the outer edges will appear to be floating.

leveling_buffer=-1

In most cases, the leveling feature of Ruins will tend to break the landscape.
Setting it to -1 turns it off, as preserveBlock is a better way to ensure
a good fit with the land.

Use in conjunction with the above two settings, to optimize performance.

================================================================================

-----------------------
Master-Template
-----------------------

Have a "master-template" on your desktop, use it to store commonly used iists and rules

Most importantly, use it to add the finishing touches on templates, as outlined by
the above conventions

the unacceptable_target_blocks list is such a standard, and is most useful for
new players who will be placing everything in generic as a starting place

=================================================================================

------------------------------------
Folder/File Naming Conventions
------------------------------------

In the continuous process of developing structures, my "templateparser" folder is
filled with tons of bits and pieces of templates, experiments, and temp files.

The folder houses my workspace and as such gets very messy, so I use the 'Gilly' folder
as my place for released support files. I've also kept a naming convention for all
of my released templates. Every file starts with "Gilly" to prevent duplicate filenames
if the content ends up getting merged with any other content.

I suggest that new players who decide to make content consider choosing a unique marker
in their filenames for this exact reason, and I extend this suggestion to content makers
who make things for other mods/systems as well.

# LargePyramid
# Author: Ozzitosis

weight=20
biomesToSpawnIn=Desert
unacceptable_target_blocks=flowing_water,water,flowing_lava,lava,ice,bedrock,netherrack,nether_brick,nether_brick_fence,soul_sand,quartz_ore,gravel,end_stone,obsidian,iron_bars,cloud,flesh,ash_block,slime_grass,slime_congealed,slime_dirt
embed_into_distance=5
dimensions=30,60,60
max_leveling=30
leveling_buffer=-1
allowable_overhang=9000
preserve_plants=1
uniqueMinDistance=50

rule1=0,100,preserveBlock
rule2=0,100,sandstone