TerrainCodesWML

2007-06-21T18:44:45Z

Tamur: /* Adding terrains */

{{WML Tags}}
== Values of terrain letters ==

What each letter represents in Wesnoth maps,
and the possible values of the ''letter'' key.

See [[TerrainWML]] for information on how to define a terrain.

* '''A''' human (snow) hill village
* '''a''' human hill village
* '''B''' desert village (adobe)
* '''b''' human mountain village
* '''C''' castle
* '''c''' shallow water, "coast"
* '''D''' underground village (cave, village), "dungeon village"
* '''d''' sand, (old desert)
* '''E''' desert road
* '''e''' elven (snow) village
* '''F''' forest (snow)
* '''f''' forest
* '''G''' savanna (grass)
* '''g''' grass
* '''H''' hills (snow)
* '''h''' hills
* '''I''' desert
* '''i''' ice (tundra)
* '''J''' desert hills
* '''j''' -nothing- (will be snowy mountains)
* '''K''' keep (castle)
* '''k''' river ford (grass, shallow water)
* '''L''' tropical forest village (savanna, village)
* '''l''' lava (canyon)
* '''M''' desert mountains
* '''m''' mountain
* '''N''' ruined castle
* '''n''' encampment (castle)
* '''O''' -nothing- (will probably be an Orc Castle one day)
* '''o''' dwarven castle (castle)
* '''P''' desert oasis
* '''p''' dwarven village
* '''Q''' sunken ruin
* '''q''' ruin (swamp)
* '''R''' road (grass)
* '''r''' dirt (grass)
* '''S''' tundra
* '''s''' deep water
* '''T''' forest (tropical)
* '''t''' village
* '''U''' desert village (tent)
* '''u''' cave
* '''V''' snow village (tundra, village)
* '''v''' human village (village)
* '''W''' cavewall
* '''w''' swamp
* '''X''' canyon (replaced by chasm in trunk)
* '''x''' reserved for UMCs
* '''Y''' swamp village (swamp, village)
* '''y''' reserved for UMCs
* '''Z''' mermen village (shallow water)
* '''z''' reserved for UMCs
* '''/''','''|''','''\''' bridge (grass, shallow water)
* '''~''' fog
* ' ' void/shroud (it uses the "space" character)
* '''*''' reserved for UMCs
* '''^''' reserved for UMCs
* '''%''' reserved for UMCs
* '''@''' reserved for UMCs
* '''[''' rockbound cave
* ''']''' mushroom grove
* ''' ' ''' illuminated cave
* ''' ? ''' great Elven tree
* ''' & ''' impassable mountains
* ''' " ''' ???
* ''' $ ''' ???
* ''' . ''' ???
* ''' ; ''' ???
* ''' : ''' ???
* ''' < ''' ???
* ''' > ''' ???
* ''' _ ''' ???
* ''' ` ''' ???

==Reserved letters and non-letter Characters==
Reserved letters are for custom terrains in user-made campaigns. In addition to these it is currently also possible to use other characters not on the above list to represent custom terrain, such as ½ § @ % etc., but new "official" terrain may be assigned for these characters in the future. So when creating custom terrain, the letters marked as reserved on the above list should be used first.
Use campaign definitions (see [[CampaignWML]]) to prevent your custom terrains from interfering with other campaigns.

== Terrain strings '''''[[User:SkeletonCrew#Branch_terrain|(SVN terrain only)]]''''' ==
The terrains will be changed from a single letter to a multi letter system. There will be a compability layer for a short while. This layer doesn't work for campaigns with custom terrains, these campaigns have to be changed to use the new system.

The following rules are stated for the new terrain letters, note most of these rules are not validated since it would slow down Wesnoth; not following these rules might break Wesnoth.
* terrain strings are between 2 and 4 characters
* terrain strings start with a capital letter and the following letters are lower case
* terrain strings can only contain letters and the symbols /|\ which are meant for directional items like bridges.
* the underscore is used for internal terrains
* the star '*' can be used for wildcards in some parts

Starting positions are defined by a number followed by 1 space and then the terrain string; this means that a starting position is no longer automatically a keep.

The letters Y,y,Z,z are reserved for UMC so any string containing any of these letters is a custom terrain. Other undefined terrain strings are reserved for future expansion within Wesnoth.

=== Conversion form old to new ===
Map conversion logic is included in the [[Maintenance_tools|upconvert]] tool. This script will, among other things, convert a map with the old letters to the new strings. Here is a lookup table with the letters.

char= a b c d e f g h i j k l m
str= Vhh Vhm Ww Ds Vea Ff Gg Hh Ai Wwf Ql Mm

char= n o p q r s t u v w x y z
str= Ce Cud Vud Chs Re Wo Veg Uu Vhg Ss

char= A B C D E F G H I J K L M
str= Vhha Vda Ch Vu Rd Fa Gs Ha Dd Hd _K Vht Md

char= N O P Q R S T U V W X Y Z
str= Chr Do Chw Rr Aa Ft Vdt Vha Xu Qxu Vs Vwm

char= / | \ & _ ~ ? ] [ '
str= Bww/ Bww| Bww\ Xm _s _f Fet Uf Uh Uui

=== terrains sorted per group ===
This list shows the string for the terrains, the italic strings are reservations for terrains.
The old letter is extra shown for as an extra reference.

==== Snow terrains ====
<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td>Ai</td>
<td>i</td>
<td>ice</td>
<td>snow</td>
</tr>

<tr>
<td>Aa</td>
<td>S</td>
<td>tundra "Arctic"</td>
<td>snow</td>
</tr>

</table>

==== Bridges ====
Since bridges are directional all strings here
will be appended with either /|\ to show their
direction. In this list these signs are replaced
with a *.

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td><i>Brx*</i></td>
<td></td>
<td>Bridge of stones over chasm for aboveground</td>
<td>bridge</td>
</tr>

<tr>
<td><i>Bxu*</i></td>
<td></td>
<td>Bridge over chasm underground</td>
<td>bridge</td>
</tr>

<tr>
<td><i>Bsw*</i></td>
<td></td>
<td>wooden bridge over swamp</td>
<td>bridge</td>
</tr>

<tr>
<td><i>Bwr*</i></td>
<td></td>
<td>Stone Bridge over shallow water</td>
<td>bridge</td>
</tr>

<tr>
<td>Bww*</td>
<td>/|\</td>
<td>wooden bridge bridge, over wadeable, wooden</td>
<td>bridge, common</td>
</tr>

</table>

==== Castles ====

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td>Ce</td>
<td>n</td>
<td>encampment (castle)</td>
<td>castle, common</td>
</tr>

<tr>
<td>Ch</td>
<td>C</td>
<td>human castle</td>
<td>castle, common</td>
</tr>

<tr>
<td>Cv</td>
<td></td>
<td>Elven castle</td>
<td>castle</td>
</tr>

<tr>
<td>Chr</td>
<td>N</td>
<td>ruined castle</td>
<td>castle</td>
</tr>

<tr>
<td>Chs</td>
<td>q</td>
<td>human ruin (swamp)</td>
<td>castle</td>
</tr>

<tr>
<td>Chw</td>
<td>Q</td>
<td>human sunken ruin</td>
<td>castle</td>
</tr>

<tr>
<td><i>Co</i></td>
<td>O</td>
<td>will be an Orc Castle one day</td>
<td>castle</td>
</tr>

<tr>
<td>Cud</td>
<td>o</td>
<td>dwarven castle "castle underground, dwarf"</td>
<td>castle, underground</td>
</tr>

</table>

==== desert ====

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td>Dd</td>
<td>I</td>
<td>desert</td>
<td>desert</td>
</tr>

<tr>
<td>Do</td>
<td>P</td>
<td>desert oasis</td>
<td>desert</td>
</tr>

<tr>
<td>Ds</td>
<td>d</td>
<td>sand, (old desert)</td>
<td>desert</td>
</tr>

</table>

==== Forest ====

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td>Fa</td>
<td>F</td>
<td>forest (snow) "forest arctic"</td>
<td>forrest, snow</td>
</tr>

<tr>
<td><i>Fb</i></td>
<td></td>
<td>Sinister Forest "Forest, Bad"</td>
<td>forrest</td>
</tr>

<tr>
<td>Fet</td>
<td>?</td>
<td>great Elven tree</td>
<td>forrest</td>
</tr>

<tr>
<td>Ff</td>
<td>f</td>
<td>forrest</td>
<td>forrest, common</td>
</tr>

<tr>
<td>Ft</td>
<td>T</td>
<td>forrest tropical</td>
<td>forrest</td>
</tr>

</table>

==== Grass ====

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td><i>Gb</i></td>
<td></td>
<td>dying "Grass brown/bad"</td>
<td>grass</td>
</tr>

<tr>
<td><i>Gf</i></td>
<td></td>
<td>Farmer's Fields</td>
<td>grass</td>
</tr>

<tr>
<td>Gg</td>
<td>g</td>
<td>grass</td>
<td>grass, common</td>
</tr>

<tr>
<td>Gs</td>
<td>G</td>
<td>savanna (grass)</td>
<td>grass</td>
</tr>

</table>

==== hill ====

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td>Ha</td>
<td>H</td>
<td>hills (snow) "hills arctic"</td>
<td>hill, snow</td>
</tr>

<tr>
<td>Hd</td>
<td>J</td>
<td>desert hills (dunes)</td>
<td>hill, desert</td>
</tr>

<tr>
<td>Hh</td>
<td>h</td>
<td>hills</td>
<td>hill, common</td>
</tr>

</table>

==== Keep ====
The keep definition is now done with terrain transition WML,
since we're no longer out of letters, this will be done
manually. the _K is for backwards compability but this
will be removed in the near future. The _K uses the special
castle transition WML the new ones don't. This would
also allow to mix items, eg a Kh keep in a Ce castle.

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td>_K</td>
<td>K</td>
<td>keep (castle)</td>
<td>keep, common</td>
</tr>

<tr>
<td>Ke</td>
<td></td>
<td>encampment (keep)</td>
<td>keep, common</td>
</tr>

<tr>
<td>Kh</td>
<td></td>
<td>keep castle</td>
<td>keep, common</td>
</tr>

<tr>
<td>Khr</td>
<td></td>
<td>ruined keep</td>
<td>keep</td>
</tr>

<tr>
<td>Khs</td>
<td></td>
<td>human ruin keep(swamp)</td>
<td>keep</td>
</tr>

<tr>
<td>Khw</td>
<td></td>
<td>human sunken ruin keep</td>
<td>keep</td>
</tr>

<tr>
<td><i>Ko</i></td>
<td></td>
<td>will be an Orc keep one day</td>
<td>keep</td>
</tr>

<tr>
<td>Kud</td>
<td></td>
<td>dwarven keep "keep underground, dwarf"</td>
<td>keep, underground</td>
</tr>

</table>

==== Mountain ====

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td><i>Ma</i></td>
<td></td>
<td>snowy mountains</td>
<td>mountain, snow</td>
</tr>

<tr>
<td>Md</td>
<td>M</td>
<td>desert mountains</td>
<td>mountain, desert</td>
</tr>

<tr>
<td>Mm</td>
<td>m</td>
<td>mountain</td>
<td>mountain, common</td>
</tr>

</table>

==== (mostly) Impassable ====

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td><i>Qx</i></td>
<td></td>
<td>chasm for above ground</td>
<td>misc</td>
</tr>

<tr>
<td>Qxu</td>
<td>X</td>
<td>chasm for underground</td>
<td>misc, underground</td>
</tr>

<tr>
<td><i>Qxw</i></td>
<td></td>
<td>aboveground chasm with water pouring over the edge</td>
<td>misc</td>
</tr>

<tr>
<td>Ql</td>
<td>l</td>
<td>lava</td>
<td>misc</td>
</tr>

<tr>
<td><i>Qr</i></td>
<td></td>
<td>stone wall</td>
<td>misc</td>
</tr>

</table>

==== road ====

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td><i>Rc</i></td>
<td></td>
<td>Carpeted Floor</td>
<td>road</td>
</tr>

<tr>
<td>Rd</td>
<td>E</td>
<td>desert road</td>
<td>road, desert</td>
</tr>

<tr>
<td>Re</td>
<td>r</td>
<td>dirt road "earth"</td>
<td>road, common</td>
</tr>

<tr>
<td>Rr</td>
<td></td>
<td>stone road "rock"</td>
<td>road</td>
</tr>

<tr>
<td><i>Rw</i></td>
<td></td>
<td>Wood floor (interior)</td>
<td>road</td>
</tr>

</table>

==== swamp ====

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td><i>Sb</i></td>
<td></td>
<td>fetid swamp "Swamp Bad"</td>
<td>swamp</td>
</tr>

<tr>
<td><i>Ss</i></td>
<td>w</td>
<td>swamp</td>
<td>swamp</td>
</tr>

</table>

==== underground ====

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td>Uu</td>
<td>u</td>
<td>normal cave</td>
<td>underground</td>
</tr>

<tr>
<td>Uui</td>
<td>'</td>
<td>illuminated cave</td>
<td>underground</td>
</tr>

<tr>
<td>Uf</td>
<td>]</td>
<td>mushroom grove "underground forest"</td>
<td>underground</td>
</tr>

<tr>
<td>Uh</td>
<td>[</td>
<td>rockbound cave (functionally "underground hill")</td>
<td>underground</td>
</tr>

<tr>
<td>Uhi</td>
<td></td>
<td>illuminated rockbound cave (functionally "underground hill")</td>
<td>underground</td>
</tr>

<tr>
<td><i>Uuc</i></td>
<td></td>
<td>normal cave, carved</td>
<td>underground</td>
</tr>

</table>

==== village ====

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td>Vda</td>
<td>B</td>
<td>desert village (adobe)</td>
<td>village, desert</td>
</tr>

<tr>
<td>Vdt</td>
<td>U</td>
<td>desert village (tent)</td>
<td>village, desert</td>
</tr>

<tr>
<td>Veg</td>
<td>t</td>
<td>elven village "village elven grassland"</td>
<td>village</td>
</tr>

<tr>
<td>Vea</td>
<td>e</td>
<td>elven (snow) village</td>
<td>village, snow</td>
</tr>

<tr>
<td>Vha</td>
<td>V</td>
<td>village, snow snow village (tundra, village)</td>
<td>village, snow</td>
</tr>

<tr>
<td>Vhg</td>
<td>v</td>
<td>human village (village)</td>
<td>village, common</td>
</tr>

<tr>
<td>Vhh</td>
<td>a</td>
<td>human hill village</td>
<td>village, hill, common</td>
</tr>

<tr>
<td>Vhha</td>
<td>A</td>
<td>human (snow) hill village</td>
<td>village, snow, hill</td>
</tr>

<tr>
<td>Vhm</td>
<td>b</td>
<td>human mountain village</td>
<td>village, mountain</td>
</tr>

<tr>
<td>Vht</td>
<td>L</td>
<td>tropical village (savanna, village) --nothing foresty about this village</td>
<td>village</td>
</tr>

<tr>
<td>Vu</td>
<td>D</td>
<td>underground village (cave, village)</td>
<td>village, underground</td>
</tr>

<tr>
<td>Vud</td>
<td>p</td>
<td>dwarven village</td>
<td>village, underground</td>
</tr>

<tr>
<td>Vwm</td>
<td>Z</td>
<td>mermen village (shallow water)</td>
<td>village, water</td>
</tr>

<tr>
<td>Vs</td>
<td>Y</td>
<td>swamp village (swamp, village)</td>
<td>village, swamp</td>
</tr>

<tr>
<td>Vsm</td>
<td></td>
<td>swamp merfolk village (swamp)</td>
<td>village, swamp</td>
</tr>

</table>

==== water ====

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td>Wo</td>
<td>s</td>
<td>deep water "water, ocean"</td>
<td>water, common</td>
</tr>

<tr>
<td>Ww</td>
<td>c</td>
<td>shallow water, "water, wade-able"</td>
<td>water, common</td>
</tr>

<tr>
<td>Wwf</td>
<td>k</td>
<td>river ford "water wadeable, ford"</td>
<td>water</td>
</tr>

<tr>
<td><i>Wwu</i></td>
<td></td>
<td>shallow underground water</td>
<td>water, underground</td>
</tr>

</table>

==== Impassable ====

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td>Xm</td>
<td>&</td>
<td>impassable moutains</td>
<td>impassable, mountain</td>
</tr>

<tr>
<td><i>Xrw</i></td>
<td></td>
<td>Impassable stone "rock" wall (interior)</td>
<td>impassable</td>
</tr>

<tr>
<td>Xu</td>
<td>W</td>
<td>cavewall</td>
<td>impassable, underground</td>
</tr>

<tr>
<td><i>Xuc</i></td>
<td></td>
<td>cavewall, carved</td>
<td>impassable, underground</td>
</tr>

<tr>
<td><i>Xww</i></td>
<td></td>
<td>Impassable wooden wall (interior)</td>
<td>impassable</td>
</tr>

</table>

==== Specials ====
These terrains are hardcoded in the game and translated
automatically. The old UMC terrains are here for backwards
compability this compability will only be guaranteed till
the next major release after 1.2.(That would be 1.4 or 2.0.)
As stated before the * will no longer be supported.

<table border="1"><tr>
<th>String</th>
<th>Old letter</th>
<th>Description</th>
<th>Theme</th>
</tr>

<tr>
<td>_f</td>
<td>~</td>
<td>fog</td>
<td>misc</td>
</tr>

<tr>
<td>_s</td>
<td> (space character)</td>
<td>void/shroud</td>
<td>misc</td>
</tr>

</table>

== Adding terrains ==
When adding terrains make sure the following files are also checked:

data/faction/* contains favorite positions for the different factions, this is only used for the random map generator at the moment so it is not very important.

data/abilities.cfg contains the definition of ''submerge'' and ''ambush'' so depending on the change these need to be updated.

data/utils/utils.cfg contains the macro STARTING_VILLAGES which contains a list of village strings. This list doesn't support wildcards (yet).

== See Also ==
* [[TerrainWML]]
* [[ReferenceWML]]
* [http://www.idi.ntnu.no/~haskjold/wesnoth/map_letters.html Freim's List of Terrain Letters]

[[Category: WML Reference]]

Tiles Tutorial

2007-06-21T18:38:04Z

Tamur: /* Normal Tiles */

=== Normal Tiles ===

Normal tiles consist of a set of 72x72 tiles which are the variants used for a given terrain type. The probability for showing the different variants are given in terrain-graphics.cfg. In addition each terrain type has a set of transition tiles:

* 6 basic transitions: n, ne, se, s, sw, nw
* 6 "2-side trans": n-ne, ne-se, se-s, s-sw, sw-nw, nw-n
* 6 "3-side trans": n-ne-se, ne-se-s, se-s-sw, s-sw-nw, sw-nw-n, nw-n-ne
* 6 "4-side trans": n-ne-se-s, ne-se-s-sw, se-s-sw-nw, s-sw-nw-nw, sw-nw-n-ne, nw-n-ne-se

Few terrain types use all these possible transitions, if any.

It is possible to make several transitions and use different ones depending on which terrain type is adjacent. There is also a need for some special transitions when terrains are adjacent to castles.

Transitions are drawn around tiles according to a what is defined in terrain-graphics.cfg. Each terrain is placed in a given layer. This defines which terrain will draw their transition when adjacent to another. This means that the one which are layered the "highest" will draw their transitions on top of terrain layered further down.

Each of these transitions are stored in separate image files.

'''Example 1.'''

1 tile + the 6 basic transitions:

http://www.idi.ntnu.no/~haskjold/wesnoth/info/normal_tiles.png

'''Example 2.'''

1 tile + 2 x nw trans and a sw-nw-n trans. (This might seem strange, but the trans. are named after where the trans. is drawn in the trans. tile itself, not where it's "attached" to the terrain tile).

http://www.idi.ntnu.no/~haskjold/wesnoth/info/normal_tiles2.png

=== Multihex tiles ===

Multihex tiles work differently. They don't have seperate transitions. One could say the trans are attached to the tile itself. They also behave differently. While normal tiles draw their trans according to the layering a multihex tile will rather overlap terrain either vertically and/or horizontally. This means fx that mountain tops will extend into tiles above removing the need for a special transition. for other sorts of terrain like grassland and other flat ones this must be done in a way that will allow them to mesh into each other. Of course multihex is not neccesarily ideal for all terrain types.

'''Examples'''

http://www.idi.ntnu.no/~haskjold/wesnoth/info/multihex_tiles.png

http://www.idi.ntnu.no/~haskjold/wesnoth/info/multihex_tiles2.png

Note on overlay tiles: you define a background tile which gets drawn first underneat them using the regular layering rules for that particual terrain type.

http://www.idi.ntnu.no/~haskjold/wesnoth/info/multihex_tiles3.png

== See Also ==
* [[Create]]
* [[Art Tutorials]]

[[Category: Art Tutorials]]

The Battle for Wesnoth Wiki - User contributions [en]

TerrainCodesWML

Tiles Tutorial