The Battle for Wesnoth Wiki - User contributions [en]

WML for Complete Beginners: Chapter 2

2018-11-30T14:24:51Z

Holius: /* The Userdata Directory */ version update 1.12 -> 1.14

==Chapter 2: The Userdata Directory and the Campaign Folder==

So now that you understand the basic syntax of WML, it's time to learn where The Battle for Wesnoth stores files so that we can begin creating our campaign.

===The Userdata Directory===

There are two main directories that Wesnoth creates on your computer. The '''installation directory''' contains all the files for the core game. The '''userdata directory''' stores all your personal Wesnoth data, which includes your installed add-ons, your settings and preferences, and your saved games. The userdata directory is where we will store your work throughout this tutorial.

The location of your userdata directory differs depending on your operating system, and in the case of Microsoft Windows, the version of your operating system. Refer to the following table to determine where your userdata directory is located:

{| border="1"
!Windows XP
|~/My Documents/My Games/Wesnoth 1.14/
|-
!Windows Vista and above
|~/Documents/My Games/Wesnoth 1.14/
|-
!Mac OS X
|~/Library/Application Support/Wesnoth 1.14/
|-
!Linux
|~/.local/share/wesnoth/1.14/
|}

''Note:'' On Windows, if you chose 'Store userdata in the install location' during setup, the userdata directory is usually in 
~/AppData/Local/VirtualStore/Program Files (x86)/Battle for Wesnoth 1.14.5

Now navigate to your userdata folder. Provided that you have already run the Wesnoth application at least once before, you should see a total of five folders ("cache", "data", "editor", "persist", and "saves") in this directory, along with two files ("preferences" and "save_index.gz"). If you see all seven of these, everything is good. If you do not see all seven, try running the Wesnoth application. If that does not work, try restarting your computer. If neither of these steps work, reinstall Wesnoth.

Of the seven objects contained in the userdata folder, you will only ever need to directly interact with two: the "data" folder and the "editor" folder.

====The data folder====

:The data folder (more exactly the data/add-ons/ folder) is where all installed add-ons are kept. This is where we will be building our campaign, when we get to that. If you have previously installed any Wesnoth add-ons, they should show up in this folder.

====The editor folder====

:The editor folder is where all maps created with the in-game map editor are stored. If you have ever created and saved a map in-game, you should see the map file in this directory.

===The Campaign Folder===

Like I told you earlier, all add-ons are installed in the data/add-ons folder inside the userdata directory. That means that your campaign will also be located inside the data/add-ons folder. If you're not already there, enter the data/add-ons folder now.

Next, create a new folder inside the data/add-ons folder. Name this new folder "my_first_campaign" exactly as I wrote it here (but don't include the quotation marks). Make sure you spelled it right, that you didn't accidentally capitalize any letters and that you included the underscores between the words in the folder name, because if you don't your campaign won't work when you try to play it.

Now enter the "my_first_campaign" folder and create seven new folders. Name these folders "images", "macros", "maps", "scenarios", "translations", "units" and "utils" (again, make sure you spelled everything right, that you didn't accidentally capitalize anything, and that you didn't include the quotation marks).

All campaigns share this common folder structure.

Continue to [[WML for Complete Beginners: Chapter 3]]

Or head back to [[WML for Complete Beginners: Chapter 1]]

Return to Main Index:
[[WML for Complete Beginners]]

[[Category:WML_for_Complete_Beginners]]

AI Recruitment

2017-11-30T15:28:17Z

Holius: fix errors (title levels)

A new [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|recruitment candidate action]] (CA) was introduced and made the default in Wesnoth 1.11. It is much more configurable than previous versions and supports multiple leader recruiting. This page describes how it works and the parameters available for customizing it.

==How it works==
===Map analysis===
In a first step, the CA analyzes the map and tries to find "important hexes". Those are locations on the map where a fight will occur with high probability. The important hexes are later used in combat simulations to calculate an average defense rating for the combatants.

When the game is running in debug mode ''and'' the game is started with the parameter <code>--log-info=ai/recruitment</code> the important hexes are marked with white 'x' markers on the map.

===Score Map===

A score map is created for all leaders who are able to recruit. All unit types from the recruit and recall lists are mapped to a score.

In the end, the scores represent the desired unit ratios on the map. This means the AI will ''not'' just recruit the unit with the highest score, but in such a way that the mix of units on the map comes as close as possible to the mix represented by the scores.
The scores are filled with values coming from combat analyses (see below).

After that the AI modifies the scores in several ways:
* Similar units get a penalty for being similar. Similar units are units in one advancement tree.
Example (Archer can advance to Ranger):
before after
Elvish Fighter: 50 50
Elvish Archer: 50 25
Elvish Ranger: 50 25
* The aspects ''recruitment_more'', ''recruitment_diversity'' and ''recruitment_randomness'' are handled ([[#Other_Recruitment_Related_Aspects|see below]]).

===Combat Analysis===
For each unit type the AI leaders can recruit, the CA simulates fights against all enemy units on the map. If there are less then 5 enemy units, the enemy recruitment list(s) are also taken into account.

After combat analysis the score map may look like this:

Goblin Spearman score: 16.1252
Naga Fighter score: 0
Orcish Archer score: 61.6442
Orcish Assassin score: 88.0737
Orcish Grunt score: 100
Troll Whelp score: 26.7646
Wolf Rider score: 0

====Implementation details for interested readers====

The combat analysis uses the function ''compare_unit_types(A, B)''. It takes two unit types and simulates a fight, using a cache because simulation is expensive. The function returns a positive value if unit type ''A'' is better than ''B'' and a negative value if unit type ''B'' is better than ''A''. If the return value is 2.0, it means that unit type A is twice as good as unit type B.

Here is a important code snippet from ''compare_unit_types()'':
double value_of_a = damage_to_b / (b_max_hp * a_cost);
double value_of_b = damage_to_a / (a_max_hp * b_cost);

if (value_of_a > value_of_b) {
return value_of_a / value_of_b;
} else if (value_of_a < value_of_b) {
return -value_of_b / value_of_a;
} else {
return 0.;
}
''damage_to_b'' comes from simulations and is the average damage dealt by ''A'' when ''A'' attacks (''A'' chooses weapon) plus the average damage dealt by ''A'' when ''B'' attacks (''B'' chooses weapon). ''damage_to_a'' is equivalent.

The return value of ''compare_unit_types()'' is multiplied by the enemy's current hitpoints and added to the score map.

Included in the damage calculations are average defense (coming from "important hexes"), resistance, resistance abilities, average time of day, drain, poison, berserk, swarm and slows.

At this point the scores can be quite inconvenient for a generalized treatment. They could all be negative, very high or too similar. Thus, the scores are transformed linearly. The resulting scores are numbers between 0.0 and 100.0.
The minimum depends on the aspect ''recruitment_diversity''.

Simplified code snippet:
double new_100 = max_score;
double new_0 = max_score - (recruitment_diversity * (max_score - average_score));

BOOST_FOREACH(double& score, scores) {
score = 100 * ((score - new_0) / (new_100 - new_0)); // linear transformation
if (score < 0.) {
score = 0.;
}
}

==Aspect ''recruitment_instructions''==

This is a powerful aspect for controlling recruitment via WML. Its syntax is quite complex and requires the [[Wesnoth_AI_Framework#The_.5Bai.5D_Tag_.E2.80.94_Aspects|''composite'' aspect configuration]]. At its core are the ''[recruit]'' tags, which are the instructions to the candidate action defining which units are to be recruited.
[ai]
[aspect]
id=recruitment_instructions
[facet]
turns=
[value]
#(here multiple [recruit] and/or [limit]-tags)
[recruit]
#(attributes)
[/recruit]
[limit]
#(attributes)
[/limit]
[value]
[/facet]
[/aspect]
[/ai]

Attributes inside '''[facet]''':
* '''turns'''="": (string) This key takes a comma separated list containing numbers specifying the turns. '-' can be used between two values to define a range. An empty string means ''all turns''.
* The [[Wesnoth_AI_Framework#The_.5Bai.5D_Tag_.E2.80.94_Aspects|other keys possible in [facet] tags]] can, in principle, also be used, but note that ''invalidate_on_gamestate_change'' and ''invalidate_on_minor_gamestate_change'' have no effect on [recruit] tags. They are read at the beginning of the turn and are immutable for the remainder of the turn.

Attributes inside '''[recruit]''':
* '''id''': (string) {{DevFeature1.13|5}} By specifying an ID it becomes possible to manipulate the [recruit] tags using [[DirectActionsWML#.5Bmodify_ai.5D|modify_ai]]. This is entirely optional.
* '''type='''"": (string) This key takes a comma separated list containing unit types, usages or levels. Common values for ''usage'' are 'scout', 'fighter', 'archer', 'healer' and 'mixed fighter'. An empty string means 'all units'. If more than one unit is specified, the AI decides what to recruit according to the score map.
* '''number'''=-1: (integer) A number ''n'' greater than 0 instructs the AI to recruit ''n'' units. '-1' means 'as much as possible'. '0' means 'do not recruit'.
* '''importance'''=1: (integer) Priority of the recruitment. The AI first recruits units with the highest importance, until the specified limits are reached. If gold is lacking or the castle is full, only the most important units are recruited, all other [recruit] jobs are dropped.
* '''leader_id'''="": (string) ''id'' of the leader to execute this recruitment. Empty string means 'all leaders'. Note that this is only a recommendation to the AI. If the specified leader has no free hexes available, the AI uses other leaders to do the job.
* '''total'''=no: (boolean) If set to 'yes', the AI counts the own units on the map which match at least one of the given types and then recruits the difference between ''number'' and the counted amount.
* '''blocker'''=yes: (boolean) If set to 'yes', the AI stops recruiting if this job cannot be done (for example, because of lack of gold or a [limit]). If set to 'no', the AI drops this job and tries to continue with less important ones.
* '''pattern'''=no: (boolean) If set to 'yes', the unit to recruit is not chosen by the AI, but randomly according to the frequency in the type attribute. For example, when <code>type=Orcish Grunt, Orcish Grunt, scout</code> and <code>number=6</code>, the AI recruits 6 units, with the probability that one unit is a grunt being twice as high as that of a scout. If the ''type'' attribute is empty, the AI recruits randomly. (See also [[#Other_Recruitment_Related_Aspects|''recruitment_pattern'']])

Attributes inside '''[limit]''':
* '''id''': (string) {{DevFeature1.13|5}} By specifying an ID it becomes possible to manipulate the [limit] tags using [[DirectActionsWML#.5Bmodify_ai.5D|modify_ai]]. This is entirely optional.
* '''type'''="": (string) This key takes a comma separated list containing unit types, usages or levels. An empty string means 'all units'.
* '''max'''=0: (int) The maximum of units of the given type(s).

'''Notes:'''
* [limit] has higher priority than [recruit].
* The ''recruitment_save_gold'' aspect has higher priority than [recruit]. So if exact recruiting is wished, deactivate ''recruitment_save_gold'' ([[#Aspect_recruitment_save_gold|see below]]).
* If recruitment is specified for a turn, the AI does '''not recruit any other unit''' by default. (So if the AI is told to recruit 1 scout in turn 1, then the AI will only recruit 1 scout and no other units). To prevent this behavior one can add this [recruit] tag:
[recruit]
importance=0
[/recruit]
The AI then falls back to normal recruiting when all other [recruit] tags are dealt with. This is also the content of the [default] facet for the aspect.
* Even if only a [limit] tag is used in the aspect declaration, the [default] facet will get overwritten. Include the [recruit] tag mentioned in the previous point to let the AI recruit something. {{DevFeature1.13|5}} As of 1.13.5, if there is a [limit] tag but no [recruit] tag, an empty [recruit] tag is implied, allowing the AI to recruit. If both [limit] and [recruit] tags are present, no additional [recruit] tag is ever implied.
* Only one facet at a time can be active. When there are more [facet]s defined in a turn, only one will be used (usually the first one). Use several [recruit] and/or [limit] tags in the same facet instead.
* Do not define more than one [recruit] tag with the same importance. Also note that the aspect ''recruitment_pattern'' expands into a [recruit] tag with importance=1.
* {{DevFeature1.13|5}} The tags '''[total]''' and '''[pattern]''' may be used instead of [recruit]. These have basically the same meaning and contents as [recruit], but imply either total=yes or pattern=yes. They are converted to [recruit] tags and can be manipulated as such by modify_ai.

===Examples===
Recruit 3 grunts (and nothing else) on turns 3-5.
[ai]
[aspect]
id=recruitment_instructions
[facet]
'''turns=3-5'''
[value]
[recruit]
'''type=Orcish Grunt'''
'''number=3'''
[/recruit]
[/value]
[/facet]
[/aspect]
[/ai]
Recruit as many scouts as possible until there are 4 scouts in total, then recruit other units.
[ai]
[aspect]
id=recruitment_instructions
[facet]
[value]
[recruit]
type=scout
number=4
'''total=yes'''
importance=1
[/recruit]
'''[recruit]'''
'''importance=0'''
'''[/recruit]'''
[/value]
[/facet]
[/aspect]
[/ai]
Recruit 6 grunts or level 2 units (whatever seems better to the AI) and nothing else.
[ai]
[aspect]
id=recruitment_instructions
[facet]
[value]
[recruit]
'''type=Orcish Grunt, 2'''
number=6
[/recruit]
[/value]
[/facet]
[/aspect]
[/ai]
Recruit 5 scouts with 'leader1' and 5 grunts with 'leader2'. Try to recruit the grunts even if 'leader1' cannot recruit all of the scouts.
[ai]
[aspect]
id=recruitment_instructions
[facet]
[value]
[recruit]
type=scout
number=5
'''importance=2'''
'''leader_id=leader1'''
'''blocker=no'''
[/recruit]
[recruit]
type=Orcish Grunt
number=5
'''importance=1'''
'''leader_id=leader2'''
[/recruit]
[/value]
[/facet]
[/aspect]
[/ai]
Always recruit random units.
[ai]
[aspect]
id=recruitment_instructions
[facet]
[value]
[recruit]
'''type='''
'''pattern=yes'''
importance=1
[/recruit]
[/value]
[/facet]
[/aspect]
[/ai]
Do not recruit on turn 4.
[ai]
[aspect]
id=recruitment_instructions
[facet]
'''turns=4'''
[value]
[recruit]
importance=1
'''number=0'''
[/recruit]
[/value]
[/facet]
[/aspect]
[/ai]
Do not have more than 6 units on the map.
[ai]
[aspect]
id=recruitment_instructions
[facet]
[value]
[limit]
type= #empty type means all units
max=6
[/limit]
[recruit] #Do not forget to include the default
importance=0 #[recruit]-tag. Otherwise the AI won't
[/recruit] #recruit anything.
[/value]
[/facet]
[/aspect]
[/ai]

The following does not work because only one [facet] can be active.
[ai]
[aspect]
id=recruitment_instructions
[facet]
'''turns=1-10'''
[value]
[recruit]
type=scout
number=5
'''importance=1'''
[/recruit]
[/value]
[/facet]
[facet]
'''turns=3'''
[value]
[recruit]
type=Orcish Grunt
number=3
'''importance=2'''
[/recruit]
[/value]
[/facet]
[/aspect]
[/ai]
Instead, one has to use <code>turns=1-2,4-10</code> in the first facet.

==Aspect ''recruitment_save_gold''==

===How it works===

For several reasons it can be a good idea not to spend all gold at once:
* To save upkeep
* To wait for the enemy to recruit first and thus to counter more easily
* To save gold for the next scenario when the enemy is almost defeated
It can also be a good idea (especially for the AI) to recruit in waves (instead of recruiting one unit or so each turn). If this type of behavior is desired, there is the aspect ''recruitment_save_gold''.

The Recruitment CA is always in one of the following states:
* NORMAL
* SAVE_GOLD
* SPEND_ALL_GOLD
* LEADER_IN_DANGER
Except for state 'LEADER_IN_DANGER', the states are persistent over turns.

The AI keeps track of a ''unit_ratio''. This is <code>our_total_unit_costs / enemy_total_unit_costs</code>, where the costs are the sum of the cost of all units on the map weighted by their HP. The AI also attempts to estimate the total income over the next 5 turns.

If the AI is in state NORMAL '''and''' the unit_ratio exceeds a predefined threshold (defined in ''begin'', see below) '''and''' the estimated income is positive, the AI switches to state SAVE_GOLD. Now the AI does not recruit units anymore until ''unit_ratio'' falls below another predefined threshold (defined in ''end''). Then the AI switches back to state NORMAL and recruits again.

With this behavior the AI can save quite a lot of gold. If the gold then accumulates to more than another predefined value (''spend_all_gold''), it switches into state SPEND_ALL_GOLD and recruits a big army to start an offensive wave.

The AI ignores all those gold saving strategies when it is in state LEADER_IN_DANGER. This happens when an enemy is close to the AI leader (within 5 hexes).

'''Important note:''' While one might assume that the AI plays better when it tries to save some gold, tests show that this is generally not the case. They indicate that, for the current AI, it is always better for the AI to have as many units on the map as possible. This aspect is therefore deactivated by default.

===The Aspect===
This aspect also requires the [[Wesnoth_AI_Framework#The_.5Bai.5D_Tag_.E2.80.94_Aspects|composite syntax]].
[ai]
[aspect]
id=recruitment_save_gold
[facet]
[value]
#(attributes)
[/value]
[/facet]
[/aspect]
[/ai]
Attributes inside '''[value]''':
* '''active'''=0: (int) From this turn on the aspect is active. The AI always spends all gold until then. <code>active=0</code> can be used to deactivate gold saving.
* '''begin''': (double) See explanation above.
* '''end''': (double) See explanation above.
* '''spend_all_gold''': (int) See explanation above. If set to '-1', the AI never switches to state SPEND_ALL_GOLD.
* '''save_on_negative_income''': (boolean) If this is set to yes, the AI switches to state SAVE_GOLD even if the income is negative (estimated over 5 turns, village gain and unit loss estimation included).

===Example===
[ai]
[aspect]
id=recruitment_save_gold
[facet]
[value]
active=2
begin=1.5
end=1.1
spend_all_gold=-1
save_on_negative_income=no
[/value]
[/facet]
[/aspect]
[/ai]

A macro can be used to deactivate recruitment_save_gold:

{AI_ASPECT recruitment_save_gold {AI_DEACTIVATE_SAVE_GOLD} }

==Other Recruitment Related Aspects==

*'''recruitment_diversity'''=2.0: (double) When this value is high, the AI recruits more units which are currently rare on the map. When the value is 0.0, the AI only recruits the best unit. See [[#Implementation_details_for_interested_readers|above]] for implementation details.
*'''recruitment_more'''="": (string) This key takes a comma separated list containing unit types, usages or levels. This is meant to let a scenario editor make an easy hack for making the AI recruit more units of a specific type. (25 will be added to the unit type's score.) The same unit type can also be used several time. For example, with <code>recruitment-more="Orcish Grunt, Orcish Grunt"</code> it is possible to add a total of 50 to the Grunt's score.
*'''recruitment_randomness'''=50: (int) A random value between 0 and ''recruitment_randomness'' is added to each score. Use a high value, such as '200', to increase randomness.
*'''recruitment_pattern'''="": (string) This key takes a comma separated list containing unit types, usages or levels. Common values for ''usage'' are 'scout', 'fighter', 'archer', 'healer' and 'mixed fighter'. This tells the AI with what probability it should recruit different types of units. The usage is listed in the unit type config files (see data/core/units/ for mainline units; see also [[UnitTypeWML]]).
**For example, <code>recruitment_pattern=fighter,fighter,2</code> means that the AI recruits on average twice as many fighters as level 2 units. It does not mean that it recruits two fighters first, then a level 2 unit, then two fighters again, etc.
**Internally ''recruitment_pattern'' expands into a ''recruitment_instructions'' facet with <code>pattern=yes</code> and <code>importance=1</code>. Make sure that there is no ''recruitment_instructions'' facet with <code>importance=1</code> when using ''recruitment_pattern''.
*'''villages_per_scout'''=4: (int) A number 0 or higher which determines how many scouts the AI recruits. If set to '0', the AI does not recruit scouts to capture villages.

==Making recruitment strong==

The default values for the recruitment aspects are chosen to provide variety in the units the AI recruits. Tests have shown that it plays slightly better (against other AIs, at least) when it mostly recruits the units that score highest in the evaluation explained above. The best values found are:
* '''recruitment_diversity=0.8''': Let the AI recruit the best units only.
* '''recruitment_randomness=0''': Let the recruitment not be random.
* '''villages_per_scout=0''': The AI plays slightly better with fewer or no scouts.
* '''deactivate recruitment_save_gold''': The AI plays better when it spends all money.

In Multiplayer games, the AI 'Strong AI (RCA)' can be chosen with the settings as described here. {{DevFeature1.13|5}} As this is only a very minor modification of the default AI, this AI has been changed to a [[Wesnoth_AI#AIs_Available_in_the_Multiplayer_Setup_Menu|Dev AI]] (available in debug mode only) and has been renamed to 'Default AI (RCA) with Alternate Recruiting'.

==Some notes on multiple leaders==

The new recruitment CA is able to recruit with multiple leaders — even with different recruitment lists for each leader. However there are some drawbacks:
* In the current version, the leaders recruit almost the same amount of units by default. This can partly be configured with the ''recruitment_instructions'' aspect and its attribute ''leader_id''.
** Note however that, as mentioned above, ''leader_id'' in ''recruitment_instructions'' is only a recommendation. For example, a leader recruits more units when enemies are near.
* Multiple leaders with different recruitment lists in combination with a <code>recruitment_pattern</code> may not result in the expected behavior. For the AI it is more important that the leaders recruit the same amount of units than fulfilling the ratios given in ''recruitment_pattern''.

'''See also:''' [[Wesnoth AI]]
[[Category:AI]]

AI Arena

2017-11-30T15:12:29Z

Holius: fix errors (title levels)

{| class="wikitable" style="text-align: center;"
|'''Note'''
|-
|The AI Arena should still be usable, but it is currently not maintained. If you encounter any problems with the Arena itself or the content of this page, please let us know either on the forums or the developer IRC channel.
|}

== AI Arena is an interactive AI testing framework ==
It is implemented as a test scenario ai_arena_small (available from r34329 (31 Mar 09) )

This documentation is accurate as of r34889 (14 Apr 09)

To launch it, run Wesnoth with a -t parameter (must not come as last parameter). For example:

./wesnoth-debug -t ai_arena_small -d

The scenario is located in data/ai/scenarios/scenario-AI_Arena_small.cfg

It is based on the Den of Onis.

The map includes three sides:

1: Human (AI developer)

2: Challenger AI (Side which which is tested, 'north team')

3: Champion AI (Side which commands the enemy of the AI being tested, 'south team')

All leaders start off-map in pocketed locations.

You can access an interactive menu by right-clicking a map tile.

There are menu options which allows AI developer to pick the challenge (each challenge has a small description and a unique number), and to pick the AI that will try the challenge (AI developer can select from a list a .cfg location which contains the bare *contents* of the SIDE tag with [[SideWML]] and [[AiWML]] configuration - without the SIDE tag itself). The test will be loaded (units will appear inside the Arena) and selected AI will be hot-redeployed).

Then, the AI developer can end his turn and watch the AI's actions.

== Creating new challenges ==
Please feel free to add more 'AI challenges' and improve existing ones. Each challenge should be AI-independent.

To create a challenge which will be committed into Wesnoth repository:

# Look at the content ai/scenarios/ai_arena_small directory
# Assign a unique CODE number (4 digits) for your challenge. Pick a NAME (suitable as part of WML event name) for your challenge. Write a small DESCRIPTION for your challenge
# Create a new file in ai/scenarios/ai_arena_small directory.
[event]
name=preload
[lua]
code = << register_test('CODE-NAME','DESCRIPTION'); >>
[/lua]
[/event]
[event]
name=CODE-NAME
first_time_only=no
[/event]

Use the second event to create the situation. If you do not intend to commit that file, you may use any filename and event name you like, just make sure that this is legal WML event name and make sure that it matches in both events.

Note: Add code to clean all your labels to cleanup function. (since there is (so far) no way to delete all labels on the map)

== Creating new AI configurations ==

Example of AI configuration file:
ai_algorithm =formula_ai
[ai]
eval_list=yes
[register_candidate_move]
name=poisoner
type=attack
evaluation="{ai/formula/poisoner_eval.fai}"
action="{ai/formula/poisoner_attack.fai}"
[/register_candidate_move]
[/ai]
Then use it by typing a name in the interactive menu, or add a reference to it to the AI Arena scenario

== Where to put new AI configurations ==

If it should be available for selection as a multiplayer AI and AI Arena in both non-debug and debug modes, put it in
data/ai/ais/

If it should be available for selection as a multiplayer AI and AI Arena only in debug mode, put it in
data/ai/dev/

== Where to put all formulas which may be used by the AIs ==

data/ai/formula/

[[Category:AI]]

LuaAI

2017-11-30T14:59:46Z

Holius: fix errors (title levels)

Wesnoth provides the functionality to both access and define all types of [[Wesnoth_AI_Framework#Types_of_AI_Components|AI components]] using [[LuaWML|Lua]]. Instructions for using these components to customize the default AI and to create custom AIs are explained on other pages. See [[Wesnoth AI]] for a summary of the available documentation. This page is a reference guide to the Lua AI functions, variables and component syntax.

== Lua AI Functions ==

The code of [[Creating_Custom_AIs#Creating_Custom_Candidate_Actions|custom Lua candidate actions]] (CAs) has access to the ''ai'' table. This is a Lua table containing functions for getting information about the game state and for executing AI moves. Together with the other [[LuaWML|Wesnoth Lua functions]] they can be used in the CA [[Creating_Custom_AIs#Evaluation_Function|evaluation]] and [[Creating_Custom_AIs#Execution_Function|execution]] functions to code the desired AI behavior.

=== ''ai'' Table Functions Returning Game State Information ===

The ''ai'' table contains a large number of functions returning game state information. Some of those are simple scalar values which are self-explanatory, while others can be tables with many elements and complex structure. We will not show the structure of all these tables here. If you need to know the exact structure of such a table, use the method described below for [[#Debug_access_to_the_AI_tree|accessing the AI tree]].

==== Retrieving Aspect Values ====

The contents of many of the [[AiWML#List_of_AI_Aspects|AI aspects]] can be read using ''ai'' table commands of the form
* '''ai.get_<aspect_name>()''', for example
** '''ai.get_aggression()'''
** '''ai.get_caution()'''
Note that this returns the result of the aspect evaluation given the game state at the time of the last [[Wesnoth_AI_Framework#Some_more_on_the_invalidation_keys|invalidation of the aspect]], not its definition. For example, '''ai.get_avoid()''' returns the list of avoided hexes, rather than the [[StandardLocationFilter|Standard Location Filter]] used to find them, and [[#Dynamic_Lua_Aspects|dynamic Lua aspects]] return the function evaluation result, not the function itself.

The full list of functions returning aspect values is
Functions returning scalar values (numbers, strings or booleans):
ai.get_aggression()
ai.get_attack_depth()
ai.get_caution()
ai.get_grouping()
ai.get_leader_aggression()
ai.get_leader_ignores_keep()
ai.get_leader_value()
ai.get_number_of_possible_recruits_to_force_recruit()
ai.get_passive_leader()
ai.get_passive_leader_shares_keep()
ai.get_recruitment_ignore_bad_combat()
ai.get_recruitment_ignore_bad_movement()
ai.get_scout_village_targeting()
ai.get_simple_targeting()
ai.get_support_villages()
ai.get_village_value()
ai.get_villages_per_scout()

Functions returning tables:
ai.get_attacks()
ai.get_avoid()
ai.get_leader_goal()
ai.get_recruitment_pattern()

{{DevFeature1.13|5}}

These functions are now deprecated. The new standard way of accessing aspect values is through the <code>ai.aspects</code> table, for example <code>ai.aspects.aggression</code>. All aspects can be accessed this way, including some that don't have function forms, such as the advancements aspect. {{DevFeature1.13|6}} The corresponding get_aspect_name functions are now deprecated, with the exception of <code>ai.get_attacks()</code> which returns an analysis of all possible attacks; this differs from <code>ai.aspects.attacks</code> which only returns the allowed units for use in attacks (in "own" and "enemy" subtables).

==== Functions Returning Other Game State Information ====

* '''ai.get_targets()''': Get the AI targets. See [[#Lua_Goals_and_Targets|below]] for details.
* '''ai.side''': side number of the AI
* '''ai.suitable_keep(''unit'')''': This returns the location of the closest keep to the unit passed as argument. Note that this returns the ''x'' and ''y'' coordinates of the keep as two separate arguments, so it needs to be called as <syntaxhighlight lang='lua' inline>local x, y = ai.suitable_keep(unit)</syntaxhighlight>.

Finally, the following functions related to move maps (tables that relate the current positions of units and the hexes they can move to) also exist:
* '''ai.get_new_dst_src()'''
* '''ai.get_new_enemy_dst_src()'''
* '''ai.get_new_enemy_src_dst()'''
* '''ai.get_new_src_dst()'''
* '''ai.is_dst_src_valid()'''
* '''ai.is_enemy_dst_src_valid()'''
* '''ai.is_enemy_src_dst_valid()'''
* '''ai.is_src_dst_valid()'''
* '''ai.recalculate_enemy_move_maps()'''
* '''ai.recalculate_move_maps()'''
If you need to know what they do and the exact structure of their return values, use the method described below for [[#Debug_access_to_the_AI_tree|accessing the AI tree]].

The file ''ai/lua/stdlib.lua'' replaces the move-map functions with the following simplified set:
* '''ai.get_dst_src()'''
* '''ai.get_src_dst()'''
* '''ai.get_enemy_dst_src()'''
* '''ai.get_enemy_src_dst()'''

'''Note:''' The file stdlib.lua is loaded by default, but if a custom Lua [engine] tag is defined, it must load the file manually with the following code:
<syntaxhighlight lang='lua'>
local ai_stdlib = wesnoth.require('ai/lua/stdlib.lua')
ai_stdlib.init(ai)
</syntaxhighlight>

=== ''ai'' Table Functions for Executing AI Moves ===

For all functions below, units (''unit'', ''attacker'', ''defender'') can be passed either as a unit object in a single variable, or as two parameters specifying the unit's ''x'' and ''y'' coordinates. For functions taking more than one unit as arguments, it can also be a mix of the two.

* '''ai.attack(''attacker, defender, weapon, aggression'')''': Execute attack by ''attacker'' against ''defender''. If ''weapon'' is provided, it is the number of the weapon to be used (count starts at 1, not 0, as always in Lua), otherwise choice of the weapon is left to the AI engine. If ''aggression'' is provided, it is used to influence the choice of the best weapon. Obviously, this only makes sense if this choice is left to the engine, that is, if ''weapon'' is set to either 'nil' or '-1'.
* '''ai.move(''unit, to_x, to_y'')''': Execute partial move of ''unit'' to hex ''(to_x'', ''to_y)''. ''Partial'' move means that the unit keeps whatever movement points it has left after the move.
* '''ai.move_full(''unit, to_x, to_y'')''': Execute full move of ''unit'' to hex ''(to_x'', ''to_y)''. ''Full'' move means that the unit's movement points are set to zero at the end of the move.
* '''ai.recall(''unit_id, x, y'')''': Recall the unit with id ''unit_id''. An optional recruit location can be given in ''x'' and ''y''. If the location is omitted, a suitable hex is automatically chosen by the AI engine.
* '''ai.recruit(''unit_type, x, y'')''': Recruit a unit of type ''unit_type''. An optional recruit location can be given in ''x'' and ''y''. If the location is omitted, a suitable hex is automatically chosen by the AI engine.
* '''ai.stopunit_attacks(''unit'')''': Remove remaining attacks from ''unit''. This is equivalent to setting <code>attacks_left=0</code>.
* '''ai.stopunit_moves(''unit'')''': Remove remaining movement points from ''unit''. This is equivalent to setting <code>moves=0</code>.
* '''ai.stopunit_all(''unit'')''': Remove both remaining attacks and remaining movement points from ''unit''.
* '''ai.synced_command(''command, x1, y1'')''': Execute the specified Lua command in a replay and MP safe way. ''command'' is a string containing the Lua code and ''(x1,y1)'' is an optional map location that is the only allowed external variable used in the code string (specified as Lua variables ''x1'' and ''y1'').

{{DevFeature1.13|5}} The above functions change the gamestate and thus are not always available. To be more specific, they are only available if '''ai.read_only''' is false. If it is true, the functions do not exist. This is the case everywhere except stage and candidate evaluation functions.
The following functions are available for checking whether a planned AI move is possible. This is useful in order to prevent an aborted execution of a move, which might result in some or all of the remaining moves to be aborted by the AI due to a [[Creating_Custom_AIs#Execution_Function|blacklisted candidate action]].

* '''ai.check_attack()
* '''ai.check_move()
* '''ai.check_recall()
* '''ai.check_recruit()
* '''ai.check_stopunit()
* '''ai.check_synced_command()

These check functions take the same arguments as the respective AI action functions. They return a Lua table which looks something like the following for a successful check
<syntaxhighlight lang='lua'>{
gamestate_changed = false,
ok = true,
status = 0,
result = 'action_result::AI_ACTION_SUCCESS'
}</syntaxhighlight>
and like this for an unsuccessful check
<syntaxhighlight lang='lua'>{
gamestate_changed = false,
ok = false,
status = 2008,
result = 'move_result::E_NO_ROUTE'
}</syntaxhighlight>

'''Notes:'''
* ''status'' is the error code returned by the AI engine in case of an unsuccessful code. The error string for a given error code can be found in file [https://github.com/wesnoth/wesnoth/blob/master/src/ai/actions.hpp src/ai/actions.hpp]. {{DevFeature1.13|5}} It is now also available as the ''result'' element of the table.
* The move execution functions return the same table, with the only difference being that ''gamestate_changed'' is 'true' in case the execution resulted in a change of the game state (even if the move was only partially successful).

== Lua AI Variables — Persistence ==

When [[Creating Custom AIs]] in Lua, it is sometimes necessary to transfer information between the evaluation and execution functions of the same candidate action (CA) or between CAs. It might also be necessary to have this information persist from turn to turn and across save/load cycles. This could, in principle, be done using WML variables, but depending on the type and amount of information, that could be awkward and/or inconvenient to do in practice.

The Wesnoth AI therefore includes a field called ''data'' which is automatically added to the internal AI context. The evaluation and execution functions of [[Creating_Custom_AIs#Setting_Up_a_Custom_AI|Lua candidate actions]] have access to this field if the third (optional) variable is passed to them. Assuming this variable is called ''self'', the field is accessed as ''self.data''.

When saving a game, the save routine finds this field, converts it to a config and stores its content in readable format in the save file. When the scenario gets loaded back, the engine code injects the data back into the AI context. Note that, in order for this to work, all content of ''data'' needs to be in [[LuaWML#Encoding_WML_objects_into_Lua_tables|WML table format]]. Other format content can also be used during an AI turn, for example to pass it between the evaluation and execution functions of the same CA, but it is lost when saving the game.

== Dynamic Lua Aspects ==

It is possible to define aspects using Lua. These can be either static or dynamic, that is, their value can change depending on the game state. We demonstrate this here with a few examples.

First, as simple example of defining the ''aggression'' aspect statically in Lua:
<syntaxhighlight lang='wml'>
[aspect]
id="aggression"
engine="lua"
value="0.765"
[/aspect]
</syntaxhighlight>
There is, of course, no advantage of this over simply [[AiWML|defining the aspect in WML]], we simply show it for completeness and for the syntax. An example of defining aggression dynamically so that it increases slowly from turn to turn is
<syntaxhighlight lang='wml'>
[aspect]
id=aggression
engine=lua

code=<<
local value = wesnoth.current.turn / 10.
return value
>>
[/aspect]
</syntaxhighlight>
Note the difference between the ''value'' and ''code'' attributes in the two examples.

{{DevFeature1.13|5}} A Lua aspect may also contain an [args] subtag, which is passed to the aspect evaluation function in the same way as for candidate actions.

==== The ''advancements'' Aspect ====

A slightly more elaborate example, using the ''advancements'' aspect, is given below. This aspect is different from others in that it can be used with a function ''advance(x, y)'', where ''(x, y)'' is the current location of the unit about to advance. You can then use ''wesnoth.get_unit(x, y)'' to retrieve the unit object itself. For example, the following code advances the unit with id 'Bob' to a swordsman (assuming here that this unit is a spearman), while all other spearmen are advanced to javelineers.
<syntaxhighlight lang='wml'>
[ai]
[aspect]
id=advancements
engine=lua

code=<<
function advance(x, y)
local unit = wesnoth.get_unit(x, y)
if (unit.id == 'Bob') then
return 'Swordsman'
else
return 'Javelineer'
end
end
return advance
>>
[/aspect]
[/ai]
</syntaxhighlight>
Note that this aspect only affects AI units while they are attacking. When a defending unit advances, it is still decided randomly. That is because Wesnoth's design does not allow the AI to make out of turn decisions.

==== The ''attacks'' Aspect ====

{{DevFeature1.13|5}}

The attacks aspect may also be defined using the Lua engine; this is a little more complicated than most aspects, though. The aspect must return a table containing two keys, '''own''' and '''enemy'''. The value of each of these keys can be either a table defining a valid WML unit filter or a function which, when called with a unit proxy as its argument, returns true if the unit may be attacked and false otherwise.

== Lua Goals and Targets ==

It is also possible to define AI [[RCA_AI#Use_of_Goals_and_Targets_in_the_RCA_AI|goals and targets]] in Lua. This is, however, somewhat inconvenient and we generally recommend using the [[AiWML#The_.5Bgoal.5D_Tag|[goal] tag]] with WML [[StandardUnitFilter|Standard Unit Filter]]s (SUFs) or [[StandardLocationFilter|Standard Location Filter]]s (SLFs) instead. That is much more versatile and it makes no difference to the AI behavior whether the goals are defined using WML or Lua.

The only time that defining goals in Lua might be advantageous is if one wants to use goals with dynamic values, such as in this example, where one goal has a constant value, while the other's value increases from turn to turn; or if one wants to define other types of targets that the other goals do not support (not demonstrated here).
<syntaxhighlight lang='wml'>
[goal]
name=lua_goal
engine=lua
code = <<
local turn = wesnoth.current.turn
local targets = {}
targets[1] = { value = 2, type = 2, loc = { x = 5, y = 6 } }
targets[2] = { value = turn * 2 , type = 2, loc = { x = 4, y = 9 } }
return targets
>>
[/goal]
</syntaxhighlight>

As you can see, the return value must be an array containing the targets. Each target must contain three fields:
* '''value''': The value of the target, equivalent to that defined for WML goals
* '''loc''': A table with attributes ''x'' and ''y'' defining the target's location. This is one of the disadvantages with respect to the WML syntax. Each goal needs to be defined individually by its coordinates. The use of SUFs and SLFs is not possible.
* '''type''': A number defining the type of the target. File [https://github.com/wesnoth/wesnoth/blob/master/src/ai/default/contexts.hpp src/ai/default/contexts.hpp] defines the available types as
<syntaxhighlight lang='cpp'>
enum TYPE { VILLAGE, LEADER, EXPLICIT, THREAT, BATTLE_AID, MASS, SUPPORT };
</syntaxhighlight>
User-defined targets should usually be given <code>type = 2</code> for ''target'' and ''target_location'' type targets, and <code>type = 3</code> for ''protect_*'' type targets. This corresponds to ''EXPLICIT'' and ''THREAT'' targets (the third and fourth in the enum list, with counting starting at 0).
{{DevFeature1.13|5}} Target types can now be specified as strings instead of integers. The possible values are <syntaxhighlight lang='lua' inline>'village', 'leader', 'explicit', 'threat', 'battle aid', 'mass', 'support'</syntaxhighlight>. (Integer types still work, for now.)

'''Notes:'''
* This code is parsed by the Lua engine and the targets are available to any engine.
* Targets can be read in Lua using '''ai.get_targets()'''
** This produces a Lua array like the one above, with one element for each hex that was found as a target (even if SUFs or SLFs were used in WML).
** {{DevFeature1.13|5}} The array now contains string target types, not integer target types. Thus, any previous use of get_targets() which checks the type must be updated.
** The table also includes all the [[RCA_AI#RCA_AI_Aspect_and_Goal_Configuration|automatically generated targets]].
* {{DevFeature1.13|5}} A Lua goal may also include an [args] subtag, which is passed to the goal evaluation function in the same way as for candidate actions.

== Lua Candidate Actions ==

Lua candidate actions are the recommended method for creating custom AIs. They are described on a [[Creating_Custom_AIs#Setting_Up_a_Custom_AI|separate page]].

== Lua AI — Legacy Methods ==

The recommended method of using custom Lua AI functionality is described at [[Creating Custom AIs]]. A variety of alternative older methods also still exist. There should be few, if any, situations in which using these methods is advantageous, but for completeness they are described on a [[Lua_AI_Legacy_Methods_Howto|separate page]].

The methods include:

* '''Lua stage''': There should not be anything that can be done with the Lua stage that cannot just as easily be done with the ''main_loop'' stage.
* '''Lua engine''': With the new type of Lua candidate actions, it is not necessary any more to define a Lua engine. This is only needed for the old-style CAs.
* The '''old syntax''' for defining '''Lua candidate actions''': There is no advantage in using the old syntax over the new one. Since the evaluation and execution code was given as separate `evaluation=` and `execution=` keys, there is no chance of shared state between the two.
* '''Preload event''': It is not necessary to set up a preload event any more (the one possible exception might be in order to set up a debug testing mechanism).
* '''Behavior (sticky) candidate actions''': These are Lua CAs which attach directly to specific units. They could, in principle, still be useful. However, using the new syntax for Lua CAs with a condition to filter for specific units is usually done just as easily. Several of the [[Micro AIs]] demonstrate how to do so.

== Debug access to the AI tree ==

It is now possible to access candidate actions (and some other AI components) and have them updated automatically without requiring reloading. Only external candidate actions work in this way though. Candidate actions defined in the engine inside the config file of the scenario will not be updated if their code is directly in the [engine] tag, and they will only be updated on reloading if they are set up by including a file.

The purpose of this is to aid with debugging. Now the developer does not have to reload the game to test the changes done in the candidate action code.

Access to the AI tree is done with function
wesnoth.debug_ai(side)
The function only works in debug mode '''and''' if Wesnoth is launched with the <code>--debug-lua</code> launch argument. It returns a table containing the component tree of the active AI for a side, the engine functions and to the [[#Lua_AI_Functions|''ai'' table]] of the Lua AI. It also allows the user to execute stages and to evaluate and/or execute candidate actions.

Structure of the table (example showing only some of the output):
{
stage_hello = function: 0x6dc24c0,
ai = #the ai table,
data = {
},
do_moves = function: 0x6dc2590,
candidate_action_evaluation_hello = function: 0x6dc2560,
candidate_action_evaluation_hello2 = function: 0x6dc2640,
components = {
id = "",
stage = {
another_stage = {
name = "another_stage",
id = "",
exec = function: 0x17cd3bb,
engine = "lua",
stg_ptr = "userdata: 0x7c5a8d0"
},
testing_ai_default::candidate_action_evaluation_loop = {
name = "testing_ai_default::candidate_action_evaluation_loop",
candidate_action = {
external = {
name = "external",
id = "",
exec = function: 0x17cd2f3,
engine = "lua",
ca_ptr = "userdata: 0x6fb3600"
},
second = {
name = "second",
id = "",
exec = function: 0x17cd2f3,
engine = "lua",
ca_ptr = "userdata: 0x6fb2f50"
}
},
id = "ca_loop",
exec = function: 0x17cd3bb,
engine = "",
stg_ptr = "userdata: 0x6fb2728"
}
},
engine = "",
name = ""
},
candidate_action_execution_hello2 = function: 0x6dc2670,
candidate_action_execution_hello = function: 0x6dc2530
}

The fields described as " name = function: 0xXXXXXXXX" are functions and can be called to using the usual function call syntax of Lua.

Some examples:
<syntaxhighlight lang='lua'>
wesnoth.debug_ai(2).ai -- returns the ai table containing of the Lua AI context

wesnoth.debug_ai(2).stage[another_stage].exec() -- executes the stage

wesnoth.debug_ai(2).ai.get_aggression() -- returns the current value of the aggression aspect of the AI
</syntaxhighlight>

Therefore, we have up-to-date access to the whole AI, including the [[#Lua_AI_Variables_.E2.80.94_Persistence|''data'' table]].

'''Notes:'''
* Treat the structure above as an example only. The real content and structure may vary. This should not be a problem for AI applications though, as this function is only used for debugging and will not work in non-debug mode. It is really meant for testing only.
* ''debug_utils'' from the [http://forum.wesnoth.org/viewtopic.php?f=58&t=28320&start=45 Wesnoth Lua Pack] can be used to display the content of essentially any Wesnoth Lua data structure, including the ''debug_ai'' tree. You should always use some sort of vizualization like that (another, more basic option is to simply go through and print the keys of the returned table using the Lua ''pairs()'' function) when work with ''wesnoth.debug_ai''.

'''See also:''' [[Wesnoth AI]]
[[Category:AI]]
[[Category: Lua Reference|*]]

Guide to UMC Content

2017-11-23T15:35:01Z

Holius: page structure + link to addon server

This is a guide to the current (1.12.x) user-made content for players. It provides unfamiliar players with detailed information about campaigns (including story, completion, difficulty and playing style) as well as detailed information about eras. Feel free to edit this guide, it is a wiki.

== Instructions ==
When adding a campaign to the list, please place it in its alphabetically sorted location, ignoring any initial article ("A", "An", or "The").

=== Blueprint for Campaigns ===

* Description:

* Author:

* Maintainer: if not maintained by the author anymore.

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

* Length:

* Version:

* Requirements: (only if needed)

* 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 erratically 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

=== Blueprint for Eras ===

* Description:

* Author:

* Maintainer: if not maintained by the author anymore.

* 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.

* Faction Descriptions: Describe your individual factions here.

* Version:

* Requirements: (only if needed)

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

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

=== Campaigns ===

==== Add's Army ====

''Add, a wounded paladin, is posted to the quiet and remote province of Cormell to recover. But when undead creatures start appearing, it's up to Add to do something about it... with whatever motley forces he can muster.''

'''Author:''' Makepeace McEvoy

'''Status:''' Complete

'''Length:''' 8 scenarios

'''Version:''' 1.1

'''Difficulty:''' Easy (with a touch of not yet balanced)

'''Style:''' Skirmish, Dungeon

'''Faction/Era:''' Default

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

==== After the Storm ====

''Follow the journey of Galas and his band following the events of Invasion from the Unknown''

'''Author:''' shadowmaster/ShikadiLord

'''Status:''' Finished

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

'''Version:''' 0.9.9

'''Difficulty:''' Medium-hard

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

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

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

'''Note:''' (vultraz) Long, very enjoyable campaign with great story. (Knyghtmare) The best UMC campaign ever!

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#After_the_Storm Players’ Review(s)]'''

==== 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:''' 10 playable scenarios / 1 cutscene

'''Version:''' 0.10.2

'''Difficulty:''' Normal

'''Style:''' Skirmish

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

'''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(s)]'''

==== Aria of the Dragon-Slayer (The Dragon Trilogy, Part III) ====

''''''Part VII: Awakening from Legend''' - In ancient times, the fate of Irdya was changed in a great war against the dragons; and, in that war, the heroines Maat and Myra of Hiera'Shirsha stopped the Sky Dragon Svarballi and, unable to destroy him, locked him in a mighty prison. Now, five millennia after that war, as humans rule Irdya and two suns shine in the sky, the one with the power to finally slay the Sky Dragon may have been born as a peasant girl in the outskirts of civilization... Follow Tenma Yozora through the last days of Irdya's Golden Age and through the path to becoming the prophesied Dragon-Slayer...''

'''Author:''' revansurik

'''Status:''' Complete

'''Length:''' 51 scenarios

'''Version:''' 0.4.2.2

'''Difficulty:''' Normal

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

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

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

==== Bad Moon Rising ====

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

'''Author:''' Doofus-01

'''Status:''' Finished

'''Length:''' 20 scenarios

'''Version:''' 1.5.8

'''Difficulty:''' Hard

'''Style:''' Skirmish

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

'''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

'''Version:''' 1.0.4

'''Difficulty:''' Hard

'''Style:''' Skirmish

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

'''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

'''Version:''' 1.1

'''Difficulty:''' Unbalanced

'''Style:''' Skirmish

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

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

'''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

'''Version:''' 1.0.3

'''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]

'''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

'''Version:''' 1.1.1

'''Difficulty:''' Hard

'''Style:''' Skirmish

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

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

==== 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

'''Version:''' 1.2.1

'''Difficulty:''' Normal

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

'''Faction/Era:''' Default

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

==== Danse Macabre ====

''Macabre is a rare zombie who has intelligence and will. What's he like? What's his purpose?''

'''Author:''' kamikaze

'''Maintainer:''' James_The_Invisible

'''Status:''' Completed

'''Length:''' 12 scenarios

'''Version:''' 1.3

'''Difficulty:''' Unbalanced

'''Style:''' Large Battle

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

'''[http://units.wesnoth.org/1.12/Danse_Macabre/en_US/Danse_Macabre.html Custom units]'''

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

'''Note:''' While the campaign is playable on Wesnoth 1.12 without major issues, it is (still) in need of heavy re-balancing. Sadly, for various reasons I am not able to do it in near future but patches are always welcome, preferably in form of pull requests on [https://github.com/konecnyjakub/Danse_Macabre GitHub].

==== 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)

'''Version:''' 1.0.4

'''Difficulty:''' Hard

'''Style:''' Skirmish

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

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

==== Dawn of Thunder ====

''A young elvish fighter is send to represent the Aethenwood at the Ka'lian. The adventure turns out to be bigger then expected.''

'''Author:''' Paulomat4

'''Status:''' unfinished

'''Length:''' 17 scenarios

'''Version:''' 1.1.0

'''Difficulty:''' challenging

'''Style:''' Skirmish, Large Battle, RPG-elements

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

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

==== 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

'''Version:''' 0.2.14

'''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]'''

'''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 Final Exam ====

''Young mage Erika must find a magic book to become a true mage. But will it really be her final exam?''

'''Author:''' Elven

'''Status:''' Finished

'''Length:''' 4 scenarios

'''Version:''' 2.7

'''Difficulty:''' Easy

'''Style:''' Skirmish, Minigames

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

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

'''Note:''' Short, easy campaign with varying objectives. Features female mage as leader.

==== The Flight of Drakes ====

''Legends of the Emerald Forest, chapter I: The Flight of Drakes.

''Follow drake king Klader on his quest to find the Crown of Light, a legendary artifact from pre-historic times.''

''This campaign is the first chapter of a trilogy; the second chapter is an Undead campaign and it's called 'Only Death Behind'.''

'''Author:''' NoQ

'''Status:''' Finished

'''Length:''' 7 playable scenarios / 2 talk only

'''Version:''' 1.1.2

'''Difficulty:''' Easy

'''Style:''' Skirmish

'''Faction/Era:''' Drakes

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

==== 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

'''Version:''' 2.0.0

'''Difficulty:''' Normal

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

'''Faction/Era:''' Unique. You play Elves and Undead throughout the campaign.

'''Walkthrough:''' [[IftU Walkthrough]]

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

==== The Legend Begins ====

''The tale of Jahin, the greatest hero the land of Arkenova, or perhaps the world of Irdya, had ever known. Watch his legend unfold before your very eyes.''

'''Author:''' Tahsin Jahin Khalid (Lord-Knightmare)

'''Status:''' Complete

'''Length:''' 73 scenarios divided into 3 episodes. Continuation from one episode to the next one is possible, but not recommended.

Episode 1 - 28 scenarios

Episode 2 - 26 scenarios

Episode 3 - 20 scenarios

'''Version:''' 0.5.2

'''Requirements:''' ''War of Legends'' is required to be installed. Latest version recommended.

'''Difficulty:''' Intermediate

'''Style:''' skirmishes, survivals, large battles, dungeons, boss battles

'''Faction/Era:''' [http://units.wesnoth.org/trunk/mainline/en_US/era_default.html Default], [http://units.wesnoth.org/trunk/War_of_Legends/en_US/war_of_legends.html War of Legends]

'''Custom units:''' [http://units.wesnoth.org/trunk/The_Legend_Begins/en_US/The_Legend_Begins-E1.html Custom Units]

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

==== 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

'''Version:''' 1.0.2

'''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]'''

'''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 threat, 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''' (5 chapters, 110 scenarios) - 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:''' complete

'''Length:''' 200 (+8 talk-only) scenarios

'''Version:''' 3.0.1

'''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

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

'''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).

==== The Library of Kratemaqht ====

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

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

'''Status:''' Complete

'''Length:''' 17 scenarios

'''Version:''' 1.0.0

'''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]'''

'''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(s)]'''

'''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 Militia ====

''The Travels of a group of Peasants and their Friends; a level 0 campaign that does not focus on a singular hero.''

'''Author:''' Desert_Shyde

'''Status:''' Finished

'''Length:''' 15 scenarios

'''Version:''' 1.5.2

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default

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

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?t=30294

==== The North Wind ====

''Wesnoth's army was occupied fighting Mal Ravanal in the East, but there were whisperings of an orcish attack in the north. Konrad II must send Deoran, now an experienced rider and commander, with a small band of knights to hold off the orcs....''

''This campaign features unique gameplay characteristics such as a lack of recruiting and a 24-turn time-of-day cycle.''

'''Author:''' aelius, Deusite; pyndragon

'''Status:''' WIP

'''Length:''' 1 playable scenario, 6 intended

'''Version:''' 0.0.5

'''Difficulty:''' Normal

'''Style:''' RPG, Skirmish, Survival

'''Faction/Era:''' Loyalists

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

==== Only Death Behind ====

''Legends of the Emerald Forest, chapter II: Only Death Behind.''

''Three ghosts have escaped from the land of the dead. Yet they don't remember anything about their past.''

''This is an Undead campaign that references certain characters and events from 'The Flight of Drakes', yet it can be played separately.''

'''Author:''' NoQ

'''Status:''' Complete

'''Length:''' 7 playable scenarios / 1 talk only

'''Version:''' 1.0.0

'''Difficulty:''' Easy

'''Style:''' Skirmish

'''Faction/Era:''' Undead

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=39119&p=556996#p556996

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Review_by_Adamant14 Player's Review]'''

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

==== 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

'''Version:''' 1.2

'''Difficulty:''' Hard

'''Style:''' Skirmish

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

'''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(s)]'''

==== 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

'''Version:''' 1.1.12

'''Difficulty:''' Normal

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

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

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

==== 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

'''Version:''' 1.2.7

'''Difficulty:''' Normal

'''Style:''' Skirmish

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

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

'''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.

==== Roboke's Island ====

Mystic Island Quest

''Embark from Elensefar on an expedition to the west that will not only change your life but conearn the fate of many.''

''"Unraveling the mystery of Roboke island is a magic experience." (Weldyn Gazette)''

''"Ferocious battles and mysterious riddles await you." (Wesmere Post)''

''"The adventures of Roboke and his side-kick are truly stunning." (Knalga News)''

'''Author:''' x42

'''Status:''' beta, story-complete

'''Length:''' 18 playable scenarios + 6 story chapters

'''Version:''' 0.8.X-beta

'''Difficulty:''' Hard

'''Style:''': various (RPG, Skirmish, Puzzle)

'''Faction/Era:''' Default (Fencer as main hero + various allies)

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

'''Note:''' Requires BfW ≥ 1.11.6 (for MicroAI)

==== 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

'''Version:''' 1.0.4

'''Difficulty:''' Normal

'''Style:''' Skirmish

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

'''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.

==== 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

'''Version:''' 1.0.1

'''Difficulty:''' Easy

'''Style:''' Skirmish

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

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

'''Note:''' Easy difficulty applies to easy and normal settings, hard is a considerable step up in difficulty.

==== 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)

'''Version:''' 1.5.2

'''Difficulty:''' Normal

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

'''Faction:''' Default Era

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

'''Wiki:''' [[Saving_Elensefar]]

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

==== Secrets of the Ancients ====

''From the Journal of Ardonna of Tarrynth:''

''It's unfair that we humans must die after so few years. Though this is the natural order, we need not embrace it! The lords on the Green Isle knew how to live forever. Pursuit of that knowledge was declared illegal by King Haldric I, but I believe it is worth the risk: If I can rediscover the secrets of the ancients, not only will I cheat death, I will become a hero to the whole continent!''

'''Author:''' beetlenaut

'''Status:''' Completed

'''Length:''' 18 playable scenarios + 3 story only

'''Version:''' 1.1.1

'''Difficulty:''' Hard

'''Style:''' Skirmish

'''Faction/Era:''' Undead/Default

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

'''Walkthrough:''' [[Secrets of the Ancients Walkthrough]]

==== 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

'''Version:''' 3.0.1

'''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.

==== Soldier of Wesnoth ====

''697 YW. More than two decades after King Konrad II died leaving no heir, three noble Houses vie for the control of the kingdom, which, still feeling the damages of Mal-Ravanal's invasion, sees its glory and power slowly fade away. Meanwhile, in the southern province of Kerlath, a young peasant called Addraryn sets out to join Weldyn's Army, in order to be able to marry the fair Elywen. However, his travel will suffer some very unexpected twists which will lead him to the main stages of the Second Civil War. Journey across Wesnoth, witness its decadence, meet old heroes and save the kingdom from the enemies within and from the formidable Lion of the Desert...''

'''Author:''' revansurik

'''Status:''' Completed

'''Length:''' 31 scenarios

'''Version:''' 2.0.0

'''Difficulty:''' Normal

'''Style:''' Skirmish

'''Faction/Era:''' Default+Khalifate+Custom Units

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

==== A Song of Fire (The Dragon Trilogy, Part I) ====

''''''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

'''Version:''' 0.5.8

'''Difficulty:''' Hard

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

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

'''Walkthrough:''' [[A Song of Fire Walkthrough]]

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

==== Stormtrooper ====

''A story of a freshly recruited, cowardly Stormtrooper trying to make his name in the Land of Close Combat. (don't ask what it means, you don't have to know to play and enjoy it)''

'''Author:''' Szturmowiec

'''Status:''' Complete

'''Length:''' 5 scenarios

'''Version:''' 0.5beta

'''Difficulty:''' Hard (balancing issues may occur)

'''Style:''' Skirmish, some battles are hard to tell (may be a bit too big to call it a skirmish, but still not very big), one big battle

'''Faction/Era:''' Default

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

==== Swamp Witch's Curse ====

''A Faerie tale from the World of Four Moons.''

''In the tradition of Evil Sorceress's, a witch from the jungle made a surprise visit at the presentation of a sultans daughter. Promptly declaring the girl to be the future bride for her son she lays a curse that will harm any other man which approaches her. The girl grew up wild and somewhat bitter. Now many years later, word arrives of a merchant lord who knows a way to break the curse but in exchange he wants to marry her and receive a large dowry.''

'''Author:''' Velensk

'''Status:''' Complete

'''Length:''' 9 scenarios

'''Version:''' 1.0

'''Difficulty:''' Expert

'''Style:''' Skirmish

'''Faction:''' Era of Four Moons, Freemen

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

==== Sven's Adventure ====

''A young adventurer's quest to retrieve the fabled, and dangerous, Spellbook of Death.''

'''Author:''' kpearce

'''Status:''' Complete

'''Length:''' 19 scenarios

'''Version:''' 0.1.1

'''Difficulty:''' Normal

'''Style:''' RPG, Dungeon, Boss Battle

'''Faction/Era:''' Default (mixed factions)

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

==== 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

'''Version:''' 1.1.2

'''Difficulty:''' Hard

'''Style:''' Skirmish

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

'''[http://units.wesnoth.org/1.10/Talentless_Mage/en_US/Talentless%20Mage.html Custom Units]'''

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

'''[http://wiki.wesnoth.org/Guide_to_UMC_Campaigns/Players_Reviews#Talentless_Mage Players’ Review(s)]'''

==== The Ravagers====

''"The Ravagers" is a tale of pure revenge. A tale of justice served cold, told in a flashback-style point-of-view narrative, by a ranger in the Inn at Weldyn.
The campaign includes many new exciting gameplay features, fun mechanics, hundreds of custom units, and many more.''

'''Author:''' WhiteWolf

'''Status:''' Finished

'''Length:''' 25 playable scenarios + 2 scene scenarios

'''Version:''' 1.0.13, see history on forum, requiring Wesnoth 1.12.x

'''Requirements:''' Akladian Music Pack, Underness Music Pack

'''Difficulty:''' Intermediate

'''Style:''' Skirmish + RPG / Flashback narrative

'''Faction/Era:''' Humans, Elves, Ravagers(dark humans)

'''[https://units.wesnoth.org/1.12/The_Ravagers/en_US/The_Ravagers.html Custom Units]'''

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

==== The Tale 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:''' 5 scenarios

'''Version:''' 0.10.2

'''Difficulty:''' Normal

'''Style:''' Skirmish

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

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

'''Walkthrough''' There is a video-walkthrough by the campaign maintainer that begins here: https://www.youtube.com/watch?v=dGM1bjImvkI&list=PLZorLYWvUD7VIhaXxKwzO8iQANlp_TaF0

'''Note:''' As of August 2014, all previous issues raised about this campaign have been addressed. If you've not played this campaign since 1.4 or 1.10, in this humble maintainers opinion, it's worth another go.

==== 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

'''Status:''' Complete

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

'''Version:''' 0.9

'''Difficulty:''' Easy

'''Style:''' Skirmish

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

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

==== 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

'''Version:''' 1.7.1

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

'''Style''': Skirmish, Dungeon

'''Era:''' Era of Magic

'''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(s)]'''

==== 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 dialogue-only

'''Version:''' 1.0.2

'''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]'''

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

==== War of the Jewel (The Dragon Trilogy, Part II)====

'''''Part IV: City of the Sun''' - Centuries have passed since the refugees of the Last War, led by Myra of Hiera'Shirsha and the Exodus Heroes, have established a new city for themselves in the faraway Netjer-Ta, the golden Maat'Kare; although they are constantly combatting foes who threaten to conquer them, the Maat'Karians have experienced times of relative comfort. However, this age of peace is soon to end, when the ancient evil that nearly destroyed their ancestors reappears at the very heart of their civilization, attracting upon itself the greedy eyes of darkly neighbours... And, in this brewing storm, the young Akhen Wadjet, Myra's last heir, will be forced to overcome his fears and doubts to protect the legacy his ancestor gave her own life for...''

'''Author:''' revansurik

'''Status:''' Complete

'''Length:''' 38 scenarios + epilogue

'''Version:''' 0.2.2

'''Difficulty:''' Normal

'''Style:''' Skirmish/Large Battle

'''Faction/Era:''' War of Legends+Custom factions (Maat'Karians, Wargs, Chomi, Deshra, Washraha, Woodlanders, Aeserians)

'''Forum:''' http://forums.wesnoth.org/viewtopic.php?f=8&t=39618&p=562944#p562944

==== 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

'''Version:''' 1.0.0

'''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]'''

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

=== Eras ===

[[Category:Campaigns|*]]
[[Category:Eras|*]]

==== Era of Four Moons ====

An era based of the cultures in fictional world Ialfa. There are a core set of four which have had the blunt of the balancing effort put into them, and an additional four which represent other parts of the world and are not complete or balanced.

'''Author:''' Velensk

'''Status:'''

'''Faction Descriptions:''' The four core factions are:

-The Highlanders (Chaotic/Neutral): A nomadic people living along the savanna and steppes. Units generally have high hp and low resistances and good movement and defense in the hills. Features cheap mobile infantry and recruitable level 2 Elephants that act as a living battering ram.

-The Imperialists (Lawful): A massive oligarchy centered around an emperor and his house. Most units do well in the open and not well in forests. Can create durable positions and hold open ground exceptionally well but most units do not inflict a lot of damage. Features units with 50% defense in the open and suicidal units.

-The Sea States (Lawful/Neutral): A collation of small mercantile city states. Can field a variety of versatile units with no exceptional strengths or weaknesses.

-The Darklanders (Chaotic): A society of tribal Jungle people. Units generally have low hitpoints but good defense and movement in forests. Features very efficient melee power and access to both slows and berserk.

The other factions are:

-The Dalefolk (Neutral): A cluster of rural settlements known for it's magicians and inventors: Most units do exceptionally well in mountains. Features some good defensive units, the shapeshifter (who changes form depending on terrain), and a powerful melee magician.

-The Pygmies (Liminal): A strange race of tiny jungle dwellers shrouded in mystery: Most units do very well in forests and swamps and are very dodgy at the cost of experience points. Also, most units will heal themselves slightly over time. Feature effective mobile level 0s and many powerful support units.

-The Whites (Chaotic/Neutral): Barbarians from another continent: Units are generally mobile and high on hp but have low defenses when not in rough terrain. Feature powerful magicians and a steadfast berserker.

-The Freemen (Lawful): A society of desert dwellers split between the city dwellers and the nomads. Units tend to be durable and adept in deserts and hills and not as good in forests. Features units with stun and recruitable level 2 rocs.

'''Version: ''' 0.5.1

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

==== War of Legends ====

'''Description:''' An era based on the continent of Arkenova as well as other parts of Irdya.

'''Author:''' Tahsin Jahin Khalid (Lord-Knyghtmare)

'''Maintainer:''' Tahsin Jahin Khalid (Lord-Knyghtmare)

'''Status:''' Finished

'''Factions:'''

# Aragwaithi
# Windsong
# Human Alliance
# Orcish Union
# Southerners
# Outlaws
# Elementals
# Undead
# Drakes
# Dark Legion
# Sylvans
# Minotaurs
# Vampires

'''Version:''' 1.1.5.1

'''Forum:''' [http://forums.wesnoth.org/viewtopic.php?f=19&t=30087 Development and Feedback Thread]

==== Era of Magic(EoMa) ====

'''Description:''' Aiming at using the whole potential of Battle of Wesnoth's graphic engine, the Era of Magic is considered to have a most amazing special effects and attack animations in the BfW game. There are 8 playable factions with fully animated units and tons of special effects contained in the era, and the stories of them are told in the campaign "To Lands Unknown".

'''Author:''' Inferno8

'''Maintainer:''' Inferno8

'''Status:''' Finished; Available on 1.10 and 1.12 add-on server

'''Faction Descriptions:'''

Sky Kingdom - powerful magi of all kinds. Their knowledge allows them to cast amazing spells and summon creatures like unstopable Golems or mysterious Mus. Masters of Elements and Gurus are one of the most powerful human beings in the Era.

Al-Kamija - these proud people are good warriors and spell casters of the desert. They use magical circles and scrolls to summon amazing creatures like Jinns or elementals from other dimension called Abyss. These creatures can't be poisoned, which is a great advantage.
(The campaign "To Lands Unknown" is mainly about the story of this faction)

Tharis - fearsome Tharis faction is very dangerous especially at night. Cruel people of Tharis with their black magic and dreadful monsters like Hydra can demolish everything standing on their way. Being so powerful in attack, Tharis have no healer, so they need to push forward at all costs.

Kharos - this strange name is the name of a beautiful country ruled by prophets of light. These peaceful people are masters of defense and support. Their formations of healers and Shielders assisted by Silver Warriors, who can teleport between friendly villages, are very hard to destroy.

Barbarians - the best in hand-to-hand combat. This multi-cultural society divided into Goblins, Orcs, Cyclops and Trolls with their own advantages and disadvantages can be hard opponent, but separately they are very weak.

Runemasters - these Dwarves use runic magic and equipment and are well known of their protection against magic. The Runemasters create steam machines like Gyrocopters, Robots and even mighty Mechanical Dragons. Units from this faction are very resistant but slow.

Dark Blood Alliance - this faction is composed of agile lizards, giant frogs, wyverns swallowing enemies and salamanders, which have developed to perfection the art of disguise. At the head of the community stand shamans known for their water magic, which is used in the fight as well as in healing.

Destroyers - a terrifying undead creations consisting of civilizations long gone...

'''Version:''' 1.1.1 (February 18th, 2015)

'''Forum:''' [http://forums.wesnoth.org/viewtopic.php?f=19&t=20039 Development and Feedback Thread]

==== Ageless Era ====

'''Description:''' Ageless Era is a compilation of the most popular eras and factions on the add-on server. It is more an era pack than an era.

'''Author:''' mnewton1, Ravana and various

'''Maintainer:''' Ravana

'''Status:''' Finished; Available on 1.6, 1.8, 1.10 and 1.12 add-on server. Only maintained on 1.12 server

'''Unit Tree:''' [http://units.wesnoth.org/1.12/Ageless_Era/en_US/Ageless%20Era.html Ageless Unit Tree]

'''Factions List:''' Currently there are 91 factions in the era:

Default: Loyalist, Rebels, Northerners, Undead, Knalgan Alliance, Drakes, Khalifate

Extended Era: Loyalist, Sylvans, Dwarves, Outlaws, Northerners, Undead, Chaos, Dark Elves

Archaic Era: Khthon, Phantoms, Despair, Primeval, South-Seas, Ukians, Northern Orcs

Era of Four Moons: Highlanders, Imperialists, Sea States, Darklanders, Dalefolk, Freemen, Pygmies, Whites

Era of the Future: Welkin, Brungar

BEEM: Anakes, Calidonians, Wood Warriors

Custom Factions: Yokai, Dark Legion, Desert Elves, Steelhive, Frozen

Era of Myths: Celestials, Devlings, Elementals, Therians, Vampires, The Warg, Windsong

Feudal Era: Aragwaithi, Ceresians, Clockwork Dwarves, High Elves, Orcish Khaganates

Imperial Era: Arendians, Cavernei, Issaelfr, Lavinian Legion, Marauders, Orcei Gladiatores, Sidhe

Era of Strife: Eventide, Triththa, Free Saurians, Eltireans, Minotaurs

Era of Magic: Barbarians, Dark Blood Alliance, Sky Kingdom, Kharos, Runemasters, Al-Kamija, Tharis, Destroyers

Mercenaries Era: Highlanders, Enchanters, Avians, Slavers, Mercenaries, Equestrians, Emperor's Guard, Oracles, Holy Order, The Cult, Fanatics, Tribalists, Hive, Infernai, Refugees, Blight

'''Version:''' 4.14 (August 21, 2015)

'''Git:''' [https://github.com/ProditorMagnus/Ageless-for-1-11 Ageless-for-1-11]

'''Forum:''' [http://forums.wesnoth.org/viewtopic.php?f=19&t=25274 Development and Feedback Thread]

==== Imperial Era (IE) ====

'''Description:''' One of the oldest maintained user eras, the Imperial Era brings together seven different factions in a completely re-imagined setting, the world of Orbivm, a very lethal world indeed. The era contains both mainline and development versions of each faction and can be used to play five campaigns, each featuring a different race.

'''Author:''' Orbivm Project (but really Turin)

'''Maintainer:''' UnwiseOwl

'''Status:''' Playable. Available on 1.12 as "Imperial Era" and 1.10 as "Imperial Era Fixed"

'''Faction Descriptions:'''

# Lavinian Legion - Based on the Roman Legion, the Lavinians have strong, versatile melee units in the legionaries and a range of support classes sourced from amongst the Lavinian population and various subjugated races. The legion are strong in the plains but weak when fighting in forested areas. The Lavinians are featured in "Fall of Silvium".
# Sidhe - The Sidhe are a group of forest-dwelling elves whose focus is stealth and fleet movement. Their mages are able to channel the lightning itself, and their various other units move almost as fast. The Sidhe feature in "Tale of Vaniyera".
# Marauders - Based on the Germanic peoples that eventually conquered Rome (hint, hint), the Marauders are equally as at home in the hills, forests and swamps of their homeland. Their hard-hitting melee units are practicalyl unstoppable during the night-time. The Marauders are the stars of the "Alfhelm the Wise" campaign.
# Orcei Gentorum - The orcs have been captured gladiators slaving away in the Lavinian arenas for generations.The life of an orc in Orbivm is harsh and brutal, just like the orcs themselves. The tale of the uprising of one such group of Orcs is told in "Up from Slavery".
# Cavernei - The Cavernei are a dwarvish race with similarities to the mainline Knalgans, but with a greater emphasis on the military uses of runesmithing. They get a campaign too, in "Gali's Contract"
# Issaelfr - The frost elves live on the fringes of the habitable lands of Evrosia, the main continent of Orbivm, and have become inured to difficult conditions and tuned in to their Fae natures. They don't have a campaign yet, but you could always write one.
# Arendians - The Arendians are horse-lords living on the Western steppes of Evrosia. A life of constant battle has developed a military-focused society where warriors are trained from a young age. They used to have a campaign, but it fell into disrepair a very long time ago.

'''Version:''' 0.22.1 (July, 2015)

'''Wiki:''' [[Orbivm]]

'''Forum:''' [http://forums.wesnoth.org/viewtopic.php?t=37920 Development and Feedback Thread]

== Additional infos ==
See also:
* [[Player_UMC_Reviews|Player UMC Reviews]]
* [[:Category:User-made Campaigns - Walkthroughs|Walkthroughs for user-made campaigns]]
* [[Guide_to_UMC_Content/1.10|Guide to user-made content (UMC) for Battle for Wesnoth 1.10]]
* [http://forums.wesnoth.org/viewtopic.php?f=8&t=37476 forum thread] for this page
* [http://forums.wesnoth.org/viewtopic.php?f=8&t=36733 non-available content]
* [http://addons.wesnoth.org the addon server]

RussianTranslation:TwoBrothers

2017-08-11T11:50:25Z

Holius: title levels

== Перевод кампании "История двух братьев" (A Tale Of Two Brothers) ==
=== Имена собственные ===

==== Имена персонажей ====

; Bjarn : Бьярн [+] переведено
; Arne : Арне [+] переведено
; Erik : Эрик [+] переведено
; Heine : Хайне [+] переведено
; Magnus : Магнус [+] переведено
; Nil-Galion : Нил-Галион [+] переведено
; Muff Toras : Муфф Торас [+] переведено
; Brena : Брена [+] переведено

=== Сценарии ===

==== Rooting Out A Mage ====

Выдворение мага

# название [*] вычитывается
# диалоги [?] подстрочник

==== The Chase ====

Погоня

# название [*] вычитывается
# диалоги [?] подстрочник

[[Category:Russian]]