The Battle for Wesnoth Wiki - User contributions [en]

Micro AIs

2026-08-01T21:48:23Z

Dalas120: Added documentation for the Regroup Micro AI

== A Few General Words about Micro AIs ==

* Micro AIs allow Wesnoth campaign and scenario authors to add new AI functionality without the need for any AI programming. They bring new specialized behavior to Wesnoth that cannot be achieved, at least not easily, by adjusting default AI parameters (such as those described at [[AiWML]]) or with WML code.

* A Micro AI is activated and configured (or deleted) via the [micro_ai] tag placed in an event, requiring only a few lines of WML code. {{DevFeature1.15|?}} Starting in 1.16 the [micro_ai] tag may also be used in [side][ai] or [unit][ai]. These are both shorthands for placing it in the prestart event with "action=add", side set to the side, and in the case of [unit][ai], a [filter] tag set to limit the Micro AI to that one unit.

* '''Before Wesnoth 1.13.6''', the Micro AI behavior was inconsistent when it came to '''hidden enemies and petrified units'''. Some Micro AIs ignored those, while others did not. In some case there was even a potential for AI errors when an AI unit ran into hidden or petrified enemies. As of 1.13.6, this has all been fixed. The Micro AIs now correctly and consistently ignore hidden units and treat petrified units as blocking the hex they are on but having no effect otherwise, in the same way as the default AI does. '''Important notes:'''
** It is not possible to re-include hidden/petrified units via the Standard Unit Filters (SUFs) used by some of the Micro AIs. In fact, if this is attempted, the filters will generally not match any unit.
*** This only applies to SUFs which go directly into the [micro_ai] tag. Any SUF that is a sub-tag of another filter (for example, of a Standard Location Filter) is taken literally and returns all units matching the filter. If hidden or petrified units are to be excluded from such a sub-filter, that needs to be specified directly in that filter.
** We also note that, because all the Micro AIs are written in Lua, it is possible to [[Micro_AIs#Using_Development_.281.13.29_Version_Micro_AIs_in_your_Stable_.281.12.29_Version_Add-on|move a Micro AI's code into one's add-on]] and modify it to whatever scenario-specific behavior is desired (this does not only apply to hidden/petrified units, but to all behavior). Setting up general Micro AI behavior that works in every possible setting is not feasible, but adapting it to work (only) in the specific setting of a given scenario is often quite simple. If you do not know how to do this, please post a message on the Wesnoth forums and we will be happy to help you with it.

* The '''[[AiWML#List_of_AI_Aspects|default AI aspects]] are, for the most part, not taken into account by the Micro AIs'''. For example, unless noted otherwise, specifying a value for ''aggression'' does not change the MAI behavior. The exception is the ''[avoid]'' tag which is taken into account by many Micro AIs (except those for which it would interfere with the Micro AI behavior or those that already use a a [[StandardLocationFilter|Standard Location Filter]] that can be used for the same purpose). This is a feature of the Micro AIs, not a bug. If you feel that a certain default AI aspect should also apply to a Micro AI, please let us know in the [http://forums.wesnoth.org/viewtopic.php?f=10&t=39456 Micro AIs Feedback thread].

* '''Before Wesnoth 1.13.7''', the Micro AIs did not all work reliably when the '''AI side is under shroud''' and it may have been necessary to turn shroud off for the side when using a Micro AI. {{DevFeature1.13|7}} The Micro AIs now all work for sides under shroud. They do this by disregarding shroud for terrain purposes when path finding, consistent with default Wesnoth AI behavior, while still ignoring hidden units (including those hidden under shroud) correctly.

* Most Micro AIs in their default setting apply to all units of a side, although many of them provide parameters for filtering the units that should be affected by the new behavior. If the Micro AI is applied only to part of the units of a side, the other units follow the default Wesnoth AI behavior.

* Micro AIs are available in mainline since Wesnoth 1.11/1.12.

== Micro AI Test and Demo Scenarios ==

All Micro AIs described here can be checked out in a number of test and demo scenarios. The easiest way to access the test scenarios is by assigning a hotkey to "Start Test Scenario" in the preferences (as of Wesnoth 1.13.8). Then, simply press the hotkey in the titlescreen and select the desired scenario from the list (e.g. 'micro_ai_test' for the overall "switchboard scenario").

Test scenarios can also be accessed from the command line by typing
path/wesnoth-executable -t micro_ai_test
or (depending on your system and Wesnoth version)
path/wesnoth-executable -tmicro_ai_test
This starts up a "switchboard scenario" in which you can select the Micro AI demonstration scenario you want to check out. Here, ''path/wesnoth-executable'' needs to be replaced by whatever the path and filename of the Wesnoth executable is on your system.

== Setting up a Micro AI ==

Setting up a Micro AI requires only one simple step:
==== Activating and configuring (or deleting) a Micro AI ====

Micro AIs are activated, deleted and configured using the [micro_ai] tag. This tag needs to be placed in [[ActionWML]], that is, in an event, a menu option or the like. As an example, the following code activates the healer_support Micro AI in its default configuration for Side 2 from the beginning of the scenario:
[event]
name=prestart

# Configure the healer support micro AI
[micro_ai]
side=2
ai_type=healer_support
action=add
[/micro_ai]
[/event]
'''Keys required for all Micro AIs:'''
All [micro_ai] tags must contain the following three required keys:
* '''side''': The side for which the Micro AI is to be added, changed or deleted. {{DevFeature1.17|0}} this can be a list of sides.
* '''ai_type''': The type of Micro AI to be added, changed or deleted. See the following sections for allowed values.
* '''action''' (string): The action to take concerning the Micro AI. The following values are allowed:
** ''add'': Add a Micro AI to a side.
** ''change'': Change the configuration of an existing Micro AI. Note that this does not only change the specific parameters provided in the tag, but it replaces the entire existing Micro AI by a new version with the new (and only the new) configuration. It is therefore equivalent to using first the ''delete'' and then the ''add'' action.
** ''delete'': Delete an existing Micro AI from a side.

'''Keys required under certain circumstances:'''
* '''ca_id''': (string) If several MAIs of the same type are used for the same side and one or several of these are to be changed or deleted during a scenario, this key needs to be included so that the [micro_ai] tag knows which of them needs to be changed/deleted. The same is also true if a Micro AI is changed more than once during a scenario. We therefore '''strongly recommend always setting ''ca_id''''' for MAIs which are, or might be, changed or deleted during a scenario.
** '''Note:''' The id(s)/name(s) actually assigned to the CA(s) of the MAI by the engine might be different from the parameter passed here. It is, however, sufficient to use this ca_id with the [micro_ai] tag add/delete/change actions to identify the MAI uniquely. (In other words: you don't have to worry about this if you always use the [micro_ai] tag, but might have to figure out the actual name(s) of the CA(s) if you want to delete or change them manually.)
* Other keys may also be required depending on the Micro AI. In additional, a number of optional keys may be available to configure the AI behavior. See the sections on the individual Micro AIs for details.

'''Required keys for deleting a Micro AI:'''

Only a subset of the keys required for setting up a Micro AI are needed when deleting it. '''side''', '''ai_type''' and '''action'''=delete always need to be provided. '''ca_id''' needs to be given if it was provided when adding the Micro AI (see above for when this is needed).

'''Notes:'''
* The ''add'' and ''change'' actions ignore all keys that do not apply to the respective Micro AI type. The ''delete'' action ignores all keys other than the required keys listed above.

* Some of the Micro AIs use and/or modify default AI components (candidate actions or aspects) when they are added, or reset these components to their default values when they are deleted. Thus, if you have modified the AI yourself using the default CAs or aspects, some of these modifications might be affected, or might be interfering with the Micro AI. The sections below indicate whether a Micro AI modifies any default AI components.

===Combining Different Micro AI Types for the Same Side===

No extra steps need to be taken when combining different Micro AIs on the same side. Simply set up the [micro_ai] tags for all AIs you want to use.

'''Notes:'''
* While it is ''technically'' possible to combine any number of Micro AIs, this does not mean that all Micro AIs work together in practice. Some are not compatible because they control units in contradictory ways.
* Not all combinations that ''should'' work have been tested yet. If you find a combination that you believe should work but doesn't, [http://forums.wesnoth.org/viewtopic.php?f=10&t=39456 please let us know] and we will see if that can be fixed.
* The candidate action score almost certainly has to be set (using the ca_score= key) for one or several of the MAIs if several of them are used on the same side.

== Animals Micro AIs ==
=== General Comments on the Animal Micro AIs ===

The Animals Micro AIs are meant to simulate the behaviors of certain types of animals. They are, however, set up so that they can be used with arbitrary unit types and might be applicable in quite diverse situations. The AIs nevertheless remain named after the animals for which they were written originally, so that they are (to some extent) descriptive of their behavior.

Brief descriptions of the AI behaviors are given in the following subsections. To get a better feeling for their behavior, check out the "Animals", "Swarm", "Wolves" and "Dragon" scenarios from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]. Note that some of the animal AIs are designed for animal types that do not exist in mainline. In the test scenario, other animal types are therefore substituted for them.

=== Animals AI: Wolves (ai_type=wolves) ===

The Wolves Micro AI organizes all "wolf" units (predators) of the side to hunt in a single pack. They actively chase after the closest prey and try to corner it (not always super successfully), but are easily distracted by other enemy units coming into attack range, to the point where the pack might split up. The wolves can, however, be told to attack only prey units as well as to try to avoid other types of units (such as larger predators). When no prey is left, the wolves wander randomly.

This AI works best for a small number of predators (2 - 5) and sparse prey. Also, the predators should be put on the map in a pack, that is, reasonably close to each other. For a demonstration of the Wolves AI behavior, check out the "Animals" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Note that another wolves AI exists, called [[Micro_AIs#Animals_AI:_Multi-pack_Wolves_.28ai_type.3Dwolves_multipacks.29|Multipack Wolves]], which distributes the wolves of a side into several packs, rather than all of them into one single pack as it is done here.

Enable the Wolves Micro AI by using
ai_type=wolves
in the [micro_ai] tag together with the following keys:

'''Required keys:'''

* '''[filter]''': A [[StandardUnitFilter|Standard Unit Filter]] selecting the predator units. The filter automatically includes the side= key set to the AI side.
* '''[filter_second]''': A [[StandardUnitFilter|Standard Unit Filter]] selecting the prey units. The filter automatically includes a [[StandardSideFilter|Standard Side Filter]] set to all enemies of the AI side.

'''Optional keys:'''

* '''attack_only_prey'''=no: In the default configuration, the wolves attack all enemy units in attack range. If this key is set to 'yes', they only attack prey units.
* '''avoid_type''': Comma-separated list of unit types (on enemy sides) which the wolves try to avoid. They try to stay out of these units' way as much as possible when moving around (except when they are moving in to attack another enemy unit) and never attack them.
* '''ca_score'''=90000: (non-negative integer) The evaluation score of the candidate actions controlling this Micro AI. By default, it is set to 90,000, which is lower than the default combat CA, but higher than most other default CAs which move units. It can be changed by setting this parameter but in most cases this will not make sense. Note that the Wolves AI consists of 2 CAs with scores ranging from <tt>ca_score-1</tt> to <tt>ca_score</tt>.

'''Notes on default (RCA) AI aspects:'''
* If ''attack_only_prey'' or ''avoid_type'' are set, the Wolves Micro AI modifies the [[AiWML#Filtering_Combat_with_the_attacks_Aspect|attacks aspect]].
* Attacks by the wolves are left to the default (RCA) AI, meaning that the value of ''aggression'' has an influence on the behavior.
*'''[avoid]''': The standard RCA AI aspect used to define locations that should be avoided by the AI is taken into account. Note: as attacks by the wolves are left to the default AI, there is no separate ''[avoid]'' tag for this Micro AI in order to prevent inconsistencies.

Here's an example of a wolves [micro_ai] tag usage from the "Animals" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=6
ai_type=wolves
action=add

[filter]
type=Wolf
[/filter]
[filter_second]
type=Vampire Bat
[/filter_second]
avoid_type=Yeti,Giant Spider,Ghast,Footpad
[/micro_ai]

=== Animals AI: Multi-pack Wolves (ai_type=wolves_multipacks) ===

The Multi-pack Wolves Micro AI is different from the [[Micro_AIs#Animals_AI:_Wolves_.28ai_type.3Dwolves.29|Wolves Micro AI]] in that there can be an arbitrary number of wolf packs, with the pack size being a free parameter. At the beginning of the scenario, close wolves are grouped into packs in a semi-methodical way. If the wolves are put on the map in distinct groups of close wolves of the correct number, they will be joined into packs matching these groups. If, on the other hand, they are spread out all over the map, the method of assigning them to packs is semi-random.

Wolves of the same pack begin by joining each other on the map. After that, they stay together until only one wolf is left, which then tries to join up with an incomplete pack or with other single wolves. Individual wolves entering the map during the scenario behave in that way as well.

A second difference to the other Wolves AI is that wolves do not actively hunt here. For the most part they just wander (often long distance). However, the pack ferociously (and without regard for its own health) attacks any enemy units that come into range, as long as that does not mean separating the pack by more than a few hexes. Staying together, or joining with a new wolf assigned to the pack, is the only thing that takes priority over satisfying the wolves' thirst for blood.

For a demonstration of the Multi-pack Wolves AI behavior, check out the "Wolves" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Enable the Multi-pack Wolves Micro AI by using
ai_type=wolves_multipacks
in the [micro_ai] tag together with the following keys:

'''Required keys:'''

There are no required keys

'''Optional keys:'''

* '''[avoid]''': {{DevFeature1.15|0}} A [[StandardLocationFilter|Standard Location Filter]] for the locations which the AI units should avoid. If it is not given, the existence of the default (RCA) AI's [avoid] tag is checked (and used if it exists).
* '''ca_score'''=300000: (non-negative integer) The evaluation score of the candidate actions controlling this Micro AI. By default, it is set to 300,000, which is higher than any of the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|RCA AI candidate actions]]. By setting it, for example, to 170,000, we can have it be executed after the default recruitment CA, but before most of the other default CAs. Note that the Multi-pack Wolves AI consists of 2 CAs with scores ranging from <tt>ca_score-1</tt> to <tt>ca_score</tt>.
* '''pack_size'''=3: (integer) The size of the packs.
* '''show_pack_number'''=no: If set to "yes", the wolves' pack numbers will be shown below them. Note that this means that the pack number of a wolf killed in an attack will remain as a label on the map. This behavior is intentional to help UMC authors note where units might have made suicidal mistakes.
* '''type'''=Wolf: Comma-separated list of the unit types which the AI controls. The default value is "Wolf".

'''Standard RCA AI aspects respected by this Micro AI:'''
*'''[avoid]''': {{DevFeature1.15|0}} The standard RCA AI aspect used to define locations that should be avoided by the AI. See above (under 'optional keys') for details.

Here's an example of a wolves_multipacks [micro_ai] tag usage from the "Wolves" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=2
ai_type=wolves_multipacks
action=add

show_pack_number=yes
pack_size=4
[/micro_ai]

=== Animals AI: Big Animals (ai_type=big_animals) ===

The Big Animals Micro AI is a simulation of large predators that wander and hunt alone, such as Bears, Giant Spiders or Yetis. For the most part, these just wander on the terrain that's been defined for them, but they attack enemy units if those happen to come into range. The AI can be set up so that the Big Animals stay out of the way of other units (such as other large predators), in which case they only attack those if cornered or if they run into them accidentally (such as ambushers).

For a demonstration of the Big Animals AI behavior, check out the "Animals" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Enable the Big Animals Micro AI by using
ai_type=big_animals
in the [micro_ai] tag together with the following keys:

'''Required keys:'''

* '''[filter]''': A [[StandardUnitFilter|Standard Unit Filter]] selecting the animals to which this AI is applied. The filter automatically includes the side= key set to the AI side.

'''Optional keys:'''

* '''ca_score'''=300000: (non-negative integer) The evaluation score of the candidate action controlling this Micro AI. By default, it is set to 300,000, which is higher than any of the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|RCA AI candidate actions]]. By setting it, for example, to 170,000, we can have it be executed after the default recruitment CA, but before most of the other default CAs.
* '''[filter_location]''': The big animals often go for long distance (multi-turn) journeys. This tag is a [[StandardLocationFilter|Standard Location Filter]] describing the terrain from which the next goal is chosen. The default is all terrain on the map.
* '''[filter_location_wander]''': The terrain on which the big animals will end their moves. This is a [[StandardLocationFilter|Standard Location Filter]]. The default is all terrain on the map.
* '''[avoid_unit]''': A [[StandardUnitFilter|Standard Unit Filter]] describing all enemy units that the big animals will avoid. The filter automatically includes a [[StandardSideFilter|Standard Side Filter]] set to all enemies of the AI side.

Here's an example of big_animals [micro_ai] tag usage from the "Animals" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=3
ai_type=big_animals
action=add

[filter]
type=Ghast
[/filter]
[avoid_unit]
type=Yeti,Giant Spider,Ghast,Footpad
[/avoid_unit]
[filter_location]
x,y=1-40,1-18
[/filter_location]
[/micro_ai]

=== Animals AI: Forest Animals (ai_type=forest_animals) ===

The Forest Animals Micro AI simulates a number of different animal behaviors that one might find in a forest, namely animals behaving like deer, rabbits and families of tuskers. In the following, we will refer to those animals by these types, even though the actual unit types can be selected freely. They behave as follows:
* Each deer wanders randomly on (selectable) terrain, except when enemies get in its (the deer's) maximum movement range, in which case it flees to the farthest point it can reach.
* Tuskers exhibit the same behavior as deer, except when an enemy is next to one of the tusklets. This enemy is attacked unconditionally by the tuskers trying to protect their young.
* Tusklets blindly follow the closest adult tusker, except when there is no tusker left, in which case they behave the same as deer.
* Rabbits also wander randomly, but in addition disappear into their holes (if any are within reach) when enemies are close. They reappear out of their holes at the beginning of the turn, if it is safe.

For a demonstration of the Forest Animals AI behavior, check out the "Animals" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Enable the Forest Animals Micro AI by using
ai_type=forest_animals
in the [micro_ai] tag together with the following keys:

'''Required keys:'''

There are no required keys

'''Optional keys:'''

* '''ca_score'''=300000: (non-negative integer) The evaluation score of the candidate actions controlling this Micro AI. By default, it is set to 300,000, which is higher than any of the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|RCA AI candidate actions]]. By setting it, for example, to 170,000, we can have it be executed after the default recruitment CA, but before most of the other default CAs. Note that the Forest Animals AI consists of 4 CAs with scores ranging from <tt>ca_score-3</tt> to <tt>ca_score</tt>.
* '''rabbit_type, tusker_type, tusklet_type, deer_type''': Comma-separated lists of the unit types behaving as the respective animals. If any of these parameters are not set, those types of animal behavior are skipped by the AI.
* '''[filter_location]''': A [[StandardLocationFilter|Standard Location Filter]] describing the terrain on which the forest animals wander when they are not threatened by enemies.
* '''rabbit_number'''=6: (integer) The number of rabbits for the AI to have on the map simultaneously. The AI puts the missing number of rabbits onto the map at the beginning of the AI's turn (when the rabbits come out of their holes).
* '''rabbit_enemy_distance'''=3: (number) Rabbits won't spawn in holes that aren't more than this distance away from all enemies.
* '''rabbit_hole_img''': Rabbit holes are marked by items on the map. If this parameter is set, it must be the file name of the item image. If it is not set, all items on the map are treated as rabbit holes.
** {{DevFeature1.14|10}} Items used for rabbit holes on the map border used to produce an error. Placing them on the map border therefore needed to be avoided on the scenario setup side. They are now automatically excluded from consideration by the AI code.

Here's an example of forest_animals [micro_ai] tag usage from the "Animals" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=2
ai_type=forest_animals
action=add

deer_type=Vampire Bat
rabbit_type=Giant Rat
tusker_type=Ogre
tusklet_type=Young Ogre
[filter_location]
terrain=*^F*
[/filter_location]
[/micro_ai]

=== Animals AI: Herd and Herders (ai_type=herding) ===

The Herding Micro AI sets up an area on the map where a number of herder units (such as sheep dog) control and protect a herd (such as sheep). For convenience, we simply refer to them as sheep dogs and sheep in the following, even though arbitrary unit types can be selected for either.

Sheep dogs try to keep their sheep safe. This involves keeping them inside the herding area, positioning themselves in between the sheep and approaching enemies, and attacking the enemies if those get too close. If no active herding or protecting move is needed, the dogs go to a random location on the perimeter of the herding area.

Sheep wander aimlessly except when a sheep dog is next to them, in which case they run away from the dog. The dogs exploit this by positioning themselves on the outside of the sheep, if possible. Sheep also run away from approaching enemies.

For a demonstration of the Herding AI behavior, check out the "Animals" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Enable the Herding Micro AI by using
ai_type=herding
in the [micro_ai] tag together with the following keys:

'''Required keys:'''

* '''[filter]''': A [[StandardUnitFilter|Standard Unit Filter]] describing the herder units (e.g. dogs). The filter automatically includes the side= key set to the AI side.
* '''[filter_second]''': A [[StandardUnitFilter|Standard Unit Filter]] describing the herd units (e.g. sheep). The filter automatically includes the side= key set to the AI side.
* '''[filter_location]''': A [[StandardLocationFilter|Standard Location Filter]] describing the terrain forming the perimeter of the herding area. In other words, this is the path the herders (dogs) use to patrol around the outside of the herding area. This must be a set of coordinates ''completely enclosing'' the herding area. Here's an example of setting up a rectangular perimeter:
[filter_location]
x=10-20,10-20,10, ,20
y=11, 21, 11-21,11-21
[/filter_location]
Another possibility is by defining the path by certain terrain on the map (as it is done in the "Animals" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]), in which case the filter can simply look like this:
[filter_location]
terrain=Rb
[/filter_location]
* '''herd_x,herd_y''': The coordinate of one hex (''any'' one hex) inside the herding area. This is needed to define which part of the map is on the ''inside'' of the herding area perimeter defined by [herding_perimeter], and which is the ''outside''. {{DevFeature1.15|0}} '''herd_loc''' can be used instead with a named/special location.

'''Optional keys:'''
* '''attention_distance'''=8: (integer) If an enemy is within this distance of a herd unit, but not as close as ''attack_distance'', the herders try to position themselves in between the enemy and the herd unit.
* '''attack_distance'''=4: (integer) If an enemy is within this distance of a herd animal, the herders attack this enemy.
* '''ca_score'''=300000: (non-negative integer) The evaluation score of the candidate actions controlling this Micro AI. By default, it is set to 300,000, which is higher than any of the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|RCA AI candidate actions]]. By setting it, for example, to 170,000, we can have it be executed after the default recruitment CA, but before most of the other default CAs. Note that the Herding AI consists of 6 CAs with scores ranging from <tt>ca_score-5</tt> to <tt>ca_score</tt>.

Here's an example of a Herding [micro_ai] tag usage from the "Animals" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=7
ai_type=herding
action=add

[filter]
type=Footpad
[/filter]
[filter_second]
type=Troll Whelp
[/filter_second]
herd_x,herd_y=32,28
[filter_location]
terrain=Rb
[/filter_location]
[/micro_ai]

=== Animals AI: Hunter (ai_type=hunter) ===

The Hunter Micro AI leads a unit (or units) through hunt-and-rest cycles. The units wander in a prescribed area of the map, their hunting ground, until an enemy unit comes within range. Note that the units do not actively chase down enemies, but wander randomly through the hunting ground until an enemy is encountered.

If enemies are within range of a hunter unit, the hunter attacks the weakest of them. If a kill is made, it then retreats to its rest location, where it stays for a certain number of turns and until fully healed (whatever happens later).

A few more details:
* If the hunter's way home is entirely blocked on the return (so that there is no possible path), the normal RCA AI takes over its behavior.
* However, if the way is blocked by an enemy unit occupying the rest hex, that enemy will be attacked unconditionally.
* A kill only makes the hunter go home when it is the attacker, not as defender.

For a demonstration of the Hunter AI behavior, check out the "Dragon" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Enable the Hunter Micro AI by using
ai_type=hunter
in the [micro_ai] tag together with the following keys:

'''Required keys:'''

* '''id''' or '''[filter]''': The ID of a unit or a [[StandardUnitFilter|Standard Unit Filter]] selecting the units controlled by this Micro AI.
** One or the other is required
** If both are given, [filter] takes priority over id=
** The AI contains an implicit filter for units on the AI side. Thus, if all AI units are to be selected, an empty [filter] tag can be used.
** If several units match the filter, the order in which they are controlled is not guaranteed. If the order matters, set up several MAIs using the id= key and different values for ca_score=.
* '''home_x,home_y''': The coordinates of the hex to which the hunter returns and rests at after a kill. {{DevFeature1.15|0}} '''home_loc''' can be used instead with a named/special location.

'''Optional keys:'''

* '''ca_score'''=300000: (non-negative integer) The evaluation score of the candidate action controlling this Micro AI. By default, it is set to 300,000, which is higher than any of the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|RCA AI candidate actions]]. By setting it, for example, to 170,000, we can have it be executed after the default recruitment CA, but before most of the other default CAs.
* '''[filter_location]''': A [[StandardLocationFilter|Standard Location Filter]] describing the unit's hunting ground. If this tag is not provided, the hunter uses all of the map.
* '''rest_turns'''=3: (integer) The number of turns the AI stays at home_x,home_y after a kill. It will not leave its home until this number of turns have passed ''and'' it is fully healed.
* '''show_messages'''=no: (boolean) If set to yes, the hunter announces whenever its behavior changes to the next phase. Note that this is meant as debug output for the scenario author. The messages are not translated and are not included in replays (and are only visible to the host in an MP game).

Here's an example of a hunter [micro_ai] tag usage from the "Dragon" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=1
ai_type=hunter
action=add

[filter]
id=Rowck
[/filter]
[filter_location]
x,y=5-30,1-15
[/filter_location]
home_x,home_y=3,15
rest_turns=2

show_messages=yes
[/micro_ai]

=== Animals AI: Swarm (ai_type=swarm) ===

The Swarm Micro AI uses some very simply algorithms to simulate animal swarm behavior. Without adjacent enemies, they simply do a random move, trying to stay together and at a certain distance from enemies. However, if an enemy unit is close to any bat, the swarm scatters. This is particular fun to watch when one places an enemy unit in the middle of the swarm. After being scattered, the swarm members slowly rejoin, but not in a very organized way. Sub-swarms or individual bats might roam around for quite some time before they find their way back. It is also possible that individual bats (or small groups) split off from the larger swarm at times.

For a demonstration of the Swarm AI behavior, check out the "Swarm" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Enable the Swarm Micro AI by using
ai_type=swarm
in the [micro_ai] tag together with the following keys:

'''Required keys:'''

There are no required keys

'''Optional keys:'''

* '''[avoid]''': {{DevFeature1.15|0}} A [[StandardLocationFilter|Standard Location Filter]] for the locations which the AI units should avoid. If it is not given, the existence of the default (RCA) AI's [avoid] tag is checked (and used if it exists).
* '''ca_score'''=300000: (non-negative integer) The evaluation score of the candidate actions controlling this Micro AI. By default, it is set to 300,000, which is higher than any of the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|RCA AI candidate actions]]. By setting it, for example, to 170,000, we can have it be executed after the default recruitment CA, but before most of the other default CAs. Note that the Swarm AI consists of 2 CAs with scores ranging from <tt>ca_score-1</tt> to <tt>ca_score</tt>.
* '''enemy_distance'''=5: (int) The minimum distance kept between units of the swarm and enemies when the swarm moves as a whole.
* '''[filter]''': {{DevFeature1.15|12}} A [[StandardUnitFilter|Standard Unit Filter]] selecting the units. Only AI units matching this filter participate in the swarm. The filter automatically includes the side= key set to the AI side.
* '''scatter_distance'''=3: (int) Enemies within "scatter_distance" hexes of any swarm unit cause the swarm to scatter, by each unit trying to maximize its individual distance from the enemy.
* '''vision_distance'''=12: (int) Only units within this distance follow the overall swarm motion (either away from an enemy or of the swarm as a whole). The smaller this value is set, the less likely the swarm is to stay together or rejoin. This parameter is meant to simulate how far an individual member of the swarm can see, meaning that the swarm is "out of sight" (and the unit will not be able to follow it) if it is more than this distance away.

'''Standard RCA AI aspects respected by this Micro AI:'''
*'''[avoid]''': {{DevFeature1.15|0}} The standard RCA AI aspect used to define locations that should be avoided by the AI. See above (under 'optional keys') for details.

Here's an example of a Swarm [micro_ai] tag usage from the "Swarm" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=2
ai_type=swarm
action=add
[/micro_ai]

== Assassin Squad Micro AI (ai_type=assassin) ==

{{DevFeature1.13|6}}

This Micro AI controls one or several assassin units which try to circle around enemy units with the goal of hitting a target unit without being distracted or impeded by other enemies. The units will always attack the target if such attacks are possible, otherwise they will follow the path of least resistance toward it. Notes:

* The main priority for the AI is to find paths that avoid enemy units. However, if no such path can be found, the assassins will still advance toward the target, taking the path exposing the units to the least potential damage from enemies.

* The units will not necessarily follow the same path. The best path is chosen individually for each unit.

* While it is not a requirement for the AI to work, using ambusher or skirmisher units, or units with the quick trait, makes this AI more lethal in many cases.

* The CA evaluation scores of this AI are hard-coded, it does not work otherwise. That means that '''ca_score''' is not a valid key for the [micro_ai] tag.

Enable the Assassin Squad Micro AI by using
ai_type=assassin
in the [micro_ai] tag.

===Assassin Squad specific keys for the [micro_ai] tag:===

'''Required keys:'''

* '''[filter]''': A [[StandardUnitFilter|Standard Unit Filter]] defining the assassin units. The filter automatically includes the side= key set to the AI side.
* '''[filter_second]''': A [[StandardUnitFilter|Standard Unit Filter]] defining the target unit.
** It is important to realize that the AI currently only works correctly with a single target unit. It is thus the responsibility of the scenario designer to make sure that this filter matches an individual enemy unit. If several enemy units are to be targeted in the same scenario, several instances of the Assassin Micro AI can be used.
** The filter automatically includes a [[StandardSideFilter|Standard Side Filter]] set to all enemies of the AI side.

'''Optional keys:'''

* '''[prefer]''': A [[StandardLocationFilter|Standard Location Filter]] selecting locations on the map for the assassins to prefer when making their way toward the target unit. This could be used, for example, to make units with the ambush ability move (mostly) through forest or to have the assassins circle around the, say, northern part of the map rather than the south if that is desirable for scenario design purposes.
** As with avoiding enemies, the units will still move across non-preferred terrain if that is either the only option or ''much'' shorter than preferred terrain
** Attacking, once the target unit is in range, is not influenced by the [prefer] SLF.

Here is an example of an Assassin Squad [micro_ai] tag usage:
[micro_ai]
side=2
ai_type=assassin
action=add

[filter]
type=Assassin,Master at Arms,Duelist
[/filter]
[filter_second]
id=Konrad
[/filter_second]
[prefer] # Circle around northern part of map
x=1-9, 10-99
y=1-37, 1-17
[/prefer]
[/micro_ai]

== Bottleneck Defense Micro AI (ai_type=bottleneck_defense) ==

The Bottleneck Defense Micro AI lets you define a location on the map where the AI can take a defensive stance behind a narrow passage (bottleneck). Units on the front line are backed up by healers and/or units with the leadership ability. Injured units are moved to the back and replaced by uninjured (or less injured) units. The units on the front line only attack when it is safe (no retaliation) or when there is a high chance that they will make a kill or level up. Using this Micro AI only makes sense if there is no way for the enemy sides to move around the bottleneck and attack the AI's units from behind.

For a demonstration, check out the "Bottleneck" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Enable the Bottleneck Defense Micro AI by using
ai_type=bottleneck_defense
in the [micro_ai] tag.

===Bottleneck Defense specific keys for the [micro_ai] tag:===

'''Required keys:'''

The Bottleneck Defense AI requires two sets of coordinates that define where it should be taking up its defensive stance, and from which side the enemy attacks at that location.

* '''x,y''': Comma separated lists of the hexes on the front line, where strong units are placed. All hexes on which the AI makes contact with (can be attacked by) the enemy need to be included here. Units are placed on them in the order in which they are listed here. {{DevFeature1.15|0}} '''location_id''' can be used instead with named/special locations.
* '''enemy_x,enemy_y''': Comma separated list of the hexes from which the enemy can attack the AI front line units. This is needed for the AI to know on which side of the front line support units (healers etc.) need to be placed. In many cases, it is sufficient to provide only one of the enemy front line hexes, but there are geometries for which that does not work. It is therefore safer to list all enemy front line hexes here. {{DevFeature1.15|0}} '''enemy_loc''' can be used instead with named/special locations.

'''Optional keys:'''

By default, the AI places healers and units with the leadership ability both on the front line itself (if they are the strongest units available) and on hexes adjacent to and behind the line. If different placement is desired, these locations can be overridden with the following keys.

* '''active_side_leader'''=no: (boolean) If set to 'yes', the side leader participates in the bottleneck defense action after the side's gold has been spent. If set to 'no' (default), the leader follows default AI behavior (sitting on the keep and recruiting, for the most part).
* '''ca_score'''=300000: (non-negative integer) The evaluation score of the candidate actions controlling this Micro AI. By default, it is set to 300,000, which is higher than any of the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|RCA AI candidate actions]]. By setting it, for example, to 170,000, we can have it be executed after the default recruitment CA, but before most of the other default CAs. Note that the Bottleneck Defense AI consists of 2 CAs with scores ranging from <tt>ca_score-1</tt> to <tt>ca_score</tt>.
* '''[filter]''': {{DevFeature1.15|3}} A [[StandardUnitFilter|Standard Unit Filter]] selecting the units. Only AI units matching this filter participate in the bottleneck defense. The filter automatically includes the side= key set to the AI side.
* '''healer_x,healer_y''': Comma separated list of hexes where healers are placed. This can be used to keep healers from the front line (or to take up only certain positions on the front line), and/or to override the default healing positions behind the line. Healers are placed on them in the order in which the hexes are listed, with the exception that hexes on the line always take priority over hexes behind the line. {{DevFeature1.15|0}} '''healer_loc''' can be used instead with named/special locations.
* '''leadership_x,leadership_y''': Same as ''healer_x,healer_y'', but for units with the leadership ability. {{DevFeature1.15|0}} '''leadership_loc''' can be used instead with named/special locations.

As an example, in the "Bottleneck" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]], there are three front line hexes, two of which are on hill terrain, while the third is a road with a lower defense rating. The healer and side leader are supposed to participate in combat because they are strong units, but only from the hill hexes to keep them safer. This is accomplished by using the following keys settings (check out the scenario to see which hex is which):
[micro_ai]
side=1
ai_type=bottleneck_defense
action=add

x=14,14,14
y= 7, 9, 8
enemy_x=13,13
enemy_y= 8, 9

healer_x=14,14,15,15
healer_y= 7, 9, 8, 9
leadership_x=14,14,15,15
leadership_y= 7, 9, 9 ,8
active_side_leader=yes
[/micro_ai]

== Fast Micro AI (ai_type=fast_ai) ==

{{DevFeature1.13|0}}

This AI is meant as a fall-back AI for scenarios where there are so many units that attacks and moves done by the default AI are slow with long delays before each move. It replaces the default castle-switch, retreat-injured, spread-poison, high-xp-attack, combat, place-healers, move-to-targets, villages and retreat candidate actions (CAs). It should be obvious that in order to achieve the faster speed, compromises concerning the quality of the moves have to be made.

Enable the Fast Micro AI by using
ai_type=fast_ai
in the [micro_ai] tag.

'''Combat candidate action:'''
* Attackers are considered individually one at a time. The best attack found for a unit is executed without checking whether a better attack by another unit might be possible.
* The default order in which attackers are considered is by decreasing hitpoints, starting with the strongest unit (in terms of HP). This can be modified with the optional keys below.
* By default, if weaker units block attack hexes for a stronger unit, they do not move out of the way (this is the same as for the default AI). If a hex becomes available after an attack (e.g. due to a weaker unit dying in the attack), all attacks that were possible ''before'' this happened are finished first. Only after that are attacks by the stronger unit reconsidered.
* If include_occupied_attack_hexes=yes is set, weaker units move out of the way for stronger units if possible. This can, however slow down the AI depending on the situation on the map. Use with caution.
* {{DevFeature1.13|2}} Previous to this version, attacks by the leader were bunched in with the attacks by the other units. Now leader attacks are treated separately and contain an extra layer of analysis to determine whether the attack position is "safe" (in an approximate way). Currently, this is done with two simple considerations:
** Count all enemy units that can reach the leader's attack position. If there are more than given by optional parameter 'leader_attack_max_units' (default value 3), do not attack.
** Add up the hitpoints of all enemies that can reach the leader's attack position. If this value, multiplied by optional parameter 'leader_weight'(default value 2), is larger than the leaders hitpoints, do not attack.
** Two optional parameters, 'threatened_leader_fights' and 'leader_additional_threat', can also be used to let the leader attack when the threat at the attack hex is comparable to that at the leader's current position.
** In order to keep this AI as fast as possible, leader attacks are done by a separate candidate action that is only evaluated when all other CAs are done.

'''Move-to-targets, villages and retreat candidate actions:'''
* The move-to-targets, villages and retreat candidate actions of the default AI are removed. Move-to-targets and villages are taken over by the Fast Micro AI, whereas retreat is simply not done.
* This CA moves units toward goals after attacks are done. Goals are unowned (if the AI side has a leader only) and enemy-owned villages and enemy leaders.
* For each goal, units are pre-sorted in order of the fewest moves needed to cover the ''distance'' toward the goal (that is, as if move cost on each hex toward the goal were 1). Units are then considered sequentially and if a unit can get there "efficiently", its move is executed without considering other units.
** A move is considered efficient if the move cost to get to the hex is not more than 'move_cost_factor' larger than the distance to the hex. 'move_cost_factor' is an optional key that defaults to 2. It can be set to values of 1.1 or larger (see below).
** If the move for the current unit is not found to be efficient, the AI considers the next unit instead. If no unit can do an efficient move toward the goal, the best (fastest) of the inefficient moves is selected instead.

* Village goals:
** Village goals are considered before enemy leader goals so that the AI preferentially chooses scouts (or otherwise fast units) for them.
** The number of units sent toward villages depends on the value of the default AI aspect village_value. It is set to village_value/4 times the number of units the AI has left to move. Thus, by default (village_value=1.0) the AI sends a quarter of its units toward villages, and the rest toward enemy leaders. This means that the meaningful range of values for village_value is 0..4.
** Only one unit is moved toward each village. This consideration also overrides the number of units to move toward villages defined by village_value, topping it at the number of unowned/enemy-owned villages on the map.
** Setting village_value=0 disables moving units toward villages altogether. That is, not only are no units chosen, but the village targeting phase of the AI is entirely disabled with no evaluation time used for it. Note that, unlike with the default AI, this also means that no villages within range of an AI unit are grabbed.
** The order in which villages are chosen as goals is some combination of them being close to the AI side's leader and being spread out over the map.

* Enemy leader goals:
** The order of enemy leaders goals is set according to their distance from the AI leader with the closest enemy leader being targeted first (if the AI has a leader, otherwise their order is random). One unit is sent toward each enemy leader in this order, after which the AI starts with the first enemy leader again. This is repeated until all units have moved.

* Guardians (units with ai_special=guardian set) are ignored by the fast move-to-targets CA.

'''Tips for speeding up/modifying the Fast Micro AI in specific scenarios:'''

A number of optional keys and default AI aspects can be used to modify the behavior of the Fast Micro AI. The MAI is set up so that it is a reasonable compromise between speed and quality of the moves in most situations. However, this might not be ideal for all scenarios here are some things that can be done to speed up the AI (or to get better behavior in some situations by doing the opposite):
* Use large values for the default AI aspect aggression. The largest delays before attacks happen (in some circumstances) when the Fast MAI has to consider lots of units with attacks left but decides not to attack with them. See below for a description of how aggression is used by the fast AI.
* Use large values of move_cost_factor (see above for description of what this does). If you want to emphasize units that can move across terrain easily (e.g. bats) to be chosen for village grabbing, you might want to use low values of move_cost_factor, but this might slow down the AI. The default value should work reasonably well in most standard situations, but modifying the value might work better on specific maps.
* Don't use dungeon_mode=yes unless absolutely necessary, even in most dungeon crawls. Test the AI without this setting first and only use it if it is the only way to solve the problem. Often, a minor tweak to the map will have the same effect, without the speed penalty.
* Use include_occupied_attack_hexes=yes with caution. It might (or might not) slow down the attack CA significantly, depending on the scenario.
* Set village_value=0, which makes the AI not consider villages as goals. This has not been found to make a large difference on the maps tested so far, but it might have an effect on maps with a very large number of villages.
* Use attack_hidden_enemies=yes on maps where there are no hidden enemies. Excluding hidden enemies from the attack calculation requires an additional filter to be evaluated that takes extra time. In most cases this will not result in a large computation time saving.

'''Required keys:'''

There are no required keys.

'''Optional keys:'''

* '''attack_hidden_enemies'''=no: (boolean) By default, hidden enemies are excluded from the attack calculation. Setting this to 'yes' makes the AI also consider those enemies as attack targets.
* '''[avoid]''': {{DevFeature1.13|2}} A [[StandardLocationFilter|Standard Location Filter]] for the terrain which the AI units should avoid. If it is not given, the existence of the default (RCA) AI's [avoid] tag is checked (and used if it exists). As with the default AI, units will not step on hexes defined by the [avoid] tag. In addition, no goals will be chosen that lie on those hexes. The one minor exception is that a unit stepping out of the way for another unit might temporarily enter the avoided zone.
* '''dungeon_mode'''=no: (boolean) As much as possible, the Fast Micro AI works with distances between hexes rather than path finding. This works pretty well on open maps and even most dungeon crawls (and similar scenarios), but it might result in some units getting temporarily (and in rare cases permanently) stuck on maps with convoluted labyrinths. If that is the case, setting dungeon_mode=yes triggers more path finding that avoids such situations (but as a result is somewhat slower).
* '''include_occupied_attack_hexes'''=no: (boolean) If set to 'yes', the AI moves weaker units out of the way for a stronger attacker. This might lead to better attacks but is slower, so don't use if speed is essential.
* '''[filter]''': {{DevFeature1.13|2}} A [[StandardUnitFilter|Standard Unit Filter]] selecting the attackers. Only AI units matching this filter will attack, analog to filtering units using [filter_own] with the [[AiWML#Filtering_Combat_with_the_attacks_Aspect|attacks aspect]] for the default AI. The filter automatically includes the side= key set to the AI side. It does not affect the move-to-targets CA.
* '''[filter_second]''': {{DevFeature1.13|2}} A [[StandardUnitFilter|Standard Unit Filter]] selecting the enemies. Only enemy units matching this filter will be attacked, analog to filtering units using [filter_own] with the [[AiWML#Filtering_Combat_with_the_attacks_Aspect|attacks aspect]] for the default AI. The filter automatically includes a [[StandardSideFilter|Standard Side Filter]] set to all enemies of the AI side. It does not affect the move-to-targets CA.
* '''leader_weight'''=2: (number >= 0) {{DevFeature1.13|2}} A factor specifying how much more valuable the AI considers side leaders than non-leader units in the attack evaluation. This is also used to determine whether an attack by the leader is safe (see description of the combat candidate action above).
* '''leader_additional_threat'''=1: (number > 0) {{DevFeature1.13|2}} If threatened_leader_fights=yes, the threat at the attack position may be larger by this factor for the leader to leave the keep for an attack.
* '''leader_attack_max_units'''=3: (number >= 0) {{DevFeature1.13|2}} A number specifying how many enemy units within reach are acceptable when determining whether an attack by the leader is safe (see description of the combat candidate action above).
* '''move_cost_factor'''=2: (number >= 1.1) The factor by which the move cost to a goal hex may be larger than the distance to the goal hex for a move to be considered "efficient". See description above. 1.1 is used if this is set to values smaller than 1.1. Smaller values might lead to better behavior, while larger values might speed up the AI.
* '''weak_units_first'''=no: (boolean) If set to 'yes', inverts the order in which units are considered by the combat CA. Attacks are then done in order of increasing hitpoints of the attackers.
* '''skip_combat_ca'''=no: (boolean) If set to 'yes', the fast combat CA is not used. The default AI's high_xp_attack and combat CAs remains in place in this case.
* '''skip_move_ca'''=no: (boolean) If set to 'yes', the fast move-to-targets CA is not used. The default AI's retreat, villages and move-to-targets CAs remains in place in this case.
* '''threatened_leader_fights'''=no: (boolean) {{DevFeature1.13|2}} By default, the AI leader will not attack if the threat at the attack position is too high. If this key is set to 'yes', the leader will attack if the threat there is not larger than the threat at his current position multiplied by the value of 'leader_additional_threat'. This is meant as an option for the endgame: when the AI leader is under attack, he might as well go down fighting.

'''Standard RCA AI aspects respected by this Micro AI:'''
*'''aggression''': The [[AiWML#List_of_AI_Aspects|default RCA AI aspect]] used to set how aggressive the AI should attack. It works in roughly the same way as the default AI aspect:
** The value of (1 - aggression) determines how much the AI values its own units compared to the enemy's units. Thus, aggression=0 means that attacks are only done if the AI expects to deal (roughly) the same amount of damage as it will receive. aggression=1 means that expected damage to the AI's units is not considered, only the expected damage to enemy units matters.
** Damage is calculated as a combination of hitpoints and chance to die, in "gold equivalent units".
** Unlike the default AI, aggression is set to 1 for values larger than 1. Allowed values are thus anything from -infinity to +infinity, although only -infinity to +1.0 make sense.
*'''[avoid]''': {{DevFeature1.13|2}} The standard RCA AI aspect used to define locations that should be avoided by the AI. See above (under 'optional keys') for details.
*'''attacks aspect''': {{DevFeature1.13|2}} The standard RCA AI [[AiWML#Filtering_Combat_with_the_attacks_Aspect|attacks aspect]] used to filter own and enemy units for attacks is now also taken into account as long as neither [filter] nor [filter_second] (see above under 'optional keys') are defined in the [micro_ai] tag.
*'''village_value=1''': (number ranging from 0 to 4) The [[AiWML#List_of_AI_Aspects|default RCA AI aspect]] used to define how much villages should be targeted by the move-to-targets CA. In the Fast MAI, this defines which fraction of the AI units are moved toward village goals (see above for details). If set to 0, villages are ignored as goals.

'''Notes:'''
* The CA evaluation scores of this AI are hard-coded to the same values as those of the respective [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|default candidate actions]]. ca_score is therefore not a valid optional key.
* The fast Micro AI modifies (removes) the default castle-switch, retreat-injured, spread-poison, high-xp-attack, combat, place-healers, move-to-targets, villages and retreat candidate actions.

Enabling the Fast Micro AI in its default configuration is as simple as this usage example from the "Fast AI" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=1
ai_type=fast_ai
action=add
[/micro_ai]

== Generalized Goto Micro AI (ai_type=goto) ==

The Goto Micro AI provides a highly configurable method of sending a unit (or units) to a location or set of locations. The units to be moved are defined using a [[StandardUnitFilter|Standard Unit Filter]] (SUF) [alternatively, all side units are used if the SUF is not provided), while the goto locations are given in a [[StandardLocationFilter|Standard Location Filter]] (SLF).

By default, each unit matching the SUF will move toward the closest goal (in terms of turns needed to get there) matching the SLF via the fastest route given the current situation on the map (locations of enemy units etc.), but this behavior can be influenced by the optional keys listed below. Note that this means that a unit's goal might change from one turn to the next depending on the situation on the map.

The behavior of the unit(s) once they reach their goal location(s) is configurable as well. By default, they will stay there until the Goto Micro AI is deleted or changed.

For demonstrations of several Goto Micro AI usages, check out the "Goto" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Enable the Goto Micro AI by using
ai_type=goto
in the [micro_ai] tag.

===Goto specific keys for the [micro_ai] tag:===

'''Required keys:'''

* '''[filter_location]''': A [[StandardLocationFilter|Standard Location Filter]] describing the possible goal locations for the move.

'''Optional keys:'''

* '''[avoid]''': {{DevFeature1.15|0}} A [[StandardLocationFilter|Standard Location Filter]] for the locations which the AI units should avoid. If it is not given, the existence of the default (RCA) AI's [avoid] tag is checked (and used if it exists). Note that the area defined by [avoid] is not entered at all, even if the end point of the move would lie outside the area again.
* '''avoid_enemies''': (number>0) By default, units controlled by the Goto Micro AI will not take enemy units into account for route finding, other than the enemies' ZoCs. By contrast, if this key is set, they will try to avoid traversing hexes on which they can be attacked by enemies. The larger the value of ''avoid_enemies'', the more the units will try to stay out of the enemies' way. Notes:
** Units are willing to take a path that is 'avoid_enemies' movement points longer for each enemy unit that can be avoided by doing so for each hex along the path. As an example, if avoid_enemies=1 and the shortest path crosses 2 hexes that can be reached by 3 enemies each, the unit is willing to take a path that is up to 6 hexes longer instead. If avoid_enemies=10 in the same situation, the unit will take a path up to 60 hexes longer.
** Hexes adjacent to enemy units are always strongly avoided, independent of the value of avoid_enemies.
** avoid_enemies is ignored if 'use_straight_line=true' is set.
** Due to an issue with the path finding code, '''tunnels and teleports are ignored in Wesnoth 1.14 and before''' if 'avoid_enemies' is used. This has been fixed in Wesnoth 1.15.
* '''ca_score'''=300000: (non-negative integer) The evaluation score of the candidate action controlling this Micro AI. By default, it is set to 300,000, which is higher than any of the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|RCA AI candidate actions]]. By setting it, for example, to 170,000, we can have it be executed after the default recruitment CA, but before most of the other default CAs.
* '''[filter]''': A [[StandardUnitFilter|Standard Unit Filter]] selecting the units to be moved. Defaults to all units of the side if not defined. The filter automatically includes the side= key set to the AI side.
* '''ignore_enemy_at_goal'''=no and '''ignore_units'''=no: (boolean) In the default configuration, the Goto MAI does not move units if the path to all goal hexes is blocked by enemies. It is therefore possible to disable the Goto MAI by putting enemy units on all the goal hexes. That can be changed if either of these two keys is set to 'yes'.
** 'ignore_enemy_at_goal=yes' makes the AI choose its goals while disregarding any enemy units at the goal hexes. Even so, a stiff rating penalty is applied to goal hexes occupied by enemies, thus that unoccupied goal hexes are chosen unless all possible goals are occupied by enemies. Note that this setting ''only'' ignores enemy units at the goal hexes themselves. It is still possible to disable the AI by putting enemies all around the goals.
** 'ignore_units=yes' let's the AI ignore ''all'' enemy units when deciding which goal hex(es) to move toward.
** In both cases, enemies are only ignored for deciding which unit to move toward which goal hex. For the actual move itself, all enemies and their ZoCs are considered as usual.
** Both options only take effect if neither avoid_enemies is used, nor use_straight_line is set to 'yes', as neither of these consider enemies as blockers. Or in other words, if avoid_enemies is used, or use_straight_line=yes, it is unnecessary to set ignore_enemy_at_goal or ignore_units to yes.
* '''release_unit_at_goal'''=no: (boolean) By default, a unit that reaches a goal location will stay there until the Goto Micro AI is deleted or changed (or until the conditions specified in the [goto_goals] SLF change). If this parameter is set, a unit that has reached its goal will not be controlled by this Micro AI any more starting from the next turn.
* '''release_all_units_at_goal'''=no: (boolean) Same as ''release_unit_at_goal'', but this will deactivate the Goto Micro AI for all units once the first unit reaches a goal.
* '''remove_movement'''=yes: (boolean): {{DevFeature1.15|11}} By default, when the Goto MAI cannot move a unit (for example, because the path is blocked by enemies), its movement points are still removed. If this option is set to 'no', this step does not happen, so that other AI candidate actions (or even another Goto MAI with different parameters) can take over instead.
* '''unique_goals'''=no: (boolean) If set to 'yes', each unit will be sent to a different goal location. Note that the best goals are recalculated each turn, so a unit might choose a different goal this turn from what it was heading for during the previous turn if the situation on the map has changed. Also note that if there are more units than goal locations, the left over units will not be handled by the Goto MAI but follow default behavior instead.
* '''use_straight_line'''=no: (boolean) By default, units choose the route by which they will get to their goal locations in the smallest number of turns. If this parameter is set to 'yes', a straight line route (or something pretty close to it at least) will be chosen instead, irrespective of whether this leads into a dead end, whether it is blocked by enemies, etc.

'''Standard RCA AI aspects respected by this Micro AI:'''
*'''[avoid]''': {{DevFeature1.15|0}} The standard RCA AI aspect used to define locations that should be avoided by the AI. See above (under 'optional keys') for details.

'''Notes:'''
* Depending on the parameters used, the Goto Micro AI might require a lot of path finding to be done. Thus, while it is possible to set up this AI to move many units to many different locations, a usage like that might require quite a long calculation time.

===Goto Micro AI example usages:===

Here are several examples of goto [micro_ai] tag usages from the "Goto" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
* Send a unit toward a castle (similar to the RCA AI's Goto Candidate Action, but avoiding dead ends and areas ZoCed by enemies)
[micro_ai]
side=2
ai_type=goto
action=add
ca_id=messenger1

[filter]
id=messenger1
[/filter]
[filter_location]
x,y=6-7,2-4
terrain=C*
[/filter_location]
ca_score=210001
[/micro_ai]
* Send all units of the side toward the southern border of the map
[micro_ai]
side=8
ai_type=goto
action=add

[filter_location]
y=33
[/filter_location]
avoid_enemies=1
[/micro_ai]
* Send units to the four corners of the map (with each unit going to a different corner).
[micro_ai]
side=7
ai_type=goto
action=add

[filter_location]
x=1,1,44,44
y=1,33,1,33
[/filter_location]
unique_goals=yes
[/micro_ai]
* Set up a guardian unit that doesn't move while no enemy unit is within 8 hexes (ironically, the Goto Micro AI can be used to keep units in place, although using one of the Guardian Micro AIs might often be a better idea)
[micro_ai]
side=3
ai_type=goto
action=add

[filter]
id=guard1
[/filter]
[filter_location]
[filter]
id=guard1
[/filter]
[not]
[filter]
side=1
[/filter]
radius=8
[/not]
[/filter_location]
[/micro_ai]

== Guardian Micro AIs ==
=== General Comments on the Guardian Micro AIs ===

The Guardian Micro AIs can be used to set up different kind of guardian behaviors for a unit or a set of units. Four different types of guardians are available and are described below.

For a demonstration of several different guardian behaviors, check out the "Guardians" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

=== Return Guardian (ai_type=return_guardian)===

A 'return guardian' is a variation of the standard Wesnoth guardian. It has an assigned guard position (GP) to which it returns after attacks on approaching enemies:
* If at GP with no enemy in reach, do nothing.
* If at GP with an enemy in reach, attack. Note that the attack is done by the default AI, which might result in the guardian not attacking if the enemy is deemed too strong (this can be influenced by setting the default ''aggression'' value to a different value).
* If not at GP, return there, no matter whether an enemy is in reach or not.
* If enemies are blocking the way back to GP, do your best to move around them.
* If the guardian ends up next to an enemy on the way back, attack that enemy after the move.

Enable the Return Guardian Micro AI by using
ai_type=return_guardian
in the [micro_ai] tag together with the following keys:

'''Required keys:'''

* '''id''' or '''[filter]''': The ID of a unit or a [[StandardUnitFilter|Standard Unit Filter]] selecting the units controlled by this Micro AI.
** One or the other is required
** If both are given, [filter] takes priority over id=
** The AI contains an implicit filter for units on the AI side. Thus, if all AI units are to be selected, an empty [filter] tag can be used.
** If several units match the filter, the order in which they are controlled is not guaranteed. If the order matters, set up several MAIs using the id= key and different values for ca_score=.
* '''return_x,return_y''': The coordinate of the hex the unit returns to after each attack. {{DevFeature1.15|0}} '''return_loc''' can be used instead with a named/special location.

'''Optional keys:'''

* '''ca_score'''=100010: (non-negative integer) The evaluation score of the candidate actions controlling this Micro AI. This AI consist of 2 CAs, one with score <tt>ca_score</tt> the other with <tt>ca_score-20</tt>. The default value is set so that the first CA gets executed right before the default combat CA, and the other right after. It usually will not make sense to change this value, but it is possible to do so for custom applications. {{DevFeature1.13|6}}: This is now changed to 100100 and 99900 in order to avoid conflicts with the new high_XP_attacks candidate action.

Here's an example of a return guardian [micro_ai] tag usage from the "Guardians" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=2
ai_type=return_guardian
action=add

[filter]
id=return1
[/filter]
return_x,return_y=20,2
[/micro_ai]

===Stationed Guardian (ai_type=stationed_guardian) ===

A 'stationed guardian' is another variation of the standard Wesnoth guardian with a somewhat more complex behavior than that of the 'return guardian'. Two positions are defined for it, a 'station' and a 'guarded location', as well as a distance. The behavior is as follows:
* If no enemy is within 'distance' of the guard's current position, do nothing. This is independent of the guardian being at its station or not.
* Otherwise: If an enemy is within 'distance' of the guard, but not also within the same distance of the guarded location and the station (all of this simultaneously), move the guard in the direction of the station (or keep the guard in place if the station is unreachable).
* Otherwise:
** Pick the enemy unit that is closest to the guarded location.
** If we can reach it, pick the adjacent hex with the highest defense rating and attack from there.
** If not in reach, move toward this unit.

Enable the Stationed Guardian Micro AI by using
ai_type=stationed_guardian
in the [micro_ai] tag together with the following keys:

'''Required keys:'''

* '''id''' or '''[filter]''': The ID of a unit or a [[StandardUnitFilter|Standard Unit Filter]] selecting the units controlled by this Micro AI.
** One or the other is required
** If both are given, [filter] takes priority over id=
** The AI contains an implicit filter for units on the AI side. Thus, if all AI units are to be selected, an empty [filter] tag can be used.
** If several units match the filter, the order in which they are controlled is not guaranteed. If the order matters, set up several MAIs using the id= key and different values for ca_score=.
* '''distance''': The distance parameter as explained above
* '''station_x,station_y''': The x and y position of the hex that serves as the guardians station. {{DevFeature1.15|0}} '''station_loc''' can be used instead with a named/special location.
* '''guard_x, guard_y''': The x and y position of the guarded location. {{DevFeature1.13|0}} These are now optional keys, defaulting to station_x,station_y if not provided. {{DevFeature1.15|0}} '''guard_loc''' can be used instead with a named/special location.

'''Optional keys:'''

* '''ca_score'''=300000: (non-negative integer) The evaluation score of the candidate action controlling this Micro AI. By default, it is set to 300,000, which is higher than any of the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|RCA AI candidate actions]]. By setting it, for example, to 170,000, we can have it be executed after the default recruitment CA, but before most of the other default CAs.

Here's an example of a stationed guardian [micro_ai] tag usage from the "Guardians" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=2
ai_type=stationed_guardian
action=add

[filter]
id=stationed1
[/filter]
distance=4
station_x,station_y=2,14
guard_x,guard_y=3,13
[/micro_ai]

=== Coward (ai_type=coward) ===

Cowards are units that, like guardians, sit around doing nothing until an enemy comes into range. Unlike guardians, however, they run away once enemies approach. Applications might be wild animals, unarmed civilians getting in the way of a battle, etc. The coward macro can be called with two optional locations, 'seek' and 'avoid':
* If neither is given, the coward retreats to the position farthest away from the approaching enemies.
* If 'seek' is given, it preferentially goes toward that location (but getting away from enemies takes priority).
* If 'avoid' is given, it in addition tries to avoid that location (with both maximizing distance from enemies and going toward 'seek' taking priority).
* Both 'seek' and 'avoid' may consist of only one coordinate ('x' or 'y'), in which case not a single hex, but a line of hexes is sought or avoided.

Enable the Coward Micro AI by using
ai_type=coward
in the [micro_ai] tag together with the following keys:

'''Required keys:'''

* '''id''' or '''[filter]''': The ID of a unit or a [[StandardUnitFilter|Standard Unit Filter]] selecting the units controlled by this Micro AI.
** One or the other is required
** If both are given, [filter] takes priority over id=
** The AI contains an implicit filter for units on the AI side. Thus, if all AI units are to be selected, an empty [filter] tag can be used.
** If several units match the filter, the order in which they are controlled is not guaranteed. If the order matters, set up several MAIs using the id= key and different values for ca_score=.
* '''distance''': The distance within which an enemy must be to "scare" the unit

'''Optional keys:'''

* '''attack_if_trapped'''='no': {{DevFeature1.13|0}} With the default settings, a coward never attacks. If this key is set to 'yes', the coward attacks the weakest (lowest hitpoints) enemy next to which it ends up after moving (such as a cornered animal would do, blindly lashing out without regards for its own safety).
* '''avoid_x, avoid_y''': The x and y coordinate of the hex to avoid. {{DevFeature1.15|0}} '''avoid_loc''' can be used instead with a named/special location.
* '''ca_score'''=300000: (non-negative integer) The evaluation score of the candidate action controlling this Micro AI. By default, it is set to 300,000, which is higher than any of the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|RCA AI candidate actions]]. By setting it, for example, to 170,000, we can have it be executed after the default recruitment CA, but before most of the other default CAs.
* '''[filter_second]''': A [[StandardUnitFilter|Standard Unit Filter]] selecting the units from which the cowards flee. If not set, this defaults to all enemy units. Note, however, that no "enemy of AI side" condition is added if [filter_second] is specified, meaning that it can include allied and/or enemy units as desired (and even units on the same side as the coward).
* '''seek_x, seek_y''': The x and y coordinate of the hex to seek. {{DevFeature1.15|0}} '''seek_loc''' can be used instead with a named/special location.

Here's an example of a coward [micro_ai] tag usage from the "Guardians" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=2
ai_type=coward
action=add

[filter]
id=coward3
[/filter]
distance=5
seek_x,seek_y=24,5
avoid_x,avoid_y=24,15
[/micro_ai]

=== Zone guardian (ai_type=zone_guardian) ===

A zone guardian is a unit that, as the name says, guards a zone. It moves randomly inside this zone until an enemy enters it (or a separately defined enemy zone, see below). Applications might be the defense of a castle, a nesting area or for protecting an unit. The zone macro can be called with an optional SLF, [filter_location_enemy]:
* If not specified, the zone guard attacks any enemy coming inside its guard zone.
* If [filter_location_enemy] is given, it attacks any enemy entering this zone and once there are no more enemies, it goes back to patrol in its basic zone.

Enable the Zone Guardian Micro AI by using
ai_type=zone_guardian
in the [micro_ai] tag together with the following keys:

'''Required keys:'''

* '''id''' or '''[filter]''': The ID of a unit or a [[StandardUnitFilter|Standard Unit Filter]] selecting the units controlled by this Micro AI.
** One or the other is required
** If both are given, [filter] takes priority over id=
** The AI contains an implicit filter for units on the AI side. Thus, if all AI units are to be selected, an empty [filter] tag can be used.
** If several units match the filter, the order in which they are controlled is not guaranteed. If the order matters, set up several MAIs using the id= key and different values for ca_score=.
* '''[filter_location]''': A [[StandardLocationFilter|Standard Location Filter]] designating the zone to guard.

'''Optional keys:'''
* '''ca_score'''=300000: (non-negative integer) The evaluation score of the candidate action controlling this Micro AI. By default, it is set to 300,000, which is higher than any of the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|RCA AI candidate actions]]. By setting it, for example, to 170,000, we can have it be executed after the default recruitment CA, but before most of the other default CAs.
* '''[filter_location_enemy]''': A [[StandardLocationFilter|Standard Location Filter]] designating the zone where enemies have to be attacked. If not given, it defaults to [filter_location].
* '''station_x,station_y''': By default, the zone guardian moves randomly within the zone if there is no enemy to attack. However, if station_x/y is given, it moves to this position instead during turns when it does not have an enemy to attack. This position does not need to be inside the zone defined above. Note: obviously it does not make sense to define [filter_location], [filter_location_enemy] and station_x/y all at the same time. Only [filter_location] and either one of the latter two (or none of them) should be provided for any zone guardian. {{DevFeature1.15|0}} '''station_loc''' can be used instead with a named/special location.

Here's an example of a zone guardian [micro_ai] tag usage from the "Guardians" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=2
ai_type=zone_guardian
action=add

[filter]
id=zone3
[/filter]
[filter_location]
x,y=22-31,4-11 # This is intentionally chosen to extend past the lake
terrain=W*
[/filter_location]
station_x,station_y=32,8
[/micro_ai]

== Hang Out Micro AI (ai_type=hang_out) ==

The Hang Out Micro AI instructs units of the AI side to "hang out" around a certain location, or locations, until a condition for mobilizing the side is met. If none of the optional keys are given, the AI controls all units of the side to hang around the leader while moving off castle tiles to make room for recruiting.

The AI works by moving each unit to its best hex first using the minimum amount of movement points required for this move. Once all AI units are in position, movement points are set to zero for all of them simultaneously such that they cannot be used by other AI candidate actions. This is done because the mobilizing condition might be met as result of one of the moves of the Hang Out AI, after which we want units to be able to continue with other AI actions.

For a demonstration, check out the "Hang Out and Messenger" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Enable the Hang Out Micro AI by using
ai_type=hang_out
in the [micro_ai] tag.

===Hang Out specific keys for the [micro_ai] tag:===

'''Required keys:'''

There are no required keys. In its default configuration, the Hang Out MAI controls all units of a side, keeping them as close to the side leader(s) as possible while moving off castle tiles to make room for recruiting. For this purpose, the candidate action score defaults to 170,000, which is just below the score of the default recruiting CA.

'''Optional keys:'''

* '''[avoid]''': A [[StandardLocationFilter|Standard Location Filter]] for the terrain which the AI units should avoid. If it is not given, the existence of the default (RCA) AI's [avoid] tag is checked (and used if it exists). If neither of these two exists, this parameter is set to default to all castle terrain (<tt>terrain=C*,C*^*,*^C*</tt>) so that units move off the castle to make room for recruiting. Note that this does not include keep terrain, otherwise the leader would be moved off the keep as well.
* '''ca_score'''=170000: (non-negative integer) The evaluation score of the candidate action controlling this Micro AI. By default, it is set to 170,000, which means that it is executed after the default recruitment CA, but before most of the other default CAs.
* '''[filter]''': A [[StandardUnitFilter|Standard Unit Filter]] selecting the units of the AI side participating in the Hang Out action (<tt>side=</tt> is always set and does not need to be provided). It defaults to all units of the side. The filter automatically includes the side= key set to the AI side.
* '''[filter_location]''': A [[StandardLocationFilter|Standard Location Filter]] describing the locations ''near'' which the AI units should hang out. This does not mean that the units only move onto terrain specified here, but that they minimize the distance to such terrain. It defaults to the position of the side leader(s).
* '''[mobilize_condition]''': Contains ([[ConditionalActionsWML#Condition_Tags|WML Condition Tags]]) Once the condition set up here has been met, the Hang Out MAI is disabled and the side goes over to other AI activity. The Hang Out MAI remains disabled after this, even if the condition is not met any more later in the scenario.
* '''mobilize_on_gold_less_than''': (integer) Since side gold cannot be checked in a WML condition tag without storing it in a variable first, this key is provided separately. It disables the Hang Out Micro AI once the side gold goes below the value specified here for the first time.

'''Standard RCA AI aspects respected by this Micro AI:'''
*'''[avoid]''': The standard RCA AI aspect used to define locations that should be avoided by the AI. See above (under 'optional keys') for details.

'''Notes:'''

* The Hang Out AI still takes effect if no locations to hang out at are found or if all map locations are to be avoided. In that case, it simply keeps all units at their current locations.

This is an example of a Hang Out Micro AI configuration from the "Hang Out and Messenger" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=1
ai_type=hang_out
action=add

[avoid]
terrain=C*,H*,M*,A*,S*,*^F*
[/avoid]
[mobilize_condition]
[have_unit]
side=1
count=7-99
[/have_unit]
[/mobilize_condition]
[/micro_ai]

== Healer Support Micro AI (ai_type=healer_support) ==

The Healer Support Micro AI configures the healers of a side to stay behind the battle lines and heal injured and/or threatened units rather than participate in combat under all circumstances. You can set different levels of aggressiveness for the healers.

'''Notes'''
* By default, ''all'' healers of the AI side are controlled by this AI. This includes in particular also the side leader, if the leader is a healer. If you do not want the leader to be included (and possibly be moved away from the keep etc.) use the [filter] tag with canrecruit=no (see below).
* It is not always better to use this Micro AI than the default AI, as it takes healers (which can be strong units) away from the pool of units to choose for attacks.
* {{DevFeature1.15|3}} This Micro AI now takes unit guardian status and the passive_leader aspect into account.

For a demonstration, check out the "Healers" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Enable the Healer Support Micro AI by using
ai_type=healer_support
in the [micro_ai] tag.

===Healer Support specific keys for the [micro_ai] tag:===

'''Required keys:'''

There are no required keys.

'''Optional keys:'''

* '''[filter]''': A [[StandardUnitFilter|Standard Unit Filter]] selecting the healer units. If set, only units on the AI side passing this filter ''and'' having the healing ability are considered by this Micro AI.
*'''[filter_second]''': A [[StandardUnitFilter|Standard Unit Filter]] selecting units to receive healing. If set, only units on the AI side passing this filter ''and'' the other healee selection criteria will be selected for healing by this Micro AI.
* '''aggression'''=1.0: (float) Sets the aggressiveness of the AI. This parameter is set up as a float to accommodate future functionality, but it currently acts as a boolean: if set to zero, the AI will never let its healers participate in combat, for all other values it allows them to attack after all other units have attacked and if the healers cannot find any more units to support. The former behavior might be appropriate in scenarios with only one or few valuable healers, while the latter might work better in scenarios with many healers.
* '''injured_units_only'''=no: (boolean) If set to 'yes', the AI will only move healers next to units that are already injured and skip units that currently have full hitpoints, but might get injured during the next enemy turn.
* '''max_threats'''=9999: (integer) The maximum allowable number of enemies that can attack a hex in order for it to be considered for a healer. As an example, setting 'max_threats=0' means that the AI only moves healers to locations that are entirely safe from the enemy (assuming that none of the units currently on the map dies). Note that the value of this key is checked against the number of enemies that can make it to the hex, not the number of adjacent hexes from which the healer could be attacked.

'''Standard RCA AI aspects respected by this Micro AI:'''
*'''[avoid]''': The standard RCA AI aspect used to define locations that should be avoided by the AI. Note: as attacks by the healers are left to the default AI, there is no separate ''[avoid]'' tag for this Micro AI in order to prevent inconsistencies.

'''Notes:'''
* The Healer Support Micro AI modifies the [[AiWML#Filtering_Combat_with_the_attacks_Aspect|attacks aspect]].
* The CA evaluation scores of this AI are hard-coded. It does not work otherwise.

This is an example of a Healer Support Micro AI configuration from the "Healers" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=2
ai_type=healer_support
action=add

aggression=0
[/micro_ai]

== Lurkers Micro AI (ai_type=lurkers) ==

The Lurker Micro AI controls some or all units of a side in "lurker mode". A lurker is a unit that is capable of moving across most terrains, but that only stops on and attacks from specific terrain. It might also have the ability to hide on this terrain (which is the reason why it is called a lurker).

Lurkers move individually without strategy and always attack the weakest enemy within their reach. If no enemy is in reach, the lurker does a random move instead - or it just sits and waits (lurks).

For a demonstration of different types of lurker behavior, check out the "Lurkers" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Enable the Lurkers Micro AI by using
ai_type=lurkers
in the [micro_ai] tag

===Lurkers specific keys for the [micro_ai] tag:===

'''Required keys:'''
* '''[filter]''': Specifies which units of the side are controlled by the Lurker Micro AI. This is a [[StandardUnitFilter|Standard Unit Filter]]. The filter automatically includes the side= key set to the AI side.
* '''[filter_location]''': Specifies the terrain from which the lurkers attack. This is a [[StandardLocationFilter|Standard Location Filter]].

'''Optional keys:'''
* '''ca_score'''=300000: (non-negative integer) The evaluation score of the candidate action controlling this Micro AI. By default, it is set to 300,000, which is higher than any of the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|RCA AI candidate actions]]. By setting it, for example, to 170,000, we can have it be executed after the default recruitment CA, but before most of the other default CAs.
* '''[filter_location_wander]''': Specifies the terrain on which lurkers end their moves if there is no enemy in reach. This is a [[StandardLocationFilter|Standard Location Filter]]. If [filter_location_wander] is not given, it defaults to [filter_location].
* '''stationary'''=no: (boolean) If set to yes, a lurker never moves if there is no enemy within attack range.

Here's an example of [micro_ai] tag usage from the "Lurkers" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=4
ai_type=lurkers
action=add

[filter]
type=Naga Fighter
[/filter]
[filter_location]
terrain=W*,S*
[/filter_location]
[filter_location_wander]
terrain=W*
[/filter_location_wander]
[/micro_ai]

== Messenger Escort Micro AI (ai_type=messenger_escort) ==

The Messenger Escort Micro AI lets you define a set of waypoints through which it tries to move one or several of its units, the messenger(s). The other units escort the messenger, trying to protect it and attacking enemies that are in its way. Note that a messenger might not strictly hit intermediate waypoints, but that getting close is good enough, especially if a waypoint is occupied by an enemy unit. It does, however, always try to get to the last waypoint.

'''Notes on the use of several messengers:''' {{DevFeature1.13|0}}
* This Micro AI can control several messengers at the same time, which can but do not have to move in a group. They can be put on the map altogether in one location, or be spread out on the map or across different turns.
* The farther a messenger has moved through the chain of waypoints, the higher a priority it is for the AI, meaning that farther advanced (on the map) messengers are moved first, and that the escort units try to clear the way and stay with those messengers more so than with those further back on the map. This order can be inverted using the invert_order= key.
* If several messengers are on the map, escort units might move from one to the other, the AI making a judgement call where they are needed most. Closeness to a messenger is generally the most important criterion, but not the only one.
* If a messenger dies, the escort units previously staying with it now join one of the other messengers if there are any left (otherwise they follow default AI behavior).
* If you want certain escort units to stay always with the same messenger, use several messenger [micro_ai] tags with different [filter]/[filter_second] combinations.

For a demonstration, check out the "Messenger" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Enable the Messenger Escort Micro AI by using
ai_type=messenger_escort
in the [micro_ai] tag.

===Messenger Escort specific keys for the [micro_ai] tag:===

'''Required keys:'''

* '''id''' or '''[filter]''': {{DevFeature1.13|0}} (Previous to 1.13.0, only id= was allowed.) The id of a unit or a [[StandardUnitFilter|Standard Unit Filter]] selecting the units controlled by this Micro AI.
** One or the other is required
** If both are given, [filter] takes priority over id=
** The AI contains an implicit filter for units on the AI side. Thus, if all AI units are to be selected, an empty [filter] tag can be used.
* '''waypoint_x,waypoint_y''': Comma-separated list of waypoint coordinates through which the messenger will go in the given order to reach its goal, given by the last coordinate. If you want the messenger to go directly to the goal, simply enter a single x,y coordinate here. Note that the messenger does not have to hit each waypoint exactly (except for the final one), getting close to them is good enough. {{DevFeature1.15|0}} '''waypoint_loc''' can be used instead with named/special locations.

'''Optional keys:'''

* '''[avoid]''': {{DevFeature1.15|11}} A [[StandardLocationFilter|Standard Location Filter]] for the locations which the AI units should avoid. If it is not given, the existence of the default (RCA) AI's [avoid] tag is checked (and used if it exists).
* '''ca_score'''=300000: (non-negative integer) The evaluation score of the candidate actions controlling this Micro AI. By default, it is set to 300,000, which is higher than any of the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|RCA AI candidate actions]]. By setting it, for example, to 170,000, we can have it be executed after the default recruitment CA, but before most of the other default CAs. Note that the Messenger Escort AI consists of 3 CAs with scores ranging from <tt>ca_score-2</tt> to <tt>ca_score</tt>.
* '''enemy_death_chance'''=0.67 and '''messenger_death_chance'''=0.0: (both floats; ranging from 0 to 1) If the messenger is adjacent to an enemy at the end of the move, it will only attack the enemy if the chance of death of the enemy is >= enemy_death_chance and if the messenger's chance of death is <= messenger_death_chance (or if it is an attack at a range for which the enemy does not have a weapon).
* '''[filter_second]''': {{DevFeature1.13|0}} A [[StandardUnitFilter|Standard Unit Filter]] selecting the escort units. If not set, this defaults to all enemy units. The filter automatically includes the side= key set to the AI side.
* '''invert_order'''=no: {{DevFeature1.13|0}} If set to 'yes', the order of priority with which messenger units are considered is inverted, starting with the messenger unit that is the least advanced on the map (see description above). In most cases, selecting this option results in worse performance of the AI, so use it with caution. (And obviously it has no effect at all if there is only one messenger controlled by the AI.)

'''Standard RCA AI aspects respected by this Micro AI:'''
*'''[avoid]''': {{DevFeature1.15|11}} The standard RCA AI aspect used to define locations that should be avoided by the AI. See above (under 'optional keys') for details.

Here's an example of [micro_ai] tag usage from the "Messenger Escort" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=2
ai_type=messenger_escort
action=add

[filter]
id=messenger
[/filter]
waypoint_x=31,24,27,28
waypoint_y=20,14,7,1
[/micro_ai]

== Patrol Micro AI (ai_type=patrol) ==

The defines a number of waypoints for a unit (or units) to follow. Options can be set whether the route should be followed in a loop, as an out-and back, only once, whether units encountered along the way should be attacked, etc.

With the default settings, getting to the next waypoint takes priority over attacking for a patroller, but this can be overridden (as of '''Wesnoth 1.15.12''', using the '''attack_range''' option). Unless instructed otherwise, the AI thus prefers to move the patrol unit around enemies rather than straight for them. Also, if a waypoint is occupied by a unit the AI is not instructed to attack, it will (eventually) abandon that waypoint once it gets close enough and move on to the next one.

For a demonstration of several different patrol behaviors, check out the "Patrols" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Enable the Patrol Micro AI it by using
ai_type=patrol
in the [micro_ai] tag.

===Patrol specific keys for the [micro_ai] tag:===

'''Required keys:'''

* '''id''' or '''[filter]''': The ID of a unit or a [[StandardUnitFilter|Standard Unit Filter]] selecting the units controlled by this Micro AI.
** One or the other is required
** If both are given, [filter] takes priority over id=
** The AI contains an implicit filter for units on the AI side. Thus, if all AI units are to be selected, an empty [filter] tag can be used.
** If several units match the filter, the order in which they are controlled is not guaranteed. If the order matters, set up several MAIs using the id= key and different values for ca_score=.
* '''waypoint_x,waypoint_y''': Comma-separated lists of the waypoint coordinates through which the patrol travels (in order). {{DevFeature1.15|0}} '''waypoint_loc''' can be used instead with named/special locations.

'''Optional keys:'''

* '''attack''': By default (if this key is not set), the patrol unit attacks any unit it ends up next to after a move, or that is within '''attack_range''' (see below). Alternatively, this parameter can be set to a comma-separated list of unit ids. If that is done, the patrol only attacks these units when it ends up next to them or if it gets within attack_range. It ignores any other unit. This can in turn be used to have the patroller not attack at all, by setting ''attack='' to a non-existing id. The exception to this is an enemy on the last waypoint with ''one_time_only=yes'', which will always be attacked.
* '''attack_range'''=1: {{DevFeature1.15|12}} If the patrol comes within this many hexes of an enemy unit, it interrupts its patrol route and attacks that enemy (assuming it still has enough movement left to get to the enemy). The '''attack=''' instructions are taken into account for this. Note that the patrol generally tries to move around enemies, which means that for the default value of 1, enemies are usually not within attack range, except at the end of the move.
* '''attack_invisible_enemies'''=no: {{DevFeature1.15|12}} If set to 'yes', the unit also attacks invisible enemies (according to the criteria set by '''attack''' and '''attack_range''').
* '''ca_score'''=300000: (non-negative integer) The evaluation score of the candidate action controlling this Micro AI. By default, it is set to 300,000, which is higher than any of the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|RCA AI candidate actions]]. By setting it, for example, to 170,000, we can have it be executed after the default recruitment CA, but before most of the other default CAs.
* '''one_time_only'''=no: (boolean) If set to 'yes', the unit goes through the patrol route only once and then hangs out at the last waypoint. It also always attacks any enemy unit on the last waypoint, independent of what ''attack='' is set to.
* '''out_and_back'''=no: (boolean) By default, a patrol unit returns to the first waypoint after reaching the last, doing the patrol route as a loop. If this parameter is set to 'yes', the unit instead reverses its course and perpetually does out and backs of the route.

Here's an example of [micro_ai] tag usage from the "Patrols" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=2
ai_type=patrol
action=add

[filter]
id=Konrad
[/filter]
waypoint_x=9,24,25
waypoint_y=21,23,15
one_time_only=yes
attack=Gertburt
[/micro_ai]

== Protect Unit Micro AI (ai_type=protect_unit) ==

The Protect Unit Micro AI tries to move one or several units to a given location while keeping them safe from enemy attacks. It does so by keeping the protected units away from enemy units and close to friendly units. Other units on the AI side are controlled by the default Wesnoth AI.

For a demonstration, check out the "Protect Unit" and "The Elves Besieged" scenarios from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Enable the Protect Unit Micro AI by using
ai_type=protect_unit
in the [micro_ai] tag.

===Protect Unit specific keys for the [micro_ai] tag:===

'''Required keys:'''

* '''[unit]''': A separate [unit] tag is required for each protected unit(s). Each tag has required keys '''id''', '''goal_x''', '''goal_y''' for each unit, as shown in the example below. {{DevFeature1.15|0}} '''goal_loc''' can be used instead with a named/special location.

'''Optional keys:'''

* '''disable_move_leader_to_keep'''=no: (boolean) If set to 'yes', side leaders protected by this AI do not try to return to their keep. This is necessary for this Micro AI to work with units that are side leaders and that are supposed to move to an off-keep location.

'''Notes:'''
*The Protect Unit Micro AI modifies the [[AiWML#Filtering_Combat_with_the_attacks_Aspect|attacks aspect]]. Depending on the parameters, it might also modify the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|move leader to keep candidate action]].
* The CA evaluation scores of this AI are hard-coded. It does not work otherwise.

Here's an example of [micro_ai] tag usage from the "HttT: The Elves Besieged" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=1
ai_type=protect_unit
action=add

[unit]
id=Delfador
goal_x,goal_y=1,2
[/unit]
[unit]
id=Konrad
goal_x,goal_y=1,1
[/unit]

disable_move_leader_to_keep=true
[/micro_ai]

== Recruiting Micro AI==
=== General Comments on the Recruiting Micro AIs ===

The Recruiting Micro AI replaces the default recruitment AI by alternative recruiting patterns. Currently there are two recruiting algorithms you can choose from, random recruiting and the rush recruiting used in the new (as of Version 1.11.1) Experimental AI (see below).

For a demonstration of a different recruiting pattern, check out the "Recruiting" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]. You can also explore the unit choices by watching the Experimental AI in a multiplayer game.

'''Note:''' Obviously, the Recruitment Micro AI modifies the [[RCA_AI#The_Candidate_Actions_.28CAs.29_of_the_main_loop_Stage_in_the_RCA_AI|recruitment candidate action]].

=== Random Recruitment AI (ai_type=recruit_random) ===

This AI randomly selects a unit type from the recruitment list of the side. The probability of choosing each type and the behavior in low-gold situations can be influenced with optional parameters.

Enable the Random Recruiting Micro AI by using
ai_type=recruit_random
in the [micro_ai] tag.

'''Required keys:'''

There are no required keys.

'''Optional keys:'''

* '''ca_score'''=180000: (non-negative integer) The evaluation score of the candidate action controlling this Micro AI. By default, it is set to 180,000. This is identical to the default Recruiting CA which it replaces.
* '''[probability]''': This tag sets the probability of selecting the given unit type. It has two required sub-keys:
** '''type''': comma-separated list of unit types to which this probability is to be applied
** '''probability''': (non-negative float) The probability with which these unit types is to be selected. All unit types for which no [probability] tag is defined receive a default probability of 1.0, thus values should be chosen relative to that. As an example, in the code below swordsmen and peasants are given a probability of 8, while no other units have assigned probabilities. Thus, each of these two unit types is 8 times more likely to be selected than any other individual unit type.
* '''skip_low_gold_recruiting'''=no: (boolean) By default, the random recruitment AI chooses a unit to recruit only from those types for which it has sufficient gold. If this parameter is set to 'yes', it will instead choose from all available unit types and end recruiting for the turn if there is not enough gold to recruit it this turn (even if other, affordable unit types exist).

Here's an example of a random recruiting [micro_ai] tag usage from the "Recruiting" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=1
ai_type=recruit_random
action=add

[probability]
type=Swordsman,Peasant
probability=8
[/probability]

skip_low_gold_recruiting=yes
[/micro_ai]

=== Rush Recruitment AI (ai_type=recruit_rushers) ===

This AI replaces the default recruiting with the recruiting used in the Experimental AI [[Experimental_AI#Recruitment|as described here]].

Enable the Rush Recruiting Micro AI by using
ai_type=recruit_rushers
in the [micro_ai] tag.

'''Required keys:'''

There are no required keys.

'''Optional keys:'''

* '''ca_score'''=180000: (non-negative integer) The evaluation score of the candidate action controlling this Micro AI. By default, it is set to 180,000. This is identical to the default Recruiting CA which it replaces.
* {{DevFeature1.15|2}} '''high_level_fraction'''=0: (non-negative number) The approximate fraction of units of level 2 or higher to be recruited. This is defined as fraction of units on the map, not of new units being recruited during a turn or over several turns (which makes a difference if there are already units on the map). The effect is also cumulative per level (starting from level 2), meaning that 1/3 of L2 units will be recruited in the example above, 1/3*1/3=1/9 L3s etc. The default value is zero, which leaves the high-level unit recruiting to the default Experimental AI algorithm resulting usually in very few such units being recruited.
* '''randomness'''=0.1: (number) A random number is applied to the rusher recruit engine's score to prevent the recruitment pattern from being too predictable. 0 causes no randomness to be applied, while larger numbers increase the random effect. A value of 1-2 generates results in which the random effect is approximately equal to the scored effect. Extremely high values are essentially entirely random.
* {{DevFeature1.17|6}} '''reset_cache_each_turn'''=no: (bool) Many of the operations of the rush recruitment evaluation are expensive and are therefore cached. For the most part, this cache can be kept from turn to turn, but in case there are events that change, for example, the map or the recruit list, this parameter can be set to 'yes' to force a reset of the cache each turn.

Here's an example of a rush recruiting [micro_ai] tag usage from the "Recruiting" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]:
[micro_ai]
side=1
ai_type=recruit_rushers
action=add
[/micro_ai]

== Regroup Micro AI (ai_type=regroup) ==

{{DevFeature1.19|26}}

Note: this Micro AI is experimental, and might change significantly in the future.

This Micro AI commands its side's units to retreat when badly outnumbered, reducing the default AI's aggressiveness and tendency to attack into impossible odds. It prefers retreating towards its leader, and prefers engaging enemies near its leader. Specific features are detailed in the "optional keys" section.

This Micro AI is not necessarily stronger than the default AI (although it can be in some situations) but rather aims to create more back-and-forth gameplay with a stronger day/night cycle, as well as better-protected leaders. Many of its parameters are calibrated around the typical single-player scenario; for example, it weighs its own units as less valuable than the player's.

This Micro AI does not make attacks (except for the always_attack_at_turn_end key explained below), and as such is unaffected by most default AI aspects - except for the [avoid] tag, which is respected. However, in concert with this MAI, the default Wesnoth AI generally performs well with the AI aspects listed below, although for best performance it's still recommended to tune AI aspects to each scenario and map:
* '''leader_value=0''': High leader value makes it easy to bait the AI around by repositioning your leader. Especially abusable with fast or teleporting leaders.
* '''village_value=0.1''': Villages are important, but less so for singleplayer AIs (who often have high base income). High village value can also cause army units to target far-away villages instead of defending our leader.
* '''scout_village_targeting=30''': village_value=0.1 lowers village_value for army units, but we don't want to lower the scout village value - scouts should still contest villages.
* '''grouping=no''': Regular grouping, if combined with this Micro AI, can sometimes cause the AI to behave too cautiously.
* '''aggression=0.9''': When this Micro AI lets the default AI control a unit near enemies, it does so because it's expecting to attack. Low aggression can sometimes result in the default AI commanding units to hang around doing nothing, or to flee to an obviously-unsafe village.

===Regroup specific keys for the [micro_ai] tag===

'''Required keys:'''

There are no required keys, although setting retreat_tod is recommended for most applications.

'''Optional keys:'''

* '''retreat_tod''' (string): This Micro AI will always retreat when badly outnumbered (e.g. 4-to-1 odds), but can also be configured to prioritize retreating at certain times of day. The following values are allowed:
** '''daytime''': Useful when the AI's units are chaotic and/or its opponents are lawful.
** '''nighttime''': Useful when the AI's units are lawful and/or its opponents are chaotic.
** '''none''': (default) Never prioritize retreating.

* '''[filter_retreat_target]''': A Standard Unit Filter describing the unit(s) to retreat towards, and near which to prioritize engaging enemies. Defaults to all same-side leaders.

* '''[filter_guards]''': A Standard Unit Filter describing guard units, with an implicit filter for units on the AI side. When an enemy enters a guard's attack range, the guard uses the same attack/retreat logic as the rest of this micro_ai when deciding how to respond. If the guard decides to retreat or has no enemies in its attack range, it remains on / returns to its stationed hex. A guard's stationed hex is set when this micro_ai first runs: the guard's goto_x,goto_y if one is set, or else the guards starting location. Guards will also help capture low-threat enemy or neutral villages.

* '''leader_protect_radius'''=3: (non-negative integer) When enemies are within this radius of any friendly leader (including ally side leaders) or a [filter_retreat_target] target, this Micro AI will never attempt to retreat from them, no matter how poor the odds. Within this radius, retreating units also priorize good terrain and bodyblocking enemies more than usual. If leader_prudence=yes, this radius also influences (in combination with many other factors) how far each leader is willing to move.

* '''leader_prudence'''=yes: (boolean) By default, this Micro AI will try to prevent its leader(s) from moving into dangerous situations, but will still allow it to move and attack when somewhat safe. Leaders with lots of gold, income, or nearby units are especially cautious, while leaders with nothing to lose are more willing to attack. This is intended to be a middle ground between the default leader AI (very reckless) and passive_leader=yes (never moves or attacks). If this option is set to 'no', this behavior is disabled.

* '''leader_frustration'''=yes: (boolean) By default, this Micro AI tries to discourage XP farming by tracking how badly outnumbered its leader is. If badly outnumbered for several consecutive turns (for example, if its recruits are all killed before getting a chance to act), the frustrated leader will be willing to attack much more aggressively than usual. When this happens, this Micro AI fires the `name=leader_frustrated` event. If this option is set to 'no', this behavior is disabled.

* '''always_attack_at_turn_end'''=yes: (boolean) The default AI will sometimes move low-hp units adjacent to an enemy but not attack, since the low-hp units would be likely to die. This both looks stupid and makes it easy for the player to distibute XP. By default, this Micro AI will always force non-leader units to attack if they would otherwise have ended their turn adjacent to an enemy and not on a village.

== Simple Attack Micro AI (ai_type=simple_attack) ==

The Simple Attack Micro AI is meant as an addition to the default combat candidate action for when one wants to force the AI to do attacks that it would otherwise not do (for example on units that are 1 XP from leveling) or to execute certain attacks before all others (for example, attack with all "expendable" units first). It is not set up to be a replacement for the default attacks. Some notes:

* The algorithm is different from and simpler than that of the default combat CA. For example, no attack combinations are considered, only individual attacks. As a result, the [[AiWML#List_of_AI_Aspects|default aspects]] (aggression, caution, [avoid], ...) are not taken into account. Also, if lots of units are involved, evaluation of this Micro AI is potentially quite a bit slower than of the default attacks.

* If an attack matching the Standard Unit Filters described below is found, this attack will always be executed, no matter how bad the odds are. Thus, this Micro AI can be used to force the AI to do attacks it would otherwise avoid.

* Other than selecting the attacker/defender units, this AI is currently not configurable. Let us know if you would like to see certain options to be added. (No guarantees that we will add them, but we will definitely consider them.)

For a demonstration, check out the "Simple Attack" scenario from the [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

Enable the Simple Attack Micro AI by using
ai_type=simple_attack
in the [micro_ai] tag.

===Simple Attack specific keys for the [micro_ai] tag===

'''Required keys:'''

There are no required keys. It is, however, in general not desirable to use this AI without at least one of the optional Standard Unit Filters below, as this AI is not meant as a replacement of the default combat candidate action.

'''Optional keys:'''

* '''ca_score'''=110000: (non-negative integer) The evaluation score of the candidate action controlling this Micro AI. By default, it is set to 110,000, which means that it is executed right before the default combat candidate action.
* '''[filter]''': A [[StandardUnitFilter|Standard Unit Filter]] selecting the units of the AI side participating in the Simple Attack action. It defaults to all units of the side. The filter automatically includes the side= key set to the AI side.
* '''[filter_second]''': A [[StandardUnitFilter|Standard Unit Filter]] selecting the units the AI should attack. It defaults to all enemy units. The filter automatically includes a [[StandardSideFilter|Standard Side Filter]] set to all enemies of the AI side.
* '''weapon'''=-1: (integer) The number of the weapon that should be used for this attack. Weapon numbers start at 1 (not 0). -1 stands for "best weapon" (by whatever criterion the AI chooses to use). '''Available from Wesnoth 1.11.8'''

Below are 2 examples of Simple Attack Micro AI configurations from the "Simple Attack" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]]. The first one shows how to force the AI to attack with all Soulless and Walking Corpse units first:
[micro_ai]
side=2
ai_type=simple_attack
action=add

ca_score=110000
[filter]
type=Soulless,Walking Corpse
[/filter]
[/micro_ai]

The second example executes attacks by Soulless on all enemy units that are 1 XP from leveling. Note that the Lua code in the preload event is there simply in order to code the "1 XP from advancing" condition. It is not needed for most other SUFs, as can be seen in the previous example.
[event]
name=preload
first_time_only=no
[lua]
code=<<
function close_to_advancing(unit)
if (unit.experience >= unit.max_experience-1) then
return true
else
return false
end
end
>>
[/lua]
[/event]

[event]
name=prestart
[micro_ai]
side=2
ai_type=simple_attack
action=add

ca_score=110001
[filter]
type=Soulless # No Walking Corpses; L0 units don't advance enemy
[/filter]
[filter_second]
lua_function = "close_to_advancing"
[/filter_second]
[/micro_ai]
[/event]
Several Simple Attack Micro AIs can be combined for the same AI side. The two examples above are both used (note the different values for ca_score) in the "Simple Attack" [[Micro_AIs#Micro_AI_Test_and_Demo_Scenarios|test scenario]].

== Custom Micro AIs ==

{{DevFeature1.13|5}}

From 1.13.5 onwards, adding a new Micro AI can be easily done without altering any core files or overriding the micro_ai tag. The [micro_ai] tag now looks up its ''ai_type'' parameter in the <code>wesnoth.micro_ais</code> table and uses the micro AI setup function found there to determine which keys are required and allowed and what candidate actions to add.

A micro AI setup function takes as its single parameter the contents of the [micro_ai] tag and returns three separate values:
*'''required''': A list of required keys and tags, as strings. Tags are indicated by enclosing them within square brackets in the string. If a key or tag in this list is missing from the [micro_ai] tag, an error will be printed. {{DevFeature1.17|6}} In order to enable better error handling, the syntax of this table has been changed. It is now of format <syntaxhighlight lang='lua' inline>{ param1 = 'param1_type', ... }</syntaxhighlight>. The supported parameter types can be found at the link to examples below.
*'''optional''': Similar to above, a list of optional keys and tags, as strings. No error will be printed if a key or tag in this list is missing, nor will an error be printed if it is present (as would be the case for unrecognized keys or tags). {{DevFeature1.17|6}} The format of this table has been changed in the same way as for 'required'. Also, a warning message is now issued if the '[micro_ai]' tag contains a key or tag that is not listed in either 'required' or 'optional'.
*'''ca_params''': A table specifying the candidate actions that constitute the micro AI. It should contain an ''ai_id'' key (which specifies a base ID to be used for candidate actions of this micro AI) and a series of candidate action definitions. Each candidate action definition is a table containing the following keys:
**'''ca_id''': The ID used for the candidate action. This will be combined with the ''ai_id'' to produce the final ID.
**'''location''': Path to the Lua file that defines the candidate action.
**'''score''': The maximum score for the candidate action. If the [micro_ai] tag specified a ''ca_score'' parameter, the score here should normally be based on that.

(The return statement would thus look like <syntaxhighlight lang='lua' inline>return required, optional, ca_params</syntaxhighlight>.)

'''Examples''' of micro AI setup functions can be found in the [https://github.com/wesnoth/wesnoth/tree/1.14/data/ai/micro_ais/mai-defs default MAI definitions directory]. See the [https://github.com/wesnoth/wesnoth/blob/1.14/data/ai/micro_ais/mai-defs/animals.lua#L4-L12 Big Animals MAI definition] for a simple example. For custom micro AIs, the setup code should be put into a ''[lua]'' tag inside a preload event.

Since the function has full access to the contents of the [micro_ai] tag, it can conditionally add candidate actions to '''ca_params''' depending on the values of other keys within the [micro_ai] tag. It can also perform other actions such as adding facets to an aspect; if it does such things, it should pay attention to the ''action'' key to determine whether it's being added or removed.

There are two useful helper functions that can be used by Micro AI setup functions requiring aspect changes. They can be brought into scope by a line similar to the following:
<syntaxhighlight lang='lua>local MAIH = wesnoth.require("ai/micro_ais/micro_ai_helper.lua")</syntaxhighlight>
* MAIH.add_aspects(side, aspect_params)
* MAIH.delete_aspects(side, aspect_params)

The ''aspect_params'' parameter is an array of tables, each of which contains the following keys:
*'''aspect''': The aspect to change.
*'''facet''': The WML defining the facet. This must include an ''id'' key in order for the aspect to be correctly deleted. For maximum compatibility, incorporate the ''ca_id'' key from the [micro_ai] tag.

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

1.19 Roadmap

2026-04-28T18:12:33Z

Dalas120:

This page is for consolidating and planning when new features and fixes are intended to land in the 1.19 development branch. The release schedule for Development releases can be found [https://forums.wesnoth.org/viewtopic.php?f=2&t=52785 here (link is to the 1.17 page, might change for 1.19)].

== Instructions ==
Place the feature or fix you intend to implement within the section of the point release that you intend to have it implemented by, as well as your forum username in parenthesis after the feature description. The point release something is planned to be released with is not set in stone, and can be updated as needed depending on the circumstances.

This is just an outline currently, with some point releases for the early, middle and late parts of the branch.

== Note on Single-Player Campaign Reworks ==

We have some campaign reworks planned and in-progress.

* In-hiatus: The Rise of Wesnoth
* In-progress but slower development: Legend of Wesmere (still Hybrid), Asheviere's Dogs (AD)
* post-development: SotBE revisions

The other three might be going into 1.21.x so have been mentioned here just to prepare for an unprecedented development allowances (more assistance in coding, accelerated development speed, etc).

If you have inquiries on the reworks, contact SP rework team leaders (forums/discord):
* Dalas (TSG/TDG/HttT)
* Dwarftough/Mechanical (LoW)
* Gweoddeoran (TRoW)
* LK (SotBE)

New Campaigns added in

* The South Guard: Tutorial
* The Deceivers Gambits, Parts I and II
* Dusk of Dawn
* Heir to the Throne (Revised)

Revised Campaigns:

* Liberty
* The Hammer of Thursagan
* Sceptre of Fire
* Under the Burning Suns

== 1.19.0 (05/26/2024) ==
* Move the Dunefolk into Default Era (Pentarctagon) - completed in #8688

== 1.19.1 (06/16/2024) ==
* [https://github.com/wesnoth/wesnoth/pull/6826 #6826] Merge hardware accelerated unit submerge effect, if possible (Pentarctagon)
** Completed in [https://github.com/wesnoth/wesnoth/pull/8687 #8687].

== 1.19.2 (07/21/2024) ==
* Finish adding ability/weapon special unit tests (Pentarctagon)
* Release tentative TSG re-revision add-on, building on Yumi's work (Dalas)
** Depending on reception, additional development may be needed, or the rework may be dropped altogether.
** If all goes well, some months from now I'll need to convert this from add-on to mainline so translators can begin work.

== 1.19.3 (08/18/2024) ==
* Investigate replacing mariadbpp with Boost.MySql (Pentarctagon)

== 1.19.4 (09/15/2024) ==
* Release final (hopefully) TDG add-on. Collect feedback and fix bugs (Dalas)
** If all goes well, some months from now I'll need to convert this from add-on to mainline so translators can begin work.

== 1.19.5 (10/20/2024) ==
* [https://github.com/wesnoth/wesnoth/pull/6512 #6512] New type of deprecation warning, when a deprecated attribute is used alongside its replacement (octalot)
* [https://github.com/wesnoth/wesnoth/pull/7082 #7082] Get wmllint running against mainline during CI with no errors (Pentarctagon)
* GUI2 port of the Help Browser (LumiousE/babaissarkar, CelticMinstrel)
** Completed in [https://github.com/wesnoth/wesnoth/pull/3653 #3653]

== 1.19.6 (11/17/2024) ==

== 1.19.7 (12/15/2024) ==
* Unified recruit/recall dialog (LumiousE/babaissarkar) (related issues: [https://github.com/wesnoth/wesnoth/issues/1059 1059], [https://github.com/wesnoth/wesnoth/issues/8829 8829], [https://github.com/wesnoth/wesnoth/issues/5237 5237])
** Completed in [https://github.com/wesnoth/wesnoth/pull/9499 #9499]

== 1.19.8 (01/19/2025) ==

* [https://github.com/wesnoth/wesnoth/issues/8585 #8585], [https://github.com/wesnoth/wesnoth/issues/9035 #9035] Solve all issues with [damage_type] (octalot)
* Go through all the added translatable strings, and check that they're used. For example, look for campaign-specific abilities which aren't used in the campaign. This is on the roadmap twice, I'm planning to do it annually. (octalot, but open to volunteers)

== 1.19.9 (02/16/2025) ==
* Release first half of HttT revision and gather feedback, fix bugs, etc (Dalas)
** This is a VERY rough release date. Probably +/- 2 months.

== 1.19.10 (03/16/2025) ==
* [https://github.com/wesnoth/wesnoth/issues/5041 #5041] Draw text on images in [[IntroWML]], useable for place-name labels on the journey-tracker maps (octalot)
* Add "pseudo-queues" as a built-in feature for the multiplayer lobby (pentarctagon)

== 1.19.11 (04/20/2025) ==

== 1.19.12 (05/18/2025) ==
* Improve UtBS. (Hejnewar) This includes:
** Removal and replacement of some abilities, mainly hero ones.
** Better accomodation of high level units to the new recall system.
** Difficulty of Nightmare+.
** Changes to some maps and scenarios, mainly in order to make them more fluid.
* Mercenaries SP/MP campaign (still didn't give up) (Hejnewar) This includes:
** New pixelart terrains and backgrounds (particularily tough for someone without pixelart skills).
* Balance (Hejnewar)
* New MP maps and scenarios. (Hejnewar) This includes:
** New short survival.
** Recovery of long lost mapmaking art.
** New PvP and PvPvE maps, including experimental scenarios with events.

== 1.19.13 (06/15/2025) ==
* Establish clear direction on weather graphics (doofus-01)

== 1.19.14 (07/20/2025) ==

== 1.19.15 (08/17/2025) ==
* Play through any remaining mainline campaigns worth playing through (ie: not LoW, TRoW or SotBE) and add at least a minimum baseline of achievements to them (Pentarctagon)
* Replace TDG's current magic system with an improved and more developer-friendly version (amakriLexa04)

== 1.19.16 (09/21/2025) ==

== 1.19.17 (10/19/2025) ==
* Release second half of HttT revision and gather feedback, fix bugs, etc (Dalas)
** This is a VERY rough release date. Probably +/- 3 months.
** If all goes well, some months from now I'll need to convert this from add-on to mainline so translators can begin work.

== 1.19.18 (11/16/2025) ==

== 1.19.19 (12/21/2025) ==

== 1.19.20 (01/18/2026) ==
* Go through all the added translatable strings, and check that they're used. For example, look for campaign-specific abilities which aren't used in the campaign. (octalot, but open to volunteers)
* Take a serious look at supporting a competitive mode/ELO ranking natively (pentarctagon)

== 1.19.21 (Beta 1) (02/15/2026) ==
'''This marks the beginning of the feature freeze and string freeze for 1.19;''' the only API changes made past this point must be to fix bugs.

== 1.19.22 (Beta 2) (03/15/2026) ==

== 1.19.23 (Beta 3) (04/19/2026) ==

== 1.19.24 (RC1) (delayed until Fall 2026; formerly 05/17/2026) ==
'''This marks the beginning of the API freeze;''' no API changes for for any reason can be made at this point. Additional RC releases will be done as needed.

* Add new screenshots for 1.20

== 1.20.0 (delayed until Fall 2026; formerly 06/21/2026) ==

[[Category:Roadmaps]]

TerrainMaskWML

2026-04-27T21:44:41Z

Dalas120: Add documentation for [terrain_mask] mask_file key

{{WML Tags}}

The '''[terrain_mask]''' tag makes map manipulation from within WML much easier.
It uses a Wesnoth map as a "mask" over a given location,
placing it down on top of the scenario map.
Fog ('_f') and Shroud ('_s') are used like alpha in an image; i.e. they cause the previous terrain to be used.

* '''x,y''': the x,y location in the scenario map to place the top-left corner of the mask onto. Important note: if 'border=yes (default)' and alignment is unset, then (x,y) will not denote the place of the top-left corner but rather of the place of the location (1,1) of the mask data (the top left corner of the 'inner' part of the mask). So the top-left corner of the mask will be placed at (x-1,y-1) or (x-1,1).
* '''mask''': a Wesnoth map; see [[BuildingMaps]].
* '''mask_file''': path to a file containing Wesnoth map data. Overrides '''mask'''.
* '''border''': (default=yes) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored. {{DevFeature1.15|1}} the '''border''' key is only used if '''alignment''' is empty/invalid.
* '''ignore_special_locations''': (default=no) By default, any special location names given in the mask will be added to the map, allowing them to be used for [[StandardLocationFilter|filtering by location_id]]. Setting this to 'yes' prevents that.
<ul><li>'''alignment''': (falls back to '''border''' if empty/invalid) ({{DevFeature1.15|1}}, leaving out this key will fallback to 1.12 behaviour). possible values '''even''', '''odd''' or '''raw''', describes how the data in 'mask' is aligned, there is the even alignment (this is what the map editor produces thus you usually want to use `aligment=even`):
<pre>
__/10\__/30\
/00\__/20\__/
\__/11\__/31\
/01\__/21\__/
\__/12\__/32\
/02\__/22\__/
\__/ \__/
</pre>
and the odd alignment, (used by old mask files in wesnoth 1.10 and older):
<pre>
/00\__/20\__
\__/10\__/30\
/01\__/21\__/
\__/11\__/31\
/02\__/22\__/
\__/12\__/32\
\__/ \__/
</pre>
. Using '''raw''' will assume the map data is aligned in the same way as the map square that starts at (x,y)</li>
<li>{{anchor|rule|'''[rule]'''}}: specifies a rule for blending the mask with the scenario.<br>
The terrain on each hex fitting the rule will be changed to the terrain specified in the rule.
* '''old''': a comma-separated list of terrain codes. The rule fits only those hexes that have one of these terrains in the scenario. If omitted, matches any hex on the base map.
* '''new''': a list of terrain letters. The rule fits only those hexes with this terrain specified in the mask. If omitted, matches any hex on the mask.
* '''terrain''': the letter of the terrain to change hexes which fit this rule (i.e. for which the '''new''' terrain code in the mask falls on top of the '''old''' terrain in the scenario) into. If omitted, defaults to either the old or new terrain depending on the value of use_old.
* '''layer''': (overlay|base|both, default=both) only change the specified layer.
* '''replace_if_failed''': (default=no) When replacing just one layer failed, try to replace the whole terrain. If '''terrain''' is an overlay only terrain, use the default_base as base layer. If the terrain has no default base, do nothing.
* '''use_old''': if yes, no change is done to hexes matching this rule. If no, the hex is changed to the new terrain or, if specified, the value of the terrain key.</li></ul>

As an example, suppose you want to lay down a road somewhere. You could specify by hand the path the road takes using
[terrain], or you could use
[terrain_mask]:

<pre>
[terrain_mask]
x,y=12,10
mask="border_size=1
usage=map

Re, Re, _f, _f, _f, _f, _f, _f, _f, _f, _f, _f
Re, Re, _f, _f, _f, _f, _f, _f, _f, _f, _f, _f
Re, Re, _f, _f, _f, _f, _f, _f, _f, _f, _f, _f
_f, _f, Re, _f, _f, _f, _f, _f, _f, _f, _f, _f
_f, _f, Re, _f, _f, _f, _f, _f, _f, _f, _f, _f
Re, Re, _f, _f, _f, _f, _f, _f, _f, _f, _f, _f
_f, _f, Re, _f, _f, Re, Re, _f, _f, _f, _f, _f
_f, _f, _f, Re, Re, Re, _f, Re, Re, _f, _f, _f
_f, _f, _f, _f, _f, _f, _f, Re, _f, _f, _f, _f
_f, _f, _f, _f, _f, _f, _f, Re, Re, _f, _f, _f
_f, _f, _f, _f, _f, _f, _f, Re, Re, Re, Re, Re
_f, _f, _f, _f, _f, _f, _f, Re, Re, Re, Re, Re
"
[/terrain_mask]
</pre>

For instance, suppose you want snow to fall in an area. You want villages on green grass (Gg^Vh) to turn into snowy villages on snow (Aa^Vha), pine forest on semi-dry grass (Gs^Fp) to turn into snowy pine forest on snow (Aa^Fpa), hills (Hh) to turn into snowy hills (Ha), and green grass (Gg) and regular dirt (Re) to turn into snow (Aa), while other terrain remains untouched. You could look over your destination map and work out which terrain type is which and draw your mask, but that's a lot of effort, you want to just draw a simple mask which has areas of snow and areas of no snow, and make the game work out the rest.

You can do it like this:

[terrain_mask]
x,y=1,1
mask="border_size=1
usage=map

_f, _f, Aa, _f, _f, _f, Aa, _f, _f
_f, _f, Aa, _f, _f, _f, Aa, _f, _f
_f, _f, Aa, _f, Aa, _f, Aa, _f, _f
Aa, Aa, _f, _f, Aa, Aa, Aa, _f, _f
_f, _f, Aa, Aa, Aa, Aa, Aa, Aa, Aa
_f, _f, _f, Aa, Aa, Aa, Aa, Aa, Aa
_f, _f, _f, _f, Aa, Aa, _f, _f, _f
_f, _f, _f, _f, Aa, Aa, _f, _f, _f"
[rule]
old=Gg^Vh
new=Aa
terrain=Aa^Vha
[/rule]
[rule]
old=Gs^Fp
new=Aa
terrain=Aa^Fpa
[/rule]
[rule]
old=Hh
new=Aa
terrain=Ha
[/rule]

[rule]
old=Gg,Re
new=Aa
#don't specify terrain and it just uses the new terrain
[/rule]

#default: Will match everything, since 'old' and 'new' aren't
#specified. Set 'use_old=yes' to signal no change.
[rule]
use_old=yes
[/rule]
[/terrain_mask]

Timeline of Wesnoth

2025-07-03T16:02:11Z

Dalas120:

{{Translations}}
This is a official chronological history of the country of Wesnoth and surrounding regions, gleaned from written accounts and verbal histories passed down through the generations. Portions of entries surrounded by parentheses and containing a question mark are assumed or unconfirmed information. The history is sorted by era, and within the era by date, using the Foundation of Wesnoth as a base. BW=Before Wesnoth, YW=Years Wesnoth. They function the same way as BC and AD do in our timekeeping system. Each of the eras is summarized before the timeline for that era begins. This history of the Great Continent is a subject of active scholarship.

The world that Wesnoth resides in is called Irdya. Before the Great Fall and the (unchronicled) technological age, this name is only rarely used.

''This page documents the official, canon timeline, as based on the mainline campaigns. UMC specific info should be in its own pages and should not be here.''

'''Spoiler warning!'''
This page contains plot spoilers to several campaigns.

__NOTOC__
[[#Prehistory - 20 YW: The Founding of Wesnoth|The Founding of Wesnoth]]

[[#20-130 YW: The Taming of the Wild|The Taming of the Wild]]

[[#200-350 YW: The Golden Age of Wesnoth|The Golden Age of Wesnoth]]

[[#350-417 YW: The First Dark Age of Wesnoth|The First Dark Age of Wesnoth]]

[[#417-530 YW: The Turmoil of Asheviere|The Turmoil of Asheviere]]

[[#530-630 YW: The Age of Fear|The Age of Fear]]

[[#628-673 YW: The Silver Age of Wesnoth|The Silver Age of Wesnoth]]

[[#761-816 YW: The Legacy of Black-Eye Karun|The Legacy of Black-Eye Karun]]

[[#After the Great Fall|After the Great Fall]]

== Prehistory - 20 YW: The Founding of Wesnoth ==
During the age of the Founding of Wesnoth, there were two important geographic locations, these being the Green Isle and the Great Continent. Haldric is the main historical figure at this time. This age ends with the founding of Wesnoth as a country in the Great Continent, and with orcs attacking both elves and men from the sea.

=== Prehistory ===
* Elves and dwarves inhabit the Great Continent.
* Humans inhabit the distant West.
* Haldric's people colonise the [[Geography_of_Wesnoth#The_Green_Isle|Green Isle]] from a continent further to the west.

=== 200 BW ===
* The Lich-Lords arrive on the Green Isle after losing a war in the distant West.
* After a long war Haldric's people come to dominate the Green Isle.
* The 'Wesfolk' and their Lich-Lords are pushed onto marginal lands.

=== 12 BW ===
* The Crown Prince of Southbay discovers the Great Continent.

=== 11-7 BW ===
* The Crown Prince makes several voyages between the Green Isle and the Great Continent.

=== 6 BW ===
* Following these voyages to the Great Continent, the elder Crown Prince falls ill and dies.
* His younger brother is implicated in a plot to kill him.
* As a distraction the younger Prince starts a war with the Wesfolk and their Lich-Lords.
* The Lich-Lords sense they will be destroyed and open gates to the homeland of the orcs in the West.

=== 5-2 BW ===
* The Green Isle is overrun with orcs.
* The Wesfolk desert their Lich-Lords as they fear becoming prey for the orcs.
* [[CharactersStorys#Prince_Haldric|Prince Haldric]] leads the evacuation of the survivors to the Great Continent. [[Mainline_Campaigns#The_Rise_of_Wesnoth|'''The Rise of Wesnoth''']] begins.

=== 1 BW ===
* Human settlers, led by Prince Haldric, arrive at the western coast of the Great Continent (the landfall occurs in the future Bay of Pearls) in large numbers.
* Humans arrive in the middle of a simmering dispute between the elves and dwarves.
* The elves and dwarves are distrustful of humans, and there is a small skirmish.
* Messengers from Wesmere Forest come and ask Haldric to come before the Ka'lian.
* Prince Haldric asks the Four elvish Lords ([[CharactersStorys#Lady_Dionli|Dionli]], [[CharactersStorys#Lord_Logalmier|Logalmier]], [[Aryad]], and [[El'Isomithir]]) for help and land.
* They set before him four quests to prove his worth, which he completes.

=== 1 YW ===
* [[CharactersStorys#Prince_Haldric|Haldric]] is granted the plains north and south of the Great River.
* Haldric agrees to a Pact of Mutual Defence with the elves, but the Ka'lian decides it will betray him and allow humans and orcs to exhaust each other in war if the opportunity presents. Haldric, learning of this, considers the Pact a dead letter.
* The Ruby of Fire is temporarily hidden, and the [[CharactersStorys#Lich-Lord_Jevyan|lich-lord Jevyan]] is deceived into believing it is held by the elves.
* Haldric founds the country of [[Geography_of_Wesnoth#Wesnoth|Wesnoth]] in the central plain south of the great River.
* Reign of Haldric I (formerly prince Haldric) begins. [[Mainline_Campaigns#The_Rise_of_Wesnoth|'''The Rise of Wesnoth''']] ends.

=== 2 YW ===
* Orcs, following the ships fleeing from the Green Isle, begin to arrive on the Great Continent.
* These orcs are defeated by Haldric's forces.
* Some of the orcish survivors flee back to the Green Isle, others move to attack the elves.
* King Haldric helps the elves fight the surviving orcs.

=== 3 YW ===
* [[Mainline_Campaigns#Winds_of_Fate|'''Winds of Fate''']] begins.
* Drakes arrive on the Great Continent.
* Elensefar and Wesmere are raided by Drakes.
* The drakes build an eyrie north of Wesmere.

=== 4 YW ===
* [[CharactersStorys#Karron|Karron]] is banished from the Great Continent by [[CharactersStorys#Gorlack|Gorlack]]. [[Mainline_Campaigns#Winds_of_Fate|'''Winds of Fate''']] ends.

=== 8 YW ===
* A second wave of orcs arrive from the Green Isle; these orcs begin claiming large portions of the northern Great Continent for themselves.
* [[CharactersStorys#Erlornas|Erlornas]] of Wesmere is involved in the first direct elvish clash with orcs ([[Mainline_Campaigns#An_Orcish_Incursion|'''An Orcish Incursion''']] takes place in 8-9YW).
* Haldric I publicly repudiates the Pact he spoke with the elves, refusing to give aid. <ref>{{Cite|treaty}}</ref>

=== 9-11 YW ===
* Many elves are killed in battle by the orcs.
* Elvish emissaries are turned away from Wesnoth.

=== 12 YW ===
* Orcs fail to take the Wesmere Forest and instead march down the coast, devastating human settlements there.
* Elves refuse to aid the humans in confronting the orcs.
* Human refugees from the coastal settlements relocate in what will become known as the Great Central Plain. Dan'Tonk, which will become Wesnoth's largest city, is founded.

=== 20 YW ===
* [[CharactersStorys#Prince_Haldric|Haldric I]] dies.
* [[CharactersStorys#Haldric_II|Haldric II]] ascends to the throne.
* [[CharactersStorys#Kalenz_2|Kalenz]] and [[CharactersStorys#Landar|Landar]] escape an orcish invasion of their home in Lintanir Forest. [[Mainline_Campaigns#Legend_of_Wesmere|'''The Legend of Wesmere''']] begins.
* Humans and elves decisively defeat the orcs at Tath, thus halting the orcish advance.
* A new treaty between humans and elves is signed and King Haldric II allows emissaries of the elves to return to Wesnoth.
* Elves inform [[CharactersStorys#Haldric_II|Haldric II]] of the danger posed by the unshielded Ruby of Fire.
* [[CharactersStorys#Kalenz_2|Kalenz]] and [[CharactersStorys#Landar|Landar]], later to become successive High Lords of the Elves, are able to sneak into an orcish camp by stealth and assassinate the Great Chief Brurbar. A long orcish civil war for succession follows. The orcs are unable to undertake action against any other race during this period and Wesnoth enjoys a long period during which it can expand with little opposition.

== 20-130 YW: The Taming of the Wild ==
This era is that in which the kingdom of [[Geography_of_Wesnoth#Wesnoth|Wesnoth]] expanded and defined its borders, and settled the area which it had claimed for its own. The Taming of the Wild refers to the settling of the unsettled lands, as well as to the colonization of the Northlands. The end of this era is marked by friction between the city-state of [[Geography_of_Wesnoth#Elensefar|Elensefar]] and the country of Wesnoth, which will continue for the next several hundred years.

=== 21 YW ===
* Founding of the Great Academy on Alduin.

* [[CharactersStorys#Kalenz|Kalenz]] is relieved of command by the Ka'lian. He retires to Lintanir Forest with [[CharactersStorys#Cleodil|Cleodil]]. A faction of xenophobic elves begins to gather around [[CharactersStorys#Landar|Landar]].

=== 22 YW ===
* While studying at the Academy, [[CharactersStorys#Ardonna_.2F_Ardryn-Na|Ardonna]] resolves to spend the winter researching the Lich Lords' longevity.

=== 23 YW ===
* Action of '''Secrets of the Ancients''' takes place.

=== 25-40 YW ===
* In 25 YW [[CharactersStorys#Haldric_II|Haldric II]] sends an expedition to retrieve the Ruby of Fire from its place of concealment.
* Haldric II commissions a dwarven tribe to build the Sceptre of Fire with the Ruby of Fire as its centerpiece; elves associated with [[CharactersStorys#Landar|Landar's]] faction attack during the transfer. [[Mainline_Campaigns#The_Sceptre_of_Fire|'''Sceptre of Fire''']] begins.
* Action of '''The Sceptre of Fire''' takes place. Haldric II is informed that the Sceptre was both completed and lost in the year 40. It will not be recovered for nearly 500 years.
* With the death of [[CharactersStorys#Thursagan|Thursagan]], the Runemaster, all runemasters are killed and runesmithing is lost for several centuries.<ref>{{Cite|reclaiming}}</ref>

=== 26-50 YW ===
* [[CharactersStorys#Landar|Landar]] declares himself High Lord of the Elves, leading to civil war.

=== 51 YW ===
* Wesnothian New Writing (the script later called "steel-hand", to distinguish it from the more complex "brush-hand" cursive brought from the [[Geography_of_Wesnoth#The_Green_Isle|Green Isle]]) is promulgated by royal decree. From this date all royal documents and public inscriptions are in New Writing. It spreads rapidly via the mercantile class. The older brush-hand writing continues to be used for magical purposes, scholarship, and in certain elevated literary forms.

=== 50-93 YW ===
* Elvish civil war (and [[Mainline_Campaigns#Legend_of_Wesmere|'''The Legend of Wesmere''']]) ends. [[CharactersStorys#Kalenz_2|Kalenz]] declared High Lord, begins reorganizing and militarizing elvish society to fight the orcs. In late 93 YW he cedes control to a reconstituted Ka'lian and retires again to the Forest of Lintanir.

=== 161-164 YW ===
* The newly crowned king sought to make safe once and for all the wildlands that separated the human cities surrounding Weldyn and the coastal regions of [[Elensefar]].
* The grand army of Wesnoth, personally led by the High Council of Archmagi, destroyed all enemies residing within Wesnoth.
* The city-state of Elensefar is formally united to the kingdom. Settlements from it spread north of the river into the new frontier province of Annuvin, carefully avoiding the margins of Wesmere Forest.

=== 164-176 YW ===
* During this twelve year span, the western fortress of Halstead was erected in the very heart of the western wilderlands.

=== 199 YW ===
* Emboldened by the far-reaching arm of Halstead's protection, settlement in the west explodes
* The settlements of Aldril and Carcyn grow to become major cities, the first as an important port due to its position on the Bay of Pearls, and the second as a stop on the road to Elensefar and military outpost along the Great River
* Settlers from Carcyn cross the Great River to establish the first settlements north of it and east of Wesmere.

== 200-350 YW: The Golden Age of Wesnoth ==
The Golden Age of Wesnoth was the time of the great kings, and of peace and prosperity within the kingdom. The orcs had suffered a grave defeat at the hands of Wesnoth and Elensefar seventy-five years earlier, so they did not pose much of a threat, and whenever they did attack they were quickly defeated. This allowed the army to lessen in size, and the kings of this age to undertake the great public works they are renowned for. The era ends when the king of Wesnoth dies without an heir, and a new dynasty begins.

=== 251 YW ===
* [[CharactersStorys#Cleodil|Cleodil]], wife of [[CharactersStorys#Kalenz_2|Kalenz]], dies.

=== 350 YW ===
* Disintegration of the Kingdom follows the death of Haldric IV.
* [[Geography_of_Wesnoth#Elensefar|Elensefar]] remains a province of Wesnoth but exerts increasing independence due to isolation.
* Treaty between lord of Elensefar and king of Wesnoth signed.

== 350-417 YW: The First Dark Age of Wesnoth ==
The first Dark Age was a time of strife and invasion. When Haldric IV died, he left Wesnoth without a king, and the next 70 years were marked by short-lived dynasties, attacks by ever more aggressive orcs, and the further separation of Wesnoth and Elensefar. The Dark Age ended when Garard I took the throne, and began a new dynasty that would last for several hundred years.

=== 360 YW ===
* [[CharactersStorys#Malin_Keshar|Malin Keshar]] born in Parthyn.

=== 363 YW ===
* Last of [[CharactersStorys#Kalenz|Kalenz's]] children dies. Kalenz, condemned to outlive his offspring by the potion of Crelanu, leaves the Forest of Lintanir and begins wandering the Great Continent.

* Village of Maghre terrorized by a minor necromancer. Action of [[Mainline_Campaigns#A_Tale_Of_Two_Brothers|'''A Tale of Two Brothers''']] takes place.

=== 389 YW ===
* Garard, a future king of Wesnoth, is born.
* [[CharactersStorys#Malin_Keshar|Malin Keshar]] returns to Parthyn from the Academy at Alduin. [[Mainline_Campaigns#Descent_into_Darkness|'''Descent Into Darkness''']] begins.

== 417-530 YW: The Turmoil of Asheviere ==
King Garard's dynasty was long-lived and productive, but it was also punctuated by significant turmoil: the end of the first king's reign was marred by orcish and undead raids, and the second was murdered by his own wife and son. It was not until 517 YW that the usurpation of the throne by Queen Mother Asheviere was ended.

=== 417 YW ===
* Ending years of strife and division, Garard I seizes the throne and becomes king of Wesnoth, beginning the [[Garardine Dynasty]].

=== 439 YW ===
* [[CharactersStorys#Garard_II|Crown Prince Garard II]] is born.

=== 442 YW ===
* Prince Arand is born.

=== 448 YW ===
* [[CharactersStorys#Delfador|Delfador]], later called "the Great", is born.

=== 465 YW ===
* The South Guard reports increased bandit activity. Prince Arand sends Deoran and a company of soldiers to investigate. '''The South Guard''' begins.

=== 466 YW ===
* Hostile forces besiege Westin, but are repulsed. '''The South Guard''' ends.
* Displeased with Deoran's performance, Garard II assigns him as ambassador to Lintanir forest — a far-away posting.

=== 470 YW ===
* Garard I dies; [[CharactersStorys#Garard_II|Garard II]] ascends to the throne of Wesnoth
* Garard II marries Asheviere.

=== 476 YW ===
* Garard II founds Fort Garard and prepares to invade the Whitefang orcs.
* Delfador and Deoran join Garard's army. '''The Deceiver's Gambit I''' begins.

=== 478 YW ===
* More orcish clans and a saurian tribe join Garard's war. Garard II is ambushed and nearly killed, but retreats to Fort Garard. '''The Deceiver's Gambit I''' ends.
* Control of the Estmarks is effectively lost during this war, not to be regained for decades. Outposts are built on the near side of the Weldyn to repel orc raids. The long watch of the River Guard begins.

=== 479 YW ===
* A series of bloody battles at the Ford of Abez end in deadlock. The ford is heavily fortified, and river commerce grinds to a halt.
* Crown Prince Eldred is born.

=== 498 YW ===
* Princess Li'sar is born.
* Delfador, now the king’s premier war-mage, leads an attack behind enemy lines. '''The Deceiver's Gambit II''' begins.

=== 500 YW ===
* Prince Konrad is born, the youngest of several sons of Prince Arand.

=== 501 YW ===
==== The End of the War ====
* Delfador learns that a necromancer — Iliah-Malal — has been manipulating the Wesnoth-orc war.
* Delfador slays Iliah-Malal and defeats an orcish army at the Ford of Abez, ending the Wesnoth-orc war.

==== The Fall of Garard ====
* Eldred attacks Prince Arand — his uncle — at Fort Garard, but is repulsed.
* Eldred blames the attack on Arand, claiming that Arand has started a rebellion.
* Garard II sends Delfador to put down Arand's revolt. Delfador kills Arand. Fort Garard is destroyed.
* Eldred betrays Garard II — his father — and kills him. Deoran and Delfador are blamed. Deoran dies.
* Delfador gathers a force of loyalists to avenge Garard II's death. Delfador confronts Eldred's forces on the road to Weldyn.
* Delfador's forces are defeated, but Eldred is slain by Delfador in the fight. '''The Deceiver's Gambit II''' ends.

==== The Rise of Asheviere ====
* Asheviere orders the slaughter of Garard's nephews and declares herself Queen of Wesnoth. '''Asheveire's Dogs''' begins.
* Baron De Ferres rallies a force of nobles to oppose Asheviere.
* Asheviere allies with orcs from numerous clans, promising them gold in return for loyalty.
* Delfador and the elf Parandra infiltrate the palace at Weldyn, but come too late to save Garard's nephews from death.
* Delfador and Parandra find an orphaned human child. Parandra and Delfador agree to give the orphan the identity of Prince Konrad.
* Asheviere conquers Soradoc, Tath, and Dan'Tonk. Baron De Ferres is slain. '''Asheveire's Dogs''' ends.

==== The Western Reaches ====
* Elensefar refuses to submit to Asheviere and declares itself an independent city-state.
* After several defeats, Wesnoth's army retreats from the remote areas of the kingdom. The western Wesnothian border recedes, is fixed, and remains heavily defended.
* As a result of the loyalist withdrawal, several small human communities on the west coast of the Great Continent live in relative independence while elves flourish in the great forest to the southwest of Wesnoth.
* A band of Wesnoth citizens organizes resistance to Asheviere's siezure of power. They are eventually forced to abandon their home and settle in the Three Sisters ('''Liberty''').

=== 502-517 YW ===
* Delfador raises Konrad in the Aethenwood, under the protection of elves.
* Elensefar, Blackwater Port, and the Aethenwood conspire to keep Wesnoth's western reaches free from Asheviere's influence.

=== 517 YW ===
* Asheviere launches a major attack on Elensefar, Blackwater Port, and the Aethenwood.
* Konrad and Delfador flee the Aethenwood and embark upon a quest to regain the throne of Wesnoth. '''Heir To The Throne''' begins.

=== 518 YW ===
* Konrad crosses the Great River into the Northlands on a search for the Sceptre of Fire.
* They enter the Caves of Knalga, find it, and ally with Princess Li'sar.
* They return to Wesnoth and claim the throne. '''Heir to the Throne''' ends.

=== 522 YW ===
* Birth of Princess Ana'sar.

=== 530 YW ===
* Wesnothian colonists begin reclaiming the Estmarks.

=== 544 YW ===
* With both sides of the lower Weldyn River again civilized territory, the River Guard posts south of Soradoc are abandoned. Wesnothian military activity shifts eastward into the Estmarks.

== 530-630 YW: The Age of Fear ==
The Age of Fear takes its names from the events of the end of the era. On the surface, the first 77 years were very uneventful for the kingdom of Wesnoth. However, during this time unexplainable magical events took place, especially in the eastern lands. Previously tamed lands were slowly claimed by wilderness as fear and paranoia gradually overshadowed the spirit of pioneering and adventure displayed earlier in Wesnoth's history. In the last 10 years of the age, Wesnoth bore the brunt of the most powerful undead attack ever and was nearly destroyed. By the end of the era, most of Wesnoth had been made barren, most of the great buildings inside and outside of Weldyn were razed, and the population of Wesnoth was half of what it had been.

It was in this era that certain areas of the chaotic Northlands were for the first time put into any kind of law and order. A small group of humans and dwarves, accepting anyone of any race who wished to join, formed themselves into the "Northern Alliance”, with the vision of making the Northlands safe to live in. Over time, this alliance grew slowly but steadily in power. By the end of the era, the alliance had succeeded in making a few small areas, including Knalga and the surrounding regions, stable and prosperous. Consequently, many people evacuated from the wasteland that most of Wesnoth had become and moved north - depleting the population of Wesnoth still further.

=== 533 YW ===
* Delfador succumbs to old age and dies, his body is entombed alongside his staff in Eregonor.
* The next great sage of Wesnoth, [[CharactersStorys#Dacyn|Dacyn]], is born.

=== 534 YW ===

* The small community of Dwarven Doors, in the Northlands just outside Knalga, rebels against the orcish overlords. '''Northern Rebirth''' begins.
* The residents, led by Tallin, head underground and find dwarves, whom they ally with.
* Their combined forces destroy a lich who is attempting to claim Knalga as his own.
* Abhai finds the [[CampaignDialogue:NR#Abhai_Finds_Rod_of_Justice|Rod of Justice]].

=== 535 YW ===

* The warlord-aspirant Rakshas attacks Tallin and his forces, but does not penetrate the dwarves' defences.
* To help defeat the orcs, Tallin secures the help of two Liches, and rescues an elvish princess to secure the help of the elves.
* Assisted by his new allies, Tallin smashes the forces of Rakshas.
* According to some historians, Tallin and the elvish princess are married; others say they parted in bad blood.
* To preserve the new-found peace in the Northlands, Tallin and his allies form the Northern Alliance. '''Northern Rebirth''' ends.

=== 550 YW ===

* Lord Hamel of Knalga sends an expedition to Kal Kartha to determine the fate of the Hammer of Thursagan ('''The Hammer of Thursagan''' takes place in late 550 YW to early 551 YW.).
* Dwarves at Knalga and elsewhere begin to reclaim the lost art of runesmithing.
* Wesnothian colonization expands southward past Fort Tahn.

=== 563 YW ===
* Konrad and Li'sar die after an extraordinarily long reign.
* Princess Ana'sar becomes queen.
* The seer Galdren becomes prominent at the court of Weldyn.

=== 585 YW ===
* Queen Ana'sar retires.
* Haldric VII becomes king of Wesnoth.

=== 589 YW ===
* Dacyn the White Mage and Ravanal, an eastern wizard, compete to be the king's advisor.
* The seer Galdren dies after advising Haldric VII to choose Dacyn.
* The king does as Galdren advises.

=== 593 YW ===
* Ravanal reveals that he has turned to evil, and flees from Weldyn.
* Konrad II is born.
* Certain southern frontier regions are formally annexed to the Kingdom of Wesnoth as the Province of Kerlath.

=== 612 YW ===
* Haldric VII dies. Konrad II is crowned King of Wesnoth.
* Dacyn continues his duties as advisor with Konrad II.

=== 625 YW ===
* Mysterious disappearances of livestock and peasants cause partial evacuation of the the '''Estmark Hills'''. Lords of the Horse Plains report increased banditry from there.
* Konrad II sends [[CharactersStorys#Dacyn|Dacyn]] with [[CharactersStorys#Owaec|Owaec]] and [[CharactersStorys#Gweddry|Gweddry]] to man the old River Guard strongpoints. [[Mainline_Campaigns#The_Eastern_Invasion|'''Eastern Invasion''']] begins.

=== 626 YW ===
* [[CharactersStorys#Mal-Ravanal|Mal-Ravanal]] attacks the southern outpost where [[CharactersStorys#Gweddry|Gweddry]] and [[CharactersStorys#Dacyn|Dacyn]] are stationed.
* Dacyn and Gweddry travel to the northern outpost, and, with [[CharactersStorys#Owaec|Owaec]], retreat into the northlands.
* In the Far North, the wife of Kai Laudiss slain in a large raid by the orcs of Tirigaz on Jotha
* Kai Laudiss slain by poisoned orcish dart during failed attack on the Port of Tirigaz orcs. His son, [[CharactersStorys#Kai_Krellis|Krellis]] succeeds him as Kai and relies on the wisdom of [[CharactersStorys#Cylanna|Cylanna]], a priestess.
* The merfolk city of Jotha is overrun by undead (Mal Kevek and others). The action of [[Mainline_Campaigns#Dead_Water|'''Dead Water''']] takes place.

=== 627 YW ===
* Wesnoth's last defences are broken and the undead march on Wesnoth
* In the northlands, the orcs drive [[CharactersStorys#Gweddry|Gweddry's]] army back across the river.
* Weldyn is besieged.
* Gweddry breaks through undead lines to reach Weldyn and a council is held.
* Gweddry's army is fortunate and kills [[CharactersStorys#Mal-Ravanal|Mal-Ravanal]]. [[Mainline_Campaigns#The_Eastern_Invasion|'''Eastern Invasion''']] ends. [[Mainline_Campaigns#Dead_water|'''Dead Water''']] ends (about this time).
* Wesnoth is saved, but large portions have been laid waste by the undead.
* After destroying [[CharactersStorys#Mal-Ravanal|Mal-Ravanal's]] henchmen the mermen relaxed and began rebuilding in earnest, and soon Jotha was restored.

== 628-673 YW: The Silver Age of Wesnoth ==

The Silver Age, or restoration of the Wesnothian kingdom, essentially coincides with the rest of the long and successful reign of [[CharactersStorys#Konrad_II|Konrad II]]. During this period Wesnoth largely recovered from the damage that Mal-Ravanal's undead attack had done. It would, however, never quite regain the majesty it had at the height of its power.

The Northlands, aided by a second wave of colonization north from Wesnoth, become more civilised and stable. Although nowhere near as prosperous as Wesnoth was during its Golden Age, the Northlands developed towns of significant size and a thriving - if somewhat dangerous - trade network.

Four major powers soon came to dominate much of the Northlands. First there were the dwarves, who controlled most of the mountains and a vast array of underground tunnels and caverns. To the east, shrouded in mystery, lay the elvish forests which continued to be inaccessible to anyone not of elvish blood. The remaining landscape was dominated either by orcish tribes, or independent human earldoms. As competition for the land grew fierce, wars smoldered between human and orcish forces.

=== 628-635 YW ===
* [[CharactersStorys#Konrad_II|Konrad II]] begins his attempt to rebuild Wesnoth.

=== 673 YW ===
* [[CharactersStorys#Konrad_II|Konrad II]] dies, bringing the [[Garardine Dynasty]] to an end. Second Wesnothian civil war begins.

== 786-826 YW: The Legacy of Black-Eye Karun ==

After decades of struggle, Black-Eye Karun becomes the first warlord since the assassination of Great Chief Brurbar in 20 YW to unite all the different squabbling orcish tribes under his banner. Among his many accomplishments as a Sovereign, his most famous is the creation of the Great Council.

Karun was a far-sighted individual and he knew that after his death the orcish tribes would once again turn to fighting among themselves, with little he could do to prevent that and consequent peril from the Wesnothians and elves.

Consequently, Karun selected from among all the different tribes six of the most sober and wisest orcs and thus created the Great Council. It was the Great Council's job to stay aloof from any tribal or territorial squabbling amongst the orcs, but yet always remain there to give advice to whomever came to seek it. In order to preserve the orcish race in the event of an emergency, he invested in them the power to call up The Great Horde. It was established that every orc, no matter what tribe he came from, must obey the summons of The Great Horde and follow wholeheartedly the leader that the Great Council put at the head of The Great Horde.

===786 YW===
* Karun is born.

===805 YW===
* Karun devised the formation of the Great Council.

===811 YW===
* A border dispute between Karun and a human enclave aligned with the Northern Alliance leaves several men and orcs dead and begins a feud that will grow into a fifteen-year war.

===812 YW===
* Rahul I becomes Lord Protector of the Northern Alliance.

===816 YW===
* [[CharactersStorys#Kapou.27e|Kapou’e]] is born

===826 YW===
* Rahul I (Lord Protector of the Northern Alliance) and Black Eye Karun sign a peace treaty ending a 15 year war between the humans and the orcs. Soon after this Karun, is ambushed and killed in mysterious circumstances.

===829 YW===
* Frustrated by the fallout of Karun's supposed assassination, Rahul I resigns, and Howgarth III takes his place as Lord Protector.

===842 YW===
* Famine in the Northlands. Famine led humans to colonize some orcish lands and push orcs into desolated hill country. The few orcish tribes who had remained part of the Alliance, feeling the pressure, either left Alliance territory or revolted and were destroyed.
* Retaliating, the orcs systematically slaughtered human colonies and villages on their lands. Then, Earl Lanbec'h — the most powerful human warlord of the North — determined to abolish the orcish menace raised an army and conferred leadership of it to his son-in-law Baron Alber.
* In response, the Great Council set up by the Black Eye Karun calls upon The Great Horde and bestows leadership of it upon [[CharactersStorys#Kapou.27e|Kapou’e]]; [[Mainline_Campaigns#Son_of_the_Black_Eye|'''Son of the Black Eye''']] begins.

===843 YW===
* Half of the Great Council is treacherously slain by the allied human forces and orcish unity disintegrates. Faced with the extermination of all the orcs on the Great Continent, [[CharactersStorys#Kapou.27e|Kapou’e]] forcibly asserts his control over the orcish territories and defeats the enemy forces. The Northern Alliance arrives on the scene in time for the final battle and helps Kapou’e defeat the forces of the northern earldoms, who had broken the treaty. Kapou’e then assumes the position of Sovereign over the northern tribes, and his rule ushers in an unprecedented era of unity and prosperity for the orcs.
* After 843: Portions of Kapou'e's army act as mercenaries in foreign struggles with other races which keeps them from attacking their nearest neighbors.

===852 YW===
* [[CharactersStorys#Kapou.27e|Kapou’e]] repels a large elvish invasion.

===858 YW===
* The humans once again stage an invasion but prove to be no match for the united orcish forces under the leadership of [[CharactersStorys#Kapou.27e|Kapou’e]]. [[Mainline_Campaigns#Son_of_the_Black_Eye|'''Son of the Black Eye''']] ends.

==After the Great Fall==
At some unknown point in the future, an unspeakable cataclysm scorched the surface of the lands. The Wesnoth magicians try to raise up a 3rd sun in the sky, Gaia, but they fail and the 'sun' falls down over Weldyn. The capital is no more. The King and his family are dead and there is no heir. The local leaders tear apart Wesnoth. The nights become longer, days hotter. Evil creatures show up. Forests die, hills turn into rocky wastelands and fields become barren deserts. In the apocalypse allies turn against each other and friends fight over what few resources remain. The great nations were destroyed, and huge numbers of people died. Still amidst the chaos somehow small groups of people survived, sheltered in hidden places. In this post-apocalyptic world survival is a daily struggle as a few remaining tribes eke out an existence among the ruins of fallen empires. Heroic bands of elves, nomadic refugee humans, savage hordes of orcs and dark necromancers all forge new lives under the merciless dual suns, Sela and Naia, of this new Irdya.

===??? Post-Wesnoth===

* The Quenoth elves adapt to life in barren world of the Great Southern Desert. Over time they lost their affinity for the woodlands of their ancestry and embrace life in the sandy wastelands.
* Under the leadership of Tanuil, the Quenoth elves build and sustain a fortified village around a rare oasis. The village thrives amidst the hostilities of the desert.
* One night, a meteor storm rains from the sky and destroys the village of the Quenoth elves. '''Under the Burning Suns''' begins. The next day, Tanuil, like many others, is missing and presumed dead. Kalehssar (Kaleh), nephew of Tanuil, takes leadership of the remaining Quenoth elves as the surviving next of kin.
* Kaleh, heeding the voice of his god Eloh in his dreams, gathers the remaining Quenoth elves and leads them north to a new promised land, foregoing rebuilding of their desert village.
* The Quenoth elves battle their way north through undead, orcs, bandits and other evil, venturing underground beneath a large mountain range at the command of Eloh.
* Befriending unexpected allies underground, Kaleh's forces survive to the other side of the mountain.
* Keratur, son of Tanuil and survivor of the cataclysm, insane with fright attacks Kaleh. Kaleh defeats Keratur.
* Kaleh defies commands given him by a vision of Eloh.
* The Quenoth reach the ocean. Aided by merfolk, they escape the mainland and head for a newly discovered island, a place where the Quenoth may settle in peace.
* On the island, the Quenoth confront Yechnagoth, the Eater of Souls and impersonator of Eloh. Yechnagoth and army are destroyed by the Quenoth.
* Kaleh and the elves settle on their newfound, and newly named, Quenoth Isle. '''Under the Burning Suns''' ends.

== History Credits ==
Timelined by Kamahawk and Turin. Revised to incorporate material from later version of Legend of Wesmere and reconcile different versions of the history of the Sceptre of Fire by Eric S. Raymond.

* History derived from the following [[Mainline_Campaigns|mainline campaigns]]:
** [[The Rise of Wesnoth]]
** [[Legend of Wesmere]]
** [[A Tale of Two Brothers]]
** [[Descent into Darkness]]
** [[Delfador's Memoirs]]
** [[Liberty]]
** [[Heir to the Throne]]
** [[Northern Rebirth]]
** [[The Hammer of Thursagan]]
** [[TheEasternInvasion|Eastern Invasion]]
** [[Dead Water]]
** [[UnderTheBurningSuns|Under the Burning Suns]]

== See Also ==

* [[Geography of Wesnoth]]
* [[Poetry of Wesnoth]]
* [[Races]]
* [[FactionHistory|History of various factions]]
* [[Future History]] '''(unofficial)'''

[[Category:World of Wesnoth]]
[[Category:History]]

Timeline of Wesnoth

2025-07-03T15:58:51Z

Dalas120: Update timeline to reflect 1.19's new The South Guard and The Deceiver's Gambit

{{Translations}}
This is a official chronological history of the country of Wesnoth and surrounding regions, gleaned from written accounts and verbal histories passed down through the generations. Portions of entries surrounded by parentheses and containing a question mark are assumed or unconfirmed information. The history is sorted by era, and within the era by date, using the Foundation of Wesnoth as a base. BW=Before Wesnoth, YW=Years Wesnoth. They function the same way as BC and AD do in our timekeeping system. Each of the eras is summarized before the timeline for that era begins. This history of the Great Continent is a subject of active scholarship.

The world that Wesnoth resides in is called Irdya. Before the Great Fall and the (unchronicled) technological age, this name is only rarely used.

''This page documents the official, canon timeline, as based on the mainline campaigns. UMC specific info should be in its own pages and should not be here.''

'''Spoiler warning!'''
This page contains plot spoilers to several campaigns.

__NOTOC__
[[#Prehistory - 20 YW: The Founding of Wesnoth|The Founding of Wesnoth]]

[[#20-130 YW: The Taming of the Wild|The Taming of the Wild]]

[[#200-350 YW: The Golden Age of Wesnoth|The Golden Age of Wesnoth]]

[[#350-417 YW: The First Dark Age of Wesnoth|The First Dark Age of Wesnoth]]

[[#417-530 YW: The Turmoil of Asheviere|The Turmoil of Asheviere]]

[[#530-630 YW: The Age of Fear|The Age of Fear]]

[[#628-673 YW: The Silver Age of Wesnoth|The Silver Age of Wesnoth]]

[[#761-816 YW: The Legacy of Black-Eye Karun|The Legacy of Black-Eye Karun]]

[[#After the Great Fall|After the Great Fall]]

== Prehistory - 20 YW: The Founding of Wesnoth ==
During the age of the Founding of Wesnoth, there were two important geographic locations, these being the Green Isle and the Great Continent. Haldric is the main historical figure at this time. This age ends with the founding of Wesnoth as a country in the Great Continent, and with orcs attacking both elves and men from the sea.

=== Prehistory ===
* Elves and dwarves inhabit the Great Continent.
* Humans inhabit the distant West.
* Haldric's people colonise the [[Geography_of_Wesnoth#The_Green_Isle|Green Isle]] from a continent further to the west.

=== 200 BW ===
* The Lich-Lords arrive on the Green Isle after losing a war in the distant West.
* After a long war Haldric's people come to dominate the Green Isle.
* The 'Wesfolk' and their Lich-Lords are pushed onto marginal lands.

=== 12 BW ===
* The Crown Prince of Southbay discovers the Great Continent.

=== 11-7 BW ===
* The Crown Prince makes several voyages between the Green Isle and the Great Continent.

=== 6 BW ===
* Following these voyages to the Great Continent, the elder Crown Prince falls ill and dies.
* His younger brother is implicated in a plot to kill him.
* As a distraction the younger Prince starts a war with the Wesfolk and their Lich-Lords.
* The Lich-Lords sense they will be destroyed and open gates to the homeland of the orcs in the West.

=== 5-2 BW ===
* The Green Isle is overrun with orcs.
* The Wesfolk desert their Lich-Lords as they fear becoming prey for the orcs.
* [[CharactersStorys#Prince_Haldric|Prince Haldric]] leads the evacuation of the survivors to the Great Continent. [[Mainline_Campaigns#The_Rise_of_Wesnoth|'''The Rise of Wesnoth''']] begins.

=== 1 BW ===
* Human settlers, led by Prince Haldric, arrive at the western coast of the Great Continent (the landfall occurs in the future Bay of Pearls) in large numbers.
* Humans arrive in the middle of a simmering dispute between the elves and dwarves.
* The elves and dwarves are distrustful of humans, and there is a small skirmish.
* Messengers from Wesmere Forest come and ask Haldric to come before the Ka'lian.
* Prince Haldric asks the Four elvish Lords ([[CharactersStorys#Lady_Dionli|Dionli]], [[CharactersStorys#Lord_Logalmier|Logalmier]], [[Aryad]], and [[El'Isomithir]]) for help and land.
* They set before him four quests to prove his worth, which he completes.

=== 1 YW ===
* [[CharactersStorys#Prince_Haldric|Haldric]] is granted the plains north and south of the Great River.
* Haldric agrees to a Pact of Mutual Defence with the elves, but the Ka'lian decides it will betray him and allow humans and orcs to exhaust each other in war if the opportunity presents. Haldric, learning of this, considers the Pact a dead letter.
* The Ruby of Fire is temporarily hidden, and the [[CharactersStorys#Lich-Lord_Jevyan|lich-lord Jevyan]] is deceived into believing it is held by the elves.
* Haldric founds the country of [[Geography_of_Wesnoth#Wesnoth|Wesnoth]] in the central plain south of the great River.
* Reign of Haldric I (formerly prince Haldric) begins. [[Mainline_Campaigns#The_Rise_of_Wesnoth|'''The Rise of Wesnoth''']] ends.

=== 2 YW ===
* Orcs, following the ships fleeing from the Green Isle, begin to arrive on the Great Continent.
* These orcs are defeated by Haldric's forces.
* Some of the orcish survivors flee back to the Green Isle, others move to attack the elves.
* King Haldric helps the elves fight the surviving orcs.

=== 3 YW ===
* [[Mainline_Campaigns#Winds_of_Fate|'''Winds of Fate''']] begins.
* Drakes arrive on the Great Continent.
* Elensefar and Wesmere are raided by Drakes.
* The drakes build an eyrie north of Wesmere.

=== 4 YW ===
* [[CharactersStorys#Karron|Karron]] is banished from the Great Continent by [[CharactersStorys#Gorlack|Gorlack]]. [[Mainline_Campaigns#Winds_of_Fate|'''Winds of Fate''']] ends.

=== 8 YW ===
* A second wave of orcs arrive from the Green Isle; these orcs begin claiming large portions of the northern Great Continent for themselves.
* [[CharactersStorys#Erlornas|Erlornas]] of Wesmere is involved in the first direct elvish clash with orcs ([[Mainline_Campaigns#An_Orcish_Incursion|'''An Orcish Incursion''']] takes place in 8-9YW).
* Haldric I publicly repudiates the Pact he spoke with the elves, refusing to give aid. <ref>{{Cite|treaty}}</ref>

=== 9-11 YW ===
* Many elves are killed in battle by the orcs.
* Elvish emissaries are turned away from Wesnoth.

=== 12 YW ===
* Orcs fail to take the Wesmere Forest and instead march down the coast, devastating human settlements there.
* Elves refuse to aid the humans in confronting the orcs.
* Human refugees from the coastal settlements relocate in what will become known as the Great Central Plain. Dan'Tonk, which will become Wesnoth's largest city, is founded.

=== 20 YW ===
* [[CharactersStorys#Prince_Haldric|Haldric I]] dies.
* [[CharactersStorys#Haldric_II|Haldric II]] ascends to the throne.
* [[CharactersStorys#Kalenz_2|Kalenz]] and [[CharactersStorys#Landar|Landar]] escape an orcish invasion of their home in Lintanir Forest. [[Mainline_Campaigns#Legend_of_Wesmere|'''The Legend of Wesmere''']] begins.
* Humans and elves decisively defeat the orcs at Tath, thus halting the orcish advance.
* A new treaty between humans and elves is signed and King Haldric II allows emissaries of the elves to return to Wesnoth.
* Elves inform [[CharactersStorys#Haldric_II|Haldric II]] of the danger posed by the unshielded Ruby of Fire.
* [[CharactersStorys#Kalenz_2|Kalenz]] and [[CharactersStorys#Landar|Landar]], later to become successive High Lords of the Elves, are able to sneak into an orcish camp by stealth and assassinate the Great Chief Brurbar. A long orcish civil war for succession follows. The orcs are unable to undertake action against any other race during this period and Wesnoth enjoys a long period during which it can expand with little opposition.

== 20-130 YW: The Taming of the Wild ==
This era is that in which the kingdom of [[Geography_of_Wesnoth#Wesnoth|Wesnoth]] expanded and defined its borders, and settled the area which it had claimed for its own. The Taming of the Wild refers to the settling of the unsettled lands, as well as to the colonization of the Northlands. The end of this era is marked by friction between the city-state of [[Geography_of_Wesnoth#Elensefar|Elensefar]] and the country of Wesnoth, which will continue for the next several hundred years.

=== 21 YW ===
* Founding of the Great Academy on Alduin.

* [[CharactersStorys#Kalenz|Kalenz]] is relieved of command by the Ka'lian. He retires to Lintanir Forest with [[CharactersStorys#Cleodil|Cleodil]]. A faction of xenophobic elves begins to gather around [[CharactersStorys#Landar|Landar]].

=== 22 YW ===
* While studying at the Academy, [[CharactersStorys#Ardonna_.2F_Ardryn-Na|Ardonna]] resolves to spend the winter researching the Lich Lords' longevity.

=== 23 YW ===
* Action of '''Secrets of the Ancients''' takes place.

=== 25-40 YW ===
* In 25 YW [[CharactersStorys#Haldric_II|Haldric II]] sends an expedition to retrieve the Ruby of Fire from its place of concealment.
* Haldric II commissions a dwarven tribe to build the Sceptre of Fire with the Ruby of Fire as its centerpiece; elves associated with [[CharactersStorys#Landar|Landar's]] faction attack during the transfer. [[Mainline_Campaigns#The_Sceptre_of_Fire|'''Sceptre of Fire''']] begins.
* Action of '''The Sceptre of Fire''' takes place. Haldric II is informed that the Sceptre was both completed and lost in the year 40. It will not be recovered for nearly 500 years.
* With the death of [[CharactersStorys#Thursagan|Thursagan]], the Runemaster, all runemasters are killed and runesmithing is lost for several centuries.<ref>{{Cite|reclaiming}}</ref>

=== 26-50 YW ===
* [[CharactersStorys#Landar|Landar]] declares himself High Lord of the Elves, leading to civil war.

=== 51 YW ===
* Wesnothian New Writing (the script later called "steel-hand", to distinguish it from the more complex "brush-hand" cursive brought from the [[Geography_of_Wesnoth#The_Green_Isle|Green Isle]]) is promulgated by royal decree. From this date all royal documents and public inscriptions are in New Writing. It spreads rapidly via the mercantile class. The older brush-hand writing continues to be used for magical purposes, scholarship, and in certain elevated literary forms.

=== 50-93 YW ===
* Elvish civil war (and [[Mainline_Campaigns#Legend_of_Wesmere|'''The Legend of Wesmere''']]) ends. [[CharactersStorys#Kalenz_2|Kalenz]] declared High Lord, begins reorganizing and militarizing elvish society to fight the orcs. In late 93 YW he cedes control to a reconstituted Ka'lian and retires again to the Forest of Lintanir.

=== 161-164 YW ===
* The newly crowned king sought to make safe once and for all the wildlands that separated the human cities surrounding Weldyn and the coastal regions of [[Elensefar]].
* The grand army of Wesnoth, personally led by the High Council of Archmagi, destroyed all enemies residing within Wesnoth.
* The city-state of Elensefar is formally united to the kingdom. Settlements from it spread north of the river into the new frontier province of Annuvin, carefully avoiding the margins of Wesmere Forest.

=== 164-176 YW ===
* During this twelve year span, the western fortress of Halstead was erected in the very heart of the western wilderlands.

=== 199 YW ===
* Emboldened by the far-reaching arm of Halstead's protection, settlement in the west explodes
* The settlements of Aldril and Carcyn grow to become major cities, the first as an important port due to its position on the Bay of Pearls, and the second as a stop on the road to Elensefar and military outpost along the Great River
* Settlers from Carcyn cross the Great River to establish the first settlements north of it and east of Wesmere.

== 200-350 YW: The Golden Age of Wesnoth ==
The Golden Age of Wesnoth was the time of the great kings, and of peace and prosperity within the kingdom. The orcs had suffered a grave defeat at the hands of Wesnoth and Elensefar seventy-five years earlier, so they did not pose much of a threat, and whenever they did attack they were quickly defeated. This allowed the army to lessen in size, and the kings of this age to undertake the great public works they are renowned for. The era ends when the king of Wesnoth dies without an heir, and a new dynasty begins.

=== 251 YW ===
* [[CharactersStorys#Cleodil|Cleodil]], wife of [[CharactersStorys#Kalenz_2|Kalenz]], dies.

=== 350 YW ===
* Disintegration of the Kingdom follows the death of Haldric IV.
* [[Geography_of_Wesnoth#Elensefar|Elensefar]] remains a province of Wesnoth but exerts increasing independence due to isolation.
* Treaty between lord of Elensefar and king of Wesnoth signed.

== 350-417 YW: The First Dark Age of Wesnoth ==
The first Dark Age was a time of strife and invasion. When Haldric IV died, he left Wesnoth without a king, and the next 70 years were marked by short-lived dynasties, attacks by ever more aggressive orcs, and the further separation of Wesnoth and Elensefar. The Dark Age ended when Garard I took the throne, and began a new dynasty that would last for several hundred years.

=== 360 YW ===
* [[CharactersStorys#Malin_Keshar|Malin Keshar]] born in Parthyn.

=== 363 YW ===
* Last of [[CharactersStorys#Kalenz|Kalenz's]] children dies. Kalenz, condemned to outlive his offspring by the potion of Crelanu, leaves the Forest of Lintanir and begins wandering the Great Continent.

* Village of Maghre terrorized by a minor necromancer. Action of [[Mainline_Campaigns#A_Tale_Of_Two_Brothers|'''A Tale of Two Brothers''']] takes place.

=== 389 YW ===
* Garard, a future king of Wesnoth, is born.
* [[CharactersStorys#Malin_Keshar|Malin Keshar]] returns to Parthyn from the Academy at Alduin. [[Mainline_Campaigns#Descent_into_Darkness|'''Descent Into Darkness''']] begins.

== 417-530 YW: The Turmoil of Asheviere ==
King Garard's dynasty was long-lived and productive, but it was also punctuated by significant turmoil: the end of the first king's reign was marred by orcish and undead raids, and the second was murdered by his own wife and son. It was not until 517 YW that the usurpation of the throne by Queen Mother Asheviere was ended.

=== 417 YW ===
* Ending years of strife and division, Garard I seizes the throne and becomes king of Wesnoth, beginning the [[Garardine Dynasty]].

=== 439 YW ===
* [[CharactersStorys#Garard_II|Crown Prince Garard II]] is born.

=== 442 YW ===
* Prince Arand is born.

=== 448 YW ===
* [[CharactersStorys#Delfador|Delfador]], later called "the Great", is born.

=== 465 YW ===
* The South Guard reports increased bandit activity. Prince Arand sends Deoran and a company of soldiers to investigate. '''The South Guard''' begins.

=== 466 YW ===
* Hostile forces besiege Westin, but are repulsed. '''The South Guard''' ends.
* Displeased with Deoran's performance, Garard II assigns him as ambassador to Lintanir forest — a far-away posting.

=== 470 YW ===
* Garard I dies; [[CharactersStorys#Garard_II|Garard II]] ascends to the throne of Wesnoth
* Garard II marries Asheviere.

=== 476 YW ===
* Garard II founds Fort Garard and prepares to invade the Whitefang orcs.
* Delfador and Deoran join Garard's army. '''The Deceiver's Gambit I''' begins.

=== 478 YW ===
* More orcish clans and a saurian tribe join Garard's war. Garard II is ambushed and nearly killed, but retreats to Fort Garard. '''The Deceiver's Gambit I''' ends.
* Control of the Estmarks is effectively lost during this war, not to be regained for decades. Outposts are built on the near side of the Weldyn to repel orc raids. The long watch of the River Guard begins.

=== 479 YW ===
* A series of bloody battles at the Ford of Abez end in deadlock. The ford is heavily fortified, and river commerce grinds to a halt.
* Crown Prince Eldred is born.

=== 498 YW ===
* Princess Li'sar is born.

=== 500 YW ===
* Prince Konrad is born, the youngest of several sons of Prince Arand.
* Delfador, now the king’s premier war-mage, leads an attack behind enemy lines. '''The Deceiver's Gambit II''' begins.

=== 501 YW ===
==== The End of the War ====
* Delfador learns that a necromancer — Iliah-Malal — has been manipulating the Wesnoth-orc war.
* Delfador slays Iliah-Malal and defeats an orcish army at the Ford of Abez, ending the Wesnoth-orc war.

==== The Fall of Garard ====
* Eldred attacks Prince Arand — his uncle — at Fort Garard, but is repulsed.
* Eldred blames the attack on Arand, claiming that Arand has started a rebellion.
* Garard II sends Delfador to put down Arand's revolt. Delfador kills Arand. Fort Garard is destroyed.
* Eldred betrays Garard II — his father — and kills him. Deoran and Delfador are blamed. Deoran dies.
* Delfador gathers a force of loyalists to avenge Garard II's death. Delfador confronts Eldred's forces on the road to Weldyn.
* Delfador's forces are defeated, but Eldred is slain by Delfador in the fight. '''The Deceiver's Gambit II''' ends.

==== The Rise of Asheviere ====
* Asheviere orders the slaughter of Garard's nephews and declares herself Queen of Wesnoth. '''Asheveire's Dogs''' begins.
* Baron De Ferres rallies a force of nobles to oppose Asheviere.
* Asheviere allies with orcs from numerous clans, promising them gold in return for loyalty.
* Delfador and the elf Parandra infiltrate the palace at Weldyn, but come too late to save Garard's nephews from death.
* Delfador and Parandra find an orphaned human child. Parandra and Delfador agree to give the orphan the identity of Prince Konrad.
* Asheviere conquers Soradoc, Tath, and Dan'Tonk. Baron De Ferres is slain. '''Asheveire's Dogs''' ends.

==== The Western Reaches ====
* Elensefar refuses to submit to Asheviere and declares itself an independent city-state.
* After several defeats, Wesnoth's army retreats from the remote areas of the kingdom. The western Wesnothian border recedes, is fixed, and remains heavily defended.
* As a result of the loyalist withdrawal, several small human communities on the west coast of the Great Continent live in relative independence while elves flourish in the great forest to the southwest of Wesnoth.
* A band of Wesnoth citizens organizes resistance to Asheviere's siezure of power. They are eventually forced to abandon their home and settle in the Three Sisters ('''Liberty''').

=== 502-517 YW ===
* Delfador raises Konrad in the Aethenwood, under the protection of elves.
* Elensefar, Blackwater Port, and the Aethenwood conspire to keep Wesnoth's western reaches free from Asheviere's influence.

=== 517 YW ===
* Asheviere launches a major attack on Elensefar, Blackwater Port, and the Aethenwood.
* Konrad and Delfador flee the Aethenwood and embark upon a quest to regain the throne of Wesnoth. '''Heir To The Throne''' begins.

=== 518 YW ===
* Konrad crosses the Great River into the Northlands on a search for the Sceptre of Fire.
* They enter the Caves of Knalga, find it, and ally with Princess Li'sar.
* They return to Wesnoth and claim the throne. '''Heir to the Throne''' ends.

=== 522 YW ===
* Birth of Princess Ana'sar.

=== 530 YW ===
* Wesnothian colonists begin reclaiming the Estmarks.

=== 544 YW ===
* With both sides of the lower Weldyn River again civilized territory, the River Guard posts south of Soradoc are abandoned. Wesnothian military activity shifts eastward into the Estmarks.

== 530-630 YW: The Age of Fear ==
The Age of Fear takes its names from the events of the end of the era. On the surface, the first 77 years were very uneventful for the kingdom of Wesnoth. However, during this time unexplainable magical events took place, especially in the eastern lands. Previously tamed lands were slowly claimed by wilderness as fear and paranoia gradually overshadowed the spirit of pioneering and adventure displayed earlier in Wesnoth's history. In the last 10 years of the age, Wesnoth bore the brunt of the most powerful undead attack ever and was nearly destroyed. By the end of the era, most of Wesnoth had been made barren, most of the great buildings inside and outside of Weldyn were razed, and the population of Wesnoth was half of what it had been.

It was in this era that certain areas of the chaotic Northlands were for the first time put into any kind of law and order. A small group of humans and dwarves, accepting anyone of any race who wished to join, formed themselves into the "Northern Alliance”, with the vision of making the Northlands safe to live in. Over time, this alliance grew slowly but steadily in power. By the end of the era, the alliance had succeeded in making a few small areas, including Knalga and the surrounding regions, stable and prosperous. Consequently, many people evacuated from the wasteland that most of Wesnoth had become and moved north - depleting the population of Wesnoth still further.

=== 533 YW ===
* Delfador succumbs to old age and dies, his body is entombed alongside his staff in Eregonor.
* The next great sage of Wesnoth, [[CharactersStorys#Dacyn|Dacyn]], is born.

=== 534 YW ===

* The small community of Dwarven Doors, in the Northlands just outside Knalga, rebels against the orcish overlords. '''Northern Rebirth''' begins.
* The residents, led by Tallin, head underground and find dwarves, whom they ally with.
* Their combined forces destroy a lich who is attempting to claim Knalga as his own.
* Abhai finds the [[CampaignDialogue:NR#Abhai_Finds_Rod_of_Justice|Rod of Justice]].

=== 535 YW ===

* The warlord-aspirant Rakshas attacks Tallin and his forces, but does not penetrate the dwarves' defences.
* To help defeat the orcs, Tallin secures the help of two Liches, and rescues an elvish princess to secure the help of the elves.
* Assisted by his new allies, Tallin smashes the forces of Rakshas.
* According to some historians, Tallin and the elvish princess are married; others say they parted in bad blood.
* To preserve the new-found peace in the Northlands, Tallin and his allies form the Northern Alliance. '''Northern Rebirth''' ends.

=== 550 YW ===

* Lord Hamel of Knalga sends an expedition to Kal Kartha to determine the fate of the Hammer of Thursagan ('''The Hammer of Thursagan''' takes place in late 550 YW to early 551 YW.).
* Dwarves at Knalga and elsewhere begin to reclaim the lost art of runesmithing.
* Wesnothian colonization expands southward past Fort Tahn.

=== 563 YW ===
* Konrad and Li'sar die after an extraordinarily long reign.
* Princess Ana'sar becomes queen.
* The seer Galdren becomes prominent at the court of Weldyn.

=== 585 YW ===
* Queen Ana'sar retires.
* Haldric VII becomes king of Wesnoth.

=== 589 YW ===
* Dacyn the White Mage and Ravanal, an eastern wizard, compete to be the king's advisor.
* The seer Galdren dies after advising Haldric VII to choose Dacyn.
* The king does as Galdren advises.

=== 593 YW ===
* Ravanal reveals that he has turned to evil, and flees from Weldyn.
* Konrad II is born.
* Certain southern frontier regions are formally annexed to the Kingdom of Wesnoth as the Province of Kerlath.

=== 612 YW ===
* Haldric VII dies. Konrad II is crowned King of Wesnoth.
* Dacyn continues his duties as advisor with Konrad II.

=== 625 YW ===
* Mysterious disappearances of livestock and peasants cause partial evacuation of the the '''Estmark Hills'''. Lords of the Horse Plains report increased banditry from there.
* Konrad II sends [[CharactersStorys#Dacyn|Dacyn]] with [[CharactersStorys#Owaec|Owaec]] and [[CharactersStorys#Gweddry|Gweddry]] to man the old River Guard strongpoints. [[Mainline_Campaigns#The_Eastern_Invasion|'''Eastern Invasion''']] begins.

=== 626 YW ===
* [[CharactersStorys#Mal-Ravanal|Mal-Ravanal]] attacks the southern outpost where [[CharactersStorys#Gweddry|Gweddry]] and [[CharactersStorys#Dacyn|Dacyn]] are stationed.
* Dacyn and Gweddry travel to the northern outpost, and, with [[CharactersStorys#Owaec|Owaec]], retreat into the northlands.
* In the Far North, the wife of Kai Laudiss slain in a large raid by the orcs of Tirigaz on Jotha
* Kai Laudiss slain by poisoned orcish dart during failed attack on the Port of Tirigaz orcs. His son, [[CharactersStorys#Kai_Krellis|Krellis]] succeeds him as Kai and relies on the wisdom of [[CharactersStorys#Cylanna|Cylanna]], a priestess.
* The merfolk city of Jotha is overrun by undead (Mal Kevek and others). The action of [[Mainline_Campaigns#Dead_Water|'''Dead Water''']] takes place.

=== 627 YW ===
* Wesnoth's last defences are broken and the undead march on Wesnoth
* In the northlands, the orcs drive [[CharactersStorys#Gweddry|Gweddry's]] army back across the river.
* Weldyn is besieged.
* Gweddry breaks through undead lines to reach Weldyn and a council is held.
* Gweddry's army is fortunate and kills [[CharactersStorys#Mal-Ravanal|Mal-Ravanal]]. [[Mainline_Campaigns#The_Eastern_Invasion|'''Eastern Invasion''']] ends. [[Mainline_Campaigns#Dead_water|'''Dead Water''']] ends (about this time).
* Wesnoth is saved, but large portions have been laid waste by the undead.
* After destroying [[CharactersStorys#Mal-Ravanal|Mal-Ravanal's]] henchmen the mermen relaxed and began rebuilding in earnest, and soon Jotha was restored.

== 628-673 YW: The Silver Age of Wesnoth ==

The Silver Age, or restoration of the Wesnothian kingdom, essentially coincides with the rest of the long and successful reign of [[CharactersStorys#Konrad_II|Konrad II]]. During this period Wesnoth largely recovered from the damage that Mal-Ravanal's undead attack had done. It would, however, never quite regain the majesty it had at the height of its power.

The Northlands, aided by a second wave of colonization north from Wesnoth, become more civilised and stable. Although nowhere near as prosperous as Wesnoth was during its Golden Age, the Northlands developed towns of significant size and a thriving - if somewhat dangerous - trade network.

Four major powers soon came to dominate much of the Northlands. First there were the dwarves, who controlled most of the mountains and a vast array of underground tunnels and caverns. To the east, shrouded in mystery, lay the elvish forests which continued to be inaccessible to anyone not of elvish blood. The remaining landscape was dominated either by orcish tribes, or independent human earldoms. As competition for the land grew fierce, wars smoldered between human and orcish forces.

=== 628-635 YW ===
* [[CharactersStorys#Konrad_II|Konrad II]] begins his attempt to rebuild Wesnoth.

=== 673 YW ===
* [[CharactersStorys#Konrad_II|Konrad II]] dies, bringing the [[Garardine Dynasty]] to an end. Second Wesnothian civil war begins.

== 786-826 YW: The Legacy of Black-Eye Karun ==

After decades of struggle, Black-Eye Karun becomes the first warlord since the assassination of Great Chief Brurbar in 20 YW to unite all the different squabbling orcish tribes under his banner. Among his many accomplishments as a Sovereign, his most famous is the creation of the Great Council.

Karun was a far-sighted individual and he knew that after his death the orcish tribes would once again turn to fighting among themselves, with little he could do to prevent that and consequent peril from the Wesnothians and elves.

Consequently, Karun selected from among all the different tribes six of the most sober and wisest orcs and thus created the Great Council. It was the Great Council's job to stay aloof from any tribal or territorial squabbling amongst the orcs, but yet always remain there to give advice to whomever came to seek it. In order to preserve the orcish race in the event of an emergency, he invested in them the power to call up The Great Horde. It was established that every orc, no matter what tribe he came from, must obey the summons of The Great Horde and follow wholeheartedly the leader that the Great Council put at the head of The Great Horde.

===786 YW===
* Karun is born.

===805 YW===
* Karun devised the formation of the Great Council.

===811 YW===
* A border dispute between Karun and a human enclave aligned with the Northern Alliance leaves several men and orcs dead and begins a feud that will grow into a fifteen-year war.

===812 YW===
* Rahul I becomes Lord Protector of the Northern Alliance.

===816 YW===
* [[CharactersStorys#Kapou.27e|Kapou’e]] is born

===826 YW===
* Rahul I (Lord Protector of the Northern Alliance) and Black Eye Karun sign a peace treaty ending a 15 year war between the humans and the orcs. Soon after this Karun, is ambushed and killed in mysterious circumstances.

===829 YW===
* Frustrated by the fallout of Karun's supposed assassination, Rahul I resigns, and Howgarth III takes his place as Lord Protector.

===842 YW===
* Famine in the Northlands. Famine led humans to colonize some orcish lands and push orcs into desolated hill country. The few orcish tribes who had remained part of the Alliance, feeling the pressure, either left Alliance territory or revolted and were destroyed.
* Retaliating, the orcs systematically slaughtered human colonies and villages on their lands. Then, Earl Lanbec'h — the most powerful human warlord of the North — determined to abolish the orcish menace raised an army and conferred leadership of it to his son-in-law Baron Alber.
* In response, the Great Council set up by the Black Eye Karun calls upon The Great Horde and bestows leadership of it upon [[CharactersStorys#Kapou.27e|Kapou’e]]; [[Mainline_Campaigns#Son_of_the_Black_Eye|'''Son of the Black Eye''']] begins.

===843 YW===
* Half of the Great Council is treacherously slain by the allied human forces and orcish unity disintegrates. Faced with the extermination of all the orcs on the Great Continent, [[CharactersStorys#Kapou.27e|Kapou’e]] forcibly asserts his control over the orcish territories and defeats the enemy forces. The Northern Alliance arrives on the scene in time for the final battle and helps Kapou’e defeat the forces of the northern earldoms, who had broken the treaty. Kapou’e then assumes the position of Sovereign over the northern tribes, and his rule ushers in an unprecedented era of unity and prosperity for the orcs.
* After 843: Portions of Kapou'e's army act as mercenaries in foreign struggles with other races which keeps them from attacking their nearest neighbors.

===852 YW===
* [[CharactersStorys#Kapou.27e|Kapou’e]] repels a large elvish invasion.

===858 YW===
* The humans once again stage an invasion but prove to be no match for the united orcish forces under the leadership of [[CharactersStorys#Kapou.27e|Kapou’e]]. [[Mainline_Campaigns#Son_of_the_Black_Eye|'''Son of the Black Eye''']] ends.

==After the Great Fall==
At some unknown point in the future, an unspeakable cataclysm scorched the surface of the lands. The Wesnoth magicians try to raise up a 3rd sun in the sky, Gaia, but they fail and the 'sun' falls down over Weldyn. The capital is no more. The King and his family are dead and there is no heir. The local leaders tear apart Wesnoth. The nights become longer, days hotter. Evil creatures show up. Forests die, hills turn into rocky wastelands and fields become barren deserts. In the apocalypse allies turn against each other and friends fight over what few resources remain. The great nations were destroyed, and huge numbers of people died. Still amidst the chaos somehow small groups of people survived, sheltered in hidden places. In this post-apocalyptic world survival is a daily struggle as a few remaining tribes eke out an existence among the ruins of fallen empires. Heroic bands of elves, nomadic refugee humans, savage hordes of orcs and dark necromancers all forge new lives under the merciless dual suns, Sela and Naia, of this new Irdya.

===??? Post-Wesnoth===

* The Quenoth elves adapt to life in barren world of the Great Southern Desert. Over time they lost their affinity for the woodlands of their ancestry and embrace life in the sandy wastelands.
* Under the leadership of Tanuil, the Quenoth elves build and sustain a fortified village around a rare oasis. The village thrives amidst the hostilities of the desert.
* One night, a meteor storm rains from the sky and destroys the village of the Quenoth elves. '''Under the Burning Suns''' begins. The next day, Tanuil, like many others, is missing and presumed dead. Kalehssar (Kaleh), nephew of Tanuil, takes leadership of the remaining Quenoth elves as the surviving next of kin.
* Kaleh, heeding the voice of his god Eloh in his dreams, gathers the remaining Quenoth elves and leads them north to a new promised land, foregoing rebuilding of their desert village.
* The Quenoth elves battle their way north through undead, orcs, bandits and other evil, venturing underground beneath a large mountain range at the command of Eloh.
* Befriending unexpected allies underground, Kaleh's forces survive to the other side of the mountain.
* Keratur, son of Tanuil and survivor of the cataclysm, insane with fright attacks Kaleh. Kaleh defeats Keratur.
* Kaleh defies commands given him by a vision of Eloh.
* The Quenoth reach the ocean. Aided by merfolk, they escape the mainland and head for a newly discovered island, a place where the Quenoth may settle in peace.
* On the island, the Quenoth confront Yechnagoth, the Eater of Souls and impersonator of Eloh. Yechnagoth and army are destroyed by the Quenoth.
* Kaleh and the elves settle on their newfound, and newly named, Quenoth Isle. '''Under the Burning Suns''' ends.

== History Credits ==
Timelined by Kamahawk and Turin. Revised to incorporate material from later version of Legend of Wesmere and reconcile different versions of the history of the Sceptre of Fire by Eric S. Raymond.

* History derived from the following [[Mainline_Campaigns|mainline campaigns]]:
** [[The Rise of Wesnoth]]
** [[Legend of Wesmere]]
** [[A Tale of Two Brothers]]
** [[Descent into Darkness]]
** [[Delfador's Memoirs]]
** [[Liberty]]
** [[Heir to the Throne]]
** [[Northern Rebirth]]
** [[The Hammer of Thursagan]]
** [[TheEasternInvasion|Eastern Invasion]]
** [[Dead Water]]
** [[UnderTheBurningSuns|Under the Burning Suns]]

== See Also ==

* [[Geography of Wesnoth]]
* [[Poetry of Wesnoth]]
* [[Races]]
* [[FactionHistory|History of various factions]]
* [[Future History]] '''(unofficial)'''

[[Category:World of Wesnoth]]
[[Category:History]]

GameConfigWML

2025-01-14T22:01:37Z

Dalas120:

{{WML Tags}}
== The [game_config] tag ==

This tag is a top level WML tag which can only be used once because
it defines basic settings that are used everywhere in the game.
In official versions of Wesnoth it is in ''game_config.cfg''; values used there are labeled 'standard'.

{{Note|This page is very outdated, and will take multiple edits to update.}}

The following keys are recognised
* '''base_income''': (standard 2) how much your leader earns without any villages
* '''village_income''': (standard 1) how much your leader earns for each village you control
* '''poison_amount''': (standard 8) the amount of damage poison deals to a unit
* '''rest_heal_amount''': (standard 2) how much HP a unit gains each turn it rests
* '''recall_cost''': (standard 20) how much it costs to recall a unit; this cost is independent of level.
* '''kill_experience''': (standard 8) killing a unit with ''level=X'' will give ''X''*''kill_experience'' experience to the killing unit. However, if a unit has ''level=0'', it will still give half of ''X'' experience.

* '''default_defeat_music''': (standard 'defeat.ogg,defeat2.ogg') default list of music tracks that are chosen to play on player's defeat; this can be overriden per-scenario
* '''default_victory_music''': (standard 'victory.ogg,victory2.ogg') default list of music tracks that are chosen to play on player's victory; this can be overriden per-scenario
* '''title_music''': (standard 'main_menu.ogg') the music to play at the title screen

* '''energy''': (standard 'misc/bar-energy.png') the images used to display hp/xp bars.
* '''orb''': (standard 'misc/orb.png') the orb image to add on top of the hp bar, this is recolorable to show the status; see 'Orbs', [[WesnothManual]]
* '''orb_two_color''': (standard 'misc/orb-two-color.png') like '''orb''', but has two separate recolorable parts. Note this is the image to use, although the colors to use for recoloring it also have names that end '_color'.
* '''show_moved_orb''', '''show_partial_orb''', '''show_unmoved_orb''': (default to 'yes' when omitted from the .cfg) whether to show the orb for the player's own units when they're in the given state
* '''show_disengaged_orb''': (defaults to 'yes' when omitted from the .cfg) whether to show a special orb instead of the "partial" orb when a unit can move but can't attack
* '''show_ally_orb''': (defaults to 'yes' when omitted from the .cfg) whether to show an orb on allied units
* '''show_enemy_orb''': (defaults to '' 'no' '' when omitted from the .cfg) whether to show an orb on opposing units
* '''show_status_on_ally_orb''': (defaults to 'yes' when omitted from the .cfg) if true, during allies' turns their units have orbs that show the unmoved/partial/moved status. If true, overrides 'show_ally_orb' during that ally's turn.
* '''ally_orb_color''': (standard 'lightblue') target for recoloring the ally orb
* '''enemy_orb_color''': (standard 'black') target for recoloring the enemy orb, although by default this orb is not shown
* '''moved_orb_color''': (standard 'red') target for recoloring the moved orb
* '''partial_orb_color''': (standard 'brightorange') target for recoloring the partially-moved orb, also used for half of the disengaged orb
* '''unmoved_orb_color''': (standard 'brightgreen') target for recoloring the fully-moved orb, also used for half of the disengaged orb

* '''flag_image''': (standard 'image/flag'terrain/flag-1.png:150,terrain/flag-2.png:150,terrain/flag-3.png:150,terrain/flag-4.png:150') the default flag animation to mark captured villages (if no custom flag is defined in the [side] tag). By example, this animation has 4 frames of 150ms each. An automatic side-coloring is applied.
* '''flag_icon_image''': (standard 'flags/flag-icon.png') the default flag icon to indicate the side playing in the statusbar (if no custom flag_icon is defined in the [side] tag). An automatic side-coloring is applied.
* ''' hp_bar_scaling ''': (standard '0.6') The ratio of hitpoints to height used for displaying the hp bar. Can be overwritten in [unit] and [unit_type].
* ''' xp_bar_scaling ''': (standard '0.5') The ratio of xp to height used for displaying the xp bar. Can be overwritten in [unit] and [unit_type].

* '''footprint_left_nw''', '''footprint_left_n''', '''footprint_right_nw''', '''footprint_right_n''': images used to display the path that a unit would take to the tile the cursor is on.
The first image of each key is used for tiles which would take only 1 movement point for the selected unit to move onto;
the second for ones which would take more.
The 'n' and 'nw' designations distinguish between tiles which are moved from orthogonally and diagonally in the same way as described in '''[missile_frame]''', [[AnimationWML]].
The 'left' and 'right' designations are used alternately throughout the path;
however, the standard values are the same for 'left' and 'right'.

* '''terrain_mask_image''': (standard 'terrain/alphamask.png') used to give a hex-shape from a rectangular image.
* '''grid_image''': (standard 'terrain/grid.png') the image used by the grid option
* '''unreachable_image''': (standard 'terrain/darken.png') the stripes mask used to show unreachable locations

* '''observer_image''': (standard 'misc/eye.png') the image to use for observer in multi-player games. (The eye in the upper right hand corner.)
* '''zoom_levels''': {{DevFeature1.13|8}} A comma-separated list of valid zoom levels, with 1.0 representing 100%.

== Color Palettes ==

Color palettes are defined by two tags within '''[game_config]'''.

* '''[color_palette]''': Contains the definitions of source palettes, such as magenta. Each key defines a palette, and must be set to a comma-separated list of hexadecimal colors.
* '''[color_range]''': Defines a target color palette. This tag can also be used at top level.
** '''id''': Used to reference the palette, for example from '''[side]''' or ~RC().
** '''name''': A translatable name for the color. <s>This may be ignored for non-core colors?</s>
** '''rgb''': A comma-separated sequence of four hexadecimal colors:
**# the average shade of a unit's team-color portions
**# the maximum highlight shade of a unit's team-color portions
**# the minimum shadow shade of a unit's team-color portions
**# the color of the markers on the mini-map.

== See Also ==

* [[ReferenceWML]]

[[Category: WML Reference]]

1.19 Roadmap

2024-06-30T03:02:03Z

Dalas120: Add Dalas's plans to roadmap

This page is for consolidating and planning when new features and fixes are intended to land in the 1.19 development branch. The release schedule for Development releases can be found [https://forums.wesnoth.org/viewtopic.php?f=2&t=52785 here (link is to the 1.17 page, might change for 1.19)].

== Instructions ==
Place the feature or fix you intend to implement within the section of the point release that you intend to have it implemented by, as well as your forum username in parenthesis after the feature description. The point release something is planned to be released with is not set in stone, and can be updated as needed depending on the circumstances.

This is just an outline currently, with some point releases for the early, middle and late parts of the branch.

== Note on Single-Player Campaign Reworks ==

We have some campaign reworks planned and in-progress.

In-progress: The South Guard, The Deceiver's Gambit (DM replacement), The Rise of Wesnoth
In-progress but slower development: Legend of Wesmere (reworked to SP entirely), Heir to the Throne (grand overhaul)
Planned but no progress yet: Angel of Ashes (AoA) (Ashievere-centric campaign)

The first three (TSG, TDG and TRoW) might have higher chances of getting into 1.19.x cycle before any of the others.
The other three might be going into 1.21.x so have been mentioned here just to prepare for an unprecedented development allowances (more assistance in coding, accelerated development speed, etc).

If you have inquiries on the reworks, contact SP rework team leaders (forums/discord): Nemaara/Yumi (TSG, TRoW, AoA), Dalas (TDG, HttT), Lord-Knightmare (LoW-rework).

== 1.19.0 (05/26/2024) ==
* Move the Dunefolk into Default Era (Pentarctagon) - completed in #8688

== 1.19.1 (06/16/2024) ==
* [https://github.com/wesnoth/wesnoth/pull/6826 #6826] Merge hardware accelerated unit submerge effect, if possible (Pentarctagon)
** Completed in [https://github.com/wesnoth/wesnoth/pull/8687 #8687].

== 1.19.2 (07/21/2024) ==
* Finish adding ability/weapon special unit tests (Pentarctagon)
* Release tentative TSG re-revision add-on, building on Yumi's work (Dalas)
** Depending on reception, additional development may be needed, or the rework may be dropped altogether.
** If all goes well, some months from now I'll need to convert this from add-on to mainline so translators can begin work.

== 1.19.3 (08/18/2024) ==
* Investigate replacing mariadbpp with Boost.MySql (Pentarctagon)

== 1.19.4 (09/15/2024) ==
* Release final (hopefully) TDG add-on. Collect feedback and fix bugs (Dalas)
** If all goes well, some months from now I'll need to convert this from add-on to mainline so translators can begin work.

== 1.19.5 (10/20/2024) ==
* [https://github.com/wesnoth/wesnoth/pull/6512 #6512] New type of deprecation warning, when a deprecated attribute is used alongside its replacement (octalot)
* [https://github.com/wesnoth/wesnoth/pull/7082 #7082] Get wmllint running against mainline during CI with no errors (Pentarctagon)

== 1.19.6 (11/17/2024) ==

== 1.19.7 (12/15/2024) ==

== 1.19.8 (01/19/2025) ==

== 1.19.9 (02/16/2025) ==
* Release first half of HttT revision and gather feedback, fix bugs, etc (Dalas)
** This is a VERY rough release date. Probably +/- 2 months.

== 1.19.10 (03/16/2025) ==
* [https://github.com/wesnoth/wesnoth/issues/5041 #5041] Draw text on images in [[IntroWML]], useable for place-name labels on the journey-tracker maps (octalot)
* Add "pseudo-queues" as a built-in feature for the multiplayer lobby (pentarctagon)

== 1.19.11 (04/20/2025) ==

== 1.19.12 (05/18/2025) ==

== 1.19.13 (06/15/2025) ==

== 1.19.14 (07/20/2025) ==

== 1.19.15 (08/17/2025) ==
* Play through any remaining mainline campaigns worth playing through (ie: not LoW) and add at least a minimum baseline of achievements to them (Pentarctagon)

== 1.19.16 (09/21/2025) ==

== 1.19.17 (10/19/2025) ==
* Release second half of HttT revision and gather feedback, fix bugs, etc (Dalas)
** This is a VERY rough release date. Probably +/- 3 months.
** If all goes well, some months from now I'll need to convert this from add-on to mainline so translators can begin work.

== 1.19.18 (11/16/2025) ==

== 1.19.19 (12/21/2025) ==

== 1.19.20 (01/18/2026) ==
* Go through all the added translatable strings, and check that they're used. For example, look for campaign-specific abilities which aren't used in the campaign. (octalot, but open to volunteers)
* Take a serious look at supporting a competitive mode/ELO ranking natively (pentarctagon)

== 1.19.21 (Beta 1) (02/15/2026) ==
'''This marks the beginning of the feature freeze and string freeze for 1.19;''' the only API changes made past this point must be to fix bugs.

== 1.19.22 (Beta 2) (03/15/2026) ==

== 1.19.23 (Beta 3) (04/19/2026) ==

== 1.19.24 (RC1) (05/17/2026) ==
'''This marks the beginning of the API freeze;''' no API changes for for any reason can be made at this point. Additional RC releases will be done as needed.

* Add new screenshots for 1.20

== 1.20.0 (06/21/2026) ==

[[Category:Roadmaps]]