The Battle for Wesnoth Wiki - User contributions [en]

VariablesWML/How to use variables

2013-12-10T09:49:58Z

Pyrophorus: /* Dynamic code with insert_tag */

== WML Variables HowTo (or Descent into Darkness) ==
In this document, we shall try to explain WML variables and their use with some details. We’ll start under the burning sun of lawful ordinary use, but, step by step, we shall go deeper in the shadows of necromancy, exploring undocumented features and hidden pits as we may. The first part should be understandable by any beginner, but the last one most probably requires a good WML understanding.

=== Under the burning sun ===

==== Variable definitions ====
This section and the next one can be skipped if you already know what variables are and how to use them. Variables are some kind of container a programmer can use to store pieces of information (s)he needs to manipulate : numbers, names, sentences, and anything else. In most programming languages, variables must be declared before they can be used. Declaration is an instruction giving a name (used later to refer to the variable) and a type, which defines the kind of content of the variable (number, characters strings, and so on). Later in the program, instructions can be used to store and retrieve the content of the container, which is most often called the value of the variable. In WML, variables need no declaration and their value have no precise type1). This means a new variable will be created at the first time the programmer stores something in it. And that (s)he can store anything in it. Variables use memory, so it’s good practice to clear them when they’re not needed anymore.
Variables names are freely chosen by the programmer with some restrictions. They should not be the name of a language instruction (keyword) or operator. In WML, you can use quite any name or sentence to name a variable, but you shouldn’t if you want to shun subtle problems. A classical rule is :
: - variable name should begin with a letter
: - variable names should only contain letters (not accented) and numbers and the underscore _ character.
No spaces, no accented letters, no special characters, no minus and plus signs, etc… Those names are always safe and correctly interpreted by the engine as variables names. Note that some special characters are forbidden in variable names: '''$ , . | {} [] =''' because they have a special meaning we shall see later. I would strongly suggest to avoid common tags names like “event” “side” and too long names like:
: “name_of_the_guy_who_killed_the_orc_on_last_turn” which is not the same as:
: “name_of_the_gyu_who_killed_the_orc_on_last_turn”, but it’s not really obvious at first glance.
It’s a common error to type wrongly a variable name: in WML this don’t rise any error message, but the variable will have no value, giving most probably what you don’t expect. Last but not least, variables names are case sensitive: in other words, ‘aVar’ is not the same as ‘avar’.

==== Variables creation and manipulation ====
Even if WML variables contents have no precise types.[[In computering words, they are not '''strongly typed.'''|1)]], we shall discuss two kinds:
: - variables holding a single value, like a number, a character string
: - variables holding a compound value, i.e. a pack of single values.
They’re often called containers in the documentation. Simple variables are created using the tag '''[set_variable]''':
[set_variable]
name=simpleVariable
value=36
[/set_variable]
The tag defines the name and the value of the variable.

Next, we can access the variable value using the variable name prefixed with a dollar sign $.
[modify_unit]
[filter]
id=$unit.id
[/filter]
moves=$simpleVariable
[/modify_unit]
This sets the moves of the unit to 36 since '''simpleVariable''' holds 36.

When the line is executed, the value 36 is substituted to '''$simpleVariable''', so it works as if we wrote:
[modify_unit]
[filter]
id=$unit.id
[/filter]
moves=36
[/modify_unit]
Using the same tag, we can change the value of '''simpleVariable''', or make some arithmetic (see the tag documentation for the whole list).

For example:
[set_variable]
name=simpleVariable
sub=30
[/set_variable]
will change the value to 6 of course. We can even set the variable to another value type:
[set_variable]
name=simpleVariable
value="Delfador the Great"
[/set_variable]
We shall not use '''[set_variable]''' tag anymore. Instead, we shall use the '''VARIABLE''' shortcut:

{VARIABLE simpleVariable "Delfador the Great"}
stands for:
[set_variable]
name=simpleVariable
value="Delfador the Great"
[/set_variable]
We shall not use the arithmetic variations of '''set_variable''' either. Instead we shall use the '''formulaAI''' syntax which is much more natural. Instead of:
[set_variable]
name=simpleVariable
value=35
[/set_variable]
[set_variable]
name=simpleVariable
add=$anotherVariable
[/set_variable]
we shall write:
[set_variable]
name=simpleVariable
value="$(35 + $anotherVariable)"
[/set_variable]
: # or
{VARIABLE simpleVariable "$(35 + $anotherVariable)"}
The formulaAI syntax is easy to use, the important thing is to always put the formula in this sequence: “'''$( …''' here comes the formula '''… )'''”
In other words, '''$simpleVariable''' can be written everywhere you want to use the value of '''simpleVariable.'''
Clearing variables can be done using the '''[clear_variable]''' tag:
[clear_variable]
name=simpleVariable
[/clear_variable]
: # or using the following macro to delete more than one variable {CLEAR_VARIABLE simpleVariable,anotherOne,count} [[Please note the CLEAR_VARIABLE macro will not work if your variables names contain spaces or commas. It’s one good reason to avoid them.|2)]]

==== Containers ====
What is a container?
It is a variable holding more than a simple value.
A good example is the unit variable created automatically in '''moveto''' and '''attack''' events. It contains the full description of a unit, not only its name and its id. Containers are useful to store related values in a pack. All these different values are called “members” of the created container. Instead of writing this:
{VARIABLE heroName "Delfador"}
{VARIABLE heroGold 250}
{VARIABLE heroFame 127}
{VARIABLE heroFullName "Delfador the Great"}
we can pack all this in a “hero” variable using '''[set_variables]''' (notice the ‘s’)
[set_variables]
name=hero
[value]
name="Delfador"
gold=250
fame=127
fullName="Delfador the Great"
[/value]
[/set_variables]
Then, to get the values stored in the container, we shall use the $ sign as before, but appending the member name and a dot:[[That’s why dots are forbidden in variable names : they are used to specify members.|3)]]
$hero.name -> Delfador
$hero.gold -> 250
And if we want to change a value, the “gold” member for instance:
[set_variable]
name=hero.gold
add=100
[/set_variable]
It’s important to note that here, we changed the “gold” member as if it was a single variable whose name is “'''hero.gold'''”. We can also clear a member of the container in the same way:
{CLEAR_VARIABLE hero.fullName}
This will delete the '''fullName''' member permanently. Note it will not only clear the value, but clear the member itself. Clearing the value would be:
{VARIABLE hero.fullName ""}
Can we add later a member to an existing container ? Yes, it can be done:
{VARIABLE hero.hasStaff yes}
this creates the member hasStaff and set it to yes.

=== A glance into the pit ===

All this will be clearer if we take a look at the way variables are stored. Opening a savegame with a text editor, we should find a part like this one:
[replay_start]
id=""
[variables]
damage_inflicted=18
heal_amount=10
side_number=1
turn_number=26
x1=8
x2=0
y1=8
y2=0
simpleVariable=35
[hero]
name="Delfador"
gold=250
fame=127
fullName="Delfador the Great"
[/hero]
...

Here are our variables ! We can see simple ones are a pair name/value separated with an equal
sign.[[That’s why = signs are forbidden in variables names : it corrupts savegames.|4)]]

Container are stored in a WML block whose name is the variable name.
Actually, it’s just like folders and files on your hard disk. Each name/value pair is like a file,
and other tags like folders. This explains the syntax used: '''set_variable''' and '''clear_variable''' operate on name/value pairs, and you use the dot to specify the path to the line you want to create or modify, for example '''hero.name'''.
Using '''set_variable''' creates a line if it exists not. So we can use it to add lines to the hero
container using '''hero.'''something name, just as we can add a new line at the first level.
Now, we can understand better what a container is. It’s a WML block, just as an ordinary tag,
and can hold any valid WML content. Look at this:
[set_variables]
name=aVar
[value]
name=capture
first_time_only=no
[filter]
side=3
type=orc
[/filter]
[set_variable]
name=tmp
rand=1..2
[/set_variable]
[/value]
[/set_variables]
This is perfectly valid and creates this container variable:
[aVar]
name=capture
first_time_only=no
[filter]
side=3
type=orc
[/filter]
[set_variable]
name=tmp
rand=1..2
[/set_variable]
[/aVar]
We can modify members in the sub blocks too, using the full path to them, separated with
dots. For instance:
{VARIABLE aVar.set_variable.rand “1..5”}
or
{VARIABLE aVar.filter.side 2}.
Capito ?

We can delete members, values or even whole blocks in the same way:
{CLEAR_VARIABLE aVar.filter.type}
will remove the key ‘type’ in the filter block:
[aVar]
name=capture
first_time_only=no
[filter]
side=3
[/filter]
[set_variable]
name=tmp
rand=1..2
[/set_variable]
[/aVar]

{CLEAR_VARIABLE aVar.filter } will remove the whole filter block:

[aVar]
name=capture
first_time_only=no
[set_variable]
name=tmp
rand=1..2
[/set_variable]
[/aVar]
This example is rather confusing because this variable looks much more like a piece of code
than data (and it’s part of the content of an event, of course). But, if you want to follow us to
the deeper of darkness, you should already face this ominous truth: data and code are not
separated in WML, and it’s possible to modify the code with data manipulation instructions.
Fortunately with some limits. Actually, you can only modify from WML what can be put into
a variable: units, locations, and some code blocks, but you can’t directly access to scenario
level.

A more usual example is the unit container. '''Moveto''' events create a unit variable holding the
full description of the moving unit. When pushed in your torture room (the ‘unit’ variable)
you’re allowed to access any field of the unit. Exact composition of a unit block can be
fetched in a savegame or with ''':inspect''' in debug mode. It’s rather complex. Here is an
example (many lines have been deleted, particularly animations):
[unit]
flying=yes
gender="female"
hitpoints=26
id="Lestiviel"
image="units/elves-wood/shaman.png"
max_experience=26
max_hitpoints=26
max_moves=5
moves=5
name=_"Lestiviel"
overlays="misc/hero-icon.png"
profile="portraits/Lestiviel-y.png"
race="elf"
[attack]
damage=3
description=_"staff"
icon="attacks/druidstaff.png"
name="staff"
number=2
range="melee"
type="impact"
[/attack]
[attack]
damage=3
description=_"entangle"
name="entangle"
number=2
range="ranged"
type="impact"
[specials]
[slow]
description=_"Slow:"
id="slow"
name=_"slows"
[/slow]
[/specials]
[/attack]
[modifications]
[trait]
description=_"Zero upkeep"
female_name=_"female^loyal"
id="loyal"
male_name=_"loyal"
[effect]
apply_to="loyal"
[/effect]
[/trait]
[trait]
female_name=_"female^intelligent"
id="intelligent"
male_name=_"intelligent"
[effect]
apply_to="max_experience"
increase="-20%"
[/effect]
[/trait]
[/modifications]
[/unit]
Here we have a problem: this unit has two attack blocks and two traits blocks. How can we
access them ? Writing only '''$unit.attack.name''' can’t be correct since we have two blocks. We
have here our first example of arrays. Arrays are lists of WML blocks sharing the same name (here '''attack''' or '''modifications.trait'''). The blocks in arrays are implicitly numbered in the
order they are written, and we can use this index to state which one we want:

$unit.attack[0].name -> "staff"
$unit.attack[1].name -> "entangle"

$unit.modifications.trait[0].id -> "loyal"
$unit.modifications.trait[1].id -> "intelligent"

Note: Indexes begins with 0. So, can we modify the value of the intelligent trait using
VARIABLE ? Yes, just do it:

{VARIABLE $unit.modifications.trait[1].increase "-50%"}

Does this modification apply to the unit ? Not immediately. You should use '''[unstore_unit]'''
first to pull them out of your torture room, and then… well, it works for some values, but not
all of them. There is an automatic healing process at work and some unit properties are
overwritten when '''[unstore_unit]''' happens, but the variable itself is really changed. You can
verify this using ''':inspect'''.

==== More with arrays ====
Arrays can be created using the '''[set_variables]''' tag. In it, we can repeat the '''[value][/value]'''
block at will, and this will create a container array:
[set_variables]
name=heroes
[value]
name="Delfador"
gold=250
fame=127
fullName="Delfador the Great"
[/value]
[value]
name="Konrad"
gold=125
fame=10
fullName="Konrad the Heir"
[/value]
[value]
name="Lisar"
gold=1258
fame=250
fullName="Princess Lisar"
[/value]
[/set_variables]
This will create three [heroes] blocks numbered from 0 to 2.
[heroes]
name="Delfador"
gold=250
fame=127
fullName="Delfador the Great"
[/heroes]
[heroes]
name="Konrad"
gold=125
fame=10
fullName="Konrad the Heir"
[/heroes]
[heroes]
name="Lisar"
gold=1258
fame=250
fullName="Princess Lisar"
[/heroes]
Arrays all have a special property named '''length'''. It holds the number of blocks in the array.
So here:
$heroes.length -> 3

$unit.modifications.trait.length -> 2
(from the previous ‘unit’ example)

Another way to create arrays is using '''[store_unit]''' and '''[store_locations]''' tags, or
'''[set_variables]''' when using the '''split''' key to split a string.

All these arrays can be modified: we can add later a block or delete it. Deletion is done with
the '''[clear_variable]''' tag:
{CLEAR_VARIABLE heroes[1]}
This will delete the Konrad record. Please note that the array will be renumbered: so the Lisar record will now have the index 1.

Adding blocks can be done with '''[set_variables]''' using the additional key '''mode'''. By default,
'''[set_variables]''' creates a new array (or container), erasing any previous variable with the
same name. But, using one of the different modes allows to add new blocks in various places:

* replace: will clean the array name and replace it with given data, it’s the default.
* append: will append given data to the current array
* merge: will merge in the given data into name
* insert: will insert the given data at the index specified in the name attribute, such as
name=my_array[1].

Note that '''[store_unit]''' has also a '''mode''' key allowing to append more units blocks to an array.

You can place any kind of block in an array, but usually, it’s good practice to avoid meddling
different kind of records (for instance units and locations). The reason is most often, arrays
are fetched and manipulated in loops. Loops are much more easy to program when all records
have the same structure.
The '''FOREACH''' macro is most often used for this purpose. It takes an array name and a
variable name as arguments. The variable will contain an index incremented by one on each
step of the loop by the ending macro '''NEXT'''. For instance, we can summarize the wealth of
our heroes with this code:
{FOREACH heroes index}
[set_variable]
name=tmp
add=$heroes[$index].gold
[/set_variable]
{NEXT index}

[message]
speaker=narrator
message="Team has $tmp gold."
[/message]
Here, we accumulate the gold amount of our heroes in the variable '''tmp'''. The loop will begin
with '''index'''=0 and repeat the code inserted between '''FOREACH''' and '''NEXT''', incrementing the value of index by one and will stop when '''index=heroes.length'''.
'''FOREACH''' is easy to use, but one should be aware of two things:
:- make sure you don’t use the index variable elsewhere: it shall be cleared at the end.
:- when using such a loop to delete some records. For instance this:
{FOREACH heroes index}
[if]
[variable]
name=heroes[$index].name
equals="Konrad"
[/variable]
[then]
{CLEAR_VARIABLE heroes[$index]}
[/then]
[/if]
{NEXT index}
will not work exactly as expected. As we saw earlier, the array will be renumbered when the
“Konrad” record is deleted. So the next record will take the “Konrad” index, and, since index
is incremented at the end of the step, the record following “Konrad” will be skipped. The
correct way to do this is fetching the array in reverse order[[Less easy because there is no macro for that.|5)]] or decrementing the index after the deletion:
{FOREACH heroes index}
[if]
[variable]
name=heroes[$index].name
equals="Konrad"
[/variable]
[then]
{CLEAR_VARIABLE heroes[$index]}
[set_variable]
name=index
sub=1
[set_variable]
[/then]
[/if]
{NEXT index}
=== First steps into darkness ===

==== Using simple strings in names ====
Consider this variable name:
heroes_$index
How to understand this? At execution time, '''$index''' will be replaced with the value of the
variable index[[It would be better if it exists… |6)]]. Suppose it contains 2, the variable used will then be '''heroes_2'''. Of course, it
can be anything else, “Konrad” for instance. Then the variable will be '''heroes_Konrad'''.

Look at these macros:
#define LSB_STOREPERSO ID KILL
[store_unit]
[filter]
id=${ID}
[/filter]
variable=${ID}_back
kill={KILL}
[/store_unit]
#enddef

#define LSB_RECALLPERSO ID XY
[unstore_unit]
variable=${ID}_back
find_vacant=yes
{XY}
[/unstore_unit]
#enddef
They store and retrieve an unit using it’s ID to create the name of the variable. The unit ID is
found in the variable whose name is given in the parameter ID. For instance, it can be '''unit.id''' in a moveto event:
[event]
name=moveto
# ... the filter will come here
{LSB_STOREPERSO unit.id yes} # the unit disappear
# but is stored in a variable named after its id,
# for instance "Konrad_back"
[/event]
The variables created using this code shouldn’t be confused with an array. They’re individual
variables, even if they look more or less the same in the ''':inspect''' display. Particularly, they
can’t be fetched using a '''FOREACH''' loop. But if this is not needed, one can find this better to
create bi-dimensional arrays, particularly because distinct records are easier to identify in the
''':inspect''' display.
In this code, we use quite the same system as above to create a bi-dimensional array to store
boats and units on board. The unit ID (of the boat) is used to create the name of an array
storing the units it contains, whose name is '''RF_$ID''', for example '''RF_B1, RF_B2''' and so on.
So, in a '''moveto''' event of one of these boats, '''RF_$unit.id''' is the name of the array
containing the crew. This code make them pop out.
{FOREACH RF_$unit.id| n}
[unstore_unit]
variable=RF_$unit.id|[$n]
x,y=$rft[0].x,$rft[0].y
find_vacant=yes
[/unstore_unit]
{NEXT n}
Fine, but here, the engine could have a problem: what is exactly RF_$unit.id[$n] ? It can
be :
:- the nth record of the array RF_$unit.id (if unit.id = B1, it would be RF_B1[$n])
:- the simple variable named RF_$unit.id[$n], where the suffix is taken from $unit.id array.
That’s why the pipe character | is appended to the array name. It states the first case is the
good one, or in other words, the array name is delimited between the $ sign and the pipe.

This is one way to create and use bi-dimensional arrays. But it’s possible to create real bi-
dimensional array: they are arrays containing arrays (which could contain arrays as well, and
so on… but will you really need that ?)
Here is the way to do this. We shall use here our “heroes” array, and store it twice into a new
created array:
[set_variables]
name=biDim
[insert_tag]
name=value
variable=heroes
[/insert_tag]
[insert_tag]
name=value
variable=heroes # of course it could be something different
[/insert_tag]
[/set_variables]
'''Insert_tag''' creates a new block whose tag is equal to its '''name''' key, so each '''insert_tag''' will create a block:
[value]
[heroes]
name="Delfador"
gold=250
fame=127
fullName="Delfador the Great"
[/heroes]
[heroes]
name="Konrad"
gold=125
fame=10
fullName="Konrad the Heir"
[/heroes]
[heroes]
name="Lisar"
gold=1258
fame=250
fullName="Princess Lisar"
[/heroes]
[/value]
Still with us? OK, now to access our heroes we shall use the ordinary syntax. For instance:
$biDim[0].heroes[1].name -> Konrad

And of course, one can walk all the array using a nested FOREACH loop.
{FOREACH biDim i}
{FOREACH biDim[$i].heroes index}
[if]
[variable]
name=biDim[$i].heroes[$index].gold
less_than=100
[/variable]
[then]
[set_variable]
name=biDim[$i].heroes[$index].gold
add=100
[/set_variable]
[/then]
[/if]
{NEXT index}
{NEXT i}
This adds some gold to the purse of the poorest heroes of biDim array.

==== Using variables strings in events names ====
This syntax:
[event]
name=$myEvent
...
[/message]
Is perfectly valid. Of course, '''myEvent''' should contain some valid event name, consistent with
the event body. One use of this is to specify turn numbers. For instance:
[event]
name=turn $afterDark
...
[/event]
With this you can set '''afterDark''' in order to state when the event should fire (it must then
contain a number or a string of the form '''side number'''). Even more useful is the way to fire an
event some turn after another occurred. Suppose we want to raise a storm two turns after some
hero visited a particular location. Then we shall write:
[event]
name=moveto
# ... the moveto filter will come here

[event]
name="turn $($turn_number + 2)"

# start the storm
[/event]
[/event]
This will create the nested event and make it fire 2 turns later.
It can be used with '''fire_event''' too. This code sets the variable '''myEvent''' according to the
incomer type, then fires the corresponding event.
[switch]
name=unit.type
[case]
value=Elvish Sorceress
{VARIABLE myEvent storm}
[/case]
[case]
value=Troll Warrior
{VARIABLE myEvent monster}
[/case]
[case]
value=Mermaid Initiate
{VARIABLE myEvent flood}
[/case]
[/switch]

# --- somewhat later…
[fire_event]
name=$myEvent
[/fire_event]

# ... of course, these events should be defined elsewhere
[event]
name=storm
...
[/event]

[event]
name=monster
...
[/event]

[event]
name=flood
...
[/event]

=== Voodoo and black magics ===
« He who enters this place must quit all hopes… »

At this point, maybe you begin to suspect many things can be replaced with variables,
including parts of the code itself. That’s true and interesting in some cases, but it should be
clear that using the features explained later creates code much more difficult to understand
and to debug. You certainly shall discover that much more can be done than what we
describe, but here, we shall restrain ourselves to some limits. Trespassing them is most often
getting caught in mysterious traps, and most often, absolutely useless.
In other words, you’re at risk to fall into deep darkness under heavy bugs attack. So take
care…

==== Existing blocks customization ====
Since we can add members to existing containers, why not add some to documented
containers like units or objects ? It’s perfectly possible, and finally harmless (You’re only are at risk your code become broken if the key name is used in further versions of Wesnoth) [[You can minimize the risk using special key names like 'Pyro_level' instead of only 'level'… or write a feature request! |7)]] . WML just ignores what it knows nothing of. In units blocks, you have a special block named '''variables'''
where you can add safely all what you want, but it’s common to find in campaigns additions
to the '''status''' block. For instance:
{VARIABLE unit.status.isHero yes}
creates a new flag named '''isHero''' in unit status. Of course, the game engine will not display
anything as it does with '''slow''' and '''poison''' status key, but you can use it in filters:
[event]
name=die
first_time_only=no
[filter_condition]
[variable]
name=unit.status.isHero
boolean_equals=yes
[/variable]
[/filter_condition]
…

The same can be done in objects. In this object block, the programmer added two custom
keys, category and price.
[object]
name= _ "Poisonous Bow"
image=items/bow.png
description= _ "This bow deals 20% more damage than other bows, it shots poisonned arrows to enemies and is also quicker."
category=bows
price=150
[effect]
apply_to=new_attack
name=longbow
type=pierce
range=ranged
damage=12
number=4
movement_used=0
icon=attacks/bow-elven-magic.png
[specials]
{WEAPON_SPECIAL_POISON}
[/specials]
[/effect]
[/object]
And when this object is applied to an unit, the extra keys are not deleted or modified in any
way.

==== Passing “parameters” to an event ====
The trick explained here is for use with the '''fire-event''' tag. As you know, this tag allows to
trigger an event (custom or not) from another piece of code. Really useful for instance, when
you don’t want to repeat the same code in many places. As the reference manual says, it can
be used as some sort of subroutine call.
Fine, but in programming languages, subroutines calls accept parameters for use of the
subroutine, and '''fire_event''' don’t.
Suppose we want to display a nice message which can be spoken by various units. Of course,
we can use role or a global variable '''whoSpeaks''' to specify who is speaking. For instance:
[event]
name=nice_speech
[message]
speaker=$whoSpeaks
message=_"Vanish, foul messengers of Sauron…" # and so on…
[/message]
[/event]
We can fire this event with:
{VARIABLE whoSpeaks Gandalf} # or any other character
[fire_event]
name=nice_speech
[/fire_event]
But we would have to clear the whoSpeaks variable later. There is another way. In the
fire_event tag documentation, one can find:
'''[primary_attack]''': Information passed to the primary attack filter and $weapon variable on
the new event. Of course, we have no attacker and no attack here, but what happens if we set something here
like :
[fire_event]
name=nice_speech
[primary_attack]
whoSpeaks=Gandalf
[/primary_attack]
[/fire_event]

[event]
name=nice_speech
[message]
speaker=$weapon.whoSpeaks
message=_"Vanish, foul messengers of Sauron…" # and so on…
[/message]
[/event]
Well, it pure voodoo but it works. Of course, one can pass anything in the '''primary_attack'''
block, not only a single value. The block itself will be discarded when he event is finished,
just like call parameters in subroutines.

==== Dynamic code with insert_tag ====
We have already seen a use of this tag above. Its effect is to insert at execution time a WML
block contained in a variable. It is like a macro, but macro substitution occurs once when
loading the code which makes a huge difference. With '''insert_tag''', the variable used (i.e. the
code executed) can change during the scenario.
First step is creating a container holding the WML block you want to execute. For instance,
this action:
[harm_unit]
[filter]
x,y=$x1,$y1
[/filter]
amount=10
animate=yes
kill=no
[/harm_unit]
The easiest way is to use a macro to define the block content:

#define BLOCK_CONTENT
[filter]
x,y=$x1,$y1
[/filter]
amount=10
animate=yes
kill=no
#enddef

[set_variables]
name=harmingCode
[value]
{BLOCK_CONTENT}
[/value]
[/set_variables]
Else, we should have to create the variable first, and then add the subtag in this way:
[set_variables]
name=harmingCode
[value]
amount=10
animate=yes
kill=no
[/value]
[/set_variables]

[set_variables]
name=harmingCode.filter
[value]
x,y=$x1,$y1
[/value]
[/set_variables]
Notice, we didn’t include the '''[harm_unit]''' tag. Then we can use '''insert_tag''' in this way:
[insert_tag]
name=harm_unit
variable=harmingCode
[/insert_tag]
This will produce exactly the original block above. Sometimes, it’s not very practical to
define only the block content in the macro (maybe you would like to use it elsewhere, as an
ordinary macro). Then you can specify the '''command''' tag in the '''insert_tag'''. This tag does
nothing except creating blocks. Then it would be:
#define HARM_UNIT
[harm_unit]
[filter]
x,y=$x1,$y1
[/filter]
amount=10
animate=yes
kill=no
[/harm_unit]
#enddef

[set_variables]
name=harmingCode
[value]
{HARM_UNIT}
[/value]
[/set_variables]

# --- somewhere else…

[insert_tag]
name=command
variable=harmingCode
[/insert_tag]
But… this code works not always. The reason is the $x1, $y1. They are replaced with their values when we create the '''harmingCode''' variable, which is not what we generally want. We want to use the values they hold when the '''insert_tag''' is executed (most often, it’s later), in other words, we want to delay their substitution. To mark these variables to be substituted later , we shall add a pipe character just after the dollar sign:
#define HARM_UNIT
[harm_unit]
[filter]
x,y=$|x1,$|y1
[/filter]
amount=10
animate=yes
kill=no
[/harm_unit]
#enddef

Then the code works. And the macro can be used in a normal way too. Another way to avoid the early variable substitution is using the tag '''literal''' instead of '''value''' when creating the '''harmingCode''' variable:

[set_variables]
name=harmingCode
[literal]
{HARM_UNIT}
[/literal]
[/set_variables]

Pay heed, '''insert_tag''' must be included in some action (event and so on). It works not at the scenario level for instance.
As you can see, the '''insert_tag''' allows to do many things, but in our opinion, should be used scarcely. Here we shall show how it can be used to solve a common problem. Suppose we want to list the objects of a unit in a option message, let the user choose an object and remove it from the unit. This can be done with this kind of code:
[message]
message="Choose an item to drop"
speaker=narrator
[option]
message="Fabulous speed potion"
[show_if]
# here a conditional expression stating if the unit has
# the fabulous item.
[/show_if]
[command]
# ... drop the item
[/command]
[/option]
# more options blocks...
[/message]
The '''show_if''' tag prevents the line to show if the unit has not the object. There are two problems with this code. First, the condition is not easy to write: the object list of the unit must be searched for that particular object. Next, the message block must have an option for each possible item. No problem if you have only a few, but when, like in some add-ons we shall name not, you have near one hundred…
Here, we shall create dynamically a message block listing all the objects in the modification block of the unit. Thus, we don’t need the '''show_if''' tag et we want something like that:
[message]
message="Choose an item to drop"
speaker=narrator
[option]
message="Fabulous speed potion"
[command]
# ... drop the item
[/command]
[/option]
[option]
message="Amazing flashing bow"
[command]
# ... drop the item
[/command]
[/option]
# ... more options if more objects
[option]
message="Exit"
[command]
# ... exit the loop
[/command]
[/option]
[/message]
So we shall create dynamically this block in a container variable and next use '''insert_tag''' to
execute it. The block itself is embedded in a loop which executes until the exit option is
chosen (this sets the flag '''t_done'''):
# list unit objects
#define LSB_LIST_UNIT_THINGS
{VARIABLE t_done no}

[while]
[variable]
name=t_done
equals=no
[/variable]
[do]
{CLEAR_VARIABLE t_menu}
{VARIABLE t_menu.message " Choose an item to drop:"}
{VARIABLE t_menu.speaker narrator}

# here begins the objects listing. They are in the modifications block of the unit
{FOREACH unit.modifications.object nc}
# creates the option block with the name of the object
[set_variables]
name=t_menu.option
mode=append
[value]
message=$unit.modifications.object[$nc].name
[command]
# remove the object, or anything else
{LSB_CLEAR_UNITOBJECT}
[/command]
[/value]
[/set_variables]
{NEXT nc}

# this adds the “exit” option to the end of the list
{VARIABLE nc $t_menu.option.length}
[set_variables]
name=t_menu.option
mode=append
[value]
message="Exit."
[command]
{VARIABLE t_done yes}
[/command]
[/value]
[/set_variables]

# this finally displays the list on screen and let the user choose
[insert_tag]
name=message
variable=t_menu
[/insert_tag]
[/do]
[/while]
{CLEAR_VARIABLE t_menu,nc}
#enddef

# this is an example of use: in a right-click menu item.
[set_menu_item]
id=LSB_drop
description="Drop items."
[show_if]
[variable]
name=unit.side
equals=1
[/variable]
[/show_if]
[command]
{LSB_LIST_UNIT_THINGS}
[/command]
[/set_menu_item]
Of course, you may want to list not all objects applied to a unit. It’s easy to do that adding a
custom key to the objects you want to list, for instance '''droppable=yes''', and testing if it is
present before creating the option block.

Another example of code managing pickuppable items on the map. We first define those objects using macros. For instance, this one is the core Storm Trident with some additional keys. The '''[object]''' tag is missing in order to use this macro more easily in an '''[insert_tag]'''.
# --- Object definition example, don’t include the [object] tag
#define LSB_STORM_TRIDENT
name="storm trident"
image=items/storm-trident.png
duration=forever
description={RTN_USTR-6}
category=spears
level=2
[effect]
apply_to=new_attack
name="storm trident"
description="storm trident"
icon=attacks/lightning.png
type=fire
range=ranged
[specials]
{WEAPON_SPECIAL_MAGICAL}
[/specials]
damage=15
number=2
[/effect]

{LIGHTNING_ANIMATION "storm trident" 1}
{LIGHTNING_ANIMATION "storm trident" 2}
{LIGHTNING_ANIMATION "storm trident" 3}
#enddef
At the beginning of the scenario or even the campaign, we define an object list containing all pickuppable items. Please note it’s the only place we need to modify when creating or deleting an object in our campaign. All the code needed to manage them is generic.
# --- shortcut to store an object into an array
#define LSB_OBJINFO OBJ
[value]
{OBJ}
[/value]
#enddef

# This is the main objects list which must be created at first start: it creates an array with all pickuppable items and give them an uid.
#define LSB_CREATEOBJECTS_LIST
[set_variables]
name=Objets
mode=replace
{LSB_OBJINFO {RTN_OBJ_TELNECKLACE} }
{LSB_OBJINFO {RTN_OBJ_AELTHRANK} }
{LSB_OBJINFO {LSB_GOLD} }
{LSB_OBJINFO {LSB_STORM_TRIDENT} }
# add more here at will
[/set_variables]

{FOREACH Objets i} # this adds an id to objects
[set_variable]
name=Objets[$i].uid
value=$i
[/set_variable]
{NEXT i}
#enddef
Here a macro to drop objects on the map. Note the NUM parameter is the uid created before, not the full object itself. Of course, it can be a variable holding an uid.
#define LSB_DROP_OBJECT NUM X Y
[item] # place the item on the map
image=$Objets[{NUM}].image
x,y={X},{Y}
[/item]
[set_variables] # add it to the dropped objects list
name=D_Objets
mode=append
[value]
x={X}
y={Y}
code={NUM}
[/value]
[/set_variables]
#enddef
At last, we can set up a moveto event to trigger the pick up dialog
#define LSB_GETOBJECT FILTER ID
[event]
name=moveto
id=GETOBJECT_{ID}
first_time_only=no
[filter]
[filter_location] # fires only if there is something on the map
find_in=D_Objets
[/filter_location]
{FILTER} # and for some units
[/filter]

{VARIABLE i $D_Objets.length}
[while] # maybe we have more than one object here
[variable]
name=i
greater_than=0
[/variable]
[do]
[set_variable]
name=i
sub=1
[/set_variable]

# message
[if]
[variable]
name=D_Objets[$i].x
equals=$x1
[/variable]
[variable]
name=D_Objets[$i].y
equals=$y1
[/variable]
[then]
[message]
speaker=narrator
message=_ "There is a $Objets[$D_Objets[$i].code].name on the ground. Should $unit.name take it ?"
[option]
message=_ "Take it"
[command]
# --- give object to unit
[insert_tag]
name=object
variable=Objets[$D_Objets[$i].code]
[/insert_tag]

# --- clear the map
[remove_item]
image=$Objets[$D_Objets[$i].code].image
x,y=$unit.x,$unit.y
[/remove_item]
{CLEAR_VARIABLE D_Objets[$i]}
[/command]
[/option]
[option]
message= _ "Leave it"
[/option]
[/message]
[/then]
[/if]
[/do]
[/while]
[/event]
#enddef

VariablesWML/How to use variables

2013-12-10T09:37:06Z

Pyrophorus: /* Passing “parameters” to an event */

== WML Variables HowTo (or Descent into Darkness) ==
In this document, we shall try to explain WML variables and their use with some details. We’ll start under the burning sun of lawful ordinary use, but, step by step, we shall go deeper in the shadows of necromancy, exploring undocumented features and hidden pits as we may. The first part should be understandable by any beginner, but the last one most probably requires a good WML understanding.

=== Under the burning sun ===

==== Variable definitions ====
This section and the next one can be skipped if you already know what variables are and how to use them. Variables are some kind of container a programmer can use to store pieces of information (s)he needs to manipulate : numbers, names, sentences, and anything else. In most programming languages, variables must be declared before they can be used. Declaration is an instruction giving a name (used later to refer to the variable) and a type, which defines the kind of content of the variable (number, characters strings, and so on). Later in the program, instructions can be used to store and retrieve the content of the container, which is most often called the value of the variable. In WML, variables need no declaration and their value have no precise type1). This means a new variable will be created at the first time the programmer stores something in it. And that (s)he can store anything in it. Variables use memory, so it’s good practice to clear them when they’re not needed anymore.
Variables names are freely chosen by the programmer with some restrictions. They should not be the name of a language instruction (keyword) or operator. In WML, you can use quite any name or sentence to name a variable, but you shouldn’t if you want to shun subtle problems. A classical rule is :
: - variable name should begin with a letter
: - variable names should only contain letters (not accented) and numbers and the underscore _ character.
No spaces, no accented letters, no special characters, no minus and plus signs, etc… Those names are always safe and correctly interpreted by the engine as variables names. Note that some special characters are forbidden in variable names: '''$ , . | {} [] =''' because they have a special meaning we shall see later. I would strongly suggest to avoid common tags names like “event” “side” and too long names like:
: “name_of_the_guy_who_killed_the_orc_on_last_turn” which is not the same as:
: “name_of_the_gyu_who_killed_the_orc_on_last_turn”, but it’s not really obvious at first glance.
It’s a common error to type wrongly a variable name: in WML this don’t rise any error message, but the variable will have no value, giving most probably what you don’t expect. Last but not least, variables names are case sensitive: in other words, ‘aVar’ is not the same as ‘avar’.

==== Variables creation and manipulation ====
Even if WML variables contents have no precise types.[[In computering words, they are not '''strongly typed.'''|1)]], we shall discuss two kinds:
: - variables holding a single value, like a number, a character string
: - variables holding a compound value, i.e. a pack of single values.
They’re often called containers in the documentation. Simple variables are created using the tag '''[set_variable]''':
[set_variable]
name=simpleVariable
value=36
[/set_variable]
The tag defines the name and the value of the variable.

Next, we can access the variable value using the variable name prefixed with a dollar sign $.
[modify_unit]
[filter]
id=$unit.id
[/filter]
moves=$simpleVariable
[/modify_unit]
This sets the moves of the unit to 36 since '''simpleVariable''' holds 36.

When the line is executed, the value 36 is substituted to '''$simpleVariable''', so it works as if we wrote:
[modify_unit]
[filter]
id=$unit.id
[/filter]
moves=36
[/modify_unit]
Using the same tag, we can change the value of '''simpleVariable''', or make some arithmetic (see the tag documentation for the whole list).

For example:
[set_variable]
name=simpleVariable
sub=30
[/set_variable]
will change the value to 6 of course. We can even set the variable to another value type:
[set_variable]
name=simpleVariable
value="Delfador the Great"
[/set_variable]
We shall not use '''[set_variable]''' tag anymore. Instead, we shall use the '''VARIABLE''' shortcut:

{VARIABLE simpleVariable "Delfador the Great"}
stands for:
[set_variable]
name=simpleVariable
value="Delfador the Great"
[/set_variable]
We shall not use the arithmetic variations of '''set_variable''' either. Instead we shall use the '''formulaAI''' syntax which is much more natural. Instead of:
[set_variable]
name=simpleVariable
value=35
[/set_variable]
[set_variable]
name=simpleVariable
add=$anotherVariable
[/set_variable]
we shall write:
[set_variable]
name=simpleVariable
value="$(35 + $anotherVariable)"
[/set_variable]
: # or
{VARIABLE simpleVariable "$(35 + $anotherVariable)"}
The formulaAI syntax is easy to use, the important thing is to always put the formula in this sequence: “'''$( …''' here comes the formula '''… )'''”
In other words, '''$simpleVariable''' can be written everywhere you want to use the value of '''simpleVariable.'''
Clearing variables can be done using the '''[clear_variable]''' tag:
[clear_variable]
name=simpleVariable
[/clear_variable]
: # or using the following macro to delete more than one variable {CLEAR_VARIABLE simpleVariable,anotherOne,count} [[Please note the CLEAR_VARIABLE macro will not work if your variables names contain spaces or commas. It’s one good reason to avoid them.|2)]]

==== Containers ====
What is a container?
It is a variable holding more than a simple value.
A good example is the unit variable created automatically in '''moveto''' and '''attack''' events. It contains the full description of a unit, not only its name and its id. Containers are useful to store related values in a pack. All these different values are called “members” of the created container. Instead of writing this:
{VARIABLE heroName "Delfador"}
{VARIABLE heroGold 250}
{VARIABLE heroFame 127}
{VARIABLE heroFullName "Delfador the Great"}
we can pack all this in a “hero” variable using '''[set_variables]''' (notice the ‘s’)
[set_variables]
name=hero
[value]
name="Delfador"
gold=250
fame=127
fullName="Delfador the Great"
[/value]
[/set_variables]
Then, to get the values stored in the container, we shall use the $ sign as before, but appending the member name and a dot:[[That’s why dots are forbidden in variable names : they are used to specify members.|3)]]
$hero.name -> Delfador
$hero.gold -> 250
And if we want to change a value, the “gold” member for instance:
[set_variable]
name=hero.gold
add=100
[/set_variable]
It’s important to note that here, we changed the “gold” member as if it was a single variable whose name is “'''hero.gold'''”. We can also clear a member of the container in the same way:
{CLEAR_VARIABLE hero.fullName}
This will delete the '''fullName''' member permanently. Note it will not only clear the value, but clear the member itself. Clearing the value would be:
{VARIABLE hero.fullName ""}
Can we add later a member to an existing container ? Yes, it can be done:
{VARIABLE hero.hasStaff yes}
this creates the member hasStaff and set it to yes.

=== A glance into the pit ===

All this will be clearer if we take a look at the way variables are stored. Opening a savegame with a text editor, we should find a part like this one:
[replay_start]
id=""
[variables]
damage_inflicted=18
heal_amount=10
side_number=1
turn_number=26
x1=8
x2=0
y1=8
y2=0
simpleVariable=35
[hero]
name="Delfador"
gold=250
fame=127
fullName="Delfador the Great"
[/hero]
...

Here are our variables ! We can see simple ones are a pair name/value separated with an equal
sign.[[That’s why = signs are forbidden in variables names : it corrupts savegames.|4)]]

Container are stored in a WML block whose name is the variable name.
Actually, it’s just like folders and files on your hard disk. Each name/value pair is like a file,
and other tags like folders. This explains the syntax used: '''set_variable''' and '''clear_variable''' operate on name/value pairs, and you use the dot to specify the path to the line you want to create or modify, for example '''hero.name'''.
Using '''set_variable''' creates a line if it exists not. So we can use it to add lines to the hero
container using '''hero.'''something name, just as we can add a new line at the first level.
Now, we can understand better what a container is. It’s a WML block, just as an ordinary tag,
and can hold any valid WML content. Look at this:
[set_variables]
name=aVar
[value]
name=capture
first_time_only=no
[filter]
side=3
type=orc
[/filter]
[set_variable]
name=tmp
rand=1..2
[/set_variable]
[/value]
[/set_variables]
This is perfectly valid and creates this container variable:
[aVar]
name=capture
first_time_only=no
[filter]
side=3
type=orc
[/filter]
[set_variable]
name=tmp
rand=1..2
[/set_variable]
[/aVar]
We can modify members in the sub blocks too, using the full path to them, separated with
dots. For instance:
{VARIABLE aVar.set_variable.rand “1..5”}
or
{VARIABLE aVar.filter.side 2}.
Capito ?

We can delete members, values or even whole blocks in the same way:
{CLEAR_VARIABLE aVar.filter.type}
will remove the key ‘type’ in the filter block:
[aVar]
name=capture
first_time_only=no
[filter]
side=3
[/filter]
[set_variable]
name=tmp
rand=1..2
[/set_variable]
[/aVar]

{CLEAR_VARIABLE aVar.filter } will remove the whole filter block:

[aVar]
name=capture
first_time_only=no
[set_variable]
name=tmp
rand=1..2
[/set_variable]
[/aVar]
This example is rather confusing because this variable looks much more like a piece of code
than data (and it’s part of the content of an event, of course). But, if you want to follow us to
the deeper of darkness, you should already face this ominous truth: data and code are not
separated in WML, and it’s possible to modify the code with data manipulation instructions.
Fortunately with some limits. Actually, you can only modify from WML what can be put into
a variable: units, locations, and some code blocks, but you can’t directly access to scenario
level.

A more usual example is the unit container. '''Moveto''' events create a unit variable holding the
full description of the moving unit. When pushed in your torture room (the ‘unit’ variable)
you’re allowed to access any field of the unit. Exact composition of a unit block can be
fetched in a savegame or with ''':inspect''' in debug mode. It’s rather complex. Here is an
example (many lines have been deleted, particularly animations):
[unit]
flying=yes
gender="female"
hitpoints=26
id="Lestiviel"
image="units/elves-wood/shaman.png"
max_experience=26
max_hitpoints=26
max_moves=5
moves=5
name=_"Lestiviel"
overlays="misc/hero-icon.png"
profile="portraits/Lestiviel-y.png"
race="elf"
[attack]
damage=3
description=_"staff"
icon="attacks/druidstaff.png"
name="staff"
number=2
range="melee"
type="impact"
[/attack]
[attack]
damage=3
description=_"entangle"
name="entangle"
number=2
range="ranged"
type="impact"
[specials]
[slow]
description=_"Slow:"
id="slow"
name=_"slows"
[/slow]
[/specials]
[/attack]
[modifications]
[trait]
description=_"Zero upkeep"
female_name=_"female^loyal"
id="loyal"
male_name=_"loyal"
[effect]
apply_to="loyal"
[/effect]
[/trait]
[trait]
female_name=_"female^intelligent"
id="intelligent"
male_name=_"intelligent"
[effect]
apply_to="max_experience"
increase="-20%"
[/effect]
[/trait]
[/modifications]
[/unit]
Here we have a problem: this unit has two attack blocks and two traits blocks. How can we
access them ? Writing only '''$unit.attack.name''' can’t be correct since we have two blocks. We
have here our first example of arrays. Arrays are lists of WML blocks sharing the same name (here '''attack''' or '''modifications.trait'''). The blocks in arrays are implicitly numbered in the
order they are written, and we can use this index to state which one we want:

$unit.attack[0].name -> "staff"
$unit.attack[1].name -> "entangle"

$unit.modifications.trait[0].id -> "loyal"
$unit.modifications.trait[1].id -> "intelligent"

Note: Indexes begins with 0. So, can we modify the value of the intelligent trait using
VARIABLE ? Yes, just do it:

{VARIABLE $unit.modifications.trait[1].increase "-50%"}

Does this modification apply to the unit ? Not immediately. You should use '''[unstore_unit]'''
first to pull them out of your torture room, and then… well, it works for some values, but not
all of them. There is an automatic healing process at work and some unit properties are
overwritten when '''[unstore_unit]''' happens, but the variable itself is really changed. You can
verify this using ''':inspect'''.

==== More with arrays ====
Arrays can be created using the '''[set_variables]''' tag. In it, we can repeat the '''[value][/value]'''
block at will, and this will create a container array:
[set_variables]
name=heroes
[value]
name="Delfador"
gold=250
fame=127
fullName="Delfador the Great"
[/value]
[value]
name="Konrad"
gold=125
fame=10
fullName="Konrad the Heir"
[/value]
[value]
name="Lisar"
gold=1258
fame=250
fullName="Princess Lisar"
[/value]
[/set_variables]
This will create three [heroes] blocks numbered from 0 to 2.
[heroes]
name="Delfador"
gold=250
fame=127
fullName="Delfador the Great"
[/heroes]
[heroes]
name="Konrad"
gold=125
fame=10
fullName="Konrad the Heir"
[/heroes]
[heroes]
name="Lisar"
gold=1258
fame=250
fullName="Princess Lisar"
[/heroes]
Arrays all have a special property named '''length'''. It holds the number of blocks in the array.
So here:
$heroes.length -> 3

$unit.modifications.trait.length -> 2
(from the previous ‘unit’ example)

Another way to create arrays is using '''[store_unit]''' and '''[store_locations]''' tags, or
'''[set_variables]''' when using the '''split''' key to split a string.

All these arrays can be modified: we can add later a block or delete it. Deletion is done with
the '''[clear_variable]''' tag:
{CLEAR_VARIABLE heroes[1]}
This will delete the Konrad record. Please note that the array will be renumbered: so the Lisar record will now have the index 1.

Adding blocks can be done with '''[set_variables]''' using the additional key '''mode'''. By default,
'''[set_variables]''' creates a new array (or container), erasing any previous variable with the
same name. But, using one of the different modes allows to add new blocks in various places:

* replace: will clean the array name and replace it with given data, it’s the default.
* append: will append given data to the current array
* merge: will merge in the given data into name
* insert: will insert the given data at the index specified in the name attribute, such as
name=my_array[1].

Note that '''[store_unit]''' has also a '''mode''' key allowing to append more units blocks to an array.

You can place any kind of block in an array, but usually, it’s good practice to avoid meddling
different kind of records (for instance units and locations). The reason is most often, arrays
are fetched and manipulated in loops. Loops are much more easy to program when all records
have the same structure.
The '''FOREACH''' macro is most often used for this purpose. It takes an array name and a
variable name as arguments. The variable will contain an index incremented by one on each
step of the loop by the ending macro '''NEXT'''. For instance, we can summarize the wealth of
our heroes with this code:
{FOREACH heroes index}
[set_variable]
name=tmp
add=$heroes[$index].gold
[/set_variable]
{NEXT index}

[message]
speaker=narrator
message="Team has $tmp gold."
[/message]
Here, we accumulate the gold amount of our heroes in the variable '''tmp'''. The loop will begin
with '''index'''=0 and repeat the code inserted between '''FOREACH''' and '''NEXT''', incrementing the value of index by one and will stop when '''index=heroes.length'''.
'''FOREACH''' is easy to use, but one should be aware of two things:
:- make sure you don’t use the index variable elsewhere: it shall be cleared at the end.
:- when using such a loop to delete some records. For instance this:
{FOREACH heroes index}
[if]
[variable]
name=heroes[$index].name
equals="Konrad"
[/variable]
[then]
{CLEAR_VARIABLE heroes[$index]}
[/then]
[/if]
{NEXT index}
will not work exactly as expected. As we saw earlier, the array will be renumbered when the
“Konrad” record is deleted. So the next record will take the “Konrad” index, and, since index
is incremented at the end of the step, the record following “Konrad” will be skipped. The
correct way to do this is fetching the array in reverse order[[Less easy because there is no macro for that.|5)]] or decrementing the index after the deletion:
{FOREACH heroes index}
[if]
[variable]
name=heroes[$index].name
equals="Konrad"
[/variable]
[then]
{CLEAR_VARIABLE heroes[$index]}
[set_variable]
name=index
sub=1
[set_variable]
[/then]
[/if]
{NEXT index}
=== First steps into darkness ===

==== Using simple strings in names ====
Consider this variable name:
heroes_$index
How to understand this? At execution time, '''$index''' will be replaced with the value of the
variable index[[It would be better if it exists… |6)]]. Suppose it contains 2, the variable used will then be '''heroes_2'''. Of course, it
can be anything else, “Konrad” for instance. Then the variable will be '''heroes_Konrad'''.

Look at these macros:
#define LSB_STOREPERSO ID KILL
[store_unit]
[filter]
id=${ID}
[/filter]
variable=${ID}_back
kill={KILL}
[/store_unit]
#enddef

#define LSB_RECALLPERSO ID XY
[unstore_unit]
variable=${ID}_back
find_vacant=yes
{XY}
[/unstore_unit]
#enddef
They store and retrieve an unit using it’s ID to create the name of the variable. The unit ID is
found in the variable whose name is given in the parameter ID. For instance, it can be '''unit.id''' in a moveto event:
[event]
name=moveto
# ... the filter will come here
{LSB_STOREPERSO unit.id yes} # the unit disappear
# but is stored in a variable named after its id,
# for instance "Konrad_back"
[/event]
The variables created using this code shouldn’t be confused with an array. They’re individual
variables, even if they look more or less the same in the ''':inspect''' display. Particularly, they
can’t be fetched using a '''FOREACH''' loop. But if this is not needed, one can find this better to
create bi-dimensional arrays, particularly because distinct records are easier to identify in the
''':inspect''' display.
In this code, we use quite the same system as above to create a bi-dimensional array to store
boats and units on board. The unit ID (of the boat) is used to create the name of an array
storing the units it contains, whose name is '''RF_$ID''', for example '''RF_B1, RF_B2''' and so on.
So, in a '''moveto''' event of one of these boats, '''RF_$unit.id''' is the name of the array
containing the crew. This code make them pop out.
{FOREACH RF_$unit.id| n}
[unstore_unit]
variable=RF_$unit.id|[$n]
x,y=$rft[0].x,$rft[0].y
find_vacant=yes
[/unstore_unit]
{NEXT n}
Fine, but here, the engine could have a problem: what is exactly RF_$unit.id[$n] ? It can
be :
:- the nth record of the array RF_$unit.id (if unit.id = B1, it would be RF_B1[$n])
:- the simple variable named RF_$unit.id[$n], where the suffix is taken from $unit.id array.
That’s why the pipe character | is appended to the array name. It states the first case is the
good one, or in other words, the array name is delimited between the $ sign and the pipe.

This is one way to create and use bi-dimensional arrays. But it’s possible to create real bi-
dimensional array: they are arrays containing arrays (which could contain arrays as well, and
so on… but will you really need that ?)
Here is the way to do this. We shall use here our “heroes” array, and store it twice into a new
created array:
[set_variables]
name=biDim
[insert_tag]
name=value
variable=heroes
[/insert_tag]
[insert_tag]
name=value
variable=heroes # of course it could be something different
[/insert_tag]
[/set_variables]
'''Insert_tag''' creates a new block whose tag is equal to its '''name''' key, so each '''insert_tag''' will create a block:
[value]
[heroes]
name="Delfador"
gold=250
fame=127
fullName="Delfador the Great"
[/heroes]
[heroes]
name="Konrad"
gold=125
fame=10
fullName="Konrad the Heir"
[/heroes]
[heroes]
name="Lisar"
gold=1258
fame=250
fullName="Princess Lisar"
[/heroes]
[/value]
Still with us? OK, now to access our heroes we shall use the ordinary syntax. For instance:
$biDim[0].heroes[1].name -> Konrad

And of course, one can walk all the array using a nested FOREACH loop.
{FOREACH biDim i}
{FOREACH biDim[$i].heroes index}
[if]
[variable]
name=biDim[$i].heroes[$index].gold
less_than=100
[/variable]
[then]
[set_variable]
name=biDim[$i].heroes[$index].gold
add=100
[/set_variable]
[/then]
[/if]
{NEXT index}
{NEXT i}
This adds some gold to the purse of the poorest heroes of biDim array.

==== Using variables strings in events names ====
This syntax:
[event]
name=$myEvent
...
[/message]
Is perfectly valid. Of course, '''myEvent''' should contain some valid event name, consistent with
the event body. One use of this is to specify turn numbers. For instance:
[event]
name=turn $afterDark
...
[/event]
With this you can set '''afterDark''' in order to state when the event should fire (it must then
contain a number or a string of the form '''side number'''). Even more useful is the way to fire an
event some turn after another occurred. Suppose we want to raise a storm two turns after some
hero visited a particular location. Then we shall write:
[event]
name=moveto
# ... the moveto filter will come here

[event]
name="turn $($turn_number + 2)"

# start the storm
[/event]
[/event]
This will create the nested event and make it fire 2 turns later.
It can be used with '''fire_event''' too. This code sets the variable '''myEvent''' according to the
incomer type, then fires the corresponding event.
[switch]
name=unit.type
[case]
value=Elvish Sorceress
{VARIABLE myEvent storm}
[/case]
[case]
value=Troll Warrior
{VARIABLE myEvent monster}
[/case]
[case]
value=Mermaid Initiate
{VARIABLE myEvent flood}
[/case]
[/switch]

# --- somewhat later…
[fire_event]
name=$myEvent
[/fire_event]

# ... of course, these events should be defined elsewhere
[event]
name=storm
...
[/event]

[event]
name=monster
...
[/event]

[event]
name=flood
...
[/event]

=== Voodoo and black magics ===
« He who enters this place must quit all hopes… »

At this point, maybe you begin to suspect many things can be replaced with variables,
including parts of the code itself. That’s true and interesting in some cases, but it should be
clear that using the features explained later creates code much more difficult to understand
and to debug. You certainly shall discover that much more can be done than what we
describe, but here, we shall restrain ourselves to some limits. Trespassing them is most often
getting caught in mysterious traps, and most often, absolutely useless.
In other words, you’re at risk to fall into deep darkness under heavy bugs attack. So take
care…

==== Existing blocks customization ====
Since we can add members to existing containers, why not add some to documented
containers like units or objects ? It’s perfectly possible, and finally harmless (You’re only are at risk your code become broken if the key name is used in further versions of Wesnoth) [[You can minimize the risk using special key names like 'Pyro_level' instead of only 'level'… or write a feature request! |7)]] . WML just ignores what it knows nothing of. In units blocks, you have a special block named '''variables'''
where you can add safely all what you want, but it’s common to find in campaigns additions
to the '''status''' block. For instance:
{VARIABLE unit.status.isHero yes}
creates a new flag named '''isHero''' in unit status. Of course, the game engine will not display
anything as it does with '''slow''' and '''poison''' status key, but you can use it in filters:
[event]
name=die
first_time_only=no
[filter_condition]
[variable]
name=unit.status.isHero
boolean_equals=yes
[/variable]
[/filter_condition]
…

The same can be done in objects. In this object block, the programmer added two custom
keys, category and price.
[object]
name= _ "Poisonous Bow"
image=items/bow.png
description= _ "This bow deals 20% more damage than other bows, it shots poisonned arrows to enemies and is also quicker."
category=bows
price=150
[effect]
apply_to=new_attack
name=longbow
type=pierce
range=ranged
damage=12
number=4
movement_used=0
icon=attacks/bow-elven-magic.png
[specials]
{WEAPON_SPECIAL_POISON}
[/specials]
[/effect]
[/object]
And when this object is applied to an unit, the extra keys are not deleted or modified in any
way.

==== Passing “parameters” to an event ====
The trick explained here is for use with the '''fire-event''' tag. As you know, this tag allows to
trigger an event (custom or not) from another piece of code. Really useful for instance, when
you don’t want to repeat the same code in many places. As the reference manual says, it can
be used as some sort of subroutine call.
Fine, but in programming languages, subroutines calls accept parameters for use of the
subroutine, and '''fire_event''' don’t.
Suppose we want to display a nice message which can be spoken by various units. Of course,
we can use role or a global variable '''whoSpeaks''' to specify who is speaking. For instance:
[event]
name=nice_speech
[message]
speaker=$whoSpeaks
message=_"Vanish, foul messengers of Sauron…" # and so on…
[/message]
[/event]
We can fire this event with:
{VARIABLE whoSpeaks Gandalf} # or any other character
[fire_event]
name=nice_speech
[/fire_event]
But we would have to clear the whoSpeaks variable later. There is another way. In the
fire_event tag documentation, one can find:
'''[primary_attack]''': Information passed to the primary attack filter and $weapon variable on
the new event. Of course, we have no attacker and no attack here, but what happens if we set something here
like :
[fire_event]
name=nice_speech
[primary_attack]
whoSpeaks=Gandalf
[/primary_attack]
[/fire_event]

[event]
name=nice_speech
[message]
speaker=$weapon.whoSpeaks
message=_"Vanish, foul messengers of Sauron…" # and so on…
[/message]
[/event]
Well, it pure voodoo but it works. Of course, one can pass anything in the '''primary_attack'''
block, not only a single value. The block itself will be discarded when he event is finished,
just like call parameters in subroutines.

==== Dynamic code with insert_tag ====
We have already seen a use of this tag above. Its effect is to insert at execution time a WML
block contained in a variable. It is like a macro, but macro substitution occurs once when
loading the code which makes a huge difference. With '''insert_tag''', the variable used (i.e. the
code executed) can change during the scenario.
First step is creating a container holding the WML block you want to execute. For instance,
this action:
[harm_unit]
[filter]
x,y=$x1,$y1
[/filter]
amount=10
animate=yes
kill=no
[/harm_unit]
The easiest way is to use a macro to define the block content:

#define BLOCK_CONTENT
[filter]
x,y=$x1,$y1
[/filter]
amount=10
animate=yes
kill=no
#enddef

[set_variables]
name=harmingCode
[value]
{BLOCK_CONTENT}
[/value]
[/set_variables]
Else, we should have to create the variable first, and then add the subtag in this way:
[set_variables]
name=harmingCode
[value]
amount=10
animate=yes
kill=no
[/value]
[/set_variables]

[set_variables]
name=harmingCode.filter
[value]
x,y=$x1,$y1
[/value]
[/set_variables]
Notice, we didn’t include the '''[harm_unit]''' tag. Then we can use '''insert_tag''' in this way:
[insert_tag]
name=harm_unit
variable=harmingCode
[/insert_tag]
This will produce exactly the original block above. Sometimes, it’s not very practical to
define only the block content in the macro (maybe you would like to use it elsewhere, as an
ordinary macro). Then you can specify the '''command''' tag in the '''insert_tag'''. This tag does
nothing except creating blocks. Then it would be:
#define HARM_UNIT
[harm_unit]
[filter]
x,y=$x1,$y1
[/filter]
amount=10
animate=yes
kill=no
[/harm_unit]
#enddef

[set_variables]
name=harmingCode
[value]
{HARM_UNIT}
[/value]
[/set_variables]

# --- somewhere else…

[insert_tag]
name=command
variable=harmingCode
[/insert_tag]
But… this code works not always. The reason is the $x1, $y1. They are replaced with their values when we create the '''harmingCode''' variable, which is not what we generally want. We want to use the values they hold when the '''insert_tag''' is executed (most often, it’s later), in other words, we want to delay their substitution. To mark these variables to be substituted later , we shall add a pipe character just after the dollar sign:
#define HARM_UNIT
[harm_unit]
[filter]
x,y=$|x1,$|y1
[/filter]
amount=10
animate=yes
kill=no
[/harm_unit]
#enddef
Then the code works. And the macro can be used in a normal way too.
Pay heed, '''insert_tag''' must be included in some action (event and so on). It works not at the scenario level for instance.
As you can see, the '''insert_tag''' allows to do many things, but in our opinion, should be used scarcely. Here we shall show how it can be used to solve a common problem. Suppose we want to list the objects of a unit in a option message, let the user choose an object and remove it from the unit. This can be done with this kind of code:
[message]
message="Choose an item to drop"
speaker=narrator
[option]
message="Fabulous speed potion"
[show_if]
# here a conditional expression stating if the unit has
# the fabulous item.
[/show_if]
[command]
# ... drop the item
[/command]
[/option]
# more options blocks...
[/message]
The '''show_if''' tag prevents the line to show if the unit has not the object. There are two problems with this code. First, the condition is not easy to write: the object list of the unit must be searched for that particular object. Next, the message block must have an option for each possible item. No problem if you have only a few, but when, like in some add-ons we shall name not, you have near one hundred…
Here, we shall create dynamically a message block listing all the objects in the modification block of the unit. Thus, we don’t need the '''show_if''' tag et we want something like that:
[message]
message="Choose an item to drop"
speaker=narrator
[option]
message="Fabulous speed potion"
[command]
# ... drop the item
[/command]
[/option]
[option]
message="Amazing flashing bow"
[command]
# ... drop the item
[/command]
[/option]
# ... more options if more objects
[option]
message="Exit"
[command]
# ... exit the loop
[/command]
[/option]
[/message]
So we shall create dynamically this block in a container variable and next use '''insert_tag''' to
execute it. The block itself is embedded in a loop which executes until the exit option is
chosen (this sets the flag '''t_done'''):
# list unit objects
#define LSB_LIST_UNIT_THINGS
{VARIABLE t_done no}

[while]
[variable]
name=t_done
equals=no
[/variable]
[do]
{CLEAR_VARIABLE t_menu}
{VARIABLE t_menu.message " Choose an item to drop:"}
{VARIABLE t_menu.speaker narrator}

# here begins the objects listing. They are in the modifications block of the unit
{FOREACH unit.modifications.object nc}
# creates the option block with the name of the object
[set_variables]
name=t_menu.option
mode=append
[value]
message=$unit.modifications.object[$nc].name
[command]
# remove the object, or anything else
{LSB_CLEAR_UNITOBJECT}
[/command]
[/value]
[/set_variables]
{NEXT nc}

# this adds the “exit” option to the end of the list
{VARIABLE nc $t_menu.option.length}
[set_variables]
name=t_menu.option
mode=append
[value]
message="Exit."
[command]
{VARIABLE t_done yes}
[/command]
[/value]
[/set_variables]

# this finally displays the list on screen and let the user choose
[insert_tag]
name=message
variable=t_menu
[/insert_tag]
[/do]
[/while]
{CLEAR_VARIABLE t_menu,nc}
#enddef

# this is an example of use: in a right-click menu item.
[set_menu_item]
id=LSB_drop
description="Drop items."
[show_if]
[variable]
name=unit.side
equals=1
[/variable]
[/show_if]
[command]
{LSB_LIST_UNIT_THINGS}
[/command]
[/set_menu_item]
Of course, you may want to list not all objects applied to a unit. It’s easy to do that adding a
custom key to the objects you want to list, for instance '''droppable=yes''', and testing if it is
present before creating the option block.

Another example of code managing pickuppable items on the map. We first define those objects using macros. For instance, this one is the core Storm Trident with some additional keys. The '''[object]''' tag is missing in order to use this macro more easily in an '''[insert_tag]'''.
# --- Object definition example, don’t include the [object] tag
#define LSB_STORM_TRIDENT
name="storm trident"
image=items/storm-trident.png
duration=forever
description={RTN_USTR-6}
category=spears
level=2
[effect]
apply_to=new_attack
name="storm trident"
description="storm trident"
icon=attacks/lightning.png
type=fire
range=ranged
[specials]
{WEAPON_SPECIAL_MAGICAL}
[/specials]
damage=15
number=2
[/effect]

{LIGHTNING_ANIMATION "storm trident" 1}
{LIGHTNING_ANIMATION "storm trident" 2}
{LIGHTNING_ANIMATION "storm trident" 3}
#enddef
At the beginning of the scenario or even the campaign, we define an object list containing all pickuppable items. Please note it’s the only place we need to modify when creating or deleting an object in our campaign. All the code needed to manage them is generic.
# --- shortcut to store an object into an array
#define LSB_OBJINFO OBJ
[value]
{OBJ}
[/value]
#enddef

# This is the main objects list which must be created at first start: it creates an array with all pickuppable items and give them an uid.
#define LSB_CREATEOBJECTS_LIST
[set_variables]
name=Objets
mode=replace
{LSB_OBJINFO {RTN_OBJ_TELNECKLACE} }
{LSB_OBJINFO {RTN_OBJ_AELTHRANK} }
{LSB_OBJINFO {LSB_GOLD} }
{LSB_OBJINFO {LSB_STORM_TRIDENT} }
# add more here at will
[/set_variables]

{FOREACH Objets i} # this adds an id to objects
[set_variable]
name=Objets[$i].uid
value=$i
[/set_variable]
{NEXT i}
#enddef
Here a macro to drop objects on the map. Note the NUM parameter is the uid created before, not the full object itself. Of course, it can be a variable holding an uid.
#define LSB_DROP_OBJECT NUM X Y
[item] # place the item on the map
image=$Objets[{NUM}].image
x,y={X},{Y}
[/item]
[set_variables] # add it to the dropped objects list
name=D_Objets
mode=append
[value]
x={X}
y={Y}
code={NUM}
[/value]
[/set_variables]
#enddef
At last, we can set up a moveto event to trigger the pick up dialog
#define LSB_GETOBJECT FILTER ID
[event]
name=moveto
id=GETOBJECT_{ID}
first_time_only=no
[filter]
[filter_location] # fires only if there is something on the map
find_in=D_Objets
[/filter_location]
{FILTER} # and for some units
[/filter]

{VARIABLE i $D_Objets.length}
[while] # maybe we have more than one object here
[variable]
name=i
greater_than=0
[/variable]
[do]
[set_variable]
name=i
sub=1
[/set_variable]

# message
[if]
[variable]
name=D_Objets[$i].x
equals=$x1
[/variable]
[variable]
name=D_Objets[$i].y
equals=$y1
[/variable]
[then]
[message]
speaker=narrator
message=_ "There is a $Objets[$D_Objets[$i].code].name on the ground. Should $unit.name take it ?"
[option]
message=_ "Take it"
[command]
# --- give object to unit
[insert_tag]
name=object
variable=Objets[$D_Objets[$i].code]
[/insert_tag]

# --- clear the map
[remove_item]
image=$Objets[$D_Objets[$i].code].image
x,y=$unit.x,$unit.y
[/remove_item]
{CLEAR_VARIABLE D_Objets[$i]}
[/command]
[/option]
[option]
message= _ "Leave it"
[/option]
[/message]
[/then]
[/if]
[/do]
[/while]
[/event]
#enddef

VariablesWML/How to use variables

2013-12-10T09:35:53Z

Pyrophorus: /* Voodoo and black magics */

== WML Variables HowTo (or Descent into Darkness) ==
In this document, we shall try to explain WML variables and their use with some details. We’ll start under the burning sun of lawful ordinary use, but, step by step, we shall go deeper in the shadows of necromancy, exploring undocumented features and hidden pits as we may. The first part should be understandable by any beginner, but the last one most probably requires a good WML understanding.

=== Under the burning sun ===

==== Variable definitions ====
This section and the next one can be skipped if you already know what variables are and how to use them. Variables are some kind of container a programmer can use to store pieces of information (s)he needs to manipulate : numbers, names, sentences, and anything else. In most programming languages, variables must be declared before they can be used. Declaration is an instruction giving a name (used later to refer to the variable) and a type, which defines the kind of content of the variable (number, characters strings, and so on). Later in the program, instructions can be used to store and retrieve the content of the container, which is most often called the value of the variable. In WML, variables need no declaration and their value have no precise type1). This means a new variable will be created at the first time the programmer stores something in it. And that (s)he can store anything in it. Variables use memory, so it’s good practice to clear them when they’re not needed anymore.
Variables names are freely chosen by the programmer with some restrictions. They should not be the name of a language instruction (keyword) or operator. In WML, you can use quite any name or sentence to name a variable, but you shouldn’t if you want to shun subtle problems. A classical rule is :
: - variable name should begin with a letter
: - variable names should only contain letters (not accented) and numbers and the underscore _ character.
No spaces, no accented letters, no special characters, no minus and plus signs, etc… Those names are always safe and correctly interpreted by the engine as variables names. Note that some special characters are forbidden in variable names: '''$ , . | {} [] =''' because they have a special meaning we shall see later. I would strongly suggest to avoid common tags names like “event” “side” and too long names like:
: “name_of_the_guy_who_killed_the_orc_on_last_turn” which is not the same as:
: “name_of_the_gyu_who_killed_the_orc_on_last_turn”, but it’s not really obvious at first glance.
It’s a common error to type wrongly a variable name: in WML this don’t rise any error message, but the variable will have no value, giving most probably what you don’t expect. Last but not least, variables names are case sensitive: in other words, ‘aVar’ is not the same as ‘avar’.

==== Variables creation and manipulation ====
Even if WML variables contents have no precise types.[[In computering words, they are not '''strongly typed.'''|1)]], we shall discuss two kinds:
: - variables holding a single value, like a number, a character string
: - variables holding a compound value, i.e. a pack of single values.
They’re often called containers in the documentation. Simple variables are created using the tag '''[set_variable]''':
[set_variable]
name=simpleVariable
value=36
[/set_variable]
The tag defines the name and the value of the variable.

Next, we can access the variable value using the variable name prefixed with a dollar sign $.
[modify_unit]
[filter]
id=$unit.id
[/filter]
moves=$simpleVariable
[/modify_unit]
This sets the moves of the unit to 36 since '''simpleVariable''' holds 36.

When the line is executed, the value 36 is substituted to '''$simpleVariable''', so it works as if we wrote:
[modify_unit]
[filter]
id=$unit.id
[/filter]
moves=36
[/modify_unit]
Using the same tag, we can change the value of '''simpleVariable''', or make some arithmetic (see the tag documentation for the whole list).

For example:
[set_variable]
name=simpleVariable
sub=30
[/set_variable]
will change the value to 6 of course. We can even set the variable to another value type:
[set_variable]
name=simpleVariable
value="Delfador the Great"
[/set_variable]
We shall not use '''[set_variable]''' tag anymore. Instead, we shall use the '''VARIABLE''' shortcut:

{VARIABLE simpleVariable "Delfador the Great"}
stands for:
[set_variable]
name=simpleVariable
value="Delfador the Great"
[/set_variable]
We shall not use the arithmetic variations of '''set_variable''' either. Instead we shall use the '''formulaAI''' syntax which is much more natural. Instead of:
[set_variable]
name=simpleVariable
value=35
[/set_variable]
[set_variable]
name=simpleVariable
add=$anotherVariable
[/set_variable]
we shall write:
[set_variable]
name=simpleVariable
value="$(35 + $anotherVariable)"
[/set_variable]
: # or
{VARIABLE simpleVariable "$(35 + $anotherVariable)"}
The formulaAI syntax is easy to use, the important thing is to always put the formula in this sequence: “'''$( …''' here comes the formula '''… )'''”
In other words, '''$simpleVariable''' can be written everywhere you want to use the value of '''simpleVariable.'''
Clearing variables can be done using the '''[clear_variable]''' tag:
[clear_variable]
name=simpleVariable
[/clear_variable]
: # or using the following macro to delete more than one variable {CLEAR_VARIABLE simpleVariable,anotherOne,count} [[Please note the CLEAR_VARIABLE macro will not work if your variables names contain spaces or commas. It’s one good reason to avoid them.|2)]]

==== Containers ====
What is a container?
It is a variable holding more than a simple value.
A good example is the unit variable created automatically in '''moveto''' and '''attack''' events. It contains the full description of a unit, not only its name and its id. Containers are useful to store related values in a pack. All these different values are called “members” of the created container. Instead of writing this:
{VARIABLE heroName "Delfador"}
{VARIABLE heroGold 250}
{VARIABLE heroFame 127}
{VARIABLE heroFullName "Delfador the Great"}
we can pack all this in a “hero” variable using '''[set_variables]''' (notice the ‘s’)
[set_variables]
name=hero
[value]
name="Delfador"
gold=250
fame=127
fullName="Delfador the Great"
[/value]
[/set_variables]
Then, to get the values stored in the container, we shall use the $ sign as before, but appending the member name and a dot:[[That’s why dots are forbidden in variable names : they are used to specify members.|3)]]
$hero.name -> Delfador
$hero.gold -> 250
And if we want to change a value, the “gold” member for instance:
[set_variable]
name=hero.gold
add=100
[/set_variable]
It’s important to note that here, we changed the “gold” member as if it was a single variable whose name is “'''hero.gold'''”. We can also clear a member of the container in the same way:
{CLEAR_VARIABLE hero.fullName}
This will delete the '''fullName''' member permanently. Note it will not only clear the value, but clear the member itself. Clearing the value would be:
{VARIABLE hero.fullName ""}
Can we add later a member to an existing container ? Yes, it can be done:
{VARIABLE hero.hasStaff yes}
this creates the member hasStaff and set it to yes.

=== A glance into the pit ===

All this will be clearer if we take a look at the way variables are stored. Opening a savegame with a text editor, we should find a part like this one:
[replay_start]
id=""
[variables]
damage_inflicted=18
heal_amount=10
side_number=1
turn_number=26
x1=8
x2=0
y1=8
y2=0
simpleVariable=35
[hero]
name="Delfador"
gold=250
fame=127
fullName="Delfador the Great"
[/hero]
...

Here are our variables ! We can see simple ones are a pair name/value separated with an equal
sign.[[That’s why = signs are forbidden in variables names : it corrupts savegames.|4)]]

Container are stored in a WML block whose name is the variable name.
Actually, it’s just like folders and files on your hard disk. Each name/value pair is like a file,
and other tags like folders. This explains the syntax used: '''set_variable''' and '''clear_variable''' operate on name/value pairs, and you use the dot to specify the path to the line you want to create or modify, for example '''hero.name'''.
Using '''set_variable''' creates a line if it exists not. So we can use it to add lines to the hero
container using '''hero.'''something name, just as we can add a new line at the first level.
Now, we can understand better what a container is. It’s a WML block, just as an ordinary tag,
and can hold any valid WML content. Look at this:
[set_variables]
name=aVar
[value]
name=capture
first_time_only=no
[filter]
side=3
type=orc
[/filter]
[set_variable]
name=tmp
rand=1..2
[/set_variable]
[/value]
[/set_variables]
This is perfectly valid and creates this container variable:
[aVar]
name=capture
first_time_only=no
[filter]
side=3
type=orc
[/filter]
[set_variable]
name=tmp
rand=1..2
[/set_variable]
[/aVar]
We can modify members in the sub blocks too, using the full path to them, separated with
dots. For instance:
{VARIABLE aVar.set_variable.rand “1..5”}
or
{VARIABLE aVar.filter.side 2}.
Capito ?

We can delete members, values or even whole blocks in the same way:
{CLEAR_VARIABLE aVar.filter.type}
will remove the key ‘type’ in the filter block:
[aVar]
name=capture
first_time_only=no
[filter]
side=3
[/filter]
[set_variable]
name=tmp
rand=1..2
[/set_variable]
[/aVar]

{CLEAR_VARIABLE aVar.filter } will remove the whole filter block:

[aVar]
name=capture
first_time_only=no
[set_variable]
name=tmp
rand=1..2
[/set_variable]
[/aVar]
This example is rather confusing because this variable looks much more like a piece of code
than data (and it’s part of the content of an event, of course). But, if you want to follow us to
the deeper of darkness, you should already face this ominous truth: data and code are not
separated in WML, and it’s possible to modify the code with data manipulation instructions.
Fortunately with some limits. Actually, you can only modify from WML what can be put into
a variable: units, locations, and some code blocks, but you can’t directly access to scenario
level.

A more usual example is the unit container. '''Moveto''' events create a unit variable holding the
full description of the moving unit. When pushed in your torture room (the ‘unit’ variable)
you’re allowed to access any field of the unit. Exact composition of a unit block can be
fetched in a savegame or with ''':inspect''' in debug mode. It’s rather complex. Here is an
example (many lines have been deleted, particularly animations):
[unit]
flying=yes
gender="female"
hitpoints=26
id="Lestiviel"
image="units/elves-wood/shaman.png"
max_experience=26
max_hitpoints=26
max_moves=5
moves=5
name=_"Lestiviel"
overlays="misc/hero-icon.png"
profile="portraits/Lestiviel-y.png"
race="elf"
[attack]
damage=3
description=_"staff"
icon="attacks/druidstaff.png"
name="staff"
number=2
range="melee"
type="impact"
[/attack]
[attack]
damage=3
description=_"entangle"
name="entangle"
number=2
range="ranged"
type="impact"
[specials]
[slow]
description=_"Slow:"
id="slow"
name=_"slows"
[/slow]
[/specials]
[/attack]
[modifications]
[trait]
description=_"Zero upkeep"
female_name=_"female^loyal"
id="loyal"
male_name=_"loyal"
[effect]
apply_to="loyal"
[/effect]
[/trait]
[trait]
female_name=_"female^intelligent"
id="intelligent"
male_name=_"intelligent"
[effect]
apply_to="max_experience"
increase="-20%"
[/effect]
[/trait]
[/modifications]
[/unit]
Here we have a problem: this unit has two attack blocks and two traits blocks. How can we
access them ? Writing only '''$unit.attack.name''' can’t be correct since we have two blocks. We
have here our first example of arrays. Arrays are lists of WML blocks sharing the same name (here '''attack''' or '''modifications.trait'''). The blocks in arrays are implicitly numbered in the
order they are written, and we can use this index to state which one we want:

$unit.attack[0].name -> "staff"
$unit.attack[1].name -> "entangle"

$unit.modifications.trait[0].id -> "loyal"
$unit.modifications.trait[1].id -> "intelligent"

Note: Indexes begins with 0. So, can we modify the value of the intelligent trait using
VARIABLE ? Yes, just do it:

{VARIABLE $unit.modifications.trait[1].increase "-50%"}

Does this modification apply to the unit ? Not immediately. You should use '''[unstore_unit]'''
first to pull them out of your torture room, and then… well, it works for some values, but not
all of them. There is an automatic healing process at work and some unit properties are
overwritten when '''[unstore_unit]''' happens, but the variable itself is really changed. You can
verify this using ''':inspect'''.

==== More with arrays ====
Arrays can be created using the '''[set_variables]''' tag. In it, we can repeat the '''[value][/value]'''
block at will, and this will create a container array:
[set_variables]
name=heroes
[value]
name="Delfador"
gold=250
fame=127
fullName="Delfador the Great"
[/value]
[value]
name="Konrad"
gold=125
fame=10
fullName="Konrad the Heir"
[/value]
[value]
name="Lisar"
gold=1258
fame=250
fullName="Princess Lisar"
[/value]
[/set_variables]
This will create three [heroes] blocks numbered from 0 to 2.
[heroes]
name="Delfador"
gold=250
fame=127
fullName="Delfador the Great"
[/heroes]
[heroes]
name="Konrad"
gold=125
fame=10
fullName="Konrad the Heir"
[/heroes]
[heroes]
name="Lisar"
gold=1258
fame=250
fullName="Princess Lisar"
[/heroes]
Arrays all have a special property named '''length'''. It holds the number of blocks in the array.
So here:
$heroes.length -> 3

$unit.modifications.trait.length -> 2
(from the previous ‘unit’ example)

Another way to create arrays is using '''[store_unit]''' and '''[store_locations]''' tags, or
'''[set_variables]''' when using the '''split''' key to split a string.

All these arrays can be modified: we can add later a block or delete it. Deletion is done with
the '''[clear_variable]''' tag:
{CLEAR_VARIABLE heroes[1]}
This will delete the Konrad record. Please note that the array will be renumbered: so the Lisar record will now have the index 1.

Adding blocks can be done with '''[set_variables]''' using the additional key '''mode'''. By default,
'''[set_variables]''' creates a new array (or container), erasing any previous variable with the
same name. But, using one of the different modes allows to add new blocks in various places:

* replace: will clean the array name and replace it with given data, it’s the default.
* append: will append given data to the current array
* merge: will merge in the given data into name
* insert: will insert the given data at the index specified in the name attribute, such as
name=my_array[1].

Note that '''[store_unit]''' has also a '''mode''' key allowing to append more units blocks to an array.

You can place any kind of block in an array, but usually, it’s good practice to avoid meddling
different kind of records (for instance units and locations). The reason is most often, arrays
are fetched and manipulated in loops. Loops are much more easy to program when all records
have the same structure.
The '''FOREACH''' macro is most often used for this purpose. It takes an array name and a
variable name as arguments. The variable will contain an index incremented by one on each
step of the loop by the ending macro '''NEXT'''. For instance, we can summarize the wealth of
our heroes with this code:
{FOREACH heroes index}
[set_variable]
name=tmp
add=$heroes[$index].gold
[/set_variable]
{NEXT index}

[message]
speaker=narrator
message="Team has $tmp gold."
[/message]
Here, we accumulate the gold amount of our heroes in the variable '''tmp'''. The loop will begin
with '''index'''=0 and repeat the code inserted between '''FOREACH''' and '''NEXT''', incrementing the value of index by one and will stop when '''index=heroes.length'''.
'''FOREACH''' is easy to use, but one should be aware of two things:
:- make sure you don’t use the index variable elsewhere: it shall be cleared at the end.
:- when using such a loop to delete some records. For instance this:
{FOREACH heroes index}
[if]
[variable]
name=heroes[$index].name
equals="Konrad"
[/variable]
[then]
{CLEAR_VARIABLE heroes[$index]}
[/then]
[/if]
{NEXT index}
will not work exactly as expected. As we saw earlier, the array will be renumbered when the
“Konrad” record is deleted. So the next record will take the “Konrad” index, and, since index
is incremented at the end of the step, the record following “Konrad” will be skipped. The
correct way to do this is fetching the array in reverse order[[Less easy because there is no macro for that.|5)]] or decrementing the index after the deletion:
{FOREACH heroes index}
[if]
[variable]
name=heroes[$index].name
equals="Konrad"
[/variable]
[then]
{CLEAR_VARIABLE heroes[$index]}
[set_variable]
name=index
sub=1
[set_variable]
[/then]
[/if]
{NEXT index}
=== First steps into darkness ===

==== Using simple strings in names ====
Consider this variable name:
heroes_$index
How to understand this? At execution time, '''$index''' will be replaced with the value of the
variable index[[It would be better if it exists… |6)]]. Suppose it contains 2, the variable used will then be '''heroes_2'''. Of course, it
can be anything else, “Konrad” for instance. Then the variable will be '''heroes_Konrad'''.

Look at these macros:
#define LSB_STOREPERSO ID KILL
[store_unit]
[filter]
id=${ID}
[/filter]
variable=${ID}_back
kill={KILL}
[/store_unit]
#enddef

#define LSB_RECALLPERSO ID XY
[unstore_unit]
variable=${ID}_back
find_vacant=yes
{XY}
[/unstore_unit]
#enddef
They store and retrieve an unit using it’s ID to create the name of the variable. The unit ID is
found in the variable whose name is given in the parameter ID. For instance, it can be '''unit.id''' in a moveto event:
[event]
name=moveto
# ... the filter will come here
{LSB_STOREPERSO unit.id yes} # the unit disappear
# but is stored in a variable named after its id,
# for instance "Konrad_back"
[/event]
The variables created using this code shouldn’t be confused with an array. They’re individual
variables, even if they look more or less the same in the ''':inspect''' display. Particularly, they
can’t be fetched using a '''FOREACH''' loop. But if this is not needed, one can find this better to
create bi-dimensional arrays, particularly because distinct records are easier to identify in the
''':inspect''' display.
In this code, we use quite the same system as above to create a bi-dimensional array to store
boats and units on board. The unit ID (of the boat) is used to create the name of an array
storing the units it contains, whose name is '''RF_$ID''', for example '''RF_B1, RF_B2''' and so on.
So, in a '''moveto''' event of one of these boats, '''RF_$unit.id''' is the name of the array
containing the crew. This code make them pop out.
{FOREACH RF_$unit.id| n}
[unstore_unit]
variable=RF_$unit.id|[$n]
x,y=$rft[0].x,$rft[0].y
find_vacant=yes
[/unstore_unit]
{NEXT n}
Fine, but here, the engine could have a problem: what is exactly RF_$unit.id[$n] ? It can
be :
:- the nth record of the array RF_$unit.id (if unit.id = B1, it would be RF_B1[$n])
:- the simple variable named RF_$unit.id[$n], where the suffix is taken from $unit.id array.
That’s why the pipe character | is appended to the array name. It states the first case is the
good one, or in other words, the array name is delimited between the $ sign and the pipe.

This is one way to create and use bi-dimensional arrays. But it’s possible to create real bi-
dimensional array: they are arrays containing arrays (which could contain arrays as well, and
so on… but will you really need that ?)
Here is the way to do this. We shall use here our “heroes” array, and store it twice into a new
created array:
[set_variables]
name=biDim
[insert_tag]
name=value
variable=heroes
[/insert_tag]
[insert_tag]
name=value
variable=heroes # of course it could be something different
[/insert_tag]
[/set_variables]
'''Insert_tag''' creates a new block whose tag is equal to its '''name''' key, so each '''insert_tag''' will create a block:
[value]
[heroes]
name="Delfador"
gold=250
fame=127
fullName="Delfador the Great"
[/heroes]
[heroes]
name="Konrad"
gold=125
fame=10
fullName="Konrad the Heir"
[/heroes]
[heroes]
name="Lisar"
gold=1258
fame=250
fullName="Princess Lisar"
[/heroes]
[/value]
Still with us? OK, now to access our heroes we shall use the ordinary syntax. For instance:
$biDim[0].heroes[1].name -> Konrad

And of course, one can walk all the array using a nested FOREACH loop.
{FOREACH biDim i}
{FOREACH biDim[$i].heroes index}
[if]
[variable]
name=biDim[$i].heroes[$index].gold
less_than=100
[/variable]
[then]
[set_variable]
name=biDim[$i].heroes[$index].gold
add=100
[/set_variable]
[/then]
[/if]
{NEXT index}
{NEXT i}
This adds some gold to the purse of the poorest heroes of biDim array.

==== Using variables strings in events names ====
This syntax:
[event]
name=$myEvent
...
[/message]
Is perfectly valid. Of course, '''myEvent''' should contain some valid event name, consistent with
the event body. One use of this is to specify turn numbers. For instance:
[event]
name=turn $afterDark
...
[/event]
With this you can set '''afterDark''' in order to state when the event should fire (it must then
contain a number or a string of the form '''side number'''). Even more useful is the way to fire an
event some turn after another occurred. Suppose we want to raise a storm two turns after some
hero visited a particular location. Then we shall write:
[event]
name=moveto
# ... the moveto filter will come here

[event]
name="turn $($turn_number + 2)"

# start the storm
[/event]
[/event]
This will create the nested event and make it fire 2 turns later.
It can be used with '''fire_event''' too. This code sets the variable '''myEvent''' according to the
incomer type, then fires the corresponding event.
[switch]
name=unit.type
[case]
value=Elvish Sorceress
{VARIABLE myEvent storm}
[/case]
[case]
value=Troll Warrior
{VARIABLE myEvent monster}
[/case]
[case]
value=Mermaid Initiate
{VARIABLE myEvent flood}
[/case]
[/switch]

# --- somewhat later…
[fire_event]
name=$myEvent
[/fire_event]

# ... of course, these events should be defined elsewhere
[event]
name=storm
...
[/event]

[event]
name=monster
...
[/event]

[event]
name=flood
...
[/event]

=== Voodoo and black magics ===
« He who enters this place must quit all hopes… »

At this point, maybe you begin to suspect many things can be replaced with variables,
including parts of the code itself. That’s true and interesting in some cases, but it should be
clear that using the features explained later creates code much more difficult to understand
and to debug. You certainly shall discover that much more can be done than what we
describe, but here, we shall restrain ourselves to some limits. Trespassing them is most often
getting caught in mysterious traps, and most often, absolutely useless.
In other words, you’re at risk to fall into deep darkness under heavy bugs attack. So take
care…

==== Existing blocks customization ====
Since we can add members to existing containers, why not add some to documented
containers like units or objects ? It’s perfectly possible, and finally harmless (You’re only are at risk your code become broken if the key name is used in further versions of Wesnoth) [[You can minimize the risk using special key names like 'Pyro_level' instead of only 'level'… or write a feature request! |7)]] . WML just ignores what it knows nothing of. In units blocks, you have a special block named '''variables'''
where you can add safely all what you want, but it’s common to find in campaigns additions
to the '''status''' block. For instance:
{VARIABLE unit.status.isHero yes}
creates a new flag named '''isHero''' in unit status. Of course, the game engine will not display
anything as it does with '''slow''' and '''poison''' status key, but you can use it in filters:
[event]
name=die
first_time_only=no
[filter_condition]
[variable]
name=unit.status.isHero
boolean_equals=yes
[/variable]
[/filter_condition]
…

The same can be done in objects. In this object block, the programmer added two custom
keys, category and price.
[object]
name= _ "Poisonous Bow"
image=items/bow.png
description= _ "This bow deals 20% more damage than other bows, it shots poisonned arrows to enemies and is also quicker."
category=bows
price=150
[effect]
apply_to=new_attack
name=longbow
type=pierce
range=ranged
damage=12
number=4
movement_used=0
icon=attacks/bow-elven-magic.png
[specials]
{WEAPON_SPECIAL_POISON}
[/specials]
[/effect]
[/object]
And when this object is applied to an unit, the extra keys are not deleted or modified in any
way.

==== Passing “parameters” to an event ====
The trick explained here is for use with the '''fire-event''' tag. As you know, this tag allows to
trigger an event (custom or not) from another piece of code. Really useful for instance, when
you don’t want to repeat the same code in many places. As the reference manual says, it can
be used as some sort of subroutine call.
Fine, but in programming languages, subroutines calls accept parameters for use of the
subroutine, and '''fire_event''' don’t.
Suppose we want to display a nice message which can be spoken by various units. Of course,
we can use role or a global variable '''whoSpeaks''' to specify who is speaking. For instance:
[event]
name=nice_speech
[message]
speaker=$whoSpeaks
message=_"Vanish, foul messengers of Sauron…" # and so on…
[/message]
[/event]
We can fire this event with:
{VARIABLE whoSpeaks Gandalf} # or any other character
[fire_event]
name=nice_speech
[/fire_event]
But we would have to clear the whoSpeaks variable later. There is another way. In the
fire_event tag documentation, one can find:
'''[primary_attack]''': Information passed to the primary attack filter and $weapon variable on
the new event.
Of course, we have no attacker and no attack here, but what happens if we set something here
like :
[fire_event]
name=nice_speech
[primary_attack]
whoSpeaks=Gandalf
[/primary_attack]
[/fire_event]

[event]
name=nice_speech
[message]
speaker=$weapon.whoSpeaks
message=_"Vanish, foul messengers of Sauron…" # and so on…
[/message]
[/event]
Well, it pure voodoo but it works. Of course, one can pass anything in the '''primary_attack'''
block, not only a single value. The block itself will be discarded when he event is finished,
just like call parameters in subroutines.

==== Dynamic code with insert_tag ====
We have already seen a use of this tag above. Its effect is to insert at execution time a WML
block contained in a variable. It is like a macro, but macro substitution occurs once when
loading the code which makes a huge difference. With '''insert_tag''', the variable used (i.e. the
code executed) can change during the scenario.
First step is creating a container holding the WML block you want to execute. For instance,
this action:
[harm_unit]
[filter]
x,y=$x1,$y1
[/filter]
amount=10
animate=yes
kill=no
[/harm_unit]
The easiest way is to use a macro to define the block content:

#define BLOCK_CONTENT
[filter]
x,y=$x1,$y1
[/filter]
amount=10
animate=yes
kill=no
#enddef

[set_variables]
name=harmingCode
[value]
{BLOCK_CONTENT}
[/value]
[/set_variables]
Else, we should have to create the variable first, and then add the subtag in this way:
[set_variables]
name=harmingCode
[value]
amount=10
animate=yes
kill=no
[/value]
[/set_variables]

[set_variables]
name=harmingCode.filter
[value]
x,y=$x1,$y1
[/value]
[/set_variables]
Notice, we didn’t include the '''[harm_unit]''' tag. Then we can use '''insert_tag''' in this way:
[insert_tag]
name=harm_unit
variable=harmingCode
[/insert_tag]
This will produce exactly the original block above. Sometimes, it’s not very practical to
define only the block content in the macro (maybe you would like to use it elsewhere, as an
ordinary macro). Then you can specify the '''command''' tag in the '''insert_tag'''. This tag does
nothing except creating blocks. Then it would be:
#define HARM_UNIT
[harm_unit]
[filter]
x,y=$x1,$y1
[/filter]
amount=10
animate=yes
kill=no
[/harm_unit]
#enddef

[set_variables]
name=harmingCode
[value]
{HARM_UNIT}
[/value]
[/set_variables]

# --- somewhere else…

[insert_tag]
name=command
variable=harmingCode
[/insert_tag]
But… this code works not always. The reason is the $x1, $y1. They are replaced with their values when we create the '''harmingCode''' variable, which is not what we generally want. We want to use the values they hold when the '''insert_tag''' is executed (most often, it’s later), in other words, we want to delay their substitution. To mark these variables to be substituted later , we shall add a pipe character just after the dollar sign:
#define HARM_UNIT
[harm_unit]
[filter]
x,y=$|x1,$|y1
[/filter]
amount=10
animate=yes
kill=no
[/harm_unit]
#enddef
Then the code works. And the macro can be used in a normal way too.
Pay heed, '''insert_tag''' must be included in some action (event and so on). It works not at the scenario level for instance.
As you can see, the '''insert_tag''' allows to do many things, but in our opinion, should be used scarcely. Here we shall show how it can be used to solve a common problem. Suppose we want to list the objects of a unit in a option message, let the user choose an object and remove it from the unit. This can be done with this kind of code:
[message]
message="Choose an item to drop"
speaker=narrator
[option]
message="Fabulous speed potion"
[show_if]
# here a conditional expression stating if the unit has
# the fabulous item.
[/show_if]
[command]
# ... drop the item
[/command]
[/option]
# more options blocks...
[/message]
The '''show_if''' tag prevents the line to show if the unit has not the object. There are two problems with this code. First, the condition is not easy to write: the object list of the unit must be searched for that particular object. Next, the message block must have an option for each possible item. No problem if you have only a few, but when, like in some add-ons we shall name not, you have near one hundred…
Here, we shall create dynamically a message block listing all the objects in the modification block of the unit. Thus, we don’t need the '''show_if''' tag et we want something like that:
[message]
message="Choose an item to drop"
speaker=narrator
[option]
message="Fabulous speed potion"
[command]
# ... drop the item
[/command]
[/option]
[option]
message="Amazing flashing bow"
[command]
# ... drop the item
[/command]
[/option]
# ... more options if more objects
[option]
message="Exit"
[command]
# ... exit the loop
[/command]
[/option]
[/message]
So we shall create dynamically this block in a container variable and next use '''insert_tag''' to
execute it. The block itself is embedded in a loop which executes until the exit option is
chosen (this sets the flag '''t_done'''):
# list unit objects
#define LSB_LIST_UNIT_THINGS
{VARIABLE t_done no}

[while]
[variable]
name=t_done
equals=no
[/variable]
[do]
{CLEAR_VARIABLE t_menu}
{VARIABLE t_menu.message " Choose an item to drop:"}
{VARIABLE t_menu.speaker narrator}

# here begins the objects listing. They are in the modifications block of the unit
{FOREACH unit.modifications.object nc}
# creates the option block with the name of the object
[set_variables]
name=t_menu.option
mode=append
[value]
message=$unit.modifications.object[$nc].name
[command]
# remove the object, or anything else
{LSB_CLEAR_UNITOBJECT}
[/command]
[/value]
[/set_variables]
{NEXT nc}

# this adds the “exit” option to the end of the list
{VARIABLE nc $t_menu.option.length}
[set_variables]
name=t_menu.option
mode=append
[value]
message="Exit."
[command]
{VARIABLE t_done yes}
[/command]
[/value]
[/set_variables]

# this finally displays the list on screen and let the user choose
[insert_tag]
name=message
variable=t_menu
[/insert_tag]
[/do]
[/while]
{CLEAR_VARIABLE t_menu,nc}
#enddef

# this is an example of use: in a right-click menu item.
[set_menu_item]
id=LSB_drop
description="Drop items."
[show_if]
[variable]
name=unit.side
equals=1
[/variable]
[/show_if]
[command]
{LSB_LIST_UNIT_THINGS}
[/command]
[/set_menu_item]
Of course, you may want to list not all objects applied to a unit. It’s easy to do that adding a
custom key to the objects you want to list, for instance '''droppable=yes''', and testing if it is
present before creating the option block.

Another example of code managing pickuppable items on the map. We first define those objects using macros. For instance, this one is the core Storm Trident with some additional keys. The '''[object]''' tag is missing in order to use this macro more easily in an '''[insert_tag]'''.
# --- Object definition example, don’t include the [object] tag
#define LSB_STORM_TRIDENT
name="storm trident"
image=items/storm-trident.png
duration=forever
description={RTN_USTR-6}
category=spears
level=2
[effect]
apply_to=new_attack
name="storm trident"
description="storm trident"
icon=attacks/lightning.png
type=fire
range=ranged
[specials]
{WEAPON_SPECIAL_MAGICAL}
[/specials]
damage=15
number=2
[/effect]

{LIGHTNING_ANIMATION "storm trident" 1}
{LIGHTNING_ANIMATION "storm trident" 2}
{LIGHTNING_ANIMATION "storm trident" 3}
#enddef
At the beginning of the scenario or even the campaign, we define an object list containing all pickuppable items. Please note it’s the only place we need to modify when creating or deleting an object in our campaign. All the code needed to manage them is generic.
# --- shortcut to store an object into an array
#define LSB_OBJINFO OBJ
[value]
{OBJ}
[/value]
#enddef

# This is the main objects list which must be created at first start: it creates an array with all pickuppable items and give them an uid.
#define LSB_CREATEOBJECTS_LIST
[set_variables]
name=Objets
mode=replace
{LSB_OBJINFO {RTN_OBJ_TELNECKLACE} }
{LSB_OBJINFO {RTN_OBJ_AELTHRANK} }
{LSB_OBJINFO {LSB_GOLD} }
{LSB_OBJINFO {LSB_STORM_TRIDENT} }
# add more here at will
[/set_variables]

{FOREACH Objets i} # this adds an id to objects
[set_variable]
name=Objets[$i].uid
value=$i
[/set_variable]
{NEXT i}
#enddef
Here a macro to drop objects on the map. Note the NUM parameter is the uid created before, not the full object itself. Of course, it can be a variable holding an uid.
#define LSB_DROP_OBJECT NUM X Y
[item] # place the item on the map
image=$Objets[{NUM}].image
x,y={X},{Y}
[/item]
[set_variables] # add it to the dropped objects list
name=D_Objets
mode=append
[value]
x={X}
y={Y}
code={NUM}
[/value]
[/set_variables]
#enddef
At last, we can set up a moveto event to trigger the pick up dialog
#define LSB_GETOBJECT FILTER ID
[event]
name=moveto
id=GETOBJECT_{ID}
first_time_only=no
[filter]
[filter_location] # fires only if there is something on the map
find_in=D_Objets
[/filter_location]
{FILTER} # and for some units
[/filter]

{VARIABLE i $D_Objets.length}
[while] # maybe we have more than one object here
[variable]
name=i
greater_than=0
[/variable]
[do]
[set_variable]
name=i
sub=1
[/set_variable]

# message
[if]
[variable]
name=D_Objets[$i].x
equals=$x1
[/variable]
[variable]
name=D_Objets[$i].y
equals=$y1
[/variable]
[then]
[message]
speaker=narrator
message=_ "There is a $Objets[$D_Objets[$i].code].name on the ground. Should $unit.name take it ?"
[option]
message=_ "Take it"
[command]
# --- give object to unit
[insert_tag]
name=object
variable=Objets[$D_Objets[$i].code]
[/insert_tag]

# --- clear the map
[remove_item]
image=$Objets[$D_Objets[$i].code].image
x,y=$unit.x,$unit.y
[/remove_item]
{CLEAR_VARIABLE D_Objets[$i]}
[/command]
[/option]
[option]
message= _ "Leave it"
[/option]
[/message]
[/then]
[/if]
[/do]
[/while]
[/event]
#enddef

FilterWML/Examples - How to use Filter

2013-06-17T11:47:07Z

Pyrophorus: /* Using filters in events. */

== WML Filtering ==

Filters are a very important part of WML language, and a fairly complex too for various
reasons. Here, we shall try to explain how to use them with more details than in the reference
wiki pages. But the goal is not to replace these pages, and we assume you have at least some
knowledge of the various WML filters, namely unit and location filters. The examples given
below aren’t always the best way to do things: the goal here is understanding filtering, not to
give a complete WML course.

=== Basics: How filters work. ===

Filtering is narrowing a set of objects to a result set using criteria. Let’s give an example :
given a set of cards, if one is asked to select the spades, (s)he will probably check the cards
one by one and create two stacks : one containing only the spades, and another containing the
unselected cards. This is a very simple filter, where the criterion is « this card has spades
colour » and the result set is a card stack.
The spades cards are said ‘matching’ the filter.
If next we’re asked to find the king of spades, most probably, we will not restart from the
beginning but only scan the spades stack to find the right card. This is an example of two
criteria filter. In WML we would write something like :
[filter]
colour=spades
value=king
[/filter]
to describe the operation. Criteria are expressions evaluating to true or false. Is this card colour
spades ? That’s how we must read the sentence: ‘colour=spades’.
Now, stating both criteria must be met is not the only way to combine them:
[filter]
colour=spades,diamonds
value=king
[/filter]
the first expression will be true if a card colour is ‘spades OR diamonds’. It would make no
sense to state they should be ‘spades AND diamonds’, of course.
In many languages, you must specify how criteria combine using the special keywords ‘OR’
and ‘AND’. In WML, you can do so, but most often, you’re not requested to do so. Writing
explicitly the logical operators would give something like that:
[filter]
[and]
colour=spades
[or]
colour=diamonds
[/or]
[/and]

[and]
value=king
[/and]
[/filter]
or in natural speech: “is card (colour=spades OR colour=diamonds) AND value=king ?” Note
here the use of parenthesis. As in algebra, they mean their content must be evaluated prior to
apply the last criterion.
'''[and]''' and '''[or]''' subtags are WML equivalents of parenthesis. They are not mandatory (like in some other languages), and this is a cool feature, but can be misleading in complex filters.
The rule is:
* listed criteria are ''ANDed'', in other words, they must all be true for the object to match the filter.
* comma separated lists in a criterion are equivalent to ''ORed'' criteria. In other words, one only is enough for the object to match the filter.

'''There are some things important to note:'''

* A complex filter can always be split into simpler filters applied in chain, each filter taking as starting set the result set of the former one. In our example, we applied the filter « value=king » to the result set of filter « color=spades ». This is important when building or debugging filters, because complex ones can easily be reduced to a chain of simpler ones.

* Criteria order is not important from a logical point of view. We could have searched the kings first, obtaining the four kings in our result set, and the card of color spade next. The final result is the same. But in WML, for some reasons we shall study later, order can be important.

* Result sets can contain any number of objects. One can’t assume the result set of our filter will contain a single card ‘THE king of spades’. A human being would probably stop the search when finding a king of spades, but filters don’t. If our starting card packet is not a complete set (some cards were lost, a cheater introduced some more, or anything else), you’ll find one, none or many kings of spades. It’s a common error in WML to assume filters will select a single object.1)
* Any unit or location will match an empty filter like this one:
[event]
name=moveto
[filter]
[/filter]
…
[/event]
This event will be triggered on every move of every unit on the map.

________________________________________

:1) One can be sure only when filtering with ID’s because they are unique.

'''Here now are two versions of the same action, using filters and not.'''
[modify_unit]
[filter]
side=2
[not]
race=orc
[/not]
[/filter]
side=1
[/modify_unit]
This moves to side 1 all side 2 units except orcs. Please note how filter syntax is after all very close to natural speech. This is why we shall see a good way to design complex filters is writing an accurate sentence describing them first.
Using no filter (and assuming ‘all_units’ is an array containing all created units in a scenario) we should write :
{FOREACH all_units i}
[if]
[variable]
name= all_units[$i].side
equals=2
[/variable]
[and]
[variable]
name= all_units[$i].race
not_equals=orc
[/variable]
[/and]
[then]
[set_variable]
name= all_units[$i].side
value=1
[/set_variable]
[unstore_unit]
variable= all_units[$i]
[/unstore_unit]
[/then]
[/if]
{NEXT i}
Of course, the first version is much more concise. One should mark :
* Filters are hidden loops2) fetching all elements of the starting set.
* Criteria composition is more explicit in the second version. We have here an [and] tag which is missing in the first one. It shows clearly both condition must be met. In filters, the [and] tag is most often implicit, as we already seen.
________________________________________

:2) Internally, it’s not always the case, but we’ve not to deal with internal implementations. Conceptually, filters can always be seen as hidden loops.

At this point, a question arises : where are the starting and result sets we talked about? They show nowhere. The reply is most often we don’t need to see them, because we don’t need to create result sets explicitly. We need to use them to specify actions targets or conditions. In the '''‘modify_unit’''' example, we apply the action « change side » to the result set of the filter and then need it no more.
The starting set is implicit too. Most of time, it’s the larger available set of objects : i.e. all created units (sometimes including the recall list) or all hexes in the map. In the '''moveto''' event, it contains only the moving unit.
Once again, we are not telling these sets really exist in Wesnoth engine code. But these are an accurate model of how the filters work in WML.

=== Result sets and arrays. ===

A good way to get explicitly the result set is to use the '''‘store_...’''' tags. These actions create
arrays containing the result set of the filter they take as parameter. This is very useful in many ways. The common use is of course to store units and locations for some processing or later use. But one can use this to split complex filters and inspect intermediate results. The former '''‘modify_unit’''' example could be written as:
[store_unit]
variable=temp1
[filter]
side=2
[/filter]
[/store_unit]

[store_unit]
variable=temp2
[filter]
find_in=temp1
[not]
race=orc
[/not]
[/filter]
[/store_unit]

[modify_unit]
[filter]
find_in=temp2
[/filter]
side=1
[/modify_unit]
This trivial example shows not only how to debug complex filters (inspecting the content of ''temp1'' and ''temp2'' arrays), but how to specify a starting set with the '''‘find_in’''' key. Without it, the second '''‘store_unit’''' tag would store all units except orcs. With it, we ask to apply the filter to the content of ''temp1'' array only (all side 2 units). It’s like our card example where we selected the spades first and next the king(s) in the spades stack.
The '''‘find-in’''' key is really precious in many cases : often it’s easier to build explicitly an array containing the objects we want to select than creating complex filters to retrieve them.
For example, if we want dying units to drop weapons and other units to retrieve them, it can be very difficult to create a filter allowing to select locations where the weapons where dropped. Instead, we can build an array containing their locations (and other informations at will). Since this array have x and y members, the '''find_in''' key of a location filter can use it3). It would be:
# in the die event
[set_variables]
name=weapons
mode=append
[value]
x=$unit.x
y=$unit.y
… anything else, for instance the image name and item id.
[/value]
[/set_variables]

# drop item, etc…

# and in a moveto event
[event]
name=moveto
first_time_only=no
[filter]
side=1
[filter_location]
find_in=weapons
[/filter_location]
[/filter]
…

Let’s give another example.
The scenario’s map features three temples at 10,10 20,20 30,30.
We want to give some bonus gold to side 1 if any side 1 unit visits temple 1,2,3 exactly in that order.
Here is a solution using result sets arrays :
[event]
name=moveto
first_time_only=no
[filter]
side=1
x,y=10,10
[not]
find_in=temple_1
[/not]
[/filter]
[store_unit]
mode=append
variable=temple_1
[filter]
id=$unit.id
[/filter]
[/store_unit]
[/event]
In temple_1, we store all side 1 units visiting temple_1, but only once (that’s why the '''[not] find_in''' tag, because units can visit the temple more than once).

________________________________________

:3) It’s surprising because this array doesn’t contain locations, but it’s a feature, not a side effect.

[event]
name=moveto
first_time_only=no
[filter]
side=1
x,y=20,20
find_in=temple_1
[not]
find_in=temple_2
[/not]
[/filter]
[store_unit]
mode=append
variable=temple_2
[filter]
id=$unit.id
[/filter]
[/store_unit]
[/event]

This time, we store only units previously stored in temple_1 (= they already visited that temple).
Then the last event is obviously :
[event]
name=moveto
first_time_only=yes
[filter]
side=1
x,y=30,30
find_in=temple_2
[/filter]
[gold]
side=1
amount=1000
[/gold]
{CLEAR_VARIABLE temple_1,temple_2}
[/event]

=== Ordering and writing ===

We said earlier that criteria order is not significant. That's right from a theoretical point of view. But, for syntactic reasons and particularly because the radius key in location filters, this is not fully true in WML. Actually conditions are applied to candidate objects until one proves to be false or all conditions are checked. Then, if some condition proves to be false, remaining conditions are not evaluated (so if there's some radius there, it will not be executed). In some cases, this may be important. One can assume conditions are evaluated in the order they are found except logical operators (and, or, not) which are evaluated after other conditions. It’s very important to note that evaluation order of top level conditions (those not embedded in and/or/not tags) is undocumented, which means your code shouldn’t rely on it. On the contrary, and/or/not tags are always executed last, in the order they are written.

So in this example:
[filter]
has_weapon=sword
side=1
[or]
side=2
[/or]
gender=female
[/filter]
will be executed using this order:
[filter]
has_weapon=sword
side=1
gender=female
[or]
side=2
[/or]
[/filter]
One should be aware of this for some reasons:

'''⇒''' Clarity: your code will be easier to understand and to debug if you avoid meddling conditions, nested filters and logical blocks, and write them in the order they are evaluated.

'''⇒''' Performance.
Most of time, performance is not an issue. But it can be if you have a lot of units and use '''[filter_wml]'''. More generally, it’s good programming practice to execute the more restrictive test first.
Consider this example:
[filter]
race=orc
x,y=16,22
[/filter]
The first condition will be evaluated on all units. But the second one will be evaluated on all orcs. Then if we write:
[filter]
x,y=16,22
race=orc
[/filter]
obviously, the second condition will be evaluated once at most, and filtering will be faster. (Strictly speaking, I should have wrapped second condition in an '''and''' tag to force evaluation order).
Remember too that logical operators '''(and, or, not)''' are not mandatory, but are allowed. So one can use them for clarity sake or to force an evaluation order. It’s particularly important when using '''or''' tags.

In the example above one could expect the result set contains all women of sides 1 and 2 wielding a sword. But it contains actually all side 1 women wielding a sword plus all side 2 units.

Filters work actually as if top level criteria were enclosed in an implicit '''and''' tag: so we should read:
[filter]
[and] '''#implicit'''
has_weapon=sword
side=1
gender=female
[/and]
[or]
side=2
[/or]
[/filter]
and what we probably wanted is:
[filter]
has_weapon=sword
gender=female
[and]
side=1
[or]
side=2
[/or]
[/and]
[/filter]
Note that it could be written:
[filter]
[and]
has_weapon=sword
gender=female
[/and]
[and]
side=1
[or]
side=2
[/or]
[/and]
[/filter]
This syntax is correct and you can use it if you find it clearer.
Remembering this implicit '''and''' tag (and writing it explicitly at will) is very important to understand or design complex filters.

=== Writing complex filters. ===

Here are some guidelines one can use when writing complex filters. Suppose we want to set up some kind of disease aura harming units standing close to some villages. We shall start writing a sentence describing the feature.

'''We want to select units who:'''
'''Are enemy to side 1'''
'''stand on hexes which'''
'''are near to'''
'''villages'''
'''with side 1 units standing on it'''
Mark we put only one condition on each line to clearly separate them. Mark we sorted them, because some apply to units to be filtered, others to locations, and finally to other (enemy) units standing on locations. Next, we shall add logical operators and parenthesis to clearly specify what we want:
'''Units, who ('''
'''Are enemy to side 1 AND'''
'''stand on locations which ('''
'''( Are villages AND'''
'''have unit on it who ('''
'''Belongs to side 1'''
''')'''
''') OR'''
'''are adjacent to THOSE villages radius 3'''
''')'''
''')'''
Now, we are ready to start building the filter. Since we want units who… it shall be a unit filter. In the standard unit filter, there’s no condition directly allowing to state the unit is enemy to side 1. So we have to replace this with something valid in the SUF context. Using parenthesis to avoid errors, we can replace the condition with a side filter because it’s valid in unit filters.
'''Units, who ('''
'''(belongs to a side which ('''
'''is enemy to side 1) ) AND'''
'''stand on locations which ('''
'''( Are villages AND'''
'''have unit on it who ('''
'''Belongs to side 1'''
''')'''
''') OR'''
'''are adjacent to THOSE villages radius 3'''
''')'''
''')'''
Now we can write the filter. Here we do it step by step to show how the translation is rather straightforward and how our parenthesis match exactly the subtags.
[filter]
[filter_side]
[enemy_of]
side=1
[/enemy_of]
[/filter_side]
'''AND'''
'''stand on locations which ( # we start to filter locations there'''
'''( Are villages AND'''
'''have unit on it who ('''
'''Belongs to side 1'''
''')'''
''') OR'''
'''are adjacent to THOSE villages radius 3'''
''')'''
[/filter]

[filter]
[filter_side]
[enemy_of]
side=1
[/enemy_of]
[/filter_side]
[and]
[filter_location]
terrain=*^V*
'''AND'''
'''have unit on it who (# to unit filter again'''
'''Belongs to side 1'''
''')'''
radius=3 '''# radius is a special case, see below'''
[/filter_location]
[/and]
[/filter]

[filter]
[filter_side]
[enemy_of]
side=1
[/enemy_of]
[/filter_side]
[and]
[filter_location]
terrain=*^V*
[and]
[filter]
side=1
[/filter]
[/and]
radius=3 '''# radius is a special case, see below'''
[/filter_location]
[/and]
[/filter]
Here, we are done. The filter should work as it is, but it looks rather unusual because all these '''[and]''' blocks. Actually we can delete most of them using a simple rule: '''[and]''' tags are not needed when they contain one single criterion or a single block, (except if you want to set up an evaluation order). In our example, the '''filter_location''' block is alone in its '''and''' tag, and the embedded '''filter''' as well, so we can avoid those '''and''' tags and get finally:
[event]
name=moveto
first_time_only=no
[filter]
[filter_side]
[enemy_of]
side=1
[/enemy_of]
[/filter_side]
[filter_location]
terrain=*^V*
[filter]
side=1
[/filter]
radius=3
[/filter_location]
[/filter]
[harm_unit]
[filter]
id=$unit.id
[/filter]
amount=10
animate=yes
[/harm_unit]
[/event]

=== Filters uses: events actions and conditions. ===

Here, we shall deal with filter uses in WML. The language is not fully consistent, mainly to simplify its syntax, so some points can be misleading.
:'''Using in actions'''
Most actions take a filter as first parameter. The main difficulty here is to know if '''[filter]''' tags must be used or not. Actually, they’re used to avoid confusing keys and criteria when they have the same name4. For instance, the '''[kill]''' action needs a unit filter and has these keys:

* '''animate:''' if 'yes', displays the unit dying (fading away).
* '''fire_event:''' if 'yes', triggers any appropriate 'die' events (See EventWML). Note that events are only fired for killed units that have been on the map (as opposed to recall list).
* '''[secondary_unit]''' with a StandardUnitFilter as argument. Do not use a [filter] tag. Has an effect only if fire_event=yes. The first on-map unit matching the filter.

As we can see, none of these keys and tags are shared with unit filter keys and tags. This means the code parser needs no '''[filter]''' tag to know which key belongs to the filter and which to the action. But in the code, there’s no obvious distinction.

________________________________________

:4) Note there’s no specific top level tag for location filters.

[kill]
animate=yes '''# this belongs to the ‘kill’'''
id=BadGuy_101 '''# this belongs to the unit filter'''
[/kill]
is the correct syntax. Note a common error is to use a '''[filter]''' tag here. Since this tag is unknown in the context, it is ignored, so the kill action is applied to the starting set, i.e. all units (including the recall lists). Same with the '''filter_side''' tag which is not needed everywhere (in '''store_sides''' particularly).
Adversely, '''[modify_unit]''' obviously requires a '''[filter]''' tag, because all keys and criteria have the same name:
[modify_unit]
side=2
side=1
[/modify_unit]

This would make no sense of course because one can’t find if side 1 units must be put into side 2 or the contrary. Anyway, there is an exception: the '''[store_unit]''' tag requires a '''[filter]''' tag even if there is no '''‘variable’''' key in units description. Another special case is when using terrain action, because the key '''terrain''' is valid both in location filters and terrain action. Since there is no special tag to delimit location filters, one should write:
[terrain]
[and]
terrain=Wo* '''# here is the filter criterion'''
[/and]
terrain=Rr '''# and the new terrain'''
[/terrain]
The next example can be confusing:
[kill]'''# kill all units standing on deep water'''
animate=yes
[filter_location]
terrain=Wo
[/filter_location]
[/kill]
When reading the '''‘kill’''' tag documentation, one will not find any '''‘filter_location’''' or location filter entry. Does this means it’s an undocumented feature ? No. But the '''‘filter_location’''' belongs to the implicit '''‘filter’''' tag of the '''‘kill’''' action and is documented there. It’s kind of:
[kill]'''# kill all units standing on deep water'''
animate=yes
'''#'''[filter] '''we’re filtering units here, not locations'''
[filter_location]
terrain=Wo
[/filter_location]
'''#'''[/filter]
[/kill]

=== Using filters in conditions. ===

Filters can be used to create conditional expressions. They can be nested in '''[have_unit]''' or '''[have_location]''' tags or in nested filters. Here, the result set is not used directly, but its size must fall in the range defined by the '''‘count’''' key. This finally gives a Boolean result: true or false. So one can use them in '''[if] [show_if]''' conditional actions or in a '''[filter_condition]''' tag. They are widely used in nested filters too (see the special chapter on this).

Let’s give some examples:

[have_unit] '''# this piece of code evaluates to true when no more enemy leaders are alive'''
canrecruit=yes
[not]
side=1
[/not]
count=0
[/have_unit]

[have_location] '''# this one is true if at least 5 side 1 units stand on a village'''
terrain=*^V*
[filter]
side=1
[/filter]
count=5-1000
[/have_location]
Note we could also write this condition:
[have_unit]
side=1
[filter_location]
terrain=*^V*
[/filter_location]
count=5-1000
[/have_unit]
Note we could use a '''[store_unit]''' instead, testing the ''length'' property of the array:
[store_unit]
variable=temp
[filter]
side=1
[filter_location]
terrain=*^V*
[/filter_location]
[/filter]
[/store_unit]
#[if] or [filter_condition]
[variable]
name=temp.length
greater_than=4
[/variable]

=== Using filters in events. ===
In events, filters are always used in a conditional way, because they state if the event should fire or not. In any event, we can set '''[filter_condition]''' using '''have_unit''' or '''have_location''' (and a more ordinary variable condition, but this is off topic).
Some events use filters in a special way: '''moveto''' and '''attack''' events particularly. In them, the filtering apply not on all units as usual, but only on units involved in the event action: one unit only is moving at a time, two units only are involved in a fight. Then the event fires if and only if the involved unit(s) match the filter.
Note that one can use '''[filter]''' and '''[filter_condition]''' in the same moveto or attack event. Both conditions are then ANDed.

'''Filtering units'''

Criteria allowed to filter units (in standard unit filters) are listed below. First, the keys dealing with the unit properties (as usual, comma separated lists means conditions are ORed):
:'''id:''' ''can be a comma-separated list, every unit with one of these ids matches''
:'''type:''' ''can be a list of types''
:'''race:''' ''(Version 1.11 and later only: this can be a comma-separated list)''
:'''ability:''' ''unit has an ability with the given id (not name !)''
:'''side:''' ''the unit is on the given side (can be a list). One can use a [filter_side] instead''
:'''has_weapon:''' ''the unit has a weapon with the given name''
:'''canrecruit:''' ''yes if the unit can recruit (i.e. is a leader)''
:'''gender:''' ''female if the unit is female rather than the default of male''
:'''role:''' ''the unit has been assigned the given role''
:'''level:''' ''the level of the unit''
:'''defense:''' ''current defense of the unit on current tile''
:'''movement_cost:''' ''current movement cost of the unit on current tile''
:'''x,y:''' ''the position of the unit. (Ranges ? probably because it works in moveto events)''

Not all unit properties are listed here, but they can be used in a '''[filter_wml]''' sub-tag like this:
[filter_wml]
max_moves=7
[/filter_wml]

[filter_wml]
[status]
poisoned=yes
[/status]
[/filter_wml]
Some of them accept comma separated lists or ranges. Some not, but it also possible to use them more than once with '''[and]''' and '''[or]''' subtags. For instance :
[and]
race= elf
[or]
race= merman
[/or]
[/and]
Other sub tags are dealing with unit relationships:
:'''⇒''' The hex on which they stand: '''[filter_location]''' which contains a standard location filter.
:'''⇒''' The units adjacent to it: '''[filter_adjacent]''' which contains another standard unit filter
:'''⇒''' Their visible status relating to a particular side: '''[filter_vision]'''
These are nested filters ; or in other words, filters used to create conditions and not result sets (see earlier and later).

Custom functions returning a boolean:
:'''formula:''' FormulaAI like formula.
:'''lua_function:''' lua function

SUFs accept a '''find_in''' key too. As we saw earlier, this allows to restrict the starting set to the content of an array.

=== this_unit ===

This variable is a special variable defined only inside SUFs. Suppose we want to catch in a filter units at full health. We can use the '''hitpoints''', but the problem is we know not which value to use, because every unit type has its own:
[filter]
side=1
[filter_wml]
hitpoints=?
[/filter_wml]
[/filter]
This is why we could have the use of some way to specify the unit being fetched during the filtering.
[filter]
side=1
[filter_wml]
hitpoints=$this_unit.max_hitpoints
[/filter_wml]
[/filter]
This does the trick. The condition value will be updated according to unit properties before executing the check.

=== Filtering locations ===

'''find_in''': a location array specifying the starting set.

'''time_of_day''': one of lawful, chaotic, neutral or liminal.
'''time_of_day_id''': one or more from: dawn, morning, afternoon, dusk, first_watch, second_watch, indoors, underground and deep_underground.

'''terrain''': comma separated list of terrains.
'''x,y''': the same as in the unit filter; supports any range.
'''owner_side''': If a valid side number, restricts stored locations to villages belonging to this side. If 0, restricts to all unowned locations (the whole map except villages which belong to some valid side). A hex is considered a village if and only if its [ terrain_type ] gives_income= parameter was set to yes (which means a side can own that hex).

'''[filter_adjacent_location]''': a standard location filter; if present the correct number of adjacent locations must match this filter

'''[filter]''' with a Standard Unit Filter as argument; if present a unit must also be there

'''radius''': this is not strictly speaking a criterion. It adds to the result set all hexes adjacent to a matching hex and is always applied last, when all criteria are checked. Remember the filtering process is a hidden loop where all candidates are fetched one by one. If a candidate match the filter, radius adds all adjacent hexes (matching the filter or not !). If it don't, it does nothing.
This is why this example doesn't work:
[filter] '''# this example doesn’t work !'''
side=1
[filter_location]
x,y=43,32
radius=5
[not]
x,y=43,32
[/not]
[/filter_location]
[/filter]
The coder here expected the radius action to be performed just after selecting the 43,32 hex, and the '''[not]''' criterion applied to this hex and it's adjacent radius 5 set. But '''radius''' is always applied last, even if written before some other conditions. So when using '''radius''', a good rule is to create the filter without it at first and to see if it can catch something. Here, it would give:
[filter]
side=1
[filter_location]
x,y=43,32
[not]
x,y=43,32
[/not]
[/filter_location]
[/filter]
which is clearly non sense because the two conditions are mutually exclusive.

The solution is to pack the conditions in two different filters:
[filter]
side=1
[filter_location]
x,y=43,32
radius=5
[/filter_location]
[and]
[filter_location]
[not]
x,y=43,32
[/not]
[/filter_location]
[/and]
[/filter]
or,
[filter]
side=1
[filter_location]
[and]
x,y=43,32
radius=5
[/and]
[not]
x,y=43,32
[/not]
[/filter_location]
[/filter]
or, since the x,y keys are defined in '''[filter]''' too, it can be:
[filter]
side=1
[filter_location]
x,y=43,32
radius=5
[/filter_location]
[not]
x,y=43,32
[/not]
[/filter]
This is why '''[filter_radius]''' is useful. As we said, radius adds hexes without checking any condition (except proximity of course). If we want to put a condition on hexes added with radius (and them only), we would use it as in next example. Here we want to select forested hexes near villages:
[filter_location]
terrain=*^V*
radius=3
[filter_radius]
terrain=*^F*
[/filter_radius]
[/filter_location]
But, this will not work exactly as in our previous example because radius extends outwards from matching locations one step at a time. Only the locations matching the '''filter_radius''' will be selected AND used to compute the next step. If there’s no forest hex near the village, the previous filter will return nothing, even if there are some forest hexes farther in the range.

Note this filter selects the village too ! If we want not, this should be:
[filter_location]
[and]
terrain=*^V*
radius=3
[filter_radius]
terrain=*^F*
[/filter_radius]
[/and]
[not]
terrain=*^V*
[/not]
[/filter_location]

=== Nested filters ===

Now, we are ready to study how to create nested filters, in other words, filters containing sub filters. In location or unit filters, the documentation says one can insert filters of various kind involving other objects. In this way, we can select unit adjacent to other units or standing on some terrains. Actually, they’re not exactly filters: they are conditions or criteria built on filters. In other words, they don’t produce a result set but are, like other criteria, expressions evaluating to true or false. That’s why many of them have additional keys, like '''‘count’''' (see the filter use in conditions).

We shall discuss this on examples.

=== Filter_adjacent. ===

In a unit filter, this allow to create criteria stating which units must be adjacent to the tested unit. In this example, we shall implement an ability named ‘escape’. Units having this ability can teleport elsewhere when surrounded by more than 3 enemies. We shall set a '''moveto''' event to watch the ‘surround’ event.

FilterWML/Examples - How to use Filter

2013-06-17T11:45:52Z

Pyrophorus: /* Using filters in events. */

== WML Filtering ==

Filters are a very important part of WML language, and a fairly complex too for various
reasons. Here, we shall try to explain how to use them with more details than in the reference
wiki pages. But the goal is not to replace these pages, and we assume you have at least some
knowledge of the various WML filters, namely unit and location filters. The examples given
below aren’t always the best way to do things: the goal here is understanding filtering, not to
give a complete WML course.

=== Basics: How filters work. ===

Filtering is narrowing a set of objects to a result set using criteria. Let’s give an example :
given a set of cards, if one is asked to select the spades, (s)he will probably check the cards
one by one and create two stacks : one containing only the spades, and another containing the
unselected cards. This is a very simple filter, where the criterion is « this card has spades
colour » and the result set is a card stack.
The spades cards are said ‘matching’ the filter.
If next we’re asked to find the king of spades, most probably, we will not restart from the
beginning but only scan the spades stack to find the right card. This is an example of two
criteria filter. In WML we would write something like :
[filter]
colour=spades
value=king
[/filter]
to describe the operation. Criteria are expressions evaluating to true or false. Is this card colour
spades ? That’s how we must read the sentence: ‘colour=spades’.
Now, stating both criteria must be met is not the only way to combine them:
[filter]
colour=spades,diamonds
value=king
[/filter]
the first expression will be true if a card colour is ‘spades OR diamonds’. It would make no
sense to state they should be ‘spades AND diamonds’, of course.
In many languages, you must specify how criteria combine using the special keywords ‘OR’
and ‘AND’. In WML, you can do so, but most often, you’re not requested to do so. Writing
explicitly the logical operators would give something like that:
[filter]
[and]
colour=spades
[or]
colour=diamonds
[/or]
[/and]

[and]
value=king
[/and]
[/filter]
or in natural speech: “is card (colour=spades OR colour=diamonds) AND value=king ?” Note
here the use of parenthesis. As in algebra, they mean their content must be evaluated prior to
apply the last criterion.
'''[and]''' and '''[or]''' subtags are WML equivalents of parenthesis. They are not mandatory (like in some other languages), and this is a cool feature, but can be misleading in complex filters.
The rule is:
* listed criteria are ''ANDed'', in other words, they must all be true for the object to match the filter.
* comma separated lists in a criterion are equivalent to ''ORed'' criteria. In other words, one only is enough for the object to match the filter.

'''There are some things important to note:'''

* A complex filter can always be split into simpler filters applied in chain, each filter taking as starting set the result set of the former one. In our example, we applied the filter « value=king » to the result set of filter « color=spades ». This is important when building or debugging filters, because complex ones can easily be reduced to a chain of simpler ones.

* Criteria order is not important from a logical point of view. We could have searched the kings first, obtaining the four kings in our result set, and the card of color spade next. The final result is the same. But in WML, for some reasons we shall study later, order can be important.

* Result sets can contain any number of objects. One can’t assume the result set of our filter will contain a single card ‘THE king of spades’. A human being would probably stop the search when finding a king of spades, but filters don’t. If our starting card packet is not a complete set (some cards were lost, a cheater introduced some more, or anything else), you’ll find one, none or many kings of spades. It’s a common error in WML to assume filters will select a single object.1)
* Any unit or location will match an empty filter like this one:
[event]
name=moveto
[filter]
[/filter]
…
[/event]
This event will be triggered on every move of every unit on the map.

________________________________________

:1) One can be sure only when filtering with ID’s because they are unique.

'''Here now are two versions of the same action, using filters and not.'''
[modify_unit]
[filter]
side=2
[not]
race=orc
[/not]
[/filter]
side=1
[/modify_unit]
This moves to side 1 all side 2 units except orcs. Please note how filter syntax is after all very close to natural speech. This is why we shall see a good way to design complex filters is writing an accurate sentence describing them first.
Using no filter (and assuming ‘all_units’ is an array containing all created units in a scenario) we should write :
{FOREACH all_units i}
[if]
[variable]
name= all_units[$i].side
equals=2
[/variable]
[and]
[variable]
name= all_units[$i].race
not_equals=orc
[/variable]
[/and]
[then]
[set_variable]
name= all_units[$i].side
value=1
[/set_variable]
[unstore_unit]
variable= all_units[$i]
[/unstore_unit]
[/then]
[/if]
{NEXT i}
Of course, the first version is much more concise. One should mark :
* Filters are hidden loops2) fetching all elements of the starting set.
* Criteria composition is more explicit in the second version. We have here an [and] tag which is missing in the first one. It shows clearly both condition must be met. In filters, the [and] tag is most often implicit, as we already seen.
________________________________________

:2) Internally, it’s not always the case, but we’ve not to deal with internal implementations. Conceptually, filters can always be seen as hidden loops.

At this point, a question arises : where are the starting and result sets we talked about? They show nowhere. The reply is most often we don’t need to see them, because we don’t need to create result sets explicitly. We need to use them to specify actions targets or conditions. In the '''‘modify_unit’''' example, we apply the action « change side » to the result set of the filter and then need it no more.
The starting set is implicit too. Most of time, it’s the larger available set of objects : i.e. all created units (sometimes including the recall list) or all hexes in the map. In the '''moveto''' event, it contains only the moving unit.
Once again, we are not telling these sets really exist in Wesnoth engine code. But these are an accurate model of how the filters work in WML.

=== Result sets and arrays. ===

A good way to get explicitly the result set is to use the '''‘store_...’''' tags. These actions create
arrays containing the result set of the filter they take as parameter. This is very useful in many ways. The common use is of course to store units and locations for some processing or later use. But one can use this to split complex filters and inspect intermediate results. The former '''‘modify_unit’''' example could be written as:
[store_unit]
variable=temp1
[filter]
side=2
[/filter]
[/store_unit]

[store_unit]
variable=temp2
[filter]
find_in=temp1
[not]
race=orc
[/not]
[/filter]
[/store_unit]

[modify_unit]
[filter]
find_in=temp2
[/filter]
side=1
[/modify_unit]
This trivial example shows not only how to debug complex filters (inspecting the content of ''temp1'' and ''temp2'' arrays), but how to specify a starting set with the '''‘find_in’''' key. Without it, the second '''‘store_unit’''' tag would store all units except orcs. With it, we ask to apply the filter to the content of ''temp1'' array only (all side 2 units). It’s like our card example where we selected the spades first and next the king(s) in the spades stack.
The '''‘find-in’''' key is really precious in many cases : often it’s easier to build explicitly an array containing the objects we want to select than creating complex filters to retrieve them.
For example, if we want dying units to drop weapons and other units to retrieve them, it can be very difficult to create a filter allowing to select locations where the weapons where dropped. Instead, we can build an array containing their locations (and other informations at will). Since this array have x and y members, the '''find_in''' key of a location filter can use it3). It would be:
# in the die event
[set_variables]
name=weapons
mode=append
[value]
x=$unit.x
y=$unit.y
… anything else, for instance the image name and item id.
[/value]
[/set_variables]

# drop item, etc…

# and in a moveto event
[event]
name=moveto
first_time_only=no
[filter]
side=1
[filter_location]
find_in=weapons
[/filter_location]
[/filter]
…

Let’s give another example.
The scenario’s map features three temples at 10,10 20,20 30,30.
We want to give some bonus gold to side 1 if any side 1 unit visits temple 1,2,3 exactly in that order.
Here is a solution using result sets arrays :
[event]
name=moveto
first_time_only=no
[filter]
side=1
x,y=10,10
[not]
find_in=temple_1
[/not]
[/filter]
[store_unit]
mode=append
variable=temple_1
[filter]
id=$unit.id
[/filter]
[/store_unit]
[/event]
In temple_1, we store all side 1 units visiting temple_1, but only once (that’s why the '''[not] find_in''' tag, because units can visit the temple more than once).

________________________________________

:3) It’s surprising because this array doesn’t contain locations, but it’s a feature, not a side effect.

[event]
name=moveto
first_time_only=no
[filter]
side=1
x,y=20,20
find_in=temple_1
[not]
find_in=temple_2
[/not]
[/filter]
[store_unit]
mode=append
variable=temple_2
[filter]
id=$unit.id
[/filter]
[/store_unit]
[/event]

This time, we store only units previously stored in temple_1 (= they already visited that temple).
Then the last event is obviously :
[event]
name=moveto
first_time_only=yes
[filter]
side=1
x,y=30,30
find_in=temple_2
[/filter]
[gold]
side=1
amount=1000
[/gold]
{CLEAR_VARIABLE temple_1,temple_2}
[/event]

=== Ordering and writing ===

We said earlier that criteria order is not significant. That's right from a theoretical point of view. But, for syntactic reasons and particularly because the radius key in location filters, this is not fully true in WML. Actually conditions are applied to candidate objects until one proves to be false or all conditions are checked. Then, if some condition proves to be false, remaining conditions are not evaluated (so if there's some radius there, it will not be executed). In some cases, this may be important. One can assume conditions are evaluated in the order they are found except logical operators (and, or, not) which are evaluated after other conditions. It’s very important to note that evaluation order of top level conditions (those not embedded in and/or/not tags) is undocumented, which means your code shouldn’t rely on it. On the contrary, and/or/not tags are always executed last, in the order they are written.

So in this example:
[filter]
has_weapon=sword
side=1
[or]
side=2
[/or]
gender=female
[/filter]
will be executed using this order:
[filter]
has_weapon=sword
side=1
gender=female
[or]
side=2
[/or]
[/filter]
One should be aware of this for some reasons:

'''⇒''' Clarity: your code will be easier to understand and to debug if you avoid meddling conditions, nested filters and logical blocks, and write them in the order they are evaluated.

'''⇒''' Performance.
Most of time, performance is not an issue. But it can be if you have a lot of units and use '''[filter_wml]'''. More generally, it’s good programming practice to execute the more restrictive test first.
Consider this example:
[filter]
race=orc
x,y=16,22
[/filter]
The first condition will be evaluated on all units. But the second one will be evaluated on all orcs. Then if we write:
[filter]
x,y=16,22
race=orc
[/filter]
obviously, the second condition will be evaluated once at most, and filtering will be faster. (Strictly speaking, I should have wrapped second condition in an '''and''' tag to force evaluation order).
Remember too that logical operators '''(and, or, not)''' are not mandatory, but are allowed. So one can use them for clarity sake or to force an evaluation order. It’s particularly important when using '''or''' tags.

In the example above one could expect the result set contains all women of sides 1 and 2 wielding a sword. But it contains actually all side 1 women wielding a sword plus all side 2 units.

Filters work actually as if top level criteria were enclosed in an implicit '''and''' tag: so we should read:
[filter]
[and] '''#implicit'''
has_weapon=sword
side=1
gender=female
[/and]
[or]
side=2
[/or]
[/filter]
and what we probably wanted is:
[filter]
has_weapon=sword
gender=female
[and]
side=1
[or]
side=2
[/or]
[/and]
[/filter]
Note that it could be written:
[filter]
[and]
has_weapon=sword
gender=female
[/and]
[and]
side=1
[or]
side=2
[/or]
[/and]
[/filter]
This syntax is correct and you can use it if you find it clearer.
Remembering this implicit '''and''' tag (and writing it explicitly at will) is very important to understand or design complex filters.

=== Writing complex filters. ===

Here are some guidelines one can use when writing complex filters. Suppose we want to set up some kind of disease aura harming units standing close to some villages. We shall start writing a sentence describing the feature.

'''We want to select units who:'''
'''Are enemy to side 1'''
'''stand on hexes which'''
'''are near to'''
'''villages'''
'''with side 1 units standing on it'''
Mark we put only one condition on each line to clearly separate them. Mark we sorted them, because some apply to units to be filtered, others to locations, and finally to other (enemy) units standing on locations. Next, we shall add logical operators and parenthesis to clearly specify what we want:
'''Units, who ('''
'''Are enemy to side 1 AND'''
'''stand on locations which ('''
'''( Are villages AND'''
'''have unit on it who ('''
'''Belongs to side 1'''
''')'''
''') OR'''
'''are adjacent to THOSE villages radius 3'''
''')'''
''')'''
Now, we are ready to start building the filter. Since we want units who… it shall be a unit filter. In the standard unit filter, there’s no condition directly allowing to state the unit is enemy to side 1. So we have to replace this with something valid in the SUF context. Using parenthesis to avoid errors, we can replace the condition with a side filter because it’s valid in unit filters.
'''Units, who ('''
'''(belongs to a side which ('''
'''is enemy to side 1) ) AND'''
'''stand on locations which ('''
'''( Are villages AND'''
'''have unit on it who ('''
'''Belongs to side 1'''
''')'''
''') OR'''
'''are adjacent to THOSE villages radius 3'''
''')'''
''')'''
Now we can write the filter. Here we do it step by step to show how the translation is rather straightforward and how our parenthesis match exactly the subtags.
[filter]
[filter_side]
[enemy_of]
side=1
[/enemy_of]
[/filter_side]
'''AND'''
'''stand on locations which ( # we start to filter locations there'''
'''( Are villages AND'''
'''have unit on it who ('''
'''Belongs to side 1'''
''')'''
''') OR'''
'''are adjacent to THOSE villages radius 3'''
''')'''
[/filter]

[filter]
[filter_side]
[enemy_of]
side=1
[/enemy_of]
[/filter_side]
[and]
[filter_location]
terrain=*^V*
'''AND'''
'''have unit on it who (# to unit filter again'''
'''Belongs to side 1'''
''')'''
radius=3 '''# radius is a special case, see below'''
[/filter_location]
[/and]
[/filter]

[filter]
[filter_side]
[enemy_of]
side=1
[/enemy_of]
[/filter_side]
[and]
[filter_location]
terrain=*^V*
[and]
[filter]
side=1
[/filter]
[/and]
radius=3 '''# radius is a special case, see below'''
[/filter_location]
[/and]
[/filter]
Here, we are done. The filter should work as it is, but it looks rather unusual because all these '''[and]''' blocks. Actually we can delete most of them using a simple rule: '''[and]''' tags are not needed when they contain one single criterion or a single block, (except if you want to set up an evaluation order). In our example, the '''filter_location''' block is alone in its '''and''' tag, and the embedded '''filter''' as well, so we can avoid those '''and''' tags and get finally:
[event]
name=moveto
first_time_only=no
[filter]
[filter_side]
[enemy_of]
side=1
[/enemy_of]
[/filter_side]
[filter_location]
terrain=*^V*
[filter]
side=1
[/filter]
radius=3
[/filter_location]
[/filter]
[harm_unit]
[filter]
id=$unit.id
[/filter]
amount=10
animate=yes
[/harm_unit]
[/event]

=== Filters uses: events actions and conditions. ===

Here, we shall deal with filter uses in WML. The language is not fully consistent, mainly to simplify its syntax, so some points can be misleading.
:'''Using in actions'''
Most actions take a filter as first parameter. The main difficulty here is to know if '''[filter]''' tags must be used or not. Actually, they’re used to avoid confusing keys and criteria when they have the same name4. For instance, the '''[kill]''' action needs a unit filter and has these keys:

* '''animate:''' if 'yes', displays the unit dying (fading away).
* '''fire_event:''' if 'yes', triggers any appropriate 'die' events (See EventWML). Note that events are only fired for killed units that have been on the map (as opposed to recall list).
* '''[secondary_unit]''' with a StandardUnitFilter as argument. Do not use a [filter] tag. Has an effect only if fire_event=yes. The first on-map unit matching the filter.

As we can see, none of these keys and tags are shared with unit filter keys and tags. This means the code parser needs no '''[filter]''' tag to know which key belongs to the filter and which to the action. But in the code, there’s no obvious distinction.

________________________________________

:4) Note there’s no specific top level tag for location filters.

[kill]
animate=yes '''# this belongs to the ‘kill’'''
id=BadGuy_101 '''# this belongs to the unit filter'''
[/kill]
is the correct syntax. Note a common error is to use a '''[filter]''' tag here. Since this tag is unknown in the context, it is ignored, so the kill action is applied to the starting set, i.e. all units (including the recall lists). Same with the '''filter_side''' tag which is not needed everywhere (in '''store_sides''' particularly).
Adversely, '''[modify_unit]''' obviously requires a '''[filter]''' tag, because all keys and criteria have the same name:
[modify_unit]
side=2
side=1
[/modify_unit]

This would make no sense of course because one can’t find if side 1 units must be put into side 2 or the contrary. Anyway, there is an exception: the '''[store_unit]''' tag requires a '''[filter]''' tag even if there is no '''‘variable’''' key in units description. Another special case is when using terrain action, because the key '''terrain''' is valid both in location filters and terrain action. Since there is no special tag to delimit location filters, one should write:
[terrain]
[and]
terrain=Wo* '''# here is the filter criterion'''
[/and]
terrain=Rr '''# and the new terrain'''
[/terrain]
The next example can be confusing:
[kill]'''# kill all units standing on deep water'''
animate=yes
[filter_location]
terrain=Wo
[/filter_location]
[/kill]
When reading the '''‘kill’''' tag documentation, one will not find any '''‘filter_location’''' or location filter entry. Does this means it’s an undocumented feature ? No. But the '''‘filter_location’''' belongs to the implicit '''‘filter’''' tag of the '''‘kill’''' action and is documented there. It’s kind of:
[kill]'''# kill all units standing on deep water'''
animate=yes
'''#'''[filter] '''we’re filtering units here, not locations'''
[filter_location]
terrain=Wo
[/filter_location]
'''#'''[/filter]
[/kill]

=== Using filters in conditions. ===

Filters can be used to create conditional expressions. They can be nested in '''[have_unit]''' or '''[have_location]''' tags or in nested filters. Here, the result set is not used directly, but its size must fall in the range defined by the '''‘count’''' key. This finally gives a Boolean result: true or false. So one can use them in '''[if] [show_if]''' conditional actions or in a '''[filter_condition]''' tag. They are widely used in nested filters too (see the special chapter on this).

Let’s give some examples:

[have_unit] '''# this piece of code evaluates to true when no more enemy leaders are alive'''
canrecruit=yes
[not]
side=1
[/not]
count=0
[/have_unit]

[have_location] '''# this one is true if at least 5 side 1 units stand on a village'''
terrain=*^V*
[filter]
side=1
[/filter]
count=5-1000
[/have_location]
Note we could also write this condition:
[have_unit]
side=1
[filter_location]
terrain=*^V*
[/filter_location]
count=5-1000
[/have_unit]
Note we could use a '''[store_unit]''' instead, testing the ''length'' property of the array:
[store_unit]
variable=temp
[filter]
side=1
[filter_location]
terrain=*^V*
[/filter_location]
[/filter]
[/store_unit]
#[if] or [filter_condition]
[variable]
name=temp.length
greater_than=4
[/variable]

=== Using filters in events. ===
In events, filters are always used in a conditional way, because they state if the event should fire or not. In any event, we can set '''[filter_condition]''' using '''have_unit''' or '''have_location''' (and a more ordinary variable condition, but this is off topic).
Some events use filters in a special way: '''moveto''' and '''attack''' events particularly. In them, the filtering apply not on all units as usual, but only on units involved in the event action: one unit only is moving at a time, two units only are involved in a fight. Then the event fires if and only if the involved unit(s) match the filter.
Note that one can use '''[filter]''' and '''[filter_condition]''' in the same moveto or attack event. Both conditions are then ANDed.

'''Filtering units'''

Criteria allowed to filter units (in standard unit filters) are listed below. First, the keys dealing with the unit properties (as usual, comma separated lists means conditions are ORed):
:'''id:''' ''can be a comma-separated list, every unit with one of these ids matches''
:'''type:''' ''can be a list of types''
:'''race:''' ''(Version 1.11 and later only: this can be a comma-separated list)''
:'''ability:''' ''unit has an ability with the given id (not name !)''
:'''side:''' ''the unit is on the given side (can be a list). One can use a [filter_side] instead''
:'''has_weapon:''' ''the unit has a weapon with the given name''
:'''canrecruit:''' ''yes if the unit can recruit (i.e. is a leader)''
:'''gender:''' ''female if the unit is female rather than the default of male''
:'''role:''' ''the unit has been assigned the given role''
:'''level:''' ''the level of the unit''
:'''defense:''' ''current defense of the unit on current tile''
:'''movement_cost:''' ''current movement cost of the unit on current tile''
:'''x,y:''' ''the position of the unit. (Ranges ? probably because it works in moveto events)''

Not all unit properties are listed here, but they can be used in a '''[filter_wml]''' sub-tag like this:
[filter_wml]
max_moves=7
[/filter_wml]

[filter_wml]
[status]
poisoned=yes
[/status]
[/filter_wml]
Some of them accept comma separated lists or ranges. Some not, but it also possible to use them more than once with '''[and]''' and '''[or]''' subtags. For instance :
[and]
race= elf
[or]
race= merman
[/or]
[/and]
Other sub tags are dealing with unit relationships:
:'''⇒''' The hex on which they stand: '''[filter_location]''' which contains a standard location filter.
:'''⇒''' The units adjacent to it: '''[filter_adjacent]''' which contains another standard unit filter
:'''⇒''' Their visible status relating to a particular side: '''[filter_vision]'''
These are nested filters ; or in other words, filters used to create conditions and not result sets (see earlier and later).

Custom functions returning a boolean:
'''formula:''' FormulaAI like formula.
'''lua_function:''' lua function

SUFs accept a '''find_in''' key too. As we saw earlier, this allows to restrict the starting set to the content of an array.

=== this_unit ===

This variable is a special variable defined only inside SUFs. Suppose we want to catch in a filter units at full health. We can use the '''hitpoints''', but the problem is we know not which value to use, because every unit type has its own:
[filter]
side=1
[filter_wml]
hitpoints=?
[/filter_wml]
[/filter]
This is why we could have the use of some way to specify the unit being fetched during the filtering.
[filter]
side=1
[filter_wml]
hitpoints=$this_unit.max_hitpoints
[/filter_wml]
[/filter]
This does the trick. The condition value will be updated according to unit properties before executing the check.

=== Filtering locations ===

'''find_in''': a location array specifying the starting set.

'''time_of_day''': one of lawful, chaotic, neutral or liminal.
'''time_of_day_id''': one or more from: dawn, morning, afternoon, dusk, first_watch, second_watch, indoors, underground and deep_underground.

'''terrain''': comma separated list of terrains.
'''x,y''': the same as in the unit filter; supports any range.
'''owner_side''': If a valid side number, restricts stored locations to villages belonging to this side. If 0, restricts to all unowned locations (the whole map except villages which belong to some valid side). A hex is considered a village if and only if its [ terrain_type ] gives_income= parameter was set to yes (which means a side can own that hex).

'''[filter_adjacent_location]''': a standard location filter; if present the correct number of adjacent locations must match this filter

'''[filter]''' with a Standard Unit Filter as argument; if present a unit must also be there

'''radius''': this is not strictly speaking a criterion. It adds to the result set all hexes adjacent to a matching hex and is always applied last, when all criteria are checked. Remember the filtering process is a hidden loop where all candidates are fetched one by one. If a candidate match the filter, radius adds all adjacent hexes (matching the filter or not !). If it don't, it does nothing.
This is why this example doesn't work:
[filter] '''# this example doesn’t work !'''
side=1
[filter_location]
x,y=43,32
radius=5
[not]
x,y=43,32
[/not]
[/filter_location]
[/filter]
The coder here expected the radius action to be performed just after selecting the 43,32 hex, and the '''[not]''' criterion applied to this hex and it's adjacent radius 5 set. But '''radius''' is always applied last, even if written before some other conditions. So when using '''radius''', a good rule is to create the filter without it at first and to see if it can catch something. Here, it would give:
[filter]
side=1
[filter_location]
x,y=43,32
[not]
x,y=43,32
[/not]
[/filter_location]
[/filter]
which is clearly non sense because the two conditions are mutually exclusive.

The solution is to pack the conditions in two different filters:
[filter]
side=1
[filter_location]
x,y=43,32
radius=5
[/filter_location]
[and]
[filter_location]
[not]
x,y=43,32
[/not]
[/filter_location]
[/and]
[/filter]
or,
[filter]
side=1
[filter_location]
[and]
x,y=43,32
radius=5
[/and]
[not]
x,y=43,32
[/not]
[/filter_location]
[/filter]
or, since the x,y keys are defined in '''[filter]''' too, it can be:
[filter]
side=1
[filter_location]
x,y=43,32
radius=5
[/filter_location]
[not]
x,y=43,32
[/not]
[/filter]
This is why '''[filter_radius]''' is useful. As we said, radius adds hexes without checking any condition (except proximity of course). If we want to put a condition on hexes added with radius (and them only), we would use it as in next example. Here we want to select forested hexes near villages:
[filter_location]
terrain=*^V*
radius=3
[filter_radius]
terrain=*^F*
[/filter_radius]
[/filter_location]
But, this will not work exactly as in our previous example because radius extends outwards from matching locations one step at a time. Only the locations matching the '''filter_radius''' will be selected AND used to compute the next step. If there’s no forest hex near the village, the previous filter will return nothing, even if there are some forest hexes farther in the range.

Note this filter selects the village too ! If we want not, this should be:
[filter_location]
[and]
terrain=*^V*
radius=3
[filter_radius]
terrain=*^F*
[/filter_radius]
[/and]
[not]
terrain=*^V*
[/not]
[/filter_location]

=== Nested filters ===

Now, we are ready to study how to create nested filters, in other words, filters containing sub filters. In location or unit filters, the documentation says one can insert filters of various kind involving other objects. In this way, we can select unit adjacent to other units or standing on some terrains. Actually, they’re not exactly filters: they are conditions or criteria built on filters. In other words, they don’t produce a result set but are, like other criteria, expressions evaluating to true or false. That’s why many of them have additional keys, like '''‘count’''' (see the filter use in conditions).

We shall discuss this on examples.

=== Filter_adjacent. ===

In a unit filter, this allow to create criteria stating which units must be adjacent to the tested unit. In this example, we shall implement an ability named ‘escape’. Units having this ability can teleport elsewhere when surrounded by more than 3 enemies. We shall set a '''moveto''' event to watch the ‘surround’ event.

FilterWML/Examples - How to use Filter

2013-06-17T11:40:30Z

Pyrophorus: /* Filters uses: events actions and conditions. */

== WML Filtering ==

Filters are a very important part of WML language, and a fairly complex too for various
reasons. Here, we shall try to explain how to use them with more details than in the reference
wiki pages. But the goal is not to replace these pages, and we assume you have at least some
knowledge of the various WML filters, namely unit and location filters. The examples given
below aren’t always the best way to do things: the goal here is understanding filtering, not to
give a complete WML course.

=== Basics: How filters work. ===

Filtering is narrowing a set of objects to a result set using criteria. Let’s give an example :
given a set of cards, if one is asked to select the spades, (s)he will probably check the cards
one by one and create two stacks : one containing only the spades, and another containing the
unselected cards. This is a very simple filter, where the criterion is « this card has spades
colour » and the result set is a card stack.
The spades cards are said ‘matching’ the filter.
If next we’re asked to find the king of spades, most probably, we will not restart from the
beginning but only scan the spades stack to find the right card. This is an example of two
criteria filter. In WML we would write something like :
[filter]
colour=spades
value=king
[/filter]
to describe the operation. Criteria are expressions evaluating to true or false. Is this card colour
spades ? That’s how we must read the sentence: ‘colour=spades’.
Now, stating both criteria must be met is not the only way to combine them:
[filter]
colour=spades,diamonds
value=king
[/filter]
the first expression will be true if a card colour is ‘spades OR diamonds’. It would make no
sense to state they should be ‘spades AND diamonds’, of course.
In many languages, you must specify how criteria combine using the special keywords ‘OR’
and ‘AND’. In WML, you can do so, but most often, you’re not requested to do so. Writing
explicitly the logical operators would give something like that:
[filter]
[and]
colour=spades
[or]
colour=diamonds
[/or]
[/and]

[and]
value=king
[/and]
[/filter]
or in natural speech: “is card (colour=spades OR colour=diamonds) AND value=king ?” Note
here the use of parenthesis. As in algebra, they mean their content must be evaluated prior to
apply the last criterion.
'''[and]''' and '''[or]''' subtags are WML equivalents of parenthesis. They are not mandatory (like in some other languages), and this is a cool feature, but can be misleading in complex filters.
The rule is:
* listed criteria are ''ANDed'', in other words, they must all be true for the object to match the filter.
* comma separated lists in a criterion are equivalent to ''ORed'' criteria. In other words, one only is enough for the object to match the filter.

'''There are some things important to note:'''

* A complex filter can always be split into simpler filters applied in chain, each filter taking as starting set the result set of the former one. In our example, we applied the filter « value=king » to the result set of filter « color=spades ». This is important when building or debugging filters, because complex ones can easily be reduced to a chain of simpler ones.

* Criteria order is not important from a logical point of view. We could have searched the kings first, obtaining the four kings in our result set, and the card of color spade next. The final result is the same. But in WML, for some reasons we shall study later, order can be important.

* Result sets can contain any number of objects. One can’t assume the result set of our filter will contain a single card ‘THE king of spades’. A human being would probably stop the search when finding a king of spades, but filters don’t. If our starting card packet is not a complete set (some cards were lost, a cheater introduced some more, or anything else), you’ll find one, none or many kings of spades. It’s a common error in WML to assume filters will select a single object.1)
* Any unit or location will match an empty filter like this one:
[event]
name=moveto
[filter]
[/filter]
…
[/event]
This event will be triggered on every move of every unit on the map.

________________________________________

:1) One can be sure only when filtering with ID’s because they are unique.

'''Here now are two versions of the same action, using filters and not.'''
[modify_unit]
[filter]
side=2
[not]
race=orc
[/not]
[/filter]
side=1
[/modify_unit]
This moves to side 1 all side 2 units except orcs. Please note how filter syntax is after all very close to natural speech. This is why we shall see a good way to design complex filters is writing an accurate sentence describing them first.
Using no filter (and assuming ‘all_units’ is an array containing all created units in a scenario) we should write :
{FOREACH all_units i}
[if]
[variable]
name= all_units[$i].side
equals=2
[/variable]
[and]
[variable]
name= all_units[$i].race
not_equals=orc
[/variable]
[/and]
[then]
[set_variable]
name= all_units[$i].side
value=1
[/set_variable]
[unstore_unit]
variable= all_units[$i]
[/unstore_unit]
[/then]
[/if]
{NEXT i}
Of course, the first version is much more concise. One should mark :
* Filters are hidden loops2) fetching all elements of the starting set.
* Criteria composition is more explicit in the second version. We have here an [and] tag which is missing in the first one. It shows clearly both condition must be met. In filters, the [and] tag is most often implicit, as we already seen.
________________________________________

:2) Internally, it’s not always the case, but we’ve not to deal with internal implementations. Conceptually, filters can always be seen as hidden loops.

At this point, a question arises : where are the starting and result sets we talked about? They show nowhere. The reply is most often we don’t need to see them, because we don’t need to create result sets explicitly. We need to use them to specify actions targets or conditions. In the '''‘modify_unit’''' example, we apply the action « change side » to the result set of the filter and then need it no more.
The starting set is implicit too. Most of time, it’s the larger available set of objects : i.e. all created units (sometimes including the recall list) or all hexes in the map. In the '''moveto''' event, it contains only the moving unit.
Once again, we are not telling these sets really exist in Wesnoth engine code. But these are an accurate model of how the filters work in WML.

=== Result sets and arrays. ===

A good way to get explicitly the result set is to use the '''‘store_...’''' tags. These actions create
arrays containing the result set of the filter they take as parameter. This is very useful in many ways. The common use is of course to store units and locations for some processing or later use. But one can use this to split complex filters and inspect intermediate results. The former '''‘modify_unit’''' example could be written as:
[store_unit]
variable=temp1
[filter]
side=2
[/filter]
[/store_unit]

[store_unit]
variable=temp2
[filter]
find_in=temp1
[not]
race=orc
[/not]
[/filter]
[/store_unit]

[modify_unit]
[filter]
find_in=temp2
[/filter]
side=1
[/modify_unit]
This trivial example shows not only how to debug complex filters (inspecting the content of ''temp1'' and ''temp2'' arrays), but how to specify a starting set with the '''‘find_in’''' key. Without it, the second '''‘store_unit’''' tag would store all units except orcs. With it, we ask to apply the filter to the content of ''temp1'' array only (all side 2 units). It’s like our card example where we selected the spades first and next the king(s) in the spades stack.
The '''‘find-in’''' key is really precious in many cases : often it’s easier to build explicitly an array containing the objects we want to select than creating complex filters to retrieve them.
For example, if we want dying units to drop weapons and other units to retrieve them, it can be very difficult to create a filter allowing to select locations where the weapons where dropped. Instead, we can build an array containing their locations (and other informations at will). Since this array have x and y members, the '''find_in''' key of a location filter can use it3). It would be:
# in the die event
[set_variables]
name=weapons
mode=append
[value]
x=$unit.x
y=$unit.y
… anything else, for instance the image name and item id.
[/value]
[/set_variables]

# drop item, etc…

# and in a moveto event
[event]
name=moveto
first_time_only=no
[filter]
side=1
[filter_location]
find_in=weapons
[/filter_location]
[/filter]
…

Let’s give another example.
The scenario’s map features three temples at 10,10 20,20 30,30.
We want to give some bonus gold to side 1 if any side 1 unit visits temple 1,2,3 exactly in that order.
Here is a solution using result sets arrays :
[event]
name=moveto
first_time_only=no
[filter]
side=1
x,y=10,10
[not]
find_in=temple_1
[/not]
[/filter]
[store_unit]
mode=append
variable=temple_1
[filter]
id=$unit.id
[/filter]
[/store_unit]
[/event]
In temple_1, we store all side 1 units visiting temple_1, but only once (that’s why the '''[not] find_in''' tag, because units can visit the temple more than once).

________________________________________

:3) It’s surprising because this array doesn’t contain locations, but it’s a feature, not a side effect.

[event]
name=moveto
first_time_only=no
[filter]
side=1
x,y=20,20
find_in=temple_1
[not]
find_in=temple_2
[/not]
[/filter]
[store_unit]
mode=append
variable=temple_2
[filter]
id=$unit.id
[/filter]
[/store_unit]
[/event]

This time, we store only units previously stored in temple_1 (= they already visited that temple).
Then the last event is obviously :
[event]
name=moveto
first_time_only=yes
[filter]
side=1
x,y=30,30
find_in=temple_2
[/filter]
[gold]
side=1
amount=1000
[/gold]
{CLEAR_VARIABLE temple_1,temple_2}
[/event]

=== Ordering and writing ===

We said earlier that criteria order is not significant. That's right from a theoretical point of view. But, for syntactic reasons and particularly because the radius key in location filters, this is not fully true in WML. Actually conditions are applied to candidate objects until one proves to be false or all conditions are checked. Then, if some condition proves to be false, remaining conditions are not evaluated (so if there's some radius there, it will not be executed). In some cases, this may be important. One can assume conditions are evaluated in the order they are found except logical operators (and, or, not) which are evaluated after other conditions. It’s very important to note that evaluation order of top level conditions (those not embedded in and/or/not tags) is undocumented, which means your code shouldn’t rely on it. On the contrary, and/or/not tags are always executed last, in the order they are written.

So in this example:
[filter]
has_weapon=sword
side=1
[or]
side=2
[/or]
gender=female
[/filter]
will be executed using this order:
[filter]
has_weapon=sword
side=1
gender=female
[or]
side=2
[/or]
[/filter]
One should be aware of this for some reasons:

'''⇒''' Clarity: your code will be easier to understand and to debug if you avoid meddling conditions, nested filters and logical blocks, and write them in the order they are evaluated.

'''⇒''' Performance.
Most of time, performance is not an issue. But it can be if you have a lot of units and use '''[filter_wml]'''. More generally, it’s good programming practice to execute the more restrictive test first.
Consider this example:
[filter]
race=orc
x,y=16,22
[/filter]
The first condition will be evaluated on all units. But the second one will be evaluated on all orcs. Then if we write:
[filter]
x,y=16,22
race=orc
[/filter]
obviously, the second condition will be evaluated once at most, and filtering will be faster. (Strictly speaking, I should have wrapped second condition in an '''and''' tag to force evaluation order).
Remember too that logical operators '''(and, or, not)''' are not mandatory, but are allowed. So one can use them for clarity sake or to force an evaluation order. It’s particularly important when using '''or''' tags.

In the example above one could expect the result set contains all women of sides 1 and 2 wielding a sword. But it contains actually all side 1 women wielding a sword plus all side 2 units.

Filters work actually as if top level criteria were enclosed in an implicit '''and''' tag: so we should read:
[filter]
[and] '''#implicit'''
has_weapon=sword
side=1
gender=female
[/and]
[or]
side=2
[/or]
[/filter]
and what we probably wanted is:
[filter]
has_weapon=sword
gender=female
[and]
side=1
[or]
side=2
[/or]
[/and]
[/filter]
Note that it could be written:
[filter]
[and]
has_weapon=sword
gender=female
[/and]
[and]
side=1
[or]
side=2
[/or]
[/and]
[/filter]
This syntax is correct and you can use it if you find it clearer.
Remembering this implicit '''and''' tag (and writing it explicitly at will) is very important to understand or design complex filters.

=== Writing complex filters. ===

Here are some guidelines one can use when writing complex filters. Suppose we want to set up some kind of disease aura harming units standing close to some villages. We shall start writing a sentence describing the feature.

'''We want to select units who:'''
'''Are enemy to side 1'''
'''stand on hexes which'''
'''are near to'''
'''villages'''
'''with side 1 units standing on it'''
Mark we put only one condition on each line to clearly separate them. Mark we sorted them, because some apply to units to be filtered, others to locations, and finally to other (enemy) units standing on locations. Next, we shall add logical operators and parenthesis to clearly specify what we want:
'''Units, who ('''
'''Are enemy to side 1 AND'''
'''stand on locations which ('''
'''( Are villages AND'''
'''have unit on it who ('''
'''Belongs to side 1'''
''')'''
''') OR'''
'''are adjacent to THOSE villages radius 3'''
''')'''
''')'''
Now, we are ready to start building the filter. Since we want units who… it shall be a unit filter. In the standard unit filter, there’s no condition directly allowing to state the unit is enemy to side 1. So we have to replace this with something valid in the SUF context. Using parenthesis to avoid errors, we can replace the condition with a side filter because it’s valid in unit filters.
'''Units, who ('''
'''(belongs to a side which ('''
'''is enemy to side 1) ) AND'''
'''stand on locations which ('''
'''( Are villages AND'''
'''have unit on it who ('''
'''Belongs to side 1'''
''')'''
''') OR'''
'''are adjacent to THOSE villages radius 3'''
''')'''
''')'''
Now we can write the filter. Here we do it step by step to show how the translation is rather straightforward and how our parenthesis match exactly the subtags.
[filter]
[filter_side]
[enemy_of]
side=1
[/enemy_of]
[/filter_side]
'''AND'''
'''stand on locations which ( # we start to filter locations there'''
'''( Are villages AND'''
'''have unit on it who ('''
'''Belongs to side 1'''
''')'''
''') OR'''
'''are adjacent to THOSE villages radius 3'''
''')'''
[/filter]

[filter]
[filter_side]
[enemy_of]
side=1
[/enemy_of]
[/filter_side]
[and]
[filter_location]
terrain=*^V*
'''AND'''
'''have unit on it who (# to unit filter again'''
'''Belongs to side 1'''
''')'''
radius=3 '''# radius is a special case, see below'''
[/filter_location]
[/and]
[/filter]

[filter]
[filter_side]
[enemy_of]
side=1
[/enemy_of]
[/filter_side]
[and]
[filter_location]
terrain=*^V*
[and]
[filter]
side=1
[/filter]
[/and]
radius=3 '''# radius is a special case, see below'''
[/filter_location]
[/and]
[/filter]
Here, we are done. The filter should work as it is, but it looks rather unusual because all these '''[and]''' blocks. Actually we can delete most of them using a simple rule: '''[and]''' tags are not needed when they contain one single criterion or a single block, (except if you want to set up an evaluation order). In our example, the '''filter_location''' block is alone in its '''and''' tag, and the embedded '''filter''' as well, so we can avoid those '''and''' tags and get finally:
[event]
name=moveto
first_time_only=no
[filter]
[filter_side]
[enemy_of]
side=1
[/enemy_of]
[/filter_side]
[filter_location]
terrain=*^V*
[filter]
side=1
[/filter]
radius=3
[/filter_location]
[/filter]
[harm_unit]
[filter]
id=$unit.id
[/filter]
amount=10
animate=yes
[/harm_unit]
[/event]

=== Filters uses: events actions and conditions. ===

Here, we shall deal with filter uses in WML. The language is not fully consistent, mainly to simplify its syntax, so some points can be misleading.
:'''Using in actions'''
Most actions take a filter as first parameter. The main difficulty here is to know if '''[filter]''' tags must be used or not. Actually, they’re used to avoid confusing keys and criteria when they have the same name4. For instance, the '''[kill]''' action needs a unit filter and has these keys:

* '''animate:''' if 'yes', displays the unit dying (fading away).
* '''fire_event:''' if 'yes', triggers any appropriate 'die' events (See EventWML). Note that events are only fired for killed units that have been on the map (as opposed to recall list).
* '''[secondary_unit]''' with a StandardUnitFilter as argument. Do not use a [filter] tag. Has an effect only if fire_event=yes. The first on-map unit matching the filter.

As we can see, none of these keys and tags are shared with unit filter keys and tags. This means the code parser needs no '''[filter]''' tag to know which key belongs to the filter and which to the action. But in the code, there’s no obvious distinction.

________________________________________

:4) Note there’s no specific top level tag for location filters.

[kill]
animate=yes '''# this belongs to the ‘kill’'''
id=BadGuy_101 '''# this belongs to the unit filter'''
[/kill]
is the correct syntax. Note a common error is to use a '''[filter]''' tag here. Since this tag is unknown in the context, it is ignored, so the kill action is applied to the starting set, i.e. all units (including the recall lists). Same with the '''filter_side''' tag which is not needed everywhere (in '''store_sides''' particularly).
Adversely, '''[modify_unit]''' obviously requires a '''[filter]''' tag, because all keys and criteria have the same name:
[modify_unit]
side=2
side=1
[/modify_unit]

This would make no sense of course because one can’t find if side 1 units must be put into side 2 or the contrary. Anyway, there is an exception: the '''[store_unit]''' tag requires a '''[filter]''' tag even if there is no '''‘variable’''' key in units description. Another special case is when using terrain action, because the key '''terrain''' is valid both in location filters and terrain action. Since there is no special tag to delimit location filters, one should write:
[terrain]
[and]
terrain=Wo* '''# here is the filter criterion'''
[/and]
terrain=Rr '''# and the new terrain'''
[/terrain]
The next example can be confusing:
[kill]'''# kill all units standing on deep water'''
animate=yes
[filter_location]
terrain=Wo
[/filter_location]
[/kill]
When reading the '''‘kill’''' tag documentation, one will not find any '''‘filter_location’''' or location filter entry. Does this means it’s an undocumented feature ? No. But the '''‘filter_location’''' belongs to the implicit '''‘filter’''' tag of the '''‘kill’''' action and is documented there. It’s kind of:
[kill]'''# kill all units standing on deep water'''
animate=yes
'''#'''[filter] '''we’re filtering units here, not locations'''
[filter_location]
terrain=Wo
[/filter_location]
'''#'''[/filter]
[/kill]

=== Using filters in conditions. ===

Filters can be used to create conditional expressions. They can be nested in '''[have_unit]''' or '''[have_location]''' tags or in nested filters. Here, the result set is not used directly, but its size must fall in the range defined by the '''‘count’''' key. This finally gives a Boolean result: true or false. So one can use them in '''[if] [show_if]''' conditional actions or in a '''[filter_condition]''' tag. They are widely used in nested filters too (see the special chapter on this).

Let’s give some examples:

[have_unit] '''# this piece of code evaluates to true when no more enemy leaders are alive'''
canrecruit=yes
[not]
side=1
[/not]
count=0
[/have_unit]

[have_location] '''# this one is true if at least 5 side 1 units stand on a village'''
terrain=*^V*
[filter]
side=1
[/filter]
count=5-1000
[/have_location]
Note we could also write this condition:
[have_unit]
side=1
[filter_location]
terrain=*^V*
[/filter_location]
count=5-1000
[/have_unit]
Note we could use a '''[store_unit]''' instead, testing the ''length'' property of the array:
[store_unit]
variable=temp
[filter]
side=1
[filter_location]
terrain=*^V*
[/filter_location]
[/filter]
[/store_unit]
#[if] or [filter_condition]
[variable]
name=temp.length
greater_than=4
[/variable]

=== Using filters in events. ===
In events, filters are always used in a conditional way, because they state if the event should fire or not. In any event, we can set '''[filter_condition]''' using '''have_unit''' or '''have_location''' (and a more ordinary variable condition, but this is off topic).
Some events use filters in a special way: '''moveto''' and '''attack''' events particularly. In them, the filtering apply not on all units as usual, but only on units involved in the event action: one unit only is moving at a time, two units only are involved in a fight. Then the event fires if and only if the involved unit(s) match the filter.
Note that one can use '''[filter]''' and '''[filter_condition]''' in the same moveto or attack event. Both conditions are then ANDed.

'''Filtering units'''

Criteria allowed to filter units (in standard unit filters) are listed below. First, the keys dealing with the unit properties (as usual, comma separated lists means conditions are ORed):
:'''id:''' ''can be a comma-separated list, every unit with one of these ids matches''
:'''type:''' ''can be a list of types''
:'''race:''' ''(Version 1.11 and later only: this can be a comma-separated list)''
:'''ability:''' ''unit has an ability with the given id (not name !)''
:'''side:''' ''the unit is on the given side (can be a list). One can use a [filter_side] instead''
:'''has_weapon:''' ''the unit has a weapon with the given name''
:'''canrecruit:''' ''yes if the unit can recruit (i.e. is a leader)''
:'''gender:''' ''female if the unit is female rather than the default of male''
:'''role:''' ''the unit has been assigned the given role''
:'''level:''' ''the level of the unit''
:'''defense:''' ''current defense of the unit on current tile''
:'''movement_cost:''' ''current movement cost of the unit on current tile''
:'''x,y:''' ''the position of the unit. (Ranges ? probably because it works in moveto events)''

Not all unit properties are listed here, but they can be used in a '''[filter_wml]''' sub-tag like this:
[filter_wml]
max_moves=7
[/filter_wml]

[filter_wml]
[status]
poisoned=yes
[/status]
[/filter_wml]
Some of them accept comma separated lists or ranges. Some not, but it also possible to use them more than once with '''[and]''' and '''[or]''' subtags. For instance :
[and]
race= elf
[or]
race= merman
[/or]
[/and]
Other sub tags are dealing with unit relationships:
'''⇒''' The hex on which they stand: '''[filter_location]''' which contains a standard location filter.
'''⇒''' The units adjacent to it: '''[filter_adjacent]''' which contains another standard unit filter
'''⇒''' Their visible status relating to a particular side: '''[filter_vision]'''
These are nested filters ; or in other words, filters used to create conditions and not result sets (see earlier and later).

Custom functions returning a boolean:
'''formula:''' FormulaAI like formula.
'''lua_function:''' lua function

SUFs accept a '''find_in''' key too. As we saw earlier, this allows to restrict the starting set to the content of an array.

=== this_unit ===

This variable is a special variable defined only inside SUFs. Suppose we want to catch in a filter units at full health. We can use the '''hitpoints''', but the problem is we know not which value to use, because every unit type has its own:
[filter]
side=1
[filter_wml]
hitpoints=?
[/filter_wml]
[/filter]
This is why we could have the use of some way to specify the unit being fetched during the filtering.
[filter]
side=1
[filter_wml]
hitpoints=$this_unit.max_hitpoints
[/filter_wml]
[/filter]
This does the trick. The condition value will be updated according to unit properties before executing the check.

=== Filtering locations ===

'''find_in''': a location array specifying the starting set.

'''time_of_day''': one of lawful, chaotic, neutral or liminal.
'''time_of_day_id''': one or more from: dawn, morning, afternoon, dusk, first_watch, second_watch, indoors, underground and deep_underground.

'''terrain''': comma separated list of terrains.
'''x,y''': the same as in the unit filter; supports any range.
'''owner_side''': If a valid side number, restricts stored locations to villages belonging to this side. If 0, restricts to all unowned locations (the whole map except villages which belong to some valid side). A hex is considered a village if and only if its [ terrain_type ] gives_income= parameter was set to yes (which means a side can own that hex).

'''[filter_adjacent_location]''': a standard location filter; if present the correct number of adjacent locations must match this filter

'''[filter]''' with a Standard Unit Filter as argument; if present a unit must also be there

'''radius''': this is not strictly speaking a criterion. It adds to the result set all hexes adjacent to a matching hex and is always applied last, when all criteria are checked. Remember the filtering process is a hidden loop where all candidates are fetched one by one. If a candidate match the filter, radius adds all adjacent hexes (matching the filter or not !). If it don't, it does nothing.
This is why this example doesn't work:
[filter] '''# this example doesn’t work !'''
side=1
[filter_location]
x,y=43,32
radius=5
[not]
x,y=43,32
[/not]
[/filter_location]
[/filter]
The coder here expected the radius action to be performed just after selecting the 43,32 hex, and the '''[not]''' criterion applied to this hex and it's adjacent radius 5 set. But '''radius''' is always applied last, even if written before some other conditions. So when using '''radius''', a good rule is to create the filter without it at first and to see if it can catch something. Here, it would give:
[filter]
side=1
[filter_location]
x,y=43,32
[not]
x,y=43,32
[/not]
[/filter_location]
[/filter]
which is clearly non sense because the two conditions are mutually exclusive.

The solution is to pack the conditions in two different filters:
[filter]
side=1
[filter_location]
x,y=43,32
radius=5
[/filter_location]
[and]
[filter_location]
[not]
x,y=43,32
[/not]
[/filter_location]
[/and]
[/filter]
or,
[filter]
side=1
[filter_location]
[and]
x,y=43,32
radius=5
[/and]
[not]
x,y=43,32
[/not]
[/filter_location]
[/filter]
or, since the x,y keys are defined in '''[filter]''' too, it can be:
[filter]
side=1
[filter_location]
x,y=43,32
radius=5
[/filter_location]
[not]
x,y=43,32
[/not]
[/filter]
This is why '''[filter_radius]''' is useful. As we said, radius adds hexes without checking any condition (except proximity of course). If we want to put a condition on hexes added with radius (and them only), we would use it as in next example. Here we want to select forested hexes near villages:
[filter_location]
terrain=*^V*
radius=3
[filter_radius]
terrain=*^F*
[/filter_radius]
[/filter_location]
But, this will not work exactly as in our previous example because radius extends outwards from matching locations one step at a time. Only the locations matching the '''filter_radius''' will be selected AND used to compute the next step. If there’s no forest hex near the village, the previous filter will return nothing, even if there are some forest hexes farther in the range.

Note this filter selects the village too ! If we want not, this should be:
[filter_location]
[and]
terrain=*^V*
radius=3
[filter_radius]
terrain=*^F*
[/filter_radius]
[/and]
[not]
terrain=*^V*
[/not]
[/filter_location]

=== Nested filters ===

Now, we are ready to study how to create nested filters, in other words, filters containing sub filters. In location or unit filters, the documentation says one can insert filters of various kind involving other objects. In this way, we can select unit adjacent to other units or standing on some terrains. Actually, they’re not exactly filters: they are conditions or criteria built on filters. In other words, they don’t produce a result set but are, like other criteria, expressions evaluating to true or false. That’s why many of them have additional keys, like '''‘count’''' (see the filter use in conditions).

We shall discuss this on examples.

=== Filter_adjacent. ===

In a unit filter, this allow to create criteria stating which units must be adjacent to the tested unit. In this example, we shall implement an ability named ‘escape’. Units having this ability can teleport elsewhere when surrounded by more than 3 enemies. We shall set a '''moveto''' event to watch the ‘surround’ event.

Guide to UMC Content

2013-06-12T12:05:40Z

Pyrophorus: /* A New Order */

''This is a guide to the current (1.10.x/1.11.x) UMC campaigns for players. It aims to provide all the information not only about the story, but also about completion, difficulty and playing style of the campaign. See also [[Guide_to_UMC_Campaigns/Players_Reviews|Players Reviews]], as well as http://forums.wesnoth.org/viewtopic.php?f=8&t=37476 for further information and http://forums.wesnoth.org/viewtopic.php?f=8&t=36733 (for currently non-available UMC-content). Please edit, it is a wiki.''

=== Blueprint ===

'''Status:'''
* Broken = Does not work at all
* Incomplete = Partially written, no progress
* WIP = Partially written, progress
* Complete = Completely written, but buggy as well as potential balance issues.
* Finished = Completely written, minimal to no bugs, slight balance issues possible.

'''Length:'''

'''Author:'''

'''Maintainer:''' if not maintained by the author anymore.

'''Description:'''

'''Version: '''

'''Requirements:'''

'''Difficulty:'''

Please note: Often campaigns introducing new mechanics are listed as expert level on the add-on server, here difficulty means the raw difficulty after the mechanics are understood.

* Unbalanced = If you can't beat the hard mode, it isn't necessarily unbalanced, but if the difficulty changes erraticly from one scenario to the next and only people using the debug mode have seen the final, then it is.
* Easy
* Normal
* Hard

'''Style:'''

Please note: Many campaigns will feature more than one style. Please list the most significant ones.

* Skirmish = small to medium sized armies, your standard Wesnoth gameplay
* Dungeon = long and narrow tunnels (not every underground scenario is a dungeon, a dungeon isn't necessarily underground)
* RPG = role playing game elements such as talking with non-player-characters, item collection, dependency on a party of very few adventurers without or limited recruits
* Survival = being exposed to changing, spawning enemies while remaining on the same map
* Large Battle = large number of units on the battlefield, sizely maps
* Simulation = campaigns feat. terrain modification, alternative resources
* Boss battle = the challenge is to defeat a single powerful enemy unit
* Minigames = there are puzzles and minigames in the campaign that significantly differ from standard Wesnoth gameplay

'''Faction/Era:'''

* Era for the whole campaign and more specifically the faction or unit composition you field.

'''Custom units:'''

* Link to the unit tree for cases that don't feel sufficiently described by Faction / Era entry.

'''Forum:'''

* Links to the feedback and development threads at forums.wesnoth.org

== Battle for Wesnoth 1.10.x - stable ==

''Campaigns available in the 1.10.x stable version.''

=== After the Storm ===

''Follow the journey of Elynia and her band following the events of Invasion from the Unknown''

'''Author:''' shadowmaster/ShikadiLord

'''Status:''' Finished

'''Length:''' 3 episodes of approximately 12 scenarios each, some of which are multi-part

'''Difficulty:''' Medium-hard

'''Style:''' Skirmish, Boss Battle, Dungeon

'''Faction/Era:''' Many custom units

'''Version:''' 0.9.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=32091

'''Note:''' (vultraz) Long, very enjoyable campaign with great story.

=== Aldur The Great ===

''This is a story about Aldur the Great.''

'''Author:''' pintercsabi

'''Status:''' Complete, but unbalanced

'''Length:''' 5 playable scenarios

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish

'''Faction/Era:''' Default

'''Version:''' 1.2.2

'''Forum:''' -

'''Note:''' (Adamant14) Short unbalanced campaign, maybe abandoned. You fight with Peasants, Ruffians and Woodsman against Orcs

=== Alfhelm the Wise ===

''This is the tale of Alfhelm, called by some the Wise, son of Alfric Conqueror. This is the tale of his victories over his enemies, and his rise to power in the clans of Marauderdom. This is the tale of his journey south and his destruction of the Lavinian Empire. And this is the tale of his demise in the dark forests far to the east of his homeland.''

'''Author:''' turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 15 gameplay scenarios

'''Difficulty:''' Moderate

'''Style:''' Skirmish

'''Faction/Era:''' Imperial Era, Marauders.

'''Version:''' 0.6.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=17144

'''Note:''' (Maintainer) Though this campaign is complete and playable the whole way through, the code is four years old and pretty buggy. If you notice any errors while playing, please let me know and I'll incorporate the fixes into my next revision as soon as possible.]

=== A New Order ===

'''Author:''' szopen

'''Status:''' Finished.

'''Length:''' 45 scenarios.

'''Description:''' The old kingdom of Wesnoth has fallen before barbarian hordes. The occupying barbarians are on the brink of civil war, the seeds of Wesnothian rebellion are kept alive by old legends, while bandits and Khalifate mercenaries roam the land. Can Gawen Hagarthen unite these disparate factions against a common foe?
Note: This campaign contains mature themes, some of which may be unsuitable for children.

'''Version: ''' 1.2.15

'''Requirements:''' Requires BfW 1.10. In addition, you have to install Era Khalifate add-on; the Akladian Music package is optional

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Akladians, Khalifate

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=6486

'''Note:''' (Pyrophorus) Certainly one of the most mature and well designed campaign in add-ons. A must.

''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#A_New_Order Players Review]'''

=== Antar, Son of Rheor ===

''This is the story about a young Lord and his first mission; sent by his father the young Lord Antar has to relieve his neighbours; he has to convince the Elves and Dwarves to ally him; he has to fight against hordes of Orcs and Endless Undead; and finally he has to defeat Mal Kazur, the mastermind who is behind all the evil.''

'''Author:''' Adamant14

'''Status:''' WIP

'''Length:''' 9 playable scenarios / 1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Loyalists and Elves (feat. fencer as main hero + various allies)

'''Version:''' 0.9.9

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36075

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Antar.2C_Son_of_Rheor Players Review]'''

=== A Story of the Northlands ===

''A story of life and death in a remote village of the Northlands. Your village has been overrun by an orcish raid. You fight for its freedom while you wait for help to arrive.''

'''Author:''' zepko

'''Status:''' Complete

'''Length:''' 10 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default + additions: you play with a custom faction of outlaws and with a custom party of loyalist knights.

'''[http://units.wesnoth.org/1.10/A_Story_of_the_Northlands/en_US/A_Story_of_the_Northlands.html Custom Units]'''

'''Version:''' 1.0.0

=== A Vision Blinded ===

''Defend the northern forest against what appeared like a routine orcish raid, and unravel the greater conspiracies that lie below its waves.''

'''Author:''' LemonTea

'''Maintainer:''' AxalaraFlame

'''Status:''' Complete

'''Length:''' 13 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves (+ Trolls, Outlaws)

'''[http://units.wesnoth.org/1.10/A_Vision_Blinded/en_US/A_Vision_Blinded.html Custom units]'''

'''Version:''' 0.6.6

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23463&hilit=a+vision+blinded

=== Bad Moon Rising ===

''An expedition to gather treasure from the cold north sets off compounding disaster.''

'''Author:''' Doofus-01

'''Status:''' Finished

'''Length:''' 20 scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Archaic Era

'''Version:''' 1.4.4.a

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31348

=== Battle Against Time===

''Rescue fellow orcish warchief before he is executed. (This is not a normal campaign. It is experiment with carryover system. You will start with defined number of turns and gold. You will only have that many turns to play through the whole campaign. There is no finish bonus and gold carryover is always 100%.)''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 4 playable scenarios + 1 prologue scenario

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default: Orcs

'''Version:''' 1.0.0

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=27319

=== Besieged Druids ===

''A elvish school for druids comes under attack by goblins. It seems more than just a routine raid; is there something more sinister behind this attack? - In Beseiged Druids, you control Eärendil, the surviving teacher at the school, and the many and varied initiates. Not all of these are ordinary students; many have been experimenting with other forms of magic, while others are simply overachievers in some area of study. Unfortunately, they are not especially good at combat, at least initially. Together with a very small contingent of surviving guards, it is up to these students to save the island of Aleron from disaster.''

'''Author:''' Celtic Minstrel

'''Status:''' Complete

'''Length:''' 9 scenarios

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves

'''[http://units.wesnoth.org/1.10/DruidSiege/en_US/celmin-druid-siege.html Custom units]'''

'''Version:''' 1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37342

=== Birth of a Lich ===

''This is the life story of the dreaded lich Malifor, his struggle as a mage outcast, the orcish conquest of the northlands and his transformation to quench the thirst for revenge''

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 12 playable scenarios / 2 dialogue only

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle, Dungeon

'''Faction/Era:''' Human outlaws, dwarves, undead

'''[http://units.wesnoth.org/1.10/Birth_of_a_Lich/en_US/Birth_of_a_Lich.html Custom Units]

'''Version:''' 1.0.3

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37057

=== Bitter Revenge===

''Amidst the strife and turmoil of the first Dark Age of Wesnoth, a time of transient monarchies and conspiracies against the Crown, the boy Darith witnesses the murder of his father by a general of Wesnoth. Follow Darith's quest for retribution in this treacherous tale of betrayal, deceit, love, remorse, and vengeance.''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 11 playable scenarios + 4 dialogue only

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default (mostly outlaws and undead, custom units)

'''Version:''' 1.1.0

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=26699

=== Cavanagh The Conqueror ===

''This is the tale of Cavanagh Orc-Foundling, who was blessed by the gods to conquer and unite all of the Great Continent. Orcs and elves, gods and men, queens and sorcerers populate this epic tale of revenge and redemption.''

'''Author:''' TheEmptyLord (Programming, Map-making, Editing), Scott_Free(Story)

'''Status:''' WIP

'''Length:''' 10 Playable Scenarios so far

'''Difficulty:''' Normal

'''Style:''' Skirmish, limited RPG, limited Large Battle

'''Faction/Era:''' Default (Units from Northerners, Outlaws, Loyalists as well as other factions interspersed. Several custom units.)

'''Version:''' 0.1.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=35927

=== Cities of the Frontier ===

''Settle a new town in the wilds north of the Great River.''

''This campaign makes several changes to the standard Wesnoth game mechanics, and focuses on city-building and gold management.''

'''Author:''' esci

'''Status:''' Complete

'''Length:''' Not fixed, approximately 6-10 seasons of 36 turns each

'''Difficulty:''' Normal

'''Style:''' Simulation, Survival

'''Faction/Era:''' Default, Loyalist

'''[http://units.wesnoth.org/1.10/Cities_of_the_Frontier/en_US/Cities_of_the_Frontier.html Custom units]'''

'''Version:''' 0.5.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36004

=== Considerate Dead ===

''As the wind goes on and on, people discover necromancer aren't always bad. Made by tribes45 - No scenarios are done, 4 playable out of ??.''

'''Author:''' tribes45 aka tribes55

'''Status:''' Incomplete, unbalanced, abandoned

'''Length:''' 5 scenarios

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish

'''Faction/Era:''' Default

'''Version:''' .009

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36522

=== Count Kromire ===

''You are the blood son of a vampire lord, however when the might of the celestial crusades comes knocking, and your father is slain, you flee your lands. However you intend to return, to restore the lands of Kromire to the Kromires, to avenge your father, and most importantly, to make sure that no celestial ever dares come into your mountains again.''

'''Author:''' Velensk

'''Maintainer:''' currently none

'''Status:''' Complete

'''Length:''' 9 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Era of Myths, Vampires

'''Version:''' 1.3.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=21560

=== Elvish Dynasty RPG ===

''You are the new ruler of an elvish kingdom! Can you lead your people to glory? This campaign is highly randomized so it will be different every time you play!''

''Sequel to Ooze Mini-Campaign''

'''Author:''' spencelack

'''Maintainer:''' Wesbane

'''Status:''' Complete

'''Length:''' 10 years, in each year choice between dialogue and fighting scenario (selected out of a large pool of possible scenarios)

'''Difficulty:''' Normal

'''Style:''' RPG, Skirmish

'''Faction/Era:''' Default, Elves

'''Version:''' 0.9.9b

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=28627

=== Fall of Silvium ===

''You are Caius Regilius, Tribune of the province of Silvia, located in the northmost reaches of the Lavinian Empire at the height of its power. But the Empire has overextended itself, The city of Silvium lies seperated from the rest of the Empire by the mountains of Arendia, and is sandwiched between the Marauders and the Sidhe... war is inevitable, and the province of Silvia will almost certainly fall.''

'''Author:''' turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 8 scenarios

'''Difficulty:''' Medium

'''Style:''' Skirmish

'''Faction/Era:''' Imperial Era, Lavinian Legion.

'''Version:''' 0.6

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=31&t=24356

'''Note:''' The final level of this campaign is not supposed to be winnable. It's a final blaze of glory and chance to use all your high-powered units, but to 'win' the campaign, you must lose...the ending is similar to a certain mainline campaign, but predates it.

=== Fate of a Princess ===

''Part I: Baldres, a notorious robber baron, flees Wesnoth with his followers and sets off into the northlands to evade the king's justice. The baron's deeds and misdeeds are to change the balance of power between orcs and non-orcs throughout the northlands, and will carry consequences long after his eventual death.''

''Part II: The Greenwood elves face a crisis which demands the return of the queen's estranged half-elven half-sister, Baldres' daughter. Two brave young elves must make a perilous journey to find her and bring her back to her former home. If they fail, the whole northlands will be engulfed in war with the resurgent orcs...''

'''Author:''' SkyOne, mich, simonsmith

'''Status:''' Finished

'''Length:''' 26-29 scenarios (some dialogue-only), 2 parts

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon

'''Faction/Era:''' Default with additions. You play two different, unique cross-faction combinations in each part.

'''[http://units.wesnoth.org/1.10/Fate_of_a_Princess/en_US/Fate_of_a_Princess.html Custom units]'''

'''Version:''' 0.9.17

'''Required Wesnoth version:''' 1.9.12 or later

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=26327

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Fate_of_a_princess Players Review]'''

=== Forgotten Kingdom ===

''Help Orlog, a troll chieftan, lead his people to safety in the underground and discover an ancient power long forgotten.''

'''Author:''' Limabean

'''Maintainer:''' Chrysophylax

'''Status:''' Incomplete ( but all scenarios playable and balanced )

'''Length:''' 9 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Goblins, Trolls

'''[http://units.wesnoth.org/1.10/Forgotten_Kingdom/en_US/Forgotten_Kingdom.html Custom units]'''

'''Version:''' 0.1.7

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23483

'''Note:''' (Adamant14) This campaign includes a custom Troll line. A good campaign, I hope Limabean and/or Chrysophylax will finish it.

=== Forward they Cried ===

''You are the leader of an advanced detachment that has been tasked with capturing a bridgehead while the main army prepares to attack. It should be a simple enough assignment.''

'''Author:''' Glowing Fish

'''Maintainer:''' Lord-Knightmare

'''Status:''' Finished

'''Length:''' 1 scenario ( rather a single scenario than a campaign )

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default Loyalists

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23656&p=350126&hilit=forward+they+cried#p350126

'''Version:''' 1.0.0

'''Note:''' (Adamant14) Only a single scenario, but a great scenario.
(UnwiseOwl) You wouldn't want to stop thinking for a turn, and it's good for the first few turns, but this one leaves me wanting more.

=== Galuldur's First Journey ===

''While the belligerence of orcs is nothing new, their intensifying attacks on a fledgling colony of elves in Pindir Forest begin to show signs of a deeper malice, forcing Galuldur, the young son of the colony's adventurous founder Galur, to venture out of his forest's friendly trees in search of help. His simple errand quickly turns into a frantic quest to unearth the roots of the mysterious evil threatening his people. As you lead him through unknown lands, Galuldur, forced to match wits with unexpected adversaries at nearly every turn in a desperate attempt to save his world, quickly learns that the world is neither a friendly nor a simple place.''

'''Author:''' mattsc

'''Status:''' Complete

'''Length:''' 8-9 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves

'''[http://units.wesnoth.org/1.10/Galuldur/en_US/Galuldur.html Custom units]'''

'''Version:''' 1.1.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31895

=== Grnk the Mighty ===

''All his life, puny little goblin Grnk the Frail had been dreaming about leaving the orcs and starting a better life. When he finally arrives in the human town of Shmaltupp, he realizes that the world is not as black and white as he had imagined. He also discovers that he is no ordinary goblin. Follow Grnk the Frail on his path to becoming Grnk the Mighty.''

'''Author:''' mattsc

'''Status:''' Part I complete

'''Length:''' 13 scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish, RPG

'''Faction/Era:''' Default, changing (no standard army building gameplay)

'''[http://units.wesnoth.org/1.10/Grnk/en_US/Grnk.html Custom units]'''

'''Version:''' 1.0.5

'''Required Wesnoth version:''' 1.9.5 or later

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34970

=== Invasion from the Unknown ===

''Episode I - Seeking the Light: Long after the Fall, the last forest elves are forced to abandon their safe valley, and find themselves resorting to the dark means of necromancy in order to survive the perils and challenges of this new harsh world. May they finally free the Great Continent from its chaos, or perish in the foolish attempt of restoring peace and life to the lands.''

''Episode II - Armageddon: As the shadow of Chaos covers the entire continent, an assorted group of foolish heroes prepares a counter-attack to the Empire, with one unique goal in their minds: defeat the evil Emperor, whoever it is. Lead these courageous living and non-living warriors to victory, and rediscover lost secrets of the history.''

'''Author:''' shadowmaster

'''Maintainer:''' Espreon

'''Status:''' Finished

'''Length:''' 26 scenarios in two episodes

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon, Boss battle

'''Faction/Era:''' Unique. You play Elves and Undead throughout the campaign + in the 2nd part Northerners and Aragwaithi.

'''Version:''' 1.90.6

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Invasion_from_the_Unknown Players Review]'''

'''Note:''' (taptap) Despite its acknowledged flaws (generic hero, plot holes, deus ex machina moments, gameplay issues in the 2nd part) this is undoubtedly the most iconic campaign in UMC. It single-handedly redefines the elvish history and sketches a cosmology for the ages after the fall. With the Chaos empire and its various allies it introduces an era worth of factions to single-player play. At the same time it features some of the most beautiful maps in Wesnoth and stunning art on par with mainline campaigns.

=== Invasion of Eliador ===

''A peaceful island is about to be invaded by unknadd-ons foes travelling towards the eastern shore. It is up to a family of outlaws to warn the island's inhabitants before it's too late.''

'''Author:''' Sam M. (Genosuke)

'''Maintainer:''' trewe

'''Version:''' 1.0.4

'''Style:''' RPG, Skirmish, Puzzle

'''Length:''' 10 scenarios + epilogue

'''Difficulty:''' Easy

'''Status:''' Complete

'''Faction:''' Default (outlaws)

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=6556

'''Wiki:''' [[Invasion_of_Eliador]]

=== Langrisser Sample Campaign ===

''The Imperial Knights of the Rayguard Empire have disrupted the peace of the village that was Hein's hometown, seeking only a girl named Liana. Fight to rescue Liana.''

'''Author:''' Morath

'''Status:''' Finished

'''Length:''' 1 playable scenario

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves

'''Version:''' 0.1.0.5

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36417&hilit=Langrisser

'''Wikipedia:''' [http://en.wikipedia.org/wiki/Langrisser What is Langrisser]

'''Note:''' (Adamant14) Single scenario, different from usual Wesnoth behaviour.

=== Legend of Far North ===

''The tale of the legendary Black Eye Karun,depicting his rise to power, his successes and his brutal assassination.'

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 16 playable scenarios / 1 dialogue only,1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Orcs, Trolls, Saurians, Nagas

'''[http://units.wesnoth.org/1.10/Legend_of_Far_North/en_US/Legend_of_Far_North.html Custom Units]'''

'''Version:''' 1.0.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34769

=== Legend of the Invincibles ===

'''''Part I: Shrouded in Darkness''' (5 chapters, 90 scenarios) - A pair of heroes, after stopping an orcish thread, are outcast into caves, where they have no other choice than to become liches in order to survive. They preserved their original appearance and moral principles, and fight in various skirmishes against evil (although using evil methods sometimes), until the Fall, when they are buried alive under the ashes of the third sun.''

'''''Part II: Into the Light''' (4 chapters, 96 scenarios at the moment) - Long after the Fall, the lich heroes awaken. Searching for more power, they manage to resurrect themselves as living beings, but this time more powerful and ridden of the evil within. But the evil from inside them did not cease to exist, and started a campaign to conquer the world. Stopping the campaign caused an even worse disaster...''

'''Author:''' Dugi

'''Status:''' WiP (but Part I might be considered complete)

'''Length:''' 185 (+7 talk-only) scenarios at the moment

'''Difficulty:''' Normal

'''Style:''' mostly Skirmish and Dungeon (all other styles are present as well, but less frequently)

'''Faction/Era:''' Elves, Loyalists, Undead, Dwarves; but they advance past their usual maximum level

'''Version:''' 2.5.0

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Legends_of_the_Invincibles Players Review]'''

'''Note:''' The most unique feature of this campaign is its RPG-like unit development system, enemies drop items units can use, leaders are stronger than most usual units and all units get AMLA (after maximum level advancement) after reaching their maximum level (that is also increased by a load of additional level 4 units).

=== Panther Lord ===

''The Imperialists ambitions of pushing into the Sea States have been repeatedly thwarted and now they turn their attentions elsewhere. You are an outcast Darklander now living as a mercenary in the Sea States and the rumors you hear indicate that they will be coming to your people. Though an outcast you do not wish to see them subjugated. The spirit whose friendship caused you to be an outcast has a plan that might allow you to save them.''

'''Author:''' Velensk

'''Maintainer:''' Lavender

'''Status:''' Finished

'''Length:''' 14 scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Era of Four Moons, Darklanders (+ a wide variety of mercenaries)

'''Version:''' 1.0.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34318

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Panther_Lord Players Review]'''

=== Random Campaign ===

''Gain experience playing the Default Era faction of your choice in a campaign setting''

'''Author:''' SigurdFireDragon

'''Status:''' Complete

'''Length:''' 7 playable scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Age of Heroes, & Era of Legends

'''Version:''' 1.0.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=32922

'''Note:''' (Author) A 4 scenario version is under the multiplayer button, which lets you choose any era.
Intended for players to gain practice with a faction and learn sound strategies using faction specific adjustments against random factions from the chosen era.

=== Rebellion in the North ===

''A great orcish uprising tends to destabilise the Northlands. As the future Lord Protector of the Northern Alliance you have to crush the rebellion and establish peace again."

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 24 playable scenarios / 3 dialogue only,2 cutscenes

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Loyalists, Dwarves, Gryphons, Merfolk

'''Version:''' 1.1.12

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=33059

=== Return of the Monster ===

''It was time for Amailoss, born from the naga queen's last egg, to leave home. Time for him to grow into a leader in his own right, and eventually become the guardian and leader of another naga city. But along the way, he became friends with an unusual mud-crawler, they met a strange young monster, discovered that a spirit had escaped from an orc prison, and the mystery of that spirit became a grave challenge for Amailoss and the many races in the region....''

''A naga campaign, involving elves, orcs, saurians, turtle-like races, and some monsters.''

'''Author:''' SkyOne

'''Status:''' Complete

'''Length:''' 16 playable, 2 dialog scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon

'''Faction/Era:''' Default with additions. You play a custom naga faction and carapaces (a turtle-like race).

'''[http://units.wesnoth.org/1.10/Return_of_the_Monster/en_US/Return_of_the_Monster.html Custom units]'''

'''Version:''' 0.7.1

'''Required Wesnoth version:''' 1.10.x

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36438

=== Return to Noelren ===

'''Status:''' Complete.

'''Length:''' 26 scenarios + 7 cut scenes

'''Author:''' Pyrophorus

'''Description:''' ''A story in the first Dark Age of Wesnoth. See how various heroes stick together to shun the threat of black magics, restore the secret kingdom of Noelren and install Garard I on the throne of Wesnoth. This campaign features complex scenarios, unusual objectives and units, emphasizing more on story and adventures than hardcore fighting.''

'''Version: ''' 0.7.6

'''Requirements:''' BfW 1.10 (not tested on 1.11)

'''Difficulty:''' Easy, unbalanced

'''Style:''' Skirmish, RPG, Large Battle, Simulation

'''Faction/Era:''' Default + custom units

'''[http://units.wesnoth.org/1.10/ReturnToNoelren/en_US/ReturnToNoelren.html Custom Units]'''

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34685#p501026

'''Note:''' (Adamant14) I never saw so much fantastic and new ideas in one single UMC, wow!

=== Return to Ruins ===

''The humble farmers of Vertegris are summoned by Erik the General of Weldyn to put an end to an orcish raiding party. If they knew what would befall their former home... They never would have left. This is a relatively short campaign with 8 scenarios, It is still undergoing changes.''

'''Author:''' Jeff Stevens (Ulfsark)

'''Composer:''' Paul Fredericks (paulfredericksmusic.com)

'''Status:''' Complete

'''Length:''' 7 scenarios + 1 dialogue-only

'''Difficulty:''' Easy,Normal,Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default,(Loyalists, Outlaws)

'''Version:''' 0.5.1

'''Required Wesnoth version:''' 1.10.x

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37790&sid=9059f18497cda1219f42a626544d0ffd&p=540646#p540646

'''Note:''' (Adamant14) You play a short campaign with just a few units. Playable in a few hours, nevertheless it is fun to play.

=== Salt Wars ===

''Introductory campaign for the Era of Four Moons.''

''As an officer of one of the Sea States you must defend your organization from aggressive rivals.''

'''Author:''' Velensk

'''Maintainer:''' Lavender

'''Status:''' Complete

'''Length:''' 5 scenarios

'''Difficulty:''' Easy

'''Style:''' Skirmish

'''Faction/Era:''' Era of Four Moons, Sea States

'''Version:''' 0.2.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31498

=== Saving Elensefar ===

''Meneldur, elvish mariner of Elensefar, is driven to sea by the same orcs who attacked the city. He must gather an army willing to fight for him to regain Elensefar, his adopted homeland.''

'''Author:''' Turin

'''Maintainer:''' trewe

'''Status:''' Finished

'''Length:''' 1 year (around 12 scenarios)

'''Difficulty:''' Normal

'''Style:''' Skirmish, RPG, Simulation

'''Version:''' 1.5.2

'''Faction:''' Default Era

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?t=3072&start=0

'''Wiki:''' [[SeafaringCampaign]]

'''Note:''' Labeled as Expert, recruit list changes in all scenarios.

=== Shameless Crossover Excuse ===

''Fugitive dark sorcerer Gwiti Ha'atel discovers he has the power to mess with Wesnoth's continuity. His quest for revenge on the NPCs who have used his portraits will lead him through perils untold and in-jokes unnumbered, but shall pale before the horror he finds at his quest's end.''

'''Author:''' Orcish Shyde, Mountain_King

'''Status:''' Complete

'''Length:''' 9 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Version:''' 1.1.0

'''Faction:''' Undead

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=32016&start=15

=== Swamplings ===

''Banished by Yushnak the Ponderer, a tribe of lowly swamp goblins endure in the deadly mire of Pogo Bog. Four centuries before the founding of Wesnoth, this is the story of the goblins' struggle against the intrigues and betrayals of the greater races, and the rise of the first wolf rider.''

'''Author:''' John Rawlins (boru)

'''Status:''' Complete

'''Length:''' 14 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Version:''' 1.1.7n

'''Faction:''' Goblins

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=29784

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Swamplings Players Review]'''

=== Talentless Mage===

''Humorous and silly campaign about mage apprentice who has managed to learn only one simple spell in thirty years.''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 11 playable scenarios + 3 dialogue scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Noob Faction

'''Version:''' 1.1.0

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=27608]

'''[http://wiki.wesnoth.org/index.php?title=Guide_to_UMC_Campaigns/Players_Reviews&action=submit#Talentless_Mage Players Review]'''

=== The Dark Alliance===

''Prince Terhar lived two years with elves. Little did he expect what would happen when he returned back to Weldyn.''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 11 or 10 playable scenarios depending on the branch you take (+ 5 dialogue scenarios)

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default: Recruit list changes in almost every scenario

'''Version:''' 1.0.3"

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=26924

=== The Dark Hordes ===

'''Status:''' Incomplete/WIP

'''Length:''' 11/?

'''Author:''' Circon

'''Maintainer:''' Various

'''Description:''' Lead fugitive dark sorcerer Gwiti Ha’atel to mastery of the undead hordes.

'''Version: '''

'''Requirements:'''

'''Difficulty:'''

'''Style:''' Skirmish

'''Faction/Era:''' Default undead

'''[http://units.wesnoth.org/1.10/The_Dark_Hordes/en_US/The_Dark_Hordes_1.html Custom Units]'''

'''Walkthrough:''' [[TheDarkHordes]]

'''Forum:''' [[http://forums.wesnoth.org/viewtopic.php?f=8&t=16576&]]

=== The Devil's Flute ===

'''Status:''' Complete, unmaintained

'''Length:''' 10 scenarios

'''Author:''' lipk

'''Description:''' Creona, the well-known assassin, gets a strange job from a strange person. So, in fact, it's no surprise that things take a strange turn...

'''Version:''' 0.1.4c

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish, Minigames

'''Faction/Era:''' Outlaws

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36044

=== The Earth's Gut ===

''The year is 515YW. You are the young dwarven leader Hamel. Your tribe in the caves of Knalga is under pressure from its enemies, and resources are growing scarce. In order to forge the weapons required to resist your enemies, you must set forth and collect what ores and minerals remain.''

'''Author:''' Anonymissimus

'''Maintainer:''' Anonymissimus

'''Status:''' WIP, story is unfinished (I didn't add any scenario since long, but that doesn't mean nothing is added to the campaign. My addons tend to be in good shape and bug-free which means also WIP as I'm updating it since 1.4 days.)

'''Length:''' 23 scenarios, 5 of which are cutscene only, some others have changing objectives

'''Difficulty:''' Normal

'''Style:''' Dungeon, Skirmish

'''Faction/Era:''' Default, dwarves, woses, mages, a few custom units

'''[http://units.wesnoth.org/1.10/The_Earths_Gut/en_US/the_earths_gut.html Custom units]'''

'''Version:''' 0.2.14

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=26800

'''Note:''' This campaign is a "Dwarvish dungeon crawler" (It currently contains about as many surface scenarios as underground though.) and is intended to be challenging for experienced players on hard whilst suitably easy on easy. I develop the campaign with the wesnoth development version and I advise to play with that, but it is intended to work almost equally well with the stable wesnoth version (except for features only available in the wesnoth development version).

=== The Epic of Vaniyera ===

''The expansionist Lavinian Legion, led by the Imperator himself, has invaded the northern forests of the Sidhe, or Wild Elves. It is up to Leithan the Thunderblade and his advisor Vaniyera to push its armies back where they came from...''

'''Author:''' oreb, turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 6 scenarios

'''Difficulty:''' Hard (Don't be fooled by "novice level" in the campaign description, this one is very hard.)

'''Note:''' (Maintainer) Working on this issue, the next release (due at the end of November, hah!) should bring easy difficulty back to the level of a reasonable introduction to the IE, while the hard difficulty will also become slightly easier. With any luck, this will be the last release before version 1.0 of the campaign].

'''Style:''' Skirmish

'''Faction/Era:''' Imperial Era, Sidhe.

'''Version:''' 0.9.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=19490

=== The Fall of Wesnoth ===

''As the beloved human empire of Wesnoth becomes lazy and arrogant in its peaceful state of happiness, Emperor Dantair demands the creation of another sun in a bid to destroy all evil. Or is it all for a different purpose? A man named Alitar sees it that way, and now he must survive the most evil inhabited lands if he is to stop chaos from rising, and Wesnoth from falling... This is the story of The Fall of Wesnoth.''

'''Author:''' Pewskeepski

'''Status:''' 1st part complete, 2nd WIP.

'''Length:''' 10 playable scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Outlaws

'''[http://units.wesnoth.org/1.10/The_Fall_of_Wesnoth/en_US/The_Fall_of_Wesnoth-1.html Custom units]'''

'''Version:''' 1.0.8

=== The Founding of Borstep ===

''The chieftain of your tribe has become decadent and weak. Take over, and lead your people to a better home--whether it is already occupied or not. The Northlands in year 9W are a barbaric place, but anyone who stands in your way will learn the power of orcs!''

'''Author:''' Beetlenaut

'''Status:''' Complete

'''Length:''' 10 and 1 dialogue only

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default, Northerners

'''[http://units.wesnoth.org/1.10/The_Founding_of_Borstep/en_US/The_Founding_of_Borstep.html Custom units]'''

'''Version:''' 1.1.1b

'''Note:''' (Kanzil) I find the protagonist hard to sympathise with. Also, most scenarios contain interesting twists. For example, in one, each time you killed a boar it gives you extra health.

'''Note:''' (beetlenaut--author) In most Orcish campaigns the leader is heroic or just wants peace. Krag-Ubor wants plunder and battle like all enemy Orcs in other campaigns. I '''hope''' you don't sympathize too strongly, but I don't think you need to in order to enjoy the game play.

=== The Library of Kratemaqht ===

''An ancient story from the old continent.''

'''Author:''' Rich Marinaccio (cephalo)

'''Status:''' Complete

'''Length:''' 17 scenarios

'''Difficulty:''' Unbalanced (some scenarios are Easy - some rather Hard)

'''Style:''' Skirmish, RPG

'''Faction/Era:''' Loyalists and custom units.

'''[http://units.wesnoth.org/1.10/Library_Of_Kratemaqht/en_US/The_Library_Of_Kratemaqht.html Custom units]'''

'''Version:''' 1.0.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37798

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#The_Library_of_Kratemaqht Players Review]'''

'''Notes:''' (Adamant14) This campaign has a thought-out story, shows a great love for detail;
It includes a great custom Dragon, some brilliant custom images (fire, burning houses, burning forest) that makes the scenery / maps look very nice.

=== The Roar of the Woses ===

''When the construction of a dam threatens the existence of her home, Kylix is forced on a journey to stop it.''

'''Author:''' Alarantalara

'''Status:''' Finished

'''Length:''' 10-11 scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default with Additions (primarily Saurians, Nagas, Woses)

'''Version:''' 1.2.7

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=29830

'''Note:''' (author) Potentially unbalanced on Hard difficulty due to experiments with non-standard ways to increase difficulty. This issue does not exist on the lower difficulty levels.

=== The Three Elves ===

''Three elves have just begun their adventure in the northern swampland. Will they become heroes or will they be responsible for another undead expansion?''

'''Author:''' Stanislav Hoferek

'''Maintainer:''' trewe

'''Version:''' 0.9

'''Status:''' Complete

'''Difficulty:''' Easy

'''Length:''' 8 scenarios + 2 dialogue

'''Style:''' Skirmish

'''Faction:''' Default (Elves)

'''Forum:''' (does it have one?)

=== The Sojournings of Grog ===

''Grog (as starred in Under the Burning Suns) goes home.''

'''Author:''' Peter Christopher, Thomas Hockings

'''Maintainer:''' Elvish_Hunter

'''Status:''' Finished

'''Length:''' 18 playable scenarios in 2 parts

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon, Large Battle

'''[http://units.wesnoth.org/1.10/The_Sojournings_of_Grog/en_US/The_Sojournings_of_Grog.html Custom units]'''

'''Faction/Era:''' Default. Most of the time you play trolls and some desert elves accompanying Grog.

'''Version:''' 3.0.1

=== The Unstoppable Legion ===

''Horseback campaign. The kingdom of Suveran, far away from Wesnoth, is under attack. Only Deuterus, a Great Druid, knows their weakness and only Viktor, a young noble, dares go on the quest to stop them.''

'''Author:''' Chris Neville-Smith (Chris NS)

'''Maintainer:''' Chris Neville-Smith (Chris NS)

'''Status:''' WIP

'''Length:''' Currently 15 playable sceanrios, including a fork of three paths near the beginning, and another fork of two paths later on.

'''Difficulty:''' Normal

'''Style:''' Mainly Skirmish

'''[http://units.wesnoth.org/1.10/The_Unstoppable_Legion/en_US/The_Unstoppable_Legion.html Custom units]'''

'''Faction/Era:''' Play mounted units, including expanded Cavalryman line, and completely new Bowrider line. Joined later by Dwarves. Main enemies are the dark fighters and dark cultists.

'''Version:''' 0.8.7

=== The White Troll ===

''The story of a white troll whelp with strange magic powers, who is raised in an elvish village.''

'''Author:''' Wesnoth Italian Forum

'''Status:''' Complete

'''Length:''' 8 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default: you play with elves and trolls. Also features custom units with special advancements and abilities.

'''[http://units.wesnoth.org/1.10/White_Troll/en_US/white_troll.html Custom Units]'''

'''Version:''' 0.7.5

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=38828

=== To Lands Unknown ===

''This is the story of Mehir, the Summoner, and his journey to lands unknown.''

'''Author:''' inferno8

'''Status:''' Complete

'''Length:''' 20 scenarios, 4 dialogue only

'''Difficulty:''' Intermediate (Era of Magic)

'''Style''': Skirmish, Dungeon

'''Era:''' Era of Magic

'''Version:''' 1.6.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31799

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#To_Lands_Unknown Players Review]'''

=== Unlikely Alliance ===

''Play as the members of an alliance between the elves, drakes, and undead after the Fall of Wesnoth.''

'''Author:''' Creativity

'''Status:''' Broken ( Abandoned )

'''Length:''' 2 broken scenarios

'''Difficulty:''' Unbalanced

'''Style:''' -

'''Faction/Era:''' -

'''Version:''' 0.1

'''Forum:''' -

'''Note:''' (Adamant14) Did not work at all. Seems abandoned.

=== Up from Slavery ===

''The Orcei are captives in the imperial city of Lavinium, gladiators performing for the emperor Optus Maximus. All it will take, however, is one orc to lead his people to freedom. The Samnis called Sparxus may be that orc.''

'''Author:''' turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 7 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish, Arena (= No recruit, small group gladiator fights)

'''Faction/Era:''' Imperial Era, Orcei Gladiatores

'''Version:''' 0.6.0

'''Note:''' (Maintainer) At some point, I am intending to completely re-work this campaign to be a multi-player campaign, with one side led by Sparxus and one by Gravirivus. If anyone would like to take this on or has ideas for how to accomplish this, let us know. Nevertheless, its playable as a single player campaign now with some nice ideas that could be developed further.]

=== Warmaster ===

''One day the scout of your king brings a mysterious little stone, called Zrai-Stone, back from one of his trips. Soon that stone causes a lot of trouble...''

'''Author:''' Conkinator

'''Maintainer:''' trewe

'''Version:''' 1.3.5

'''Status:''' Finished

'''Length:''' 16 battle + 2 bonus + 1 epilogue scenarios

'''Difficulty:''' Hard

'''Faction:''' Default (loyalists)

'''Style:''' Skirmish, Survival

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=15527

=== Way of Dragon ===

''The story of what might happen if a person against his will transform into a dragon...''

'''Author:''' DrakeDragon

'''Status:''' Complete

'''Length:''' 7 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish/RPG

'''Faction/Era:''' Default Loyalists

'''Version:''' 1.2.0

'''Forum:''' [http://forums.wesnoth.org/viewtopic.php?f=8&t=37876 Wesnoth Forum] [http://uporoom.ru/index.php/topic,179.0.html Russian Forum]

'''Note:''' (Adamant14) Promising short campaign, you play with just a few units.

== Battle for Wesnoth 1.11.x - development ==

''Campaigns available in the 1.11.x development version.''

''Please note: Battle for Wesnoth 1.11.0 features a bug that messes up the selection of difficulty levels.''

=== Antar, Son of Rheor ===

''This is the story about a young Lord and his first mission; sent by his father the young Lord Antar has to relieve his neighbours; he has to convince the Elves and Dwarves to ally him; he has to fight against hordes of Orcs and Endless Undead; and finally he has to defeat Mal Kazur, the mastermind who is behind all the evil.''

'''Author:''' Adamant14

'''Status:''' WIP

'''Length:''' 9 playable scenarios / 1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Loyalists and Elves (feat. fencer as main hero + various allies)

'''Version:''' 0.9.9

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36075

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Antar.2C_Son_of_Rheor Players Review]'''

'''Note:''' (Adamant14) The campaign did not work with BfW version 1.11.0, or BfW version 1.11.1, so please use BfW version 1.11.2 or later!

=== A Song of Fire ===

''''''Part I: The Last War''' - In a long-forgotten era, at the heart of the Great Continent, an ancestral evil is awakened, threatening to destroy the whole world. Follow young Myra in the war that will alter the future of Irdya and its peoples forever.''

''''''Part II: Towards the Rising Sun''' - After the vicious Last War, Myra has become the new leader of Aragwaithi and Windsong alike. Albeit young and shaken by many losses, she must steel herself to lead her people through the vast and hostile Hannuk Steppes. However, her journey will take them all farther than in their wildest dreams. Furthermore, Myra must deal with the evil influence of the mysterious red gem she found after the last battle.''

''''''Part III: Raging Skies''' - The refugees have finally found a new home: families are built, allies are made and, for the first time in years, Myra and her friends know peace. However, when everything seems normal, ambition and thirst for power cause the break out of a continental war. And, amidst this new storm, an old foe rises agan, more powerful than ever. Witness the end of the song of Irdya's first great heroine.''

'''Author:''' revansurik

'''Status:''' Complete

'''Length:''' 36 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Default+War of Legends

'''Version:''' 0.3.4

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=38210

=== Bad Moon Rising ===

''An expedition to gather treasure from the cold north sets off compounding disaster.''

'''Author:''' Doofus-01

'''Status:''' Finished

'''Length:''' 20 scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Archaic Era

'''Version:''' 1.5.8

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31348

=== Birth of a Lich ===

''This is the life story of the dreaded lich Malifor, his struggle as a mage outcast, the orcish conquest of the northlands and his transformation to quench the thirst for revenge''

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 12 playable scenarios / 2 dialogue only

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle, Dungeon

'''Faction/Era:''' Human outlaws, dwarves, undead

'''[http://units.wesnoth.org/1.10/Birth_of_a_Lich/en_US/Birth_of_a_Lich.html Custom Units]

'''Version:''' 1.0.3

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37057

=== Coming of the Storm ===

''A new recruit joins the imperial army, eager to change the world and see combat. Little does he realise just how much action he will get and where his journey will take him. ''

'''Author:''' TrashMan

'''Status:''' WIP

'''Length:''' 26 playable scenarios / 4 dialogue only

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle, Dungeon

'''Faction/Era:''' Default

'''Version:''' 1.2.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23361

=== Legend of Far North ===

''The tale of the legendary Black Eye Karun,depicting his rise to power, his successes and his brutal assassination.'

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 16 playable scenarios / 1 dialogue only,1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Orcs, Trolls, Saurians, Nagas

'''[http://units.wesnoth.org/1.10/Legend_of_Far_North/en_US/Legend_of_Far_North.html Custom Units]'''

'''Version:''' 1.0.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34769

=== Legend of the Invincibles ===

'''''Part I: Shrouded in Darkness''' (5 chapters, 90 scenarios) - A pair of heroes, after stopping an orcish thread, are outcast into caves, where they have no other choice than to become liches in order to survive. They preserved their original appearance and moral principles, and fight in various skirmishes against evil (although using evil methods sometimes), until the Fall, when they are buried alive under the ashes of the third sun.''

'''''Part II: Into the Light''' (4 chapters, 96 scenarios at the moment) - Long after the Fall, the lich heroes awaken. Searching for more power, they manage to resurrect themselves as living beings, but this time more powerful and ridden of the evil within. But the evil from inside them did not cease to exist, and started a campaign to conquer the world. Stopping the campaign caused an even worse disaster...''

'''Author:''' Dugi

'''Status:''' WiP (but Part I might be considered complete)

'''Length:''' 185 (+7 talk-only) scenarios at the moment

'''Difficulty:''' Normal

'''Style:''' mostly Skirmish and Dungeon (all other styles are present as well, but less frequently)

'''Faction/Era:''' Elves, Loyalists, Undead, Dwarves; but they advance past their usual maximum level

'''Version:''' 2.5.0

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Legends_of_the_Invincibles Players Review]'''

'''Note:''' The most unique feature of this campaign is its RPG-like unit development system, enemies drop items units can use, leaders are stronger than most usual units and all units get AMLA (after maximum level advancement) after reaching their maximum level (that is also increased by a load of additional level 4 units).

=== Rebellion in the North ===

''A great orcish uprising tends to destabilise the Northlands. As the future Lord Protector of the Northern Alliance you have to crush the rebellion and establish peace again."

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 24 playable scenarios / 3 dialogue only,2 cutscenes

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Loyalists, Dwarves, Gryphons, Merfolk

'''Version:''' 1.1.12

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=33059

=== Ruthless ===

''A bard (an aging criminal) is walking in wasteland. Nothing but two hands in his pockets, and nothing but stones around. Suddenly he sees a knight on errand--a dangerous opponent, especially in broad daylight. The two strangers are soon sitting by the campfire, and the bard is telling a story.
(Beginner level, 10+ fights).''

'''Author:''' homunculus

'''Status:''' Finished

'''Length:''' 12 playable scenarios + 5 cutscene scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default (Orcs)

'''Version:''' 1.0.4

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37874

'''Note:''' (Adamant14) Recommendable campaign, with smart unusual ideas and a good detailed story.
You fight with few units on small but perfect maps. About the difficulty: The author describes his campaign as 'beginner level', but for me the difficulty is rather NORMAL than EASY.

== [[Guide_to_UMC_Campaigns/Players_Reviews|Player Reviews]] ==

[[Category:Campaigns|*]]

Player UMC Reviews

2013-06-11T13:33:21Z

Pyrophorus: /* After the Storm */

''This is a place where you can add your reviews for the current (1.10.x/1.11.x) UMC campaigns. Please edit, it is a wiki.''

=== Blueprint [add the name of the reviewed campaign here] ===
==== Review by [add your name here] ====

'''Tags:''' * describe the add-on using a few keywords

'''Description:''' * a description of the important things in the add-on, like played faction, kind of enemies, gameplay style, difficulty, etc; should not be copying the author's description or contain too many spoilers

'''Summary:''' * a ''subjective'' description of the things you liked and disliked about the add-on (and why you liked or disliked them), should also contain some kind of overall impression

'''Surroundings:''' * add your rating of the visual part of the add-on here (1-10)

'''Design:''' * add your rating of the general quality of scenarios here (1-10)

'''Story:''' * add your rating of the story's quality here (1-10)

'''Fun:''' * add your rating how much enjoyment did this add-on bring to you here (1-10)

'''Replay value:''' * add your rating about your tendency to play this add-on again here (1-10)

'''Player note:''' * add your overall rating here (1-10)

'''Link to review:''' * if you copied the review from the forums then add the related link here

== Battle for Wesnoth UMC campaign / reviews ==

''Reviews for Campaigns available in the 1.10.x stable and 1.11.x development versions.''

=== After the Storm ===
==== Review by vultraz ====
'''Tags:''' fall, dungeon, elves

'''Description:''' After the Emperor of Chaos was defeated, the free civilizations of the Great Continent hoped that his followers would abandon the ongoing war. Meanwhile, Galas and his unlikely band of heroes head back to the northern lands to request aid for their next journey.

'''Summary:''' This campaign is, in my opinion, one of the very best UMC campaigns. It follows the story of Elynia and her band and their adventures following the events of Invasion from the Unknown. Since the campaign is divided into three episodes, I'll talk about each one separately.

Episode 1: This one starts out slow, but speeds up pretty soon. The first few scenarios capture your attention and want to make you keep playing. It features an appearance of Zocthanol Isle from Under the Burning Suns, which I find quite nice. The late scenarios feature, as in all the episodes, AtS's signature dungeon crawling scenarios, of which I am very fond. My only complaint about this episode would be the third scenario, which is quite tedious after you build up a strong force. Other than that, a good episode.

Episode 2: This episode jumps in right after the cliffhanger end of episode 1, and finds Elynia 1 year into the future as a result of the explosion in Wesmere. We quickly jump right into the action, and discover a very important character in scenario 2. There are a bunch of nice plot points here, including the deal made with the demon lord, and Elynia's journey to the valley from the beginning of IftU. As before, the last few scenarios feature AtS's dungeon crawling, including a very large scenario 10 map. The episode ends on what I consider a beautiful cutscene, one which finishes with a perfect flair.

Episode 3: Shadowmaster truly saved the best for last, here. Several amazing plot points come into play in this scenario, as well as an introducing of many new characters and custom units. This episode brings together almost all the plot threads that had been laid throughout the previous two episodes and IftU and wraps them up in an elegant bow, while at the same time exploring in new directions. Gameplay wise, he managed to keep the scenarios interesting and fun after all this time. More dungeon crawling, and a gigantic final scenario followed by several cutscenes wrap up this amazing campaign. One little complaint might be about scenario 4, which I found quite hard to beat.

All in all, I thoroughly enjoyed this campaign and its story. The maps, characters, and gameplay had me hooked, and I recommend this campaign to anyone.

'''Surroundings:''' 10

'''Design:''' 10

'''Story:''' 10

'''Fun:''' 10

'''Replay value:''' 9

'''Player Note:''' 10

=== A new Order ===
==== Review by Pyrophorus ====

'''Tags:''' Akladians,skirmish,story

'''Description:''' A new Order is a rather long campaign, telling the story of the Akladians reign over Wesnoth. In short, Akladians are a barbarian people, coming from east, flying from slavery, who took control over the decadent Wesnoth kingdom. The story begins later, when Gawen, son of the Akladian king and a Wesnoth noblewoman, have to fight his way to the throne, reconciliate Wesnothians and Akladians to face the threat of a powerful necromancer.

The campaign is a classical skirmish with some large battles, and some riddles to solve. You'll play here Akladian and Khalifate factions.

'''Summary:''' It is one of the more old and mature projects in UMC (eight years old !), polished and enhanced for years, and still actively updated.

At first glance, the story can look classical and boring, but it is one of the best campaign story one can find: interesting and various characters, many plot twists, a real world description make the story really interesting and original. Not for children, as the note says, should be understood as being not the kind of childish fancy most campaigns are built on. Maps and battles have been thoroughly designed and balanced, and everything could be said perfect here, with a slight reservation about graphics (but they're progressing for now).

A classic which many different people can enjoy.

'''Surroundings:''' 8

'''Design:''' 8

'''Story:''' 10

'''Fun:''' 8

'''Replay value:''' 6

'''Player note:''' 10

=== Antar, Son of Rheor ===
==== Review by Dugi ====
'''Tags:''' loyalists, skirmish, dungeon

'''Description:''' A noble's property is attacked by undead, and he has to retaliate in order to stop the undead peril. In his journey, he passes through many other settlements, some of them are attacked by the undead too, some are just naturally hostile, some are corrupted by the promise of immortality the undeath brings and send undead legions to fight him. All of them seem to be just minions of a stronger force, but before he is reached, the end of completed part is here. 9 out of intended 17 scenarios complete.

'''Summary:''' The scenarios are designed very well, assuring that you will not get bored. Many events take place in the middles of scenarios, making scenarios less usual and different from others. Although this is a nice feature, you are frequently surprised by many elements you cannot expect and it breaks planning. There are a few special units, who have special AMLA or some special abilities, that have an unusual and very practical use on the battlefield. It is balanced quite well despite its incompleteness. The story didn't impress me, though. It is very usual, a group of loyalists going to stop a rise of a lich lord whose dreams of conquest are a endangering anyone is classic. Do not expect anything from minor events neither, the encounters in scenarios are pretty mainstream story-wise as well. Unexpected end in the middle of campaign is a really unpleasant surprise too. There is a little need to replay it, because you will know what will happen, and many of these encounters are easy with proper recruits, but maybe a few years will provide a decent amnesia for that. For short, it is a campaign strongly focusing on interesting gameplay, but if you seek heavy challenges or a deeper plot, this is not what you want.

'''Surroundings:''' 7

'''Design:''' 10

'''Story:''' 6

'''Fun:''' 7

'''Replay value:''' 7

'''Player Note:''' 8 (if I forget the missing end, and assume that these scenarios are like the existing ones)

==== Review by tribes55, dean ====
'''"Tags:"''' Adventurous,Intriguing

'''"Description:"''' You play as a limited Loyalist faction, and are mainly fighting Undead, Orcish units and goblins. You have alliances with Dwarves and Elves.

'''"Summary:"''' I liked how the campaign required thinking outside of the box, but I didn't like how on the first scenario there was VERY limited strategies you could use to win. Most scenarios are not like this in this campaign, though.

'''"Surroundings:"''' Your surroundings are constantly changing, but the maps are always interesting and in some scenarios rewarding for exploring them. 8/10

'''"Design:"''' The scenarios aren't repetitive and leave you wanting to play the next campaign. 8/10
Story: Seeing as the story is what makes me want to play the campaign, and this one kept me to the very end of the currently limited scenarios I'd give it story a 8/10.

'''"Fun:"''' * Very rarely was I bored. 7/10
Replay value: * Some scenarios challenge you to do the Scenario in a more efficient way which would make me want to replay the campaign and see what I could do better this time. 7/10

Player note: *
Overall rating would be 8/10.

=== Fate of a princess ===
==== Review by Paulomat4 ====
'''Tags:''' elves, rogues, riders, skirmish, dungeon, RPG

Part I: Baldres, a notorious robber baron, flees Wesnoth with his followers and sets off into the northlands to evade the kings justice. The barons deeds and misdeeds are to change the balance of power between orcs and non-orcs throughout the northlands, and will carry consequences long after his eventual death.
Part II: The Greenwood elves face a crisis which demands the return of the queen's estranged half-elven half-sister, Baldreds daughter. Two brave young elves must make a perilous journey to find her and bring her back to her former home. If they fail, the whole northlands will be engulfed in war with the resurgent orcs...

'''Summary:''' Nice story, which is composed of two parts. In the first part you mainly fight with bandit knights, and often have to rush from one point to another. in the second part, gameplay consists of elves, and various other races like drakes or saurians or dwarves. You will fight various races in the first part, and mostly orcs in the second. The campaign feature many custom units, and some your heroes will even have AMLA advancements. Also you will be able to collect many items through the campaign, which may cause some units to be overpowered but this is also bound to storyline reasons. The story reveals a lot about the northlands and their different factions.

'''Surroundings:''' 8

'''Design:''' 9

'''Story:''' 7

'''Fun:''' 9

'''Replay value:''' 8

'''Player Note:''' 8

=== Invasion from the Unknown ===
==== Review by Dugi ====
'''Tags:''' elves, undead, skirmish, dungeon, puzzle

'''Description:''' Starting with usual elves in forests and deserts, quickly adding the undead faction in a battle against several custom factions, evil human army, mysterious Verlissh, sinister demons, robotic automatons and dreadful, biomechanic Shaxtrals, that progresses through caves and steppes into the mysterious Dark Hive, where the Shadow Master dwells. 30 scenarios. Complete.

'''Summary:''' This campaign has a good and interesting story, enough long to develop an army of recalls an use it well. You will encounter many new kinds of enemies, assuring that you will never get bored, even if you aren't a fan of the default era. Its gameplay is unique in many ways, frequently, the enemies are just coming, and you have to pass through the area instead of defeating some leader. Another speciality are boss fights, when you can defeat a boss only using some special technique. The campaign is also balanced pretty well, easy difficulty is to enjoy the story, hard difficulty is really challenging.
However, almost all new units lack animations of any kind, that harms the visual part of this add-on. Also, some elements of the storyline are too exaggerated. But these little problems will not spoil anything.

'''Surroundings:''' 7

'''Design:''' 10

'''Story:''' 9

'''Fun:''' 10

'''Replay value:''' 7

'''Player Note:''' 10

''Review by Dugi''

=== Legend of the Invincibles ===
==== Review by Raijer ====
'''Description''': A huge campaign that will be 10 chapters long (9 chapters currently), and will have more than 200 scenarios. This campaign follows 2 heroes that find a way to eternal life, going through times, before and after the Fall, and witnessing some of the most important events in Wesnoth's history, like the raise of the second sun.

The player will be able to use humans, elves, but also undead and some special units, and will fight against basically anything you can imagine, going from orcs to demons and passing by some robots. It includes an item system, with enemy drops, crafting and gears, giving additions to units' normal attacks. The history permits to get a huge recall list, with level 4 units in the main races used and new AMLAs possibilities.

'''Summary''': This campaign has a really long story, which explains some of Wesnoth's history that wasn't talked much about in other campaigns. Despite its length, it actually never gets boring because the story is well-done, stays really coherent, but also because of the scenarios' diversity, having huge battles but also some dungeons, and special objectives. I really like how this campaign makes a mix of Wesnoth's turn-based system and the basic RPG's system, like spells, items, crafting and more… But also because it creates new strategies that can't be found in normal campaigns, thanks to the item system and AMLAs that weren't really used in other campaigns, while keeping Wesnoth's basic way of playing. The difficulty is pretty much standard, as easy being easy for everyone, and hard being really hard and most likely a huge tactical challenge. Though some scenarios in normal can be seen as really easy or really hard.

I'm really happy about this campaign because it permits to personalize your units depending on what you want them to be able to do with the AMLAs, but also with the huge item bank. I also liked the story, because i don't like how some part in Wesnoth's history are left unexplained, and this campaign goes through Irdya's history, filling some blanks. Finally, i would like to say that this campaign can be played again and again, as there are some secret scenarios, but also infinite possibilities with the items and AMLAs, which make each time completely different.

The bad sides: the item inventory is slow (seems like it will be fixed), can be really annoying in the later parts. The leaders can seem overpowered to unacquainted players though it changes as you advance. The balance isn't complete yet, but it most likely will be done as soon as the story itself is finished. There still are some bugs around, but none that stops from playing as far as i know.
And last, big problem: THERE'S ONLY 1 CHAPTER LEFT BEFORE THE STORY ENDS!

'''Surroundings''': 7

'''Design''': 7

'''Story''': 10

'''Fun''': 10

'''Replay value''': 9

'''Player note''': 10

==== Review by bumbadadabum ====

'''Description:''' (quoting Raijer) A huge campaign that will be 10 chapters long (9 chapters currently), and will have more than 200 scenarios. This campaign follows 2 heroes that find a way to eternal life, going through times, before and after the Fall, and witnessing some of the most important events in Wesnoth's history, like the raise of the second sun.

The player will be able to use humans, elves, but also undead and some special units, and will fight against basically anything you can imagine, going from orcs to demons and passing by some robots. It includes an item system, with enemy drops, crafting and gears, giving additions to units' normal attacks. The history permits to get a huge recall list, with level 4 units in the main races used and new AMLAs possibilities.

'''Summary:''' I didn't like this campaign a single bit. The scenarios feel like they've been designed 'in a hurry' without paying any attention to detail. The lack of variety or events in scenarios make them very boring to play, and often made me want to just :n and be done with them. The scale of the scenarios is completely blown out of scale, and this makes it extremely tedious to play, as everytime you press the end turn button you have to wait for the literally hundreds of enemies to move. The maps are not horrible, but far from mainline level. The story (which is one of the most important things in a campaign for me) is perhaps one of the worst things about this campaign. The dialog is badly written (in places where it is present. There isn't much dialog outside of starting dialog) and feels completely emotionless. The characters are paper-thin and not very well developed, and that only contributes to my thinking that the entire story is only there to tie the 185 scenarios together. It feels ridiculous and sometimes made me wonder what I was doing with my life, after I read another dialog. The art of the campaign consists mostly of bad frankensteins or horribly drawn units, with the exceptions of the portraits for Efraim and Lethalia, which actually look pretty decent. Overall, I feel like the pretty good idea behind the RPG engine, which in my opinion is also poorly executed, has gone to waste by it being in this campaign. I think this campaign is bad and doesn't deserve any of the praise it often receives on the forums. I would not recommend this campaign to anyone.

'''Surroundings:''' 4

'''Design:''' 2

'''Story:''' 3

'''Fun:''' 3

'''Replay value:''' 4

'''Player note:''' 2

=== Panther Lord ===
==== Review by taptap ====

Panther Lord is one of my favourite campaigns and on higher difficulties one of the most challenging. Unlike many campaigns with an anticlimactic end (Northern Rebirth, Heir to the Throne etc.) it is unrelenting from start until the end (I suffered more than 140 casualties during its 14 scenarios). Velensk is a good player and it shows.

This is the showcase campaign for the Era of Four Moons, while Salt Wars is a short and much easier introduction. The Era itself is well balanced, with many novel ideas and no elves. Admittedly, at first I shuddered at the idea of playing "half-naked wild with dark-coloured sprites" - I was quite troubled that it might be a collection of racist stereotypes, but playing with it, it certainly didn't feel so. (Much better indeed than the typical association of orcs in Tolkien-esque fantasy with mongols / turks.) There aren't only tribal Darklanders and Highlanders, but Sea States and Imperialists as well. Each of them plays very differently, none of them is depicted as timeless or "always chaotic evil", even the Imperialists, the enemies in the campaign, get the opportunity to declare themselves. It certainly benefits from the background world (IALFA developed by the maintainer of the campaign) even if you only see a glimpse of it.

The hero of the campaign is a mercenary outcast of his own Darklander civilization. When learning about plans to raze and colonize the jungles of his people by the imperialists he starts the quest to rescue his people. His friend the Panther spirit, to whom the campaign owes its name, always at his side, he is rallying troops and mercenaries around him, but soon he has to realize that change is inevitable. Changing their ways they may have hope to withstand or else they will be changed by force and subjugation. But how to convince his own people when he is an upstart at best, a traitor and spirit-friend at worst?

While the campaign is centered around Darklanders, the player has the choice of hiring (and recalling) a limited amount of highly useful mercenaries of the other factions of the Era. The campaign features small scale to a few large scale battles and puts different territory to good use encouraging the use of mercenaries and different unit types. I omit the numbers, but this campaign is certainly recommended.

=== Swamplings ===
==== Review by Dunno ====
'''Description:''' Swamplings is the name of goblin tribe living in swamps, banished by orcs. In an unfortunate turn of events, those goblins get tangled up in human affairs and must fight for their very survival. The player also learns how goblins started riding wolves.

'''Summary:''' It's a decent, finished and stable campaign with interesting plot. There are many humorous scenes and some serious ones, there are standard battle scenarios and various original missions. There are also some high quality custom sprites, and maps are very good as well. It won't make your jaw drop, however, it's just a modest, enjoyable campaign.

'''Surroundings:''' 7

'''Design:''' 8

'''Story:''' 8

'''Fun:''' 9

==== Review by Pyrophorus ====

'''Tags:''' goblins,skirmish,story

'''Description:''' see previous review.

'''Summary:''' This campaign is very original and imaginative. First of all, it features not chivalrous heroes like most Wesnoth campaigns, but humble and rather stubborn people instead. More of it, the story is much more picaresque than epic, written in a delicious humorous tone, very unusual in Wesnoth world. IMO, it's one of the few really good writing one can find here. It's impossible to abstract this complex story, where everything goes in an unexpected way, to list every strange encounter, funny event and so on. If you like good writing, humor, as well as hardcore fighting, you'll really love this campaign. If not, just as Dunno says, it's honest, no more.

'''Surroundings:''' 7

'''Design:''' 8

'''Story:''' 10

'''Fun:''' 10

'''Replay value:''' 7

=== Talentless Mage ===
==== Review by Dunno ====
'''Description:''' A humorous story about a mage who managed to learn only one spell in his life and who takes command of N.O.O.B.S. (Noticeably - Optimal - Outstanding - Brilliant - Soldiers) squad. N.O.O.B.S. advance through amla with basic options like melee attack, melee damage etc.

'''Summary:''' this here is Wesnoth parody at its best. The campaign mocks the common cliches in Wesnoth campaigns and overused events, like loyal units coming out of villages, random magical items scattered around the map and low quality frankensprites. Very absurd and pythonesque at times, you will keep smiling and laughing through the whole story.

'''Surroundings:''' 6

'''Design:''' 8

'''Story:''' 9

'''Fun:''' 10

=== The Library of Kratemaqht ===
==== Review by Wesbane ====
The campaign is about genesis, course and outcome of civil war in empire of Anaktoron.
Surroundings:
The way campaign looks. How it feels and uses game engine is simply amazing and unseen before.
Maps are nicely done although many parts of a map serve for story (decorative) purpose only what is not always good. You will travel through wealthy and populous kingdom which is torn apart by war. To create this impression in most of maps there is a lot of villages and they are placed in large groups, but map look doesn't suffer from it. More over you can feel destruction in game world as never before. Campaign features custom burning houses which are not only mere visual effect but have impact on battle course.
It is one of most cinematic campaigns if not the most. Cutscenes are packed with action and take place in several locations. Also game transition fluently into cutscene and cutscene into game. What makes it even more interesting since you will never know is it just a cutscene?
In terms of visual effects it also features the best epilogue ever.
As it was not enough you can experience a true wesnoth dragon. It is so unusual that it need separate mention.
Dragon is fully animated and have some nice custom sounds. Some of it animations are purely character play. Like roar and feasting. And last, but not least it preserves original wesnoth dragon concepts. It attacks with fangs and tail. Although it primary weapon is ranged magical fire breath which works as AoE attack when used offensively. There is one little bug with its animation, but it can't be noticed during playing it anyway.
In short this campaign surely establish new standards for wesnoth in department of visuals.
Design:
Scenarios design is good. All levels are playable. Objectives are clearly formed, so it is known most of the time what to do. There are several minor bugs and one bigger that affects game to some degree. However they do not make impossible to play and enjoy campaign.
Campaign is using default units although sometimes with unusual traits and abilities. Custom units are also present, but only as much as they are needed. Which is a great thing since it proves designer skill at using available resources. Beside that I really can't stand campaigns introducing many user made units.
I liked much idea of premagic era and weakened magic users. Unfortunately any extra mages aren't useful since you have already better characters of this class. In fact after my recall list was cleaned up after Jevyans Return I never bothered to recruit them again.
Gold carryover system is custom which is not a good choice for classic style adventure. Twenty percent instead of forty. Most probably this is caused by slightly overpopulated maps. Campaign is very easy, except two scenarios: Refugees and Loyalty's Cruel Reward. There is no moderately difficult scenarios. The huge difference between average level difficulty and hardest level is just to big. Most difficult scenarios are Refugees and Loyaltys Cruel Reward.
Story:
Amount of delivered information is enough. Writing style is good. Beginning is terrific. Switching between protagonists is cool, and quite innovative idea. Overall concept is nicely executed and creator skillfully merged a lot of facts from mainline into own story. To fully appreciate this playing The Rise of Wesnoth is recommended. However ending I found disappointing. It seemed rushed and unconvincing. Also few details don't match to reality of Irdya.
Fun:
Campaign is definitely entertaining. Well done battles. Good dialog. And full of fresh ideas. You can play as good and bad in a single campaign! Although I have nothing against being awesome most of the time enemies fell way to easily to my taste.
Replay value:
Campaign is nicely done and straight forward. Although there is nothing that would reject you from playing it again, there is nothing that would encourage you to do that either. No hidden secrets, no tactical challenges, no extra levels. No satisfying ending.

Summary:
Overall it is well made, really great, easy campaign suitable for beginners with story explaining some events from The Rise of Wesnoth. Bringing new standards in design, especially visual ones. It story is shown from several angles what is unique feature, but unfortunately potential of this solution wasn't used at all. If you are looking for deep plot, and tactical challenge you won't find it here.

'''Surroundings: 10

'''Design: 6

'''Story: 7

'''Fun: 7

'''Replay value: 5

'''Campaign score: 7

'''Player note: 8

'''Link to review:''' [http://forums.wesnoth.org/viewtopic.php?f=8&t=37798&start=45#p551674]

=== To Lands Unknown ===
==== Review by Dunno ====
'''Description:''' This campaign tells about Mehir, a Summoner, who's working on a great quest of making the biggest magical circle ever made. If he and other summoners succeed, activating the circle will bring them to the Abyss, the lands unknown.

'''Summary:''' The main idea behind this campaign and the Era of Magic (used by To Lands Unknown) is to take Wesnoth graphics to an entirely new level. Maps are no longer simple, repetitive hexes, instead many maps are absolutely mindblowing landscapes. In addition, all units are well made and animated. The story and gameplay, however, could have been done better. The campaign is quite long, and at times battles get boring.

'''Surroundings:''' 10

'''Design:''' 7

'''Story:''' 5

'''Fun:''' 6

== Back to Guide to UMC Campaigns ==
* '''[http://wiki.wesnoth.org/index.php?title=Guide_to_UMC_Campaigns Guide to UMC Campaigns]'''

== Feedback Thread ==
If you have criticism, ideas and suggestions then please post it in the feedback thread.

Or maybe you don't want, or don't know how to edit the wiki page, then you can post your review also here. I will add it then to this page.
* '''[http://forums.wesnoth.org/viewtopic.php?f=17&t=38946 Feedback Thread]'''

Player UMC Reviews

2013-06-11T12:51:39Z

Pyrophorus: /* Swamplings */

''This is a place where you can add your reviews for the current (1.10.x/1.11.x) UMC campaigns. Please edit, it is a wiki.''

=== Blueprint [add the name of the reviewed campaign here] ===
==== Review by [add your name here] ====

'''Tags:''' * describe the add-on using a few keywords

'''Description:''' * a description of the important things in the add-on, like played faction, kind of enemies, gameplay style, difficulty, etc; should not be copying the author's description or contain too many spoilers

'''Summary:''' * a ''subjective'' description of the things you liked and disliked about the add-on (and why you liked or disliked them), should also contain some kind of overall impression

'''Surroundings:''' * add your rating of the visual part of the add-on here (1-10)

'''Design:''' * add your rating of the general quality of scenarios here (1-10)

'''Story:''' * add your rating of the story's quality here (1-10)

'''Fun:''' * add your rating how much enjoyment did this add-on bring to you here (1-10)

'''Replay value:''' * add your rating about your tendency to play this add-on again here (1-10)

'''Player note:''' * add your overall rating here (1-10)

'''Link to review:''' * if you copied the review from the forums then add the related link here

== Battle for Wesnoth UMC campaign / reviews ==

''Reviews for Campaigns available in the 1.10.x stable and 1.11.x development versions.''

=== After the Storm ===
==== Review by vultraz ====
'''Tags:''' fall, dungeon, elves

'''Description:''' After the Emperor of Chaos was defeated, the free civilizations of the Great Continent hoped that his followers would abandon the ongoing war. Meanwhile, Galas and his unlikely band of heroes head back to the northern lands to request aid for their next journey.

'''Summary:''' This campaign is, in my opinion, one of the very best UMC campaigns. It follows the story of Elynia and her band and their adventures following the events of Invasion from the Unknown. Since the campaign is divided into three episodes, I'll talk about each one separately.

Episode 1: This one starts out slow, but speeds up pretty soon. The first few scenarios capture your attention and want to make you keep playing. It features an appearance of Zocthanol Isle from Under the Burning Suns, which I find quite nice. The late scenarios feature, as in all the episodes, AtS's signature dungeon crawling scenarios, of which I am very fond. My only complaint about this episode would be the third scenario, which is quite tedious after you build up a strong force. Other than that, a good episode.

Episode 2: This episode jumps in right after the cliffhanger end of episode 1, and finds Elynia 1 year into the future as a result of the explosion in Wesmere. We quickly jump right into the action, and discover a very important character in scenario 2. There are a bunch of nice plot points here, including the deal made with the demon lord, and Elynia's journey to the valley from the beginning of IftU. As before, the last few scenarios feature AtS's dungeon crawling, including a very large scenario 10 map. The episode ends on what I consider a beautiful cutscene, one which finishes with a perfect flair.

Episode 3: Shadowmaster truly saved the best for last, here. Several amazing plot points come into play in this scenario, as well as an introducing of many new characters and custom units. This episode brings together almost all the plot threads that had been laid throughout the previous two episodes and IftU and wraps them up in an elegant bow, while at the same time exploring in new directions. Gameplay wise, he managed to keep the scenarios interesting and fun after all this time. More dungeon crawling, and a gigantic final scenario followed by several cutscenes wrap up this amazing campaign. One little complaint might be about scenario 4, which I found quite hard to beat.

All in all, I thoroughly enjoyed this campaign and its story. The maps, characters, and gameplay had me hooked, and I recommend this campaign to anyone.

'''Surroundings:''' 10

'''Design:''' 10

'''Story:''' 10

'''Fun:''' 10

'''Replay value:''' 9

'''Player Note:''' 10

=== Antar, Son of Rheor ===
==== Review by Dugi ====
'''Tags:''' loyalists, skirmish, dungeon

'''Description:''' A noble's property is attacked by undead, and he has to retaliate in order to stop the undead peril. In his journey, he passes through many other settlements, some of them are attacked by the undead too, some are just naturally hostile, some are corrupted by the promise of immortality the undeath brings and send undead legions to fight him. All of them seem to be just minions of a stronger force, but before he is reached, the end of completed part is here. 9 out of intended 17 scenarios complete.

'''Summary:''' The scenarios are designed very well, assuring that you will not get bored. Many events take place in the middles of scenarios, making scenarios less usual and different from others. Although this is a nice feature, you are frequently surprised by many elements you cannot expect and it breaks planning. There are a few special units, who have special AMLA or some special abilities, that have an unusual and very practical use on the battlefield. It is balanced quite well despite its incompleteness. The story didn't impress me, though. It is very usual, a group of loyalists going to stop a rise of a lich lord whose dreams of conquest are a endangering anyone is classic. Do not expect anything from minor events neither, the encounters in scenarios are pretty mainstream story-wise as well. Unexpected end in the middle of campaign is a really unpleasant surprise too. There is a little need to replay it, because you will know what will happen, and many of these encounters are easy with proper recruits, but maybe a few years will provide a decent amnesia for that. For short, it is a campaign strongly focusing on interesting gameplay, but if you seek heavy challenges or a deeper plot, this is not what you want.

'''Surroundings:''' 7

'''Design:''' 10

'''Story:''' 6

'''Fun:''' 7

'''Replay value:''' 7

'''Player Note:''' 8 (if I forget the missing end, and assume that these scenarios are like the existing ones)

==== Review by tribes55, dean ====
'''"Tags:"''' Adventurous,Intriguing

'''"Description:"''' You play as a limited Loyalist faction, and are mainly fighting Undead, Orcish units and goblins. You have alliances with Dwarves and Elves.

'''"Summary:"''' I liked how the campaign required thinking outside of the box, but I didn't like how on the first scenario there was VERY limited strategies you could use to win. Most scenarios are not like this in this campaign, though.

'''"Surroundings:"''' Your surroundings are constantly changing, but the maps are always interesting and in some scenarios rewarding for exploring them. 8/10

'''"Design:"''' The scenarios aren't repetitive and leave you wanting to play the next campaign. 8/10
Story: Seeing as the story is what makes me want to play the campaign, and this one kept me to the very end of the currently limited scenarios I'd give it story a 8/10.

'''"Fun:"''' * Very rarely was I bored. 7/10
Replay value: * Some scenarios challenge you to do the Scenario in a more efficient way which would make me want to replay the campaign and see what I could do better this time. 7/10

Player note: *
Overall rating would be 8/10.

=== Fate of a princess ===
==== Review by Paulomat4 ====
'''Tags:''' elves, rogues, riders, skirmish, dungeon, RPG

Part I: Baldres, a notorious robber baron, flees Wesnoth with his followers and sets off into the northlands to evade the kings justice. The barons deeds and misdeeds are to change the balance of power between orcs and non-orcs throughout the northlands, and will carry consequences long after his eventual death.
Part II: The Greenwood elves face a crisis which demands the return of the queen's estranged half-elven half-sister, Baldreds daughter. Two brave young elves must make a perilous journey to find her and bring her back to her former home. If they fail, the whole northlands will be engulfed in war with the resurgent orcs...

'''Summary:''' Nice story, which is composed of two parts. In the first part you mainly fight with bandit knights, and often have to rush from one point to another. in the second part, gameplay consists of elves, and various other races like drakes or saurians or dwarves. You will fight various races in the first part, and mostly orcs in the second. The campaign feature many custom units, and some your heroes will even have AMLA advancements. Also you will be able to collect many items through the campaign, which may cause some units to be overpowered but this is also bound to storyline reasons. The story reveals a lot about the northlands and their different factions.

'''Surroundings:''' 8

'''Design:''' 9

'''Story:''' 7

'''Fun:''' 9

'''Replay value:''' 8

'''Player Note:''' 8

=== Invasion from the Unknown ===
==== Review by Dugi ====
'''Tags:''' elves, undead, skirmish, dungeon, puzzle

'''Description:''' Starting with usual elves in forests and deserts, quickly adding the undead faction in a battle against several custom factions, evil human army, mysterious Verlissh, sinister demons, robotic automatons and dreadful, biomechanic Shaxtrals, that progresses through caves and steppes into the mysterious Dark Hive, where the Shadow Master dwells. 30 scenarios. Complete.

'''Summary:''' This campaign has a good and interesting story, enough long to develop an army of recalls an use it well. You will encounter many new kinds of enemies, assuring that you will never get bored, even if you aren't a fan of the default era. Its gameplay is unique in many ways, frequently, the enemies are just coming, and you have to pass through the area instead of defeating some leader. Another speciality are boss fights, when you can defeat a boss only using some special technique. The campaign is also balanced pretty well, easy difficulty is to enjoy the story, hard difficulty is really challenging.
However, almost all new units lack animations of any kind, that harms the visual part of this add-on. Also, some elements of the storyline are too exaggerated. But these little problems will not spoil anything.

'''Surroundings:''' 7

'''Design:''' 10

'''Story:''' 9

'''Fun:''' 10

'''Replay value:''' 7

'''Player Note:''' 10

''Review by Dugi''

=== Legend of the Invincibles ===
==== Review by Raijer ====
'''Description''': A huge campaign that will be 10 chapters long (9 chapters currently), and will have more than 200 scenarios. This campaign follows 2 heroes that find a way to eternal life, going through times, before and after the Fall, and witnessing some of the most important events in Wesnoth's history, like the raise of the second sun.

The player will be able to use humans, elves, but also undead and some special units, and will fight against basically anything you can imagine, going from orcs to demons and passing by some robots. It includes an item system, with enemy drops, crafting and gears, giving additions to units' normal attacks. The history permits to get a huge recall list, with level 4 units in the main races used and new AMLAs possibilities.

'''Summary''': This campaign has a really long story, which explains some of Wesnoth's history that wasn't talked much about in other campaigns. Despite its length, it actually never gets boring because the story is well-done, stays really coherent, but also because of the scenarios' diversity, having huge battles but also some dungeons, and special objectives. I really like how this campaign makes a mix of Wesnoth's turn-based system and the basic RPG's system, like spells, items, crafting and more… But also because it creates new strategies that can't be found in normal campaigns, thanks to the item system and AMLAs that weren't really used in other campaigns, while keeping Wesnoth's basic way of playing. The difficulty is pretty much standard, as easy being easy for everyone, and hard being really hard and most likely a huge tactical challenge. Though some scenarios in normal can be seen as really easy or really hard.

I'm really happy about this campaign because it permits to personalize your units depending on what you want them to be able to do with the AMLAs, but also with the huge item bank. I also liked the story, because i don't like how some part in Wesnoth's history are left unexplained, and this campaign goes through Irdya's history, filling some blanks. Finally, i would like to say that this campaign can be played again and again, as there are some secret scenarios, but also infinite possibilities with the items and AMLAs, which make each time completely different.

The bad sides: the item inventory is slow (seems like it will be fixed), can be really annoying in the later parts. The leaders can seem overpowered to unacquainted players though it changes as you advance. The balance isn't complete yet, but it most likely will be done as soon as the story itself is finished. There still are some bugs around, but none that stops from playing as far as i know.
And last, big problem: THERE'S ONLY 1 CHAPTER LEFT BEFORE THE STORY ENDS!

'''Surroundings''': 7

'''Design''': 7

'''Story''': 10

'''Fun''': 10

'''Replay value''': 9

'''Player note''': 10

==== Review by bumbadadabum ====

'''Description:''' (quoting Raijer) A huge campaign that will be 10 chapters long (9 chapters currently), and will have more than 200 scenarios. This campaign follows 2 heroes that find a way to eternal life, going through times, before and after the Fall, and witnessing some of the most important events in Wesnoth's history, like the raise of the second sun.

The player will be able to use humans, elves, but also undead and some special units, and will fight against basically anything you can imagine, going from orcs to demons and passing by some robots. It includes an item system, with enemy drops, crafting and gears, giving additions to units' normal attacks. The history permits to get a huge recall list, with level 4 units in the main races used and new AMLAs possibilities.

'''Summary:''' I didn't like this campaign a single bit. The scenarios feel like they've been designed 'in a hurry' without paying any attention to detail. The lack of variety or events in scenarios make them very boring to play, and often made me want to just :n and be done with them. The scale of the scenarios is completely blown out of scale, and this makes it extremely tedious to play, as everytime you press the end turn button you have to wait for the literally hundreds of enemies to move. The maps are not horrible, but far from mainline level. The story (which is one of the most important things in a campaign for me) is perhaps one of the worst things about this campaign. The dialog is badly written (in places where it is present. There isn't much dialog outside of starting dialog) and feels completely emotionless. The characters are paper-thin and not very well developed, and that only contributes to my thinking that the entire story is only there to tie the 185 scenarios together. It feels ridiculous and sometimes made me wonder what I was doing with my life, after I read another dialog. The art of the campaign consists mostly of bad frankensteins or horribly drawn units, with the exceptions of the portraits for Efraim and Lethalia, which actually look pretty decent. Overall, I feel like the pretty good idea behind the RPG engine, which in my opinion is also poorly executed, has gone to waste by it being in this campaign. I think this campaign is bad and doesn't deserve any of the praise it often receives on the forums. I would not recommend this campaign to anyone.

'''Surroundings:''' 4

'''Design:''' 2

'''Story:''' 3

'''Fun:''' 3

'''Replay value:''' 4

'''Player note:''' 2

=== Panther Lord ===
==== Review by taptap ====

Panther Lord is one of my favourite campaigns and on higher difficulties one of the most challenging. Unlike many campaigns with an anticlimactic end (Northern Rebirth, Heir to the Throne etc.) it is unrelenting from start until the end (I suffered more than 140 casualties during its 14 scenarios). Velensk is a good player and it shows.

This is the showcase campaign for the Era of Four Moons, while Salt Wars is a short and much easier introduction. The Era itself is well balanced, with many novel ideas and no elves. Admittedly, at first I shuddered at the idea of playing "half-naked wild with dark-coloured sprites" - I was quite troubled that it might be a collection of racist stereotypes, but playing with it, it certainly didn't feel so. (Much better indeed than the typical association of orcs in Tolkien-esque fantasy with mongols / turks.) There aren't only tribal Darklanders and Highlanders, but Sea States and Imperialists as well. Each of them plays very differently, none of them is depicted as timeless or "always chaotic evil", even the Imperialists, the enemies in the campaign, get the opportunity to declare themselves. It certainly benefits from the background world (IALFA developed by the maintainer of the campaign) even if you only see a glimpse of it.

The hero of the campaign is a mercenary outcast of his own Darklander civilization. When learning about plans to raze and colonize the jungles of his people by the imperialists he starts the quest to rescue his people. His friend the Panther spirit, to whom the campaign owes its name, always at his side, he is rallying troops and mercenaries around him, but soon he has to realize that change is inevitable. Changing their ways they may have hope to withstand or else they will be changed by force and subjugation. But how to convince his own people when he is an upstart at best, a traitor and spirit-friend at worst?

While the campaign is centered around Darklanders, the player has the choice of hiring (and recalling) a limited amount of highly useful mercenaries of the other factions of the Era. The campaign features small scale to a few large scale battles and puts different territory to good use encouraging the use of mercenaries and different unit types. I omit the numbers, but this campaign is certainly recommended.

=== Swamplings ===
==== Review by Dunno ====
'''Description:''' Swamplings is the name of goblin tribe living in swamps, banished by orcs. In an unfortunate turn of events, those goblins get tangled up in human affairs and must fight for their very survival. The player also learns how goblins started riding wolves.

'''Summary:''' It's a decent, finished and stable campaign with interesting plot. There are many humorous scenes and some serious ones, there are standard battle scenarios and various original missions. There are also some high quality custom sprites, and maps are very good as well. It won't make your jaw drop, however, it's just a modest, enjoyable campaign.

'''Surroundings:''' 7

'''Design:''' 8

'''Story:''' 8

'''Fun:''' 9

==== Review by Pyrophorus ====

'''Tags:''' goblins,skirmish,story

'''Description:''' see previous review.

'''Summary:''' This campaign is very original and imaginative. First of all, it features not chivalrous heroes like most Wesnoth campaigns, but humble and rather stubborn people instead. More of it, the story is much more picaresque than epic, written in a delicious humorous tone, very unusual in Wesnoth world. IMO, it's one of the few really good writing one can find here. It's impossible to abstract this complex story, where everything goes in an unexpected way, to list every strange encounter, funny event and so on. If you like good writing, humor, as well as hardcore fighting, you'll really love this campaign. If not, just as Dunno says, it's honest, no more.

'''Surroundings:''' 7

'''Design:''' 8

'''Story:''' 10

'''Fun:''' 10

'''Replay value:''' 7

=== Talentless Mage ===
==== Review by Dunno ====
'''Description:''' A humorous story about a mage who managed to learn only one spell in his life and who takes command of N.O.O.B.S. (Noticeably - Optimal - Outstanding - Brilliant - Soldiers) squad. N.O.O.B.S. advance through amla with basic options like melee attack, melee damage etc.

'''Summary:''' this here is Wesnoth parody at its best. The campaign mocks the common cliches in Wesnoth campaigns and overused events, like loyal units coming out of villages, random magical items scattered around the map and low quality frankensprites. Very absurd and pythonesque at times, you will keep smiling and laughing through the whole story.

'''Surroundings:''' 6

'''Design:''' 8

'''Story:''' 9

'''Fun:''' 10

=== The Library of Kratemaqht ===
==== Review by Wesbane ====
The campaign is about genesis, course and outcome of civil war in empire of Anaktoron.
Surroundings:
The way campaign looks. How it feels and uses game engine is simply amazing and unseen before.
Maps are nicely done although many parts of a map serve for story (decorative) purpose only what is not always good. You will travel through wealthy and populous kingdom which is torn apart by war. To create this impression in most of maps there is a lot of villages and they are placed in large groups, but map look doesn't suffer from it. More over you can feel destruction in game world as never before. Campaign features custom burning houses which are not only mere visual effect but have impact on battle course.
It is one of most cinematic campaigns if not the most. Cutscenes are packed with action and take place in several locations. Also game transition fluently into cutscene and cutscene into game. What makes it even more interesting since you will never know is it just a cutscene?
In terms of visual effects it also features the best epilogue ever.
As it was not enough you can experience a true wesnoth dragon. It is so unusual that it need separate mention.
Dragon is fully animated and have some nice custom sounds. Some of it animations are purely character play. Like roar and feasting. And last, but not least it preserves original wesnoth dragon concepts. It attacks with fangs and tail. Although it primary weapon is ranged magical fire breath which works as AoE attack when used offensively. There is one little bug with its animation, but it can't be noticed during playing it anyway.
In short this campaign surely establish new standards for wesnoth in department of visuals.
Design:
Scenarios design is good. All levels are playable. Objectives are clearly formed, so it is known most of the time what to do. There are several minor bugs and one bigger that affects game to some degree. However they do not make impossible to play and enjoy campaign.
Campaign is using default units although sometimes with unusual traits and abilities. Custom units are also present, but only as much as they are needed. Which is a great thing since it proves designer skill at using available resources. Beside that I really can't stand campaigns introducing many user made units.
I liked much idea of premagic era and weakened magic users. Unfortunately any extra mages aren't useful since you have already better characters of this class. In fact after my recall list was cleaned up after Jevyans Return I never bothered to recruit them again.
Gold carryover system is custom which is not a good choice for classic style adventure. Twenty percent instead of forty. Most probably this is caused by slightly overpopulated maps. Campaign is very easy, except two scenarios: Refugees and Loyalty's Cruel Reward. There is no moderately difficult scenarios. The huge difference between average level difficulty and hardest level is just to big. Most difficult scenarios are Refugees and Loyaltys Cruel Reward.
Story:
Amount of delivered information is enough. Writing style is good. Beginning is terrific. Switching between protagonists is cool, and quite innovative idea. Overall concept is nicely executed and creator skillfully merged a lot of facts from mainline into own story. To fully appreciate this playing The Rise of Wesnoth is recommended. However ending I found disappointing. It seemed rushed and unconvincing. Also few details don't match to reality of Irdya.
Fun:
Campaign is definitely entertaining. Well done battles. Good dialog. And full of fresh ideas. You can play as good and bad in a single campaign! Although I have nothing against being awesome most of the time enemies fell way to easily to my taste.
Replay value:
Campaign is nicely done and straight forward. Although there is nothing that would reject you from playing it again, there is nothing that would encourage you to do that either. No hidden secrets, no tactical challenges, no extra levels. No satisfying ending.

Summary:
Overall it is well made, really great, easy campaign suitable for beginners with story explaining some events from The Rise of Wesnoth. Bringing new standards in design, especially visual ones. It story is shown from several angles what is unique feature, but unfortunately potential of this solution wasn't used at all. If you are looking for deep plot, and tactical challenge you won't find it here.

'''Surroundings: 10

'''Design: 6

'''Story: 7

'''Fun: 7

'''Replay value: 5

'''Campaign score: 7

'''Player note: 8

'''Link to review:''' [http://forums.wesnoth.org/viewtopic.php?f=8&t=37798&start=45#p551674]

=== To Lands Unknown ===
==== Review by Dunno ====
'''Description:''' This campaign tells about Mehir, a Summoner, who's working on a great quest of making the biggest magical circle ever made. If he and other summoners succeed, activating the circle will bring them to the Abyss, the lands unknown.

'''Summary:''' The main idea behind this campaign and the Era of Magic (used by To Lands Unknown) is to take Wesnoth graphics to an entirely new level. Maps are no longer simple, repetitive hexes, instead many maps are absolutely mindblowing landscapes. In addition, all units are well made and animated. The story and gameplay, however, could have been done better. The campaign is quite long, and at times battles get boring.

'''Surroundings:''' 10

'''Design:''' 7

'''Story:''' 5

'''Fun:''' 6

== Back to Guide to UMC Campaigns ==
* '''[http://wiki.wesnoth.org/index.php?title=Guide_to_UMC_Campaigns Guide to UMC Campaigns]'''

== Feedback Thread ==
If you have criticism, ideas and suggestions then please post it in the feedback thread.

Or maybe you don't want, or don't know how to edit the wiki page, then you can post your review also here. I will add it then to this page.
* '''[http://forums.wesnoth.org/viewtopic.php?f=17&t=38946 Feedback Thread]'''

Guide to UMC Content

2013-06-04T10:08:20Z

Pyrophorus: /* Birth of a Lich */

''This is a guide to the current (1.10.x/1.11.x) UMC campaigns for players. It aims to provide all the information not only about the story, but also about completion, difficulty and playing style of the campaign. See http://forums.wesnoth.org/viewtopic.php?f=8&t=37476 for further information, for currently non-available UMC-content please refer to http://forums.wesnoth.org/viewtopic.php?f=8&t=36733. Please edit, it is a wiki.''

=== Blueprint ===

'''Status:'''
* Broken = Does not work at all
* Incomplete = Partially written, no progress
* WIP = Partially written, progress
* Complete = Completely written, but buggy as well as potential balance issues.
* Finished = Completely written, minimal to no bugs, slight balance issues possible.

'''Length:'''

'''Author:'''

'''Maintainer:''' if not maintained by the author anymore.

'''Description:'''

'''Version: '''

'''Requirements:'''

'''Difficulty:'''

Please note: Often campaigns introducing new mechanics are listed as expert level on the add-on server, here difficulty means the raw difficulty after the mechanics are understood.

* Unbalanced = If you can't beat the hard mode, it isn't necessarily unbalanced, but if the difficulty changes erraticly from one scenario to the next and only people using the debug mode have seen the final, then it is.
* Easy
* Normal
* Hard

'''Style:'''

Please note: Many campaigns will feature more than one style. Please list the most significant ones.

* Skirmish = small to medium sized armies, your standard Wesnoth gameplay
* Dungeon = long and narrow tunnels (not every underground scenario is a dungeon, a dungeon isn't necessarily underground)
* RPG = role playing game elements such as talking with non-player-characters, item collection, dependency on a party of very few adventurers without or limited recruits
* Survival = being exposed to changing, spawning enemies while remaining on the same map
* Large Battle = large number of units on the battlefield, sizely maps
* Simulation = campaigns feat. terrain modification, alternative resources
* Boss battle = the challenge is to defeat a single powerful enemy unit
* Minigames = there are puzzles and minigames in the campaign that significantly differ from standard Wesnoth gameplay

'''Faction/Era:'''

* Era for the whole campaign and more specifically the faction or unit composition you field.

'''Custom units:'''

* Link to the unit tree for cases that don't feel sufficiently described by Faction / Era entry.

'''Forum:'''

* Links to the feedback and development threads at forums.wesnoth.org

== Battle for Wesnoth 1.10.x - stable ==

''Campaigns available in the 1.10.x stable version.''

=== Aldur The Great ===

''This is a story about Aldur the Great.''

'''Author:''' pintercsabi

'''Status:''' Complete, but unbalanced

'''Length:''' 5 playable scenarios

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish

'''Faction/Era:''' Default

'''Version:''' 1.2.2

'''Forum:''' -

'''Note:''' (Adamant14) Short unbalanced campaign, maybe abandoned. You fight with Peasants, Ruffians and Woodsman against Orcs

=== Alfhelm the Wise ===

''This is the tale of Alfhelm, called by some the Wise, son of Alfric Conqueror. This is the tale of his victories over his enemies, and his rise to power in the clans of Marauderdom. This is the tale of his journey south and his destruction of the Lavinian Empire. And this is the tale of his demise in the dark forests far to the east of his homeland.''

'''Author:''' turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 15 gameplay scenarios

'''Difficulty:''' Moderate

'''Style:''' Skirmish

'''Faction/Era:''' Imperial Era, Marauders.

'''Version:''' 0.6.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=17144

'''Note:''' (Maintainer) Though this campaign is complete and playable the whole way through, the code is four years old and pretty buggy. If you notice any errors while playing, please let me know and I'll incorporate the fixes into my next revision as soon as possible.]

=== A New Order ===

'''Author:''' szopen

'''Status:''' Finished.

'''Length:''' 45 scenarios.

'''Description:''' The old kingdom of Wesnoth has fallen before barbarian hordes. The occupying barbarians are on the brink of civil war, the seeds of Wesnothian rebellion are kept alive by old legends, while bandits and Khalifate mercenaries roam the land. Can Gawen Hagarthen unite these disparate factions against a common foe?
Note: This campaign contains mature themes, some of which may be unsuitable for children.

'''Version: ''' 1.2.15

'''Requirements:''' Requires BfW 1.10. In addition, you have to install Era Khalifate add-on; the Akladian Music package is optional

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Akladians, Khalifate

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=6486

'''Note:''' (Pyrophorus) Certainly one of the most mature and well designed campaign in add-ons. A must.

=== Antar, Son of Rheor ===

''This is the story about a young Lord and his first mission; sent by his father the young Lord Antar has to relieve his neighbours; he has to convince the Elves and Dwarves to ally him; he has to fight against hordes of Orcs and Endless Undead; and finally he has to defeat Mal Kazur, the mastermind who is behind all the evil.''

'''Author:''' Adamant14

'''Status:''' WIP

'''Length:''' 9 playable scenarios / 1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Loyalists and Elves (feat. fencer as main hero + various allies)

'''Version:''' 0.9.9

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36075

=== A Story of the Northlands ===

''A story of life and death in a remote village of the Northlands. Your village has been overrun by an orcish raid. You fight for its freedom while you wait for help to arrive.''

'''Author:''' zepko

'''Status:''' Complete

'''Length:''' 10 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default + additions: you play with a custom faction of outlaws and with a custom party of loyalist knights.

'''[http://units.wesnoth.org/1.10/A_Story_of_the_Northlands/en_US/A_Story_of_the_Northlands.html Custom Units]'''

'''Version:''' 1.0.0

=== A Vision Blinded ===

''Defend the northern forest against what appeared like a routine orcish raid, and unravel the greater conspiracies that lie below its waves.''

'''Author:''' LemonTea

'''Maintainer:''' AxalaraFlame

'''Status:''' Complete

'''Length:''' 13 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves (+ Trolls, Outlaws)

'''[http://units.wesnoth.org/1.10/A_Vision_Blinded/en_US/A_Vision_Blinded.html Custom units]'''

'''Version:''' 0.6.6

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23463&hilit=a+vision+blinded

=== Bad Moon Rising ===

''An expedition to gather treasure from the cold north sets off compounding disaster.''

'''Author:''' Doofus-01

'''Status:''' Finished

'''Length:''' 20 scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Archaic Era

'''Version:''' 1.4.4.a

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31348

=== Battle Against Time===

''Rescue fellow orcish warchief before he is executed. (This is not a normal campaign. It is experiment with carryover system. You will start with defined number of turns and gold. You will only have that many turns to play through the whole campaign. There is no finish bonus and gold carryover is always 100%.)''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 4 playable scenarios + 1 prologue scenario

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default: Orcs

'''Version:''' 1.0.0

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=27319

=== Besieged Druids ===

''A elvish school for druids comes under attack by goblins. It seems more than just a routine raid; is there something more sinister behind this attack? - In Beseiged Druids, you control Eärendil, the surviving teacher at the school, and the many and varied initiates. Not all of these are ordinary students; many have been experimenting with other forms of magic, while others are simply overachievers in some area of study. Unfortunately, they are not especially good at combat, at least initially. Together with a very small contingent of surviving guards, it is up to these students to save the island of Aleron from disaster.''

'''Author:''' Celtic Minstrel

'''Status:''' Complete

'''Length:''' 9 scenarios

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves

'''[http://units.wesnoth.org/1.10/DruidSiege/en_US/celmin-druid-siege.html Custom units]'''

'''Version:''' 1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37342

=== Birth of a Lich ===

''This is the life story of the dreaded lich Malifor, his struggle as a mage outcast, the orcish conquest of the northlands and his transformation to quench the thirst for revenge''

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 12 playable scenarios / 2 dialogue only

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle, Dungeon

'''Faction/Era:''' Human outlaws, dwarves, undead

'''[http://units.wesnoth.org/1.10/Birth_of_a_Lich/en_US/Birth_of_a_Lich.html Custom Units]

'''Version:''' 1.0.3

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37057

=== Bitter Revenge===

''Amidst the strife and turmoil of the first Dark Age of Wesnoth, a time of transient monarchies and conspiracies against the Crown, the boy Darith witnesses the murder of his father by a general of Wesnoth. Follow Darith's quest for retribution in this treacherous tale of betrayal, deceit, love, remorse, and vengeance.''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 11 playable scenarios + 4 dialogue only

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default (mostly outlaws and undead, custom units)

'''Version:''' 1.1.0

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=26699

=== Cities of the Frontier ===

''Settle a new town in the wilds north of the Great River.''

''This campaign makes several changes to the standard Wesnoth game mechanics, and focuses on city-building and gold management.''

'''Author:''' esci

'''Status:''' Complete

'''Length:''' Not fixed, approximately 6-10 seasons of 36 turns each

'''Difficulty:''' Normal

'''Style:''' Simulation, Survival

'''Faction/Era:''' Default, Loyalist

'''[http://units.wesnoth.org/1.10/Cities_of_the_Frontier/en_US/Cities_of_the_Frontier.html Custom units]'''

'''Version:''' 0.5.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36004

=== Considerate Dead ===

''As the wind goes on and on, people discover necromancer aren't always bad. Made by tribes45 - No scenarios are done, 4 playable out of ??.''

'''Author:''' tribes45 aka tribes55

'''Status:''' Incomplete, unbalanced, abandoned

'''Length:''' 5 scenarios

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish

'''Faction/Era:''' Default

'''Version:''' .009

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36522

=== Count Kromire ===

''You are the blood son of a vampire lord, however when the might of the celestial crusades comes knocking, and your father is slain, you flee your lands. However you intend to return, to restore the lands of Kromire to the Kromires, to avenge your father, and most importantly, to make sure that no celestial ever dares come into your mountains again.''

'''Author:''' Velensk

'''Maintainer:''' currently none

'''Status:''' Complete

'''Length:''' 9 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Era of Myths, Vampires

'''Version:''' 1.3.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=21560

=== Elvish Dynasty RPG ===

''You are the new ruler of an elvish kingdom! Can you lead your people to glory? This campaign is highly randomized so it will be different every time you play!''

''Sequel to Ooze Mini-Campaign''

'''Author:''' spencelack

'''Maintainer:''' Wesbane

'''Status:''' Complete

'''Length:''' 10 years, in each year choice between dialogue and fighting scenario (selected out of a large pool of possible scenarios)

'''Difficulty:''' Normal

'''Style:''' RPG, Skirmish

'''Faction/Era:''' Default, Elves

'''Version:''' 0.9.9b

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=28627

=== Fall of Silvium ===

''You are Caius Regilius, Tribune of the province of Silvia, located in the northmost reaches of the Lavinian Empire at the height of its power. But the Empire has overextended itself, The city of Silvium lies seperated from the rest of the Empire by the mountains of Arendia, and is sandwiched between the Marauders and the Sidhe... war is inevitable, and the province of Silvia will almost certainly fall.''

'''Author:''' turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 8 scenarios

'''Difficulty:''' Medium

'''Style:''' Skirmish

'''Faction/Era:''' Imperial Era, Lavinian Legion.

'''Version:''' 0.6

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=31&t=24356

'''Note:''' The final level of this campaign is not supposed to be winnable. It's a final blaze of glory and chance to use all your high-powered units, but to 'win' the campaign, you must lose...the ending is similar to a certain mainline campaign, but predates it.

=== Fate of a Princess ===

''Part I: Baldres, a notorious robber baron, flees Wesnoth with his followers and sets off into the northlands to evade the king's justice. The baron's deeds and misdeeds are to change the balance of power between orcs and non-orcs throughout the northlands, and will carry consequences long after his eventual death.''

''Part II: The Greenwood elves face a crisis which demands the return of the queen's estranged half-elven half-sister, Baldres' daughter. Two brave young elves must make a perilous journey to find her and bring her back to her former home. If they fail, the whole northlands will be engulfed in war with the resurgent orcs...''

'''Author:''' SkyOne, mich, simonsmith

'''Status:''' Finished

'''Length:''' 26-29 scenarios (some dialogue-only), 2 parts

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon

'''Faction/Era:''' Default with additions. You play two different, unique cross-faction combinations in each part.

'''[http://units.wesnoth.org/1.10/Fate_of_a_Princess/en_US/Fate_of_a_Princess.html Custom units]'''

'''Version:''' 0.9.17

'''Required Wesnoth version:''' 1.9.12 or later

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=26327

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Fate_of_a_princess Players Review]

=== Forgotten Kingdom ===

''Help Orlog, a troll chieftan, lead his people to safety in the underground and discover an ancient power long forgotten.''

'''Author:''' Limabean

'''Maintainer:''' Chrysophylax

'''Status:''' Incomplete ( but all scenarios playable and balanced )

'''Length:''' 9 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Goblins, Trolls

'''[http://units.wesnoth.org/1.10/Forgotten_Kingdom/en_US/Forgotten_Kingdom.html Custom units]'''

'''Version:''' 0.1.7

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23483

'''Note:''' (Adamant14) This campaign includes a custom Troll line. A good campaign, I hope Limabean and/or Chrysophylax will finish it.

=== Forward they Cried ===

''You are the leader of an advanced detachment that has been tasked with capturing a bridgehead while the main army prepares to attack. It should be a simple enough assignment.''

'''Author:''' Glowing Fish

'''Maintainer:''' Lord-Knightmare

'''Status:''' Finished

'''Length:''' 1 scenario ( rather a single scenario than a campaign )

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default Loyalists

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23656&p=350126&hilit=forward+they+cried#p350126

'''Version:''' 1.0.0

'''Note:''' (Adamant14) Only a single scenario, but a great scenario.
(UnwiseOwl) You wouldn't want to stop thinking for a turn, and it's good for the first few turns, but this one leaves me wanting more.

=== Galuldur's First Journey ===

''While the belligerence of orcs is nothing new, their intensifying attacks on a fledgling colony of elves in Pindir Forest begin to show signs of a deeper malice, forcing Galuldur, the young son of the colony's adventurous founder Galur, to venture out of his forest's friendly trees in search of help. His simple errand quickly turns into a frantic quest to unearth the roots of the mysterious evil threatening his people. As you lead him through unknown lands, Galuldur, forced to match wits with unexpected adversaries at nearly every turn in a desperate attempt to save his world, quickly learns that the world is neither a friendly nor a simple place.''

'''Author:''' mattsc

'''Status:''' Complete

'''Length:''' 8-9 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves

'''[http://units.wesnoth.org/1.10/Galuldur/en_US/Galuldur.html Custom units]'''

'''Version:''' 1.1.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31895

=== Grnk the Mighty ===

''All his life, puny little goblin Grnk the Frail had been dreaming about leaving the orcs and starting a better life. When he finally arrives in the human town of Shmaltupp, he realizes that the world is not as black and white as he had imagined. He also discovers that he is no ordinary goblin. Follow Grnk the Frail on his path to becoming Grnk the Mighty.''

'''Author:''' mattsc

'''Status:''' Part I complete

'''Length:''' 13 scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish, RPG

'''Faction/Era:''' Default, changing (no standard army building gameplay)

'''[http://units.wesnoth.org/1.10/Grnk/en_US/Grnk.html Custom units]'''

'''Version:''' 1.0.5

'''Required Wesnoth version:''' 1.9.5 or later

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34970

=== Invasion from the Unknown ===

''Episode I - Seeking the Light: Long after the Fall, the last forest elves are forced to abandon their safe valley, and find themselves resorting to the dark means of necromancy in order to survive the perils and challenges of this new harsh world. May they finally free the Great Continent from its chaos, or perish in the foolish attempt of restoring peace and life to the lands.''

''Episode II - Armageddon: As the shadow of Chaos covers the entire continent, an assorted group of foolish heroes prepares a counter-attack to the Empire, with one unique goal in their minds: defeat the evil Emperor, whoever it is. Lead these courageous living and non-living warriors to victory, and rediscover lost secrets of the history.''

'''Author:''' shadowmaster

'''Maintainer:''' Espreon

'''Status:''' Finished

'''Length:''' 26 scenarios in two episodes

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon, Boss battle

'''Faction/Era:''' Unique. You play Elves and Undead throughout the campaign + in the 2nd part Northerners and Aragwaithi.

'''Version:''' 1.90.6

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Invasion_from_the_Unknown Players Review]

'''Note:''' (taptap) Despite its acknowledged flaws (generic hero, plot holes, deus ex machina moments, gameplay issues in the 2nd part) this is undoubtedly the most iconic campaign in UMC. It single-handedly redefines the elvish history and sketches a cosmology for the ages after the fall. With the Chaos empire and its various allies it introduces an era worth of factions to single-player play. At the same time it features some of the most beautiful maps in Wesnoth and stunning art on par with mainline campaigns.

=== Invasion of Eliador ===

''A peaceful island is about to be invaded by unknadd-ons foes travelling towards the eastern shore. It is up to a family of outlaws to warn the island's inhabitants before it's too late.''

'''Author:''' Sam M. (Genosuke)

'''Maintainer:''' trewe

'''Version:''' 1.0.4

'''Style:''' RPG, Skirmish, Puzzle

'''Length:''' 10 scenarios + epilogue

'''Difficulty:''' Easy

'''Status:''' Complete

'''Faction:''' Default (outlaws)

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=6556

'''Wiki:''' [[Invasion_of_Eliador]]

=== Langrisser Sample Campaign ===

''The Imperial Knights of the Rayguard Empire have disrupted the peace of the village that was Hein's hometown, seeking only a girl named Liana. Fight to rescue Liana.''

'''Author:''' Morath

'''Status:''' Finished

'''Length:''' 1 playable scenario

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves

'''Version:''' 0.1.0.5

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36417&hilit=Langrisser

'''Wikipedia:''' [http://en.wikipedia.org/wiki/Langrisser What is Langrisser]

'''Note:''' (Adamant14) Single scenario, different from usual Wesnoth behaviour.

=== Legend of Far North ===

''The tale of the legendary Black Eye Karun,depicting his rise to power, his successes and his brutal assassination.'

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 16 playable scenarios / 1 dialogue only,1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Orcs, Trolls, Saurians, Nagas

'''[http://units.wesnoth.org/1.10/Legend_of_Far_North/en_US/Legend_of_Far_North.html Custom Units]'''

'''Version:''' 1.0.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34769

=== Legend of the Invincibles ===

'''''Part I: Shrouded in Darkness''' (5 chapters, 90 scenarios) - A pair of heroes, after stopping an orcish thread, are outcast into caves, where they have no other choice than to become liches in order to survive. They preserved their original appearance and moral principles, and fight in various skirmishes against evil (although using evil methods sometimes), until the Fall, when they are buried alive under the ashes of the third sun.''

'''''Part II: Into the Light''' (4 chapters, 96 scenarios at the moment) - Long after the Fall, the lich heroes awaken. Searching for more power, they manage to resurrect themselves as living beings, but this time more powerful and ridden of the evil within. But the evil from inside them did not cease to exist, and started a campaign to conquer the world. Stopping the campaign caused an even worse disaster...''

'''Author:''' Dugi

'''Status:''' WiP (but Part I might be considered complete)

'''Length:''' 185 (+7 talk-only) scenarios at the moment

'''Difficulty:''' Normal

'''Style:''' mostly Skirmish and Dungeon (all other styles are present as well, but less frequently)

'''Faction/Era:''' Elves, Loyalists, Undead, Dwarves; but they advance past their usual maximum level

'''Version:''' 2.5.0

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Legends_of_the_Invincibles Players Review]

'''Note:''' The most unique feature of this campaign is its RPG-like unit development system, enemies drop items units can use, leaders are stronger than most usual units and all units get AMLA (after maximum level advancement) after reaching their maximum level (that is also increased by a load of additional level 4 units).

=== Nothwards ===

''A lone keep in frosty woods against enemies from far beyond.''

'''Author:''' DeRaid

'''Status:''' Broken (Does not work at all)

'''Length:''' 0 playable scenarios

'''Difficulty:''' ?

'''Style:''' ?

'''Faction/Era:''' Default

'''Version:''' 0.1

'''Forum:''' -

'''Note:''' (Adamant14) Does not work at all.

=== Panther Lord ===

''The Imperialists ambitions of pushing into the Sea States have been repeatedly thwarted and now they turn their attentions elsewhere. You are an outcast Darklander now living as a mercenary in the Sea States and the rumors you hear indicate that they will be coming to your people. Though an outcast you do not wish to see them subjugated. The spirit whose friendship caused you to be an outcast has a plan that might allow you to save them.''

'''Author:''' Velensk

'''Maintainer:''' Lavender

'''Status:''' Finished

'''Length:''' 14 scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Era of Four Moons, Darklanders (+ a wide variety of mercenaries)

'''Version:''' 1.0.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34318

=== Rebellion in the North ===

''A great orcish uprising tends to destabilise the Northlands. As the future Lord Protector of the Northern Alliance you have to crush the rebellion and establish peace again."

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 24 playable scenarios / 3 dialogue only,2 cutscenes

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Loyalists, Dwarves, Gryphons, Merfolk

'''Version:''' 1.1.12

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=33059

=== Return of the Monster ===

''It was time for Amailoss, born from the naga queen's last egg, to leave home. Time for him to grow into a leader in his own right, and eventually become the guardian and leader of another naga city. But along the way, he became friends with an unusual mud-crawler, they met a strange young monster, discovered that a spirit had escaped from an orc prison, and the mystery of that spirit became a grave challenge for Amailoss and the many races in the region....''

''A naga campaign, involving elves, orcs, saurians, turtle-like races, and some monsters.''

'''Author:''' SkyOne

'''Status:''' Complete

'''Length:''' 16 playable, 2 dialog scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon

'''Faction/Era:''' Default with additions. You play a custom naga faction and carapaces (a turtle-like race).

'''[http://units.wesnoth.org/1.10/Return_of_the_Monster/en_US/Return_of_the_Monster.html Custom units]'''

'''Version:''' 0.7.1

'''Required Wesnoth version:''' 1.10.x

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36438

=== Return to Noelren ===

'''Status:''' Complete.

'''Length:''' 26 scenarios + 7 cut scenes

'''Author:''' Pyrophorus

'''Description:''' ''A story in the first Dark Age of Wesnoth. See how various heroes stick together to shun the threat of black magics, restore the secret kingdom of Noelren and install Garard I on the throne of Wesnoth. This campaign features complex scenarios, unusual objectives and units, emphasizing more on story and adventures than hardcore fighting.''

'''Version: ''' 0.7.6

'''Requirements:''' BfW 1.10 (not tested on 1.11)

'''Difficulty:''' Easy, unbalanced

'''Style:''' Skirmish, RPG, Large Battle, Simulation

'''Faction/Era:''' Default + custom units

'''[http://units.wesnoth.org/1.10/ReturnToNoelren/en_US/ReturnToNoelren.html Custom Units]'''

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34685#p501026

'''Note:''' (Adamant14) I never saw so much fantastic and new ideas in one single UMC, wow!

=== Return to Ruins ===

''The humble farmers of Vertegris are summoned by Erik the General of Weldyn to put an end to an orcish raiding party. If they knew what would befall their former home... They never would have left. This is a relatively short campaign with 8 scenarios, It is still undergoing changes.''

'''Author:''' Jeff Stevens (Ulfsark)

'''Composer:''' Paul Fredericks (paulfredericksmusic.com)

'''Status:''' Complete

'''Length:''' 7 scenarios + 1 dialogue-only

'''Difficulty:''' Easy,Normal,Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default,(Loyalists, Outlaws)

'''Version:''' 0.5.1

'''Required Wesnoth version:''' 1.10.x

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37790&sid=9059f18497cda1219f42a626544d0ffd&p=540646#p540646

'''Note:''' (Adamant14) You play a short campaign with just a few units. Playable in a few hours, nevertheless it is fun to play.

=== Salt Wars ===

''Introductory campaign for the Era of Four Moons.''

''As an officer of one of the Sea States you must defend your organization from aggressive rivals.''

'''Author:''' Velensk

'''Maintainer:''' Lavender

'''Status:''' Complete

'''Length:''' 5 scenarios

'''Difficulty:''' Easy

'''Style:''' Skirmish

'''Faction/Era:''' Era of Four Moons, Sea States

'''Version:''' 0.2.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31498

=== Saving Elensefar ===

''Meneldur, elvish mariner of Elensefar, is driven to sea by the same orcs who attacked the city. He must gather an army willing to fight for him to regain Elensefar, his adopted homeland.''

'''Author:''' Turin

'''Maintainer:''' trewe

'''Status:''' Finished

'''Length:''' 1 year (around 12 scenarios)

'''Difficulty:''' Normal

'''Style:''' Skirmish, RPG, Simulation

'''Version:''' 1.5.2

'''Faction:''' Default Era

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?t=3072&start=0

'''Wiki:''' [[SeafaringCampaign]]

'''Note:''' Labeled as Expert, recruit list changes in all scenarios.

=== Shameless Crossover Excuse ===

''Fugitive dark sorcerer Gwiti Ha'atel discovers he has the power to mess with Wesnoth's continuity. His quest for revenge on the NPCs who have used his portraits will lead him through perils untold and in-jokes unnumbered, but shall pale before the horror he finds at his quest's end.''

'''Author:''' Orcish Shyde, Mountain_King

'''Status:''' Complete

'''Length:''' 9 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Version:''' 1.1.0

'''Faction:''' Undead

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=32016&start=15

=== Swamplings ===

''Banished by Yushnak the Ponderer, a tribe of lowly swamp goblins endure in the deadly mire of Pogo Bog. Four centuries before the founding of Wesnoth, this is the story of the goblins' struggle against the intrigues and betrayals of the greater races, and the rise of the first wolf rider.''

'''Author:''' John Rawlins (boru)

'''Status:''' Complete

'''Length:''' 14 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Version:''' 1.1.7n

'''Faction:''' Goblins

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=29784

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Swamplings Players Review]

=== Talentless Mage===

''Humorous and silly campaign about mage apprentice who has managed to learn only one simple spell in thirty years.''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 11 playable scenarios + 3 dialogue scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Noob Faction

'''Version:''' 1.1.0

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=27608]

'''Review:''' [http://wiki.wesnoth.org/index.php?title=Guide_to_UMC_Campaigns/Players_Reviews&action=submit#Talentless_Mage Player's review]

=== The Dark Alliance===

''Prince Terhar lived two years with elves. Little did he expect what would happen when he returned back to Weldyn.''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 11 or 10 playable scenarios depending on the branch you take (+ 5 dialogue scenarios)

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default: Recruit list changes in almost every scenario

'''Version:''' 1.0.3"

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=26924

=== The Dark Hordes ===

'''Status:''' Incomplete/WIP

'''Length:''' 11/?

'''Author:''' Circon

'''Maintainer:''' Various

'''Description:''' Lead fugitive dark sorcerer Gwiti Ha’atel to mastery of the undead hordes.

'''Version: '''

'''Requirements:'''

'''Difficulty:'''

'''Style:''' Skirmish

'''Faction/Era:''' Default undead

'''[http://units.wesnoth.org/1.10/The_Dark_Hordes/en_US/The_Dark_Hordes_1.html Custom Units]'''

'''Walkthrough:''' [[TheDarkHordes]]

'''Forum:''' [[http://forums.wesnoth.org/viewtopic.php?f=8&t=16576&]]

=== The Devil's Flute ===

'''Status:''' Complete, unmaintained

'''Length:''' 10 scenarios

'''Author:''' lipk

'''Description:''' Creona, the well-known assassin, gets a strange job from a strange person. So, in fact, it's no surprise that things take a strange turn...

'''Version:''' 0.1.4c

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish, Minigames

'''Faction/Era:''' Outlaws

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36044

=== The Earth's Gut ===

''The year is 515YW. You are the young dwarven leader Hamel. Your tribe in the caves of Knalga is under pressure from its enemies, and resources are growing scarce. In order to forge the weapons required to resist your enemies, you must set forth and collect what ores and minerals remain.''

'''Author:''' Anonymissimus

'''Maintainer:''' Anonymissimus

'''Status:''' Incomplete

'''Length:''' 21 scenarios

'''Difficulty:''' Normal

'''Style:''' Dungeon

'''Faction/Era:''' Default, dwarves.

'''[http://units.wesnoth.org/1.10/The_Earths_Gut/en_US/the_earths_gut.html Custom units]'''

'''Version:''' 0.2.11

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=26800

'''Note:''' This campaign is a "Dwarvish dungeon crawler" and is intended to be challenging for experienced players on hard whilst suitably easy on easy.

=== The Epic of Vaniyera ===

''The expansionist Lavinian Legion, led by the Imperator himself, has invaded the northern forests of the Sidhe, or Wild Elves. It is up to Leithan the Thunderblade and his advisor Vaniyera to push its armies back where they came from...''

'''Author:''' oreb, turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 6 scenarios

'''Difficulty:''' Hard (Don't be fooled by "novice level" in the campaign description, this one is very hard.)

'''Note:''' (Maintainer) Working on this issue, the next release (due at the end of November, hah!) should bring easy difficulty back to the level of a reasonable introduction to the IE, while the hard difficulty will also become slightly easier. With any luck, this will be the last release before version 1.0 of the campaign].

'''Style:''' Skirmish

'''Faction/Era:''' Imperial Era, Sidhe.

'''Version:''' 0.9.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=19490

=== The Fall of Wesnoth ===

''As the beloved human empire of Wesnoth becomes lazy and arrogant in its peaceful state of happiness, Emperor Dantair demands the creation of another sun in a bid to destroy all evil. Or is it all for a different purpose? A man named Alitar sees it that way, and now he must survive the most evil inhabited lands if he is to stop chaos from rising, and Wesnoth from falling... This is the story of The Fall of Wesnoth.''

'''Author:''' Pewskeepski

'''Status:''' 1st part complete, 2nd WIP.

'''Length:''' 10 playable scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Outlaws

'''[http://units.wesnoth.org/1.10/The_Fall_of_Wesnoth/en_US/The_Fall_of_Wesnoth-1.html Custom units]'''

'''Version:''' 1.0.8

=== The Founding of Borstep ===

''The chieftain of your tribe has become decadent and weak. Take over, and lead your people to a better home--whether it is already occupied or not. The Northlands in year 9W are a barbaric place, but anyone who stands in your way will learn the power of orcs!''

'''Author:''' Beetlenaut

'''Status:''' Complete

'''Length:''' 10 and 1 dialogue only

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default, Northerners

'''[http://units.wesnoth.org/1.10/The_Founding_of_Borstep/en_US/The_Founding_of_Borstep.html Custom units]'''

'''Version:''' 1.1.1b

'''Note:''' (Kanzil) I find the protagonist hard to sympathise with. Also, most scenarios contain interesting twists. For example, in one, each time you killed a boar it gives you extra health.

'''Note:''' (beetlenaut--author) In most Orcish campaigns the leader is heroic or just wants peace. Krag-Ubor wants plunder and battle like all enemy Orcs in other campaigns. I '''hope''' you don't sympathize too strongly, but I don't think you need to in order to enjoy the game play.

=== The Keep ===

''A lone keep in frosty woods against enemies from far beyond.''

'''Author:''' DeRaid

'''Status:''' Broken (Does not work at all)

'''Length:''' 0 playable scenarios

'''Difficulty:''' Broken

'''Style:''' ?

'''Faction/Era:''' Default

'''Version:''' 0.1

'''Forum:''' -

'''Note:''' (Adamant14) Does not work at all.

=== The Library of Kratemaqht ===

''An ancient story from the old continent.''

'''Author:''' Rich Marinaccio (cephalo)

'''Status:''' Complete

'''Length:''' 17 scenarios

'''Difficulty:''' Unbalanced (some scenarios are Easy - some rather Hard)

'''Style:''' Skirmish, RPG

'''Faction/Era:''' Loyalists and custom units.

'''[http://units.wesnoth.org/1.10/Library_Of_Kratemaqht/en_US/The_Library_Of_Kratemaqht.html Custom units]'''

'''Version:''' 1.0.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37798

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#The_Library_of_Kratemaqht Players Reviews]

'''Notes:''' (Adamant14) This campaign has a thought-out story, shows a great love for detail;
It includes a great custom Dragon, some brilliant custom images (fire, burning houses, burning forest) that makes the scenery / maps look very nice.

=== The Roar of the Woses ===

''When the construction of a dam threatens the existence of her home, Kylix is forced on a journey to stop it.''

'''Author:''' Alarantalara

'''Status:''' Finished

'''Length:''' 10-11 scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default with Additions (primarily Saurians, Nagas, Woses)

'''Version:''' 1.2.7

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=29830

'''Note:''' (author) Potentially unbalanced on Hard difficulty due to experiments with non-standard ways to increase difficulty. This issue does not exist on the lower difficulty levels.

=== The Three Elves ===

''Three elves have just begun their adventure in the northern swampland. Will they become heroes or will they be responsible for another undead expansion?''

'''Author:''' Stanislav Hoferek

'''Maintainer:''' trewe

'''Version:''' 0.9

'''Status:''' Complete

'''Difficulty:''' Easy

'''Length:''' 8 scenarios + 2 dialogue

'''Style:''' Skirmish

'''Faction:''' Default (Elves)

'''Forum:''' (does it have one?)

=== The Sojournings of Grog ===

''Grog (as starred in Under the Burning Suns) goes home.''

'''Author:''' Peter Christopher, Thomas Hockings

'''Maintainer:''' Elvish_Hunter

'''Status:''' Finished

'''Length:''' 18 playable scenarios in 2 parts

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon, Large Battle

'''[http://units.wesnoth.org/1.10/The_Sojournings_of_Grog/en_US/The_Sojournings_of_Grog.html Custom units]'''

'''Faction/Era:''' Default. Most of the time you play trolls and some desert elves accompanying Grog.

'''Version:''' 3.0.1

=== The Unstoppable Legion ===

''Horseback campaign. The kingdom of Suveran, far away from Wesnoth, is under attack. Only Deuterus, a Great Druid, knows their weakness and only Viktor, a young noble, dares go on the quest to stop them.''

'''Author:''' Chris Neville-Smith (Chris NS)

'''Maintainer:''' Chris Neville-Smith (Chris NS)

'''Status:''' WIP

'''Length:''' Currently 15 playable sceanrios, including a fork of three paths near the beginning, and another fork of two paths later on.

'''Difficulty:''' Normal

'''Style:''' Mainly Skirmish

'''[http://units.wesnoth.org/1.10/The_Unstoppable_Legion/en_US/The_Unstoppable_Legion.html Custom units]'''

'''Faction/Era:''' Play mounted units, including expanded Cavalryman line, and completely new Bowrider line. Joined later by Dwarves. Main enemies are the dark fighters and dark cultists.

'''Version:''' 0.8.7

=== The White Troll ===

''The story of a white troll whelp with strange magic powers, who is raised in an elvish village.''

'''Author:''' Wesnoth Italian Forum

'''Status:''' Complete

'''Length:''' 8 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default: you play with elves and trolls. Also features custom units with special advancements and abilities.

'''[http://units.wesnoth.org/1.10/White_Troll/en_US/white_troll.html Custom Units]'''

'''Version:''' 0.7.5

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=38828

=== To Lands Unknown ===

''This is the story of Mehir, the Summoner, and his journey to lands unknown.''

'''Author:''' inferno8

'''Status:''' Complete

'''Length:''' 20 scenarios, 4 dialogue only

'''Difficulty:''' Intermediate (Era of Magic)

'''Style''': Skirmish, Dungeon

'''Era:''' Era of Magic

'''Version:''' 1.6.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31799

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#To_Lands_Unknown Players Review]

=== Unlikely Alliance ===

''Play as the members of an alliance between the elves, drakes, and undead after the Fall of Wesnoth.''

'''Author:''' Creativity

'''Status:''' Broken ( Abandoned )

'''Length:''' 2 broken scenarios

'''Difficulty:''' Unbalanced

'''Style:''' -

'''Faction/Era:''' -

'''Version:''' 0.1

'''Forum:''' -

'''Note:''' (Adamant14) Did not work at all. Seems abandoned.

=== Up from Slavery ===

''The Orcei are captives in the imperial city of Lavinium, gladiators performing for the emperor Optus Maximus. All it will take, however, is one orc to lead his people to freedom. The Samnis called Sparxus may be that orc.''

'''Author:''' turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 7 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish, Arena (= No recruit, small group gladiator fights)

'''Faction/Era:''' Imperial Era, Orcei Gladiatores

'''Version:''' 0.6.0

'''Note:''' (Maintainer) At some point, I am intending to completely re-work this campaign to be a multi-player campaign, with one side led by Sparxus and one by Gravirivus. If anyone would like to take this on or has ideas for how to accomplish this, let us know. Nevertheless, its playable as a single player campaign now with some nice ideas that could be developed further.]

=== Warmaster ===

''One day the scout of your king brings a mysterious little stone, called Zrai-Stone, back from one of his trips. Soon that stone causes a lot of trouble...''

'''Author:''' Conkinator

'''Maintainer:''' trewe

'''Version:''' 1.3.5

'''Status:''' Finished

'''Length:''' 16 battle + 2 bonus + 1 epilogue scenarios

'''Difficulty:''' Hard

'''Faction:''' Default (loyalists)

'''Style:''' Skirmish, Survival

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=15527

=== Way of Dragon ===

''The story of what might happen if a person against his will transform into a dragon...''

'''Author:''' DrakeDragon

'''Status:''' Complete

'''Length:''' 7 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish/RPG

'''Faction/Era:''' Default Loyalists

'''Version:''' 1.2.0

'''Forum:''' [http://forums.wesnoth.org/viewtopic.php?f=8&t=37876 Wesnoth Forum] [http://uporoom.ru/index.php/topic,179.0.html Russian Forum]

'''Note:''' (Adamant14) Promising short campaign, you play with just a few units.

== Battle for Wesnoth 1.11.x - development ==

''Campaigns available in the 1.11.x development version.''

''Please note: Battle for Wesnoth 1.11.0 features a bug that messes up the selection of difficulty levels.''

=== Antar, Son of Rheor ===

''This is the story about a young Lord and his first mission; sent by his father the young Lord Antar has to relieve his neighbours; he has to convince the Elves and Dwarves to ally him; he has to fight against hordes of Orcs and Endless Undead; and finally he has to defeat Mal Kazur, the mastermind who is behind all the evil.''

'''Author:''' Adamant14

'''Status:''' WIP

'''Length:''' 9 playable scenarios / 1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Loyalists and Elves (feat. fencer as main hero + various allies)

'''Version:''' 0.9.9

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36075

'''Note:''' (Adamant14) The campaign did not work with BfW version 1.11.0, or BfW version 1.11.1, so please use BfW version 1.11.2 or later!

=== A Song of Fire ===

''''''Part I: The Last War''' - In a long-forgotten era, at the heart of the Great Continent, an ancestral evil is awakened, threatening to destroy the whole world. Follow young Myra in the war that will alter the future of Irdya and its peoples forever.''

''''''Part II: Towards the Rising Sun''' - After the vicious Last War, Myra has become the new leader of Aragwaithi and Windsong alike. Albeit young and shaken by many losses, she must steel herself to lead her people through the vast and hostile Hannuk Steppes. However, her journey will take them all farther than in their wildest dreams. Furthermore, Myra must deal with the evil influence of the mysterious red gem she found after the last battle.''

''''''Part III: Raging Skies''' - The refugees have finally found a new home: families are built, allies are made and, for the first time in years, Myra and her friends know peace. However, when everything seems normal, ambition and thirst for power cause the break out of a continental war. And, amidst this new storm, an old foe rises agan, more powerful than ever. Witness the end of the song of Irdya's first great heroine.''

'''Author:''' revansurik

'''Status:''' Complete

'''Length:''' 36 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Default+War of Legends

'''Version:''' 0.3.3

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=38210

=== Bad Moon Rising ===

''An expedition to gather treasure from the cold north sets off compounding disaster.''

'''Author:''' Doofus-01

'''Status:''' Finished

'''Length:''' 20 scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Archaic Era

'''Version:''' 1.5.8

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31348

=== Birth of a Lich ===

''This is the life story of the dreaded lich Malifor, his struggle as a mage outcast, the orcish conquest of the northlands and his transformation to quench the thirst for revenge''

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 12 playable scenarios / 2 dialogue only

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle, Dungeon

'''Faction/Era:''' Human outlaws, dwarves, undead

'''[http://units.wesnoth.org/1.10/Birth_of_a_Lich/en_US/Birth_of_a_Lich.html Custom Units]

'''Version:''' 1.0.3

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37057

=== Coming of the Storm ===

''A new recruit joins the imperial army, eager to change the world and see combat. Little does he realise just how much action he will get and where his journey will take him. ''

'''Author:''' TrashMan

'''Status:''' WIP

'''Length:''' 26 playable scenarios / 4 dialogue only

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle, Dungeon

'''Faction/Era:''' Default

'''Version:''' 1.2.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23361

=== Legend of Far North ===

''The tale of the legendary Black Eye Karun,depicting his rise to power, his successes and his brutal assassination.'

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 16 playable scenarios / 1 dialogue only,1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Orcs, Trolls, Saurians, Nagas

'''[http://units.wesnoth.org/1.10/Legend_of_Far_North/en_US/Legend_of_Far_North.html Custom Units]'''

'''Version:''' 1.0.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34769

=== Legend of the Invincibles ===

'''''Part I: Shrouded in Darkness''' (5 chapters, 90 scenarios) - A pair of heroes, after stopping an orcish thread, are outcast into caves, where they have no other choice than to become liches in order to survive. They preserved their original appearance and moral principles, and fight in various skirmishes against evil (although using evil methods sometimes), until the Fall, when they are buried alive under the ashes of the third sun.''

'''''Part II: Into the Light''' (4 chapters, 96 scenarios at the moment) - Long after the Fall, the lich heroes awaken. Searching for more power, they manage to resurrect themselves as living beings, but this time more powerful and ridden of the evil within. But the evil from inside them did not cease to exist, and started a campaign to conquer the world. Stopping the campaign caused an even worse disaster...''

'''Author:''' Dugi

'''Status:''' WiP (but Part I might be considered complete)

'''Length:''' 185 (+7 talk-only) scenarios at the moment

'''Difficulty:''' Normal

'''Style:''' mostly Skirmish and Dungeon (all other styles are present as well, but less frequently)

'''Faction/Era:''' Elves, Loyalists, Undead, Dwarves; but they advance past their usual maximum level

'''Version:''' 2.5.0

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Legends_of_the_Invincibles Players Review]

'''Note:''' The most unique feature of this campaign is its RPG-like unit development system, enemies drop items units can use, leaders are stronger than most usual units and all units get AMLA (after maximum level advancement) after reaching their maximum level (that is also increased by a load of additional level 4 units).

=== Rebellion in the North ===

''A great orcish uprising tends to destabilise the Northlands. As the future Lord Protector of the Northern Alliance you have to crush the rebellion and establish peace again."

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 24 playable scenarios / 3 dialogue only,2 cutscenes

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Loyalists, Dwarves, Gryphons, Merfolk

'''Version:''' 1.1.12

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=33059

=== Ruthless ===

''A bard (an aging criminal) is walking in wasteland. Nothing but two hands in his pockets, and nothing but stones around. Suddenly he sees a knight on errand--a dangerous opponent, especially in broad daylight. The two strangers are soon sitting by the campfire, and the bard is telling a story.
(Beginner level, 10+ fights).''

'''Author:''' homunculus

'''Status:''' Finished

'''Length:''' 12 playable scenarios + 5 cutscene scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default (Orcs)

'''Version:''' 1.0.4

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37874

'''Note:''' (Adamant14) Recommendable campaign, with smart unusual ideas and a good detailed story.
You fight with few units on small but perfect maps. About the difficulty: The author describes his campaign as 'beginner level', but for me the difficulty is rather NORMAL than EASY.

== Player Reviews ==

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews Link to Players Reviews]'''

[[Category:Campaigns|*]]

Guide to UMC Content

2013-06-04T10:06:49Z

Pyrophorus: /* Battle Against Time */

''This is a guide to the current (1.10.x/1.11.x) UMC campaigns for players. It aims to provide all the information not only about the story, but also about completion, difficulty and playing style of the campaign. See http://forums.wesnoth.org/viewtopic.php?f=8&t=37476 for further information, for currently non-available UMC-content please refer to http://forums.wesnoth.org/viewtopic.php?f=8&t=36733. Please edit, it is a wiki.''

=== Blueprint ===

'''Status:'''
* Broken = Does not work at all
* Incomplete = Partially written, no progress
* WIP = Partially written, progress
* Complete = Completely written, but buggy as well as potential balance issues.
* Finished = Completely written, minimal to no bugs, slight balance issues possible.

'''Length:'''

'''Author:'''

'''Maintainer:''' if not maintained by the author anymore.

'''Description:'''

'''Version: '''

'''Requirements:'''

'''Difficulty:'''

Please note: Often campaigns introducing new mechanics are listed as expert level on the add-on server, here difficulty means the raw difficulty after the mechanics are understood.

* Unbalanced = If you can't beat the hard mode, it isn't necessarily unbalanced, but if the difficulty changes erraticly from one scenario to the next and only people using the debug mode have seen the final, then it is.
* Easy
* Normal
* Hard

'''Style:'''

Please note: Many campaigns will feature more than one style. Please list the most significant ones.

* Skirmish = small to medium sized armies, your standard Wesnoth gameplay
* Dungeon = long and narrow tunnels (not every underground scenario is a dungeon, a dungeon isn't necessarily underground)
* RPG = role playing game elements such as talking with non-player-characters, item collection, dependency on a party of very few adventurers without or limited recruits
* Survival = being exposed to changing, spawning enemies while remaining on the same map
* Large Battle = large number of units on the battlefield, sizely maps
* Simulation = campaigns feat. terrain modification, alternative resources
* Boss battle = the challenge is to defeat a single powerful enemy unit
* Minigames = there are puzzles and minigames in the campaign that significantly differ from standard Wesnoth gameplay

'''Faction/Era:'''

* Era for the whole campaign and more specifically the faction or unit composition you field.

'''Custom units:'''

* Link to the unit tree for cases that don't feel sufficiently described by Faction / Era entry.

'''Forum:'''

* Links to the feedback and development threads at forums.wesnoth.org

== Battle for Wesnoth 1.10.x - stable ==

''Campaigns available in the 1.10.x stable version.''

=== Aldur The Great ===

''This is a story about Aldur the Great.''

'''Author:''' pintercsabi

'''Status:''' Complete, but unbalanced

'''Length:''' 5 playable scenarios

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish

'''Faction/Era:''' Default

'''Version:''' 1.2.2

'''Forum:''' -

'''Note:''' (Adamant14) Short unbalanced campaign, maybe abandoned. You fight with Peasants, Ruffians and Woodsman against Orcs

=== Alfhelm the Wise ===

''This is the tale of Alfhelm, called by some the Wise, son of Alfric Conqueror. This is the tale of his victories over his enemies, and his rise to power in the clans of Marauderdom. This is the tale of his journey south and his destruction of the Lavinian Empire. And this is the tale of his demise in the dark forests far to the east of his homeland.''

'''Author:''' turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 15 gameplay scenarios

'''Difficulty:''' Moderate

'''Style:''' Skirmish

'''Faction/Era:''' Imperial Era, Marauders.

'''Version:''' 0.6.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=17144

'''Note:''' (Maintainer) Though this campaign is complete and playable the whole way through, the code is four years old and pretty buggy. If you notice any errors while playing, please let me know and I'll incorporate the fixes into my next revision as soon as possible.]

=== A New Order ===

'''Author:''' szopen

'''Status:''' Finished.

'''Length:''' 45 scenarios.

'''Description:''' The old kingdom of Wesnoth has fallen before barbarian hordes. The occupying barbarians are on the brink of civil war, the seeds of Wesnothian rebellion are kept alive by old legends, while bandits and Khalifate mercenaries roam the land. Can Gawen Hagarthen unite these disparate factions against a common foe?
Note: This campaign contains mature themes, some of which may be unsuitable for children.

'''Version: ''' 1.2.15

'''Requirements:''' Requires BfW 1.10. In addition, you have to install Era Khalifate add-on; the Akladian Music package is optional

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Akladians, Khalifate

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=6486

'''Note:''' (Pyrophorus) Certainly one of the most mature and well designed campaign in add-ons. A must.

=== Antar, Son of Rheor ===

''This is the story about a young Lord and his first mission; sent by his father the young Lord Antar has to relieve his neighbours; he has to convince the Elves and Dwarves to ally him; he has to fight against hordes of Orcs and Endless Undead; and finally he has to defeat Mal Kazur, the mastermind who is behind all the evil.''

'''Author:''' Adamant14

'''Status:''' WIP

'''Length:''' 9 playable scenarios / 1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Loyalists and Elves (feat. fencer as main hero + various allies)

'''Version:''' 0.9.9

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36075

=== A Story of the Northlands ===

''A story of life and death in a remote village of the Northlands. Your village has been overrun by an orcish raid. You fight for its freedom while you wait for help to arrive.''

'''Author:''' zepko

'''Status:''' Complete

'''Length:''' 10 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default + additions: you play with a custom faction of outlaws and with a custom party of loyalist knights.

'''[http://units.wesnoth.org/1.10/A_Story_of_the_Northlands/en_US/A_Story_of_the_Northlands.html Custom Units]'''

'''Version:''' 1.0.0

=== A Vision Blinded ===

''Defend the northern forest against what appeared like a routine orcish raid, and unravel the greater conspiracies that lie below its waves.''

'''Author:''' LemonTea

'''Maintainer:''' AxalaraFlame

'''Status:''' Complete

'''Length:''' 13 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves (+ Trolls, Outlaws)

'''[http://units.wesnoth.org/1.10/A_Vision_Blinded/en_US/A_Vision_Blinded.html Custom units]'''

'''Version:''' 0.6.6

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23463&hilit=a+vision+blinded

=== Bad Moon Rising ===

''An expedition to gather treasure from the cold north sets off compounding disaster.''

'''Author:''' Doofus-01

'''Status:''' Finished

'''Length:''' 20 scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Archaic Era

'''Version:''' 1.4.4.a

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31348

=== Battle Against Time===

''Rescue fellow orcish warchief before he is executed. (This is not a normal campaign. It is experiment with carryover system. You will start with defined number of turns and gold. You will only have that many turns to play through the whole campaign. There is no finish bonus and gold carryover is always 100%.)''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 4 playable scenarios + 1 prologue scenario

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default: Orcs

'''Version:''' 1.0.0

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=27319

=== Besieged Druids ===

''A elvish school for druids comes under attack by goblins. It seems more than just a routine raid; is there something more sinister behind this attack? - In Beseiged Druids, you control Eärendil, the surviving teacher at the school, and the many and varied initiates. Not all of these are ordinary students; many have been experimenting with other forms of magic, while others are simply overachievers in some area of study. Unfortunately, they are not especially good at combat, at least initially. Together with a very small contingent of surviving guards, it is up to these students to save the island of Aleron from disaster.''

'''Author:''' Celtic Minstrel

'''Status:''' Complete

'''Length:''' 9 scenarios

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves

'''[http://units.wesnoth.org/1.10/DruidSiege/en_US/celmin-druid-siege.html Custom units]'''

'''Version:''' 1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37342

=== Birth of a Lich ===

''This is the life story of the dreaded lich Malifor, his struggle as a mage outcast, the orcish conquest of the northlands and his transformation to quench the thirst for revenge''

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 12 playable scenarios / 2 dialogue only

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle, Dungeon

'''Faction/Era:''' Human outlaws, dwarves, undead

'''[http://units.wesnoth.org/1.10/Birth_of_a_Lich/en_US/Birth_of_a_Lich.html Custom Units]

'''Version:''' 1.0.3

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37057

=== Bitter Revenge===

''Amidst the strife and turmoil of the first Dark Age of Wesnoth, a time of transient monarchies and conspiracies against the Crown, the boy Darith witnesses the murder of his father by a general of Wesnoth. Follow Darith's quest for retribution in this treacherous tale of betrayal, deceit, love, remorse, and vengeance.''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 11 playable scenarios + 4 dialogue only

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default (mostly outlaws and undead, custom units)

'''Version:''' 1.1.0

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=26699

=== Cities of the Frontier ===

''Settle a new town in the wilds north of the Great River.''

''This campaign makes several changes to the standard Wesnoth game mechanics, and focuses on city-building and gold management.''

'''Author:''' esci

'''Status:''' Complete

'''Length:''' Not fixed, approximately 6-10 seasons of 36 turns each

'''Difficulty:''' Normal

'''Style:''' Simulation, Survival

'''Faction/Era:''' Default, Loyalist

'''[http://units.wesnoth.org/1.10/Cities_of_the_Frontier/en_US/Cities_of_the_Frontier.html Custom units]'''

'''Version:''' 0.5.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36004

=== Considerate Dead ===

''As the wind goes on and on, people discover necromancer aren't always bad. Made by tribes45 - No scenarios are done, 4 playable out of ??.''

'''Author:''' tribes45 aka tribes55

'''Status:''' Incomplete, unbalanced, abandoned

'''Length:''' 5 scenarios

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish

'''Faction/Era:''' Default

'''Version:''' .009

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36522

=== Count Kromire ===

''You are the blood son of a vampire lord, however when the might of the celestial crusades comes knocking, and your father is slain, you flee your lands. However you intend to return, to restore the lands of Kromire to the Kromires, to avenge your father, and most importantly, to make sure that no celestial ever dares come into your mountains again.''

'''Author:''' Velensk

'''Maintainer:''' currently none

'''Status:''' Complete

'''Length:''' 9 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Era of Myths, Vampires

'''Version:''' 1.3.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=21560

=== Elvish Dynasty RPG ===

''You are the new ruler of an elvish kingdom! Can you lead your people to glory? This campaign is highly randomized so it will be different every time you play!''

''Sequel to Ooze Mini-Campaign''

'''Author:''' spencelack

'''Maintainer:''' Wesbane

'''Status:''' Complete

'''Length:''' 10 years, in each year choice between dialogue and fighting scenario (selected out of a large pool of possible scenarios)

'''Difficulty:''' Normal

'''Style:''' RPG, Skirmish

'''Faction/Era:''' Default, Elves

'''Version:''' 0.9.9b

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=28627

=== Fall of Silvium ===

''You are Caius Regilius, Tribune of the province of Silvia, located in the northmost reaches of the Lavinian Empire at the height of its power. But the Empire has overextended itself, The city of Silvium lies seperated from the rest of the Empire by the mountains of Arendia, and is sandwiched between the Marauders and the Sidhe... war is inevitable, and the province of Silvia will almost certainly fall.''

'''Author:''' turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 8 scenarios

'''Difficulty:''' Medium

'''Style:''' Skirmish

'''Faction/Era:''' Imperial Era, Lavinian Legion.

'''Version:''' 0.6

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=31&t=24356

'''Note:''' The final level of this campaign is not supposed to be winnable. It's a final blaze of glory and chance to use all your high-powered units, but to 'win' the campaign, you must lose...the ending is similar to a certain mainline campaign, but predates it.

=== Fate of a Princess ===

''Part I: Baldres, a notorious robber baron, flees Wesnoth with his followers and sets off into the northlands to evade the king's justice. The baron's deeds and misdeeds are to change the balance of power between orcs and non-orcs throughout the northlands, and will carry consequences long after his eventual death.''

''Part II: The Greenwood elves face a crisis which demands the return of the queen's estranged half-elven half-sister, Baldres' daughter. Two brave young elves must make a perilous journey to find her and bring her back to her former home. If they fail, the whole northlands will be engulfed in war with the resurgent orcs...''

'''Author:''' SkyOne, mich, simonsmith

'''Status:''' Finished

'''Length:''' 26-29 scenarios (some dialogue-only), 2 parts

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon

'''Faction/Era:''' Default with additions. You play two different, unique cross-faction combinations in each part.

'''[http://units.wesnoth.org/1.10/Fate_of_a_Princess/en_US/Fate_of_a_Princess.html Custom units]'''

'''Version:''' 0.9.17

'''Required Wesnoth version:''' 1.9.12 or later

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=26327

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Fate_of_a_princess Players Review]

=== Forgotten Kingdom ===

''Help Orlog, a troll chieftan, lead his people to safety in the underground and discover an ancient power long forgotten.''

'''Author:''' Limabean

'''Maintainer:''' Chrysophylax

'''Status:''' Incomplete ( but all scenarios playable and balanced )

'''Length:''' 9 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Goblins, Trolls

'''[http://units.wesnoth.org/1.10/Forgotten_Kingdom/en_US/Forgotten_Kingdom.html Custom units]'''

'''Version:''' 0.1.7

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23483

'''Note:''' (Adamant14) This campaign includes a custom Troll line. A good campaign, I hope Limabean and/or Chrysophylax will finish it.

=== Forward they Cried ===

''You are the leader of an advanced detachment that has been tasked with capturing a bridgehead while the main army prepares to attack. It should be a simple enough assignment.''

'''Author:''' Glowing Fish

'''Maintainer:''' Lord-Knightmare

'''Status:''' Finished

'''Length:''' 1 scenario ( rather a single scenario than a campaign )

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default Loyalists

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23656&p=350126&hilit=forward+they+cried#p350126

'''Version:''' 1.0.0

'''Note:''' (Adamant14) Only a single scenario, but a great scenario.
(UnwiseOwl) You wouldn't want to stop thinking for a turn, and it's good for the first few turns, but this one leaves me wanting more.

=== Galuldur's First Journey ===

''While the belligerence of orcs is nothing new, their intensifying attacks on a fledgling colony of elves in Pindir Forest begin to show signs of a deeper malice, forcing Galuldur, the young son of the colony's adventurous founder Galur, to venture out of his forest's friendly trees in search of help. His simple errand quickly turns into a frantic quest to unearth the roots of the mysterious evil threatening his people. As you lead him through unknown lands, Galuldur, forced to match wits with unexpected adversaries at nearly every turn in a desperate attempt to save his world, quickly learns that the world is neither a friendly nor a simple place.''

'''Author:''' mattsc

'''Status:''' Complete

'''Length:''' 8-9 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves

'''[http://units.wesnoth.org/1.10/Galuldur/en_US/Galuldur.html Custom units]'''

'''Version:''' 1.1.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31895

=== Grnk the Mighty ===

''All his life, puny little goblin Grnk the Frail had been dreaming about leaving the orcs and starting a better life. When he finally arrives in the human town of Shmaltupp, he realizes that the world is not as black and white as he had imagined. He also discovers that he is no ordinary goblin. Follow Grnk the Frail on his path to becoming Grnk the Mighty.''

'''Author:''' mattsc

'''Status:''' Part I complete

'''Length:''' 13 scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish, RPG

'''Faction/Era:''' Default, changing (no standard army building gameplay)

'''[http://units.wesnoth.org/1.10/Grnk/en_US/Grnk.html Custom units]'''

'''Version:''' 1.0.5

'''Required Wesnoth version:''' 1.9.5 or later

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34970

=== Invasion from the Unknown ===

''Episode I - Seeking the Light: Long after the Fall, the last forest elves are forced to abandon their safe valley, and find themselves resorting to the dark means of necromancy in order to survive the perils and challenges of this new harsh world. May they finally free the Great Continent from its chaos, or perish in the foolish attempt of restoring peace and life to the lands.''

''Episode II - Armageddon: As the shadow of Chaos covers the entire continent, an assorted group of foolish heroes prepares a counter-attack to the Empire, with one unique goal in their minds: defeat the evil Emperor, whoever it is. Lead these courageous living and non-living warriors to victory, and rediscover lost secrets of the history.''

'''Author:''' shadowmaster

'''Maintainer:''' Espreon

'''Status:''' Finished

'''Length:''' 26 scenarios in two episodes

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon, Boss battle

'''Faction/Era:''' Unique. You play Elves and Undead throughout the campaign + in the 2nd part Northerners and Aragwaithi.

'''Version:''' 1.90.6

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Invasion_from_the_Unknown Players Review]

'''Note:''' (taptap) Despite its acknowledged flaws (generic hero, plot holes, deus ex machina moments, gameplay issues in the 2nd part) this is undoubtedly the most iconic campaign in UMC. It single-handedly redefines the elvish history and sketches a cosmology for the ages after the fall. With the Chaos empire and its various allies it introduces an era worth of factions to single-player play. At the same time it features some of the most beautiful maps in Wesnoth and stunning art on par with mainline campaigns.

=== Invasion of Eliador ===

''A peaceful island is about to be invaded by unknadd-ons foes travelling towards the eastern shore. It is up to a family of outlaws to warn the island's inhabitants before it's too late.''

'''Author:''' Sam M. (Genosuke)

'''Maintainer:''' trewe

'''Version:''' 1.0.4

'''Style:''' RPG, Skirmish, Puzzle

'''Length:''' 10 scenarios + epilogue

'''Difficulty:''' Easy

'''Status:''' Complete

'''Faction:''' Default (outlaws)

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=6556

'''Wiki:''' [[Invasion_of_Eliador]]

=== Langrisser Sample Campaign ===

''The Imperial Knights of the Rayguard Empire have disrupted the peace of the village that was Hein's hometown, seeking only a girl named Liana. Fight to rescue Liana.''

'''Author:''' Morath

'''Status:''' Finished

'''Length:''' 1 playable scenario

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves

'''Version:''' 0.1.0.5

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36417&hilit=Langrisser

'''Wikipedia:''' [http://en.wikipedia.org/wiki/Langrisser What is Langrisser]

'''Note:''' (Adamant14) Single scenario, different from usual Wesnoth behaviour.

=== Legend of Far North ===

''The tale of the legendary Black Eye Karun,depicting his rise to power, his successes and his brutal assassination.'

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 16 playable scenarios / 1 dialogue only,1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Orcs, Trolls, Saurians, Nagas

'''[http://units.wesnoth.org/1.10/Legend_of_Far_North/en_US/Legend_of_Far_North.html Custom Units]'''

'''Version:''' 1.0.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34769

=== Legend of the Invincibles ===

'''''Part I: Shrouded in Darkness''' (5 chapters, 90 scenarios) - A pair of heroes, after stopping an orcish thread, are outcast into caves, where they have no other choice than to become liches in order to survive. They preserved their original appearance and moral principles, and fight in various skirmishes against evil (although using evil methods sometimes), until the Fall, when they are buried alive under the ashes of the third sun.''

'''''Part II: Into the Light''' (4 chapters, 96 scenarios at the moment) - Long after the Fall, the lich heroes awaken. Searching for more power, they manage to resurrect themselves as living beings, but this time more powerful and ridden of the evil within. But the evil from inside them did not cease to exist, and started a campaign to conquer the world. Stopping the campaign caused an even worse disaster...''

'''Author:''' Dugi

'''Status:''' WiP (but Part I might be considered complete)

'''Length:''' 185 (+7 talk-only) scenarios at the moment

'''Difficulty:''' Normal

'''Style:''' mostly Skirmish and Dungeon (all other styles are present as well, but less frequently)

'''Faction/Era:''' Elves, Loyalists, Undead, Dwarves; but they advance past their usual maximum level

'''Version:''' 2.5.0

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Legends_of_the_Invincibles Players Review]

'''Note:''' The most unique feature of this campaign is its RPG-like unit development system, enemies drop items units can use, leaders are stronger than most usual units and all units get AMLA (after maximum level advancement) after reaching their maximum level (that is also increased by a load of additional level 4 units).

=== Nothwards ===

''A lone keep in frosty woods against enemies from far beyond.''

'''Author:''' DeRaid

'''Status:''' Broken (Does not work at all)

'''Length:''' 0 playable scenarios

'''Difficulty:''' ?

'''Style:''' ?

'''Faction/Era:''' Default

'''Version:''' 0.1

'''Forum:''' -

'''Note:''' (Adamant14) Does not work at all.

=== Panther Lord ===

''The Imperialists ambitions of pushing into the Sea States have been repeatedly thwarted and now they turn their attentions elsewhere. You are an outcast Darklander now living as a mercenary in the Sea States and the rumors you hear indicate that they will be coming to your people. Though an outcast you do not wish to see them subjugated. The spirit whose friendship caused you to be an outcast has a plan that might allow you to save them.''

'''Author:''' Velensk

'''Maintainer:''' Lavender

'''Status:''' Finished

'''Length:''' 14 scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Era of Four Moons, Darklanders (+ a wide variety of mercenaries)

'''Version:''' 1.0.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34318

=== Rebellion in the North ===

''A great orcish uprising tends to destabilise the Northlands. As the future Lord Protector of the Northern Alliance you have to crush the rebellion and establish peace again."

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 24 playable scenarios / 3 dialogue only,2 cutscenes

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Loyalists, Dwarves, Gryphons, Merfolk

'''Version:''' 1.1.12

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=33059

=== Return of the Monster ===

''It was time for Amailoss, born from the naga queen's last egg, to leave home. Time for him to grow into a leader in his own right, and eventually become the guardian and leader of another naga city. But along the way, he became friends with an unusual mud-crawler, they met a strange young monster, discovered that a spirit had escaped from an orc prison, and the mystery of that spirit became a grave challenge for Amailoss and the many races in the region....''

''A naga campaign, involving elves, orcs, saurians, turtle-like races, and some monsters.''

'''Author:''' SkyOne

'''Status:''' Complete

'''Length:''' 16 playable, 2 dialog scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon

'''Faction/Era:''' Default with additions. You play a custom naga faction and carapaces (a turtle-like race).

'''[http://units.wesnoth.org/1.10/Return_of_the_Monster/en_US/Return_of_the_Monster.html Custom units]'''

'''Version:''' 0.7.1

'''Required Wesnoth version:''' 1.10.x

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36438

=== Return to Noelren ===

'''Status:''' Complete.

'''Length:''' 26 scenarios + 7 cut scenes

'''Author:''' Pyrophorus

'''Description:''' ''A story in the first Dark Age of Wesnoth. See how various heroes stick together to shun the threat of black magics, restore the secret kingdom of Noelren and install Garard I on the throne of Wesnoth. This campaign features complex scenarios, unusual objectives and units, emphasizing more on story and adventures than hardcore fighting.''

'''Version: ''' 0.7.6

'''Requirements:''' BfW 1.10 (not tested on 1.11)

'''Difficulty:''' Easy, unbalanced

'''Style:''' Skirmish, RPG, Large Battle, Simulation

'''Faction/Era:''' Default + custom units

'''[http://units.wesnoth.org/1.10/ReturnToNoelren/en_US/ReturnToNoelren.html Custom Units]'''

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34685#p501026

'''Note:''' (Adamant14) I never saw so much fantastic and new ideas in one single UMC, wow!

=== Return to Ruins ===

''The humble farmers of Vertegris are summoned by Erik the General of Weldyn to put an end to an orcish raiding party. If they knew what would befall their former home... They never would have left. This is a relatively short campaign with 8 scenarios, It is still undergoing changes.''

'''Author:''' Jeff Stevens (Ulfsark)

'''Composer:''' Paul Fredericks (paulfredericksmusic.com)

'''Status:''' Complete

'''Length:''' 7 scenarios + 1 dialogue-only

'''Difficulty:''' Easy,Normal,Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default,(Loyalists, Outlaws)

'''Version:''' 0.5.1

'''Required Wesnoth version:''' 1.10.x

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37790&sid=9059f18497cda1219f42a626544d0ffd&p=540646#p540646

'''Note:''' (Adamant14) You play a short campaign with just a few units. Playable in a few hours, nevertheless it is fun to play.

=== Salt Wars ===

''Introductory campaign for the Era of Four Moons.''

''As an officer of one of the Sea States you must defend your organization from aggressive rivals.''

'''Author:''' Velensk

'''Maintainer:''' Lavender

'''Status:''' Complete

'''Length:''' 5 scenarios

'''Difficulty:''' Easy

'''Style:''' Skirmish

'''Faction/Era:''' Era of Four Moons, Sea States

'''Version:''' 0.2.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31498

=== Saving Elensefar ===

''Meneldur, elvish mariner of Elensefar, is driven to sea by the same orcs who attacked the city. He must gather an army willing to fight for him to regain Elensefar, his adopted homeland.''

'''Author:''' Turin

'''Maintainer:''' trewe

'''Status:''' Finished

'''Length:''' 1 year (around 12 scenarios)

'''Difficulty:''' Normal

'''Style:''' Skirmish, RPG, Simulation

'''Version:''' 1.5.2

'''Faction:''' Default Era

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?t=3072&start=0

'''Wiki:''' [[SeafaringCampaign]]

'''Note:''' Labeled as Expert, recruit list changes in all scenarios.

=== Shameless Crossover Excuse ===

''Fugitive dark sorcerer Gwiti Ha'atel discovers he has the power to mess with Wesnoth's continuity. His quest for revenge on the NPCs who have used his portraits will lead him through perils untold and in-jokes unnumbered, but shall pale before the horror he finds at his quest's end.''

'''Author:''' Orcish Shyde, Mountain_King

'''Status:''' Complete

'''Length:''' 9 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Version:''' 1.1.0

'''Faction:''' Undead

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=32016&start=15

=== Swamplings ===

''Banished by Yushnak the Ponderer, a tribe of lowly swamp goblins endure in the deadly mire of Pogo Bog. Four centuries before the founding of Wesnoth, this is the story of the goblins' struggle against the intrigues and betrayals of the greater races, and the rise of the first wolf rider.''

'''Author:''' John Rawlins (boru)

'''Status:''' Complete

'''Length:''' 14 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Version:''' 1.1.7n

'''Faction:''' Goblins

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=29784

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Swamplings Players Review]

=== Talentless Mage===

''Humorous and silly campaign about mage apprentice who has managed to learn only one simple spell in thirty years.''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 11 playable scenarios + 3 dialogue scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Noob Faction

'''Version:''' 1.1.0

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=27608]

'''Review:''' [http://wiki.wesnoth.org/index.php?title=Guide_to_UMC_Campaigns/Players_Reviews&action=submit#Talentless_Mage Player's review]

=== The Dark Alliance===

''Prince Terhar lived two years with elves. Little did he expect what would happen when he returned back to Weldyn.''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 11 or 10 playable scenarios depending on the branch you take (+ 5 dialogue scenarios)

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default: Recruit list changes in almost every scenario

'''Version:''' 1.0.3"

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=26924

=== The Dark Hordes ===

'''Status:''' Incomplete/WIP

'''Length:''' 11/?

'''Author:''' Circon

'''Maintainer:''' Various

'''Description:''' Lead fugitive dark sorcerer Gwiti Ha’atel to mastery of the undead hordes.

'''Version: '''

'''Requirements:'''

'''Difficulty:'''

'''Style:''' Skirmish

'''Faction/Era:''' Default undead

'''[http://units.wesnoth.org/1.10/The_Dark_Hordes/en_US/The_Dark_Hordes_1.html Custom Units]'''

'''Walkthrough:''' [[TheDarkHordes]]

'''Forum:''' [[http://forums.wesnoth.org/viewtopic.php?f=8&t=16576&]]

=== The Devil's Flute ===

'''Status:''' Complete, unmaintained

'''Length:''' 10 scenarios

'''Author:''' lipk

'''Description:''' Creona, the well-known assassin, gets a strange job from a strange person. So, in fact, it's no surprise that things take a strange turn...

'''Version:''' 0.1.4c

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish, Minigames

'''Faction/Era:''' Outlaws

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36044

=== The Earth's Gut ===

''The year is 515YW. You are the young dwarven leader Hamel. Your tribe in the caves of Knalga is under pressure from its enemies, and resources are growing scarce. In order to forge the weapons required to resist your enemies, you must set forth and collect what ores and minerals remain.''

'''Author:''' Anonymissimus

'''Maintainer:''' Anonymissimus

'''Status:''' Incomplete

'''Length:''' 21 scenarios

'''Difficulty:''' Normal

'''Style:''' Dungeon

'''Faction/Era:''' Default, dwarves.

'''[http://units.wesnoth.org/1.10/The_Earths_Gut/en_US/the_earths_gut.html Custom units]'''

'''Version:''' 0.2.11

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=26800

'''Note:''' This campaign is a "Dwarvish dungeon crawler" and is intended to be challenging for experienced players on hard whilst suitably easy on easy.

=== The Epic of Vaniyera ===

''The expansionist Lavinian Legion, led by the Imperator himself, has invaded the northern forests of the Sidhe, or Wild Elves. It is up to Leithan the Thunderblade and his advisor Vaniyera to push its armies back where they came from...''

'''Author:''' oreb, turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 6 scenarios

'''Difficulty:''' Hard (Don't be fooled by "novice level" in the campaign description, this one is very hard.)

'''Note:''' (Maintainer) Working on this issue, the next release (due at the end of November, hah!) should bring easy difficulty back to the level of a reasonable introduction to the IE, while the hard difficulty will also become slightly easier. With any luck, this will be the last release before version 1.0 of the campaign].

'''Style:''' Skirmish

'''Faction/Era:''' Imperial Era, Sidhe.

'''Version:''' 0.9.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=19490

=== The Fall of Wesnoth ===

''As the beloved human empire of Wesnoth becomes lazy and arrogant in its peaceful state of happiness, Emperor Dantair demands the creation of another sun in a bid to destroy all evil. Or is it all for a different purpose? A man named Alitar sees it that way, and now he must survive the most evil inhabited lands if he is to stop chaos from rising, and Wesnoth from falling... This is the story of The Fall of Wesnoth.''

'''Author:''' Pewskeepski

'''Status:''' 1st part complete, 2nd WIP.

'''Length:''' 10 playable scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Outlaws

'''[http://units.wesnoth.org/1.10/The_Fall_of_Wesnoth/en_US/The_Fall_of_Wesnoth-1.html Custom units]'''

'''Version:''' 1.0.8

=== The Founding of Borstep ===

''The chieftain of your tribe has become decadent and weak. Take over, and lead your people to a better home--whether it is already occupied or not. The Northlands in year 9W are a barbaric place, but anyone who stands in your way will learn the power of orcs!''

'''Author:''' Beetlenaut

'''Status:''' Complete

'''Length:''' 10 and 1 dialogue only

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default, Northerners

'''[http://units.wesnoth.org/1.10/The_Founding_of_Borstep/en_US/The_Founding_of_Borstep.html Custom units]'''

'''Version:''' 1.1.1b

'''Note:''' (Kanzil) I find the protagonist hard to sympathise with. Also, most scenarios contain interesting twists. For example, in one, each time you killed a boar it gives you extra health.

'''Note:''' (beetlenaut--author) In most Orcish campaigns the leader is heroic or just wants peace. Krag-Ubor wants plunder and battle like all enemy Orcs in other campaigns. I '''hope''' you don't sympathize too strongly, but I don't think you need to in order to enjoy the game play.

=== The Keep ===

''A lone keep in frosty woods against enemies from far beyond.''

'''Author:''' DeRaid

'''Status:''' Broken (Does not work at all)

'''Length:''' 0 playable scenarios

'''Difficulty:''' Broken

'''Style:''' ?

'''Faction/Era:''' Default

'''Version:''' 0.1

'''Forum:''' -

'''Note:''' (Adamant14) Does not work at all.

=== The Library of Kratemaqht ===

''An ancient story from the old continent.''

'''Author:''' Rich Marinaccio (cephalo)

'''Status:''' Complete

'''Length:''' 17 scenarios

'''Difficulty:''' Unbalanced (some scenarios are Easy - some rather Hard)

'''Style:''' Skirmish, RPG

'''Faction/Era:''' Loyalists and custom units.

'''[http://units.wesnoth.org/1.10/Library_Of_Kratemaqht/en_US/The_Library_Of_Kratemaqht.html Custom units]'''

'''Version:''' 1.0.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37798

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#The_Library_of_Kratemaqht Players Reviews]

'''Notes:''' (Adamant14) This campaign has a thought-out story, shows a great love for detail;
It includes a great custom Dragon, some brilliant custom images (fire, burning houses, burning forest) that makes the scenery / maps look very nice.

=== The Roar of the Woses ===

''When the construction of a dam threatens the existence of her home, Kylix is forced on a journey to stop it.''

'''Author:''' Alarantalara

'''Status:''' Finished

'''Length:''' 10-11 scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default with Additions (primarily Saurians, Nagas, Woses)

'''Version:''' 1.2.7

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=29830

'''Note:''' (author) Potentially unbalanced on Hard difficulty due to experiments with non-standard ways to increase difficulty. This issue does not exist on the lower difficulty levels.

=== The Three Elves ===

''Three elves have just begun their adventure in the northern swampland. Will they become heroes or will they be responsible for another undead expansion?''

'''Author:''' Stanislav Hoferek

'''Maintainer:''' trewe

'''Version:''' 0.9

'''Status:''' Complete

'''Difficulty:''' Easy

'''Length:''' 8 scenarios + 2 dialogue

'''Style:''' Skirmish

'''Faction:''' Default (Elves)

'''Forum:''' (does it have one?)

=== The Sojournings of Grog ===

''Grog (as starred in Under the Burning Suns) goes home.''

'''Author:''' Peter Christopher, Thomas Hockings

'''Maintainer:''' Elvish_Hunter

'''Status:''' Finished

'''Length:''' 18 playable scenarios in 2 parts

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon, Large Battle

'''[http://units.wesnoth.org/1.10/The_Sojournings_of_Grog/en_US/The_Sojournings_of_Grog.html Custom units]'''

'''Faction/Era:''' Default. Most of the time you play trolls and some desert elves accompanying Grog.

'''Version:''' 3.0.1

=== The Unstoppable Legion ===

''Horseback campaign. The kingdom of Suveran, far away from Wesnoth, is under attack. Only Deuterus, a Great Druid, knows their weakness and only Viktor, a young noble, dares go on the quest to stop them.''

'''Author:''' Chris Neville-Smith (Chris NS)

'''Maintainer:''' Chris Neville-Smith (Chris NS)

'''Status:''' WIP

'''Length:''' Currently 15 playable sceanrios, including a fork of three paths near the beginning, and another fork of two paths later on.

'''Difficulty:''' Normal

'''Style:''' Mainly Skirmish

'''[http://units.wesnoth.org/1.10/The_Unstoppable_Legion/en_US/The_Unstoppable_Legion.html Custom units]'''

'''Faction/Era:''' Play mounted units, including expanded Cavalryman line, and completely new Bowrider line. Joined later by Dwarves. Main enemies are the dark fighters and dark cultists.

'''Version:''' 0.8.7

=== The White Troll ===

''The story of a white troll whelp with strange magic powers, who is raised in an elvish village.''

'''Author:''' Wesnoth Italian Forum

'''Status:''' Complete

'''Length:''' 8 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default: you play with elves and trolls. Also features custom units with special advancements and abilities.

'''[http://units.wesnoth.org/1.10/White_Troll/en_US/white_troll.html Custom Units]'''

'''Version:''' 0.7.5

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=38828

=== To Lands Unknown ===

''This is the story of Mehir, the Summoner, and his journey to lands unknown.''

'''Author:''' inferno8

'''Status:''' Complete

'''Length:''' 20 scenarios, 4 dialogue only

'''Difficulty:''' Intermediate (Era of Magic)

'''Style''': Skirmish, Dungeon

'''Era:''' Era of Magic

'''Version:''' 1.6.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31799

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#To_Lands_Unknown Players Review]

=== Unlikely Alliance ===

''Play as the members of an alliance between the elves, drakes, and undead after the Fall of Wesnoth.''

'''Author:''' Creativity

'''Status:''' Broken ( Abandoned )

'''Length:''' 2 broken scenarios

'''Difficulty:''' Unbalanced

'''Style:''' -

'''Faction/Era:''' -

'''Version:''' 0.1

'''Forum:''' -

'''Note:''' (Adamant14) Did not work at all. Seems abandoned.

=== Up from Slavery ===

''The Orcei are captives in the imperial city of Lavinium, gladiators performing for the emperor Optus Maximus. All it will take, however, is one orc to lead his people to freedom. The Samnis called Sparxus may be that orc.''

'''Author:''' turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 7 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish, Arena (= No recruit, small group gladiator fights)

'''Faction/Era:''' Imperial Era, Orcei Gladiatores

'''Version:''' 0.6.0

'''Note:''' (Maintainer) At some point, I am intending to completely re-work this campaign to be a multi-player campaign, with one side led by Sparxus and one by Gravirivus. If anyone would like to take this on or has ideas for how to accomplish this, let us know. Nevertheless, its playable as a single player campaign now with some nice ideas that could be developed further.]

=== Warmaster ===

''One day the scout of your king brings a mysterious little stone, called Zrai-Stone, back from one of his trips. Soon that stone causes a lot of trouble...''

'''Author:''' Conkinator

'''Maintainer:''' trewe

'''Version:''' 1.3.5

'''Status:''' Finished

'''Length:''' 16 battle + 2 bonus + 1 epilogue scenarios

'''Difficulty:''' Hard

'''Faction:''' Default (loyalists)

'''Style:''' Skirmish, Survival

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=15527

=== Way of Dragon ===

''The story of what might happen if a person against his will transform into a dragon...''

'''Author:''' DrakeDragon

'''Status:''' Complete

'''Length:''' 7 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish/RPG

'''Faction/Era:''' Default Loyalists

'''Version:''' 1.2.0

'''Forum:''' [http://forums.wesnoth.org/viewtopic.php?f=8&t=37876 Wesnoth Forum] [http://uporoom.ru/index.php/topic,179.0.html Russian Forum]

'''Note:''' (Adamant14) Promising short campaign, you play with just a few units.

== Battle for Wesnoth 1.11.x - development ==

''Campaigns available in the 1.11.x development version.''

''Please note: Battle for Wesnoth 1.11.0 features a bug that messes up the selection of difficulty levels.''

=== Antar, Son of Rheor ===

''This is the story about a young Lord and his first mission; sent by his father the young Lord Antar has to relieve his neighbours; he has to convince the Elves and Dwarves to ally him; he has to fight against hordes of Orcs and Endless Undead; and finally he has to defeat Mal Kazur, the mastermind who is behind all the evil.''

'''Author:''' Adamant14

'''Status:''' WIP

'''Length:''' 9 playable scenarios / 1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Loyalists and Elves (feat. fencer as main hero + various allies)

'''Version:''' 0.9.9

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36075

'''Note:''' (Adamant14) The campaign did not work with BfW version 1.11.0, or BfW version 1.11.1, so please use BfW version 1.11.2 or later!

=== A Song of Fire ===

''''''Part I: The Last War''' - In a long-forgotten era, at the heart of the Great Continent, an ancestral evil is awakened, threatening to destroy the whole world. Follow young Myra in the war that will alter the future of Irdya and its peoples forever.''

''''''Part II: Towards the Rising Sun''' - After the vicious Last War, Myra has become the new leader of Aragwaithi and Windsong alike. Albeit young and shaken by many losses, she must steel herself to lead her people through the vast and hostile Hannuk Steppes. However, her journey will take them all farther than in their wildest dreams. Furthermore, Myra must deal with the evil influence of the mysterious red gem she found after the last battle.''

''''''Part III: Raging Skies''' - The refugees have finally found a new home: families are built, allies are made and, for the first time in years, Myra and her friends know peace. However, when everything seems normal, ambition and thirst for power cause the break out of a continental war. And, amidst this new storm, an old foe rises agan, more powerful than ever. Witness the end of the song of Irdya's first great heroine.''

'''Author:''' revansurik

'''Status:''' Complete

'''Length:''' 36 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Default+War of Legends

'''Version:''' 0.3.3

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=38210

=== Birth of a Lich ===

''This is the life story of the dreaded lich Malifor, his struggle as a mage outcast, the orcish conquest of the northlands and his transformation to quench the thirst for revenge''

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 12 playable scenarios / 2 dialogue only

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle, Dungeon

'''Faction/Era:''' Human outlaws, dwarves, undead

'''[http://units.wesnoth.org/1.10/Birth_of_a_Lich/en_US/Birth_of_a_Lich.html Custom Units]

'''Version:''' 1.0.3

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37057

=== Coming of the Storm ===

''A new recruit joins the imperial army, eager to change the world and see combat. Little does he realise just how much action he will get and where his journey will take him. ''

'''Author:''' TrashMan

'''Status:''' WIP

'''Length:''' 26 playable scenarios / 4 dialogue only

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle, Dungeon

'''Faction/Era:''' Default

'''Version:''' 1.2.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23361

=== Legend of Far North ===

''The tale of the legendary Black Eye Karun,depicting his rise to power, his successes and his brutal assassination.'

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 16 playable scenarios / 1 dialogue only,1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Orcs, Trolls, Saurians, Nagas

'''[http://units.wesnoth.org/1.10/Legend_of_Far_North/en_US/Legend_of_Far_North.html Custom Units]'''

'''Version:''' 1.0.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34769

=== Legend of the Invincibles ===

'''''Part I: Shrouded in Darkness''' (5 chapters, 90 scenarios) - A pair of heroes, after stopping an orcish thread, are outcast into caves, where they have no other choice than to become liches in order to survive. They preserved their original appearance and moral principles, and fight in various skirmishes against evil (although using evil methods sometimes), until the Fall, when they are buried alive under the ashes of the third sun.''

'''''Part II: Into the Light''' (4 chapters, 96 scenarios at the moment) - Long after the Fall, the lich heroes awaken. Searching for more power, they manage to resurrect themselves as living beings, but this time more powerful and ridden of the evil within. But the evil from inside them did not cease to exist, and started a campaign to conquer the world. Stopping the campaign caused an even worse disaster...''

'''Author:''' Dugi

'''Status:''' WiP (but Part I might be considered complete)

'''Length:''' 185 (+7 talk-only) scenarios at the moment

'''Difficulty:''' Normal

'''Style:''' mostly Skirmish and Dungeon (all other styles are present as well, but less frequently)

'''Faction/Era:''' Elves, Loyalists, Undead, Dwarves; but they advance past their usual maximum level

'''Version:''' 2.5.0

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Legends_of_the_Invincibles Players Review]

'''Note:''' The most unique feature of this campaign is its RPG-like unit development system, enemies drop items units can use, leaders are stronger than most usual units and all units get AMLA (after maximum level advancement) after reaching their maximum level (that is also increased by a load of additional level 4 units).

=== Rebellion in the North ===

''A great orcish uprising tends to destabilise the Northlands. As the future Lord Protector of the Northern Alliance you have to crush the rebellion and establish peace again."

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 24 playable scenarios / 3 dialogue only,2 cutscenes

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Loyalists, Dwarves, Gryphons, Merfolk

'''Version:''' 1.1.12

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=33059

=== Ruthless ===

''A bard (an aging criminal) is walking in wasteland. Nothing but two hands in his pockets, and nothing but stones around. Suddenly he sees a knight on errand--a dangerous opponent, especially in broad daylight. The two strangers are soon sitting by the campfire, and the bard is telling a story.
(Beginner level, 10+ fights).''

'''Author:''' homunculus

'''Status:''' Finished

'''Length:''' 12 playable scenarios + 5 cutscene scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default (Orcs)

'''Version:''' 1.0.4

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37874

'''Note:''' (Adamant14) Recommendable campaign, with smart unusual ideas and a good detailed story.
You fight with few units on small but perfect maps. About the difficulty: The author describes his campaign as 'beginner level', but for me the difficulty is rather NORMAL than EASY.

== Player Reviews ==

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews Link to Players Reviews]'''

[[Category:Campaigns|*]]

Guide to UMC Content

2013-06-04T09:54:40Z

Pyrophorus: /* Antar, Son of Rheor */

''This is a guide to the current (1.10.x/1.11.x) UMC campaigns for players. It aims to provide all the information not only about the story, but also about completion, difficulty and playing style of the campaign. See http://forums.wesnoth.org/viewtopic.php?f=8&t=37476 for further information, for currently non-available UMC-content please refer to http://forums.wesnoth.org/viewtopic.php?f=8&t=36733. Please edit, it is a wiki.''

=== Blueprint ===

'''Status:'''
* Broken = Does not work at all
* Incomplete = Partially written, no progress
* WIP = Partially written, progress
* Complete = Completely written, but buggy as well as potential balance issues.
* Finished = Completely written, minimal to no bugs, slight balance issues possible.

'''Length:'''

'''Author:'''

'''Maintainer:''' if not maintained by the author anymore.

'''Description:'''

'''Version: '''

'''Requirements:'''

'''Difficulty:'''

Please note: Often campaigns introducing new mechanics are listed as expert level on the add-on server, here difficulty means the raw difficulty after the mechanics are understood.

* Unbalanced = If you can't beat the hard mode, it isn't necessarily unbalanced, but if the difficulty changes erraticly from one scenario to the next and only people using the debug mode have seen the final, then it is.
* Easy
* Normal
* Hard

'''Style:'''

Please note: Many campaigns will feature more than one style. Please list the most significant ones.

* Skirmish = small to medium sized armies, your standard Wesnoth gameplay
* Dungeon = long and narrow tunnels (not every underground scenario is a dungeon, a dungeon isn't necessarily underground)
* RPG = role playing game elements such as talking with non-player-characters, item collection, dependency on a party of very few adventurers without or limited recruits
* Survival = being exposed to changing, spawning enemies while remaining on the same map
* Large Battle = large number of units on the battlefield, sizely maps
* Simulation = campaigns feat. terrain modification, alternative resources
* Boss battle = the challenge is to defeat a single powerful enemy unit
* Minigames = there are puzzles and minigames in the campaign that significantly differ from standard Wesnoth gameplay

'''Faction/Era:'''

* Era for the whole campaign and more specifically the faction or unit composition you field.

'''Custom units:'''

* Link to the unit tree for cases that don't feel sufficiently described by Faction / Era entry.

'''Forum:'''

* Links to the feedback and development threads at forums.wesnoth.org

== Battle for Wesnoth 1.10.x - stable ==

''Campaigns available in the 1.10.x stable version.''

=== Aldur The Great ===

''This is a story about Aldur the Great.''

'''Author:''' pintercsabi

'''Status:''' Complete, but unbalanced

'''Length:''' 5 playable scenarios

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish

'''Faction/Era:''' Default

'''Version:''' 1.2.2

'''Forum:''' -

'''Note:''' (Adamant14) Short unbalanced campaign, maybe abandoned. You fight with Peasants, Ruffians and Woodsman against Orcs

=== Alfhelm the Wise ===

''This is the tale of Alfhelm, called by some the Wise, son of Alfric Conqueror. This is the tale of his victories over his enemies, and his rise to power in the clans of Marauderdom. This is the tale of his journey south and his destruction of the Lavinian Empire. And this is the tale of his demise in the dark forests far to the east of his homeland.''

'''Author:''' turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 15 gameplay scenarios

'''Difficulty:''' Moderate

'''Style:''' Skirmish

'''Faction/Era:''' Imperial Era, Marauders.

'''Version:''' 0.6.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=17144

'''Note:''' (Maintainer) Though this campaign is complete and playable the whole way through, the code is four years old and pretty buggy. If you notice any errors while playing, please let me know and I'll incorporate the fixes into my next revision as soon as possible.]

=== A New Order ===

'''Author:''' szopen

'''Status:''' Finished.

'''Length:''' 45 scenarios.

'''Description:''' The old kingdom of Wesnoth has fallen before barbarian hordes. The occupying barbarians are on the brink of civil war, the seeds of Wesnothian rebellion are kept alive by old legends, while bandits and Khalifate mercenaries roam the land. Can Gawen Hagarthen unite these disparate factions against a common foe?
Note: This campaign contains mature themes, some of which may be unsuitable for children.

'''Version: ''' 1.2.15

'''Requirements:''' Requires BfW 1.10. In addition, you have to install Era Khalifate add-on; the Akladian Music package is optional

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Akladians, Khalifate

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=6486

'''Note:''' (Pyrophorus) Certainly one of the most mature and well designed campaign in add-ons. A must.

=== Antar, Son of Rheor ===

''This is the story about a young Lord and his first mission; sent by his father the young Lord Antar has to relieve his neighbours; he has to convince the Elves and Dwarves to ally him; he has to fight against hordes of Orcs and Endless Undead; and finally he has to defeat Mal Kazur, the mastermind who is behind all the evil.''

'''Author:''' Adamant14

'''Status:''' WIP

'''Length:''' 9 playable scenarios / 1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Loyalists and Elves (feat. fencer as main hero + various allies)

'''Version:''' 0.9.9

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36075

=== A Story of the Northlands ===

''A story of life and death in a remote village of the Northlands. Your village has been overrun by an orcish raid. You fight for its freedom while you wait for help to arrive.''

'''Author:''' zepko

'''Status:''' Complete

'''Length:''' 10 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default + additions: you play with a custom faction of outlaws and with a custom party of loyalist knights.

'''[http://units.wesnoth.org/1.10/A_Story_of_the_Northlands/en_US/A_Story_of_the_Northlands.html Custom Units]'''

'''Version:''' 1.0.0

=== A Vision Blinded ===

''Defend the northern forest against what appeared like a routine orcish raid, and unravel the greater conspiracies that lie below its waves.''

'''Author:''' LemonTea

'''Maintainer:''' AxalaraFlame

'''Status:''' Complete

'''Length:''' 13 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves (+ Trolls, Outlaws)

'''[http://units.wesnoth.org/1.10/A_Vision_Blinded/en_US/A_Vision_Blinded.html Custom units]'''

'''Version:''' 0.6.6

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23463&hilit=a+vision+blinded

=== Battle Against Time===

''Rescue fellow orcish warchief before he is executed. (This is not a normal campaign. It is experiment with carryover system. You will start with defined number of turns and gold. You will only have that many turns to play through the whole campaign. There is no finish bonus and gold carryover is always 100%.)''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 4 playable scenarios + 1 prologue scenario

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default: Orcs

'''Version:''' 1.0.0

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=27319

=== Besieged Druids ===

''A elvish school for druids comes under attack by goblins. It seems more than just a routine raid; is there something more sinister behind this attack? - In Beseiged Druids, you control Eärendil, the surviving teacher at the school, and the many and varied initiates. Not all of these are ordinary students; many have been experimenting with other forms of magic, while others are simply overachievers in some area of study. Unfortunately, they are not especially good at combat, at least initially. Together with a very small contingent of surviving guards, it is up to these students to save the island of Aleron from disaster.''

'''Author:''' Celtic Minstrel

'''Status:''' Complete

'''Length:''' 9 scenarios

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves

'''[http://units.wesnoth.org/1.10/DruidSiege/en_US/celmin-druid-siege.html Custom units]'''

'''Version:''' 1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37342

=== Birth of a Lich ===

''This is the life story of the dreaded lich Malifor, his struggle as a mage outcast, the orcish conquest of the northlands and his transformation to quench the thirst for revenge''

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 12 playable scenarios / 2 dialogue only

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle, Dungeon

'''Faction/Era:''' Human outlaws, dwarves, undead

'''[http://units.wesnoth.org/1.10/Birth_of_a_Lich/en_US/Birth_of_a_Lich.html Custom Units]

'''Version:''' 1.0.3

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37057

=== Bitter Revenge===

''Amidst the strife and turmoil of the first Dark Age of Wesnoth, a time of transient monarchies and conspiracies against the Crown, the boy Darith witnesses the murder of his father by a general of Wesnoth. Follow Darith's quest for retribution in this treacherous tale of betrayal, deceit, love, remorse, and vengeance.''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 11 playable scenarios + 4 dialogue only

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default (mostly outlaws and undead, custom units)

'''Version:''' 1.1.0

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=26699

=== Cities of the Frontier ===

''Settle a new town in the wilds north of the Great River.''

''This campaign makes several changes to the standard Wesnoth game mechanics, and focuses on city-building and gold management.''

'''Author:''' esci

'''Status:''' Complete

'''Length:''' Not fixed, approximately 6-10 seasons of 36 turns each

'''Difficulty:''' Normal

'''Style:''' Simulation, Survival

'''Faction/Era:''' Default, Loyalist

'''[http://units.wesnoth.org/1.10/Cities_of_the_Frontier/en_US/Cities_of_the_Frontier.html Custom units]'''

'''Version:''' 0.5.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36004

=== Considerate Dead ===

''As the wind goes on and on, people discover necromancer aren't always bad. Made by tribes45 - No scenarios are done, 4 playable out of ??.''

'''Author:''' tribes45 aka tribes55

'''Status:''' Incomplete, unbalanced, abandoned

'''Length:''' 5 scenarios

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish

'''Faction/Era:''' Default

'''Version:''' .009

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36522

=== Count Kromire ===

''You are the blood son of a vampire lord, however when the might of the celestial crusades comes knocking, and your father is slain, you flee your lands. However you intend to return, to restore the lands of Kromire to the Kromires, to avenge your father, and most importantly, to make sure that no celestial ever dares come into your mountains again.''

'''Author:''' Velensk

'''Maintainer:''' currently none

'''Status:''' Complete

'''Length:''' 9 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Era of Myths, Vampires

'''Version:''' 1.3.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=21560

=== Elvish Dynasty RPG ===

''You are the new ruler of an elvish kingdom! Can you lead your people to glory? This campaign is highly randomized so it will be different every time you play!''

''Sequel to Ooze Mini-Campaign''

'''Author:''' spencelack

'''Maintainer:''' Wesbane

'''Status:''' Complete

'''Length:''' 10 years, in each year choice between dialogue and fighting scenario (selected out of a large pool of possible scenarios)

'''Difficulty:''' Normal

'''Style:''' RPG, Skirmish

'''Faction/Era:''' Default, Elves

'''Version:''' 0.9.9b

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=28627

=== Fall of Silvium ===

''You are Caius Regilius, Tribune of the province of Silvia, located in the northmost reaches of the Lavinian Empire at the height of its power. But the Empire has overextended itself, The city of Silvium lies seperated from the rest of the Empire by the mountains of Arendia, and is sandwiched between the Marauders and the Sidhe... war is inevitable, and the province of Silvia will almost certainly fall.''

'''Author:''' turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 8 scenarios

'''Difficulty:''' Medium

'''Style:''' Skirmish

'''Faction/Era:''' Imperial Era, Lavinian Legion.

'''Version:''' 0.6

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=31&t=24356

'''Note:''' The final level of this campaign is not supposed to be winnable. It's a final blaze of glory and chance to use all your high-powered units, but to 'win' the campaign, you must lose...the ending is similar to a certain mainline campaign, but predates it.

=== Fate of a Princess ===

''Part I: Baldres, a notorious robber baron, flees Wesnoth with his followers and sets off into the northlands to evade the king's justice. The baron's deeds and misdeeds are to change the balance of power between orcs and non-orcs throughout the northlands, and will carry consequences long after his eventual death.''

''Part II: The Greenwood elves face a crisis which demands the return of the queen's estranged half-elven half-sister, Baldres' daughter. Two brave young elves must make a perilous journey to find her and bring her back to her former home. If they fail, the whole northlands will be engulfed in war with the resurgent orcs...''

'''Author:''' SkyOne, mich, simonsmith

'''Status:''' Finished

'''Length:''' 26-29 scenarios (some dialogue-only), 2 parts

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon

'''Faction/Era:''' Default with additions. You play two different, unique cross-faction combinations in each part.

'''[http://units.wesnoth.org/1.10/Fate_of_a_Princess/en_US/Fate_of_a_Princess.html Custom units]'''

'''Version:''' 0.9.17

'''Required Wesnoth version:''' 1.9.12 or later

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=26327

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Fate_of_a_princess Players Review]

=== Forgotten Kingdom ===

''Help Orlog, a troll chieftan, lead his people to safety in the underground and discover an ancient power long forgotten.''

'''Author:''' Limabean

'''Maintainer:''' Chrysophylax

'''Status:''' Incomplete ( but all scenarios playable and balanced )

'''Length:''' 9 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Goblins, Trolls

'''[http://units.wesnoth.org/1.10/Forgotten_Kingdom/en_US/Forgotten_Kingdom.html Custom units]'''

'''Version:''' 0.1.7

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23483

'''Note:''' (Adamant14) This campaign includes a custom Troll line. A good campaign, I hope Limabean and/or Chrysophylax will finish it.

=== Forward they Cried ===

''You are the leader of an advanced detachment that has been tasked with capturing a bridgehead while the main army prepares to attack. It should be a simple enough assignment.''

'''Author:''' Glowing Fish

'''Maintainer:''' Lord-Knightmare

'''Status:''' Finished

'''Length:''' 1 scenario ( rather a single scenario than a campaign )

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default Loyalists

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23656&p=350126&hilit=forward+they+cried#p350126

'''Version:''' 1.0.0

'''Note:''' (Adamant14) Only a single scenario, but a great scenario.
(UnwiseOwl) You wouldn't want to stop thinking for a turn, and it's good for the first few turns, but this one leaves me wanting more.

=== Galuldur's First Journey ===

''While the belligerence of orcs is nothing new, their intensifying attacks on a fledgling colony of elves in Pindir Forest begin to show signs of a deeper malice, forcing Galuldur, the young son of the colony's adventurous founder Galur, to venture out of his forest's friendly trees in search of help. His simple errand quickly turns into a frantic quest to unearth the roots of the mysterious evil threatening his people. As you lead him through unknown lands, Galuldur, forced to match wits with unexpected adversaries at nearly every turn in a desperate attempt to save his world, quickly learns that the world is neither a friendly nor a simple place.''

'''Author:''' mattsc

'''Status:''' Complete

'''Length:''' 8-9 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves

'''[http://units.wesnoth.org/1.10/Galuldur/en_US/Galuldur.html Custom units]'''

'''Version:''' 1.1.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31895

=== Grnk the Mighty ===

''All his life, puny little goblin Grnk the Frail had been dreaming about leaving the orcs and starting a better life. When he finally arrives in the human town of Shmaltupp, he realizes that the world is not as black and white as he had imagined. He also discovers that he is no ordinary goblin. Follow Grnk the Frail on his path to becoming Grnk the Mighty.''

'''Author:''' mattsc

'''Status:''' Part I complete

'''Length:''' 13 scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish, RPG

'''Faction/Era:''' Default, changing (no standard army building gameplay)

'''[http://units.wesnoth.org/1.10/Grnk/en_US/Grnk.html Custom units]'''

'''Version:''' 1.0.5

'''Required Wesnoth version:''' 1.9.5 or later

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34970

=== Invasion from the Unknown ===

''Episode I - Seeking the Light: Long after the Fall, the last forest elves are forced to abandon their safe valley, and find themselves resorting to the dark means of necromancy in order to survive the perils and challenges of this new harsh world. May they finally free the Great Continent from its chaos, or perish in the foolish attempt of restoring peace and life to the lands.''

''Episode II - Armageddon: As the shadow of Chaos covers the entire continent, an assorted group of foolish heroes prepares a counter-attack to the Empire, with one unique goal in their minds: defeat the evil Emperor, whoever it is. Lead these courageous living and non-living warriors to victory, and rediscover lost secrets of the history.''

'''Author:''' shadowmaster

'''Maintainer:''' Espreon

'''Status:''' Finished

'''Length:''' 26 scenarios in two episodes

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon, Boss battle

'''Faction/Era:''' Unique. You play Elves and Undead throughout the campaign + in the 2nd part Northerners and Aragwaithi.

'''Version:''' 1.90.6

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Invasion_from_the_Unknown Players Review]

'''Note:''' (taptap) Despite its acknowledged flaws (generic hero, plot holes, deus ex machina moments, gameplay issues in the 2nd part) this is undoubtedly the most iconic campaign in UMC. It single-handedly redefines the elvish history and sketches a cosmology for the ages after the fall. With the Chaos empire and its various allies it introduces an era worth of factions to single-player play. At the same time it features some of the most beautiful maps in Wesnoth and stunning art on par with mainline campaigns.

=== Invasion of Eliador ===

''A peaceful island is about to be invaded by unknadd-ons foes travelling towards the eastern shore. It is up to a family of outlaws to warn the island's inhabitants before it's too late.''

'''Author:''' Sam M. (Genosuke)

'''Maintainer:''' trewe

'''Version:''' 1.0.4

'''Style:''' RPG, Skirmish, Puzzle

'''Length:''' 10 scenarios + epilogue

'''Difficulty:''' Easy

'''Status:''' Complete

'''Faction:''' Default (outlaws)

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=6556

'''Wiki:''' [[Invasion_of_Eliador]]

=== Langrisser Sample Campaign ===

''The Imperial Knights of the Rayguard Empire have disrupted the peace of the village that was Hein's hometown, seeking only a girl named Liana. Fight to rescue Liana.''

'''Author:''' Morath

'''Status:''' Finished

'''Length:''' 1 playable scenario

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves

'''Version:''' 0.1.0.5

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36417&hilit=Langrisser

'''Wikipedia:''' [http://en.wikipedia.org/wiki/Langrisser What is Langrisser]

'''Note:''' (Adamant14) Single scenario, different from usual Wesnoth behaviour.

=== Legend of Far North ===

''The tale of the legendary Black Eye Karun,depicting his rise to power, his successes and his brutal assassination.'

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 16 playable scenarios / 1 dialogue only,1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Orcs, Trolls, Saurians, Nagas

'''[http://units.wesnoth.org/1.10/Legend_of_Far_North/en_US/Legend_of_Far_North.html Custom Units]'''

'''Version:''' 1.0.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34769

=== Legend of the Invincibles ===

'''''Part I: Shrouded in Darkness''' (5 chapters, 90 scenarios) - A pair of heroes, after stopping an orcish thread, are outcast into caves, where they have no other choice than to become liches in order to survive. They preserved their original appearance and moral principles, and fight in various skirmishes against evil (although using evil methods sometimes), until the Fall, when they are buried alive under the ashes of the third sun.''

'''''Part II: Into the Light''' (4 chapters, 96 scenarios at the moment) - Long after the Fall, the lich heroes awaken. Searching for more power, they manage to resurrect themselves as living beings, but this time more powerful and ridden of the evil within. But the evil from inside them did not cease to exist, and started a campaign to conquer the world. Stopping the campaign caused an even worse disaster...''

'''Author:''' Dugi

'''Status:''' WiP (but Part I might be considered complete)

'''Length:''' 185 (+7 talk-only) scenarios at the moment

'''Difficulty:''' Normal

'''Style:''' mostly Skirmish and Dungeon (all other styles are present as well, but less frequently)

'''Faction/Era:''' Elves, Loyalists, Undead, Dwarves; but they advance past their usual maximum level

'''Version:''' 2.5.0

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Legends_of_the_Invincibles Players Review]

'''Note:''' The most unique feature of this campaign is its RPG-like unit development system, enemies drop items units can use, leaders are stronger than most usual units and all units get AMLA (after maximum level advancement) after reaching their maximum level (that is also increased by a load of additional level 4 units).

=== Nothwards ===

''A lone keep in frosty woods against enemies from far beyond.''

'''Author:''' DeRaid

'''Status:''' Broken (Does not work at all)

'''Length:''' 0 playable scenarios

'''Difficulty:''' ?

'''Style:''' ?

'''Faction/Era:''' Default

'''Version:''' 0.1

'''Forum:''' -

'''Note:''' (Adamant14) Does not work at all.

=== Panther Lord ===

''The Imperialists ambitions of pushing into the Sea States have been repeatedly thwarted and now they turn their attentions elsewhere. You are an outcast Darklander now living as a mercenary in the Sea States and the rumors you hear indicate that they will be coming to your people. Though an outcast you do not wish to see them subjugated. The spirit whose friendship caused you to be an outcast has a plan that might allow you to save them.''

'''Author:''' Velensk

'''Maintainer:''' Lavender

'''Status:''' Finished

'''Length:''' 14 scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Era of Four Moons, Darklanders (+ a wide variety of mercenaries)

'''Version:''' 1.0.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34318

=== Rebellion in the North ===

''A great orcish uprising tends to destabilise the Northlands. As the future Lord Protector of the Northern Alliance you have to crush the rebellion and establish peace again."

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 24 playable scenarios / 3 dialogue only,2 cutscenes

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Loyalists, Dwarves, Gryphons, Merfolk

'''Version:''' 1.1.12

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=33059

=== Return of the Monster ===

''It was time for Amailoss, born from the naga queen's last egg, to leave home. Time for him to grow into a leader in his own right, and eventually become the guardian and leader of another naga city. But along the way, he became friends with an unusual mud-crawler, they met a strange young monster, discovered that a spirit had escaped from an orc prison, and the mystery of that spirit became a grave challenge for Amailoss and the many races in the region....''

''A naga campaign, involving elves, orcs, saurians, turtle-like races, and some monsters.''

'''Author:''' SkyOne

'''Status:''' Complete

'''Length:''' 16 playable, 2 dialog scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon

'''Faction/Era:''' Default with additions. You play a custom naga faction and carapaces (a turtle-like race).

'''[http://units.wesnoth.org/1.10/Return_of_the_Monster/en_US/Return_of_the_Monster.html Custom units]'''

'''Version:''' 0.7.1

'''Required Wesnoth version:''' 1.10.x

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36438

=== Return to Noelren ===

'''Status:''' Complete.

'''Length:''' 26 scenarios + 7 cut scenes

'''Author:''' Pyrophorus

'''Description:''' ''A story in the first Dark Age of Wesnoth. See how various heroes stick together to shun the threat of black magics, restore the secret kingdom of Noelren and install Garard I on the throne of Wesnoth. This campaign features complex scenarios, unusual objectives and units, emphasizing more on story and adventures than hardcore fighting.''

'''Version: ''' 0.7.6

'''Requirements:''' BfW 1.10 (not tested on 1.11)

'''Difficulty:''' Easy, unbalanced

'''Style:''' Skirmish, RPG, Large Battle, Simulation

'''Faction/Era:''' Default + custom units

'''[http://units.wesnoth.org/1.10/ReturnToNoelren/en_US/ReturnToNoelren.html Custom Units]'''

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34685#p501026

'''Note:''' (Adamant14) I never saw so much fantastic and new ideas in one single UMC, wow!

=== Return to Ruins ===

''The humble farmers of Vertegris are summoned by Erik the General of Weldyn to put an end to an orcish raiding party. If they knew what would befall their former home... They never would have left. This is a relatively short campaign with 8 scenarios, It is still undergoing changes.''

'''Author:''' Jeff Stevens (Ulfsark)

'''Composer:''' Paul Fredericks (paulfredericksmusic.com)

'''Status:''' Complete

'''Length:''' 7 scenarios + 1 dialogue-only

'''Difficulty:''' Easy,Normal,Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default,(Loyalists, Outlaws)

'''Version:''' 0.5.1

'''Required Wesnoth version:''' 1.10.x

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37790&sid=9059f18497cda1219f42a626544d0ffd&p=540646#p540646

'''Note:''' (Adamant14) You play a short campaign with just a few units. Playable in a few hours, nevertheless it is fun to play.

=== Salt Wars ===

''Introductory campaign for the Era of Four Moons.''

''As an officer of one of the Sea States you must defend your organization from aggressive rivals.''

'''Author:''' Velensk

'''Maintainer:''' Lavender

'''Status:''' Complete

'''Length:''' 5 scenarios

'''Difficulty:''' Easy

'''Style:''' Skirmish

'''Faction/Era:''' Era of Four Moons, Sea States

'''Version:''' 0.2.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31498

=== Saving Elensefar ===

''Meneldur, elvish mariner of Elensefar, is driven to sea by the same orcs who attacked the city. He must gather an army willing to fight for him to regain Elensefar, his adopted homeland.''

'''Author:''' Turin

'''Maintainer:''' trewe

'''Status:''' Finished

'''Length:''' 1 year (around 12 scenarios)

'''Difficulty:''' Normal

'''Style:''' Skirmish, RPG, Simulation

'''Version:''' 1.5.2

'''Faction:''' Default Era

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?t=3072&start=0

'''Wiki:''' [[SeafaringCampaign]]

'''Note:''' Labeled as Expert, recruit list changes in all scenarios.

=== Shameless Crossover Excuse ===

''Fugitive dark sorcerer Gwiti Ha'atel discovers he has the power to mess with Wesnoth's continuity. His quest for revenge on the NPCs who have used his portraits will lead him through perils untold and in-jokes unnumbered, but shall pale before the horror he finds at his quest's end.''

'''Author:''' Orcish Shyde, Mountain_King

'''Status:''' Complete

'''Length:''' 9 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Version:''' 1.1.0

'''Faction:''' Undead

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=32016&start=15

=== Swamplings ===

''Banished by Yushnak the Ponderer, a tribe of lowly swamp goblins endure in the deadly mire of Pogo Bog. Four centuries before the founding of Wesnoth, this is the story of the goblins' struggle against the intrigues and betrayals of the greater races, and the rise of the first wolf rider.''

'''Author:''' John Rawlins (boru)

'''Status:''' Complete

'''Length:''' 14 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Version:''' 1.1.7n

'''Faction:''' Goblins

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=29784

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Swamplings Players Review]

=== Talentless Mage===

''Humorous and silly campaign about mage apprentice who has managed to learn only one simple spell in thirty years.''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 11 playable scenarios + 3 dialogue scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Noob Faction

'''Version:''' 1.1.0

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=27608]

'''Review:''' [http://wiki.wesnoth.org/index.php?title=Guide_to_UMC_Campaigns/Players_Reviews&action=submit#Talentless_Mage Player's review]

=== The Dark Alliance===

''Prince Terhar lived two years with elves. Little did he expect what would happen when he returned back to Weldyn.''

'''Author:''' Wonderboy

'''Status:''' Complete

'''Length:''' 11 or 10 playable scenarios depending on the branch you take (+ 5 dialogue scenarios)

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default: Recruit list changes in almost every scenario

'''Version:''' 1.0.3"

'''Forum:''' http://wesnoth.org/forum/viewtopic.php?f=8&t=26924

=== The Dark Hordes ===

'''Status:''' Incomplete/WIP

'''Length:''' 11/?

'''Author:''' Circon

'''Maintainer:''' Various

'''Description:''' Lead fugitive dark sorcerer Gwiti Ha’atel to mastery of the undead hordes.

'''Version: '''

'''Requirements:'''

'''Difficulty:'''

'''Style:''' Skirmish

'''Faction/Era:''' Default undead

'''[http://units.wesnoth.org/1.10/The_Dark_Hordes/en_US/The_Dark_Hordes_1.html Custom Units]'''

'''Walkthrough:''' [[TheDarkHordes]]

'''Forum:''' [[http://forums.wesnoth.org/viewtopic.php?f=8&t=16576&]]

=== The Devil's Flute ===

'''Status:''' Complete, unmaintained

'''Length:''' 10 scenarios

'''Author:''' lipk

'''Description:''' Creona, the well-known assassin, gets a strange job from a strange person. So, in fact, it's no surprise that things take a strange turn...

'''Version:''' 0.1.4c

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish, Minigames

'''Faction/Era:''' Outlaws

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36044

=== The Earth's Gut ===

''The year is 515YW. You are the young dwarven leader Hamel. Your tribe in the caves of Knalga is under pressure from its enemies, and resources are growing scarce. In order to forge the weapons required to resist your enemies, you must set forth and collect what ores and minerals remain.''

'''Author:''' Anonymissimus

'''Maintainer:''' Anonymissimus

'''Status:''' Incomplete

'''Length:''' 21 scenarios

'''Difficulty:''' Normal

'''Style:''' Dungeon

'''Faction/Era:''' Default, dwarves.

'''[http://units.wesnoth.org/1.10/The_Earths_Gut/en_US/the_earths_gut.html Custom units]'''

'''Version:''' 0.2.11

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=26800

'''Note:''' This campaign is a "Dwarvish dungeon crawler" and is intended to be challenging for experienced players on hard whilst suitably easy on easy.

=== The Epic of Vaniyera ===

''The expansionist Lavinian Legion, led by the Imperator himself, has invaded the northern forests of the Sidhe, or Wild Elves. It is up to Leithan the Thunderblade and his advisor Vaniyera to push its armies back where they came from...''

'''Author:''' oreb, turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 6 scenarios

'''Difficulty:''' Hard (Don't be fooled by "novice level" in the campaign description, this one is very hard.)

'''Note:''' (Maintainer) Working on this issue, the next release (due at the end of November, hah!) should bring easy difficulty back to the level of a reasonable introduction to the IE, while the hard difficulty will also become slightly easier. With any luck, this will be the last release before version 1.0 of the campaign].

'''Style:''' Skirmish

'''Faction/Era:''' Imperial Era, Sidhe.

'''Version:''' 0.9.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=19490

=== The Fall of Wesnoth ===

''As the beloved human empire of Wesnoth becomes lazy and arrogant in its peaceful state of happiness, Emperor Dantair demands the creation of another sun in a bid to destroy all evil. Or is it all for a different purpose? A man named Alitar sees it that way, and now he must survive the most evil inhabited lands if he is to stop chaos from rising, and Wesnoth from falling... This is the story of The Fall of Wesnoth.''

'''Author:''' Pewskeepski

'''Status:''' 1st part complete, 2nd WIP.

'''Length:''' 10 playable scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Outlaws

'''[http://units.wesnoth.org/1.10/The_Fall_of_Wesnoth/en_US/The_Fall_of_Wesnoth-1.html Custom units]'''

'''Version:''' 1.0.8

=== The Founding of Borstep ===

''The chieftain of your tribe has become decadent and weak. Take over, and lead your people to a better home--whether it is already occupied or not. The Northlands in year 9W are a barbaric place, but anyone who stands in your way will learn the power of orcs!''

'''Author:''' Beetlenaut

'''Status:''' Complete

'''Length:''' 10 and 1 dialogue only

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default, Northerners

'''[http://units.wesnoth.org/1.10/The_Founding_of_Borstep/en_US/The_Founding_of_Borstep.html Custom units]'''

'''Version:''' 1.1.1b

'''Note:''' (Kanzil) I find the protagonist hard to sympathise with. Also, most scenarios contain interesting twists. For example, in one, each time you killed a boar it gives you extra health.

'''Note:''' (beetlenaut--author) In most Orcish campaigns the leader is heroic or just wants peace. Krag-Ubor wants plunder and battle like all enemy Orcs in other campaigns. I '''hope''' you don't sympathize too strongly, but I don't think you need to in order to enjoy the game play.

=== The Keep ===

''A lone keep in frosty woods against enemies from far beyond.''

'''Author:''' DeRaid

'''Status:''' Broken (Does not work at all)

'''Length:''' 0 playable scenarios

'''Difficulty:''' Broken

'''Style:''' ?

'''Faction/Era:''' Default

'''Version:''' 0.1

'''Forum:''' -

'''Note:''' (Adamant14) Does not work at all.

=== The Library of Kratemaqht ===

''An ancient story from the old continent.''

'''Author:''' Rich Marinaccio (cephalo)

'''Status:''' Complete

'''Length:''' 17 scenarios

'''Difficulty:''' Unbalanced (some scenarios are Easy - some rather Hard)

'''Style:''' Skirmish, RPG

'''Faction/Era:''' Loyalists and custom units.

'''[http://units.wesnoth.org/1.10/Library_Of_Kratemaqht/en_US/The_Library_Of_Kratemaqht.html Custom units]'''

'''Version:''' 1.0.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37798

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#The_Library_of_Kratemaqht Players Reviews]

'''Notes:''' (Adamant14) This campaign has a thought-out story, shows a great love for detail;
It includes a great custom Dragon, some brilliant custom images (fire, burning houses, burning forest) that makes the scenery / maps look very nice.

=== The Roar of the Woses ===

''When the construction of a dam threatens the existence of her home, Kylix is forced on a journey to stop it.''

'''Author:''' Alarantalara

'''Status:''' Finished

'''Length:''' 10-11 scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default with Additions (primarily Saurians, Nagas, Woses)

'''Version:''' 1.2.7

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=29830

'''Note:''' (author) Potentially unbalanced on Hard difficulty due to experiments with non-standard ways to increase difficulty. This issue does not exist on the lower difficulty levels.

=== The Three Elves ===

''Three elves have just begun their adventure in the northern swampland. Will they become heroes or will they be responsible for another undead expansion?''

'''Author:''' Stanislav Hoferek

'''Maintainer:''' trewe

'''Version:''' 0.9

'''Status:''' Complete

'''Difficulty:''' Easy

'''Length:''' 8 scenarios + 2 dialogue

'''Style:''' Skirmish

'''Faction:''' Default (Elves)

'''Forum:''' (does it have one?)

=== The Sojournings of Grog ===

''Grog (as starred in Under the Burning Suns) goes home.''

'''Author:''' Peter Christopher, Thomas Hockings

'''Maintainer:''' Elvish_Hunter

'''Status:''' Finished

'''Length:''' 18 playable scenarios in 2 parts

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon, Large Battle

'''[http://units.wesnoth.org/1.10/The_Sojournings_of_Grog/en_US/The_Sojournings_of_Grog.html Custom units]'''

'''Faction/Era:''' Default. Most of the time you play trolls and some desert elves accompanying Grog.

'''Version:''' 3.0.1

=== The Unstoppable Legion ===

''Horseback campaign. The kingdom of Suveran, far away from Wesnoth, is under attack. Only Deuterus, a Great Druid, knows their weakness and only Viktor, a young noble, dares go on the quest to stop them.''

'''Author:''' Chris Neville-Smith (Chris NS)

'''Maintainer:''' Chris Neville-Smith (Chris NS)

'''Status:''' WIP

'''Length:''' Currently 15 playable sceanrios, including a fork of three paths near the beginning, and another fork of two paths later on.

'''Difficulty:''' Normal

'''Style:''' Mainly Skirmish

'''[http://units.wesnoth.org/1.10/The_Unstoppable_Legion/en_US/The_Unstoppable_Legion.html Custom units]'''

'''Faction/Era:''' Play mounted units, including expanded Cavalryman line, and completely new Bowrider line. Joined later by Dwarves. Main enemies are the dark fighters and dark cultists.

'''Version:''' 0.8.7

=== The White Troll ===

''The story of a white troll whelp with strange magic powers, who is raised in an elvish village.''

'''Author:''' Wesnoth Italian Forum

'''Status:''' Complete

'''Length:''' 8 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default: you play with elves and trolls. Also features custom units with special advancements and abilities.

'''[http://units.wesnoth.org/1.10/White_Troll/en_US/white_troll.html Custom Units]'''

'''Version:''' 0.7.5

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=38828

=== To Lands Unknown ===

''This is the story of Mehir, the Summoner, and his journey to lands unknown.''

'''Author:''' inferno8

'''Status:''' Complete

'''Length:''' 20 scenarios, 4 dialogue only

'''Difficulty:''' Intermediate (Era of Magic)

'''Style''': Skirmish, Dungeon

'''Era:''' Era of Magic

'''Version:''' 1.6.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31799

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#To_Lands_Unknown Players Review]

=== Unlikely Alliance ===

''Play as the members of an alliance between the elves, drakes, and undead after the Fall of Wesnoth.''

'''Author:''' Creativity

'''Status:''' Broken ( Abandoned )

'''Length:''' 2 broken scenarios

'''Difficulty:''' Unbalanced

'''Style:''' -

'''Faction/Era:''' -

'''Version:''' 0.1

'''Forum:''' -

'''Note:''' (Adamant14) Did not work at all. Seems abandoned.

=== Up from Slavery ===

''The Orcei are captives in the imperial city of Lavinium, gladiators performing for the emperor Optus Maximus. All it will take, however, is one orc to lead his people to freedom. The Samnis called Sparxus may be that orc.''

'''Author:''' turin

'''Maintainer:''' UnwiseOwl

'''Status:''' Complete

'''Length:''' 7 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish, Arena (= No recruit, small group gladiator fights)

'''Faction/Era:''' Imperial Era, Orcei Gladiatores

'''Version:''' 0.6.0

'''Note:''' (Maintainer) At some point, I am intending to completely re-work this campaign to be a multi-player campaign, with one side led by Sparxus and one by Gravirivus. If anyone would like to take this on or has ideas for how to accomplish this, let us know. Nevertheless, its playable as a single player campaign now with some nice ideas that could be developed further.]

=== Warmaster ===

''One day the scout of your king brings a mysterious little stone, called Zrai-Stone, back from one of his trips. Soon that stone causes a lot of trouble...''

'''Author:''' Conkinator

'''Maintainer:''' trewe

'''Version:''' 1.3.5

'''Status:''' Finished

'''Length:''' 16 battle + 2 bonus + 1 epilogue scenarios

'''Difficulty:''' Hard

'''Faction:''' Default (loyalists)

'''Style:''' Skirmish, Survival

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=15527

=== Way of Dragon ===

''The story of what might happen if a person against his will transform into a dragon...''

'''Author:''' DrakeDragon

'''Status:''' Complete

'''Length:''' 7 playable scenarios + 1 dialogue-only

'''Difficulty:''' Normal

'''Style:''' Skirmish/RPG

'''Faction/Era:''' Default Loyalists

'''Version:''' 1.2.0

'''Forum:''' [http://forums.wesnoth.org/viewtopic.php?f=8&t=37876 Wesnoth Forum] [http://uporoom.ru/index.php/topic,179.0.html Russian Forum]

'''Note:''' (Adamant14) Promising short campaign, you play with just a few units.

== Battle for Wesnoth 1.11.x - development ==

''Campaigns available in the 1.11.x development version.''

''Please note: Battle for Wesnoth 1.11.0 features a bug that messes up the selection of difficulty levels.''

=== Antar, Son of Rheor ===

''This is the story about a young Lord and his first mission; sent by his father the young Lord Antar has to relieve his neighbours; he has to convince the Elves and Dwarves to ally him; he has to fight against hordes of Orcs and Endless Undead; and finally he has to defeat Mal Kazur, the mastermind who is behind all the evil.''

'''Author:''' Adamant14

'''Status:''' WIP

'''Length:''' 9 playable scenarios / 1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Loyalists and Elves (feat. fencer as main hero + various allies)

'''Version:''' 0.9.9

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36075

'''Note:''' (Adamant14) The campaign did not work with BfW version 1.11.0, or BfW version 1.11.1, so please use BfW version 1.11.2 or later!

=== A Song of Fire ===

''''''Part I: The Last War''' - In a long-forgotten era, at the heart of the Great Continent, an ancestral evil is awakened, threatening to destroy the whole world. Follow young Myra in the war that will alter the future of Irdya and its peoples forever.''

''''''Part II: Towards the Rising Sun''' - After the vicious Last War, Myra has become the new leader of Aragwaithi and Windsong alike. Albeit young and shaken by many losses, she must steel herself to lead her people through the vast and hostile Hannuk Steppes. However, her journey will take them all farther than in their wildest dreams. Furthermore, Myra must deal with the evil influence of the mysterious red gem she found after the last battle.''

''''''Part III: Raging Skies''' - The refugees have finally found a new home: families are built, allies are made and, for the first time in years, Myra and her friends know peace. However, when everything seems normal, ambition and thirst for power cause the break out of a continental war. And, amidst this new storm, an old foe rises agan, more powerful than ever. Witness the end of the song of Irdya's first great heroine.''

'''Author:''' revansurik

'''Status:''' Complete

'''Length:''' 36 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Default+War of Legends

'''Version:''' 0.3.3

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=38210

=== Birth of a Lich ===

''This is the life story of the dreaded lich Malifor, his struggle as a mage outcast, the orcish conquest of the northlands and his transformation to quench the thirst for revenge''

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 12 playable scenarios / 2 dialogue only

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle, Dungeon

'''Faction/Era:''' Human outlaws, dwarves, undead

'''[http://units.wesnoth.org/1.10/Birth_of_a_Lich/en_US/Birth_of_a_Lich.html Custom Units]

'''Version:''' 1.0.3

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37057

=== Coming of the Storm ===

''A new recruit joins the imperial army, eager to change the world and see combat. Little does he realise just how much action he will get and where his journey will take him. ''

'''Author:''' TrashMan

'''Status:''' WIP

'''Length:''' 26 playable scenarios / 4 dialogue only

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle, Dungeon

'''Faction/Era:''' Default

'''Version:''' 1.2.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23361

=== Legend of Far North ===

''The tale of the legendary Black Eye Karun,depicting his rise to power, his successes and his brutal assassination.'

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 16 playable scenarios / 1 dialogue only,1 cutscene

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Orcs, Trolls, Saurians, Nagas

'''[http://units.wesnoth.org/1.10/Legend_of_Far_North/en_US/Legend_of_Far_North.html Custom Units]'''

'''Version:''' 1.0.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34769

=== Legend of the Invincibles ===

'''''Part I: Shrouded in Darkness''' (5 chapters, 90 scenarios) - A pair of heroes, after stopping an orcish thread, are outcast into caves, where they have no other choice than to become liches in order to survive. They preserved their original appearance and moral principles, and fight in various skirmishes against evil (although using evil methods sometimes), until the Fall, when they are buried alive under the ashes of the third sun.''

'''''Part II: Into the Light''' (4 chapters, 96 scenarios at the moment) - Long after the Fall, the lich heroes awaken. Searching for more power, they manage to resurrect themselves as living beings, but this time more powerful and ridden of the evil within. But the evil from inside them did not cease to exist, and started a campaign to conquer the world. Stopping the campaign caused an even worse disaster...''

'''Author:''' Dugi

'''Status:''' WiP (but Part I might be considered complete)

'''Length:''' 185 (+7 talk-only) scenarios at the moment

'''Difficulty:''' Normal

'''Style:''' mostly Skirmish and Dungeon (all other styles are present as well, but less frequently)

'''Faction/Era:''' Elves, Loyalists, Undead, Dwarves; but they advance past their usual maximum level

'''Version:''' 2.5.0

'''Review:''' [http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Legends_of_the_Invincibles Players Review]

'''Note:''' The most unique feature of this campaign is its RPG-like unit development system, enemies drop items units can use, leaders are stronger than most usual units and all units get AMLA (after maximum level advancement) after reaching their maximum level (that is also increased by a load of additional level 4 units).

=== Rebellion in the North ===

''A great orcish uprising tends to destabilise the Northlands. As the future Lord Protector of the Northern Alliance you have to crush the rebellion and establish peace again."

'''Author:''' chak_abhi

'''Status:''' Finished

'''Length:''' 24 playable scenarios / 3 dialogue only,2 cutscenes

'''Difficulty:''' Normal

'''Style:''' Skirmish, Large Battle

'''Faction/Era:''' Loyalists, Dwarves, Gryphons, Merfolk

'''Version:''' 1.1.12

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=33059

=== Ruthless ===

''A bard (an aging criminal) is walking in wasteland. Nothing but two hands in his pockets, and nothing but stones around. Suddenly he sees a knight on errand--a dangerous opponent, especially in broad daylight. The two strangers are soon sitting by the campfire, and the bard is telling a story.
(Beginner level, 10+ fights).''

'''Author:''' homunculus

'''Status:''' Finished

'''Length:''' 12 playable scenarios + 5 cutscene scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default (Orcs)

'''Version:''' 1.0.4

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37874

'''Note:''' (Adamant14) Recommendable campaign, with smart unusual ideas and a good detailed story.
You fight with few units on small but perfect maps. About the difficulty: The author describes his campaign as 'beginner level', but for me the difficulty is rather NORMAL than EASY.

== Player Reviews ==

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews Link to Players Reviews]'''

[[Category:Campaigns|*]]

FilterWML/Examples - How to use Filter

2013-06-04T08:58:04Z

Pyrophorus: /* Result sets and arrays. */

Guide to UMC Content

2012-10-09T19:31:54Z

Pyrophorus: /* Salt Wars */

''This is a guide to the current (1.10.x/1.11.x) UMC campaigns for players. It aims to provide all the information not only about the story, but also about completion, difficulty and playing style of the campaign. See http://forums.wesnoth.org/viewtopic.php?f=8&t=37476 for further information, for currently non-available UMC-content please refer to http://forums.wesnoth.org/viewtopic.php?f=8&t=36733. Please edit, it is a wiki.''

=== Blueprint ===

'''Status:'''
* Broken = Does not work at all
* Incomplete = Partially written, no progress
* WIP = Partially written, progress
* Complete = Completely written, but buggy as well as potential balance issues.
* Finished = Completely written, minimal to no bugs, slight balance issues possible.

'''Length:'''

'''Author:'''

'''Maintainer:''' if not maintained by the author anymore.

'''Description:'''

'''Version: '''

'''Requirements:'''

'''Difficulty:'''

Please note: Often campaigns introducing new mechanics are listed as expert level on the add-on server, here difficulty means the raw difficulty after the mechanics are understood.

* Unbalanced = If you can't beat the hard mode, it isn't necessarily unbalanced, but if the difficulty changes erraticly from one scenario to the next and only people using the debug mode have seen the final, then it is.
* Easy
* Normal
* Hard

'''Style:'''

Please note: Many campaigns will feature more than one style. Please list the most significant ones.

* Skirmish = small to medium sized armies, your standard Wesnoth gameplay
* Dungeon = long and narrow tunnels (not every underground scenario is a dungeon, a dungeon isn't necessarily underground)
* RPG = role playing game elements such as talking with non-player-characters, item collection, dependency on a party of very few adventurers without or limited recruits
* Survival = being exposed to changing, spawning enemies while remaining on the same map
* Large Battle = Eastern Flank in Northern Rebirth, Civil War in Son of the Black-Eye
* Simulation = campaigns feat. terrain modification, alternative resources
* Boss battle = a recurring feature of Invasion of the Unknown (basically a triggered event creating a solvable puzzle for the player)

'''Faction/Era:'''

* Era for the whole campaign and more specifically the faction or unit composition you field.

'''Forum:'''

* Links to the feedback and development threads at forums.wesnoth.org

== Battle for Wesnoth 1.10.x - stable ==

''Campaigns available in the 1.10.x stable version.''

=== A Story of the Northlands ===

''A story of life and death in a remote village of the Northlands. Your village has been overrun by an orcish raid. You fight for its freedom while you wait for help to arrive.''

'''Author:''' zepko

'''Status:''' Complete

'''Length:''' 10 playable scenarios + 1 dialog-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default + additions: you play with a custom faction of outlaws and with a custom party of loyalist knights.

'''Version:''' 0.2.0

=== A Vision Blinded ===

''Defend the northern forest against what appeared like a routine orcish raid, and unravel the greater conspiracies that lie below its waves.''

'''Author:''' LemonTea

'''Maintainer:''' Adamant14

'''Status:''' Complete

'''Length:''' 13 playable scenarios + 1 dialog-only

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves (+ Trolls, Outlaws)

'''[http://units.wesnoth.org/1.10/A_Vision_Blinded/en_US/A_Vision_Blinded.html Custom units]'''

'''Version:''' 0.6.6

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=23463&hilit=a+vision+blinded

=== Antar, Son of Rheor ===

''This is the story about a young Lord and his first mission; sent by his father the young Lord Antar has to relieve his neighbours; he has to convince the Elves and Dwarves to ally him; he has to fight against hordes of Orcs and Endless Undead; and finally he has to defeat Mal Kazur, the mastermind who is behind all the evil.''

'''Author:''' Adamant14

'''Status:''' WIP

'''Length:''' 8 playable scenarios

'''Difficulty:''' WIP

'''Style:''' Skirmish

'''Faction/Era:''' Default, Loyalists (feat. fencer as main hero + various allies)

'''Version:''' 0.8.23a

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36075

=== Besieged Druids ===

''A elvish school for druids comes under attack by goblins. It seems more than just a routine raid; is there something more sinister behind this attack? - In Beseiged Druids, you control Eärendil, the surviving teacher at the school, and the many and varied initiates. Not all of these are ordinary students; many have been experimenting with other forms of magic, while others are simply overachievers in some area of study. Unfortunately, they are not especially good at combat, at least initially. Together with a very small contingent of surviving guards, it is up to these students to save the island of Aleron from disaster.''

'''Author:''' Celtic Minstrel

'''Status:''' Complete

'''Length:''' 9 scenarios

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves

'''[http://units.wesnoth.org/1.10/DruidSiege/en_US/celmin-druid-siege.html Custom units]'''

'''Version:''' 1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=37342

=== Cities of the Frontier ===

''Settle a new town in the wilds north of the Great River.''

''This campaign makes several changes to the standard Wesnoth game mechanics, and focuses on city-building and gold management.''

'''Author:''' esci

'''Status:''' Complete

'''Length:''' Not fixed, approximately 6-10 seasons of 36 turns each

'''Difficulty:''' Normal

'''Style:''' Simulation, Survival

'''Faction/Era:''' Default, Loyalist

'''[http://units.wesnoth.org/1.10/Cities_of_the_Frontier/en_US/Cities_of_the_Frontier.html Custom units]'''

'''Version:''' 0.5.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36004

=== Count Kromire ===

''You are the blood son of a vampire lord, however when the might of the celestial crusades comes knocking, and your father is slain, you flee your lands. However you intend to return, to restore the lands of Kromire to the Kromires, to avenge your father, and most importantly, to make sure that no celestial ever dares come into your mountains again.''

'''Author:''' Velensk

'''Maintainer:''' currently none

'''Status:''' Complete

'''Length:''' 9 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Era of Myths, Vampires

'''Version:''' 1.3.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=21560

=== Elvish Dynasty RPG ===

''You are the new ruler of an elvish kingdom! Can you lead your people to glory? This campaign is highly randomized so it will be different every time you play!''

''Sequel to Ooze Mini-Campaign''

'''Author:''' spencelack

'''Status:''' Complete

'''Length:''' 10 years, in each year choice between dialogue and fighting scenario (selected out of a large pool of possible scenarios)

'''Difficulty:''' Normal

'''Style:''' RPG, Skirmish

'''Faction/Era:''' Default, Elves

'''Version:''' 0.9.9b

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=28627

=== Fate of a Princess ===

''Part I: Baldres, a notorious robber baron, flees Wesnoth with his followers and sets off into the northlands to evade the king's justice. The baron's deeds and misdeeds are to change the balance of power between orcs and non-orcs throughout the northlands, and will carry consequences long after his eventual death.''

''Part II: The Greenwood elves face a crisis which demands the return of the queen's estranged half-elven half-sister, Baldres' daughter. Two brave young elves must make a perilous journey to find her and bring her back to her former home. If they fail, the whole northlands will be engulfed in war with the resurgent orcs...''

'''Author:''' SkyOne, mich, simonsmith

'''Status:''' Finished

'''Length:''' 26-29 scenarios (some dialogue-only), 2 parts

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon

'''Faction/Era:''' Default with additions. You play two different, unique cross-faction combinations in each part.

'''[http://units.wesnoth.org/1.10/Fate_of_a_Princess/en_US/Fate_of_a_Princess.html Custom units]'''

'''Version:''' 0.9.17

'''Required Wesnoth version:''' 1.9.12 or later

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=26327

=== Galuldur's First Journey ===

''While the belligerence of orcs is nothing new, their intensifying attacks on a fledgling colony of elves in Pindir Forest begin to show signs of a deeper malice, forcing Galuldur, the young son of the colony's adventurous founder Galur, to venture out of his forest's friendly trees in search of help. His simple errand quickly turns into a frantic quest to unearth the roots of the mysterious evil threatening his people. As you lead him through unknown lands, Galuldur, forced to match wits with unexpected adversaries at nearly every turn in a desperate attempt to save his world, quickly learns that the world is neither a friendly nor a simple place.''

'''Author:''' mattsc

'''Status:''' Complete

'''Length:''' 8-9 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Elves

'''[http://units.wesnoth.org/1.10/Galuldur/en_US/Galuldur.html Custom units]'''

'''Version:''' 1.1.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31895

=== Grnk the Mighty ===

''All his life, puny little goblin Grnk the Frail had been dreaming about leaving the orcs and starting a better life. When he finally arrives in the human town of Shmaltupp, he realizes that the world is not as black and white as he had imagined. He also discovers that he is no ordinary goblin. Follow Grnk the Frail on his path to becoming Grnk the Mighty.''

'''Author:''' mattsc

'''Status:''' Part I complete

'''Length:''' 13 scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish, RPG

'''Faction/Era:''' Default, changing (no standard army building gameplay)

'''[http://units.wesnoth.org/1.10/Grnk/en_US/Grnk.html Custom units]'''

'''Version:''' 1.0.5

'''Required Wesnoth version:''' 1.9.5 or later

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34970

=== Invasion from the Unknown ===

''Episode I - Seeking the Light: Long after the Fall, the last forest elves are forced to abandon their safe valley, and find themselves resorting to the dark means of necromancy in order to survive the perils and challenges of this new harsh world. May they finally free the Great Continent from its chaos, or perish in the foolish attempt of restoring peace and life to the lands.''

''Episode II - Armageddon: As the shadow of Chaos covers the entire continent, an assorted group of foolish heroes prepares a counter-attack to the Empire, with one unique goal in their minds: defeat the evil Emperor, whoever it is. Lead these courageous living and non-living warriors to victory, and rediscover lost secrets of the history.''

'''Author:''' shadowmaster

'''Maintainer:''' Espreon

'''Status:''' Finished

'''Length:''' 26 scenarios in two episodes

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon, Boss battle

'''Faction/Era:''' Unique. You play Elves, Undead and in the 2nd part Aragwaithi.

'''Version:''' 1.90.6

''Note (taptap): Despite its acknowledged flaws (generic hero, plot holes, deus ex machina moments, gameplay issues in the 2nd part) this is undoubtedly the most iconic campaign in UMC. It single-handedly redefines the elvish history and sketches a cosmology for the ages after the fall. With the Chaos empire and its various allies it introduces an era worth of factions to single-player play. At the same time it features some of the most beautiful maps in Wesnoth and stunning art on par with mainline campaigns.''

=== Panther Lord ===

''The Imperialists ambitions of pushing into the Sea States have been repeatedly thwarted and now they turn their attentions elsewhere. You are an outcast Darklander now living as a mercenary in the Sea States and the rumors you hear indicate that they will be coming to your people. Though an outcast you do not wish to see them subjugated. The spirit whose friendship caused you to be an outcast has a plan that might allow you to save them.''

'''Author:''' Velensk

'''Maintainer:''' Lavender

'''Status:''' Finished

'''Length:''' 14 scenarios

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Era of Four Moons, Darklanders (+ a wide variety of mercenaries)

'''Version:''' 1.0.2

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34318

=== Return of the Monster ===

''It was time for Amailoss, born from the naga queen's last egg, to leave home. Time for him to grow into a leader in his own right, and eventually become the guardian and leader of another naga city. But along the way, he became friends with an unusual mud-crawler, they met a strange young monster, discovered that a spirit had escaped from an orc prison, and the mystery of that spirit became a grave challenge for Amailoss and the many races in the region....''

''A naga campaign, involving elves, orcs, saurians, turtle-like races, and some monsters.''

'''Author:''' SkyOne

'''Status:''' Complete

'''Length:''' 16 playable, 2 dialog scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon

'''Faction/Era:''' Default with additions. You play a custom naga faction and carapaces (a turtle-like race).

'''[http://units.wesnoth.org/1.10/Return_of_the_Monster/en_US/Return_of_the_Monster.html Custom units]'''

'''Version:''' 0.7.1

'''Required Wesnoth version:''' 1.10.x

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36438

=== Return to Noelren ===

'''Status:''' Complete.

'''Length:''' 26 scenarios + 7 cut scenes

'''Author:''' Pyrophorus

'''Description:''' ''A story in the first Dark Age of Wesnoth. See how various heroes stick together to shun the threat of black magics, restore the secret kingdom of Noelren and install Garard I on the throne of Wesnoth. This campaign features complex scenarios, unusual objectives and units, emphasizing more on story and adventures than hardcore fighting.''

'''Version: ''' 0.7

'''Requirements:''' BfW 1.10 (not tested on 1.11)

'''Difficulty:''' Easy, unbalanced

'''Style:''' Skirmish, RPG, Large Battle, Simulation

'''Faction/Era:''' Default + custom units

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=34685#p501026

=== Salt Wars ===

''Introductory campaign for the Era of Four Moons.''

''As an officer of one of the Sea States you must defend your organization from aggressive rivals.''

'''Author:''' Velensk

'''Maintainer:''' Lavender

'''Status:''' Complete

'''Length:''' 5 scenarios

'''Difficulty:''' Easy

'''Style:''' Skirmish

'''Faction/Era:''' Era of Four Moons, Sea States

'''Version:''' 0.2.1

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=31498

=== The Dark Hordes ===

'''Status:'''

* Incomplete/WIP

'''Length:''' 11/?

'''Author:''' Circon

'''Maintainer:''' Various

'''Description:'''

'''Version: '''

'''Requirements:'''

'''Difficulty:'''

'''Style:'''

* Skirmish

'''Faction/Era:'''

* Default undead

'''Custom Units:'''

[[http://units.wesnoth.org/1.10/The_Dark_Hordes/en_US/The_Dark_Hordes_1.html Unit database]]

'''Walkthrough:'''

* [[TheDarkHordes]]

'''Forum:'''

* [[http://forums.wesnoth.org/viewtopic.php?f=8&t=16576&]]

=== The Earth's Gut ===

''The year is 515YW. You are the young dwarven leader Hamel. Your tribe in the caves of Knalga is under pressure from its enemies, and resources are growing scarce. In order to forge the weapons required to resist your enemies, you must set forth and collect what ores and minerals remain.''

'''Author:''' Anonymissimus

'''Maintainer:''' Anonymissimus

'''Status:''' Incomplete

'''Length:''' 21 scenarios

'''Difficulty:''' Normal

'''Style:''' Dungeon

'''Faction/Era:''' Default, dwarves.

'''[http://units.wesnoth.org/1.10/The_Earths_Gut/en_US/the_earths_gut.html Custom units]'''

'''Version:''' 0.2.11

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=26800

'''Note''' This campaign is a "Dwarvish dungeon crawler" and is intended to be challenging for experienced players on hard whilst suitably easy on easy.

=== The Epic of Vaniyera ===

''The expansionist Lavinian Legion, led by the Imperator himself, has invaded the northern forests of the Sidhe. It is up to the young Vaniyera to push its armies back from the border...''

'''Author:''' oreb, turin

'''Maintainer:''' unwiseowl

'''Status:''' Complete

'''Length:''' 6 scenarios

'''Difficulty:''' Hard (Don't be fooled by "novice level" in the campaign description, this one is very hard.)

'''Style:''' Skirmish

'''Faction/Era:''' Imperial Era, Sidhe.

'''Version:''' 0.9.0

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=19490

=== The Fall of Wesnoth ===

''As the beloved human empire of Wesnoth becomes lazy and arrogant in its peaceful state of happiness, Emperor Dantair demands the creation of another sun in a bid to destroy all evil. Or is it all for a different purpose? A man named Alitar sees it that way, and now he must survive the most evil inhabited lands if he is to stop chaos from rising, and Wesnoth from falling... This is the story of The Fall of Wesnoth.''

'''Author:''' Pewskeepski

'''Status:''' 1st part complete, 2nd WIP.

'''Length:''' 10 playable scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default, Outlaws

'''[http://units.wesnoth.org/1.10/The_Fall_of_Wesnoth/en_US/The_Fall_of_Wesnoth-1.html Custom units]'''

'''Version:''' 1.0.8

=== The Founding of Borstep ===

''The chieftain of your tribe has become decadent and weak. Take over, and lead your people to a better home--whether it is already occupied or not. The Northlands in year 9W are a barbaric place, but anyone who stands in your way will learn the power of orcs!''

'''Author:''' Beetlenaut

'''Status:''' Complete

'''Length:''' 10 and 1 dialogue only

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Default, Northerners

'''[http://units.wesnoth.org/1.10/The_Founding_of_Borstep/en_US/The_Founding_of_Borstep.html Custom units]'''

'''Version:''' 1.1.1b

''Note(Kanzil): I find the protagonist hard to sympathise with. Also, most scenarios contain interesting twists. For example, in one, each time you killed a boar it gives you extra health.''

''Note(beetlenaut--author): In most Orcish campaigns the leader is heroic or just wants peace. Krag-Ubor wants plunder and battle like all enemy Orcs in other campaigns. I '''hope''' you don't sympathize too strongly, but I don't think you need to in order to enjoy the game play.''

=== The Sojournings of Grog ===

''Grog (as starred in Under the Burning Suns) goes home.''

'''Author:''' Peter Christopher, Thomas Hockings

'''Maintainer:''' Elvish_Hunter

'''Status:''' Finished

'''Length:''' 18 playable scenarios in 2 parts

'''Difficulty:''' Normal

'''Style:''' Skirmish, Dungeon, Large Battle

'''[http://units.wesnoth.org/1.10/The_Sojournings_of_Grog/en_US/The_Sojournings_of_Grog.html Custom units]'''

'''Faction/Era:''' Default. Most of the time you play trolls and some desert elves accompanying Grog.

'''Version:''' 3.0.1

=== Up from Slavery ===

''Well, the orcs don't know exactly what year it is. They are captives in the imperial city of Lavinium, gladiators performing for the emperor Optus Maximus. All it will take, however, is one orc to lead his people to freedom. The Samnis called Sparxus may be that orc.''

'''Author:''' turin

'''Maintainer:''' unwiseowl

'''Status:''' Complete

'''Length:''' 7 scenarios

'''Difficulty:''' Normal

'''Style:''' Skirmish, Arena (= No recruit, small group gladiator fights)

'''Faction/Era:''' Imperial Era, Orcei Gladiatores

'''Version:''' 0.6.0

== Battle for Wesnoth 1.11.x - development ==

''Campaigns available in the 1.11.x development version.''

''Please note: Battle for Wesnoth 1.11.0 features a bug that messes up the selection of difficulty levels.''

=== Antar, Son of Rheor ===

''This is the story about a young Lord and his first mission; sent by his father the young Lord Antar has to relieve his neighbours; he has to convince the Elves and Dwarves to ally him; he has to fight against hordes of Orcs and Endless Undead; and finally he has to defeat Mal Kazur, the mastermind who is behind all the evil.''

'''Author:''' Adamant14

'''Status:''' WIP

'''Length:''' 8 playable scenarios

'''Difficulty:''' WIP

'''Style:''' Skirmish

'''Faction/Era:''' Default, Loyalists (feat. fencer as main hero + various allies)

'''Version:''' 0.8.23b

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=36075

[[Category:Campaigns|*]]