The Battle for Wesnoth Wiki - User contributions [en]

Maintenance tools

2009-02-03T20:12:09Z

Saurian: /* wmllint */

The Wesnoth source code distribution includes a couple of tools intended to help authors maintain campaigns, faction & unit packs, and other WML resources. These
are:

; wmlscope: a cross-reference lister, useful for finding unresolved macro and resource-file references.

; wmllint: a utility for sanity-checking WML syntax and porting your old WML to the current version of WML.

; wmlindent: a utility for reindenting WML to a uniform style.

You will need a Python interpreter on your system to use these tools. Linux, *BSD, and Mac OS/X should already have Python installed; for Windows it's a free download
from http://www.python.org. You will also need to know how to run command-line tools
on your system.

All three tools will require you to supply a directory list. This is a set of directories containing the WML files you want to work on.

Note to Windows Users: This means you have to run it from the '''Command Line'''. The command line may be reached by hitting Start, then Run, then "cmd" or "command" depending on your version of Windows.

Example uses:
python wmllint --oldversion=1.3.4 path\to\files
python wmlindent path\to\files

Another example:
"C:\Program Files\Python2.4\python.exe" data\tools\wmllint --dryrun data\core data\{multiplayer,themes} data\campaigns
(You have to specify the full directory path to the executable if you don't have your environment variables set up correctly).
The first thing you type is the path to your python executable, followed by a space. The second thing you type is the path to the desired script to run, followed by a space. The third thing you type is the path to the folder (or file) to be processed.

== wmlscope ==

The main use for <tt>wmlscope</tt> is to find WML macro references without definitions and references to resource files (sounds and images) that don't exist. These are difficult to spot from in-game because they usually result in silence or a missing image rather than actual broken game logic. They may happen because of typos in your WML, or because the name of a macro or the location of a resource file changed between versions of the game.

<tt>wmlscope</tt> also checks macro invocations for consistency. It will complain
if a macro is called with the wrong number of arguments. In most cases it can deduce information about the type of the literal expected to be passed to a given macro argument by looking at the name of the formal.

<table border="1"><tr>
<th>Type</th>
<th>Meanining</th>
<th>Formals requiring this type</th>
<th>Literals of this type</th>
</tr>
<tr>
<td>macro</td>
<td>A macro invocation</td>
<td></td>
<td>{.*}</td>
</tr>
<tr>
<td>numeric</td>
<td>a numeric literal</td>
<td>SIDE, X, Y, RED, GREEN, BLUE, TURN, RADIUS, *NUMBER, *AMOUNT, *_X, *_Y</td>
<td>\-?[0-9]+</td>
</tr>
<tr>
<td>position</td>
<td>a coordinate, coordinate range, or set of coordinate ranges</td>
<td>POSITION</td>
<td>([0-9]+\-[0-9]+,?|[0-9]+,?)+</td>
</tr>
<tr>
<td>span</td>
<td>a coordinate, coordinate range, or set of coordinate ranges</td>
<td>*_SPAN</td>
<td>"melee" or "ranged"</td>
</tr>
<tr>
<td>range</td>
<td>an attack range</td>
<td>RANGE</td>
<td>"melee" or "ranged"</td>
</tr>
<tr>
<td>alignment</td>
<td>an alignment keyword</td>
<td>ALIGN</td>
<td>"lawful" or "neutral" or "chaotic" {{DevFeature}}</td>
</tr><tr>
<td>image</td>
<td>an image name</td>
<td>IMAGE</td>
<td>string ending in .png or .jpg</td>
</tr>
<tr>
<td>terrain</td>
<td>a terrain code</td>
<td>TERRAIN</td>
<td>[A-Z][a-z]+\^[A-Z][a-z\\|/]+\Z</td>
</tr>
<tr>
<td>sound</td>
<td>a music or sound resource</td>
<td>MUSIC, SOUND</td>
<td>\.wav|\.ogg</td>
</tr>
<tr>
<td>affix</td>
<td>a prefix, suffix, or infix for a variable name</td>
<td>AFFIX</td>
<td>an ID or nothing {{DevFeature}}</td>
</tr>
<tr>
<td>image</td>
<td>an image name</td>
<td>IMAGE</td>
<td>string ending in .png or .jpg</td>
</tr><tr>
<td>filter</td>
<td>filter expression</td>
<td>FILTER</td>
<td>any non-quoted string containing "="</td>
</tr>
<tr>
<td>WML</td>
<td>a WML fragment</td>
<td>*_WML</td>
<td>any non-quoted string containing "=", or the empty string</td>
</tr>
<tr>
<td>name</td>
<td>a name or ID</td>
<td>NAME, VAR, IMAGESTEM, ID</td>
<td>[A-Z][a-z]+\^[A-Z][a-z\\|/]+\Z</td>
</tr>
<tr>
<td>string</td>
<td>a nonempty string not matching any of the preceding types</td>
<td>TYPE, TEXT</td>
<td>Anything surrounded by doublequotes,
'''or'' anything with embedded spaces that doesn't match one of the preceding types</td>
</tr>
<tr>
<td>optional string</td>
<td>a string value (may be empty)</td>
<td>DESCRIPTION, USER_DESCRIPTION</td>
<td>Anything surrounded by doublequotes,
'''or'' anything with embedded spaces that doesn't match one of the preceding types</td>
</tr>
<tr>
<td>value</td>
<td>anything</td>
<td>*VALUE</td>
<td>anything</td>
</tr>
</table>

Any numeric or position is accepted by a span argument. Any image or name is accepted for a string argument. Any actual argument that is a macro is accepted for any formal. Otherwise, if the formal has an identifiable type, <tt>wmlscope</tt> will complain if the actual literal does not match it.

The argument type check only works in macro calls that fit on a single line.

<tt>wmlscope</tt> has many options for changing the reports it generates; the more advanced ones are intended for Wesnoth developers. Invocations for the most commonly useful reports it generates are included in data/tools/Makefile of the source distribution. Here are some of those reports:

; make unresolved: Report on unresolved macro calls and resource references; also report macro argument-type mismatches. (This is what you are most likely to want to do).

; make all: Report all macro and resource file references, not just unresolved ones.

; make collisions: Report on duplicate resource files.

For more advanced users, or those who want to understand what the canned Makefile invocations are doing, here is a summary of <tt>wmlscope</tt>'s options. Some of the more advanced options will require you to understand
[http://docs.python.org/lib/re-syntax.html Python regular expressions].

; -h, --help: Emit a help message and quit
; -c, --crossreference: Report resolved macro references (implies -w 1)
; -C, --collisions: Report duplicate resource files
; -d, --deflist: Make definition list. (This one is for campaign server maintainers.)
; -e regexp, --exclude regexp: Ignore files matching the specified regular expression.
; -f dir, --from dir: Report only on macros defined under dir
; -l, --listfiles: List files that will be processed
; -r ddd, --refcount=ddd: Report only on macros with references in exactly ddd files.
; -u, --unresolved: Report unresolved macro references
; -w, --warnlevel: Set to 1 to warn of duplicate macro definitions
; --force-used reg: Ignore reference count 0 on names matching regexp
; --extracthelp: Extract help from macro definition comments.

== wmllint ==

<tt>wmllint</tt> is a tool for migrating your WML to the current version. It handles two problems:

* Resource files and macro names may change between versions of the game. <tt>wmllint</tt> knows about these changes and will tweak your WML to fit where it can.

* Between 1.2.x and 1.3.1 the terrain-coding system used in map files underwent a major change. It changed again in a minor way between 1.3.1 and 1.3.2. <tt>wmllint</tt> will translate your maps for you, unless you use custom terrains in which case you will have to do it by hand.

<tt>wmllint</tt> also performs various sanity-checking operations, reporting:

* unbalanced tags
* strings that need a translation mark and do not have them
* strings that have a translation mark and should not
* translatable strings containing macro references
* filter references by description= (id= in 1.5) not matched by an actual unit
* abilities or traits without matching special notes, or vice-versa
* consistency between recruit= and recruitment_pattern= instances
* double space after punctuation in translatable strings.
* unknown races or movement types in units

<tt>wmllint</tt> takes a directory-path argument specifying the WML directories to work on. It will modify any cfg and map files under those directories that need to be changed. Here is a summary of its options:

; -h, --help: Emit a help message and quit.
; -d, --dryrun: List changes but don't perform them.
; -v, --verbose: Set verbosity; more details below.
; -c, --clean: Clean up -bak files.
; -D, --diff: Show diffs between unconverted and unconverted files.
; -r, --revert: Revert the conversion from the -bak files.
; -n, --nolift: Suppress lifting, do sanity checks only

The verbosity option works like this:

; -v: lists changes.
; -v -v: warns of maps already converted.
; -v -v -v: names each file before it's processed.
; -v -v -v -v: shows verbose parse details (developers only).

The recommended procedure is this:

# Run it with --dryrun first to see what it will do.
# If the messages look good, run without --dryrun; the old content will be left in backup files with a -bak extension.
# Eyeball the changes with the --diff option.
# Use wmlscope, with a directory path including the Wesnoth mainline WML, to check that you have no unresolved references.
# Test the conversion.
# Use either --clean to remove the -bak files or --revert to undo the conversion.

In the development branch, wmllint has the additional feature that it tries to locate a spell checker on your system and spell-checks storyline and message strings. It will work automatically with either aspell, myspell, or ispell provided you have the <tt>enchant.py</tt> Python library installed.

== wmlindent ==

Call with no arguments to filter WML on standard input to reindented WML on
standard output. If arguments are specified, they are taken to be files to be
re-indented in place; interrupting will be safe, as each reindenting
will be done to a copy that is atomically renamed when it's done. This
code never modifies anything but blank lines and leading and trailing whitespace on non-blank lines.

The indent unit is four spaces. Absence of an option to change this is
deliberate; the purpose of this tool is to prevent style wars, not encourage
them.

If you don't apply this tool to your own WML, the mainline-campaign maintainers
will do it when and if your code is accepted into the tree.

Note: This tool does not include a parser. It will produce bad results on WML
that is syntactically unbalanced. Unbalanced double quotes that aren't part
of a multiline literal will also confuse it. You will receive warnings
oiif there's an indent open at end of file or if a closer occurs with
indent already zero; these two conditions strongly suggest unbalanced WML.

[[Category:Create]]
[[Category:Tools]]

User:Lizard(Saurian)

2008-09-14T16:46:59Z

Saurian: /* Saurian Exodus*/

EditingWesnoth

2008-06-04T14:09:13Z

Saurian: Windows Vista userdata path

== Game and User Directories ==

Wherever you install the game, there will be a game data directory that contains, of course, the game's data. This directory should have the following subdirectories: data, music, sounds, and images. There are several others, but these are the important ones. In this wiki, the terms "game data", wesnoth/data, or ./data refers to the wesnoth/data directory. You normally do not need to modify these files, but you can if you want to modify a unit or something.

The user data directory allows you to add custom content without modifying the game's own files. Each OS puts its user data directory in a different place. In this wiki, "user data", ''userdata''/''subdirectory'', or (occasionally) ~wesnoth/ refer to this directory.

=== Where is my '''game''' data directory? ===

====Windows====
Usually C:\Program Files\Wesnoth\data but it will be different if you installed the game in a different location: look for the data folder in the folder where you installed the game.

====Mac OS X====
Downloaded from sourceforge: command-click on the application icon. Select "Show Package Contents." Select "Contents" then "Resources.
If you did not download from sourceforge what do you do?
Command line build: /usr/local/share/wesnoth

====Linux====
/usr/local/share/wesnoth 
From apt-get (Debian and Ubuntu) or emerge (Gentoo): /usr/share/games/wesnoth 
SUSE 10.0 (pre-installed): /usr/share/wesnoth 
Fedora 5 (Installed from yum repository RPM): /usr/share/wesnoth 
Mandriva 2006.0: /usr/share/games/wesnoth 
Slackware 12 (Installed from .tgz package at LinuxPackages.net): /usr/local/share/wesnoth 
If you don't find it, or if you use another distribution, try <code>find / -iname '*wesnoth*'</code>. (as yourself, not as superuser)

=== Where is my '''user''' data directory? ===

====Windows====
c:\Program Files\Wesnoth\userdata

or c:\Users\USERNAME\AppData\Local\VirtualStore\Program Files\Wesnoth\userdata
on Vista, which has virtual folders. The AppData folder is hidden.

====Mac OS X====
Downloaded from sourceforge: ~/Library/Preferences/Wesnoth 
Command line build: ~/.wesnoth

====Linux====
~/.wesnoth

== Game data ==

The major directories you need to know about are wesnoth/data, wesnoth/data/units, wesnoth/data/campaigns, wesnoth/data/maps, wesnoth/data/scenarios, wesnoth/images

Become familiar with what is in ./data/campaigns, ./data/scenarios, and ./data/maps. These have the officially distributed campaigns and multiplayer maps. If you ever want to examine or edit one of the scenario configuration files, this is where you would go. For example, a common question is how a new player can give himself more turns or gold in scenario X. This is where you would go to do that.

Two very important directories are ./data/units and ./images. You have the ability to drop new units or images in these directories and have the game recognize them. When specifying an image for something, you do so relative to ./images.

=== Game Configuration ===

Some information is stored in files in the ./data directory itself:
* amla.cfg - global definition for After Max-Level Advancement (currently 3 hp per 100 XP)
* fonts.cfg - defines which fonts the game can use
* game.cfg
* help.cfg - the entire help system document
* items.cfg - macros for common objects and items used in the game, also available for campaign writer use
* multiplayer.cfg - defines the multiplayer eras and factions
* names.cfg - lists of name fragments that are randomly put together to create random-sounding names. Segregated by race and gender
* scenario-test.cfg - a simple test scenario. Run it with the command wesnoth -t
* schedules.cfg - defines the global day-night cycle
* terrain.cfg - defines the terrain types
* terrain-graphics.cfg - defines terrain layering and usage of random terrain
* tips.cfg - the contents of the Tome of Wesnoth
* traits.cfg - defines all traits used globally in the game
* utils.cfg - some common macros used in the game, also available for campaign writer use
* units.cfg - defines the races, which traits each race has, and the movement types (which set defenses, resistances, and movement costs)

For more information about game configuration:
* themes/: [[ThemeSystem]]
* maps/: [[BuildingMaps]]
* scenarios/: [[BuildingScenarios]]
* translations/: [[WesnothTranslations]]
* units/: [[BuildingUnits]]
* game.cfg: [[WesnothGameConfigure]]

== User Data ==
The user data directory can do a lot of things. The game looks here for several things:
* ''userdata''/data/campaigns - campaign configuration files and subdirectories
* ''userdata''/data/editor/maps - multiplayer standalone maps (map data only)
* ''userdata''/data/units - drop your custom units here, and they will be visible to the game
* ''userdata''/data/images - drop your custom images here, and they will be visible to the game

The ''userdata''/data/campaigns directory is particularly useful. A single configuration file here can selectively point to an entire subdirectory tree of units, images, sounds, scenarios, and macros. This allows you to wall off parts. Content included in the userdata units or images directories will be available globally whether you want it or not. Content included in the campaigns directory won't be loaded unless the game is told to do it.

For example, assume you have a campaign called MyCampaign. This is what the ''userdata''/data/campaigns directory looks like:
* ''userdata''/data/campaigns/MyCampaign.cfg - a text file
* ''userdata''/data/campaigns/MyCampaign/ - a subdirectory
** ''userdata''/data/campaigns/MyCampaign/scenarios
** ''userdata''/data/campaigns/MyCampaign/units
** ''userdata''/data/campaigns/MyCampaign/images
** ''userdata''/data/campaigns/MyCampaign/music
** ''userdata''/data/campaigns/MyCampaign/sounds
** ''userdata''/data/campaigns/MyCampaign/utils

MyCampaign.cfg will have something called the "campaign ifdef", which is a syntax structure that instructs the game to search ''userdata''/data/campaigns/MyCampaign/ for data. More about this is found in [[BuildingCampaigns]]. However, it is important to understand the different capabilites of the user data directory.

== See Also ==

* [[Create]]

[[Category:Create]]

User:Lizard(Saurian)

2008-06-02T19:47:22Z

Saurian: /* Several Island later ... */

=Lizard's user page=
Well, I'll make my user page here, but this will be later.
In the Forum I'm called Lizard, but the wikiuser Lizard was used.
==Free Saurian Faction / Era of Strife==
I made a Faction which is called "Free Saurian Faction" you can find it in the "Era of Strife"
==Saurian Freedom==
I might create a Campaign for the Saurians.
I starts on the Drake Island also mentioned in tRoW.
Here is a first draw:
====Working accident====
The first scenario, you escape from a cave where you are held as slaves by the drakes.
NO RECRUITING!
====A first home====
You find a swamp where you can rest (the one east of the lake). How could it be different, you have to fight for it killing several monsters. You get Spiders and/or Lizard Riders after that.
====Escape the second====
well, I need a better name.
You have to escape from the Drakes which hunt you.
====Well ...====
you went into another cave killing many young drake babys (yeah, Saurians ARE cruel).
====Fleeing by ship====
the title tells.
====Several Islands later ...====

-Maybe also a Teleport gate. You get help by a ''necromancer'', and you have to invade a village/city to get sacrifices for the Teleport Gate. For this scenario you get a special unit which tie a unit when killed. The prisoners have to be transported back to the Castle.

====Cleaning you new home====
Eliminate some Triththas(or another faction) which occupy the area around a nice swamp.

On the whole 5 + x + 1 scenarios. If I do three Islands there will be 9 scenarios.

User:Lizard(Saurian)

2008-06-02T19:47:05Z

Saurian: /* Several Island later ... */

=Lizard's user page=
Well, I'll make my user page here, but this will be later.
In the Forum I'm called Lizard, but the wikiuser Lizard was used.
==Free Saurian Faction / Era of Strife==
I made a Faction which is called "Free Saurian Faction" you can find it in the "Era of Strife"
==Saurian Freedom==
I might create a Campaign for the Saurians.
I starts on the Drake Island also mentioned in tRoW.
Here is a first draw:
====Working accident====
The first scenario, you escape from a cave where you are held as slaves by the drakes.
NO RECRUITING!
====A first home====
You find a swamp where you can rest (the one east of the lake). How could it be different, you have to fight for it killing several monsters. You get Spiders and/or Lizard Riders after that.
====Escape the second====
well, I need a better name.
You have to escape from the Drakes which hunt you.
====Well ...====
you went into another cave killing many young drake babys (yeah, Saurians ARE cruel).
====Fleeing by ship====
the title tells.
====Several Island later ...====

-Maybe also a Teleport gate. You get help by a ''necromancer'', and you have to invade a village/city to get sacrifices for the Teleport Gate. For this scenario you get a special unit which tie a unit when killed. The prisoners have to be transported back to the Castle.

====Cleaning you new home====
Eliminate some Triththas(or another faction) which occupy the area around a nice swamp.

On the whole 5 + x + 1 scenarios. If I do three Islands there will be 9 scenarios.

User:Lizard(Saurian)

2008-05-27T20:12:14Z

Saurian: Created

=Lizard's user page=
Well, I'll make my user page here, but this will be later.
In the Forum I'm called Lizard, but the wikiuser Lizard was used.
==Free Saurian Faction / Era of Strife==
I made a Faction which is called "Free Saurian Faction" you can find it in the "Era of Strife"
==Saurian Freedom==
I might create a Campaign for the Saurians.
I starts on the Drake Island also mentioned in tRoW.
Here is a first draw:
====Working accident====
The first scenario, you escape from a cave where you are held as slaves by the drakes.
NO RECRUITING!
====A first home====
You find a swamp where you can rest (the one east of the lake). How could it be different, you have to fight for it killing several monsters. You get Spiders and/or Lizard Riders after that.
====Escape the second====
well, I need a better name.
You have to escape from the Drakes which hunt you.
====Well ...====
you went into another cave killing many young drake babys (yeah, Saurians ARE cruel).
====Fleeing by ship====
the title tells.
====Several Island later ...====
====Cleaning you new home====
Eliminate some Triththas(or another faction) which occupy the area around a nice swamp.

On the whole 5 + x + 1 scenarios. If I do three Islands there will be 9 scenarios.

TerrainCodesWML

2008-03-30T11:48:56Z

Saurian: /* Adding terrains */

{{WML Tags}}

Note: the old (1.2) terrain system is no longer documented here. If you have 1.2 maps you will need to convert them using [[Maintenance_tools|wmllint]].

== Terrain strings ==

The following rules hold for terrain strings. Note most of these rules are not validated since it would slow down Wesnoth; not following these rules might break Wesnoth.

* terrain strings are composed from one or more terrain codes of 2 to 4 characters each, separated by ^.
* terrain codes start with a capital letter and the following letters are lower case
* terrain strings can only contain letters, the symbols /|\ which are meant for directional items like bridges and the symbol ^
* the underscore is used as a leader for internal terrain codes
* the star '*' can be used for wildcards in some places where a terrain code is required
* the symbol ^ indicates that a terrain is created with layers, for example Gs^Fp means Forest(Fp) overlayer on Savanna(Gs).

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.

=== Terrain Table ===
This is a list of the terrains, the strings used for them in the new map format, the letters used for them in the old map format, their id and the terrains they take their stats from.

<table border="1"><tr>
<th>String</th>
<th>Name</th>
<th>Stats from</th>
</tr>
<tr>
<td>_off^_usr</td>
<td>None (used in map borders)</td>
<td></td>
</tr>
<tr>
<td>_s</td>
<td>Shroud (use in mask only)</td>
<td></td>
</tr>
<tr>
<td>_f</td>
<td>Fog (use in mask only)</td>
<td></td>
</tr>
<tr>
<td>Ai</td>
<td>Ice</td>
<td>Snow</td>
</tr>
<tr>
<td>Aa</td>
<td>Snow</td>
<td></td>
</tr>
<tr>
<td>Ww^Bw|</td>
<td>Bridge</td>
<td>Grassland,Shallow Water</td>
</tr>
<tr>
<td>Ww^Bw/</td>
<td>Bridge</td>
<td>Grassland,Shallow Water</td>
</tr>
<tr>
<td>Ww^Bw\</td>
<td>Bridge</td>
<td>Grassland,Shallow Water</td>
</tr>
<tr>
<td>Wo^Bw|</td>
<td>Bridge</td>
<td>Grassland,Deep Water</td>
</tr>
<tr>
<td>Wo^Bw/</td>
<td>Bridge</td>
<td>Grassland,Deep Water</td>
</tr>
<tr>
<td>Wo^Bw\</td>
<td>Bridge</td>
<td>Grassland,Deep Water</td>
</tr>
<tr>
<td>Ss^Bw|</td>
<td>Bridge</td>
<td>Grassland,Swamp</td>
</tr>
<tr>
<td>Ss^Bw/</td>
<td>Bridge</td>
<td>Grassland,Swamp</td>
</tr>
<tr>
<td>Ss^Bw\</td>
<td>Bridge</td>
<td>Grassland,Swamp</td>
</tr>
<tr>
<td>Ce</td>
<td>Encampment</td>
<td>Castle</td>
</tr>
<tr>
<td>Ch</td>
<td>Castle</td>
<td></td>
</tr>
<tr>
<td>Cv</td>
<td>Elven Castle</td>
<td>Castle</td>
</tr>
<tr>
<td>Cud</td>
<td>Dwarven Castle</td>
<td>Castle</td>
</tr>
<tr>
<td>Chr</td>
<td>Ruin</td>
<td>Castle</td>
</tr>
<tr>
<td>Chw</td>
<td>Sunken Ruin</td>
<td>Castle,Shallow Water</td>
</tr>
<tr>
<td>Chs</td>
<td>Swamp Ruin</td>
<td>Castle,Swamp</td>
</tr>
<tr>
<td>Ke</td>
<td>Encampment keep</td>
<td>Castle</td>
</tr>
<tr>
<td>Kh</td>
<td>Keep</td>
<td>Castle</td>
</tr>
<tr>
<td>Kv</td>
<td>Elven Keep</td>
<td>Castle</td>
</tr>
<tr>
<td>Kud</td>
<td>Dwarven keep</td>
<td>Castle</td>
</tr>
<tr>
<td>Khr</td>
<td>Ruined keep</td>
<td>Castle</td>
</tr>
<tr>
<td>Khw</td>
<td>Sunken keep</td>
<td>Castle,Shallow Water</td>
</tr>
<tr>
<td>Khs</td>
<td>Swamp keep</td>
<td>Castle,Swamp</td>
</tr>
<tr>
<td>Dd^Dc</td>
<td>Crater</td>
<td>Sand</td>
</tr>
<tr>
<td>Dd</td>
<td>Desert</td>
<td>Sand</td>
</tr>
<tr>
<td>Dd^Dr</td>
<td>Rubble</td>
<td>Hills</td>
</tr>
<tr>
<td>Ds</td>
<td>Sand</td>
<td></td>
</tr>
<tr>
<td>Dd^Do</td>
<td>Oasis</td>
<td>Sand</td>
</tr>
<tr>
<td>Aa^Fpa</td>
<td>Snow Forest</td>
<td>Snow,Forest</td>
</tr>
<tr>
<td>Gg^Fet</td>
<td>Great Tree</td>
<td>Forest</td>
</tr>
<tr>
<td>Gs^Fp</td>
<td>Forest</td>
<td></td>
</tr>
<tr>
<td>Gs^Ft</td>
<td>Tropical Forest</td>
<td>Forest</td>
</tr>
<tr>
<td>Gg</td>
<td>Grassland</td>
<td></td>
</tr>
<tr>
<td>Ggf</td>
<td>Grassland</td>
<td>Grassland</td>
</tr>
<tr>
<td>Gs</td>
<td>Savanna</td>
<td>Grassland</td>
</tr>
<tr>
<td>Ha</td>
<td>Snow Hills</td>
<td>Snow,Hills</td>
</tr>
<tr>
<td>Hd</td>
<td>Dunes</td>
<td>Sand,Hills</td>
</tr>
<tr>
<td>Hh</td>
<td>Hills</td>
<td></td>
</tr>
<tr>
<td>Md</td>
<td>Mountains</td>
<td>Mountains</td>
</tr>
<tr>
<td>Mm</td>
<td>Mountains</td>
<td></td>
</tr>
<tr>
<td>Qxu</td>
<td>Chasm</td>
<td></td>
</tr>
<tr>
<td>Ql</td>
<td>Lava Chasm</td>
<td>Chasm</td>
</tr>
<tr>
<td>Qlf</td>
<td>Lava (flat)</td>
<td>Chasm</td>
</tr>
<tr>
<td>Rd</td>
<td>Desert road</td>
<td>Grassland</td>
</tr>
<tr>
<td>Re</td>
<td>Dirt</td>
<td>Grassland</td>
</tr>
<tr>
<td>Rr</td>
<td>Road</td>
<td>Grassland</td>
</tr>
<tr>
<td>Rp</td>
<td>Road (Elven Path)</td>
<td>Grassland</td>
</tr>
<tr>
<td>Re^Gvs</td>
<td>Farmland</td>
<td>Grassland</td>
</tr>
<tr>
<td>Gg^Wm</td>
<td>Windmill</td>
<td>Grassland</td>
</tr>
<tr>
<td>Ss</td>
<td>Swamp</td>
<td></td>
</tr>
<tr>
<td>Uu</td>
<td>Cave</td>
<td></td>
</tr>
<tr>
<td>Uu^Ii</td>
<td>Cave Lit</td>
<td>Cave</td>
</tr>
<tr>
<td>Uu^Uf</td>
<td>Mushroom Grove</td>
<td></td>
</tr>
<tr>
<td>Re^Uf</td>
<td>Mushroom Grove</td>
<td>Mushroom Grove</td>
</tr>
<tr>
<td>Uh</td>
<td>Rockbound Cave</td>
<td>Cave,Hills</td>
</tr>
<tr>
<td>Uh^Ii</td>
<td>Rockbound Cave Lit</td>
<td>Cave,Hills</td>
</tr>
<tr>
<td>Dd^Vda</td>
<td>Village</td>
<td>Village,Sand</td>
</tr>
<tr>
<td>Dd^Vdt</td>
<td>Village</td>
<td>Village,Sand</td>
</tr>
<tr>
<td>Aa^Vea</td>
<td>Village</td>
<td>Village</td>
</tr>
<tr>
<td>Gg^Ve</td>
<td>Village</td>
<td>Village</td>
</tr>
<tr>
<td>Aa^Vha</td>
<td>Village</td>
<td>Village</td>
</tr>
<tr>
<td>Gg^Vh</td>
<td>Village</td>
<td></td>
</tr>
<tr>
<td>Hh^Vhh</td>
<td>Village</td>
<td>Village,Hills</td>
</tr>
<tr>
<td>Ha^Vhha</td>
<td>Village</td>
<td>Village,Hills</td>
</tr>
<tr>
<td>Mm^Vhh</td>
<td>Village</td>
<td>Village,Mountains</td>
</tr>
<tr>
<td>Gs^Vht</td>
<td>Village</td>
<td>Village</td>
</tr>
<tr>
<td>Uu^Vu</td>
<td>Village</td>
<td>Village,Cave</td>
</tr>
<tr>
<td>Uu^Vud</td>
<td>Village</td>
<td>Village,Cave</td>
</tr>
<tr>
<td>Ww^Vm</td>
<td>Village</td>
<td>Shallow Water</td>
</tr>
<tr>
<td>Ss^Vhs</td>
<td>Village</td>
<td>Village,Swamp</td>
</tr>
<tr>
<td>Ss^Vm</td>
<td>Village</td>
<td>Swamp</td>
</tr>
<tr>
<td>Wo</td>
<td>Deep Water</td>
<td></td>
</tr>
<tr>
<td>Ww</td>
<td>Shallow Water</td>
<td></td>
</tr>
<tr>
<td>Wwf</td>
<td>River Ford</td>
<td>Grassland,Shallow Water</td>
</tr>
<tr>
<td>Mm^Xm</td>
<td>Impassable Mountains</td>
<td>Cave Wall</td>
</tr>
<tr>
<td>Md^Xm</td>
<td>Impassable Desert Mountains</td>
<td>Cave Wall</td>
</tr>
<tr>
<td>Xu</td>
<td>Cave Wall</td>
<td></td>
</tr>
<tr>
<td>Xv</td>
<td>Void</td>
<td>Cave Wall</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/core/macros/abilities.cfg contains the definition of ''submerge'' and ''ambush'' so depending on the change these need to be updated.

data/core/macros/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]]

[[Category: WML Reference]]