The Battle for Wesnoth Wiki - User contributions [en]

Testers

2026-04-23T08:17:45Z

Shadowm:

Add yourself here if you are available to test anything around wesnoth and mention what environment (OS, platform, windowing system, etc) you can test and/or debug issues in. Maybe also mention what kind of issues you're mostly interested in or when you're likely available and which way you can best be reached.

* Soliton: can test+debug on macOS, ios, linux (flatpak, X11), android
** reachable via IRC/discord/forum/github
* Irydacea: can test+debug on macOS (arm64), Windows 11 (x86_64), Linux (x86_64: Fedora with KDE Wayland)
** reachable via Discord and IRC

LuaAPI/types/widget

2026-03-11T02:19:45Z

Shadowm: unfolded is actually in 1.18

<div class="tright"> __TOC__ </div>

The '''widget''' userdata offers access to a widget of a GUI2 dialog. While there is only one type of widget userdata that covers all widgets including the window itself, the properties of a widget userdata are different for each type of widget. Indexing a widget's userdata can either be used to access a child widget or to set or get a property of a widget. Some properties are read-only or write-only; the properties depend on the type of the widget.

An example of accessing a child widget:

<syntaxhighlight lang=lua>
function preshow(dialog)
local okay_button = dialog.okay_button
-- okay_button is now a handle to the the widget's child with the id 'okay_button'
end
</syntaxhighlight>

{{DevFeature1.19|x}} Some fields are only available in newer versions of Wesnoth. However, even in this case it might be possible to set the attribute in question before the dialog is first shown by adjusting its definition WML accordingly. See [[GUIWidgetInstanceWML]] for more information on WML attributes available for each widget class.

== Widget Attributes ==

=== best_slider_length ===
{{DevFeature1.19|6}}
* ''widget''.'''best_slider_length''' ↔ ''length''
* Available on: '''[slider]'''
Best length of the slider.

=== characters_per_line ===
{{DevFeature1.19|6}}
* ''widget''.'''label''' ↔ ''int''
* Available on: '''[label]'''
Maximum characters this label should show per line.

=== editable ===
{{DevFeature1.19|6}}
* ''widget''.'''enabled''' ↔ ''boolean''
* Available on: '''[text_box]'''
If this text box is editable, i.e., read-only. (Text can be selected/copied but not modified.)

=== ellipsize_mode ===
{{DevFeature1.19|6}}
* ''widget''.'''ellipsize_mode''' ↔ ''ellipsization mode string''
* Available on: Most widgets
Sets the [https://docs.gtk.org/Pango/enum.EllipsizeMode.html Pango ellipsization mode] for the widget. Accepts only one of the special strings:
{| clasS="wikitable"
! String value
|-
| none
|-
| start
|-
| end
|-
| middle
|-
|}

=== enabled ===
* ''widget''.'''enabled''' ↔ ''boolean''
* Available on: Most widgets

=== help ===
{{DevFeature1.19|6}}
* ''widget''.'''enabled''' ↔ ''text''
* Available on: Most widgets
Help text for this widget.

=== hint_image ===
{{DevFeature1.19|6}}
* ''widget''.'''hint_image''' ↔ ''text''
* Available on: '''[text_box]''', '''[combobox]'''
A image that is shown on the widget when it is not focused and has no other text.

=== hint_text ===
{{DevFeature1.19|6}}
* ''widget''.'''hint_text''' ↔ ''text''
* Available on: '''[text_box]''', '''[combobox]'''
A background text that is shown on the widget when it is not focused and has no other text.

=== history ===
{{DevFeature1.19|6}}
* ''widget''.'''history''' ← ''text''
* Available on: '''[text_box]'''
Input history of this text box.

=== indentation_step_size ===
{{DevFeature1.19|6}}
* ''widget''.'''indentation_step_size''' ↔ ''int''
* Available on: '''[tree_view]'''
How much should child nodes be offset from their parent node.

=== item_count ===
{{DevFeature1.19|6}}
* ''widget''.'''item_count''' → ''number of items''
* Available on: '''[multi_page]''', '''[listbox]''', '''[combobox]''', '''[stacked_widget]''', '''[tree_view]''', '''[tree_view_node]''', '''[styled_widget]'''
The number of items in the container widget.

=== label ===
* ''widget''.'''label''' ← ''text''
* Available on: Most widgets, in particular '''[label]''', '''[button]''', '''[image]'''
The widget's label. Technically this is a special string used in the widget's wml definition. It usually does what one would expect, but also sets the image for '''image''' widgets. For '''[text_box]''', use '''text''' for initial values.

=== link_aware ===
{{DevFeature1.19|6}}
* ''widget''.'''link_aware''' → ''boolean''
* Available on: '''[label]''', '''[rich_label]''', '''[scroll_label]''', '''[scroll_text]'''
Whether this widget recognizes inline links and allows clicking on them.

=== link_color ===
{{DevFeature1.19|6}}
* ''widget''.'''link_color''' → ''color string''
* Available on: '''[label]''', '''[rich_label]'''
Color of the inline link, as an hex string.

=== marked_up_text ===
* ''widget''.'''marked_up_text''' ← ''text''
* Available on: Most widgets, in particular '''[label]''', '''[button]'''
Shortcut for setting label and use_markup=yes.

=== maximum_value_label ===
{{DevFeature1.19|6}}
* ''widget''.'''maximum_value_label''' ↔ ''text''
* Available on: '''[slider]'''
The text the slider's label shows when it is at maximum value position.

=== max_input_length ===
{{DevFeature1.19|6}}
* ''widget''.'''max_input_length''' ↔ ''text''
* Available on: '''[text_box]''', '''[combobox]'''
Maximum number of character than can be input into this widget.

=== minimum_value_label ===
{{DevFeature1.19|6}}
* ''widget''.'''minimum_value_label''' ↔ ''text''
* Available on: '''[slider]'''
The text the slider's label shows when it is at minimum value position.

=== overflow_to_tooltip ===
{{DevFeature1.19|6}}
* ''widget''.'''overflow_to_tooltip''' ↔ ''boolean''
* Available on: Most widgets

=== path ===
* ''widget''.'''path''' → ''array of indices''
* Available on: '''[tree_view_node]'''
A table describing this node in the overall treeview. See [[#selected_item_path|selected_item_path]] for the meaning of the table..

=== percentage ===
* ''widget''.'''percentage''' ↔ ''position''
* Available on: '''[progress_bar]'''
The current position of the progress bar, between 0 and 100.

=== selected ===
* ''widget''.'''selected''' ↔ ''boolean''
* Available on: '''[toggle_button]''', '''[toggle_panel]'''
Whether the item is selected or not. Note that this should only be used for widgets that have only 2 states. In particular, there exist 3-State toggle_buttons (for example in listbox headers). For those, selected_index must be used instead.

=== selected_index ===
* ''widget''.'''selected_index''' ↔ ''index''
* Available on: '''[listbox]''', '''[multi_page]''', '''[stacked_widget]''', '''[menu_button]''', '''[toggle_button]''', '''[toggle_panel]'''
The selected index of the item. For '''[toggle_button]''' and '''[toggle_panel]''', this is the same as '''selected''' only encoded as a number (1 for false or 2 for true) instead of a boolean.
For a '''[listbox]'''with '''has_maximum=false''' and more than one item selected, reading '''selected_index''' will return the first selected index.
For a '''[stacked_widget]''', only the layer specified by '''selected_index''' will be displayed and receive events (callbacks will only be triggered on the selected layer).
A '''selected_index''' of 0 represents all layers being selected, with events only being received by the layer with the highest index. Note that term ''selected'' for the ''layer'' of a stacked_widget is not the same as the '''selected''' ''widget'' attribute.

=== selected_item_path ===
* ''widget''.'''selected_item_path''' → ''array of indices''
* Available on: '''[tree_view]'''
A table describing the currently selected node. If for example, in the following treeview, Item 9 is selected, the result will be {2,1,3}.
+Section1
+Subsection11
*Item1
*Item2
*Item3
+Subsection12
*Item4
*Item5
*Item6
+Section2
+Subsection21
*Item7
*Item8
*Item9
+Subsection22
*Item10
*Item11
*Item12

=== step_size ===
{{DevFeature1.19|6}}
* ''widget''.'''step_size''' ↔ ''int''
* Available on: '''[slider]'''

=== text ===
* ''widget''.'''text''' ↔ ''text''
* Available on: '''[text_box]'''
The text of the textbox.

=== text_alignment ===
{{DevFeature1.19|6}}
* ''widget''.'''text_alignment''' ↔ ''text alignment string''
* Available on: Most widgets
Sets the [https://docs.gtk.org/Pango/enum.Alignment.html Pango text alignment] for the widget. Accepts only one of the special strings:
{| clasS="wikitable"
! String value
|-
| left
|-
| right
|-
| center
|-
|}

=== tooltip ===
* ''widget''.'''tooltip''' ↔ ''text''
* Available on: Most widgets

=== type ===
* ''widget''.'''type''' → ''string''
* Available on: All widgets
Returns a string specifying the type of the widget.

=== unfolded ===
* ''widget''.'''unfolded''' ← ''boolean''
* Available on: '''[tree_view_node]''', '''[tree_view]'''
Control whether a tree node is currently expanded or not.

=== unit ===
* ''widget''.'''unit''' ← ''unit or unit type''
* Available on: '''[unit_preview_pane]'''
Change the displayed unit or unit type in the preview pane.

=== use_markup ===
* ''widget''.'''use_markup''' → ''boolean''
* Available on: Most widgets, in particular '''[label]''', '''[button]'''
Sets whether the widget's label will parse [[Pango formatting]].

=== value ===
* ''widget''.'''value''' ↔ ''position''
* Available on: '''[slider]'''
The current position of the slider.

=== visible ===
* ''widget''.'''visible''' ↔ ''visibility string''
* Available on: Most widgets
Determines whether the widget is visible onscreen. The following visibility statuses are recognized:
{| clasS="wikitable"
! String value !! Boolean shorthand !! Meaning
|-
| visible || true || The widget is visible and handles events.
|-
| hidden || || The widget is not visible, doesn't handle events, but still takes up space on the dialog grid.
|-
| invisible || false || The widget is not visible, doesn't handle events, and does not take up space on the dialog grid.
|}

=== wrap ===
{{DevFeature1.19|6}}
* ''widget''.'''wrap''' → ''boolean''
* Available on: '''[label]'''
Whether the text content in this label can wrap.

== Widget Callbacks ==

=== on_button_click ===

* ''widget''.'''on_button_click''' ← '''function'''()
* Available on: '''[button]''', '''[repeating_button]'''

Triggers when the user clicks on the button. This can differ from '''on_left_click''', depending on the type of widget. For example, on a '''[repeating_button]''' it will fire multiple times if the user holds the mouse button down.

=== on_double_click ===
{{DevFeature1.19|14}}

* ''widget''.'''on_double_click''' ← '''function'''()
* Available on: '''[toggle_panel]'''

Triggers when the user double clicks on the widget. Non-toggle panel widgets can be wrapped in a toggle panel to make use of this event handler.

=== on_left_click ===

* ''widget''.'''on_left_click''' ← '''function'''()
* Available on: All widgets

Triggers when the user clicks on the widget.

=== on_link_click ===
{{DevFeature1.19|9}}

* ''widget''.'''on_link_click''' ← '''function'''(''dest'')
* Available on: '''[rich_label]'''

Triggers when the user clicks on a '''<ref>''' link inside a '''[rich_label]'''. The first argument '''dest''' is the target of the link.

=== on_modified ===

* ''widget''.'''on_modified''' ← '''function'''()
* Available on: Most widgets, in particular '''[slider]''', '''[toggle_button]''', '''[listbox]''', '''[menu_button]''', '''[text_box]'''

Triggers when the user changes the value of the widget.

== Widget Length ==

{{DevFeature1.19|4}}

* '''#'''''widget''
* Available on: '''[listbox]''', '''[multi_page]''', '''[tree_view]''', '''[tree_view_node]''', {{DevFeature1.19|6}} '''[stacked_widget]'''

Returns the total number of children in the specified container widget – for example, the number of rows in a list box, or the number of pages in a multi-page.

== Widget Methods ==

Any function defined in the [[LuaAPI/gui/widget|gui.widget]] module and taking a widget as its first parameter can be called as a method of a widget. This includes any functions that are added to the module by user code. Note that these methods are available even if the widget itself doesn't support that function, so in some cases it may be necessary to check '''widget.type''' before calling the method.

[[Category:Lua Reference]]

LuaAPI/types/widget

2026-03-11T00:18:05Z

Shadowm: Lots of things specific to 1.19.6+ were documented here without the necessary warnings

<div class="tright"> __TOC__ </div>

The '''widget''' userdata offers access to a widget of a GUI2 dialog. While there is only one type of widget userdata that covers all widgets including the window itself, the properties of a widget userdata are different for each type of widget. Indexing a widget's userdata can either be used to access a child widget or to set or get a property of a widget. Some properties are read-only or write-only; the properties depend on the type of the widget.

An example of accessing a child widget:

<syntaxhighlight lang=lua>
function preshow(dialog)
local okay_button = dialog.okay_button
-- okay_button is now a handle to the the widget's child with the id 'okay_button'
end
</syntaxhighlight>

{{DevFeature1.19|x}} Some fields are only available in newer versions of Wesnoth. However, even in this case it might be possible to set the attribute in question before the dialog is first shown by adjusting its definition WML accordingly. See [[GUIWidgetInstanceWML]] for more information on WML attributes available for each widget class.

== Widget Attributes ==

=== best_slider_length ===
{{DevFeature1.19|6}}
* ''widget''.'''best_slider_length''' ↔ ''length''
* Available on: '''[slider]'''
Best length of the slider.

=== characters_per_line ===
{{DevFeature1.19|6}}
* ''widget''.'''label''' ↔ ''int''
* Available on: '''[label]'''
Maximum characters this label should show per line.

=== editable ===
{{DevFeature1.19|6}}
* ''widget''.'''enabled''' ↔ ''boolean''
* Available on: '''[text_box]'''
If this text box is editable, i.e., read-only. (Text can be selected/copied but not modified.)

=== ellipsize_mode ===
{{DevFeature1.19|6}}
* ''widget''.'''ellipsize_mode''' ↔ ''ellipsization mode string''
* Available on: Most widgets
Sets the [https://docs.gtk.org/Pango/enum.EllipsizeMode.html Pango ellipsization mode] for the widget. Accepts only one of the special strings:
{| clasS="wikitable"
! String value
|-
| none
|-
| start
|-
| end
|-
| middle
|-
|}

=== enabled ===
* ''widget''.'''enabled''' ↔ ''boolean''
* Available on: Most widgets

=== help ===
{{DevFeature1.19|6}}
* ''widget''.'''enabled''' ↔ ''text''
* Available on: Most widgets
Help text for this widget.

=== hint_image ===
{{DevFeature1.19|6}}
* ''widget''.'''hint_image''' ↔ ''text''
* Available on: '''[text_box]''', '''[combobox]'''
A image that is shown on the widget when it is not focused and has no other text.

=== hint_text ===
{{DevFeature1.19|6}}
* ''widget''.'''hint_text''' ↔ ''text''
* Available on: '''[text_box]''', '''[combobox]'''
A background text that is shown on the widget when it is not focused and has no other text.

=== history ===
{{DevFeature1.19|6}}
* ''widget''.'''history''' ← ''text''
* Available on: '''[text_box]'''
Input history of this text box.

=== indentation_step_size ===
{{DevFeature1.19|6}}
* ''widget''.'''indentation_step_size''' ↔ ''int''
* Available on: '''[tree_view]'''
How much should child nodes be offset from their parent node.

=== item_count ===
{{DevFeature1.19|6}}
* ''widget''.'''item_count''' → ''number of items''
* Available on: '''[multi_page]''', '''[listbox]''', '''[combobox]''', '''[stacked_widget]''', '''[tree_view]''', '''[tree_view_node]''', '''[styled_widget]'''
The number of items in the container widget.

=== label ===
* ''widget''.'''label''' ← ''text''
* Available on: Most widgets, in particular '''[label]''', '''[button]''', '''[image]'''
The widget's label. Technically this is a special string used in the widget's wml definition. It usually does what one would expect, but also sets the image for '''image''' widgets. For '''[text_box]''', use '''text''' for initial values.

=== link_aware ===
{{DevFeature1.19|6}}
* ''widget''.'''link_aware''' → ''boolean''
* Available on: '''[label]''', '''[rich_label]''', '''[scroll_label]''', '''[scroll_text]'''
Whether this widget recognizes inline links and allows clicking on them.

=== link_color ===
{{DevFeature1.19|6}}
* ''widget''.'''link_color''' → ''color string''
* Available on: '''[label]''', '''[rich_label]'''
Color of the inline link, as an hex string.

=== marked_up_text ===
* ''widget''.'''marked_up_text''' ← ''text''
* Available on: Most widgets, in particular '''[label]''', '''[button]'''
Shortcut for setting label and use_markup=yes.

=== maximum_value_label ===
{{DevFeature1.19|6}}
* ''widget''.'''maximum_value_label''' ↔ ''text''
* Available on: '''[slider]'''
The text the slider's label shows when it is at maximum value position.

=== max_input_length ===
{{DevFeature1.19|6}}
* ''widget''.'''max_input_length''' ↔ ''text''
* Available on: '''[text_box]''', '''[combobox]'''
Maximum number of character than can be input into this widget.

=== minimum_value_label ===
{{DevFeature1.19|6}}
* ''widget''.'''minimum_value_label''' ↔ ''text''
* Available on: '''[slider]'''
The text the slider's label shows when it is at minimum value position.

=== overflow_to_tooltip ===
{{DevFeature1.19|6}}
* ''widget''.'''overflow_to_tooltip''' ↔ ''boolean''
* Available on: Most widgets

=== path ===
* ''widget''.'''path''' → ''array of indices''
* Available on: '''[tree_view_node]'''
A table describing this node in the overall treeview. See [[#selected_item_path|selected_item_path]] for the meaning of the table..

=== percentage ===
* ''widget''.'''percentage''' ↔ ''position''
* Available on: '''[progress_bar]'''
The current position of the progress bar, between 0 and 100.

=== selected ===
* ''widget''.'''selected''' ↔ ''boolean''
* Available on: '''[toggle_button]''', '''[toggle_panel]'''
Whether the item is selected or not. Note that this should only be used for widgets that have only 2 states. In particular, there exist 3-State toggle_buttons (for example in listbox headers). For those, selected_index must be used instead.

=== selected_index ===
* ''widget''.'''selected_index''' ↔ ''index''
* Available on: '''[listbox]''', '''[multi_page]''', '''[stacked_widget]''', '''[menu_button]''', '''[toggle_button]''', '''[toggle_panel]'''
The selected index of the item. For '''[toggle_button]''' and '''[toggle_panel]''', this is the same as '''selected''' only encoded as a number (1 for false or 2 for true) instead of a boolean.
For a '''[listbox]'''with '''has_maximum=false''' and more than one item selected, reading '''selected_index''' will return the first selected index.
For a '''[stacked_widget]''', only the layer specified by '''selected_index''' will be displayed and receive events (callbacks will only be triggered on the selected layer).
A '''selected_index''' of 0 represents all layers being selected, with events only being received by the layer with the highest index. Note that term ''selected'' for the ''layer'' of a stacked_widget is not the same as the '''selected''' ''widget'' attribute.

=== selected_item_path ===
* ''widget''.'''selected_item_path''' → ''array of indices''
* Available on: '''[tree_view]'''
A table describing the currently selected node. If for example, in the following treeview, Item 9 is selected, the result will be {2,1,3}.
+Section1
+Subsection11
*Item1
*Item2
*Item3
+Subsection12
*Item4
*Item5
*Item6
+Section2
+Subsection21
*Item7
*Item8
*Item9
+Subsection22
*Item10
*Item11
*Item12

=== step_size ===
{{DevFeature1.19|6}}
* ''widget''.'''step_size''' ↔ ''int''
* Available on: '''[slider]'''

=== text ===
* ''widget''.'''text''' ↔ ''text''
* Available on: '''[text_box]'''
The text of the textbox.

=== text_alignment ===
{{DevFeature1.19|6}}
* ''widget''.'''text_alignment''' ↔ ''text alignment string''
* Available on: Most widgets
Sets the [https://docs.gtk.org/Pango/enum.Alignment.html Pango text alignment] for the widget. Accepts only one of the special strings:
{| clasS="wikitable"
! String value
|-
| left
|-
| right
|-
| center
|-
|}

=== tooltip ===
* ''widget''.'''tooltip''' ↔ ''text''
* Available on: Most widgets

=== type ===
* ''widget''.'''type''' → ''string''
* Available on: All widgets
Returns a string specifying the type of the widget.

=== unfolded ===
{{DevFeature1.19|6}}
* ''widget''.'''unfolded''' ← ''boolean''
* Available on: '''[tree_view_node]''', '''[tree_view]'''
Control whether a tree node is currently expanded or not.

=== unit ===
* ''widget''.'''unit''' ← ''unit or unit type''
* Available on: '''[unit_preview_pane]'''
Change the displayed unit or unit type in the preview pane.

=== use_markup ===
* ''widget''.'''use_markup''' → ''boolean''
* Available on: Most widgets, in particular '''[label]''', '''[button]'''
Sets whether the widget's label will parse [[Pango formatting]].

=== value ===
* ''widget''.'''value''' ↔ ''position''
* Available on: '''[slider]'''
The current position of the slider.

=== visible ===
* ''widget''.'''visible''' ↔ ''visibility string''
* Available on: Most widgets
Determines whether the widget is visible onscreen. The following visibility statuses are recognized:
{| clasS="wikitable"
! String value !! Boolean shorthand !! Meaning
|-
| visible || true || The widget is visible and handles events.
|-
| hidden || || The widget is not visible, doesn't handle events, but still takes up space on the dialog grid.
|-
| invisible || false || The widget is not visible, doesn't handle events, and does not take up space on the dialog grid.
|}

=== wrap ===
{{DevFeature1.19|6}}
* ''widget''.'''wrap''' → ''boolean''
* Available on: '''[label]'''
Whether the text content in this label can wrap.

== Widget Callbacks ==

=== on_button_click ===

* ''widget''.'''on_button_click''' ← '''function'''()
* Available on: '''[button]''', '''[repeating_button]'''

Triggers when the user clicks on the button. This can differ from '''on_left_click''', depending on the type of widget. For example, on a '''[repeating_button]''' it will fire multiple times if the user holds the mouse button down.

=== on_double_click ===
{{DevFeature1.19|14}}

* ''widget''.'''on_double_click''' ← '''function'''()
* Available on: '''[toggle_panel]'''

Triggers when the user double clicks on the widget. Non-toggle panel widgets can be wrapped in a toggle panel to make use of this event handler.

=== on_left_click ===

* ''widget''.'''on_left_click''' ← '''function'''()
* Available on: All widgets

Triggers when the user clicks on the widget.

=== on_link_click ===
{{DevFeature1.19|9}}

* ''widget''.'''on_link_click''' ← '''function'''(''dest'')
* Available on: '''[rich_label]'''

Triggers when the user clicks on a '''<ref>''' link inside a '''[rich_label]'''. The first argument '''dest''' is the target of the link.

=== on_modified ===

* ''widget''.'''on_modified''' ← '''function'''()
* Available on: Most widgets, in particular '''[slider]''', '''[toggle_button]''', '''[listbox]''', '''[menu_button]''', '''[text_box]'''

Triggers when the user changes the value of the widget.

== Widget Length ==

{{DevFeature1.19|4}}

* '''#'''''widget''
* Available on: '''[listbox]''', '''[multi_page]''', '''[tree_view]''', '''[tree_view_node]''', {{DevFeature1.19|6}} '''[stacked_widget]'''

Returns the total number of children in the specified container widget – for example, the number of rows in a list box, or the number of pages in a multi-page.

== Widget Methods ==

Any function defined in the [[LuaAPI/gui/widget|gui.widget]] module and taking a widget as its first parameter can be called as a method of a widget. This includes any functions that are added to the module by user code. Note that these methods are available even if the widget itself doesn't support that function, so in some cases it may be necessary to check '''widget.type''' before calling the method.

[[Category:Lua Reference]]

Template:Lua Functions

2025-05-06T15:43:46Z

Shadowm: r does not come before a

{| class="reference-sidebar"
|
[[{{SERVER}}{{localurl:Template:Lua Functions|action=edit}} edit]]'''Lua Functions'''
|-
|''wesnoth''
[[LuaAPI/wesnoth#wesnoth.as_text|wesnoth.as_text]] 
[[LuaAPI/wesnoth#wesnoth.colors|wesnoth.colors]] 
[[LuaAPI/wesnoth#wesnoth.compile_formula|wesnoth.compile_formula]] 
[[LuaAPI/wesnoth#wesnoth.current|wesnoth.current]] 
[[LuaAPI/wesnoth#wesnoth.current_version|wesnoth.current_version]] 
[[LuaAPI/wesnoth#wesnoth.custom_synced_commands|wesnoth.custom_synced_commands]] 
[[LuaAPI/wesnoth#wesnoth.deprecate_api|wesnoth.deprecate_api]] 
[[LuaAPI/wesnoth#wesnoth.deprecated_message|wesnoth.deprecated_message]] 
[[LuaAPI/wesnoth#wesnoth.dofile|wesnoth.dofile]] 
[[LuaAPI/wesnoth#wesnoth.effects|wesnoth.effects]] 
[[LuaAPI/wesnoth#wesnoth.eval_formula|wesnoth.eval_formula]] 
[[LuaAPI/wesnoth#wesnoth.game_config|wesnoth.game_config]] 
[[LuaAPI/wesnoth#wesnoth.get_language|wesnoth.get_language]] 
[[LuaAPI/wesnoth#wesnoth.log|wesnoth.log]] 
[[LuaAPI/wesnoth#wesnoth.micro_ais|wesnoth.micro_ais]] 
[[LuaAPI/wesnoth#wesnoth.ms_since_init|wesnoth.ms_since_init]] 
[[LuaAPI/wesnoth#wesnoth.name_generator|wesnoth.name_generator]] 
[[LuaAPI/wesnoth#wesnoth.named_tuple|wesnoth.named_tuple]] 
[[LuaAPI/wesnoth#wesnoth.persistent_tags|wesnoth.persistent_tags]] 
[[LuaAPI/wesnoth#wesnoth.print_attributes|wesnoth.print_attributes]] 
[[LuaAPI/wesnoth#wesnoth.races|wesnoth.races]] 
[[LuaAPI/wesnoth#wesnoth.require|wesnoth.require]] 
[[LuaAPI/wesnoth#wesnoth.scenario|wesnoth.scenario]] 
[[LuaAPI/wesnoth#wesnoth.simulate_combat|wesnoth.simulate_combat]] 
[[LuaAPI/wesnoth#wesnoth.terrain_types|wesnoth.terrain_types]] 
[[LuaAPI/wesnoth#wesnoth.textdomain|wesnoth.textdomain]] 
[[LuaAPI/wesnoth#wesnoth.type|wesnoth.type]] 
[[LuaAPI/wesnoth#wesnoth.unit_types|wesnoth.unit_types]] 
[[LuaAPI/wesnoth#wesnoth.version|wesnoth.version]] 
[[LuaAPI/wesnoth#wesnoth.wml_actions|wesnoth.wml_actions]] 
[[LuaAPI/wesnoth#wesnoth.wml_conditionals|wesnoth.wml_conditionals]] 
|-
|''wesnoth.achievements''
[[LuaAPI/wesnoth/achievements#wesnoth.achievements.get|wesnoth.achievements.get]] 
[[LuaAPI/wesnoth/achievements#wesnoth.achievements.has|wesnoth.achievements.has]] 
[[LuaAPI/wesnoth/achievements#wesnoth.achievements.has_sub_achievement|wesnoth.achievements.has_sub_achievement]] 
[[LuaAPI/wesnoth/achievements#wesnoth.achievements.progress|wesnoth.achievements.progress]] 
[[LuaAPI/wesnoth/achievements#wesnoth.achievements.set|wesnoth.achievements.set]] 
[[LuaAPI/wesnoth/achievements#wesnoth.achievements.set_sub_achievement|wesnoth.achievements.set_sub_achievement]] 
|-
|''wesnoth.audio''
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list|wesnoth.audio.music_list]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.add|wesnoth.audio.music_list.add]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.all|wesnoth.audio.music_list.all]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.clear|wesnoth.audio.music_list.clear]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.current|wesnoth.audio.music_list.current]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.next|wesnoth.audio.music_list.next]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.play|wesnoth.audio.music_list.play]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.previous|wesnoth.audio.music_list.previous]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.remove|wesnoth.audio.music_list.remove]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.volume|wesnoth.audio.music_list.volume]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.play|wesnoth.audio.play]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.sources|wesnoth.audio.sources]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.volume|wesnoth.audio.volume]] 
|-
|''wesnoth.game_events''
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.add|wesnoth.game_events.add]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.add_menu|wesnoth.game_events.add_menu]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.add_repeating|wesnoth.game_events.add_repeating]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.add_wml|wesnoth.game_events.add_wml]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.fire|wesnoth.game_events.fire]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.fire_by_id|wesnoth.game_events.fire_by_id]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.on_event|wesnoth.game_events.on_event]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.on_load|wesnoth.game_events.on_load]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.on_mouse_action|wesnoth.game_events.on_mouse_action]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.on_mouse_button|wesnoth.game_events.on_mouse_button]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.on_mouse_move|wesnoth.game_events.on_mouse_move]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.on_save|wesnoth.game_events.on_save]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.remove|wesnoth.game_events.remove]] 
|-
|''wesnoth.interface''
[[LuaAPI/wesnoth/interface#wesnoth.interface.add_chat_message|wesnoth.interface.add_chat_message]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.add_hex_overlay|wesnoth.interface.add_hex_overlay]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.add_item_halo|wesnoth.interface.add_item_halo]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.add_item_image|wesnoth.interface.add_item_image]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.add_overlay_text|wesnoth.interface.add_overlay_text]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.allow_end_turn|wesnoth.interface.allow_end_turn]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.clear_chat_messages|wesnoth.interface.clear_chat_messages]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.color_adjust|wesnoth.interface.color_adjust]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.delay|wesnoth.interface.delay]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.deselect_hex|wesnoth.interface.deselect_hex]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.end_turn|wesnoth.interface.end_turn]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.float_label|wesnoth.interface.float_label]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.get_displayed_unit|wesnoth.interface.get_displayed_unit]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.get_hovered_hex|wesnoth.interface.get_hovered_hex]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.get_items|wesnoth.interface.get_items]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.get_selected_hex|wesnoth.interface.get_selected_hex]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.get_viewing_side|wesnoth.interface.get_viewing_side]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.handle_user_interact|wesnoth.interface.handle_user_interact]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.highlight_hex|wesnoth.interface.highlight_hex]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.is_locked|wesnoth.interface.is_locked]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.is_skipping_messages|wesnoth.interface.is_skipping_messages]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.lock|wesnoth.interface.lock]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.remove_hex_overlay|wesnoth.interface.remove_hex_overlay]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.remove_item|wesnoth.interface.remove_item]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.scroll|wesnoth.interface.scroll]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.scroll_to_hex|wesnoth.interface.scroll_to_hex]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.select_unit|wesnoth.interface.select_unit]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.skip_messages|wesnoth.interface.skip_messages]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.zoom|wesnoth.interface.zoom]] 
|-
|''wesnoth.map''
[[LuaAPI/wesnoth/map#wesnoth.map.add_label|wesnoth.map.add_label]] 
[[LuaAPI/wesnoth/map#wesnoth.map.are_hexes_adjacent|wesnoth.map.are_hexes_adjacent]] 
[[LuaAPI/wesnoth/map#wesnoth.map.create|wesnoth.map.create]] 
[[LuaAPI/wesnoth/map#wesnoth.map.distance_between|wesnoth.map.distance_between]] 
[[LuaAPI/wesnoth/map#wesnoth.map.find|wesnoth.map.find]] 
[[LuaAPI/wesnoth/map#wesnoth.map.generate|wesnoth.map.generate]] 
[[LuaAPI/wesnoth/map#wesnoth.map.generate_height_map|wesnoth.map.generate_height_map]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get|wesnoth.map.get]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get_adjacent_hexes|wesnoth.map.get_adjacent_hexes]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get_area|wesnoth.map.get_area]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get_direction|wesnoth.map.get_direction]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get_hexes_in_radius|wesnoth.map.get_hexes_in_radius]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get_label|wesnoth.map.get_label]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get_owner|wesnoth.map.get_owner]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get_relative_dir|wesnoth.map.get_relative_dir]] 
[[LuaAPI/wesnoth/map#wesnoth.map.iter|wesnoth.map.iter]] 
[[LuaAPI/wesnoth/map#wesnoth.map.make_bitmap|wesnoth.map.make_bitmap]] 
[[LuaAPI/wesnoth/map#wesnoth.map.matches|wesnoth.map.matches]] 
[[LuaAPI/wesnoth/map#wesnoth.map.on_board|wesnoth.map.on_board]] 
[[LuaAPI/wesnoth/map#wesnoth.map.on_border|wesnoth.map.on_border]] 
[[LuaAPI/wesnoth/map#wesnoth.map.parse_bitmap|wesnoth.map.parse_bitmap]] 
[[LuaAPI/wesnoth/map#wesnoth.map.place_area|wesnoth.map.place_area]] 
[[LuaAPI/wesnoth/map#wesnoth.map.read_location|wesnoth.map.read_location]] 
[[LuaAPI/wesnoth/map#wesnoth.map.remove_area|wesnoth.map.remove_area]] 
[[LuaAPI/wesnoth/map#wesnoth.map.remove_label|wesnoth.map.remove_label]] 
[[LuaAPI/wesnoth/map#wesnoth.map.rotate_right_around_center|wesnoth.map.rotate_right_around_center]] 
[[LuaAPI/wesnoth/map#wesnoth.map.set_owner|wesnoth.map.set_owner]] 
[[LuaAPI/wesnoth/map#wesnoth.map.split_terrain_code|wesnoth.map.split_terrain_code]] 
[[LuaAPI/wesnoth/map#wesnoth.map.terrain_mask|wesnoth.map.terrain_mask]] 
|-
|''wesnoth.paths''
[[LuaAPI/wesnoth/paths#wesnoth.paths.find_cost_map|wesnoth.paths.find_cost_map]] 
[[LuaAPI/wesnoth/paths#wesnoth.paths.find_path|wesnoth.paths.find_path]] 
[[LuaAPI/wesnoth/paths#wesnoth.paths.find_reach|wesnoth.paths.find_reach]] 
[[LuaAPI/wesnoth/paths#wesnoth.paths.find_vacant_hex|wesnoth.paths.find_vacant_hex]] 
[[LuaAPI/wesnoth/paths#wesnoth.paths.find_vision_range|wesnoth.paths.find_vision_range]] 
|-
|''wesnoth.schedule''
[[LuaAPI/wesnoth/schedule#wesnoth.schedule.get_illumination|wesnoth.schedule.get_illumination]] 
[[LuaAPI/wesnoth/schedule#wesnoth.schedule.get_time_of_day|wesnoth.schedule.get_time_of_day]] 
[[LuaAPI/wesnoth/schedule#wesnoth.schedule.replace|wesnoth.schedule.replace]] 
|-
|''wesnoth.sides''
[[LuaAPI/wesnoth/sides#wesnoth.sides.add_ai_component|wesnoth.sides.add_ai_component]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.append_ai|wesnoth.sides.append_ai]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.change_ai_component|wesnoth.sides.change_ai_component]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.create|wesnoth.sides.create]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.debug_ai|wesnoth.sides.debug_ai]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.delete_ai_component|wesnoth.sides.delete_ai_component]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.find|wesnoth.sides.find]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.get|wesnoth.sides.get]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.is_enemy|wesnoth.sides.is_enemy]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.is_fogged|wesnoth.sides.is_fogged]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.is_shrouded|wesnoth.sides.is_shrouded]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.iter|wesnoth.sides.iter]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.matches|wesnoth.sides.matches]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.override_shroud|wesnoth.sides.override_shroud]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.place_fog|wesnoth.sides.place_fog]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.place_shroud|wesnoth.sides.place_shroud]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.remove_fog|wesnoth.sides.remove_fog]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.remove_shroud|wesnoth.sides.remove_shroud]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.set_id|wesnoth.sides.set_id]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.switch_ai|wesnoth.sides.switch_ai]] 
|-
|''wesnoth.sync''
[[LuaAPI/wesnoth/sync#wesnoth.sync.evaluate_multiple|wesnoth.sync.evaluate_multiple]] 
[[LuaAPI/wesnoth/sync#wesnoth.sync.evaluate_single|wesnoth.sync.evaluate_single]] 
[[LuaAPI/wesnoth/sync#wesnoth.sync.invoke_command|wesnoth.sync.invoke_command]] 
[[LuaAPI/wesnoth/sync#wesnoth.sync.run_unsynced|wesnoth.sync.run_unsynced]] 
|-
|''wesnoth.units''
[[LuaAPI/wesnoth/units#wesnoth.units.ability|wesnoth.units.ability]] 
[[LuaAPI/wesnoth/units#wesnoth.units.add_modification|wesnoth.units.add_modification]] 
[[LuaAPI/wesnoth/units#wesnoth.units.advance|wesnoth.units.advance]] 
[[LuaAPI/wesnoth/units#wesnoth.units.chance_to_be_hit|wesnoth.units.chance_to_be_hit]] 
[[LuaAPI/wesnoth/units#wesnoth.units.clone|wesnoth.units.clone]] 
[[LuaAPI/wesnoth/units#wesnoth.units.create|wesnoth.units.create]] 
[[LuaAPI/wesnoth/units#wesnoth.units.create_animator|wesnoth.units.create_animator]] 
[[LuaAPI/wesnoth/units#wesnoth.units.defense_on|wesnoth.units.defense_on]] 
[[LuaAPI/wesnoth/units#wesnoth.units.erase|wesnoth.units.erase]] 
[[LuaAPI/wesnoth/units#wesnoth.units.extract|wesnoth.units.extract]] 
[[LuaAPI/wesnoth/units#wesnoth.units.find|wesnoth.units.find]] 
[[LuaAPI/wesnoth/units#wesnoth.units.find_attack|wesnoth.units.find_attack]] 
[[LuaAPI/wesnoth/units#wesnoth.units.find_on_map|wesnoth.units.find_on_map]] 
[[LuaAPI/wesnoth/units#wesnoth.units.find_on_recall|wesnoth.units.find_on_recall]] 
[[LuaAPI/wesnoth/units#wesnoth.units.get|wesnoth.units.get]] 
[[LuaAPI/wesnoth/units#wesnoth.units.get_hovered|wesnoth.units.get_hovered]] 
[[LuaAPI/wesnoth/units#wesnoth.units.jamming_on|wesnoth.units.jamming_on]] 
[[LuaAPI/wesnoth/units#wesnoth.units.matches|wesnoth.units.matches]] 
[[LuaAPI/wesnoth/units#wesnoth.units.movement_on|wesnoth.units.movement_on]] 
[[LuaAPI/wesnoth/units#wesnoth.units.rebuild|wesnoth.units.rebuild]] 
[[LuaAPI/wesnoth/units#wesnoth.units.remove_modifications|wesnoth.units.remove_modifications]] 
[[LuaAPI/wesnoth/units#wesnoth.units.resistance_against|wesnoth.units.resistance_against]] 
[[LuaAPI/wesnoth/units#wesnoth.units.scroll_to|wesnoth.units.scroll_to]] 
[[LuaAPI/wesnoth/units#wesnoth.units.select|wesnoth.units.select]] 
[[LuaAPI/wesnoth/units#wesnoth.units.to_map|wesnoth.units.to_map]] 
[[LuaAPI/wesnoth/units#wesnoth.units.to_recall|wesnoth.units.to_recall]] 
[[LuaAPI/wesnoth/units#wesnoth.units.transform|wesnoth.units.transform]] 
[[LuaAPI/wesnoth/units#wesnoth.units.vision_on|wesnoth.units.vision_on]] 
|-
|''ai''
[[LuaAPI/ai#ai.aspects|ai.aspects]] 
[[LuaAPI/ai#ai.attack|ai.attack]] 
[[LuaAPI/ai#ai.check_attack|ai.check_attack]] 
[[LuaAPI/ai#ai.check_move|ai.check_move]] 
[[LuaAPI/ai#ai.check_recall|ai.check_recall]] 
[[LuaAPI/ai#ai.check_recruit|ai.check_recruit]] 
[[LuaAPI/ai#ai.check_stopunit|ai.check_stopunit]] 
[[LuaAPI/ai#ai.fallback_human|ai.fallback_human]] 
[[LuaAPI/ai#ai.get_attacks|ai.get_attacks]] 
[[LuaAPI/ai#ai.get_targets|ai.get_targets]] 
[[LuaAPI/ai#ai.move|ai.move]] 
[[LuaAPI/ai#ai.move_full|ai.move_full]] 
[[LuaAPI/ai#ai.read_only|ai.read_only]] 
[[LuaAPI/ai#ai.recall|ai.recall]] 
[[LuaAPI/ai#ai.recruit|ai.recruit]] 
[[LuaAPI/ai#ai.side|ai.side]] 
[[LuaAPI/ai#ai.stopunit_all|ai.stopunit_all]] 
[[LuaAPI/ai#ai.stopunit_attacks|ai.stopunit_attacks]] 
[[LuaAPI/ai#ai.stopunit_moves|ai.stopunit_moves]] 
[[LuaAPI/ai#ai.suitable_keep|ai.suitable_keep]] 
|-
|''filesystem''
[[LuaAPI/filesystem#filesystem.canonical_path|filesystem.canonical_path]] 
[[LuaAPI/filesystem#filesystem.have_asset|filesystem.have_asset]] 
[[LuaAPI/filesystem#filesystem.have_file|filesystem.have_file]] 
[[LuaAPI/filesystem#filesystem.image_size|filesystem.image_size]] 
[[LuaAPI/filesystem#filesystem.read_file|filesystem.read_file]] 
[[LuaAPI/filesystem#filesystem.resolve_asset|filesystem.resolve_asset]] 
|-
|''functional''
[[LuaAPI/functional#functional.choose|functional.choose]] 
[[LuaAPI/functional#functional.choose_map|functional.choose_map]] 
[[LuaAPI/functional#functional.filter|functional.filter]] 
[[LuaAPI/functional#functional.filter_map|functional.filter_map]] 
[[LuaAPI/functional#functional.find|functional.find]] 
[[LuaAPI/functional#functional.find_map|functional.find_map]] 
[[LuaAPI/functional#functional.map|functional.map]] 
[[LuaAPI/functional#functional.map_array|functional.map_array]] 
[[LuaAPI/functional#functional.reduce|functional.reduce]] 
[[LuaAPI/functional#functional.take_while|functional.take_while]] 
[[LuaAPI/functional#functional.zip|functional.zip]] 
|-
|''gui''
[[LuaAPI/gui#gui.add_widget_definition|gui.add_widget_definition]] 
[[LuaAPI/gui#gui.get_user_choice|gui.get_user_choice]] 
[[LuaAPI/gui#gui.show_dialog|gui.show_dialog]] 
[[LuaAPI/gui#gui.show_help|gui.show_help]] 
[[LuaAPI/gui#gui.show_inspector|gui.show_inspector]] 
[[LuaAPI/gui#gui.show_lua_console|gui.show_lua_console]] 
[[LuaAPI/gui#gui.show_menu|gui.show_menu]] 
[[LuaAPI/gui#gui.show_narration|gui.show_narration]] 
[[LuaAPI/gui#gui.show_popup|gui.show_popup]] 
[[LuaAPI/gui#gui.show_prompt|gui.show_prompt]] 
[[LuaAPI/gui#gui.show_recruit_dialog|gui.show_recruit_dialog]] 
[[LuaAPI/gui#gui.show_recall_dialog|gui.show_recall_dialog]] 
[[LuaAPI/gui#gui.show_story|gui.show_story]] 
[[LuaAPI/gui#gui.switch_theme|gui.switch_theme]] 
[[LuaAPI/gui#gui.widget|gui.widget]] 
|-
|''location_set''
[[LuaAPI/location_set#location_set.clear|location_set.clear]] 
[[LuaAPI/location_set#location_set.clone|location_set.clone]] 
[[LuaAPI/location_set#location_set.create|location_set.create]] 
[[LuaAPI/location_set#location_set.diff|location_set.diff]] 
[[LuaAPI/location_set#location_set.empty|location_set.empty]] 
[[LuaAPI/location_set#location_set.filter|location_set.filter]] 
[[LuaAPI/location_set#location_set.get|location_set.get]] 
[[LuaAPI/location_set#location_set.insert|location_set.insert]] 
[[LuaAPI/location_set#location_set.inter|location_set.inter]] 
[[LuaAPI/location_set#location_set.inter_merge|location_set.inter_merge]] 
[[LuaAPI/location_set#location_set.invert|location_set.invert]] 
[[LuaAPI/location_set#location_set.iter|location_set.iter]] 
[[LuaAPI/location_set#location_set.of_map|location_set.of_map]] 
[[LuaAPI/location_set#location_set.of_pairs|location_set.of_pairs]] 
[[LuaAPI/location_set#location_set.of_raw|location_set.of_raw]] 
[[LuaAPI/location_set#location_set.of_shroud_data|location_set.of_shroud_data]] 
[[LuaAPI/location_set#location_set.of_triples|location_set.of_triples]] 
[[LuaAPI/location_set#location_set.of_wml_var|location_set.of_wml_var]] 
[[LuaAPI/location_set#location_set.random|location_set.random]] 
[[LuaAPI/location_set#location_set.remove|location_set.remove]] 
[[LuaAPI/location_set#location_set.size|location_set.size]] 
[[LuaAPI/location_set#location_set.stable_iter|location_set.stable_iter]] 
[[LuaAPI/location_set#location_set.symm|location_set.symm]] 
[[LuaAPI/location_set#location_set.to_map|location_set.to_map]] 
[[LuaAPI/location_set#location_set.to_pairs|location_set.to_pairs]] 
[[LuaAPI/location_set#location_set.to_shroud_data|location_set.to_shroud_data]] 
[[LuaAPI/location_set#location_set.to_stable_pairs|location_set.to_stable_pairs]] 
[[LuaAPI/location_set#location_set.to_triples|location_set.to_triples]] 
[[LuaAPI/location_set#location_set.to_wml_var|location_set.to_wml_var]] 
[[LuaAPI/location_set#location_set.union|location_set.union]] 
[[LuaAPI/location_set#location_set.union_merge|location_set.union_merge]] 
|-
|''mathx''
[[LuaAPI/mathx#mathx.clamp|mathx.clamp]] 
[[LuaAPI/mathx#mathx.lerp|mathx.lerp]] 
[[LuaAPI/mathx#mathx.random|mathx.random]] 
[[LuaAPI/mathx#mathx.random_choice|mathx.random_choice]] 
[[LuaAPI/mathx#mathx.round|mathx.round]] 
[[LuaAPI/mathx#mathx.shuffle|mathx.shuffle]] 
|-
|''stringx''
[[LuaAPI/stringx#stringx.anim_split|stringx.anim_split]] 
[[LuaAPI/stringx#stringx.escaped_split|stringx.escaped_split]] 
[[LuaAPI/stringx#stringx.format_conjunct_list|stringx.format_conjunct_list]] 
[[LuaAPI/stringx#stringx.format_disjunct_list|stringx.format_disjunct_list]] 
[[LuaAPI/stringx#stringx.iter_range|stringx.iter_range]] 
[[LuaAPI/stringx#stringx.iter_ranges|stringx.iter_ranges]] 
[[LuaAPI/stringx#stringx.join|stringx.join]] 
[[LuaAPI/stringx#stringx.join_map|stringx.join_map]] 
[[LuaAPI/stringx#stringx.map_split|stringx.map_split]] 
[[LuaAPI/stringx#stringx.parenthetical_split|stringx.parenthetical_split]] 
[[LuaAPI/stringx#stringx.parse_range|stringx.parse_range]] 
[[LuaAPI/stringx#stringx.quoted_split|stringx.quoted_split]] 
[[LuaAPI/stringx#stringx.split|stringx.split]] 
[[LuaAPI/stringx#stringx.trim|stringx.trim]] 
[[LuaAPI/stringx#stringx.vformat|stringx.vformat]] 
|-
|''unit_test''
[[LuaAPI/unit_test#unit_test.assert|unit_test.assert]] 
[[LuaAPI/unit_test#unit_test.assert_approx_equal|unit_test.assert_approx_equal]] 
[[LuaAPI/unit_test#unit_test.assert_contains|unit_test.assert_contains]] 
[[LuaAPI/unit_test#unit_test.assert_equal|unit_test.assert_equal]] 
[[LuaAPI/unit_test#unit_test.assert_greater|unit_test.assert_greater]] 
[[LuaAPI/unit_test#unit_test.assert_greater_equal|unit_test.assert_greater_equal]] 
[[LuaAPI/unit_test#unit_test.assert_in_range|unit_test.assert_in_range]] 
[[LuaAPI/unit_test#unit_test.assert_less|unit_test.assert_less]] 
[[LuaAPI/unit_test#unit_test.assert_less_equal|unit_test.assert_less_equal]] 
[[LuaAPI/unit_test#unit_test.assert_not_equal|unit_test.assert_not_equal]] 
[[LuaAPI/unit_test#unit_test.assert_nothrow|unit_test.assert_nothrow]] 
[[LuaAPI/unit_test#unit_test.assert_throws|unit_test.assert_throws]] 
[[LuaAPI/unit_test#unit_test.assert_throws_with|unit_test.assert_throws_with]] 
[[LuaAPI/unit_test#unit_test.fail|unit_test.fail]] 
[[LuaAPI/unit_test#unit_test.finish|unit_test.finish]] 
[[LuaAPI/unit_test#unit_test.fire_wml_menu_item|unit_test.fire_wml_menu_item]] 
[[LuaAPI/unit_test#unit_test.log|unit_test.log]] 
[[LuaAPI/unit_test#unit_test.succeed|unit_test.succeed]] 
[[LuaAPI/unit_test#unit_test.tostring|unit_test.tostring]] 
|-
|''wml''
[[LuaAPI/wml#wml.all_variables|wml.all_variables]] 
[[LuaAPI/wml#wml.array_access.get|wml.array_access.get]] 
[[LuaAPI/wml#wml.array_access.get_proxy|wml.array_access.get_proxy]] 
[[LuaAPI/wml#wml.array_access.set|wml.array_access.set]] 
[[LuaAPI/wml#wml.array_variables|wml.array_variables]] 
[[LuaAPI/wml#wml.attribute_count|wml.attribute_count]] 
[[LuaAPI/wml#wml.child_array|wml.child_array]] 
[[LuaAPI/wml#wml.child_count|wml.child_count]] 
[[LuaAPI/wml#wml.child_range|wml.child_range]] 
[[LuaAPI/wml#wml.clone|wml.clone]] 
[[LuaAPI/wml#wml.diff|wml.diff]] 
[[LuaAPI/wml#wml.equal|wml.equal]] 
[[LuaAPI/wml#wml.error|wml.error]] 
[[LuaAPI/wml#wml.eval_conditional|wml.eval_conditional]] 
[[LuaAPI/wml#wml.find_child|wml.find_child]] 
[[LuaAPI/wml#wml.fire|wml.fire]] 
[[LuaAPI/wml#wml.get_child|wml.get_child]] 
[[LuaAPI/wml#wml.get_nth_child|wml.get_nth_child]] 
[[LuaAPI/wml#wml.interpolate|wml.interpolate]] 
[[LuaAPI/wml#wml.literal|wml.literal]] 
[[LuaAPI/wml#wml.load|wml.load]] 
[[LuaAPI/wml#wml.matches_filter|wml.matches_filter]] 
[[LuaAPI/wml#wml.merge|wml.merge]] 
[[LuaAPI/wml#wml.parse|wml.parse]] 
[[LuaAPI/wml#wml.parsed|wml.parsed]] 
[[LuaAPI/wml#wml.patch|wml.patch]] 
[[LuaAPI/wml#wml.remove_child|wml.remove_child]] 
[[LuaAPI/wml#wml.remove_children|wml.remove_children]] 
[[LuaAPI/wml#wml.shallow_literal|wml.shallow_literal]] 
[[LuaAPI/wml#wml.shallow_parsed|wml.shallow_parsed]] 
[[LuaAPI/wml#wml.tag|wml.tag]] 
[[LuaAPI/wml#wml.tostring|wml.tostring]] 
[[LuaAPI/wml#wml.tovconfig|wml.tovconfig]] 
[[LuaAPI/wml#wml.valid|wml.valid]] 
[[LuaAPI/wml#wml.variables|wml.variables]] 
[[LuaAPI/wml#wml.variables_proxy|wml.variables_proxy]] 
|-
|''wml-utils''
[[LuaAPI/wml-utils#utils.check_key|utils.check_key]] 
[[LuaAPI/wml-utils#utils.get_sides|utils.get_sides]] 
[[LuaAPI/wml-utils#utils.handle_event_commands|utils.handle_event_commands]] 
[[LuaAPI/wml-utils#utils.optional_side_filter|utils.optional_side_filter]] 
[[LuaAPI/wml-utils#utils.scoped_var|utils.scoped_var]] 
[[LuaAPI/wml-utils#utils.set_exiting|utils.set_exiting]] 
[[LuaAPI/wml-utils#utils.vwriter|utils.vwriter]] 
|}<includeonly>[[Category:Lua Reference]]</includeonly><noinclude>A box with all the Lua functions, each one linking to the page and section they are described in. It was generated using [[/Updating|this method]]. This box should be included in [[LuaAPI|Lua reference]] page.</noinclude>

Template:Lua Functions

2025-05-06T15:43:11Z

Shadowm: Add wesnoth.units.rebuild to sidebar

{| class="reference-sidebar"
|
[[{{SERVER}}{{localurl:Template:Lua Functions|action=edit}} edit]]'''Lua Functions'''
|-
|''wesnoth''
[[LuaAPI/wesnoth#wesnoth.as_text|wesnoth.as_text]] 
[[LuaAPI/wesnoth#wesnoth.colors|wesnoth.colors]] 
[[LuaAPI/wesnoth#wesnoth.compile_formula|wesnoth.compile_formula]] 
[[LuaAPI/wesnoth#wesnoth.current|wesnoth.current]] 
[[LuaAPI/wesnoth#wesnoth.current_version|wesnoth.current_version]] 
[[LuaAPI/wesnoth#wesnoth.custom_synced_commands|wesnoth.custom_synced_commands]] 
[[LuaAPI/wesnoth#wesnoth.deprecate_api|wesnoth.deprecate_api]] 
[[LuaAPI/wesnoth#wesnoth.deprecated_message|wesnoth.deprecated_message]] 
[[LuaAPI/wesnoth#wesnoth.dofile|wesnoth.dofile]] 
[[LuaAPI/wesnoth#wesnoth.effects|wesnoth.effects]] 
[[LuaAPI/wesnoth#wesnoth.eval_formula|wesnoth.eval_formula]] 
[[LuaAPI/wesnoth#wesnoth.game_config|wesnoth.game_config]] 
[[LuaAPI/wesnoth#wesnoth.get_language|wesnoth.get_language]] 
[[LuaAPI/wesnoth#wesnoth.log|wesnoth.log]] 
[[LuaAPI/wesnoth#wesnoth.micro_ais|wesnoth.micro_ais]] 
[[LuaAPI/wesnoth#wesnoth.ms_since_init|wesnoth.ms_since_init]] 
[[LuaAPI/wesnoth#wesnoth.name_generator|wesnoth.name_generator]] 
[[LuaAPI/wesnoth#wesnoth.named_tuple|wesnoth.named_tuple]] 
[[LuaAPI/wesnoth#wesnoth.persistent_tags|wesnoth.persistent_tags]] 
[[LuaAPI/wesnoth#wesnoth.print_attributes|wesnoth.print_attributes]] 
[[LuaAPI/wesnoth#wesnoth.races|wesnoth.races]] 
[[LuaAPI/wesnoth#wesnoth.require|wesnoth.require]] 
[[LuaAPI/wesnoth#wesnoth.scenario|wesnoth.scenario]] 
[[LuaAPI/wesnoth#wesnoth.simulate_combat|wesnoth.simulate_combat]] 
[[LuaAPI/wesnoth#wesnoth.terrain_types|wesnoth.terrain_types]] 
[[LuaAPI/wesnoth#wesnoth.textdomain|wesnoth.textdomain]] 
[[LuaAPI/wesnoth#wesnoth.type|wesnoth.type]] 
[[LuaAPI/wesnoth#wesnoth.unit_types|wesnoth.unit_types]] 
[[LuaAPI/wesnoth#wesnoth.version|wesnoth.version]] 
[[LuaAPI/wesnoth#wesnoth.wml_actions|wesnoth.wml_actions]] 
[[LuaAPI/wesnoth#wesnoth.wml_conditionals|wesnoth.wml_conditionals]] 
|-
|''wesnoth.achievements''
[[LuaAPI/wesnoth/achievements#wesnoth.achievements.get|wesnoth.achievements.get]] 
[[LuaAPI/wesnoth/achievements#wesnoth.achievements.has|wesnoth.achievements.has]] 
[[LuaAPI/wesnoth/achievements#wesnoth.achievements.has_sub_achievement|wesnoth.achievements.has_sub_achievement]] 
[[LuaAPI/wesnoth/achievements#wesnoth.achievements.progress|wesnoth.achievements.progress]] 
[[LuaAPI/wesnoth/achievements#wesnoth.achievements.set|wesnoth.achievements.set]] 
[[LuaAPI/wesnoth/achievements#wesnoth.achievements.set_sub_achievement|wesnoth.achievements.set_sub_achievement]] 
|-
|''wesnoth.audio''
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list|wesnoth.audio.music_list]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.add|wesnoth.audio.music_list.add]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.all|wesnoth.audio.music_list.all]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.clear|wesnoth.audio.music_list.clear]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.current|wesnoth.audio.music_list.current]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.next|wesnoth.audio.music_list.next]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.play|wesnoth.audio.music_list.play]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.previous|wesnoth.audio.music_list.previous]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.remove|wesnoth.audio.music_list.remove]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.music_list.volume|wesnoth.audio.music_list.volume]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.play|wesnoth.audio.play]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.sources|wesnoth.audio.sources]] 
[[LuaAPI/wesnoth/audio#wesnoth.audio.volume|wesnoth.audio.volume]] 
|-
|''wesnoth.game_events''
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.add|wesnoth.game_events.add]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.add_menu|wesnoth.game_events.add_menu]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.add_repeating|wesnoth.game_events.add_repeating]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.add_wml|wesnoth.game_events.add_wml]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.fire|wesnoth.game_events.fire]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.fire_by_id|wesnoth.game_events.fire_by_id]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.on_event|wesnoth.game_events.on_event]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.on_load|wesnoth.game_events.on_load]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.on_mouse_action|wesnoth.game_events.on_mouse_action]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.on_mouse_button|wesnoth.game_events.on_mouse_button]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.on_mouse_move|wesnoth.game_events.on_mouse_move]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.on_save|wesnoth.game_events.on_save]] 
[[LuaAPI/wesnoth/game_events#wesnoth.game_events.remove|wesnoth.game_events.remove]] 
|-
|''wesnoth.interface''
[[LuaAPI/wesnoth/interface#wesnoth.interface.add_chat_message|wesnoth.interface.add_chat_message]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.add_hex_overlay|wesnoth.interface.add_hex_overlay]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.add_item_halo|wesnoth.interface.add_item_halo]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.add_item_image|wesnoth.interface.add_item_image]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.add_overlay_text|wesnoth.interface.add_overlay_text]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.allow_end_turn|wesnoth.interface.allow_end_turn]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.clear_chat_messages|wesnoth.interface.clear_chat_messages]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.color_adjust|wesnoth.interface.color_adjust]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.delay|wesnoth.interface.delay]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.deselect_hex|wesnoth.interface.deselect_hex]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.end_turn|wesnoth.interface.end_turn]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.float_label|wesnoth.interface.float_label]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.get_displayed_unit|wesnoth.interface.get_displayed_unit]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.get_hovered_hex|wesnoth.interface.get_hovered_hex]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.get_items|wesnoth.interface.get_items]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.get_selected_hex|wesnoth.interface.get_selected_hex]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.get_viewing_side|wesnoth.interface.get_viewing_side]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.handle_user_interact|wesnoth.interface.handle_user_interact]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.highlight_hex|wesnoth.interface.highlight_hex]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.is_locked|wesnoth.interface.is_locked]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.is_skipping_messages|wesnoth.interface.is_skipping_messages]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.lock|wesnoth.interface.lock]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.remove_hex_overlay|wesnoth.interface.remove_hex_overlay]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.remove_item|wesnoth.interface.remove_item]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.scroll|wesnoth.interface.scroll]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.scroll_to_hex|wesnoth.interface.scroll_to_hex]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.select_unit|wesnoth.interface.select_unit]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.skip_messages|wesnoth.interface.skip_messages]] 
[[LuaAPI/wesnoth/interface#wesnoth.interface.zoom|wesnoth.interface.zoom]] 
|-
|''wesnoth.map''
[[LuaAPI/wesnoth/map#wesnoth.map.add_label|wesnoth.map.add_label]] 
[[LuaAPI/wesnoth/map#wesnoth.map.are_hexes_adjacent|wesnoth.map.are_hexes_adjacent]] 
[[LuaAPI/wesnoth/map#wesnoth.map.create|wesnoth.map.create]] 
[[LuaAPI/wesnoth/map#wesnoth.map.distance_between|wesnoth.map.distance_between]] 
[[LuaAPI/wesnoth/map#wesnoth.map.find|wesnoth.map.find]] 
[[LuaAPI/wesnoth/map#wesnoth.map.generate|wesnoth.map.generate]] 
[[LuaAPI/wesnoth/map#wesnoth.map.generate_height_map|wesnoth.map.generate_height_map]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get|wesnoth.map.get]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get_adjacent_hexes|wesnoth.map.get_adjacent_hexes]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get_area|wesnoth.map.get_area]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get_direction|wesnoth.map.get_direction]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get_hexes_in_radius|wesnoth.map.get_hexes_in_radius]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get_label|wesnoth.map.get_label]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get_owner|wesnoth.map.get_owner]] 
[[LuaAPI/wesnoth/map#wesnoth.map.get_relative_dir|wesnoth.map.get_relative_dir]] 
[[LuaAPI/wesnoth/map#wesnoth.map.iter|wesnoth.map.iter]] 
[[LuaAPI/wesnoth/map#wesnoth.map.make_bitmap|wesnoth.map.make_bitmap]] 
[[LuaAPI/wesnoth/map#wesnoth.map.matches|wesnoth.map.matches]] 
[[LuaAPI/wesnoth/map#wesnoth.map.on_board|wesnoth.map.on_board]] 
[[LuaAPI/wesnoth/map#wesnoth.map.on_border|wesnoth.map.on_border]] 
[[LuaAPI/wesnoth/map#wesnoth.map.parse_bitmap|wesnoth.map.parse_bitmap]] 
[[LuaAPI/wesnoth/map#wesnoth.map.place_area|wesnoth.map.place_area]] 
[[LuaAPI/wesnoth/map#wesnoth.map.read_location|wesnoth.map.read_location]] 
[[LuaAPI/wesnoth/map#wesnoth.map.remove_area|wesnoth.map.remove_area]] 
[[LuaAPI/wesnoth/map#wesnoth.map.remove_label|wesnoth.map.remove_label]] 
[[LuaAPI/wesnoth/map#wesnoth.map.rotate_right_around_center|wesnoth.map.rotate_right_around_center]] 
[[LuaAPI/wesnoth/map#wesnoth.map.set_owner|wesnoth.map.set_owner]] 
[[LuaAPI/wesnoth/map#wesnoth.map.split_terrain_code|wesnoth.map.split_terrain_code]] 
[[LuaAPI/wesnoth/map#wesnoth.map.terrain_mask|wesnoth.map.terrain_mask]] 
|-
|''wesnoth.paths''
[[LuaAPI/wesnoth/paths#wesnoth.paths.find_cost_map|wesnoth.paths.find_cost_map]] 
[[LuaAPI/wesnoth/paths#wesnoth.paths.find_path|wesnoth.paths.find_path]] 
[[LuaAPI/wesnoth/paths#wesnoth.paths.find_reach|wesnoth.paths.find_reach]] 
[[LuaAPI/wesnoth/paths#wesnoth.paths.find_vacant_hex|wesnoth.paths.find_vacant_hex]] 
[[LuaAPI/wesnoth/paths#wesnoth.paths.find_vision_range|wesnoth.paths.find_vision_range]] 
|-
|''wesnoth.schedule''
[[LuaAPI/wesnoth/schedule#wesnoth.schedule.get_illumination|wesnoth.schedule.get_illumination]] 
[[LuaAPI/wesnoth/schedule#wesnoth.schedule.get_time_of_day|wesnoth.schedule.get_time_of_day]] 
[[LuaAPI/wesnoth/schedule#wesnoth.schedule.replace|wesnoth.schedule.replace]] 
|-
|''wesnoth.sides''
[[LuaAPI/wesnoth/sides#wesnoth.sides.add_ai_component|wesnoth.sides.add_ai_component]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.append_ai|wesnoth.sides.append_ai]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.change_ai_component|wesnoth.sides.change_ai_component]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.create|wesnoth.sides.create]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.debug_ai|wesnoth.sides.debug_ai]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.delete_ai_component|wesnoth.sides.delete_ai_component]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.find|wesnoth.sides.find]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.get|wesnoth.sides.get]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.is_enemy|wesnoth.sides.is_enemy]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.is_fogged|wesnoth.sides.is_fogged]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.is_shrouded|wesnoth.sides.is_shrouded]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.iter|wesnoth.sides.iter]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.matches|wesnoth.sides.matches]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.override_shroud|wesnoth.sides.override_shroud]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.place_fog|wesnoth.sides.place_fog]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.place_shroud|wesnoth.sides.place_shroud]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.remove_fog|wesnoth.sides.remove_fog]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.remove_shroud|wesnoth.sides.remove_shroud]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.set_id|wesnoth.sides.set_id]] 
[[LuaAPI/wesnoth/sides#wesnoth.sides.switch_ai|wesnoth.sides.switch_ai]] 
|-
|''wesnoth.sync''
[[LuaAPI/wesnoth/sync#wesnoth.sync.evaluate_multiple|wesnoth.sync.evaluate_multiple]] 
[[LuaAPI/wesnoth/sync#wesnoth.sync.evaluate_single|wesnoth.sync.evaluate_single]] 
[[LuaAPI/wesnoth/sync#wesnoth.sync.invoke_command|wesnoth.sync.invoke_command]] 
[[LuaAPI/wesnoth/sync#wesnoth.sync.run_unsynced|wesnoth.sync.run_unsynced]] 
|-
|''wesnoth.units''
[[LuaAPI/wesnoth/units#wesnoth.units.resistance_against|wesnoth.units.resistance_against]] 
[[LuaAPI/wesnoth/units#wesnoth.units.ability|wesnoth.units.ability]] 
[[LuaAPI/wesnoth/units#wesnoth.units.add_modification|wesnoth.units.add_modification]] 
[[LuaAPI/wesnoth/units#wesnoth.units.advance|wesnoth.units.advance]] 
[[LuaAPI/wesnoth/units#wesnoth.units.chance_to_be_hit|wesnoth.units.chance_to_be_hit]] 
[[LuaAPI/wesnoth/units#wesnoth.units.clone|wesnoth.units.clone]] 
[[LuaAPI/wesnoth/units#wesnoth.units.create|wesnoth.units.create]] 
[[LuaAPI/wesnoth/units#wesnoth.units.create_animator|wesnoth.units.create_animator]] 
[[LuaAPI/wesnoth/units#wesnoth.units.defense_on|wesnoth.units.defense_on]] 
[[LuaAPI/wesnoth/units#wesnoth.units.erase|wesnoth.units.erase]] 
[[LuaAPI/wesnoth/units#wesnoth.units.extract|wesnoth.units.extract]] 
[[LuaAPI/wesnoth/units#wesnoth.units.find|wesnoth.units.find]] 
[[LuaAPI/wesnoth/units#wesnoth.units.find_attack|wesnoth.units.find_attack]] 
[[LuaAPI/wesnoth/units#wesnoth.units.find_on_map|wesnoth.units.find_on_map]] 
[[LuaAPI/wesnoth/units#wesnoth.units.find_on_recall|wesnoth.units.find_on_recall]] 
[[LuaAPI/wesnoth/units#wesnoth.units.get|wesnoth.units.get]] 
[[LuaAPI/wesnoth/units#wesnoth.units.get_hovered|wesnoth.units.get_hovered]] 
[[LuaAPI/wesnoth/units#wesnoth.units.jamming_on|wesnoth.units.jamming_on]] 
[[LuaAPI/wesnoth/units#wesnoth.units.matches|wesnoth.units.matches]] 
[[LuaAPI/wesnoth/units#wesnoth.units.movement_on|wesnoth.units.movement_on]] 
[[LuaAPI/wesnoth/units#wesnoth.units.rebuild|wesnoth.units.rebuild]] 
[[LuaAPI/wesnoth/units#wesnoth.units.remove_modifications|wesnoth.units.remove_modifications]] 
[[LuaAPI/wesnoth/units#wesnoth.units.scroll_to|wesnoth.units.scroll_to]] 
[[LuaAPI/wesnoth/units#wesnoth.units.select|wesnoth.units.select]] 
[[LuaAPI/wesnoth/units#wesnoth.units.to_map|wesnoth.units.to_map]] 
[[LuaAPI/wesnoth/units#wesnoth.units.to_recall|wesnoth.units.to_recall]] 
[[LuaAPI/wesnoth/units#wesnoth.units.transform|wesnoth.units.transform]] 
[[LuaAPI/wesnoth/units#wesnoth.units.vision_on|wesnoth.units.vision_on]] 
|-
|''ai''
[[LuaAPI/ai#ai.aspects|ai.aspects]] 
[[LuaAPI/ai#ai.attack|ai.attack]] 
[[LuaAPI/ai#ai.check_attack|ai.check_attack]] 
[[LuaAPI/ai#ai.check_move|ai.check_move]] 
[[LuaAPI/ai#ai.check_recall|ai.check_recall]] 
[[LuaAPI/ai#ai.check_recruit|ai.check_recruit]] 
[[LuaAPI/ai#ai.check_stopunit|ai.check_stopunit]] 
[[LuaAPI/ai#ai.fallback_human|ai.fallback_human]] 
[[LuaAPI/ai#ai.get_attacks|ai.get_attacks]] 
[[LuaAPI/ai#ai.get_targets|ai.get_targets]] 
[[LuaAPI/ai#ai.move|ai.move]] 
[[LuaAPI/ai#ai.move_full|ai.move_full]] 
[[LuaAPI/ai#ai.read_only|ai.read_only]] 
[[LuaAPI/ai#ai.recall|ai.recall]] 
[[LuaAPI/ai#ai.recruit|ai.recruit]] 
[[LuaAPI/ai#ai.side|ai.side]] 
[[LuaAPI/ai#ai.stopunit_all|ai.stopunit_all]] 
[[LuaAPI/ai#ai.stopunit_attacks|ai.stopunit_attacks]] 
[[LuaAPI/ai#ai.stopunit_moves|ai.stopunit_moves]] 
[[LuaAPI/ai#ai.suitable_keep|ai.suitable_keep]] 
|-
|''filesystem''
[[LuaAPI/filesystem#filesystem.canonical_path|filesystem.canonical_path]] 
[[LuaAPI/filesystem#filesystem.have_asset|filesystem.have_asset]] 
[[LuaAPI/filesystem#filesystem.have_file|filesystem.have_file]] 
[[LuaAPI/filesystem#filesystem.image_size|filesystem.image_size]] 
[[LuaAPI/filesystem#filesystem.read_file|filesystem.read_file]] 
[[LuaAPI/filesystem#filesystem.resolve_asset|filesystem.resolve_asset]] 
|-
|''functional''
[[LuaAPI/functional#functional.choose|functional.choose]] 
[[LuaAPI/functional#functional.choose_map|functional.choose_map]] 
[[LuaAPI/functional#functional.filter|functional.filter]] 
[[LuaAPI/functional#functional.filter_map|functional.filter_map]] 
[[LuaAPI/functional#functional.find|functional.find]] 
[[LuaAPI/functional#functional.find_map|functional.find_map]] 
[[LuaAPI/functional#functional.map|functional.map]] 
[[LuaAPI/functional#functional.map_array|functional.map_array]] 
[[LuaAPI/functional#functional.reduce|functional.reduce]] 
[[LuaAPI/functional#functional.take_while|functional.take_while]] 
[[LuaAPI/functional#functional.zip|functional.zip]] 
|-
|''gui''
[[LuaAPI/gui#gui.add_widget_definition|gui.add_widget_definition]] 
[[LuaAPI/gui#gui.get_user_choice|gui.get_user_choice]] 
[[LuaAPI/gui#gui.show_dialog|gui.show_dialog]] 
[[LuaAPI/gui#gui.show_help|gui.show_help]] 
[[LuaAPI/gui#gui.show_inspector|gui.show_inspector]] 
[[LuaAPI/gui#gui.show_lua_console|gui.show_lua_console]] 
[[LuaAPI/gui#gui.show_menu|gui.show_menu]] 
[[LuaAPI/gui#gui.show_narration|gui.show_narration]] 
[[LuaAPI/gui#gui.show_popup|gui.show_popup]] 
[[LuaAPI/gui#gui.show_prompt|gui.show_prompt]] 
[[LuaAPI/gui#gui.show_recruit_dialog|gui.show_recruit_dialog]] 
[[LuaAPI/gui#gui.show_recall_dialog|gui.show_recall_dialog]] 
[[LuaAPI/gui#gui.show_story|gui.show_story]] 
[[LuaAPI/gui#gui.switch_theme|gui.switch_theme]] 
[[LuaAPI/gui#gui.widget|gui.widget]] 
|-
|''location_set''
[[LuaAPI/location_set#location_set.clear|location_set.clear]] 
[[LuaAPI/location_set#location_set.clone|location_set.clone]] 
[[LuaAPI/location_set#location_set.create|location_set.create]] 
[[LuaAPI/location_set#location_set.diff|location_set.diff]] 
[[LuaAPI/location_set#location_set.empty|location_set.empty]] 
[[LuaAPI/location_set#location_set.filter|location_set.filter]] 
[[LuaAPI/location_set#location_set.get|location_set.get]] 
[[LuaAPI/location_set#location_set.insert|location_set.insert]] 
[[LuaAPI/location_set#location_set.inter|location_set.inter]] 
[[LuaAPI/location_set#location_set.inter_merge|location_set.inter_merge]] 
[[LuaAPI/location_set#location_set.invert|location_set.invert]] 
[[LuaAPI/location_set#location_set.iter|location_set.iter]] 
[[LuaAPI/location_set#location_set.of_map|location_set.of_map]] 
[[LuaAPI/location_set#location_set.of_pairs|location_set.of_pairs]] 
[[LuaAPI/location_set#location_set.of_raw|location_set.of_raw]] 
[[LuaAPI/location_set#location_set.of_shroud_data|location_set.of_shroud_data]] 
[[LuaAPI/location_set#location_set.of_triples|location_set.of_triples]] 
[[LuaAPI/location_set#location_set.of_wml_var|location_set.of_wml_var]] 
[[LuaAPI/location_set#location_set.random|location_set.random]] 
[[LuaAPI/location_set#location_set.remove|location_set.remove]] 
[[LuaAPI/location_set#location_set.size|location_set.size]] 
[[LuaAPI/location_set#location_set.stable_iter|location_set.stable_iter]] 
[[LuaAPI/location_set#location_set.symm|location_set.symm]] 
[[LuaAPI/location_set#location_set.to_map|location_set.to_map]] 
[[LuaAPI/location_set#location_set.to_pairs|location_set.to_pairs]] 
[[LuaAPI/location_set#location_set.to_shroud_data|location_set.to_shroud_data]] 
[[LuaAPI/location_set#location_set.to_stable_pairs|location_set.to_stable_pairs]] 
[[LuaAPI/location_set#location_set.to_triples|location_set.to_triples]] 
[[LuaAPI/location_set#location_set.to_wml_var|location_set.to_wml_var]] 
[[LuaAPI/location_set#location_set.union|location_set.union]] 
[[LuaAPI/location_set#location_set.union_merge|location_set.union_merge]] 
|-
|''mathx''
[[LuaAPI/mathx#mathx.clamp|mathx.clamp]] 
[[LuaAPI/mathx#mathx.lerp|mathx.lerp]] 
[[LuaAPI/mathx#mathx.random|mathx.random]] 
[[LuaAPI/mathx#mathx.random_choice|mathx.random_choice]] 
[[LuaAPI/mathx#mathx.round|mathx.round]] 
[[LuaAPI/mathx#mathx.shuffle|mathx.shuffle]] 
|-
|''stringx''
[[LuaAPI/stringx#stringx.anim_split|stringx.anim_split]] 
[[LuaAPI/stringx#stringx.escaped_split|stringx.escaped_split]] 
[[LuaAPI/stringx#stringx.format_conjunct_list|stringx.format_conjunct_list]] 
[[LuaAPI/stringx#stringx.format_disjunct_list|stringx.format_disjunct_list]] 
[[LuaAPI/stringx#stringx.iter_range|stringx.iter_range]] 
[[LuaAPI/stringx#stringx.iter_ranges|stringx.iter_ranges]] 
[[LuaAPI/stringx#stringx.join|stringx.join]] 
[[LuaAPI/stringx#stringx.join_map|stringx.join_map]] 
[[LuaAPI/stringx#stringx.map_split|stringx.map_split]] 
[[LuaAPI/stringx#stringx.parenthetical_split|stringx.parenthetical_split]] 
[[LuaAPI/stringx#stringx.parse_range|stringx.parse_range]] 
[[LuaAPI/stringx#stringx.quoted_split|stringx.quoted_split]] 
[[LuaAPI/stringx#stringx.split|stringx.split]] 
[[LuaAPI/stringx#stringx.trim|stringx.trim]] 
[[LuaAPI/stringx#stringx.vformat|stringx.vformat]] 
|-
|''unit_test''
[[LuaAPI/unit_test#unit_test.assert|unit_test.assert]] 
[[LuaAPI/unit_test#unit_test.assert_approx_equal|unit_test.assert_approx_equal]] 
[[LuaAPI/unit_test#unit_test.assert_contains|unit_test.assert_contains]] 
[[LuaAPI/unit_test#unit_test.assert_equal|unit_test.assert_equal]] 
[[LuaAPI/unit_test#unit_test.assert_greater|unit_test.assert_greater]] 
[[LuaAPI/unit_test#unit_test.assert_greater_equal|unit_test.assert_greater_equal]] 
[[LuaAPI/unit_test#unit_test.assert_in_range|unit_test.assert_in_range]] 
[[LuaAPI/unit_test#unit_test.assert_less|unit_test.assert_less]] 
[[LuaAPI/unit_test#unit_test.assert_less_equal|unit_test.assert_less_equal]] 
[[LuaAPI/unit_test#unit_test.assert_not_equal|unit_test.assert_not_equal]] 
[[LuaAPI/unit_test#unit_test.assert_nothrow|unit_test.assert_nothrow]] 
[[LuaAPI/unit_test#unit_test.assert_throws|unit_test.assert_throws]] 
[[LuaAPI/unit_test#unit_test.assert_throws_with|unit_test.assert_throws_with]] 
[[LuaAPI/unit_test#unit_test.fail|unit_test.fail]] 
[[LuaAPI/unit_test#unit_test.finish|unit_test.finish]] 
[[LuaAPI/unit_test#unit_test.fire_wml_menu_item|unit_test.fire_wml_menu_item]] 
[[LuaAPI/unit_test#unit_test.log|unit_test.log]] 
[[LuaAPI/unit_test#unit_test.succeed|unit_test.succeed]] 
[[LuaAPI/unit_test#unit_test.tostring|unit_test.tostring]] 
|-
|''wml''
[[LuaAPI/wml#wml.all_variables|wml.all_variables]] 
[[LuaAPI/wml#wml.array_access.get|wml.array_access.get]] 
[[LuaAPI/wml#wml.array_access.get_proxy|wml.array_access.get_proxy]] 
[[LuaAPI/wml#wml.array_access.set|wml.array_access.set]] 
[[LuaAPI/wml#wml.array_variables|wml.array_variables]] 
[[LuaAPI/wml#wml.attribute_count|wml.attribute_count]] 
[[LuaAPI/wml#wml.child_array|wml.child_array]] 
[[LuaAPI/wml#wml.child_count|wml.child_count]] 
[[LuaAPI/wml#wml.child_range|wml.child_range]] 
[[LuaAPI/wml#wml.clone|wml.clone]] 
[[LuaAPI/wml#wml.diff|wml.diff]] 
[[LuaAPI/wml#wml.equal|wml.equal]] 
[[LuaAPI/wml#wml.error|wml.error]] 
[[LuaAPI/wml#wml.eval_conditional|wml.eval_conditional]] 
[[LuaAPI/wml#wml.find_child|wml.find_child]] 
[[LuaAPI/wml#wml.fire|wml.fire]] 
[[LuaAPI/wml#wml.get_child|wml.get_child]] 
[[LuaAPI/wml#wml.get_nth_child|wml.get_nth_child]] 
[[LuaAPI/wml#wml.interpolate|wml.interpolate]] 
[[LuaAPI/wml#wml.literal|wml.literal]] 
[[LuaAPI/wml#wml.load|wml.load]] 
[[LuaAPI/wml#wml.matches_filter|wml.matches_filter]] 
[[LuaAPI/wml#wml.merge|wml.merge]] 
[[LuaAPI/wml#wml.parse|wml.parse]] 
[[LuaAPI/wml#wml.parsed|wml.parsed]] 
[[LuaAPI/wml#wml.patch|wml.patch]] 
[[LuaAPI/wml#wml.remove_child|wml.remove_child]] 
[[LuaAPI/wml#wml.remove_children|wml.remove_children]] 
[[LuaAPI/wml#wml.shallow_literal|wml.shallow_literal]] 
[[LuaAPI/wml#wml.shallow_parsed|wml.shallow_parsed]] 
[[LuaAPI/wml#wml.tag|wml.tag]] 
[[LuaAPI/wml#wml.tostring|wml.tostring]] 
[[LuaAPI/wml#wml.tovconfig|wml.tovconfig]] 
[[LuaAPI/wml#wml.valid|wml.valid]] 
[[LuaAPI/wml#wml.variables|wml.variables]] 
[[LuaAPI/wml#wml.variables_proxy|wml.variables_proxy]] 
|-
|''wml-utils''
[[LuaAPI/wml-utils#utils.check_key|utils.check_key]] 
[[LuaAPI/wml-utils#utils.get_sides|utils.get_sides]] 
[[LuaAPI/wml-utils#utils.handle_event_commands|utils.handle_event_commands]] 
[[LuaAPI/wml-utils#utils.optional_side_filter|utils.optional_side_filter]] 
[[LuaAPI/wml-utils#utils.scoped_var|utils.scoped_var]] 
[[LuaAPI/wml-utils#utils.set_exiting|utils.set_exiting]] 
[[LuaAPI/wml-utils#utils.vwriter|utils.vwriter]] 
|}<includeonly>[[Category:Lua Reference]]</includeonly><noinclude>A box with all the Lua functions, each one linking to the page and section they are described in. It was generated using [[/Updating|this method]]. This box should be included in [[LuaAPI|Lua reference]] page.</noinclude>

SingleUnitWML

2025-03-27T10:25:23Z

Shadowm: /* Unit Data */ Rewrite some confusing wording surrounding [modifications] [advancement]

{{WML Tags}}
The '''[unit]''' tag describes a single unit on the map or in memory, for example Konrad.
It is different from the '''[unit_type]''' in '''[units]''', which describes a class of units. However it takes many of the same keys and thus can generally override the inherited properties from the associated '''[unit_type]'''.

'''[unit]''' can be used inside '''[side]''' ([[SideWML]]) for units present at start of the scenario, or as [[DirectActionsWML]] for units created during the game. (It is also used in save-files.)

This contains keys and tags which describe the unit's [[#Unit Data|persistent data]], as well as certain [[#Unit State|state variables]] which will also persist with the unit but will change frequently as gameplay progresses. Finally, there are some keys to set certain [[#Creation Options|one-time options]] for how the unit will be initially created, which will ''not'' persist beyond initial creation.

== Unit Data ==
The following keys and tags describe the unit itself, and will persist with the unit (though some may change automatically when the unit advances):
* {{anchor|type|'''type'''}}: the ID of the unit's unit type. This key is mandatory. See [[UnitTypeWML]].

* {{anchor|language_name|'''language_name'''}}: the name of the unit's unit type. See [[UnitTypeWML]].

* '''variation''': the [variation] of the [unit_type] as which the unit will appear.

* '''parent_type''': overrides '''type''' if this is present. This is likely of little use to WML authors; it is automatically generated when needed by the game (to keep track of some [unit_type][variation]s).

* '''side''': the side that the unit is on. It has to be an existing side, even if the unit is created in a variable. Defaults to 1, except when the [unit] tag appears inside a [side], in which case the unit always belongs to that side, and this key is ignored.

* '''id''': a unique identifier for the unit. This is (usually) not displayed to the player, but is to be used only for identifying and filtering units. If not specified, a random one will be generated for the unit to ensure that each unit has a unique '''id''' attribute (as will happen when a unit is recruited normally). In older versions, the '''description''' attribute specified a unique ID. (The one instance when an id is displayed to the player is when the leader's id is used as the default for a [[SideWML|side]]'s '''current_player''' attribute.) Note: While it IS technically possible to create multiple units with the same ID, doing so may produce unpredictable results in many cases. WML should therefore be structured in such a way that no two units in existence ever end up with the same ID.

* '''gender''': can be set to male or female to designate the gender of the unit. Default is male (unless [[#random_gender|'''random_gender''']] is set to "yes"), but if the unit has only a female variant it will be female.

* '''name''': the user-visible name of the unit. Note that the player may use the "rename unit" action to change this (unless '''unrenamable''' is also set). Although this is a translated string, see [[GettextForWesnothDevelopers#Proper_nouns_in_strings|proper nouns in strings]] before using it in a translatable string.

* '''unrenamable''': if 'yes', the user-visible name of the unit cannot be changed by the player (which is only possible when the unit is on the player's side anyway).

* '''canrecruit''': a special key for leaders.
** '''no''': default. Unit cannot recruit.
** '''yes''': unit can recruit.
: Normally when a team controls no units with '''canrecruit=yes''', that team loses. However, even if your team has lost you continue to play with whatever units you still have until the scenario is over. Usually scenarios end when only one team is left with a leader that can recruit, but special victory conditions can be set up in campaigns. Normally you want to set the leader of a side with '''canrecruit=yes'''. If you don't want the leader to recruit, it is usually better to just not give him any unit types to recruit, than to make a special victory condition. Units with '''canrecruit=yes''' are exempt from upkeep costs. So that leaders do not need to be given the ''loyal'' trait.
: More than one unit with '''canrecruit=yes''' for the same side (see [[SideWML]]) are allowed in single player, if the side is human-controlled.

* '''extra_recruit''': a list of unit types which this unit can recruit in addition to the ones given by its [side]recruit= (only relevant for units with '''canrecruit=yes''').

* {{anchor|filter_recall|'''[filter_recall]'''}}: A leader can only recall those units which pass the SUF. (Meaningful only if canrecruit=yes.)
**'''[[StandardUnitFilter]]''' tags and keys

* '''level''': the unit's current level. Defaults to the level of the [unit_type] described by [[#type|'''type''']]. This is generally not set manually.

* '''upkeep''': the amount of upkeep the unit will require each turn.
** '''loyal''': no upkeep cost. Can be changed by the effect 'loyal' (see [[EffectWML]])
** '''free''': synonymous with "loyal".
** '''full''': unit costs ''level'' upkeep (see [[UnitTypeWML]]).
** An integer can be used to set the upkeep cost to that number.
** The default is "full".
** Leaders (units with '''canrecruit=yes''') never pay upkeep no matter what upkeep is set to.
** Normally you don't want to muck with this value. If you want to give a side units without upkeep costs, give those units the 'loyal' trait.

* {{DevFeature1.13|0}} '''recall_cost''': the recall cost of this unit. Overrides the values specified by the unit's type ([[UnitTypeWML|[unit_type]]]), its side ([[SideWML|[side]]]), and the global [[GameConfigWML|[game_config]]] value. A value of -1 is equivalent to not specifying this attribute. {{DevFeature1.15|0}} Units are now recalled for AI sides even if the recall_cost is larger than the unit's worth (essentially its cost, plus potentially a bonus for experience points). In 1.14 and earlier, units were not recalled by the AI in this case even if this was the only recall/recruit action possible to the AI.

* '''overlays''': a comma-separated list of images that are overlayed on the unit.
** {{DevFeature1.15|0}} This key is supported when creating a unit from WML, but will be empty when writing the unit back to WML; the overlays will instead be stored as [modifications].

* '''max_hitpoints''': The maximum hitpoints the unit has when at full health. Default is the max HP set for the [unit_type] described by [[#type|'''type''']].

* '''max_experience''': The experience the unit needs to advance. Default is the experience required for the [unit_type] described by [[#type|'''type''']].

* {{anchor|max_moves|'''max_moves'''}}: The maximum number of movement points the unit has. Default is the number of movement specified for the [unit_type] described by [[#type|'''type''']].

* '''vision''': The the number of vision points to calculate the unit's sight range. Default is the number of vision points specified for the [unit_type] described by [[#type|'''type''']].

* '''jamming''': {{DevFeature1.15|0}} The number of jamming points for the unit. Default is the number of jamming points specified for the [unit_type] described by [[#type|'''type''']].

* '''flying''': 'yes' if the unit's [[UnitsWML#.5Bmovetype.5D|movetype]] has flying=yes. For units that don't fly, the '''flying''' attribute is generally omitted rather than being recorded as 'no'. In SingleUnitWML, this attribute has been called '''flying''' since it was added in 1.11.2, it was never called 'flies'.

* {{anchor|max_attacks|'''max_attacks'''}}: The number of attacks the unit can have per turn. Default is the number of attacks specified for the [unit_type] described by [[#type|'''type''']].

* '''profile''': sets a portrait image for this unit. Default is the portrait image set for the [unit_type] described by [[#type|'''type''']]. When the unit advances, if the value of profile is different from the unit-type portrait, that value is preserved. If the profile field is empty or the same as the unit-type portrait, the level-advance changes the unit portrait to the default for the new level and type. See [[UnitTypeWML]] for the rules used for locating files.
** If "unit_image" is given instead of a filename, uses the unit's base image as the portrait (in the same manner that unit types without portraits do by default).
** If "none" is given instead of a filename, no image will be displayed.

* '''small_profile''': sets a small portrait image for this unit. See the '''profile''' attribute above for advancement and special values. As with [[UnitTypeWML]], the location heuristic of the '''profile''' attribute is disabled when the '''small_profile''' attribute is provided.

* '''role''': used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).

* '''dismissable''': {{DevFeature1.19|9}} If 'no', unit cannot be dismissed from the recall list using the ''Dismiss'' button in Unit Recall dialog. Default: 'yes'.

* '''block_dismiss_message''': {{DevFeature1.19|9}} Sets the message to be shown when ''dismissable'' is ''no'' and the user presses the ''Dismiss'' button in Unit Recall dialog. If not set, a default message will be shown instead.

* {{anchor|variables|'''[variables]'''}}: a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable '''unit'''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]). The subnode '''mods''' is special as it is deleted on every unit rebuild (for example when the unit advances or when an [object] is removed). This makes it possible to implement [effect]s that change variables, as those will also be reapplied whenever the unit is reset. (so in particular if your effect changes the variables mods.<whatever> [remove_object] will work properly for those objects.) For example the following code will define a apply_to=moves_on_recruits effect that gives units with that effect full movement when recruited

<syntaxhighlight lang='lua'>
function wesnoth.effects.move_on_recruit(u, cfg)
-- maybe better use a status than a variable ?
u.variables["mods.move_on_recruit"] = true
end
on_event("recruit,recall", function(ec)
local unit = wesnoth.get_unit(ec.x1, ec.y1)
if unit and unit.variables["mods.move_on_recruit"] then
unit.attacks_left = 1
unit.moves = unit.max_moves
end
end)
</syntaxhighlight>
And since we used the mods subtable, [remove_object] will work properly for objects that give this effect.

* {{anchor|modifications|'''[modifications]'''}}: a collection of tags describing changes that have been made to the unit. Any number and combination of tags of each type may be specified.
** '''[trait]''': a trait the unit has. Same format as [[UnitsWML#.5Btrait.5D|[trait], UnitsWML]].
** '''[object]''': an object the unit has. Same format as [[DirectActionsWML#.5Bobject.5D|[object], DirectActionsWML]].
** '''[advancement]''': an advancement (AMLA) that has been applied to the unit. Same format as [[UnitTypeWML#After max level advancement (AMLA)|[advancement], UnitTypeWML]]. These are automatically added when the player confirms an AMLA in the Advance Unit dialog, but they can also be specified manually to indicate that the unit already has a particular advancement applied; by providing only an advancement ID with no effects, it is even possible to disable a future advancement. {{DevFeature1.13|2}} In versions prior to 1.13.2, this tag was named [advance].

* '''[event]''' The event is copied from this unit's WML description into the scenario. The event is carried along with the unit (even during advancement) and inserted into a scenario whenever this unit is first included. A [unit][event] requires a non-empty id= attribute.

* '''description''': overrides the unit type description for this unit. Note that this will be reset when the unit advances. To avoid this, one can either set up a ''post_advance'' [[EventWML|event]] to override the default description after promotion, or use an [object] with a profile [[EffectWML|effect]] to change the unit description.

* '''[special_note]''' {{DevFeature1.15|2}} see [[UnitTypeWML#Special_Notes]].

* '''ai_special''': causes the unit to act differently
** "guardian" the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it). Does the same as '''[status] guardian = 'yes''''.

* {{anchor|ai|'''[ai]'''}}: This affects how the computer will control this unit (currently only used by [[FormulaAI]]).
** '''formula''': if set, the unit will execute this code during the "unit_formulas" stage, assuming that the "unit_formulas" stage has been enabled for this side
** '''priority''', '''loop_formula''', '''[vars]''': see the [[FormulaAI]] documentation for details
** {{DevFeature1.15|?}} '''[candidate_action]''': Add a candidate action that only applies to this unit; see [[Wesnoth_AI_Framework#The_.5Bcandidate_action.5D_Tag|here]] for details. The [filter_own] tag is not supported.
*** '''stage''': If specified, the candidate action is added to the stage with the given ID, instead of the default stage (which is main_loop).
** {{DevFeature1.15|?}} '''[micro_ai]''': Add a micro AI that only applies to this unit; see [[Micro AIs]] for details. This tag does not support side, action, or [filter].

* '''traits_description''': the description of the unit's traits which is displayed. However if it is not specified explicitly, the unit's actual traits' names will be used instead, so it is normally not necessary to set this.

*'''alignment''': one of lawful/neutral/chaotic/liminal (See [[TimeWML]]). Default is the alignment of the [unit_type] described by [[#type|'''type''']]. This is generally not set manually.

*'''advances_to''': comma-separated list of unit types to which this unit can advance. Will override the default provided by the [unit_type]. This is generally not set manually.

*'''race''': See {{tag|UnitsWML|race}}. Will override the default provided by the [unit_type]. This is generally not set manually.

*'''undead_variation''': Will override the default provided by the [unit_type]. This is generally not set manually.

*'''usage''': Will override the default provided by the [unit_type]. This is generally not set manually.

*'''zoc''': whether the unit has a zone of control. Will override the default provided by the [unit_type]. This is generally not set manually.

*'''[movement_costs]''', '''[vision_costs]''', '''[defense]''', and '''[resistance]''': Can be used to modify [[UnitsWML#.5Bmovetype.5D|existing values]].

*'''[attack]''': Takes the same syntax as [[UnitTypeWML#Attacks|[unit_type][attack]]]. By default, the attacks from the [unit_type] will be included. '''Note:''' using this tag will replace ''all'' [attack] tags with the new one.

*'''hidden''': Implementation detail of [[InterfaceActionsWML#%5Bhide_unit%5D|[hide_unit]]]. This should not be set manually.

== Unit State ==
The following keys and tags describe the current state of the unit, and will change regularly as gameplay progresses:
* '''x''', '''y''': the location of the unit. By default (unless modified by [[#placement|'''placement''']] below) if a location isn't provided and the side the unit will belong to has a recall list, the unit will be created on the recall list. The recall list can also be explicitly specified as the location with "recall,recall".

* '''location_id''': {{DevFeature1.13|8}} the location of the unit, referencing one of the special locations defined by the map. This overrides '''x''' and '''y''' if present but otherwise has the same effect and can be modified by the placement options.

* '''facing''': which way the unit is facing (this only affects how the unit is displayed).
** Possible values are '''se''', '''s''', '''sw''', '''nw''', '''n''', '''ne'''. Note that some unit types may not have distinct animations for each direction.

* '''goto_x''':, '''goto_y''': the unit's current movement destination. Default is 0,0 i.e. the unit is not on a course.

* '''hitpoints''': the HP of the unit. Default [[#max_hitpoints|'''max_hitpoints''']].

* '''experience''': the XP of the unit. Default is 0.

* '''moves''': number of movement points the unit has left. Default is [[#max_moves|'''max_moves''']].
: '''Note:''' Do not assume that moves=max_moves on turns when the unit doesn't move. The wesnoth AIs sometimes manipulate the moves variable during its turn, for internal reasons.

* '''resting''': whether the unit has not moved yet this turn. Used to decide whether to give the unit rest healing. Note that this can be true even if moves is not equal to max_moves.

* '''attacks_left''': number of attacks the unit has left. Default is '''max_attacks'''.

* {{anchor|status|'''[status]'''}}: the status of the unit. This affects different features of the unit, for example whether the unit loses health each turn. Default for all keys is 'no', but this can be changed by the scenario or by special abilities (see [[AbilitiesWML]]). The Status Table displays the status of each unit using the three images '''misc/poisoned.png''', '''misc/slowed.png''' and '''misc/petrified.png'''; other keys do not appear in the Status Table.
** '''poisoned''': if 'yes', the unit loses 8 HP each turn. See also ''heals'', ''cures'', [[AbilitiesWML]].
** '''slowed''': if 'yes', the unit has 50% of its normal movement and does half damage. When the controller of the unit's turn is over, '''slowed''' is set to 'no'.
** '''petrified''': if 'yes', the unit cannot move, attack, or be attacked.
** '''uncovered''': if 'yes', the unit has performed an action (e.g. attacking) that causes it to no longer be hidden until the next turn. For cutscenes, it may be useful to set this manually.
** '''guardian''': if 'yes', the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it). Does the same as '''ai_special = "guardian"'''.
** '''unhealable''': if set to 'yes', the unit cannot be healed through normal game mechanics. This includes the healing by resting. It does ''not'' prevent the unit from being healed by WML or Lua code.
** '''unpoisonable''': if set to 'yes', the unit cannot be poisoned.
** '''undrainable''': if set to 'yes', the attacker can't gain health with drain ability attacking this unit.
** '''unplagueable''': if set to 'yes', the unit cannot be affected by plague attack.
** '''not_living''': Deprecated, this is automatically set when all three above are set and vice versa.
** '''unslowable''': if set to 'yes', the unit cannot be slowed.
** '''unpetrifiable''': if set to 'yes', the unit cannot be petrified.
** '''invulnerable''': {{DevFeature1.13|6}} if 'yes', attacks can't hit the unit. The AI and the attack dialog take it into account.
** One can add other keys to [status], but they must have boolean values, and they will not do anything meaningful on their own (but can be checked from events and acted upon accordingly). For example, a scenario can set unit.status.''my_custom_key'' to 'yes' or 'no'.

* '''invulnerable''': {{DevFeature1.13|6}} a shorthand to set the ''invulnerable'' status. Useful in [[CommandMode]] for debugging purposes. It's recommended to use [status] in written code instead.

== Creation Options ==
In addition to the unit's persistent data itself, there are several options for controlling how the unit will be created, as follows:
* '''placement''': How the unit should be placed: can be one value or a comma-separated list of values. Default value is 'map,leader' for a leader given directly in [side], "" otherwise. By default, 'map,recall' is implicitly appended to the end of the list.
** '''map''': If x,y (or location_id) are explicitly given and point to a valid on-map location - try to place the unit at the nearest free location to there, never overwriting existing units. Successful if x,y (or location_id) are given and a valid on-map vacant location near it can be found.
** '''leader''': Try to place unit near the leader, if leader is not present or is in recall list - try to place unit near the start location for this side. Successful if a valid on-map vacant location can be found near leader or near start location.
** '''recall''': Place unit on recall list. Always successful.
** '''map_overwrite''': If x,y are explicitly given and point to a valid on-map location - try to place unit at this location, if there was a unit there - overwriting it, without firing events. {{DevFeature1.13|8}} Deprecated, use placement=map and overwrite=yes instead.
** '''map_passable''': If x,y are explicitly given and point to a valid on-map location - try to place unit at this location; if the hex is of an impassable terrain for the unit being placed, or is already occupied by another unit, the new unit will be placed in the nearest vacant hex. {{DevFeature1.13|8}} Deprecated, use placement=map and passable=yes instead.
** '''leader_passable''': Similar to "leader", with the additional restriction that the selected location is not impassable for the unit being placed. {{DevFeature1.13|8}} Deprecated, use placement=leader and passable=yes instead.
* '''passable''': {{DevFeature1.13|8}} (default=no) If yes, and the specified location is of an impassable terrain for the unit being placed, the new unit will be placed in the nearest hex that is of a passable terrain for it.
* '''overwrite''': {{DevFeature1.13|8}} (default=no) If yes, always place the unit at the exact specified location, overwriting the existing unit if there is one. Generally you don't want to use this together with placement=leader.

* '''generate_name''': (default=yes) will generate a new '''name''' if there isn't one specified for the unit, as if the unit were a freshly-recruited one.
* '''random_traits''': "no" will prevent random trait generation for units. You should only need to set this for placed nonleaders in multiplayer games or if you want to give the unit fewer traits than it would normally get for its unit type. When generating traits for a unit, first traits the unit has already been given are excluded. Then "musthave" traits (undead, mechanical) for the unit type are given. Then for leaders ('''canrecruit=yes''') traits that are not available to "any" (currently that's all of them to avoid a multiplayer OOS issue, but later will be restricted based on multiplayer play balance issues) are removed from consideration. Then traits are added randomly until the maximum allowed for the unit type is reached or there are no more available traits. Random traits can now be used in MP games but only when spawned in an event, so not for leaders and other units in the [side] definition.

* '''random_gender''': "yes" will cause the gender of the unit with male and female variations to be male 50% of the time, female 50% of the time. If the unit has only one gender variant it will always be given the correct one.

* '''to_variable''': (only for [event][unit]) creates the unit into the given variable instead of placing it on the map.

* '''animate''': whether to display the recruitment animation for this unit as if it were being recruited/recalled. Defaults to "no". Irrelevant when the [unit] tag appears inside a [side].

== See Also ==

* [[UnitTypeWML]]
* [[InternalActionsWMLUnitTags]]
* [[ReferenceWML]]

[[Category:WML Reference]]

LuaAPI/types/widget

2025-03-14T08:00:54Z

Shadowm: /* on_link_click */ Fix vague DevFeature

LuaAPI/gui

2025-02-27T22:07:15Z

Shadowm: gui.show_recruit/recall_dialog are dev-only, fix template position in gui.switch_theme

{{DevFeature1.15|0}}

== Submodules ==
=== gui.widget ===

A [[LuaAPI/gui/widget|submodule]] containing functions for working with widgets in custom dialogs.

== Functions ==
=== gui.add_widget_definition ===

* '''gui.add_widget_definition'''(''widget_type'', ''definition_id'', ''wml_content'')

Creates a new WML widget definition for the specified widget type, which can be referenced from dialog WML in the '''definition''' key.

=== gui.get_user_choice ===

* '''gui.get_user_choice'''(''attributes'', ''options'')

Shows a message dialog (like the one used by the <tt>[[InterfaceActionsWML#.5Bmessage.5D|[message]]]</tt> tag) with a series of options and returns the index (1-based) of the chosen option, which can be stored as a Lua variable.

'''IMPORTANT NOTE: this function is broken in Wesnoth 1.16.0 and 1.16.1.''' If you wish to use it, you should also use wesnoth.current_version to check that your code is being run on Wesnoth 1.16.2 or higher. Alternatively, you may try using [[#gui.show_narration|gui.show_narration]] instead, which has a similar function but a wider range of features.

The first argument is a table of attributes which are directly passed to the underlying <tt>[message]</tt> tag.

The second argument is a table of options, which are used to construct a series of underlying <tt>[option]</tt> tags. Most Lua data types are supported, but a few aren't:
* If the option is a ''table'' or a ''WML table'', these fields are supported:
** ''image'': icon shown in the first column;
** ''label'': text shown in the second column;
** ''description'': text shown in the third column (''message'' is also supported as an alias);
** ''default'': whether this is option is the one selected when the dialog is shown (boolean).
* If the option can be cast to a string (''strings'', ''translatable strings'', ''numbers'', ''booleans''), it is used for the content of the description field, which means that the first two columns will be empty.
* Otherwise, it raises an "invalid data type" error.

Example taken from the test scenario (if not used in an event then change the speaker):

<syntaxhighlight lang='lua'>
local result = gui.get_user_choice(
{ speaker = "unit", message = "Pick your poison" },
{ { image = "items/potion-red.png",
label = "Something red",
description = "Take a sip and enjoy" },
{ image = "items/potion-blue.png",
label = "Nice blue",
description = "Surely you’ll like that one",
default = true },
{ image = "items/potion-yellow.png",
label = "Oh noes yellow",
description = "Oh I’m sure you’ll love that one" },
{ image = "scenery/well.png",
label = "A nice well",
description = "Grab a bucket and fetch some water" },
{ image = "items/holy-water.png",
label = "Oh nice bottle",
description = "Feel the divinity" },
-- Should have an empty first column and a second column on two lines.
{ label = "Well a nice and black drink.\nToo dark too see?",
description = "Take a sip and pass the bottle along" }
})
wesnoth.interface.add_chat_message(string.format("User selected choice %d.", result))
</syntaxhighlight>

=== gui.show_dialog ===

* '''gui.show_dialog'''(''dialog definition'', ''preshow'', ''postshow'') → ''retval''

Displays a dialog box described by a WML table and returns an integer
* if the dialog was dismissed by a button click, the integer value associated to the button via the '''return_value''' keyword.
* if the dialog was closed with the enter key, -1.
* if the dialog was closed with the escape key, -2.

The dialog box is equivalent to the '''[resolution]''' section of a GUI window as described in [[GUIToolkitWML]] and must therefore contain at least the following children: '''[tooltip]''', '''[helptip]''', and '''[grid]'''. The [grid] must contain nested [row], [column] and [grid] tags which describe the layout of the window. (More information can be found in GUIToolkit page's [[GUIToolkit#Layout|Layout]] section and [[GUILayout]]; suffice to say that the basic structure is grid -> row -> column -> widget, where the widget is considered to be in a cell defined by the row and column of the grid. A list of widgets can be found at [[GUIWidgetInstanceWML]].) For an overview of the GUI system, see [[GUIToolkit]].

Two optional functions can be passed as second and third arguments; the function passed as ''preshow'' argument is called just before the dialog is shown; the second function (argument ''postshow'') is called once the dialog is closed. These functions are helpful in setting the initial values of the fields and in recovering the final user values. These functions take a single parameter, which is the [[LuaAPI/types/widget|widget userdata]] representing the window.

For in-game dialogs that offer the player a choice and/or can change the game state, this function should be called in conjunction with [[LuaAPI/wesnoth/sync#evaluate_single|wesnoth.sync.evaluate_single]], in order to ensure that only one client displays the dialog and that the other ones recover the same input values from this single client. Though this is especially important in multiplayer scenarios, failing to do it in a single-player scenario will cause the replay to break, so it should be done in either case.

See [[LuaAPI/gui/example|here]] for a fully-working example of a custom dialog.

=== gui.show_help ===

* '''gui.show_help'''([''topic''])

Show the in-game help, optionally opening a specified topic directly.

=== gui.show_inspector ===

* {{LuaGameOnly}} '''gui.show_inspector'''()

Show the gamestate inspector.

=== gui.show_lua_console ===

* '''gui.show_lua_console'''()

Shows the Lua console. This works even if debug mode is not enabled.

=== gui.show_menu ===

* '''gui.show_menu'''(''items'', [''initial''], [''markup'']) → ''index''

Shows a popup menu onscreen at the current mouse location. This could be used for example to produce a sort of submenu in a <tt>[set_menu_item]</tt>. The items are specified as a Lua array of tables, each of which supports the following keys:

* ''icon'': An icon to display in the leftmost column of the menu.
* ''image'': An image to display in the main column of the menu. If this is present, ''label'' is ignored.
* ''label'': A label to display in the main column of the menu.
* ''details'': A secondary label to display in the right column of the menu.
* ''tooltip'': Text to display when mousing over this option.

The ''initial'' argument must be a valid index into the ''items'' array, or 0 to indicate that no element is initially selected (which is the default but typically not what you want).

The ''markup'' argument specifies whether Pango markup will be parsed in the menuitems. It defaults to false.

The ''initial'' and ''markup'' arguments can be passed in either order; the game will understand which is meant based on the type of the argument.

This function returns the index of the selected item. If the user cancelled by clicking outside the menu's boundary, 0 is returned.

=== gui.show_narration ===

* '''gui.show_narration'''(''attributes'', [''options'', [''text_input_attributes'']]) → ''result_code'', [''entered_text'']

Shows a message dialog, of the type used by the <tt>[message]</tt> ActionWML tag. Unlike the <tt>[message]</tt> tag, this is unsynced; if you need it synced, you must do it yourself. The first argument is a table describing the dialog with the following keys:

* ''title'' - The title to show on the message. For example, the speaker's name.
* ''message'' - The message content.
* ''portrait'' - An image to show along with the message. By default, no image is shown.
* ''left_side'' - The default is true; set to false to show the image on the right.
* ''mirror'' - If true, the image will be flipped horizontally.

The second argument is a list of options as a Lua array. Each option is either a (possibly-translatable) string or a config with [[DescriptionWML#WML_Format|DescriptionWML]] keys. The array itself can also have an optional '''default''' key which if present should be the index of the initially selected option (useful if you don't need full DescriptionWML but want to set a default). If present it overrides any defaults set in individual options.

The third argument is a table describing the text input field with the following keys:

* ''label'' - A label to show to the left of the text field.
* ''text'' - Initial contents of the text field.
* ''max_length'' - Maximum input length in characters (defaults to 256).

You need at least one key for the text input to be shown. Both the second and third arguments are optional, but if you want text input with no options, you must pass nil for the second parameter.

This function returns one or two values. The first value returned is the numeric result of the dialog:

* If there are no options and no text input, the result is -2 if the user pressed Escape, or -1 if they closed by clicking or pressing Space.
* If there are options, the result is the index of the option chosen (starting from 1).
* If there is text input but no options, the first return value is 0.

The second value returned is the text entered, if there was text input. Otherwise there is no second value (it is nil).

Example:

<syntaxhighlight lang='lua'>
gui.show_narration({
title = "Make your choice:",
message = "Select an option and enter some text.",
portrait = "wesnoth-icon.png",
}, {
"The first choice is always the best!",
"Pick me! Second choices are better!",
"You know you want the third option!",
}, {
label = "Text:",
text = "?",
max_length = 16
})
</syntaxhighlight>

(You don't have to format it like that, of course.)

=== gui.show_popup ===

* '''gui.show_popup'''(''title'', ''message'', [''image''])

Shows a simple popup dialog in the centre of the screen. Takes three arguments, which in order are:

# A title string for the dialog
# The message content for the dialog.
# An image to show.

Both the title and the message support Pango markup. The image is optional.

=== gui.show_prompt ===

* '''gui.show_prompt'''(''title'', ''message'', [''button''], [''markup'']) → ''result''
* '''gui.confirm'''([''title'',] ''message'') → ''result''
* '''gui.alert'''([''title''], ''message'')

Shows a standard message box onscreen (similar to the quit confirmation message, for example). The button can be any arbitrary potentially-translatable string (in which case, there will be one button with that label), or it can be one of the following special string values:

* ''ok'' or nil: A single OK button; this is the default
* ''cancel'': A single Cancel button
* ''close'': A single Close button
* ''ok_cancel'': Two buttons labelled OK and Cancel
* ''yes_no'': Two buttons labelled Yes and No
* an empty string: No buttons; the dialog automatically closes after a few seconds

The alert and confirm functions are simpler wrappers for this function, using a single OK button and a pair of Yes/No buttons, respectively. Both confirm and show_prompt return false if No or Cancel was clicked, and true otherwise. The alert function returns nothing.

=== gui.show_recruit_dialog ===

{{DevFeature1.19|8}}

* {{LuaGameOnly}} '''gui.show_recruit_dialog'''(''unit_types_list'', [''unit_dialog_options''])

Shows the recruit dialog with the given list of unit types and options. The first argument is a table of [[LuaAPI/types#Unit_Type|unit types]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:

* '''title''': the title of the dialog.
* '''ok_label''': caption of the button with id "ok".
* '''cancel_label''': caption of the button with id "cancel".
* '''help_topic''': the help topic that is to be opened when the '?' button is clicked.
* '''show_headers''': (boolean) whether to show column headers in the main list of the dialog. By default, the headers are not shown.

=== gui.show_recall_dialog ===

{{DevFeature1.19|8}}

* {{LuaGameOnly}} '''gui.show_recall_dialog'''(''units_list'', [''unit_dialog_options''])

Shows the recall dialog with the given list of units and options. The first argument is a table of [[LuaAPI/types/unit|units]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:

* '''title''': the title of the dialog.
* '''ok_label''': caption of the button with id "ok".
* '''cancel_label''': caption of the button with id "cancel".
* '''help_topic''': the help topic that is to be opened when the '?' button is clicked.
* '''show_headers''': (boolean) whether to show column headers in the main list of the dialog. By default, the headers are shown.

=== gui.show_story ===

* '''gui.show_story'''(''story_config'', ''default_title'')

Shows the storyscreen. The passed config is identical to the contents of [[IntroWML|[story]]]. The second parameter is the default title used if a part does not specify one — unlike intro storyscreens, a Lua-invoked one does not default to the scenario name.

=== gui.switch_theme ===

{{DevFeature1.19|4}}

* '''gui.switch_theme'''(''theme_id'')

Switch to the GUI2 theme with id ''theme_id''. Can only be used inside a scenario and does not replace the UI Theme selected by Preferences. The UI reverts to the theme selected in Preferences after exiting the in-game window, for example, by using the menu or by winning or losing a campaign.

[[Category:Lua Reference]]

LuaAPI/gui

2025-02-27T22:01:23Z

Shadowm: /* gui.switch_theme */ Dev-only feature

{{DevFeature1.15|0}}

== Submodules ==
=== gui.widget ===

A [[LuaAPI/gui/widget|submodule]] containing functions for working with widgets in custom dialogs.

== Functions ==
=== gui.add_widget_definition ===

* '''gui.add_widget_definition'''(''widget_type'', ''definition_id'', ''wml_content'')

Creates a new WML widget definition for the specified widget type, which can be referenced from dialog WML in the '''definition''' key.

=== gui.get_user_choice ===

* '''gui.get_user_choice'''(''attributes'', ''options'')

Shows a message dialog (like the one used by the <tt>[[InterfaceActionsWML#.5Bmessage.5D|[message]]]</tt> tag) with a series of options and returns the index (1-based) of the chosen option, which can be stored as a Lua variable.

'''IMPORTANT NOTE: this function is broken in Wesnoth 1.16.0 and 1.16.1.''' If you wish to use it, you should also use wesnoth.current_version to check that your code is being run on Wesnoth 1.16.2 or higher. Alternatively, you may try using [[#gui.show_narration|gui.show_narration]] instead, which has a similar function but a wider range of features.

The first argument is a table of attributes which are directly passed to the underlying <tt>[message]</tt> tag.

The second argument is a table of options, which are used to construct a series of underlying <tt>[option]</tt> tags. Most Lua data types are supported, but a few aren't:
* If the option is a ''table'' or a ''WML table'', these fields are supported:
** ''image'': icon shown in the first column;
** ''label'': text shown in the second column;
** ''description'': text shown in the third column (''message'' is also supported as an alias);
** ''default'': whether this is option is the one selected when the dialog is shown (boolean).
* If the option can be cast to a string (''strings'', ''translatable strings'', ''numbers'', ''booleans''), it is used for the content of the description field, which means that the first two columns will be empty.
* Otherwise, it raises an "invalid data type" error.

Example taken from the test scenario (if not used in an event then change the speaker):

<syntaxhighlight lang='lua'>
local result = gui.get_user_choice(
{ speaker = "unit", message = "Pick your poison" },
{ { image = "items/potion-red.png",
label = "Something red",
description = "Take a sip and enjoy" },
{ image = "items/potion-blue.png",
label = "Nice blue",
description = "Surely you’ll like that one",
default = true },
{ image = "items/potion-yellow.png",
label = "Oh noes yellow",
description = "Oh I’m sure you’ll love that one" },
{ image = "scenery/well.png",
label = "A nice well",
description = "Grab a bucket and fetch some water" },
{ image = "items/holy-water.png",
label = "Oh nice bottle",
description = "Feel the divinity" },
-- Should have an empty first column and a second column on two lines.
{ label = "Well a nice and black drink.\nToo dark too see?",
description = "Take a sip and pass the bottle along" }
})
wesnoth.interface.add_chat_message(string.format("User selected choice %d.", result))
</syntaxhighlight>

=== gui.show_dialog ===

* '''gui.show_dialog'''(''dialog definition'', ''preshow'', ''postshow'') → ''retval''

Displays a dialog box described by a WML table and returns an integer
* if the dialog was dismissed by a button click, the integer value associated to the button via the '''return_value''' keyword.
* if the dialog was closed with the enter key, -1.
* if the dialog was closed with the escape key, -2.

The dialog box is equivalent to the '''[resolution]''' section of a GUI window as described in [[GUIToolkitWML]] and must therefore contain at least the following children: '''[tooltip]''', '''[helptip]''', and '''[grid]'''. The [grid] must contain nested [row], [column] and [grid] tags which describe the layout of the window. (More information can be found in GUIToolkit page's [[GUIToolkit#Layout|Layout]] section and [[GUILayout]]; suffice to say that the basic structure is grid -> row -> column -> widget, where the widget is considered to be in a cell defined by the row and column of the grid. A list of widgets can be found at [[GUIWidgetInstanceWML]].) For an overview of the GUI system, see [[GUIToolkit]].

Two optional functions can be passed as second and third arguments; the function passed as ''preshow'' argument is called just before the dialog is shown; the second function (argument ''postshow'') is called once the dialog is closed. These functions are helpful in setting the initial values of the fields and in recovering the final user values. These functions take a single parameter, which is the [[LuaAPI/types/widget|widget userdata]] representing the window.

For in-game dialogs that offer the player a choice and/or can change the game state, this function should be called in conjunction with [[LuaAPI/wesnoth/sync#evaluate_single|wesnoth.sync.evaluate_single]], in order to ensure that only one client displays the dialog and that the other ones recover the same input values from this single client. Though this is especially important in multiplayer scenarios, failing to do it in a single-player scenario will cause the replay to break, so it should be done in either case.

See [[LuaAPI/gui/example|here]] for a fully-working example of a custom dialog.

=== gui.show_help ===

* '''gui.show_help'''([''topic''])

Show the in-game help, optionally opening a specified topic directly.

=== gui.show_inspector ===

* {{LuaGameOnly}} '''gui.show_inspector'''()

Show the gamestate inspector.

=== gui.show_lua_console ===

* '''gui.show_lua_console'''()

Shows the Lua console. This works even if debug mode is not enabled.

=== gui.show_menu ===

* '''gui.show_menu'''(''items'', [''initial''], [''markup'']) → ''index''

Shows a popup menu onscreen at the current mouse location. This could be used for example to produce a sort of submenu in a <tt>[set_menu_item]</tt>. The items are specified as a Lua array of tables, each of which supports the following keys:

* ''icon'': An icon to display in the leftmost column of the menu.
* ''image'': An image to display in the main column of the menu. If this is present, ''label'' is ignored.
* ''label'': A label to display in the main column of the menu.
* ''details'': A secondary label to display in the right column of the menu.
* ''tooltip'': Text to display when mousing over this option.

The ''initial'' argument must be a valid index into the ''items'' array, or 0 to indicate that no element is initially selected (which is the default but typically not what you want).

The ''markup'' argument specifies whether Pango markup will be parsed in the menuitems. It defaults to false.

The ''initial'' and ''markup'' arguments can be passed in either order; the game will understand which is meant based on the type of the argument.

This function returns the index of the selected item. If the user cancelled by clicking outside the menu's boundary, 0 is returned.

=== gui.show_narration ===

* '''gui.show_narration'''(''attributes'', [''options'', [''text_input_attributes'']]) → ''result_code'', [''entered_text'']

Shows a message dialog, of the type used by the <tt>[message]</tt> ActionWML tag. Unlike the <tt>[message]</tt> tag, this is unsynced; if you need it synced, you must do it yourself. The first argument is a table describing the dialog with the following keys:

* ''title'' - The title to show on the message. For example, the speaker's name.
* ''message'' - The message content.
* ''portrait'' - An image to show along with the message. By default, no image is shown.
* ''left_side'' - The default is true; set to false to show the image on the right.
* ''mirror'' - If true, the image will be flipped horizontally.

The second argument is a list of options as a Lua array. Each option is either a (possibly-translatable) string or a config with [[DescriptionWML#WML_Format|DescriptionWML]] keys. The array itself can also have an optional '''default''' key which if present should be the index of the initially selected option (useful if you don't need full DescriptionWML but want to set a default). If present it overrides any defaults set in individual options.

The third argument is a table describing the text input field with the following keys:

* ''label'' - A label to show to the left of the text field.
* ''text'' - Initial contents of the text field.
* ''max_length'' - Maximum input length in characters (defaults to 256).

You need at least one key for the text input to be shown. Both the second and third arguments are optional, but if you want text input with no options, you must pass nil for the second parameter.

This function returns one or two values. The first value returned is the numeric result of the dialog:

* If there are no options and no text input, the result is -2 if the user pressed Escape, or -1 if they closed by clicking or pressing Space.
* If there are options, the result is the index of the option chosen (starting from 1).
* If there is text input but no options, the first return value is 0.

The second value returned is the text entered, if there was text input. Otherwise there is no second value (it is nil).

Example:

<syntaxhighlight lang='lua'>
gui.show_narration({
title = "Make your choice:",
message = "Select an option and enter some text.",
portrait = "wesnoth-icon.png",
}, {
"The first choice is always the best!",
"Pick me! Second choices are better!",
"You know you want the third option!",
}, {
label = "Text:",
text = "?",
max_length = 16
})
</syntaxhighlight>

(You don't have to format it like that, of course.)

=== gui.show_popup ===

* '''gui.show_popup'''(''title'', ''message'', [''image''])

Shows a simple popup dialog in the centre of the screen. Takes three arguments, which in order are:

# A title string for the dialog
# The message content for the dialog.
# An image to show.

Both the title and the message support Pango markup. The image is optional.

=== gui.show_prompt ===

* '''gui.show_prompt'''(''title'', ''message'', [''button''], [''markup'']) → ''result''
* '''gui.confirm'''([''title'',] ''message'') → ''result''
* '''gui.alert'''([''title''], ''message'')

Shows a standard message box onscreen (similar to the quit confirmation message, for example). The button can be any arbitrary potentially-translatable string (in which case, there will be one button with that label), or it can be one of the following special string values:

* ''ok'' or nil: A single OK button; this is the default
* ''cancel'': A single Cancel button
* ''close'': A single Close button
* ''ok_cancel'': Two buttons labelled OK and Cancel
* ''yes_no'': Two buttons labelled Yes and No
* an empty string: No buttons; the dialog automatically closes after a few seconds

The alert and confirm functions are simpler wrappers for this function, using a single OK button and a pair of Yes/No buttons, respectively. Both confirm and show_prompt return false if No or Cancel was clicked, and true otherwise. The alert function returns nothing.

=== gui.show_recruit_dialog ===

* {{LuaGameOnly}} '''gui.show_recruit_dialog'''(''unit_types_list'', [''unit_dialog_options''])

Shows the recruit dialog with the given list of unit types and options. The first argument is a table of [[LuaAPI/types#Unit_Type|unit types]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:

* '''title''': the title of the dialog.
* '''ok_label''': caption of the button with id "ok".
* '''cancel_label''': caption of the button with id "cancel".
* '''help_topic''': the help topic that is to be opened when the '?' button is clicked.
* '''show_headers''': (boolean) whether to show column headers in the main list of the dialog. By default, the headers are not shown.

=== gui.show_recall_dialog ===

* {{LuaGameOnly}} '''gui.show_recall_dialog'''(''units_list'', [''unit_dialog_options''])

Shows the recall dialog with the given list of units and options. The first argument is a table of [[LuaAPI/types/unit|units]]. The second argument is an optional table that can be used to set various properties of the dialog shown. These are:

* '''title''': the title of the dialog.
* '''ok_label''': caption of the button with id "ok".
* '''cancel_label''': caption of the button with id "cancel".
* '''help_topic''': the help topic that is to be opened when the '?' button is clicked.
* '''show_headers''': (boolean) whether to show column headers in the main list of the dialog. By default, the headers are shown.

=== gui.show_story ===

* '''gui.show_story'''(''story_config'', ''default_title'')

Shows the storyscreen. The passed config is identical to the contents of [[IntroWML|[story]]]. The second parameter is the default title used if a part does not specify one — unlike intro storyscreens, a Lua-invoked one does not default to the scenario name.

=== gui.switch_theme ===

* '''gui.switch_theme'''(''theme_id'')

{{DevFeature1.19|4}}

Switch to the GUI2 theme with id ''theme_id''. Can only be used inside a scenario and does not replace the UI Theme selected by Preferences. The UI reverts to the theme selected in Preferences after exiting the in-game window, for example, by using the menu or by winning or losing a campaign.

[[Category:Lua Reference]]

LuaAPI/types/widget

2024-08-07T01:10:20Z

Shadowm: /* selected_item_path */ It's [tree_view], not [treeview]

PblWML

2024-04-19T08:08:02Z

Shadowm: /* icon */ Wesnoth RCX is now Wespal

{{WML Tags}}

To upload an add-on you have made, you need a '''_server.pbl''' file in your add-on's directory, at the same level as the '''_main.cfg''' file. When you upload the add-on, the entire directory and subdirectories containing the _server.pbl file will be published. Your add-on must be based entirely on these paths.

See [[AddonStructure]] for more on setting up the add-on folder if you have not done so, and [[Distributing_content]] for more on uploading an add-on to the server with this file.

Note: Be aware that translations in the .pbl-files are '''not''' used, so don't mark these strings as translatable. {{DevFeature1.15|4}} The translations in the .pbl-files are used, but they are used as a plain text instead of Gettext strings, so don't mark these strings as translatable.

== What goes into a .pbl file? ==

'''Note:''' ''You should '''not''' use special formatting or coloring in any of these keys when uploading to the official server.'''''

The following keys are recognized for .pbl files:

=== icon ===
: An image, displayed leftmost in the add-ons download dialog. It must be a standard Wesnoth file and '''not a custom one'''. A custom file will only work for users who already have the relevant add-on installed. This is not related to the icon used for entries in the campaigns menu -- see [[CampaignWML]] for more information.

: If the icon is a unit with magenta team-color bits, please use [[ImagePathFunctions]] to recolor it. For example:

::icon="units/elves-wood/archer+female-sword-1.png~RC(magenta>brightorange)"
:or
::icon="units/human-peasants/peasant-ranged.png~RC(magenta>white)~CS(24,24,24)"
:or
::icon="units/human-peasants/ruffian.png~RC(magenta>green)~BLIT(units/human-peasants/woodsman.png~RC(magenta>lightblue),18,12)"

: Because the add-on manager's UI is dark, recoloring to light colors looks usually better. [https://irydacea.me/projects/wespal Wespal] is a tool that provides a convenient way to preview recolored unit sprites without needing to launch the game with specific WML or Lua edits.

: {{DevFeature1.13|12}} Instead of a standard Wesnoth image, a [[DataURI]] can also be used. This way, an image can be directly included into the _server.pbl file. Take care to leave no trailing newline.

=== title ===
: Displayed to the right of the icon, it is just text. It should usually be the same as the name of your add-on when it is played.
: '''This value is required'''.

=== version ===
: Displayed to the right of the title; it is merely text. However, starting with Wesnoth 1.6, the required format is '''x.y.z''' where '''x''', '''y''' and '''z''' are numbers — and a value for '''x''' greater than ''0'' implies the add-on is complete, feature-wise. Trailing non-numeric elements are allowed, but nothing should appear before or between these numbers. The string of numbers will be modified on the server by inserting or appending zeros as neccesary to meet the required format. All this is necessary for the “Update All” button to work correctly. ([[#Version Key Examples|See Examples]])
: '''This value is required'''.

=== author ===
: Displayed to the right of the version; it is merely text. Put your name or nickname here. If several people have contributed significantly to the add-on you may want to list all of their names.
: '''This value is required'''.

=== passphrase ===
: Not displayed. It prevents others from modifying the version of your add-on on the server. You do not need to input a passphrase when initially publishing a add-on; if you do not, one will be randomly generated for you and replaced in your local copy of the .pbl file.
: '''SECURITY NOTE:''' If you do specify a passphrase of your own, note that it is stored in '''clear text''' form in the server; '''do NOT use a password you would normally use for any other services or web sites!'''

: {{DevFeature1.15|12}}

: It is no longer required to keep the passphrase in the .pbl file at all. If it is not present, then Wesnoth will prompt for it to be entered when uploading or deleting an add-on.

=== description ===
: This can be used to provide a brief description of your add-on, and for pre-1.0 versions, let people know how playable it is. The description can be viewed by users by clicking on the Description button in the built-in client, or by moving their mouse over the add-on's icon in the web interface.
: '''This value is required'''.

=== dependencies ===
: An optional list of dependencies (a comma separated list of ''addon-name'' – the directory names of the needed add-ons), which should be provided if your add-on relies on other user-made content to work properly. ([[#Dependency Key Example|See Example]])

=== tags ===
{{DevFeature1.13|12}}
: An optional string including a comma-separated list of keywords used for matching add-ons when typing terms into the Filter box on the top left of the Add-ons Manager. There are no specific requirements on the syntax of the keywords listed here, but a general recommendation is to keep them relevant for players. For example, one might include the add-on's acronym in the tags, the names or acronyms of add-ons to which it is related, and so on.

{{DevFeature1.15|13}} The in-game add-ons manager will show all the tags in the UI, and also includes a drop-down list of tags to filter by. Not all tags are listed in the filter box, and the exact list of tags supported may change before 1.16 is released, but the list is currently:

* '''cooperative''': All human players are on the same team, versus the AI
* '''cosmetic''': These make the game look different, without changing gameplay
* '''difficulty''': Can make campaigns easier or harder
* '''rng''': Modify the randomness in the combat mechanics, or remove it entirely
* '''survival''': Fight against waves of enemies
* '''terraforming''': Players can change the terrain

For example, if an A New Land style add-on had tags ''building'', ''terraforming'', ''anl'', ''city'', and ''survival'' then it would be shown if either ''Terraforming'' or ''Survival'' was selected in the drop-down; the other tags wouldn't affect the filtering.

=== core ===
{{DevFeature1.13|0}}
: An optional string defining the id of the core which the addon is designed for. Defaults to "''default''". Don't specify for an addon which is of type "''core''" itself. Note: DO NOT SET this unless you know why you need it! Giving it an invalid value can lead to mysterious errors with your campaign failing to load!

=== translate ===
: If set to ''true'', the add-on would have been sent to and updated with [[WesCamp|WesCamp-i18n]], if that project were still active. However, as WesCamp is no longer active, this no longer does anything.

: You should make sure your add-on complies with some very specific [[WesCamp#Preparing_your_add-on_for_WesCamp|conventions]] required to ease the process for translators as well as technical requirements.

: Note: WesCamp was abandoned in 2014. Instead, please refer to:
* [[GettextForWesnothDevelopers]]
* [[GettextForTranslators#For_add-ons]]
* forum thread: [https://r.wesnoth.org/t46366 Guide: Translating your UMC without WesCamp].

=== type ===
: Indicates the type of the add-on; used to filter listings in the downloads manager dialog. Acceptable values are:

:* ''core'': replaces the whole wml tree. {{DevFeature1.13|0}}
:* ''campaign'': single player campaign.
:* ''scenario'': single player scenario.
:* ''campaign_sp_mp'': hybrid campaign.
:* ''era'': multiplayer era.
:* ''faction'': multiplayer stand-alone faction, or add-on for other available era.
:* ''map_pack'': multiplayer map-pack.
:* ''campaign_mp'': multiplayer campaign.
:* ''scenario_mp'': multiplayer scenario. (See the note below.)
:* ''mod_mp'': multiplayer modification ({{DevFeature1.13|11}} can also used for single-player modifications, although it's still called ''mod_mp'').
:* ''media'': miscellaneous resources for UMC authors/users, for example, music packs, packages of general-purpose WML, etc. Note: Shows as Resources, not Media, in the add-ons interface
:* ''other'': The type to use when no other type fits.
: '''Note:''' If your add-on contains two or more separate multiplayer scenarios, use ''map_pack''.

: '''This value is required'''.

=== email ===
: Hidden e-mail address used by the server administrators to contact content authors in case of major issues. Again, this will only be seen by the server administrators and it is required that you provide one in case you need to be contacted about your add-on.

: '''This value is required if forum_auth is not set to true'''.

=== forum_auth ===
{{DevFeature1.17|3}}
: When set to ''true'', you will be prompted for your forum username and password when uploading your add-on. When set to true, the ''passphrase'' and ''email'' fields are also not required.

=== secondary_authors ===
: A comma-delimited list of forum accounts that are allowed to upload new versions of the add-on, but aren't allowed to delete the add-on.

=== [feedback] ===
: The [feedback] tag includes information used by the server to provide the client with a website URL for players to post feedback on an add-on and communicate with the maintainers. At this time, the official add-ons server is configured to take a single parameter described below.

==== topic_id ====
: Topic id from the [http://forums.wesnoth.org/ Wesnoth.org forums] for the add-on's feedback or development topic maintained by the add-on uploader or author. For existing topics, this topic_id corresponds to the series of digits in the ''t=YYYYY'' portion of a URL like <code><nowiki>http://forums.wesnoth.org/viewtopic.php?f=XX&t=YYYYY</nowiki></code>. You must take special care to ensure this information is valid before uploading if you want players to be able to reach you!

=== [translation] ===
{{DevFeature1.15|4}}
: Multiple [translation] tags can be used to provide the addon with a localized title and description to be seen in the addons manager. However, it should be noted that the declared translations won't influence the list of supported locales as it depends only on the presence of .mo and .po files for corresponding languages.

==== language ====
: The target language code for the translation. The codes for each language are given in the big table on [https://www.wesnoth.org/gettext/] . You can use either its contracted version (like ''sv'' for Swedish) or a more precise variety (like ''zh_CN'' or ''ca_ES@valencia'').
: '''This value is required'''.

==== title ====
: The translation of addon's title for the target language.
: '''This value is required'''.

==== description ====
: The translation of addon's description for the target language.

The add-on server keeps track of some other information about uploaded content, including when they were uploaded, what languages they have been at least partly translated into, how large they are on the server and the number of times they have been downloaded. For more information about this you can read [[CampaignServerWML]].

== Examples ==

=== Dependency Key Example ===

The following dependency key could be used when the add-on needs the ''Imperial_Era'' and ''Era_of_Myths'' to be installed before it will work properly:

dependencies=Imperial_Era,Era_of_Myths

=== Version Key Examples ===

{{DevFeature1.17|13}} the schema validation rejects many of the '''good''' examples. https://github.com/wesnoth/wesnoth/issues/7396

The following are examples of '''good''' version values:

version="1.5"
version="0.11.4"
version="0.1.4beta"
version="1.5c"

The following are examples of '''bad''' version values:

version="Beta1.5"
version="Incomplete (0.3.4)"

In both of the above examples the version number as read by the server will be '''0.0.0Beta1.5''' and '''0.0.0Incomplete (0.3.4)'''. You can clearly see why this will not be a good thing with the ''Update add-ons'' feature.

Finally, here are some example version numbers and how they will be interpreted by the ''Update add-ons'' button. The number on the left will be considered an earlier number than the number on the right in each example.

0.5 < 1.0
1.5 < 1.5c
1.0 < 1.0.1
1.0c < 1.0.1a
1.0.1a < 1.0.1c
1.0 Final < 1.0.1 Beta

=== Example .pbl File ===

<syntaxhighlight lang=wml>
title="My Campaign"
type="campaign"
icon="misc/ball.png"
version="0.1.2"
author="Me, artwork by myself"
passphrase="This is like a password; see the security note in the documentation above before choosing a value of your own"
description="You get to kill a lot of bad guys. But only the first map is done."
email="name@example.com"
[feedback]
topic_id=12345
[/feedback]
# Note: the translation feature works on version 1.14.14, 1.15.4 and later only
[translation]
language="ru"
title="Моя Кампания"
description="Вам придётся завалить немало плохишей. Но пока что готова лишь первая карта."
[/translation]
[translation]
language="zh_CN"
title="我的竞选"
description="你会杀死很多坏人。但是只完成了第一张地图。(translated online)"
[/translation]
</syntaxhighlight>

== See Also ==

* [[IGNFileFormat]]
* [[FancyAddonIcons]]
* [[ReferenceWML]]
* [[CampaignServerWML]]

[[Category: WML Reference]]

ImagePathFunctions

2024-04-19T08:06:13Z

Shadowm: /* See Also */ Wesnoth RCX is now Wespal

Image Path Functions provide a simple method for WML coders to alter the way their specified images will be displayed in the game. All of the function parameters are included at the end of an image path and should not contain any spaces or special characters (other than those specified here).

If you need to practice it without having to reload all WML, you can use an add-on named ''Image loading tester''. It is available on the 1.9, 1.10, 1.11, 1.12 and 1.14 add-on servers.

All functions are applied in left-to-right order, with the exception of RC(), TC() and PAL() which are applied always before any other functions. Standard team coloring for a unit is applied after all custom RC(), TC() and PAL() functions but before any other functions.
That is, stuff like
"units/elves-wood/fighter.png~CROP(20,20,40,40)~CROP(10,10,10,10)"
would result in taking a crop to a 40x40 rectangle whose top-left corner is x=20, y=20; and then taking a crop from ''that'' rectangle with x=10, y=10, w=10, h=10. The result is the area x=30, y=30, w=10, h=10 from the original graphic.

== Changing the colors ==

=== BLEND: Color-blend function ===
Blends the image with the given color to produce a more controlled tinting effect than color-shifting, independently of the image's contents.

'''~BLEND(r,g,b,o)'''

The color is defined by the ''r'', ''g'', and ''b'' parameters (integers ranging from 0 to 255). The ''o'' (opacity) parameter controls the amount by which the given color will be blended into the image, and may be specified either as a factor from 0.0 to 1.0, or percentage up to 100%. Thus, ~BLEND(r,g,b,0.5) and ~BLEND(r,g,b,50%) are equivalent.

=== BW: Black and White function ===
{{devfeature1.13|1}}
May be used to convert the image to pure black and white, without grey pixels.

'''~BW(threshold)'''
* ''threshold'': a value between 0 and 255 (both limits included). All pixels are converted as greyscale first, and if their average value is greater than the threshold they become white, otherwise they become black.

=== CS: Color-shift function ===
Performs simple per-channel color shifts by adding the arguments to the respective color channels.

''Multi-channel:'' '''~CS(r,g,b)'''
''Single-channel:'' '''~R(v)''', '''~G(v)''', '''~B(v)'''

The multichannel syntax assumes all arguments are set to zero initially, so one can use, e.g. ~CS(2,4) to add +2 and +4 units to the red and green channels respectively, leaving the blue channel intact. Arguments may be negative to diminish a channel's value; this can be used to change an image's brightness. Checks for out-of-range arguments or results (less than 0 or greater than 255) are made, so the resultant values are truncated if necessary.

The single channel syntax behaves exactly the same, except that only single-channel modifications are made per function. However, one can stack them to produce the same behavior as ~CS(), e.g. ~R(r)~G(g)~B(b), but that tends to be just a performance loss.

=== GS: Greyscale function ===
May be used to greyscale the image (turn to black and white)

'''~GS( )'''

=== L: Lightmap color-shift function ===
Performs per-pixel and per-channel color shifts using another image (a "lightmap") as source, allowing to create textured light effects.

'''~L(lightmap)'''

For each pixel of the original image, it checks the RGB values from the corresponding pixel of the lightmap, slightly transform them, then add these values to the original pixel.

The transformation involved is done to convert the (0,255) spectrum to (-255,255), allowing to add or subtract color. The formula is (x-128)*2, which means that 0 gives -256, 128 gives 0 and 255 gives 254. So, the no-effect lightmap is a fully grey image (RGB = 128,128,128) and any non-grey pixel will shift the colors of the original.

Note that the lightmap will be scaled to the same dimensions as the original image.

=== NEG: Negative function ===
{{devfeature1.13|0}}
Also known as ''invert'', it negates all the RGB values of the image, giving it an effect similar to a photographic negative.

'''~NEG( )'''

Inverts the image, giving it an effect like a photographic negative.

{{devfeature1.13|1}} '''~NEG(''' ''threshold'' ''')'''

If a channel has a value greater than the threshold, the channel will be inverted, performing an effect known as ''solarization''.
Threshold must be between -1 and 255, with -1 equivalent to full inversion and 255 as no-op value.

{{devfeature1.13|1}} '''~NEG(''' ''threshold_red, threshold_green, threshold_blue'' ''')'''

If a channel has a value greater than the corresponding threshold, the channel will be inverted.
Each threshold must be between -1 and 255, with -1 equivalent to full inversion and 255 as no-op value.

=== PAL: Palette-switch function ===
May be used to change colors in an image following the specifications of a source and target (new) palette.

'''~PAL(''' ''source color palette'' '''>''' ''target color palette'' ''')'''
*''source color palette'' - the first parameter is a source color palette, such as magenta. Do not surround this parameter with quotes.
*''target color palette'' - the new palette to take the place of the source colors in the image.

=== RC: Re-Color function ===
May be used to change some colors in an image. It is possible to use ''RC'' more than once on the same image, with different source palettes.

'''~RC(''' ''source color palette'' '''>''' ''destination color range'' ''')'''

==== source color palette ====
The first parameter is a set of colors, usually the magenta palette. Do not surround this parameter with quotes. The three standard palettes are:

* '''magenta''' - the 19 colors described in [[Team_Color_Shifting]]
* '''ellipse_red''' - all 255 colors with RGB value (n,0,0)
* '''flag_green''' - all 255 colors with RGB value (0,n,0)

The palette can also be given inline as a set of hexadecimal RGB values.

The named palettes are defined using the '''[[GameConfigWML#Color_Palettes|[color_palette]]]''' tag, and you can also define your own custom color palette using that tag.

Warning: the RC function will also accept (and not give a warning about) '''red''', '''green''' and any other defined '''[color_range]'''; however the set of RGB values for those aren't guaranteed. Using '''red''' instead of '''ellipse_red''' might be equivalent to the palette 030000,060000,0a0000,...,ff0000,ff0a0a,...,fff0f0.

==== destination color range ====
This is the second parameter, signifying the ID of a color range defined in the file [http://github.com/wesnoth/wesnoth/blob/master/data/core/team-colors.cfg data/core/team-colors.cfg] (or it may be a custom ID for a color range defined locally). You can also define a custom color range inline (the rgb key from [[GameConfigWML#Color_Palettes]]; note that RC does not use the fourth color for anything).

For this destination color range, using '''red''' or '''green''' makes sense.

==== Example ====
In the following example, the magenta regions in an elvish captain's image are turned a healthy shade of green:

[message]
speaker=narrator
image=units/elves-wood/captain.png~RC(magenta>green)
message=_ "Now I am on the green team."
[/message]

The following example replaces a few of the '''magenta''' pixels with green ones:

misc/orb.png~RC(690039,c30074,ec008c > 007f00,00ff00,000000,000000)

The IDs of the color ranges may be the lowercased English name of the palette's base color (e.g. 'red', 'brown', etc.). They may also be numeric color indices from the palette WML included with the game, but this is not recommended.

=== SEPIA: Sepia function ===
{{devfeature1.13|0}}
May be used to give to the image a sepia tint (like in old pictures).

'''~SEPIA()'''

=== SWAP: Channel Swap function ===
{{devfeature1.13|1}}
May be used to swap the RGBA channels of an image.

'''~SWAP(''' ''r, g, b'' ''')'''
'''~SWAP(''' ''r, g, b, a'' ''')'''
* ''r'', ''g'', ''b'', ''a'': each of these arguments may have a value equal to ''red'', ''green'', ''blue'' or ''alpha''. The RGBA channels of the original image will be exchanged accordingly (for example, <tt>~SWAP(blue,green,red)</tt> swaps the blue and red channels).

=== TC: Team-Color function ===
In Wesnoth version 1.2, the only Image Path Function was '''~TC()''', which took two comma-separated parameters: the team number and the source color palette. The valid values for both of these parameters are defined in the file ''data/team-colors.cfg''

'''~TC(''' ''team number'' ''',''' ''source color palette'' ''')'''
*''team number'' - this is the first parameter, a number 1-9 signifying the team number of a unit. Number 1 typically means the red team, 2 typically means the blue team, and so on (unless the scenario color settings for any side have been altered).
*''source color palette'' - the second parameter is a source color palette, usually magenta. Do not surround this parameter with quotes.

== Transformations ==

=== FL: Flip function ===
May be used to flip an image horizontally and/or vertically.

'''~FL(''' ''optional argument list'' ''')'''
*''vertical'' - if the string "vert" is found anywhere in the argument list, the image will be flipped vertically.
*''horizontal'' - if the string "horiz" is found anywhere in the argument list, the image will be flipped horizontally.
*if the argument list is empty, the image will only be flipped horizontally.

=== ROTATE: Rotate function ===
May be used to rotate an image.

'''~ROTATE(''' ''degrees'' ''')'''
* ''degrees'' - The number of degrees by which the image will be rotated. Positive numbers indicate clockwise rotation, while negative numbers indicate counter-clockwise. (Zero indicates no rotation.)
If the number of degrees is omitted, a quarter turn (90 degrees) clockwise is assumed.

=== SCALE: Image-scaling function ===
Scales a graphic up or down.

'''~SCALE( ''new_width'', ''new_height'' )

The ''new_width'' and ''new_height'' parameters are taken as the image's original width or height, respectively, if one of them happens to be zero. Negative values are treated in the same way, but an error is printed in stderr. This uses the bilinear interpolation algorithm.

=== SCALE_INTO function ===
{{DevFeature1.13|5}}

Similar to SCALE, but preserves aspect aspect ratio, scaling to the minimum extent required to fit into the specified area. The resulting image will have the specified width or the specified height, but not necessarily both.

=== SCALE_SHARP function ===

{{DevFeature1.13|0}}

Scales functions using a nearest neighbor algorithm. Specify width and height. (It has the same syntax as ~SCALE.)

'''~SCALE_SHARP(200,300)'''

=== SCALE_INTO_SHARP function ===
{{DevFeature1.13|5}}

Like SCALE_INTO, but uses nearest neighbor algorithm instead of bilinear interpolation.

=== XBRZ function ===

{{DevFeature1.13|0}}

Scales functions using the XBRZ algorithm. You may scale things up either 2x, 3x, 4x, or 5x. The scaling tries to preserve the pixel art nature.

'''~XBRZ(n)'''

== Cut-and-paste ==

=== BLIT: Blit function ===
Blit the parameter image on the main image. Example: peasant.png~BLIT(hat.png,30,10)

'''~BLIT(src,x,y)'''
* ''src'': an image file used as source for the blit, other image path functions can be used there.
* ''x'',''y'': top-left corner coordinates where to blit. If missing assume (0,0).

=== CROP: Crop function ===
Extracts a rectangular section of an image file.

'''~CROP(x,y,width,height)'''
* ''x'',''y'': top-left corner coordinates for the rectangular section extracted. Must be greater or equal than zero, and inside the image's bounds.
* ''width'': width of the selected region. Must be less than or equal to the original image's width, and must not be negative.
* ''height'': height of the selected region. Must be less than or equal to the original image's height, and must not be negative.

=== CROP_TRANSPARENT ===
{{devfeature1.17|26}}
Removes any transparent padding from around an image.

'''~CROP_TRANSPARENT()'''

=== MASK: Mask function ===
Remove parts of the main image using the parameter image as a mask. Example: grass.png~MASK(circle.png) will give a circle of grass.

'''~MASK(mask,x,y)'''
* ''mask'': an image file used as mask, other image path functions can be used there.
* ''x'',''y'': top-left corner coordinates where to put the mask. Parts ouside of the mask are considered transparent. If missing assume (0,0).

Only the alpha channel of the mask is used and each alpha value will be the maximum alpha of the resulting image. This means that the fully-transparent parts of the mask will erase the corresponding parts of the image, but also that a semi-transparent mask will create a semi-transparent image.

== Opacity ==

=== ADJUST_ALPHA ===

{{DevFeature1.13|?}}

Alters the alpha of the image according to a WFL formula. The formula must output an integer from 0 to 255 giving the alpha across the canvas. It is evaluated for every pixel and may use the following variables: x, y, red, green, blue, alpha, width, height. {{DevFeature1.15|0}} The variables u and v are also supported now, evaluating to normalized texture coordinates (in the range 0..1); these are equivalent to <tt>x/width</tt> and <tt>y/height</tt> respectively.

'''~ADJUST_ALPHA(formula)'''.

The context object for the formula is a '''[[#CHAN:_General_function|pixel object]]'''.

=== O: Opacity modifying function ===
Changes an image's opacity at render time.

'''~O( ''factor or percentage%'' )'''

If the argument includes the percentage symbol (''%''), it will be treated as a percentage of full (real) opacity; an image will be displayed at its native opacity with ~O(100%).

Without the percentage symbol, the argument is assumed to be a factor by which the image's native opacity should be multiplied. Thus, ~O(0.5) and ~O(50%) are equivalent forms of specifying to reduce an image's opacity by half.

=== PLOT_ALPHA ===

{{DevFeature1.13|0}}

At each pixel, the color is replaced with a grey-tone reflecting the alpha value at that pixel, and the new image is fully opaque. Useful for plotting the alpha to help debug an IPF or inspect a sprite.

'''~PLOT_ALPHA()'''

=== WIPE_ALPHA ===

{{DevFeature1.13|0}}

At each pixel, the alpha value is discarded and the pixel is made fully opaque. Useful again for diagnostics.

'''~WIPE_ALPHA()'''

=== Background coloring function ===
Sets the color of all the (semi-)transparent pixels of the image.

'''~BG(r,g,b)'''

== Miscellaneous ==

=== BL: Blurring function ===

Blurs a graphic at render time using the same algorithm used for in-game dialogs.

'''~BL( ''radius'' )'''

=== CHAN: General function ===

{{DevFeature1.13|7}}

This function allows you to do pretty much anything. It takes up to four comma-separated formulas, one each for the red, green, blue, and alpha channels. Each formula functions exactly the same as the formula for '''ADJUST_ALPHA''', but the output integer is used for the corresponding channel rather than always the alpha channel. Do not surround the formula in <code>$(...)</code>, since that will erase the <tt>self</tt> variable.

'''~CHAN(formula, formula, formula)'''

The context object for each of the formulas is a '''pixel object''' with the following properties:

* '''x''', '''y''': coordinates of the pixel, from the top left
* '''u''', '''v''': {{DevFeature1.15|0}} normalized coordinates in the range [0,1]
* '''width''', '''height''': size of the image canvas
* '''red''', '''green''', '''blue''', '''alpha''': components of the pixel colour

=== DARKEN: Removed function ===

{{DevFeature1.13|7}} This function has been removed. Use a ~BLIT(misc/tod-dark.png) call instead.

Puts a time-of-day schedule overlay (misc/tod-dark.png) on the image, which must be large enough to accommodate it.

'''~DARKEN()'''

=== BRIGHTEN: Removed function ===

{{DevFeature1.13|7}} This function has been removed. Use a ~BLIT(misc/tod-bright.png) call instead.

Puts a time-of-day schedule overlay (misc/tod-bright.png) on the image, which must be large enough to accommodate it.

'''~BRIGHTEN()'''

=== NOP: Null function ===

Does nothing.

'''~NOP()'''

=== Pseudo IPFs ===

The following functions are ignored by the IPF image modification module, but used by other Wesnoth components. They only work in special areas.

==== NO_TOD_SHIFT: Disabling ToD ====

{{DevFeature1.13|8}}

This is used by the terrain renderer and prevents terrain and item images from being affected by ToD lighting. This is in particular useful when placing unit images as items, as they will look the same as when placed as unit.

'''~NO_TOD_SHIFT()'''

==== RIGHT: Display portraits on the right ====

'''''([[DevFeature|Version 1.5.8 and later only]])'''''

This is used by the [[InterfaceActionsWML#.5Bmessage.5D|'''[message]''']] interface action and can be used to show a portrait on the right side of the screen.

'''~RIGHT()'''

== Creating an image file from IPFs ==

The big advantage of Image Path Functions is that they allow you to alter an image without needing a new image file. However, you can also save the result into a new image file using Wesnoth's command line option ''--render-image'.

Assuming you find a way to open your computer's terminal:
wesnoth --render-image "units/human-peasants/ruffian.png~RC(magenta>green)~BLIT(units/human-peasants/woodsman.png~RC(magenta>lightblue),18,12)" /tmp/new_image_file.png

Or on Windows:
"C:\Path\to\Battle for Wesnoth\wesnoth.exe" --render-image "units/human-peasants/ruffian.png~RC(magenta>green)~BLIT(units/human-peasants/woodsman.png~RC(magenta>lightblue),18,12)" new_image_file.png

Use cases include:
* Experimenting with Image Path Functions. If none of the images are from an add-on, adding ''--noaddons'' will speed this up.
* If a new Image Path Function is added to the development version of Wesnoth, add-ons for older Wesnoth versions can use a generated image instead.
* In case you want to use this anywhere out of Wesnoth. On a website, in Project Haldric, …
== See Also ==

* [[FancyAddonIcons]] - Tips and tricks for advanced Image Path Function manipulation
* [[DataURI]] - An image path may also contain the image directly, as a Base64 encoded string
* [https://irydacea.me/projects/wespal Wespal] - Tool to preview unit recoloring. Covers the effects of the [[#RC:_Re-Color_Function|RC]], [[#TC: Team-Color Function|TC]] and [[#PAL:_Palette-switch_Function|PAL]] functions.
* [https://github.com/wesnoth/wesnoth/blob/master/src/image_modifications.cpp src/image_modifications.cpp] - file where IPFs are implemented
[[Category:WML Reference]]

NotSoEasyCoding

2024-03-21T23:00:58Z

Shadowm: Update outdated info

This page lists projects which are considered a good idea by the developers but which have nobody working on them so far. If you think you've got the required skill for a task go on, implement it and you've got a high chance that it'll be accepted. The remaining barrier will only be that it's done well. :-)

If you are such a person, you should feel free to edit this page.

If you're not, you should post a feature request and discuss your idea on the forum or IRC or Discord. A coder with better knowledge of the code might give you the green light to add your feature here.

Anybody should feel free to add "clues" to any tasks, that is entry points, traps to avoid, person to contact to discuss and so on.

If you plan to work on a feature, write your name at the bottom of the feature, with the date. Note that if you spend too long at working on a feature we'll "free" it back (that is if you're not working on it. If you have problems implementing it, just tell us....). We sometimes forget to update this page so it is recommended that, before you start to work on a task, that you ask in irc/Discord whether its still considered a good idea.

If you are part of the Wesnoth dev team you can also add new entries to the list, a new entry must contain at least

1) A description of the problem.
2) A motivation why or in which situations this is important.
3) A link to a corresponding ticket on our bugtracker for discussion, if there is no ticket yet then make one.

__TOC__

== Game engine ==

=== [[OpenGL port]] ===

While software rendering is all good and nice, Wesnoth's approach does not scale well as display resolutions increase and the need for supporting high DPI configurations is factored in. One can easily see that our zoom functionality is clunky and inefficient. Having support for OpenGL and shaders would also enable us to implement fancier graphical gimmicks such as particle effects and atmospheric lighting. The downside of adding OpenGL to the mix is that we'd need people with a specific skillset to help us maintain the graphics engine in the long term, as hardware and driver-specific quirks are inevitable. Some users are also concerned about changing Wesnoth's hardware requirements so that they would be unable to play using old or unsupported hardware/OS configurations.

For hardware rendering to be effective, in particular, Wesnoth would necessitate a complete rewrite of the graphics rendering code (the display and game_display classes), the image cache manager (used to abstract the process of loading images from disk and applying image path functions), and potentially GUI2's canvas code. All three would have to limit the amount of textures they allocate to the absolute minimum, using larger textures instead. For example, the image cache could be reimplemented to load images from an internal spritesheet generated during the game loading process. (WML/Lua support for spritesheets would be nice would defining an API for it would only distract from the actual task at hand.)

The greatest difficulty in handling this task probably lies in writing a new optimized rendering engine and updating all code that relies on the old display/game_display API and semantics accordingly. The GUI2 framework code is presently unmaintained and it would take some time for somebody to study and change the current implementation. Finally, as we don't have a graphics engine maintainer at this time, this task involves an implicit long-term commitment to the project that extends beyond whichever Wesnoth series that will see this project completed.

One of the many issues related to switching from software rendering to hardware rendering is Wesnoth's [[ImagePathFunctions]] mini-language. There is already a proof of concept [https://github.com/CelticMinstrel/wesnoth-ipf here] that converts most IPFs to OpenGL shader code, but quite a bit more work would need to be done to make something usable out of it. In particular, the ability to compile arbitrary [[Wesnoth Formula Language]] code into shaders would be needed, since some IPFs embed the language.

=== Improve WML error reporting ===

There are many programming bugs that give very unclear or cryptic error messages when using WML. Here are some examples:

* <strike>When calling a macro with the wrong number of arguments, Wesnoth tells the number it expected, and the number it got, and at which line number it was instantiated. However, it would be helpful if it would also tell the line number of the definition of the macro. This might be helpful if someone is redefining macros.</strike>

* For places where a standard unit filter is expected, if one is not found, the game should point out a problem. For places where such a filter is expected but [filter] child should not appear, if one does it should report an error and a line number. Many users have a hard time with this kind of thing.

* When doing scenario transitions in a campaign, if the side definitions don't match up exactly the game tends to give unintelligible error messages. For instance, if one is transitioning and there is an AI side which does not have a leader (but it has a starting location in the map) it must have "no_leader = yes" in its [side] tag, or else when the team_builder objects enter stage two, the game will try to create a unit with an empty type, and the constructor of class unit will fail giving the error message "game::game_error tried to create unit with empty type". This really needs to be much better. For instance, giving a line number of a problem, or suggesting that no_leader should be used. (Note that, it is often possible to debug problems like this by turning on --log-debug=team_construction at commandline but I doubt that there are any users that know about this, you would only learn from reading the C++... without such debug info, fixing things like this can literally take hours.) For that matter it's some question why the team_builder doesn't just stop trying to build a unit when it sees it doesn't have enough info...

* Recursive macros break the game, and not by stack overflow but by exhausting the heap (which usually takes forever on modern OSes and results in memory thrashing before resource starvation). It would be nice if we could catch this and report an error.

Many WML users are students or beginners to programming, so any improvements to WML error reporting are a big help for their learning process -- many veterans would appreciate the extra help as well. In part we need fixits here and there, but more broadly we need a smarter system that can figure out what's really wrong when things go wrong, and give helpful suggestions.

=== Don't store all events in savefiles ===

Currently all events in a scenario are stored twice in each savefile (in [snapshot] and it [replay_start]), specially on wml-heavy umc content this can make savefiles quite big, The proposed solution is that events are not stored in savefiles when they are the same as in the scenario/era/modification file (e.g. not dynamically added with actionwml).
In detail the savefile should for all events that have an id and are not generated dynamically ([event] actionwml), store dummy events like
[event]
id=event_id
is_unchanged=yes
[/event]
in the savefiles (instead of full events), where the event is then read from the scenario/era/modification tag when the scenario is loaded. This should only apply to campaigns/modifications/mp maps/eras that require download (which is usually the case for campaigns but not for mp maps)

See also https://github.com/wesnoth/wesnoth/issues/1512

== Multiplayer/replay features ==

=== Gold graph ===

Make a graph feature, presumably in a dialog, that helps depict the history of a Wesnoth match for the benefit of spectators of a live game or replay. For example it could display army value, army + bank value, number of villages tagged, luck swings... This would also be particularly helpful for AI tweaking development, by helping coders identify the AI's weaknesses and strengths in the context of a particular scenario.

A possible nice feature for this purpose would be to allow the user to click on the graph at key points which would trigger the "back to turn" mechanism to jump back in the replay, or automatically play the replay forwards from the beginning to that point... etc.

Related email on dev-talk: https://mail.gna.org/public/wesnoth-dev/2014-02/msg00089.html

=== Automatically link up to wesnothd server on a local network ===

The feature request was to use ZeroConf technology, if available, to publish info of a running wesnothd instance to other machines on a local network. Then when they are searching to connect to an unofficial server, they won't have to learn the IP address.

The extra code should be guarded with preprocessor flags so that ZeroConf does not become a mandatory build dependency of Wesnoth.

https://github.com/wesnoth/wesnoth/issues/1162

=== Stock MP chat messages for language-independent communication ===

Wesnoth has seen a large acceptance by international communities, and many players don't speak English. It would be nice we could have a set of messages that could be chatted, but which will be translated by our translators and displayed always in the current locale on each client, to make it easier to communicate in mp games / on the mp server.

The easy part is adding the messages. They would ideally be stored in a WML file in the core data dir so they can be easily modified and translated like all other mainline WML. The hard part is devising the interaction mechanism so that a player can easily make use of these stock messages in the MP lobby or in game.

== GUI2 framework ==

As of 1.13.1+dev, GUI2's core and framework (including widgets and their APIs) are completely unmaintained. A prospective maintainer would have to be able to understand pretty advanced C++ making abundant use of template-based abstractions (most notably, the event handling code is almost completely implemented this way), multiple inheritance, and polymorphism. There is also some missing functionality (such as combo boxes and modeless dialogs) that the author did not get to implement, as well as work-in-progress functionality (new listbox and tooltip implementations, not enabled by default).

=== Generic tab_container widget ===

After 1.13.1 was released, Iris discovered a trick to implement tabbed dialogs in GUI2, involving a general widget bug fix to make children consider their parents' visibility when processing events, and an addition to the stacked_widget API enabling users to hide all but a single active layer.

The About dialog introduced in version 1.13.2 will use a horizontal listbox in combination with a stacked_widget, but ideally we should be able to reuse this pattern in more places without having to clutter up dialog implementations with the requisite code to synchronize the listbox and the stacked_widget's states. This hypothetical tab_container widget would combine the listbox and the stacked_widget to implement tabs in a cleaner fashion without having to expose the implementation details to individual dialog instances.

By all means, this should be an [[EasyCoding]] task, but GUI2's unusual code layout and API design conventions (compared to the rest of Wesnoth) ''may'' make it harder than it's supposed to be.

=== GUI2 themable in-game UI ===

The "themable" in-game UI refers to the gameplay UI including the sidebar, menu/status bar, and map view. Most of it is not implemented using proper GUI1 widgets at all, except for the various interactive buttons, menus (which are floating GUI1 listboxes), and the command and chat input boxes (floating GUI1 textboxes).

Moving the theme UI to GUI2 would probably require finishing up theme support in GUI2 (which is largely incomplete), and may benefit from a rendering engine redesign as is also required for porting the game to SDL 2; in particular so that the GUI aspects are more clearly separated from the game board rendering aspect.

'''Note:''' This task is here solely for the sake of completeness, and only somebody very well versed in the intricacies of Wesnoth's game rendering code and GUI2 should '''ever''' try to take it up. (And even then, I would not want to be anywhere near that person when they inevitably break down and fling one or more tables around upon realizing the sheer complexity of the task. -- Iris)

=== Rich Text Label Widget ===

As of version 1.13.11, the one last dialog that hasn't yet been converted to GUI2 is the help dialog. In order to finish this conversion, a new type of widget is required. It needs to be able to support text with embedded images (both centered as a block and with text wrapped around them), clickable links that trigger a callback, and tab stops, on top of the regular Pango formatting stuff. This can probably all be done with Pango, but requires digging deeper into the API (particularly for the text wrap shapes). It would also need to parse markup, for example an extension of the standard Pango markup.

== Add-ons server and client ==

=== Passphrase hashing ===

The add-ons server ([[campaignd]]) uses a very dumb authentication scheme for uploading add-ons where an author sets a passphrase (or gets a random passphrase assigned by the game) the first time they upload to the server, and subsequent uploads of the same add-on are only allowed if the passphrase matches. The passphrase is stored in clear text form both client and server-side, which has [http://forums.wesnoth.org/viewtopic.php?f=62&t=42663 various implications].

Ideally, the server would store all passphrases in a hashed form.

=== Port redirection ===

Wesnoth's MP server (wesnothd) uses a single port (15000) for servicing most requests and redirects clients to different ports according to the game client's version number. This allows the server administrators to reassign ports freely without having to modify the game client.

The add-ons server (campaignd) and client instead have a hardcoded default port number for a Wesnoth version series. For example, 1.12.x is hardcoded to default to 15006. This becomes a maintainability issue as add-on servers get decommissioned and their port numbers can't be reused for fear of misdirecting obsolete client versions to the wrong instance with incompatible add-ons.

== Multiplayer server and client ==

=== Improve server WML processing ===

The server uses its own custom WML implementation separate from the main engine's to store and process WML objects for games -- see [[WesnothdDesign#simple_wml]]. This is intended to improve performance and reduce wesnothd's memory footprint with large numbers of games and complex scenarios. However, the simple_wml code sometimes messes up WML attribute translatability, resulting in MP scenarios/campaigns being untranslated for non-hosts in networked MP (https://github.com/wesnoth/wesnoth/issues/1420). Fixing this is not easy due to the aforementioned performance requirements.

== WML-related features ==
=== Game Information ===

* [query_location] - queries a location from the user
** variable
** [filter_location]
''Regarding [query_location]: probably a better name would be choose_location. This is used when a wml event is running and needs to get a target location hex from the user. For example, you right click on a catapult unit and choose the menu item "fire Catapult." Now a [message] says to click on any target within 5 hexes. Now [choose_location] is encountered and the mouse cursor changes to a target sign (possibly customizable). If the user's mouse drifts outside of the allowed locations it changes to a cancel icon. If the operation is cancelled then the variable is cleared and no location stored. --Sapient''

''This can be implemented in lua by using wesnoth.game_events.on_mouse_action and wesnoth.syncronize_choice''

https://github.com/wesnoth/wesnoth/issues/2325

Project

2024-03-21T22:59:16Z

Shadowm:

<div class="tright"> __TOC__ </div>

The Battle for Wesnoth is an [https://opensource.org/faq#osd open source] software project hosted on [https://github.com/wesnoth GitHub], created and maintained by The Battle for Wesnoth Project, an [[Credits|international team of volunteers]] from diverse backgrounds. Conceived in 2003 by David White, Wesnoth has caught the interest of a multitude of fans who have since contributed to different aspects of the game such as engine coding, content creation, art and music development, translation, packaging, testing, and community management.

The Project is governed by the Project Manager and the Project Council as per the [https://www.wesnoth.org/constitution/ Project Constitution]. The current Project Manager [https://forums.wesnoth.org/viewtopic.php?t=55254 elected] by the development team for the Wesnoth 1.17.x development cycle is Pentarctagon. Past Project Managers include Charles Dang (vultraz), Iris Morelle (Irydacea), Nils Kneuper (Ivanovic) and Isaac Clerencia (isaac).

The Wesnoth.org website, primary multiplayer server, and add-ons server facilities are managed by a few members of the project who staff the game's backend infrastructure.

Funding for infrastructure and art and music commissions is provided by Wesnoth, Inc., a US-based company which manages revenue from donations made to Wesnoth through [https://liberapay.com/Wesnoth Liberapay] and [https://wesnoth.itch.io/battle-for-wesnoth itch.io]. While Wesnoth, Inc. financially supports the project, it does not have any involvement in its organization and direction. The current board of directors consists of Elvish_Hunter, Pentarctagon, and Soliton.

== Content Creators ==

Wesnoth's great replay value mainly stems from the great abundance of custom-made content developed by our talented community. It only takes a copy of the game, a text editor, creativity, and patience to create your own campaign, era, or multiplayer scenario!

See [[Create]] for more information on the subject of user-made content development.

== Artists ==

Graphic artists and musicians usually meet on the [https://forums.wesnoth.org/ Wesnoth.org forums]. While the main game is generally regarded as feature-complete, there is plenty of room for improvement in areas such as animations and sound effects. User-made content creators are also always in need of new art, music, and sounds for their own projects!

* [https://forums.wesnoth.org/viewforum.php?f=9 Mainline art contributions forum]
* [https://forums.wesnoth.org/viewforum.php?f=18 Mainline art development forum] (restricted to established contributors)
* [https://forums.wesnoth.org/viewforum.php?f=23 User-made art development forum]
* [https://forums.wesnoth.org/viewforum.php?f=14 Music contributions forum]

== Developers ==

The project is always eager to welcome new contributors able to help by fixing [https://bugs.wesnoth.org/ bugs], cleaning up and improving on existing code, or implementing new and exciting features!

* [[WesnothRepository]] — cloning and using our Git repository
* [[CodingStandards]] and [[HackingWesnoth]] — information on our C++ style and coding conventions
* [[PatchSubmissionGuidelines]] — instructions for submitting your code contributions
* [[DeveloperGuide]] — additional information on commit messages, unit tests, etc.
* [https://devdocs.wesnoth.org/ Source code documentation] — generated from the game's source code using Doxygen and updated daily.
* [[ReferenceWML]] — information on the Wesnoth Markup Language (WML) and the game's Lua API
* [[DeveloperResources]] — additional development-related links

== Translators ==

In order to better reach its audience, Wesnoth needs people able to translate the game into other languages from across the globe. If you consider yourself able to help, join the translation team for your language -- or if none has been established already, follow the instructions to start your own!

* [[WesnothTranslations]] — includes a list of translation maintainers and useful links for prospective translators
* [http://gettext.wesnoth.org Statistics]

[[Category:Development]]

IntroWML

2024-03-06T04:37:17Z

Shadowm: linkies

{{WML Tags}}

The '''[story]''' tag is a series of images and text to display as the first part of the intro screen. It can appear in [[ScenarioWML]] or {{DevFeature1.13|8}} as [[InterfaceActionsWML#.5Bstory.5D|ActionWML]].

The [[InterfaceActionsWML#.5Bdeprecated_message.5D|'''[deprecated_message]''']], [[InterfaceActionsWML#.5Bwml_message.5D|'''[wml_message]''']], and [[VariablesWML#.5Binsert_tag.5D|'''[insert_tag]''']] tags are allowed beneath '''[story]'''. Most other WML tags will not be recognized in this context. Note, however, that messages produced by the first two tags will not appear in the game interface until the actual game map appears.

The only other tags currently recognized within '''[story]''' and '''[part]''' are [[ConditionalActionsWML#.5Bif.5D|'''[if]'''/'''[then]'''/'''[else]''']] ({{DevFeature1.13|0}}: also [[ConditionalActionsWML#.5Bif.5D|'''[elseif]''']]) and [[ConditionalActionsWML#.5Bswitch.5D|'''[switch]'''/'''[case]''']]. These can be used to show parts conditionally on the values of variables.

See also the journey and battle macros, in the [https://www.wesnoth.org/macro-reference.html#file:image-utils.cfg Macro Reference]

== [part] ==

Each '''[part]''' tag represents one "page" of a story sequence, with its own text and images. The player advances through parts by clicking on the '''Next'''/'''→''' button to advance one part, the '''Back'''/'''←''' button to go back one part, and the '''Skip''' button to leave the story sequence and start/return to the game.

The following keys/tags are recognized for '''[part]'''.

=== Main text keys ===

* '''story''': (translatable) the text to display below the image.
* '''text_alignment''': specifies the alignment of the story text. It must be one of ''left'' (default), ''center'' or ''right''.
* '''text_layout''': specifies the vertical portion of the screen where the story text will be displayed. It must be one of ''top'', ''middle'' or ''bottom'' (default).

=== Title text keys ===

* '''show_title''': whether to display the title of the scenario at the top
* '''title''': specifies a custom title to display instead of the name of the scenario. If specified, it implies '''show_title=yes'''. If parent the '''[story]''' is used through [[InterfaceActionsWML#.5Bstory.5D|ActionWML]] with '''show_title=yes''', the '''title''' key must be explicitly specified as it does not default to the scenario title and leads to a missing title error if omitted.
* '''title_alignment''': specifies the alignment of the title box. It must be one of ''left'' (default), ''center'' or ''right''.

=== Image and sound keys ===

* '''background''': the image to display. Story images are usually created specially for this purpose, except for the map.
* '''scale_background''': Whether to scale the background, default yes.
* '''music''': change to this music
* '''sound''': a list of sound files; the engine will choose one at random and play it once while displaying the story part.
* '''voice''': a list of sound files; the engine will choose one at random and play it on a sound channel intended for voice overs once while displaying the story part.

=== [background_layer] ===

A layer of the background of the story screen.

* '''image''': path to the image file.
* '''scale_vertically''': whether the image should be scaled to fill the screen in the vertical dimension. Default yes.
* '''scale_horizontally''': whether the image should be scaled to fill the screen in the horizontal dimension. Default yes.
* '''scale''': a shortcut to set scale_vertically and scale_horizontally at once. If specified, the values of the former two keys will be ignored.
* '''keep_aspect_ratio''': whether the aspect ratio of the image should be preserved while scaling. Default yes.
* '''tile_vertically''': whether the image should be tiled in the vertical direction. Tiling happens after aligning the image to the center of the screen. Default no.
* '''tile_horizontally''': whether the image should be tiled in the horizontal direction. Tiling happens after aligning the image to the center of the screen. Default no.
* '''tile''': a shortcut to set tile_vertically and tile_horizontally at once. If specified, the values of the former two keys will be ignored.
* '''base_layer''': whether is this the layer to align the overlay images to. Default no.

=== [image] ===

An image to display.

* '''x''', '''y''': the location to draw the image, using the pixels of the '''base_layer''' background image as the coordinate system.
* '''centered''': If "yes", use the center of the image as the anchor point when placing at the x,y coordinates, if "no" then use the top-left corner.
* '''file''': the image to display.
* '''delay''': the time to delay drawing this image.
* '''resize_with_background''': {{DevFeature1.15|7}} if "yes", apply the same scaling as applied to the '''base_layer'''

Each image is placed using the pixels of the background_layer as the coordinate system; each image's location moves to compensate when the background image is scaled. Example: my background image is a map with a city at pixel 160,100; I put a battle marker on that city using '''x,y,centered=160,100,yes'''. When a user plays the game they will see the map enlarged to fill the window (regardless of its size), and the battle marker will still be on top of the city.

== See Also ==

* [[ReferenceWML]]

[[Category: WML Reference]]

IntroWML

2024-03-06T04:33:50Z

Shadowm: [image] has never been a direct descendant of [story]

{{WML Tags}}

The '''[story]''' tag is a series of images and text to display as the first part of the intro screen. It can appear in [[ScenarioWML]] or {{DevFeature1.13|8}} as [[InterfaceActionsWML#.5Bstory.5D|ActionWML]].

The '''[deprecated_message]''', '''[wml_message]''', and '''[insert_tag]''' tags are allowed beneath '''[story]'''. Most other WML tags will not be recognized in this context. Note, however, that messages produced by the first two tags will not appear in the game interface until the actual game map appears.

The only other tags currently recognized within '''[story]''' and '''[part]''' are '''[if]'''/'''[then]'''/'''[else]''' ({{DevFeature1.13|0}}: also '''[elseif]''') and '''[switch]'''/'''[case]'''. These can be used to show parts conditionally on the values of variables.

See also the journey and battle macros, in the [https://www.wesnoth.org/macro-reference.html#file:image-utils.cfg Macro Reference]

== [part] ==

Each '''[part]''' tag represents one "page" of a story sequence, with its own text and images. The player advances through parts by clicking on the '''Next'''/'''→''' button to advance one part, the '''Back'''/'''←''' button to go back one part, and the '''Skip''' button to leave the story sequence and start/return to the game.

The following keys/tags are recognized for '''[part]'''.

=== Main text keys ===

* '''story''': (translatable) the text to display below the image.
* '''text_alignment''': specifies the alignment of the story text. It must be one of ''left'' (default), ''center'' or ''right''.
* '''text_layout''': specifies the vertical portion of the screen where the story text will be displayed. It must be one of ''top'', ''middle'' or ''bottom'' (default).

=== Title text keys ===

* '''show_title''': whether to display the title of the scenario at the top
* '''title''': specifies a custom title to display instead of the name of the scenario. If specified, it implies '''show_title=yes'''. If parent the '''[story]''' is used through [[InterfaceActionsWML#.5Bstory.5D|ActionWML]] with '''show_title=yes''', the '''title''' key must be explicitly specified as it does not default to the scenario title and leads to a missing title error if omitted.
* '''title_alignment''': specifies the alignment of the title box. It must be one of ''left'' (default), ''center'' or ''right''.

=== Image and sound keys ===

* '''background''': the image to display. Story images are usually created specially for this purpose, except for the map.
* '''scale_background''': Whether to scale the background, default yes.
* '''music''': change to this music
* '''sound''': a list of sound files; the engine will choose one at random and play it once while displaying the story part.
* '''voice''': a list of sound files; the engine will choose one at random and play it on a sound channel intended for voice overs once while displaying the story part.

=== [background_layer] ===

A layer of the background of the story screen.

* '''image''': path to the image file.
* '''scale_vertically''': whether the image should be scaled to fill the screen in the vertical dimension. Default yes.
* '''scale_horizontally''': whether the image should be scaled to fill the screen in the horizontal dimension. Default yes.
* '''scale''': a shortcut to set scale_vertically and scale_horizontally at once. If specified, the values of the former two keys will be ignored.
* '''keep_aspect_ratio''': whether the aspect ratio of the image should be preserved while scaling. Default yes.
* '''tile_vertically''': whether the image should be tiled in the vertical direction. Tiling happens after aligning the image to the center of the screen. Default no.
* '''tile_horizontally''': whether the image should be tiled in the horizontal direction. Tiling happens after aligning the image to the center of the screen. Default no.
* '''tile''': a shortcut to set tile_vertically and tile_horizontally at once. If specified, the values of the former two keys will be ignored.
* '''base_layer''': whether is this the layer to align the overlay images to. Default no.

=== [image] ===

An image to display.

* '''x''', '''y''': the location to draw the image, using the pixels of the '''base_layer''' background image as the coordinate system.
* '''centered''': If "yes", use the center of the image as the anchor point when placing at the x,y coordinates, if "no" then use the top-left corner.
* '''file''': the image to display.
* '''delay''': the time to delay drawing this image.
* '''resize_with_background''': {{DevFeature1.15|7}} if "yes", apply the same scaling as applied to the '''base_layer'''

Each image is placed using the pixels of the background_layer as the coordinate system; each image's location moves to compensate when the background image is scaled. Example: my background image is a map with a city at pixel 160,100; I put a battle marker on that city using '''x,y,centered=160,100,yes'''. When a user plays the game they will see the map enlarged to fill the window (regardless of its size), and the battle marker will still be on top of the city.

== See Also ==

* [[ReferenceWML]]

[[Category: WML Reference]]

InterfaceActionsWML

2024-03-06T04:32:28Z

Shadowm: /* [story] */

{{WML Tags}}
== Interface actions ==

Part of [[ActionWML]], interface actions are actions that do not have a direct effect on gameplay;
instead, they show something to the player. The main interface tags
are '''[message]''' and '''[objectives]''', but several other tags affect
the interface also.

== [inspect] ==
This user interface instantly displays the gamestate inspector dialog at the current scenario state (the same one that can be brought up with [[CommandMode|the ''':inspect''' command]]), which can be used to inspect the values of WML variables, AI configuration, recall lists, and more.

* '''name''': optional attribute to specify the name of this gamestate inspector dialog. It is just a label to help differentiate between different invocations of gamestate inspector dialog.

== [message] ==
The most commonly used interface action is [message], which displays a message to the user in a dialog box. It can also be used to take input from the user.

The following key/tags are accepted for [message]:
* [[StandardUnitFilter]]: The unit whose profile and name are displayed. Do not use a [filter] tag. If no unit matching this filter is found, the message is not displayed (The unit has probably been killed). [message] elements should be constructed so that it is either guaranteed that a certain unit is alive, or so that dialog flows smoothly even if the message isn't displayed.

* '''speaker''': an alternative to standard unit filter. You may specify as the value of the speaker attribute a unit id or any of the following special values:
** '''narrator''': the dialog box is displayed without a caption for the unit speaking or a unit image
** '''unit''': the primary unit for the event is speaking
** '''second_unit''': the secondary unit for the event is speaking

* '''message''': (translatable) the text to display to the right of the image. ''message'' is sometimes multiple lines; if it is, be sure to use quotes(''' ' ''' or ''' " ''')
* '''male_message''', '''female_message''': {{DevFeature1.13|2}} (translatable) Used instead of ''message'' if the unit's gender matches. Never used if there is no unit (ie ''speaker=narrator''). {{DevFeature1.13|6}} This matches the primary unit, not the secondary unit.
* '''wait_description''': {{DevFeature1.13|2}} the description of this message displayed when other players in a mp game wait for one player doing input in a [message] (with [option]s or [text_input]).
* '''[show_if]''': if present then this message will only be displayed if the conditional statement in this tag is passed (see [[ConditionalActionsWML#Condition_Tags|ConditionalActionsWML]])
* '''side_for''': (default: all sides) comma-separated list of sides for who message is shown. This will not work with messages that take user input ([option]/[text_input]), which can only ever be shown to the current player. {{DevFeature1.13|0}} side_for= is now also accepted for messages with user input, it specifies on which side the message is shown (defaults to the currently playing side). For messages with input it does not accept a comma seperated list only a single number.
* '''image''': (default: profile image of speaker) the image to display to the left of the message text. Append ~RIGHT() if you want the image to appear on the right side.
** {{DevFeature1.13|0}} none: display no image
* '''mirror''': {{DevFeature1.13|5}}whether to mirror the image specified by the '''image''' attribute.
* '''second_image''': {{DevFeature1.13|6}}same as the '''image''' attribute, but the image is displayed on the right of the message text.
* '''second_mirror''': {{DevFeature1.13|6}}same as '''mirror''', but for the '''second_image''' attribute.
* '''image_pos''': {{DevFeature1.13|5}} whether to show the image on the left or right; supercedes the use of ~RIGHT() described above
* '''caption''': (default: name of speaker) the caption to display beside the image. Name to be displayed. Note: use a translation mark to avoid wmllint errors.
* '''scroll''': Boolean specifying whether the game view should scroll to the speaking unit. Defaults to ''yes''.
* '''highlight''': {{DevFeature1.13|5}} Boolean specifying whether to highlight the speaker. Defaults to ''yes''.
* '''sound''': a sound effect (wav file) to play as the message is displayed. This can be a comma-separated list, from which one will be randomly chosen.
* '''voice''': {{DevFeature1.13|?}} a sound to be played as the message is displayed. This can also be a comma-separated list, from which one will be randomly chosen. This is intended for voiceovers for the message.
* {{anchor|message-option|'''[option]'''}}: No '''[option]''' elements have to be used. If '''[option]''' elements are present, then each option will be displayed in a menu for the user to select one option. ''Note: Messages with options will not be shown at all in prestart events''
** '''message''': (translatable) the text displayed for the option. {{DevFeature1.15|1}} This is now a synonym for '''description='''.
** '''image''', '''label''', '''description''', '''default''': See [[DescriptionWML#WML_Format|DescriptionWML]].
** '''value''': {{DevFeature1.13|?}} Gives the option a value to be stored in a variable.
** '''[show_if]''': if present then this option will only be displayed if the conditional statement in this tag is passed (see [[ConditionalActionsWML#Condition_Tags|ConditionalActionsWML]])
** '''[command]''': an element containing actions which are executed if the option is selected.
* '''variable''': {{DevFeature1.13|?}} If present, either the index or the value of the chosen option will be stored in the specified variable. Option indexing starts from 1. If option has '''[show_if]''' condition evaluated as false, then it is hidden and excluded from the indexing.
* {{anchor|message-text_input|'''[text_input]'''}}: there can be only one [text_input] tag. this adds a text input field to the message. ''Note: Messages with text_input will not be shown at all in prestart events''
** '''variable''': the variable that the user's input will be written to
** '''label''': a text label to the left of the input field
** '''max_length''': the maximum number of characters that may be typed into the field
** '''text''': text that is written into the field in the beginning
* Check [[EventWML#Multiplayer_safety]] to find out in which events you can safely use '''[option]''' and '''[text_input]''' without causing OOS.

=== Formatting ===
'''[message]''' and other tags such as unit names (user_description), objectives, and floating text can make use of [https://docs.gtk.org/Pango/pango_markup.html#pango-markup Pango markup formatting codes].

Prefer to use single quotes (') instead of double quotes (") within the formatting string, as double quotes would need to be escaped in WML (""). Escaping markup can be done with [https://github.com/wesnoth/wesnoth/blob/9daa10a9f27c5a95520e871417bbd72aa52aa688/src/font/pango/escape.hpp#L38-L42 HTML entities].

For example, if you wanted to write "You are victorious!" in large, italic, gold letters, you might write it this way:

<nowiki>You are victorious!</nowiki>

These are the codes taken from the Pango markup formatting guide:

*'''font''', '''font_desc''': A font description string, such as "Sans Italic 12".
*'''font_family''', '''face''': A font family name.
*'''font_size''', '''size''': Font size in 1024ths of a point, or one of the absolute sizes 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large', or one of the relative sizes 'smaller' or 'larger'.
*'''font_style''', '''style''': One of 'normal', 'oblique', 'italic'.
*'''font_weight''', '''weight''': One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold', 'heavy', or a numeric weight.
*'''font_variant''', '''variant''': One of 'normal' or 'smallcaps'.
*'''font_stretch''', '''stretch''': One of 'ultracondensed', 'extracondensed', 'condensed', 'semicondensed', 'normal', 'semiexpanded', 'expanded', 'extraexpanded', 'ultraexpanded'.
*'''foreground''', '''fgcolor''', '''color''': An RGB color specification such as '#00FF00' or a color name such as 'red'. The full list of color names may be found in Pango's [https://github.com/GNOME/pango/blob/main/tools/rgb.txt rgb.txt] file.
*'''background, bgcolor''': An RGB color specification such as '#00FF00' or a color name such as 'red'.
*'''underline''': One of 'none', 'single', 'double', 'low', 'error'.
*'''underline_color''': The color of underlines; an RGB color specification such as '#00FF00' or a color name such as 'red'.
*'''rise''': Vertical displacement, in 10000ths of an em. Can be negative for subscript, positive for superscript.
*'''strikethrough''': 'true' or 'false' whether to strike through the text.
*'''strikethrough_color''': The color of strikethrough lines; an RGB color specification such as '#00FF00' or a color name such as 'red'
*'''fallback''': 'true' or 'false' whether to enable fallback. If disabled, then characters will only be used from the closest matching font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text. Fallback is enabled by default. Most applications should not disable fallback.
*'''letter_spacing''': Inter-letter spacing in 1024ths of a point.
*'''gravity''': One of 'south', 'east', 'north', 'west', 'auto'.
*'''gravity_hint''': One of 'natural', 'strong', 'line'.

The following pango attributes are also available directly as attributes of the '''[message]''' tag:
{{DevFeature1.13|4}}

*'''font'''
*'''font_family'''
*'''font_size'''
*'''font_style'''
*'''font_weight'''
*'''font_variant'''
*'''font_stretch'''
*'''color'''
*'''bgcolor'''
*'''underline'''
*'''underline_color'''
*'''rise'''
*'''strikethrough'''
*'''strikethrough_color'''
*'''fallback'''
*'''letter_spacing'''
*'''gravity'''
*'''gravity_hint'''

== [objectives] ==
The other tag used for plot development is '''[objectives]'''.
The '''[objectives]''' tag overwrites any previously set objectives,
and displays text which should describe the objectives of the scenario.
Scenario objectives are displayed on the player's first turn after the tag is used,
or as part of the event if it triggers during that player's turn.
Objectives can also be accessed at any time in a scenario using the
"Scenario Objectives" game menu option, making this tag useful for
scenario-specific information that the player may need to refer to during play.

Attributes of '''[objectives]''':
* '''side''': Default '0'. The side to set the objectives for. A value of 0 sets objectives for all sides. note: There are side-specific objectives and default objectives, which are used in case a side doesn't have specific ones. Specifying 0 sets the default ones.
* '''[[StandardSideFilter]]''' tags and keys: Sets the objectives of all matching sides to these passed specifications (the rest of this [objectives] tag). If no sides (such as when passing side=0) or all sides match, sets the default objectives, and the side specific ones for the matching sides otherwise.
* '''bullet''': Default '• '. Replaces the default bullet, with whatever is passed, for all objectives, gold carryover notes, and notes defined with [note].
* '''summary''': Displayed first in the objectives text, this should describe the basic objective for the overall scenario. Can be omitted.
* '''note''': Displayed last in the objectives text, this is sometimes used for hints or additional information. Can be omitted.
* '''victory_string''': Default ' _ "Victory:"', this text precedes the victory objectives. Can be set to "" too.
* '''defeat_string''': Default ' _ "Defeat:"', this text precedes the defeat objectives. Can be set to "" too.
* '''gold_carryover_string''': Default ' _ "Gold carryover:"', this text precedes the gold carryover information.
* '''notes_string''': Default ' _ "Notes:"', this text precedes the notes.
* '''silent''': Default: not present. If set to "yes", the objectives are silently changed. Else, they will be shown to the user when appropriate.
* '''delayed_variable_substitution''': {{DevFeature1.13|8}} If set to yes, any variables or [insert_tag] are not substituted right away. Instead, they are substituted whenever the objectives are actually viewed.

Tags of '''[objectives]''':
* {{anchor|objectives-objective|'''[objective]'''}}: describes a win or loss condition. Most scenarios have multiple win or loss conditions, so use a separate [objective] subtag for each line; this helps with translations.
** '''bullet''': Default '• ' or whatever is set in the parent [objectives] block. Replaces the default bullet, with whatever is provided, for the objective defined by the [objective] block.
** '''red''': Default '0' for winning objectives, '255' for losing objectives. Overrides the default red coloring of the entire objective, including the bullet.
** '''green''': Default '255' for winning objectives, '0' for losing objectives. Overrides the default green coloring of the entire objective, including the bullet.
** '''blue''': Default '0'. Overrides the default blue coloring of the entire objective, including the bullet.
** '''description''': text for the specific win or loss condition.
** '''caption''': a text which will be displayed above the ''description''. This can be used to display a subcategory of objectives below ''victory_string'' or ''defeat_string''.
** '''condition''': The color and placement of the text. Values are 'win'(colored green, placed after ''victory_string'') and 'lose'(colored red, placed after ''defeat_string'').
** '''show_turn_counter''': If set to yes, displays the number of turns remaining in the scenario. Default is no.
** '''[show_if]''': A condition that disables the objective if it doesn't hold. Conditional objectives are refreshed at '''[show_objectives]''' time only, or when manually opening the scenario objectives.
* {{anchor|objectives-gold_carryover|'''[gold_carryover]'''}}: describes how the gold carryover works in this scenario. This is intended to be a more convenient way of displaying carryover information than using the note= key in [objectives].
** '''bullet''': Default '• ' or whatever is set in the parent [objectives] block. Replaces the default bullet with whatever is provided.
** '''red''': Default '255'. Overrides the default red coloring of the entire objective, including the bullet.
** '''green''': Default '255'. Overrides the default green coloring of the entire objective, including the bullet.
** '''blue''': Default '192'. Overrides the default blue coloring of the entire objective, including the bullet.
** '''bonus''' (boolean): whether an early finish bonus is granted. If omitted, early finish bonus is not mentioned.
** '''carryover_percentage''': the amount of carryover gold. If omitted, the amount is not mentioned.
** '''[show_if]''': {{DevFeature1.13|11}} Gold carryover will not be shown if the specified condition isn't met. Conditional gold carryover is refreshed at '''[show_objectives]''' time only.
* {{anchor|objectives-note|'''[note]'''}}: describes a note, usually used for hints or additional information. This is an easier way of adding several notes than concatenating them together into a single string to use with the ''note='' key.
** '''bullet''': Default '• ' or whatever is set in the parent [objectives] block. Replaces the default bullet with whatever is provided for the note defined by the [note] block.
** '''red''': Default '255'. Overrides the default red coloring of the entire note, including the bullet.
** '''green''': Default '255'. Overrides the default green coloring of the entire note, including the bullet.
** '''blue''': Default '255'. Overrides the default blue coloring of the entire note, including the bullet.
** '''description''': the text of the note.
** '''[show_if]''': The note will not be shown if the specified condition isn't met. Conditional notes are refreshed at '''[show_objectives]''' time only.

== [set_menu_item] ==
This tag is used to add a custom option in the right-click context menu which can then be used to trigger arbitrary WML commands. The menu items can be set and modified during any event, for example during "start" or "prestart" events. The user can also assign hotkeys to these WML commands unless specified otherwise. When the hotkey is pressed the event will be fired/filtered at the current mouse position.

'''Note:''' Due to limitations in portable devices where there are no scroll bars for context menus, there is a hard-coded limit of 7 custom WML menu items. If you really need to have more than 7 menu items, try combining some of them in a submenu. {{DevFeature1.13|0}} This limitation is being removed in a [http://forums.wesnoth.org/viewtopic.php?p=572554#p572554 future version] of Wesnoth.

* '''id''': the unique id for this menu item. If a menu item with this id already exists, it allows you to set specific changes to that item. All menus will be sorted lexicographically by the id string. The ordering is underscores, digits, and finally letters.
* '''description''': the in-game text that will appear for this item in the menu.
* '''image''': the image to display next to this item.
* '''needs_select''': if ''yes'' (default ''no''), then the latest select event (see [[EventWML]]) that triggered before this menu item was chosen will be transmitted over the network before this menu item action will be. This only has any effect in networked multiplayer, and is intended to allow more elaborate menu item behaviour there without causing out of sync errors. If you don't know what this means, just leave it. {{DevFeature1.13|6}} ''needs_select=yes'' is deprecated, consider using manual variable syncing with [sync_variable].
* '''synced''' {{DevFeature1.13|1}}: if ''no'' (default ''yes'') the command handler will only be run on the client that invoked the menu item; this means that changing the gamestate in a command handler of a menu item with ''synced=no'' will cause OOS
* '''use_hotkey''': if ''no'' (default ''yes''), then the user cannot assign hotkeys to this menu item. If ''only'', the menu item is only accessible via hotkeys, not via right-click context; you can use this in combination with [default_hotkey] if you want custom hotkeys in your campaign/mp.
* '''[show_if]''': If present, the menu item will only be available if the conditional statement (see [[ConditionalActionsWML#Condition_Tags|ConditionalActionsWML]]) within evaluates to true. When this is evaluated, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked, so it's possible to for example only enable the option on empty hexes or on a particular unit.
* '''[filter_location]''': contains a [[StandardLocationFilter]] similar to the one found inside Single Unit Filters. The menu item will only be available on matching locations.
* '''[default_hotkey]''': contains a hotkey WML to specify what hotkey to assign to this, '''if the user has no hotkey assigned to this yet'''. (Unlike the rest of a menu item definition, modifying this tag has no effect on the game; it is only effective when initially defining a menu item.) Hotkey WML matches the format in the preferences file and contains the following keys:
** '''key''': a string that contains the key to assign to this.
** '''alt''', '''shift''', '''cmd'''(apple only), '''ctrl''': boolean values.
** '''repeat_on_hold''' {{DevFeature1.13|12}}: if ''yes'' (default ''no''), holding the hotkey will repeat the action continuously, unless it blocks input with something like '''[message]'''. Due to a bug, versions older than 1.13.12 always repeat the action, with no way to disable it.
* '''[command]''': contains the WML actions to be executed when the menu item is selected. Again, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked on.
** '''delayed_variable_substitution ''' (boolean yes|no, default: yes): If no, forces a variable substitution run onto the wml included in this [command] block. Use this, if you want variables which are to substitute to get the values they have at execution time of the event where this set_menu_item appears. Other than that, they get the values they have at invocation time of the menu item.

== [clear_menu_item] ==

Removes a menu item from the scenario.
Normally menu items are, including all their defining wml, automatically carried over between scenarios. This tag prevents this. (The behavior is comparable to set_variable/clear_variable).
* '''id''': (string): id of the menu item to clear. Can be a comma-separated list.

== Other interface tags ==

The following tags are also action tags:

=== [change_theme] ===

{{DevFeature1.13|8}}

Change the current interface theme.

* '''theme''': The ID of the new theme. Use <code>theme=</code> (empty key) to switch back to the theme that the player has selected in Preferences. On 1.14.2 and later it is also possible to omit the key entirely to achieve the same effect (on previous versions this will crash the Lua engine).

=== [item] ===
Makes a graphical item appear on a certain hex. Note this only places the graphics for an item. It does not make the item do anything. Use a moveto event to make moving onto the item do something. <tt>''('''Hint:''' There are a number of predefined items that are used in various campaigns that you can make use of. You can find [http://www.wesnoth.org/macro-reference.xhtml#file:items.cfg a list of them] if you look into the items.cfg file in the wesnoth install directory (under /data/core/macros).)''</tt>
* '''x''', '''y''': the location to place the item. (only for [event][item]: full [[StandardLocationFilter|SLF]] support)
* '''image''': the image (in ''images/'' as .png) to place on the hex. This image is aligned with the top-left of the hex (which is 72 pixels wide and 72 pixels tall). It is drawn underneath units. ''('''Hint:''' If using an image smaller than 72x72, then it might be useful to [[ImagePathFunctions#Blit_Function|BLIT]] the image onto <tt>misc/blank-hex.png</tt> (a blank 72x72 image).)''
* '''halo''': an image to place centered on the hex. It is drawn on top of units. Use this instead of ''image'' if the image is bigger than the hex or if you want to animate an image (https://github.com/wesnoth/wesnoth/issues/1219).
* '''name''' an id that can be used to remove the item.
''Example (where the integer after the colon is the duration of each frame or square bracket expansion as per AnimationWML is used): halo=scenery/fire1.png:100,scenery/fire2.png:100,scenery/fire3.png:100,scenery/fire4.png:100,scenery/fire5.png:100,scenery/fire6.png:100,scenery/fire7.png:100,scenery/fire8.png:100''
or equivalently (requires Wesnoth 1.11.2+):
''halo=scenery/fire[1~8].png:100''
* '''team_name''': name of the team for which the item is to be displayed (hidden for others). For multiple teams just put all the names in one string, for example separated by commas. {{DevFeature1.15|0}} In 1.14 the '''[side]team_name''' attribute was expected to be a substring of this '''team_name'''. In 1.15 both are expected to be comma-separated lists of names and the item is visible if the lists intersect. ([[https://github.com/wesnoth/wesnoth/pull/3533|#3533]])
* '''visible_in_fog''': whether the item should be visible through fog or not. Default yes.
* '''redraw''': (boolean yes|no, default: yes): If no, disables implicit calls to [[InterfaceActionsWML#.5Bredraw.5D|[redraw]]] when placing the items.
* '''[filter_team]''': {{DevFeature1.15|0}} A [[StandardSideFilter]]. Set '''team_name''' to the union of all '''[side]team_name''' attributes of all sides that match the SSF. ([[https://github.com/wesnoth/wesnoth/pull/3533|#3533]])
* {{DevFeature1.15|0}} If both '''team_name''' and '''[filter_team]''' are set, '''team_name''' is ignored.

=== [remove_item] ===
Removes any graphical items on a given hex.
* [[StandardLocationFilter]]: the hexes to remove items from
* '''image''': if specified, only removes the given item if one of its 'image', 'halo' or 'name' attributes is exactly this value. (for 'halo' and 'image' this in particular means that the image name must include any [[ImagePathFunctions|image path functions]] appended to the original image name.)

=== [print] ===
Displays a message across the screen. The message will disappear after a certain time, or when another [print] tag is encountered.
* '''text''': (translatable) the text to display. Can be an empty string to remove a previous message without showing a new one.
* '''size''': (default=12) the pointsize of the font to use
* '''duration''': the length of time to display the text for.
** (Before 1.15.4) This is measured in the number of 'frames', and the default is 50. A frame in Wesnoth is usually displayed for around 30ms.
** {{DevFeature1.15|4}} This is measured in milliseconds. Don't use the default value, because it's a mere 50ms.
** {{DevFeature1.15|14}} The default is 5000 milliseconds.
** {{DevFeature1.15|14}} The string '''unlimited''' displays the text until it's removed by another [print] tag.
* '''color''': (default '''0,0,0''') three comma-separated values giving the red, green and blue values (0-255).
* '''red''', '''green''', '''blue''': deprecated, use color=0,0,0 instead.

=== [move_unit_fake] ===
Moves an image of a unit along a certain path on the map. The path does not need to be a continuous list of adjacent hexes, so for example only the start and end points can be given, in which case the straightest line between those points will be calculated and used.
* '''type''': the type of the unit whose image to use
* '''x''': a comma-separated list of x locations to move along
* '''y''': a comma-separated list of y locations to move along (x and y values are matched pairs)
* '''side''': the side of the fake unit, used for team-coloring the fake unit
* '''gender''': the gender of the fake unit. Example: gender=female
* '''variation''': the variation of the fake unit. Example: variation=undead
* '''image_mods''': [[ImagePathFunctions|image path functions]] sequence to be applied on the fake unit.
* '''force_scroll''': Whether to scroll the map or not even when [[#.5Block_view.5D|[lock_view]]] is in effect or ''Follow Unit Actions'' is disabled in ''Advanced Preferences''. Defaults to ''yes'' starting with version '''1.11.6'''; the attribute did not exist in previous versions and this action behaved as if ''no'' was passed instead.

=== [move_units_fake] ===
moves multiple images of units along paths on the map. These units are moved in lockstep.
* '''force_scroll''': {{DevFeature1.15|0}} Has the same meaning as in [move_unit_fake] but a different default.
* '''[fake_unit]''': A fake unit to move
** '''type''': the type of unit whose image to use
** '''x''': a comma-separated list of x locations to move along
** '''y''': a comma-separated list of y locations to move along (x and y values are matched pairs)
** '''side''': the side of the fake unit, used for team-coloring the fake unit
** '''skip_steps''': the number of steps to skip before this unit starts moving

=== [hide_unit] ===
Temporarily prevents the engine from displaying the given unit. The unit does not become invisible, as it would be with the '''[hides]''' ability; it is still the same plain unit, but without an image. Useful in conjunction with '''[move_unit_fake]''': to move a leader unit into position on-screen. Until 1.8 each '''[hide_unit]''' tag only hides one unit.
* [[StandardUnitFilter]]: All matching units will be hidden

=== [unhide_unit] ===
Stops the currently hidden units from being hidden.
* [[StandardUnitFilter]]: Only the matching units will be unhidden

=== [lock_view] ===
Locks gamemap view scrolling for human players, so they cannot scroll the gamemap view until it is unlocked. WML or Lua actions such as '''[scroll_to]''' will continue to work normally, as they ignore this restriction; the locked/unlocked state is preserved when saving the current game.

This feature is generally intended to be used in cutscenes to prevent the player scrolling away from scripted actions.

{{DevFeature1.13|8}} This now also blocks the player from zooming the gamemap view. WML or Lua zoom will continue to work normally.

=== [unlock_view] ===
Unlocks gamemap view scrolling for human players.

=== [scroll] ===
Scroll a certain number of pixels in a given direction. Useful for earthquake/shaking effects.
* '''x''', '''y''': the number of pixels to scroll along the x and y axis
* '''side''': the side or sides for which this should happen. By default, the [scroll] happens for everyone.
* '''[filter_side]''': a [[StandardSideFilter]] to select the sides for which this should happen. By default, the [scroll] happens for everyone.

=== [scroll_to] ===
Scroll to a given hex
* [[StandardLocationFilter]], do not use a [filter_location] sub-tag. If more than one location matches the filter, only the first matching location will be used.
* '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''yes'' (don't scroll to fog) and ''no'' (scroll even to fog), with ''no'' as the default.
* '''immediate''': whether to instantly warp to the target hex regardless of the scroll speed setting in Preferences (defaults to ''no'').
* '''highlight''': {{DevFeature1.13|5}} Whether to highlight the hex being scrolled to (defaults to ''no'').
* '''side''': the side or sides for which this should happen. By default, the [scroll_to] happens for everyone.
* '''[filter_side]''': a [[StandardSideFilter]] to select the sides for which this should happen. By default, the [scroll_to] happens for everyone.

=== [scroll_to_unit] ===
Scroll to a given unit
* [[StandardUnitFilter]]; do not use a [filter] subtag.
* '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''yes'' (don't scroll to fog) and ''no'' (scroll even to fog), with ''no'' as the default.
* '''immediate''': whether to instantly warp to the target hex regardless of the scroll speed setting in Preferences (defaults to ''no'').
* '''highlight''': {{DevFeature1.13|5}} Whether to highlight the hex the unit is on (defaults to ''no'').
* '''for_side''': the side or sides for which this should happen. By default, the [scroll_to_unit] happens for everyone.
* '''[for_side]''': a [[StandardSideFilter]] to select the sides for which this should happen. By default, the [scroll_to_unit] happens for everyone.

=== [select_unit] ===
Selects a given unit.
* [[StandardUnitFilter]]: The first unit found will be selected.
* '''fire_event''': whether a ''select'' event should be triggered or not (def. ''no''). (Note that select events aren't multiplayer save.)
* '''highlight''': whether the unit's current hex should be highlighted (def. ''yes'').

'''Note:''' fire_event does not appear to work in 1.14 or 1.16.

=== [sound]===
Plays a sound
* '''name''': the filename of the sound to play (in ''sounds/'' as .wav or .ogg). This can be a comma-separated list, from which one sound will be chosen randomly.
* '''repeat''': repeats the sound for a specified additional number of times (default=0)

=== [sound_source] ===
Creates a sound source. "Sound sources" is a general name for a mechanism which makes possible for map elements to emit sounds according to some rules, where "map elements" can be specific locations or terrain types. For now, only sound sources tied to locations are supported.
* '''id''': a unique identification key of the sound source
* '''sounds''': a list of comma separated, randomly played sounds associated with the sound source
* '''delay''': a numerical value (in milliseconds) of the minimal delay between two playbacks of the source's sound if the source remains visible on the screen; if one scrolls out and back in, the source will be considered as ready to play
* '''chance''': a percentage (a value from 0 to 100) describing the chance of the source being activated every second after the delay has passed or when the source's location appears on the screen (note that it cannot play more than one file at the same time)
* '''check_fogged''': possible values ''yes'' and ''no'' - ''yes'' means the source will not play if its locations are fogged
* '''check_shrouded''': possible values ''yes'' and ''no'' - ''yes'' means the source will not play if its locations are shrouded
* '''x,y''': similar to x,y as found in a [[StandardLocationFilter]], these are the locations associated with the sound source
* '''fade_range''' (default = 3): distance in hexes that determines a "circular" area around the one specified by '''full_range''' where sound volume fades out linearly
* '''full_range''' (default = 14): distance in hexes that determines a "circular" area where source plays with full volume, relative to screen center
* '''loop''': number of times a sound sample should be looped if it stays visible. -1 means infinite (~65000)

=== [story] ===
{{DevFeature1.13|8}}

Shows the story screen.
* '''title''': Default title used if a part does not specify one — unlike the intro storyscreen, the scenario name is not used as a default title.
* '''[part]''', '''[if]''', '''[switch]''', '''[wml_message]''', '''[deprecated_message]''' : See [[IntroWML]].

=== [remove_sound_source] ===
Removes a previously defined sound source.
* '''id''': the identification key of the sound source to remove

=== [music] ===
Switches to playing different music
* '''name''': the filename of the music to play (in ''music/'' as .ogg)
* see [[MusicListWML]] for the correct syntax

=== [volume] ===
Changes the game volume to a percent of the preferences volume for the game being played. Values can go from 0 to 100:
* '''music''': Changes the music volume.
* '''sound''': Changes the sound volume.

=== [color_adjust] ===
Adjust the color tint of terrain, by adjusting time-of-day coloring.
* '''red''', '''green''', '''blue''': values from -255 to 255, the amount to tint by for each color

=== [screen_fade] ===
{{DevFeature1.17|6}}

Overlay the game display with the given color, fading over the specified duration. This can be used for screen fade effects.
* '''red''', '''green''', '''blue''': values from 0 to 255, the final overlay color (defaults to 0,0,0)
* '''alpha''': value from 0 to 255, the strength of the effect. 0 means no effect and can be used to fade in. 255 means fully opaque and can be used to fully fade out to the given color. Intermediate values will end up with a partial overlay tint on the game screen.
* '''duration''': the length of time it will take to complete the fade, in milliseconds. If 0 the effect is immediate.

=== [delay] ===
Pauses the game.
* '''time''': the time to pause in milliseconds
* '''accelerate ''' (boolean yes|no, default no): {{DevFeature1.13|0}} whether the delay is affected by acceleration. When [delay] is used to make an animation, this should be set to yes so that your animation matches the ones generated by the game.

=== [redraw] ===
Redraws the screen (this normally isn't done during events, although some of the other interface actions cause the screen or parts of it to be redrawn).
* '''clear_shroud''' (boolean yes|no, default no): If yes, clears fog and shroud around existing units. Useful if you, for example, spawn friendly units in the middle of an event and want the shroud to update accordingly (otherwise units that spawn inside fog would remain invisible for the duration of the event, since the fog would not automatically get cleared around them).
* '''[[StandardSideFilter]]''': the sides for which to recalculate fog and shroud.
* '''side''': If used (forces clear_shroud=yes), clears fog and shroud for that side.

=== [unit_overlay] ===
Sets an image that will be drawn over a particular unit, and follow it around
* [[StandardUnitFilter]]: All matching units will get the overlay (do not use [filter])
* '''image''': the image to place on the unit
* '''object_id''': object id to use, defaults to the '''image''' key with an "overlay_" prefix; this allows using [[DirectActionsWML#.5Bremove_object.5D|'''[remove_object]''']]
* '''duration''': object duration

=== [remove_unit_overlay] ===
Removes a particular overlayed image from a unit
* [[StandardUnitFilter]]: The overlay will get removed from all matching units (do not use [filter])
* '''image''': the image to remove from the unit
* '''object_id''': object id to use
Using [[DirectActionsWML#.5Bremove_object.5D|'''[remove_object]''']] is also possible, see https://github.com/wesnoth/wesnoth/commit/26c2f941f2bcdd89528481e114c0375ad2a46271

=== [animate_unit] ===
Uses an animation of a unit to animate it on screen (if the unit has the corresponding animation).
* '''flag''': The key to find the custom animation in the unit description (see the '''[extra_anim]''' description in [[AnimationWML]]). Standard animations can be triggered with the following keywords: ''leading recruited standing idling levelout levelin healing healed poisoned movement defend attack death victory pre_teleport post_teleport''
* '''[filter]''' with a [[StandardUnitFilter]] as argument, see [[FilterWML]]. By default, the unit at the event location will be animated. You can use this tag to choose any other unit to animate.
* '''[primary_attack]''': If this tag is not present, the filter for animation will be triggered with no attack. If it is here, all attacks from the unit will be filtered, and a matching one will be used to filter the animation. Takes a weapon filter as argument, see [[FilterWML]].
* '''[secondary_attack]''': Similar to '''[primary_attack]'''. May be needed to trigger a defense animation correctly, if there are more than one animations available for the defending unit.
* '''hits''': yes/no/hit/miss/kill: which according variation of a attack/defense animation shall be chosen (required)
* '''text''': a text to hover during the animation
* '''male_text''', '''female_text''': {{DevFeature1.13|2}} (translatable) gender-specific versions of the above
* '''red''': red value for the text color (0-255)
* '''green''': green value for the text color
* '''blue''': blue value for the text color
* '''with_bars''': yes/no: whether to display the status bars during the animation (e.g. the hitpoint bar)
* '''[animate]''': a sub block with the same syntax as '''[animate_unit]''' except that the '''[filter]''' block is mandatory to find the unit. This block will find and animate another unit simultaneously.
* '''[facing]''': a [[StandardLocationFilter]] specifying what hex the unit should be facing when animated

=== [label] ===
Places a label on the map.
* '''x''', '''y''': the location of the label. {{DevFeature1.13|1}} (only for [event][label]: full [[StandardLocationFilter|SLF]] support)
* '''text''': what the label should say. If you put an empty string <code>""</code> as an argument, the label will be completely removed. Use this method if you want to remove a specific label from any location.
* '''team_name''': if specified, the label will only be visible to the given team.
* '''color''': color of the label. The format is r,g,b; r, g and b are numbers between 0 and 255.
* '''visible_in_fog''': whether the label should be visible through fog or not. Default yes.
* '''visible_in_shroud''': whether the label should be visible through shroud or not. Default no.
* '''immutable''': whether this label is protected from being removed or changed by players. Default yes.
* '''category''': the Show/Hide Labels dialog allows showing/hiding all labels of a given category by toggling a checkbox.
* '''tooltip''': A tooltip visible when mouseovering the hex the label is on
* '''side''': the number of the side that placed the label. Can be 0 for labels placed by WML.

=== [floating_text]===
Floats text (similar to the damage and healing numbers) on the given locations.
* [[StandardLocationFilter]]: the text will be floated on all matching locations simultaneously (do not use [filter] unless you intend to match one or more units).
* '''text''': the text to display.

The default text color is '''#6b8cff'''. To change the color, use [[#Formatting|Pango markup]]. For example:

<pre>
# Float some golden yellow text at 20,20.
[floating_text]
x,y=20,20
text="" + _ "Your text here" + ""
[/floating_text]
</pre>

=== [deprecated_message] ===
Shows a deprecated message in the message area, this feature is only intended to be used to warn about deprecated macros in mainline. The message is not translatable.
* '''message''': the message to show.
* '''level''': {{DevFeature1.13|10}} The deprecation level, a number from 1 to 3.
* '''what''': {{DevFeature1.13|10}} The name of the thing being deprecated. Use this instead of '''message''' if possible; a stock message will be generated from it. Use '''message''' only if more information is required; it will be appended to the stock message. This should not be translatable
* '''version''': {{DevFeature1.13|10}} For deprecation levels 2 and 3, this indicates the version in which the feature could be removed. It does ''not'' indicate the version in which it became deprecated.

The meanings of the deprecation levels are as follows:

# Deprecated, but will only be removed if absolutely necessary. The '''version''' key is ignored.
# It will be removed no earlier than a specified version.
# It will be removed in the next stable version
# It has already been removed, leaving just a stub to inform users of how to update their code.

Note that as of 1.13.11, deprecation messages show only in the log, not in the chat message area. The '''message''' can be translatable, but does not need to be.

=== [wml_message] ===
Outputs a message to Wesnoth's console output. Intended for campaign designers to output silent text to the console, without annoying the player; then, that text might contain information useful for later bug-reporting. The log domain for it is '''wml''', and the '''debug/dbg''' log level is available for use with the '''logger''' attribute. Depending on the current log level ('''error''' by default), which may be changed with the in-game :log command, or the --log-<level>=wml command line switch, the messages are echoed to the in-game chat.
* '''message''': the message to show.
* '''logger''': the Wesnoth engine output logger that should catch the text; this might be 'err' (the errors log level), 'warn'/'wrn' (the warnings log level) or anything else (the information log level). Not all information will be displayed depending on the log level chosen when starting Wesnoth.

Note: As of 1.9.4/1.9.5 (r48805) the following "loggers" should work: If in [wml_message]: err/error, warn/wrn/warning, debug/dbg; using the :log command: Only the long forms error, warning, info and debug (this part gathered by trying rather than source inspecting). The long forms are most likely also the only ones working when starting wesnoth with --log-<level>=wml.
For log level warning or error (as during normal play), only wml_messages with logger error or warning display (for both). With logger info or debug, additionally wml_messages with logger info or debug display (for both).

=== [test_condition] ===

{{DevFeature1.13|2}}

Evaluates the contained conditional tags. If they evaluate to the expected value, it prints out a message to the console explaining which part of the condition caused this result in a way similar to [wml_message]. This can be used if your conditional test is failing and you're not sure why.

* '''result''': Whether you expect the conditions to fail or succeed. If no (the default), a message will be printed if the conditional tags fail. If yes, a message will instead be printed if the conditional tags pass.
* '''logger''': Same as for [wml_message]. Defaults to "warning".

=== [open_help] ===
Opens the in-game help.
* '''topic''': the id of the topic to open

Examples of ids:
* unit_Mage
* unit_Dark Adept
* weaponspecial_charge
* terrain_human_castle

The engine will print the topic ids if run from the command line with the ''--log-debug=help'' option.

=== [show_objectives] ===
refreshes the objectives defined by [objectives] and its [show_if] tags, and displays them. (It is also called whenever the user explicitly asks for the objectives; this matters only if the tag was overridden by a [[LuaWML#register_wml_action|Lua]] script.)
* '''side''': the side to show the objectives. If not set, all sides are used.
* '''[[StandardSideFilter]]''' tags and keys: Tag affects the matching sides instead of just all or the one given by the integer value of the side= key.

=== [chat] ===
Displays a message in the chat area, not visible for observers. Alternative unconditionally visible for everyone: [[LuaWML:Display#wesnoth.message]]. {{DevFeature1.13|9}} can be visible for observers.
* '''speaker''': (default="WML") A string for the name of the sender of the message.
* '''message''': The message that should be displayed.
* '''observable''' (boolean yes|no, default yes): {{DevFeature1.13|9}} Whether the message is displayed for observers.
* '''[[StandardSideFilter]]''' tags and keys as argument; if the same client controls multiple sides that match, then the message will only be displayed once.

=== [zoom] ===

{{DevFeature1.13|8}}

Changes the zoom level of the map.

* '''factor''': The new zoom factor, measured as a multiple of the base zoom.
* '''relative''': If yes, zoom relative to current zoom level. Otherwise, set the absolute zoom level. Default no.

== Useful Macros ==
There are some predefined macros that you find useful for interface actions. You can find a complete list along with a detailed explanation of how they work [http://www.wesnoth.org/macro-reference.xhtml here].
* '''{HIGHLIGHT_UNIT}''' Highlight a unit on the map. Use this to show important units
* '''{HIGHLIGHT_IMAGE}''' Places and highlights an image on the map. Use this to show important items or locations
* '''{SET_IMAGE}''' Places an image on the map which has no other function.
* '''{QUAKE <soundfile>}''' Creates a tremor-like screenshake and plays <soundfile>. For example, '''{QUAKE (rumble.ogg)}'''.
* '''{FLASH_WHITE}''' Flash the screen white momentarily. You can also replace WHITE with RED, BLUE or GREEN for a different colour.

== See Also ==
* [[DirectActionsWML]]
* [[InternalActionsWML]]
* [[EventWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]
[[Category: ActionsWML]]

Template:WML Tags

2024-03-06T04:28:39Z

Shadowm:

{| class="reference-sidebar"
|-
|
[[{{SERVER}}{{localurl:Template:WML Tags|action=edit}} edit]]'''WML Tags'''
|-
|''A:''
[[AbilitiesWML#The .5Babilities.5D tag|abilities]],
[[CreditsWML#.5Babout.5D|about]],
[[AchievementsWML#.5Bachievement.5D|achievement]],
[[AchievementsWML#.5Bachievement_group.5D|achievement_group]],
[[Lua_AI_Legacy_Methods_Howto#Behavior_.28Sticky.29_Candidate_Actions|add_ai_behavior]],
[[AdvancedPreferenceWML|advanced_preference]],
[[UnitTypeWML#advancefrom|advancefrom]],
[[UnitTypeWML#After_max_level_advancement_.28AMLA.29|advancement]],
[[StatisticalScenarioWML#The_.5Bteam.5D_tag|advances]],
[[AbilitiesWML#affect_adjacent|affect_adjacent]],
[[Wesnoth_AI_Framework#The_.5Bai.5D_Tag_.E2.80.94_Top-level_Elements|ai]],
[[StandardSideFilter#allied_with|allied_with]],
[[DirectActionsWML#.5Ballow_end_turn.5D|allow_end_turn]],
[[DirectActionsWML#.5Ballow_extra_recruit.5D|allow_extra_recruit]],
[[DirectActionsWML#.5Ballow_recruit.5D|allow_recruit]],
[[DirectActionsWML#.5Ballow_undo.5D|allow_undo]],
[[ConditionalActionsWML#Meta-Condition_Tags|and]],
[[InterfaceActionsWML#.5Banimate_unit.5D|animate]],
[[InterfaceActionsWML#.5Banimate_unit.5D|animate_unit]],
[[AnimationWML#The .5Banimation.5D tag|animation]],
[[Wesnoth_AI_Framework#The_.5Bai.5D_Tag_.E2.80.94_Aspects|aspect]],
attack ([[ReplayWML#attack|replay]], [[UnitTypeWML#Attacks|weapon]]),
[[AnimationWML#short-attack|attack_anim]],
attacks ([[AbilitiesWML#The_.5Bspecials.5D_tag|special]], [[StatisticalScenarioWML#The_.5Bteam.5D_tag|stats]]),
[[AiWML#avoid|avoid]];
|-
|''B:''
[[UnitTypeWML#base_unit|base_unit]],
[[IntroWML#.5Bbackground_layer.5D|background_layer]],
[[AbilitiesWML#The_.5Bspecials.5D_tag|berserk]],
[[BinaryPathWML|binary_path]],
[[InternalActionsWML#Flow_control_actions|break]],
[[EditorWML#The_.5Bbrush.5D_tag|brush]];
|-
|''C:''
[[CampaignWML#The_.5Bcampaign.5D_tag|campaign]],
[[DirectActionsWML#.5Bcancel_action.5D|cancel_action]],
[[Wesnoth_AI_Framework#The_.5Bcandidate_action.5D_Tag|candidate_action]],
[[DirectActionsWML#.5Bcapture_village.5D|capture_village]],
[[ConditionalActionsWML#.5Bswitch.5D|case]],
[[AbilitiesWML#The_.5Bspecials.5D_tag|chance_to_hit]],
[[InterfaceActionsWML#.5Bchange_theme.5D|change_theme]],
[[InterfaceActionsWML#.5Bchat.5D|chat]],
[[OptionWML#checkbox|checkbox]],
[[OptionWML#choice|choice]],
[[ReplayWML#choose|choose]],
[[PersistenceWML#WML Syntax|clear_global_variable]],
[[InterfaceActionsWML#.5Bclear_menu_item.5D|clear_menu_item]],
[[InternalActionsWML#.5Bclear_variable.5D|clear_variable]],
[[InterfaceActionsWML#.5Bcolor_adjust.5D|color_adjust]],
[[GameConfigWML#Color_Palettes|color_palette]],
[[GameConfigWML#Color_Palettes|color_range]],
command ([[ConditionalActionsWML#.5Bcommand.5D|action]], [[ReplayWML|replay]]),
[[InternalActionsWML#Flow_control_actions|continue]],
[[CreditsWML#.5Bcredits_group.5D|credits_group]],
[[AiWML#The_.5Bgoal.5D_Tag|criteria]];
|-
|''D:''
[[AbilitiesWML#The_.5Bspecials.5D_tag|damage]],
[[AnimationWML#short-death|death]],
[[StatisticalScenarioWML#The_.5Bteam.5D_tag|deaths]],
[[Wesnoth_AI_Framework#The_.5Bai.5D_Tag_.E2.80.94_Aspects|default]],
[[AnimationWML#short-defend|defend]],
[[StatisticalScenarioWML#The_.5Bteam.5D_tag|defends]],
[[UnitsWML#defense|defense]],
[[InterfaceActionsWML#.5Bdelay.5D|delay]],
[[InterfaceActionsWML#.5Bdeprecated_message.5D|deprecated_message]],
[[ReplayWML#attack|destination]],
[[CampaignWML#difficulty|difficulty]],
[[AbilitiesWML#The_.5Bspecials.5D_tag|disable]],
[[DirectActionsWML#.5Bdisallow_end_turn.5D|disallow_end_turn]],
[[DirectActionsWML#.5Bdisallow_extra_recruit.5D|disallow_extra_recruit]],
[[DirectActionsWML#.5Bdisallow_recruit.5D|disallow_recruit]],
[[ConditionalActionsWML#.5Bwhile.5D|do]],
[[DirectActionsWML#.5Bdo_command.5D|do_command]],
[[AbilitiesWML#The_.5Bspecials.5D_tag|drains]],
[[AnimationWML#short-draw_weapon|draw_weapon_anim]];
|-
|''E:''
[[EditorWML#The_.5Beditor_group.5D_tag|editor_group]],
[[EditorWML#The_.5Beditor_music.5D_tag|editor_music]],
[[EditorWML#The_.5Beditor_times.5D_tag|editor_times]],
[[EffectWML|effect]],
else ([[ConditionalActionsWML#.5Bif.5D|action]], [[AnimationWML#Conditional Branches|animation]]), [[ConditionalActionsWML#.5Bif.5D|elseif]],
[[DirectActionsWML#.5Bendlevel.5D|endlevel]],
end_turn ([[DirectActionsWML#.5Bend_turn.5D|action]], [[ReplayWML#end_turn|replay]]),
[[StandardSideFilter#enemy_of|enemy_of]],
[[Wesnoth_AI_Framework#The_.5Bai.5D_Tag_.E2.80.94_Engines|engine]],
entry ([[CreditsWML#.5Bentry.5D|credits]], [[OptionWML#entry|options]]),
[[EraWML|era]],
[[EventWML|event]],
[[StandardUnitFilter#filter_ability|experimental_filter_ability]],
[[StandardUnitFilter#filter_ability_active|experimental_filter_ability_active]],
[[AbilitiesWML#filter_specials|experimental_filter_specials]],
[[AnimationWML#short-extra|extra_anim]];
|-
|''F:''
[[Wesnoth_AI_Framework#The_.5Bai.5D_Tag_.E2.80.94_Aspects|facet]],
[[InterfaceActionsWML#.5Banimate_unit.5D|facing]],
[[InterfaceActionsWML#.5Bmove_units_fake.5D|fake_unit]],
[[ConditionalActionsWML#.5Bfalse.5D|false]],
[[PblWML#.5Bfeedback.5D|feedback]],
[[UnitTypeWML#variation|female]],
filter ([[FilterWML|concept]], [[EventWML#.5Bfilter.5D|event]]),
[[StandardUnitFilter#filter_adjacent|filter_adjacent]],
[[StandardLocationFilter#filter_adjacent_location|filter_adjacent_location]],
[[FilterWML#Filtering_Weapons|filter_attack]],
[[AbilitiesWML#filter_attacker|filter_attacker]],
[[AbilitiesWML#filter_base_value|filter_base_value]],
[[EventWML#.5Bfilter_condition.5D|filter_condition]],
[[AbilitiesWML#filter_defender|filter_defender]],
[[AiWML#Filtering_Combat_with_the_attacks_Aspect|filter_enemy]],
[[StandardLocationFilter|filter_location]],
[[AbilitiesWML#filter_opponent|filter_opponent]],
[[AiWML#Filtering_Combat_with_the_attacks_Aspect|filter_own]],
[[StandardLocationFilter#filter_owner|filter_owner]],
[[StandardLocationFilter#filter_radius|filter_radius]],
[[SingleUnitWML#filter_recall|filter_recall]],
[[StandardUnitFilter|filter_second]],
[[FilterWML#Filtering_Weapons|filter_second_attack]],
[[AbilitiesWML#filter_self|filter_self]],
[[StandardSideFilter|filter_side]],
[[AbilitiesWML#filter_student|filter_student]],
[[FilterWML#Filtering_Vision|filter_vision]],
[[FilterWML#Filtering_Weapons|filter_weapon]],
[[FilterWML#Filtering_on_WML_data|filter_wml]],
[[InternalActionsWML#.5Bfind_path.5D|find_path]],
[[InternalActionsWML#.5Bfire_event.5D|fire_event]],
[[AbilitiesWML#The_.5Bspecials.5D_tag|firststrike]],
[[InterfaceActionsWML#.5Bfloating_text.5D|floating_text]],
[[ConditionalActionsWML#.5Bfound_item.5D|found_item]],
[[ConditionalActionsWML#.5Bfor.5D|for]],
[[ConditionalActionsWML#.5Bforeach.5D|foreach]],
[[AnimationWML#The .5Bframe.5D tag|frame]];
|-
|''G:''
[[GameConfigWML|game_config]],
[[PersistenceWML#WML Syntax|get_global_variable]],
[[AiWML#The_.5Bgoal.5D_Tag|goal]],
[[DirectActionsWML#.5Bgold.5D|gold]],
[[InterfaceActionsWML#objectives-gold_carryover|gold_carryover]];
|-
|''H:''
[[DirectActionsWML#.5Bharm_unit.5D|harm_unit]],
[[StandardSideFilter#has_ally|has_ally]],
[[StandardUnitFilter#has_attack|has_attack]],
[[StandardSideFilter#has_unit|has_unit]],
[[ConditionalActionsWML#.5Bhas_achievement.5D|has_achievement]],
[[ConditionalActionsWML#.5Bhave_location.5D|have_location]],
[[ConditionalActionsWML#.5Bhave_unit.5D|have_unit]],
[[AbilitiesWML#The_.5Bspecials.5D_tag|heal_on_hit]],
[[DirectActionsWML#.5Bheal_unit.5D|heal_unit]],
[[AnimationWML#short-healed|healed_anim]],
[[AnimationWML#short-healing|healing_anim]],
[[AbilitiesWML#The_.5Babilities.5D_tag|heals]],
[[UnitsWML#.5Bhide_help.5D|hide_help]],
[[InterfaceActionsWML#.5Bhide_unit.5D|hide_unit]],
[[AbilitiesWML#The_.5Babilities.5D_tag|hides]];
|-
|''I:''
[[AnimationWML#short-idle|idle_anim]],
if ([[ConditionalActionsWML#.5Bif.5D|action]], [[AnimationWML#Conditional Branches|animation]], [[IntroWML|intro]]),
[[AbilitiesWML#The_.5Babilities.5D_tag|illuminates]],
image ([[IntroWML#.5Bimage.5D|intro]], [[TerrainGraphicsWML#The_.5Bimage.5D_subtag|terrain]]),
[[ReplayWML#init_side|init_side]],
[[VariablesWML#.5Binsert_tag.5D|insert_tag]],
[[InterfaceActionsWML#.5Binspect.5D|inspect]],
[[InterfaceActionsWML#.5Bitem.5D|item]],
[[EditorWML#The_.5Bitem_group.5D_tag|item_group]];
|-
|''J:''
[[UnitsWML#jamming_costs|jamming_costs]],
[[InternalActionsWML#join|join]];
|-
|''K:''
[[DirectActionsWML#.5Bkill.5D|kill]],
[[StatisticalScenarioWML#The_.5Bteam.5D_tag|killed]];
|-
|''L:''
[[InterfaceActionsWML#.5Blabel.5D|label]],
[[LanguageWML|language]],
[[SideWML#leader|leader]],
[[AiWML#leader_goal|leader_goal]],
[[AbilitiesWML#The_.5Babilities.5D_tag|leadership]],
[[AnimationWML#short-leading|leading_anim]],
[[AnimationWML#short-levelin|levelin_anim]],
[[AnimationWML#short-levelout|levelout_anim]],
[[DirectActionsWML#.5Blift_fog.5D|lift_fog]],
[[AI_Recruitment#instructions-limit|limit]],
[[InternalActionsWML#set_variables-literal|literal]],
[[AddonsWML#load_resource|load_resource]],
[[LocaleWML|locale]],
[[InterfaceActionsWML#.5Block_view.5D|lock_view]],
[[LuaWML|lua]];
|-
|''M:''
[[UnitTypeWML#variation|male]],
[[SavefileWML|menu_item]],
[[InterfaceActionsWML#.5Bmessage.5D|message]],
[[Micro AIs|micro_ai]],
[[AnimationWML#The .5Bframe.5D tag|missile_frame]],
[[ModificationWML|modification]],
[[SingleUnitWML#modifications|modifications]],
[[DirectActionsWML#.5Bmodify_ai.5D|modify_ai]],
[[DirectActionsWML#.5Bmodify_side.5D|modify_side]],
[[DirectActionsWML#.5Bmodify_turns.5D|modify_turns]],
[[DirectActionsWML#.5Bmodify_unit.5D|modify_unit]],
[[AddonsWML#modify_unit_type|modify_unit_type]],
[[ReplayWML#move|move]],
[[DirectActionsWML#.5Bmove_unit.5D|move_unit]],
[[InterfaceActionsWML#.5Bmove_unit_fake.5D|move_unit_fake]],
[[InterfaceActionsWML#.5Bmove_units_fake.5D|move_units_fake]],
[[AnimationWML#short-movement|movement_anim]],
[[UnitsWML#movement_costs|movement costs]],
[[UnitsWML#.5Bmovetype.5D|movetype]],
[[ScenarioWML#The_.5Bmultiplayer.5D_tag|multiplayer]],
[[EraWML#Defining_Factions|multiplayer_side]],
[[MusicListWML#.5Bmusic.5D|music]];
|-
|''N:''
[[ConditionalActionsWML#Meta-Condition_Tags|not]],
[[InterfaceActionsWML#objectives-note|note]];
|-
|''O:''
[[DirectActionsWML#.5Bobject.5D|object]],
[[InterfaceActionsWML#objectives-objective|objective]],
[[InterfaceActionsWML#.5Bobjectives.5D|objectives]],
[[DirectActionsWML#.5Bon_undo.5D|on_undo]],
[[InterfaceActionsWML#.5Bopen_help.5D|open_help]],
[[InterfaceActionsWML#.5Bmessage.5D|option]],
[[OptionWML|options]],
[[ConditionalActionsWML#Meta-Condition_Tags|or]];
|-
|''P:''
[[IntroWML#.5Bpart.5D|part]],
[[AbilitiesWML#The_.5Bspecials.5D_tag|petrifies]],
[[DirectActionsWML#.5Bpetrify.5D|petrify]],
[[DirectActionsWML#.5Bplace_shroud.5D|place_shroud]],
[[AbilitiesWML#The_.5Bspecials.5D_tag|plague]],
[[AbilitiesWML#The_.5Bspecials.5D_tag|poison]],
[[AnimationWML#short-post_movement|post_movement_anim]],
[[AnimationWML#short-pre_movement|pre_movement_anim]],
[[InternalActionsWML#.5Bfire_event.5D|primary_attack]],
[[InternalActionsWML#.5Bfire_event.5D|primary_unit]],
[[InterfaceActionsWML#.5Bprint.5D|print]],
[[DirectActionsWML#.5Bprogress_achievement.5D|progress_achievement]],
[[DirectActionsWML#.5Bput_to_recall_list.5D|put_to_recall_list]];
|-
|''R:''
[[UnitsWML#.5Brace.5D|race]],
[[InternalActionsWML#.5Brandom_placement.5D|random_placement]],
recall ([[DirectActionsWML#.5Brecall.5D|action]], [[ReplayWML#recall|replay]]),
[[StatisticalScenarioWML#The_.5Bteam.5D_tag|recalls]],
[[ReplayWML#recruit|recruit]],
[[AnimationWML#short-recruit|recruit_anim]],
[[AnimationWML#short-recruiting|recruiting_anim]],
[[StatisticalScenarioWML#The_.5Bteam.5D_tag|recruits]],
[[InterfaceActionsWML#.5Bredraw.5D|redraw]],
[[AbilitiesWML#The_.5Babilities.5D_tag|regenerate]],
[[InternalActionsWML#.5Bremove_event.5D|remove_event]],
[[InterfaceActionsWML#.5Bremove_item.5D|remove_item]],
[[DirectActionsWML#.5Bremove_object.5D|remove_object]],
[[DirectActionsWML#.5Bremove_shroud.5D|remove_shroud]],
[[InterfaceActionsWML#.5Bremove_sound_source.5D|remove_sound_source]],
[[DirectActionsWML#.5Bremove_time_area.5D|remove_time_area]],
[[DirectActionsWML#.5Bremove_trait.5D|remove_trait]],
[[InterfaceActionsWML#.5Bremove_unit_overlay.5D|remove_unit_overlay]],
[[ConditionalActionsWML#.5Brepeat.5D|repeat]],
[[DirectActionsWML#.5Breplace_map.5D|replace_map]],
[[DirectActionsWML#.5Breplace_schedule.5D|replace_schedule]],
[[ReplayWML|replay]],
[[SavefileWML|replay_start]],
[[DirectActionsWML#.5Breset_fog.5D|reset_fog]],
resistance ([[AbilitiesWML#The_.5Babilities.5D_tag|ability]], [[UnitsWML#resistance|unit]]),
[[UnitsWML#.5Bresistance_defaults.5D|resistance_defaults]],
[[ModificationWML#The_.5Bresource.5D_toplevel_tag|resource]],
[[InternalActionsWML#Flow_control_actions|return]],
[[InternalActionsWML#.5Brole.5D|role]],
[[TerrainMaskWML#rule|rule]];
|-
|''S:''
[[SavefileWML|save]],
[[ScenarioWML#The_.5Bscenario.5D_tag|scenario]],
[[InterfaceActionsWML#.5Bscreen_fade.5D|screen_fade]],
[[InterfaceActionsWML#.5Bscroll.5D|scroll]],
[[InterfaceActionsWML#.5Bscroll_to.5D|scroll_to]],
[[InterfaceActionsWML#.5Bscroll_to_unit.5D|scroll_to_unit]],
[[InternalActionsWML#.5Bfire_event.5D|secondary_attack]],
[[InternalActionsWML#.5Bfire_event.5D|secondary_unit]],
[[HelpWML#section|section]],
[[InterfaceActionsWML#.5Bselect_unit.5D|select_unit]],
[[ReplayWML#sequence|sequence]],
[[DirectActionsWML#.5Bset_achievement.5D|set_achievement]],
[[DirectActionsWML#.5Bset_extra_recruit.5D|set_extra_recruit]],
[[PersistenceWML#WML_Syntax|set_global_variable]],
[[InterfaceActionsWML#.5Bset_menu_item.5D|set_menu_item]],
[[DirectActionsWML#.5Bset_recruit.5D|set_recruit]],
[[EffectWML#set_specials|set_specials]],
[[InternalActionsWML#.5Bset_variable.5D|set_variable]],
[[InternalActionsWML#.5Bset_variables.5D|set_variables]],
[[AnimationWML#short-sheath_weapon|sheath_weapon_anim]],
show_if ([[InterfaceActionsWML#.5Bmessage.5D|message]],
[[InterfaceActionsWML#.5Bobjectives.5D|objective]],
[[InterfaceActionsWML#.5Bset_menu_item.5D|set_menu_item]]),
[[InterfaceActionsWML#.5Bshow_objectives.5D|show_objectives]],
[[SideWML|side]],
[[AbilitiesWML#The_.5Babilities.5D_tag|skirmisher]],
[[OptionWML#slider|slider]],
[[AbilitiesWML#The_.5Bspecials.5D_tag|slow]],
[[SavefileWML|snapshot]],
[[InterfaceActionsWML#.5Bsound.5D|sound]],
[[InterfaceActionsWML#.5Bsound_source.5D|sound_source]],
source ([[ReplayWML#attack|replay]], [[DirectActionsWML#.5Btunnel.5D|teleport]]),
[[UnitTypeWML#Special Notes|special_note]],
[[AbilitiesWML#The_.5Bspecials.5D_tag|specials]],
[[InternalActionsWML#set_variables-split|split]],
[[Wesnoth_AI_Framework#The_.5Bai.5D_Tag_.E2.80.94_Stages|stage]],
[[AnimationWML#short-standing|standing_anim]],
[[StatisticalScenarioWML#The_.5Bstatistics.5D_tag|statistics]],
[[SingleUnitWML#status|status]],
[[InternalActionsWML#.5Bstore_gold.5D|store_gold]],
[[InternalActionsWML#.5Bstore_items.5D|store_items]],
[[InternalActionsWML#.5Bstore_locations.5D|store_locations]],
[[InternalActionsWML#.5Bstore_map_dimensions.5D|store_map_dimensions]],
[[InternalActionsWML#.5Bstore_reachable_locations.5D|store_reachable_locations]],
[[InternalActionsWML#.5Bstore_relative_direction.5D|store_relative_direction]],
[[InternalActionsWML#.5Bstore_side.5D|store_side]],
[[InternalActionsWML#.5Bstore_starting_location.5D|store_starting_location]],
[[InternalActionsWML#.5Bstore_time_of_day.5D|store_time_of_day]],
[[InternalActionsWML#.5Bstore_turns.5D|store_turns]],
[[InternalActionsWML#.5Bstore_unit.5D|store_unit]],
[[InternalActionsWML#.5Bstore_unit_defense.5D|store_unit_defense]],
[[InternalActionsWML#.5Bstore_unit_defense_on.5D|store_unit_defense_on]],
[[InternalActionsWML#.5Bstore_unit_type.5D|store_unit_type]],
[[InternalActionsWML#.5Bstore_unit_type_ids.5D|store_unit_type_ids]],
[[InternalActionsWML#.5Bstore_villages.5D|store_villages]],
[[IntroWML|story]],
[[AbilitiesWML#The_.5Bspecials.5D_tag|swarm]],
[[AchievementsWML#.5Bsub_achievement.5D|sub_achievement]],
[[ConditionalActionsWML#.5Bswitch.5D|switch]],
[[InternalActionsWML#.5Bsync_variable.5D|sync_variable]];
|-
|''T:''
[[DirectActionsWML#.5Btunnel.5D|target]],
[[StatisticalScenarioWML#The_.5Bteam.5D_tag|team]],
teleport ([[AbilitiesWML|ability]], [[DirectActionsWML#.5Bteleport.5D|action]]),
[[AnimationWML#short-teleport|teleport_anim]],
[[DirectActionsWML#.5Bterrain.5D|terrain]],
[[UnitsWML#.5Bterrain_defaults.5D|terrain_defaults]],
[[TerrainGraphicsWML|terrain_graphics]],
[[TerrainMaskWML|terrain_mask]],
[[TerrainWML|terrain_type]],
[[ScenarioWML#The_.5Btest.5D_tag|test]],
[[InterfaceActionsWML#.5Btest_condition.5D|test_condition]],
[[TestWML#The_.5Btest_do_attack_by_id.5D_tag|test_do_attack_by_id]],
[[InterfaceActionsWML#.5Bmessage.5D|text_input]],
[[GettextForWesnothDevelopers#The_textdomain_tag|textdomain]],
[[ThemeWML|theme]],
[[ConditionalActionsWML#.5Bif.5D|then]],
[[TerrainGraphicsWML|tile]],
[[TimeWML|time]],
[[DirectActionsWML#.5Btime_area.5D|time_area]],
[[HelpWML|topic]],
[[HelpWML|toplevel]],
[[UnitsWML#.5Btrait.5D|trait]],
[[DirectActionsWML#.5Btransform_unit.5D|transform_unit]],
[[InternalActionsWML#.5Bfind_path.5D|traveler]],
[[ConditionalActionsWML#.5Btrue.5D|true]],
[[DirectActionsWML#.5Btunnel.5D|tunnel]];
|-
|''U:''
[[InterfaceActionsWML#.5Bunhide_unit.5D|unhide_unit]],
[[SingleUnitWML|unit]],
[[InterfaceActionsWML#.5Bunit_overlay.5D|unit_overlay]],
[[UnitTypeWML|unit_type]],
[[InternalActionsWML#.5Bunit_worth.5D|unit_worth]],
[[UnitsWML|units]],
[[InterfaceActionsWML#.5Bunlock_view.5D|unlock_view]],
[[DirectActionsWML#.5Bunpetrify.5D|unpetrify]],
[[DirectActionsWML#.5Bunstore_unit.5D|unstore_unit]],
[[InternalActionsWML#.5Bunsynced.5D|unsynced]];
|-
| ''V:''
[[InternalActionsWML#.5Bset_variables.5D|value]],
[[ConditionalActionsWML#.5Bvariable.5D|variable]],
[[VariablesWML#The_.5Bvariables.5D_tag|variables]],
[[TerrainGraphicsWML|variant]],
[[UnitTypeWML#Other_tags|variation]],
[[AnimationWML#short-victory|victory_anim]],
[[SideWML|village]],
[[UnitsWML#.5Bmovetype.5D|vision_costs]],
[[InterfaceActionsWML#.5Bvolume.5D|volume]];
|-
| ''W:''
[[ConditionalActionsWML#.5Bwhile.5D|while]],
[[InterfaceActionsWML#.5Bwml_message.5D|wml_message]],
[[SchemaWML|wml_schema]];
|-
| ''Z:''
[[InterfaceActionsWML#.5Bzoom.5D|zoom]];
|}<includeonly>[[Category:WML Reference]]</includeonly><noinclude>A box with all the WML tags, each one linking to the page and section they are described in. This box should be included in each of the WML reference pages.</noinclude>

IntroWML

2024-03-06T04:28:03Z

Shadowm: /* [part] */

{{WML Tags}}

The '''[story]''' tag is a series of images and text to display as the first part of the intro screen. It can appear in [[ScenarioWML]] or {{DevFeature1.13|8}} as [[InterfaceActionsWML#.5Bstory.5D|ActionWML]].

The '''[deprecated_message]''', '''[wml_message]''', '''[image]''', and '''[insert_tag]''' tags are allowed beneath '''[story]'''. Most other WML tags will not be recognized in this context. Note, however, that messages produced by the first two tags will not appear in the game interface until the actual game map appears.

The only other tags currently recognized within '''[story]''' and '''[part]''' are '''[if]'''/'''[then]'''/'''[else]''' ({{DevFeature1.13|0}}: also '''[elseif]''') and '''[switch]'''/'''[case]'''. These can be used to show parts conditionally on the values of variables.

See also the journey and battle macros, in the [https://www.wesnoth.org/macro-reference.html#file:image-utils.cfg Macro Reference]

== [part] ==

Each '''[part]''' tag represents one "page" of a story sequence, with its own text and images. The player advances through parts by clicking on the '''Next'''/'''→''' button to advance one part, the '''Back'''/'''←''' button to go back one part, and the '''Skip''' button to leave the story sequence and start/return to the game.

The following keys/tags are recognized for '''[part]'''.

=== Main text keys ===

* '''story''': (translatable) the text to display below the image.
* '''text_alignment''': specifies the alignment of the story text. It must be one of ''left'' (default), ''center'' or ''right''.
* '''text_layout''': specifies the vertical portion of the screen where the story text will be displayed. It must be one of ''top'', ''middle'' or ''bottom'' (default).

=== Title text keys ===

* '''show_title''': whether to display the title of the scenario at the top
* '''title''': specifies a custom title to display instead of the name of the scenario. If specified, it implies '''show_title=yes'''. If parent the '''[story]''' is used through [[InterfaceActionsWML#.5Bstory.5D|ActionWML]] with '''show_title=yes''', the '''title''' key must be explicitly specified as it does not default to the scenario title and leads to a missing title error if omitted.
* '''title_alignment''': specifies the alignment of the title box. It must be one of ''left'' (default), ''center'' or ''right''.

=== Image and sound keys ===

* '''background''': the image to display. Story images are usually created specially for this purpose, except for the map.
* '''scale_background''': Whether to scale the background, default yes.
* '''music''': change to this music
* '''sound''': a list of sound files; the engine will choose one at random and play it once while displaying the story part.
* '''voice''': a list of sound files; the engine will choose one at random and play it on a sound channel intended for voice overs once while displaying the story part.

=== [background_layer] ===

A layer of the background of the story screen.

* '''image''': path to the image file.
* '''scale_vertically''': whether the image should be scaled to fill the screen in the vertical dimension. Default yes.
* '''scale_horizontally''': whether the image should be scaled to fill the screen in the horizontal dimension. Default yes.
* '''scale''': a shortcut to set scale_vertically and scale_horizontally at once. If specified, the values of the former two keys will be ignored.
* '''keep_aspect_ratio''': whether the aspect ratio of the image should be preserved while scaling. Default yes.
* '''tile_vertically''': whether the image should be tiled in the vertical direction. Tiling happens after aligning the image to the center of the screen. Default no.
* '''tile_horizontally''': whether the image should be tiled in the horizontal direction. Tiling happens after aligning the image to the center of the screen. Default no.
* '''tile''': a shortcut to set tile_vertically and tile_horizontally at once. If specified, the values of the former two keys will be ignored.
* '''base_layer''': whether is this the layer to align the overlay images to. Default no.

=== [image] ===

An image to display.

* '''x''', '''y''': the location to draw the image, using the pixels of the '''base_layer''' background image as the coordinate system.
* '''centered''': If "yes", use the center of the image as the anchor point when placing at the x,y coordinates, if "no" then use the top-left corner.
* '''file''': the image to display.
* '''delay''': the time to delay drawing this image.
* '''resize_with_background''': {{DevFeature1.15|7}} if "yes", apply the same scaling as applied to the '''base_layer'''

Each image is placed using the pixels of the background_layer as the coordinate system; each image's location moves to compensate when the background image is scaled. Example: my background image is a map with a city at pixel 160,100; I put a battle marker on that city using '''x,y,centered=160,100,yes'''. When a user plays the game they will see the map enlarged to fill the window (regardless of its size), and the battle marker will still be on top of the city.

== See Also ==

* [[ReferenceWML]]

[[Category: WML Reference]]

IntroWML

2024-03-06T04:24:03Z

Shadowm: Various documentation changes to reflect 1.16 and 1.18 WML better, including fixing misinformation regarding text_alignment and text_layout that was never true (my bad)

{{WML Tags}}

The '''[story]''' tag is a series of images and text to display as the first part of the intro screen. It can appear in [[ScenarioWML]] or {{DevFeature1.13|8}} as [[InterfaceActionsWML#.5Bstory.5D|ActionWML]].

The '''[deprecated_message]''', '''[wml_message]''', '''[image]''', and '''[insert_tag]''' tags are allowed beneath '''[story]'''. Most other WML tags will not be recognized in this context. Note, however, that messages produced by the first two tags will not appear in the game interface until the actual game map appears.

The only other tags currently recognized within '''[story]''' and '''[part]''' are '''[if]'''/'''[then]'''/'''[else]''' ({{DevFeature1.13|0}}: also '''[elseif]''') and '''[switch]'''/'''[case]'''. These can be used to show parts conditionally on the values of variables.

See also the journey and battle macros, in the [https://www.wesnoth.org/macro-reference.html#file:image-utils.cfg Macro Reference]

== [part] ==

'''[part]''' is a special tag recognized only beneath '''[story]'''. Each '''[part]''' represents one image and text.
The part is displayed until the user clicks on the "Next>>>" button.

The following key/tags are recognized for '''[part]''':

=== Main text options ===

* '''story''': (translatable) the text to display below the image.
* '''text_alignment''': specifies the alignment of the story text. It must be one of ''left'' (default), ''center'' or ''right''.
* '''text_layout''': specifies the vertical portion of the screen where the story text will be displayed. It must be one of ''top'', ''middle'' or ''bottom'' (default).

=== Title text options ===

* '''show_title''': whether to display the title of the scenario at the top
* '''title''': specifies a custom title to display instead of the name of the scenario. If specified, it implies '''show_title=yes'''. If parent the '''[story]''' is used through [[InterfaceActionsWML#.5Bstory.5D|ActionWML]] with '''show_title=yes''', the '''title''' key must be explicitly specified as it does not default to the scenario title and leads to a missing title error if omitted.
* '''title_alignment''': specifies the alignment of the title box. It must be one of ''left'' (default), ''center'' or ''right''.

=== Image and sound options ===

* '''background''': the image to display. Story images are usually created specially for this purpose, except for the map.
* '''scale_background''': Whether to scale the background, default yes.
* '''music''': change to this music
* '''sound''': a list of sound files; the engine will choose one at random and play it once while displaying the story part.
* '''voice''': a list of sound files; the engine will choose one at random and play it on a sound channel intended for voice overs once while displaying the story part.

=== [background_layer] ===

A layer of the background of the story screen.

* '''image''': path to the image file.
* '''scale_vertically''': whether the image should be scaled to fill the screen in the vertical dimension. Default yes.
* '''scale_horizontally''': whether the image should be scaled to fill the screen in the horizontal dimension. Default yes.
* '''scale''': a shortcut to set scale_vertically and scale_horizontally at once. If specified, the values of the former two keys will be ignored.
* '''keep_aspect_ratio''': whether the aspect ratio of the image should be preserved while scaling. Default yes.
* '''tile_vertically''': whether the image should be tiled in the vertical direction. Tiling happens after aligning the image to the center of the screen. Default no.
* '''tile_horizontally''': whether the image should be tiled in the horizontal direction. Tiling happens after aligning the image to the center of the screen. Default no.
* '''tile''': a shortcut to set tile_vertically and tile_horizontally at once. If specified, the values of the former two keys will be ignored.
* '''base_layer''': whether is this the layer to align the overlay images to. Default no.

=== [image] ===

An image to display.

* '''x''', '''y''': the location to draw the image, using the pixels of the '''base_layer''' background image as the coordinate system.
* '''centered''': If "yes", use the center of the image as the anchor point when placing at the x,y coordinates, if "no" then use the top-left corner.
* '''file''': the image to display.
* '''delay''': the time to delay drawing this image.
* '''resize_with_background''': {{DevFeature1.15|7}} if "yes", apply the same scaling as applied to the '''base_layer'''

Each image is placed using the pixels of the background_layer as the coordinate system; each image's location moves to compensate when the background image is scaled. Example: my background image is a map with a city at pixel 160,100; I put a battle marker on that city using '''x,y,centered=160,100,yes'''. When a user plays the game they will see the map enlarged to fill the window (regardless of its size), and the battle marker will still be on top of the city.

== See Also ==

* [[ReferenceWML]]

[[Category: WML Reference]]

Credits

2021-10-25T19:40:35Z

Shadowm: Update translation credits

<div class="tright"> __TOC__ </div>
__NOEDITSECTION__
In July 2003, '''David White''' released the first version of Wesnoth. Since
then, many people have joined the project, contributing in very different ways.

To make any changes to this list, please modify
<code class="noframe">about.cfg</code> in the repo or ask any developer to do
it for you.

== Core Contributors ==
=== Programming ===
* [mailto:dave@whitevine.net David White] (Sirp) — Founding Developer
<hr style='clear:none'>
* [mailto:AI0867@gmail.com Alexander van Gessel] (AI/AI0867)
* Alfredo Beaumont (ziberpunk) — autotools
* Ali El Gariani ([[User:Alink|alink]]) — coder, bug fixes, optimizations, interface usability
* András Salamon ([[User:Ott|ott]]) — QA, bug fixing, subediting, game mechanics
* Andreas Löf (Aginor)
* Anonymissimus — bug fixes and features mostly related to the wml engine or lua interface
* [mailto:artemkhrapov2001ATyandexDOTru Artem Khrapov] ([[User:Kabachuha|kabachuha]]) — addons server rework, incremental updates and uploads feature; i18n, UI and quality of life improvements; bugfixes
* [mailto:dragonking@o2.pl Bartek Waresiak] (Dragonking) — unit balancing, Formula AI
* Benoît Timbert ([[User:Noyga|Noyga]])
* Bram Ridder (Morloth) — editor improvements
* [mailto:bruno@wolff.to Bruno Wolff III] ([[User:bruno|bruno]]) — campaign web interface, bug fixing, minor coder
* Cameron Morland
* Cédric Duval — coder, internationalization manager
* Charles Dang (vultraz) — General fixes, cleanup and improvements to various areas.
* Chris Beck (iceiceice/involution) — Bug fixes and features esp. engine-related or multiplayer-related. Added WML unit testing system, improvements to travis-CI.
* Celtic Minstrel
* Daniel Franke (dfranke)
* Daniel (gfgtdf)
* David Hilton
* Dominic Bolin (Xan)
* Elias Pschernig (allefant)
* Elvish_Hunter
* Eric S. Raymond (ESR) — Macro library reorganization, major UI makeover introducing lightweight transparent popups and linger mode, maintenance tools for WML, eight campaigns lifted from UMC, one all-original campaign, editor refactoring, many many code cleanups, and svn-to-git migration.
* Eugen Jiresch (euschn) — savegame improvements
* [mailto:fabianmueller5_at_gmx.de Fabian Müller] ([[User:fabi|fabi/fendrin]])
* [mailto:gabrielmorin~_-AT-_~gmail.com Gabriel Morin] (gabba) — Whiteboard project, naming hotseat players, delay shroud updates on game start.
* Greg Copeland (Oracle) — coding; Server optimizations.
* Gregory Lundberg (TadCarlucci) — Cleanup of campaigns code
* [mailto:cornmander@cornmander.com Gregory Shikhman] (corn) — coding; upload log maintenance/improvements
* Guillaume Melquiond (silene) — coding, bug fixes
* [mailto:billybiset@gmail.com Guillermo Biset] (billynux) — Bug fixer, remover of upload stats, network module rewrite, ANA, boost::asio
* [mailto:shadowm2006@gmail.com Iris Morelle] ([[User:Shadowm|Irydacea/shadowm]]) — Miscellaneous WML, i18n and UI features, improvements and bugfixes; refactoring and extension of add-ons management code; features and refactoring of image-path functions mechanism; cache manager UI and paths/game version dialog; campaignd refactoring and maintenance
* Jérémy Rosen ([[User:Boucman|Boucman]]) — coder
* [mailto:mcnabb@gravity.psu.edu John W. C. McNabb] (Darth Fool) — coder, graphics
* Jon Daniel (worduk) — coder, bug fixes
* Jörg Hinrichs (Yogi Bear/YogiHH)
* [mailto:justin.zaun@gmail.com Justin Zaun] (jzaun) — coder, scenario designer
* Jyrki Vesterinen
* Karol Nowak (grzywacz) — bug fixes, sound sources, gp2x port
* [mailto:erl@erl.se Kristoffer Erlandsson] (erl) — help system, editor
* [mailto:lao.geek@gmail.com Lao] ([[User:lao|lao]]) — bug fixes and candidate to GSoC 2008
* Mark de Wever ([[User:SkeletonCrew|Mordante/SkeletonCrew]]) — coder, bug fixes, various features, multi-letter terrain system, gui system.
* Martin Renold (maxy/martinxyz) — performance and gui bug fixes
* Matthias Kretz — optimizations
* Moritz Göbelbecker (mog) — Work on the terrain engine
* Nicolas Weeger (Ryo) — Python API
* [mailto:patrick_x99@hotmail.com Patrick Parker] ([[User:Sapient|Sapient]]) — improvements to user interface, WML engine, various features
* [mailto:paniemin@cc.hut.fi Pauli Nieminen] (suokko) — Bug fixing; usually targeting MP or WML engine
* [mailto:philippe.plantier@naema.org Philippe Plantier] ([[User:Ayin|Ayin]]) — several parts of the code, notably terrain graphics code
* Rusty Russell (rusty)
* Sergey Popov (loonycyborg) — scons
* singalen — iOS port
* Soliton — bug fixes and various small features usually in multiplayer context
* Steve Cotton (octalot)
* Steven Oxley (xonev)
* Thomas Baumhauer (Baufo)
* [mailto:timotei21@gmail.com Timotei Dolean] (timotei) — Eclipse UMC plugin
* Tomasz Śniatowski (ilor) — Editor
* [mailto:ydirson@altern.org Yann Dirson] — gettext support, tinygui
* [mailto:terraninfo@terraninfo.net Yurii Chernyi] (Crab) — AI
=== General Purpose Administration and Coordination ===
* Charles Dang (vultraz) — Current release manager (1.13.3-present)
<hr style='clear:none'>
* Crossbow/Miyo — Past release manager
* [mailto:shadowm2006@gmail.com Iris Morelle] ([[User:Shadowm|Irydacea/shadowm]]) — Past release manager (1.12.1-1.12.6 / 1.13.0-1.13.2)
* [mailto:isaac@sindominio.net Isaac Clerencia] — Past release manager, Debian packager
* [mailto:Crazy-Ivanovic@gmx.net Nils Kneuper] (Ivanovic) — Past release manager, internationalization manager, OpenPandora packager, A Tale of Two Brothers, German translation
* Noy — General purpose administration, unit balancing
* Pentarctagon
=== Internationalization Managers ===
* Cédric Duval — coder, internationalization manager
* David Philippi (Torangan) — internationalization manager, wescamp
* Mark Michelsen (skovbaer) — Slackware packager
* [mailto:Crazy-Ivanovic@gmx.net Nils Kneuper] (Ivanovic) — administrator, release manager, internationalization manager, OpenPandora packager, A Tale of Two Brothers, german translation
* [mailto:susanna.bjorverud@telia.com Susanna Björverud] (sanna)
=== Trailers ===
* ancestral — 1.12 trailer
* Pedro Caseiro (Kasdel) — 1.14 trailer
* Felix Merveille (felixmerveille) — 1.16 trailer edits and additions
=== Artwork and Graphics ===
* Emilien Rotival (LordBob) — portrait director - focus on loyalists, trolls, monsters
* Francisco Muñoz (fmunoz) — founding artist and former lead artist, worked consistently on all aspects till around v0.7-0.9.
* Hogne Håskjold (frame/freim) — terrain art director, made much of the current terrains (esp. mountains)
* J.W. Bjerk ([[User:Eleazar|Eleazar]]) — terrain art director (esp. Chasm, Cave, Water), sprite animations, various visual tweaks
* James Woo (Pickslide) — portraits (major focus on orcs and campaigns, especially UtBS, TEI, TSoF)
* Kathrin Polikeit (Kitty) — portrait director - focus on mages/necromancers, elvish, naga, merfolk, and troll unit trees
* Lari Nieminen (zookeeper) — sprite animation, various visual tweaks, titlescreen and campaign maps (v1.11+), water animations (v1.13+)
* Neoriceisgood — sprite creator and animator (major focus on drakes, dwarves, saurians)
* Pekka Aikio (pekka) — tiles, esp. castles, and attack icons
* Phil Barber (thespaceinvader) — Dwarf and Saurian portraits, most of the drake animations, and a large amount on other stuff, esp. the dwarves.
* Richard Kettering ([[User:Jetryl|Jetrel]]) — art director/slave, major focus on sprites, portraits, buildings, and icons
* Timo Honkasalo (Sgt. Groovy) — New high-res logo for the game
<hr style='clear:none'>
* Alex Jarocha-Ernst (Jormungandr) — portraits
* Christophe Anjard (Christophe33) — made many of the old (c. v0.6) terrains, and some sprites for the dwarves
* Erkki Lonkainen (Eternal) — created and animated many replacement sprites (esp. ogre, orc assassin & spear units, and cockatrice)
* Jason Lutes — portraits (major focus on humans, some campaign portraits)
* Johann de Venecia (Johann) — drew the new campaign story art for HttT
* Leonhard — made several of the new attack icons
* Marcus Rosén (sleepwalker) — Animations (esp. Saurians, Dwarves, Horseman), dunefolk sprites, and portraits (Mermaid Initiate & Dune Herbalist)
* Mark Goodenough (Ranger M) — sprite animator
* Maximiliano Buis (Redeth) — Made nearly all of the idle animations, and some death animations (as of 1.3.1)
* Michael Gil de Muro (grp21) — portraits (for the campaign 'The Rise of Wesnoth')
* Moritz Göbelbecker (mog) — tiles, esp. swamp, encampment, ice, and work with lava/chasm
* Niall Burton (Leonard03) — Minimalistic logo render
* Peter Geinitz (Shadow/Wayfarer) — sprite creator and animator
* Robert Bolin (Zebulon) — tiles, sprite editing and animations
<hr style='clear:none'>
* Andrew James Patterson (Kamahawk) — sprites
* antwerpz — sprite creator/animator for old saurian units
* Diego Brea (Cobretti) — sprite creator/animator
* EEL (EELuminatus) — sprite animator, provided death animations for the woses, some of the orcs, and an attack animation for the revenant
* Eli Dupree (Elvish Pillager) — sprites and animations
* Eric Holdos (Rev. V!)
* Gareth Miller (Gafgarion) — made some early sprites/tiles
* Gerald Clears (Smok'em Jags) — sprite animator
* James Barton (Sangel) — sprites
* Jami — rogue death and red mage idle animations
* Jerzy Brzozowski (Mefisto) — Various sprites and animations, tropical forests.
* Jesse Holland (Kestenvarn) — map illustrator of old titlescreen and campaign maps (v1.1 - v1.10)
* Johanna Manninen (lohari) — edited tiles, ported freeciv tiles used in very early versions of wesnoth
* John Muccigrosso (Eponymous Archon) — made some early sprites, such as the human bowmen
* Kuno Raffin (lurker) — Various terrain artwork
* Michael Mielewczik (Mille) — sprite animator
* Mikko Kraft (Deserter) — sprite animator
* Musketaquid — animated windmill / stone path
* Slainte — made sprites for c. v0.6 mages, also made many of the old attack icons
* Simon Forsyth (Alarantalara) — cave terrain
* Stephen Metcalf (Neoskel) — major help with shadow standardization (over half the units), made some missing zombie variants
* Stephen Stone (Disto) — sprite animator
* Svetac — made many of the old attack icons
* Tristan Millner (tatmf) — made old portrait of dwarven fighter
* Zhukov — sprite animator
<hr style='clear:none'>
* Aaron Redfern (A-Red) — Sprites and animations
* Adrian Sheehy (Major) — various sprites animations
* Alexander Brown (Cloud) — Sprite animations
* Anton Ecker (Kaldred) — burnt villages
* battlestar — - some scenery graphics including burnt tent.
* Ben Wenzel (artisticdude) — Sprite animations
* Blarumyrran — New storm trident, staff and ankh item pictures, various attack icons, river ford tiles, drake and human city villages
* Bora Orcal (bera) — Goblin portrait sketches
* Cernunnos — merfolk villages
* Charles Dang (vultraz) — Icons for new editor and updated terrain icons
* Chris Wilson (Valkier) — portraits
* Christian Sirviö (Girgistian) — portraits (sketches), and some attack animations for the orcs
* Clinton Bell — various animations
* Dan Gerhards (beetlenaut) — various sprites and animations
* Daniel Borgmann (dborg) — semi-transparent map grid
* Daniel Foerster (pydsigner/pyndragon) — Icon overlays for the About dialog button
* Kwandulin — Standing animations (Skeleton Archer, Bone Shooter, Orcish Archer, Dwarvish Fighter, Ulfserker, Stalwart, Runesmith), minor fixes
* doofus-01 — orcish fort and villages, desert mountains, mine walls, sea forts, portraits for walking corpse and soulless
* Elena Astanina (ayona) — log-cabin villages
* Eric Butler (Erk) — desert and merfolk villages
* Evan Crook (Flametrooper) — sprite animator (TC conversion)
* Garrett Wessner (Stilgar) — gold coin pile
* Gideon Chia (Deonjo) — new 'units' icon for general status bar
* Guangcong Luo (Zarel) — Multiplayer status icons for 1.7.x
* Highhole — revised storm trident
* Homunculus — dead great tree terrain
* [mailto:shadowm2006@gmail.com Iris Morelle] ([[User:Shadowm|Irydacea/shadowm]]) — Minor item/unit edits; animated lit brazier; ported gryphon rider animation to generic gryphon; Ancient Lich for 1.12.x
* Irrevenant — Skeleton archer death and recruit animations, new ankh touch ups, new dark adept touch ups, elvish marshal standing animation
* Irwin Ismail (Swordy) — original projectile/attack icon for chakram
* Jason Frailey (Valdroni) — scorpion portrait
* Jimmy Olsson (Azlan) — made old icons for windows version
* Joakim Persson (JAP) — Knalgan flag set
* John Mercer (Stern) — Giant Rat graphics
* John-Robert Funck (XJaPaN) — sprite animator
* Jonatan Alamà (tin) — made red logo used until before v1.0
* Justin Nichols (JustinOperable) — Portrait artwork
* Kim Holm (DUHH) — Portrait artwork
* Lukasz Wawrowski (inferno8) — Drake attack icons with fmunoz and map backgrounds for Isar’s Cross
* Lordlewis — mace item sprite
* Mattias Westlund (West) — new color cursors
* Nicholas Kerpan (Thrawn) — human thief portrait
* Pixelmind — various animations
* Randall Walls (slightcrazed) — sprite animator
* rhyging5 — various animations
* RusHHouR — New signpost (1.4.1)
* Samuel Wilson (megane) — random dice icon fix after 1.4.0
* Santiago Iborra (Quellion) — Portrait artwork
* Simeon Dear (Trilby) — Sprite animations
* Zoomo — Sprite animations
* Zaggy1024 — Wolf rider death animation
* Eisfrei — Elvish shaman idle animations
* Happy Wose — Wose idle frames and Elder wose death animation
* Wolfy — Female arch mage idle animation
* mystic x the unknown — Mage death animation
* Sonny T Yamada (SkyOne) — shadow standardization of many campaign units
* Vincent Langner (Vyncyn) — Walking Corpse and Soulless wolf variations, young roc base and attack sprite
* ZygoUgo — Giant Rat portrait
* ghype — sprite animation and dunefolk base frames
=== Music ===
* Aleksi Aubry-Carlson (Aleksi)
* Doug Kaufman (dkaufman) — http://dougkaufman.net/
* Gianmarco Leone (gmlion)
* Jeremy Nicoll (jeremy2/eltiare)
* Joseph Toscano (ZhayTee) — zhaymusic.com
* Mattias Westlund (West) — music coordinator/composer
* Ryan Reilly (Rain)
* Stephen Rozanc (TreizeCouleurs)
* Timothy Pinkham (TimothyP)
* Tyler Johnson
=== Sound Effects ===
* Corey Woodworth (woodwizzle) — hit and die sounds
* J.W. Bjerk ([[User:Eleazar|Eleazar]])
* Lari Nieminen (zookeeper) — focus on attack, weapon and user interface sounds
* Adam Rinsky (Action Jack) — dwarf hit and die sounds
* Leonardo Magno Sampaio (leorock116) — mace, staff and club sounds
=== Campaign Design ===
* Asa Swain (quartex) — Under the Burning Suns
* Astrid Halberkamp — Campaign maintenance and various improvements
* Benjamin Drieu
* Charles Dang (vultraz) — Campaign maintenance and various improvements
* Dacyn
* Dan Gerhards (beetlenaut) — Dead Water, Secrets of the Ancients
* David White (Sirp) — Heir to the Throne
* Eric J. Mesoy (Circon) — A Tale of Two Brothers
* Eric S. Raymond (ESR) — The Hammer of Thursagan
* esci — Descent into Darkness
* Francisco Muñoz (fmunoz) — founding artist and former lead artist, worked consistently on all aspects till around v0.7-0.9.
* James Spencer (Shade) — The Rise of Wesnoth
* Jeffrey 'Sigurd' Westcoat (SigurdFireDragon)
* Joseph Simmons (Turin) — The Eastern Invasion, The Sceptre of Fire
* Justin Zaun (jzaun) — coder, scenario designer
* Lari Nieminen (zookeeper) — redesign of various scenarios and other enhancement
* [mailto:Crazy-Ivanovic@gmx.net Nils Kneuper] (Ivanovic) — A Tale of Two Brothers
* Santi/fnaek — The Legend of Wesmere
* Scott Klempner — Heir to the Throne, The Rise of Wesnoth, Liberty
* Taurus — Northern Rebirth, Son of the Black-Eye
* William Carey (aelius) — The South Guard
=== Multiplayer Maps and Balancing ===
* George Birthisel (happygrue/Wintermute) — Unit balancing, Dunefolk Era
* Hejnewar — balancing for Age of Heroes, revised dunefolk
* Jake Bailey (jb) — multiplayer maps
* Joshua Northey (Becephalus) — multiplayer maps (mostly 2vs2 and up)
* Mike Quiñones (Doc Paterson) — multiplayer maps (mostly 1vs1)
* Noy — general purpose administration, unit balancing
* Peter Groen (pg) — multiplayer maps
* Ruben Philipp Wickenhäuser (The Very Uhu) — multiplayer maps
* Soliton — unit balancing
* Tom Chance (telex4) — multiplayer maps
* [mailto:kleinfel@wpi.edu Zack Kleinfeld] — multiplayer maps, unit balancing
=== Packagers ===
* ancestral — Apple OS X packager (1.12.1 and later)
* [mailto:hrubymar10@gmail.com Martin Hrubý] ([[User:hrubymar10|hrubymar10]]) — Apple macOS packager (1.13.11 and later)
* Matthias Schoeck (mattsc) — Apple OS X packager (1.11.8 and later)
* [mailto:Crazy-Ivanovic@gmx.net Nils Kneuper] (Ivanovic) — OpenPandora packager
* Rhonda D'Vine (Rhonda) — Debian/Ubuntu packager
* Sebastian Kölle (aquileia) — Visual Studio SDK maintainer
* Sergey Popov (loonycyborg) — Microsoft Windows packager and MinGW SDK maintainer
* [mailto:ports@toco-domains.de Torsten Zühlsdorff] — FreeBSD Packager
* Vincent Cheng (vincent_c) — Debian/Ubuntu packager
<hr style='clear:none'>
* [mailto:ben@happyspork.com Ben Anderman] (crimson_penguin) — Apple OS X packager (for 1.5.6 and later)
* Cyril Bouthors (CyrilB) — Debian packager, patron
* Darryl Dixon
* edge
* Isaac Clerencia — Debian packager
* Jay Hopping
* Jörg Hinrichs (Yogi Bear/YogiHH) — Microsoft Windows packager
* Laurent Wacrenier (lwa) — Apple OS X packager (for v1.4 and before)
* Marcin Konicki (ahwayakchih) — BeOS packager
* Marcus Phillips (Sithrandel) — Apple OS X packager (for v1.0 and before)
* Mark Michelsen (skovbaer) — Slackware packager
* Muhammad Amir Ayub (anakayub) — Apple OS X packager
* Piotr Cychowski (Mist/cycholka) — Microsoft Windows packager
* singalen — iOS port
* Simon Forsyth (Alarantalara) — Apple OS X Packager (1.9.6 and later)
* Vlad Glagolev (Stealth) — OpenBSD packager
=== Miscellaneous Contributors ===
* Aaron Keisch-Walter (Exasperation)
* Aaron Winter (Byteron)
* Adam Leffew
* Adrian Iosif (Zappaman)
* Aishiko — Unit instance recall cost implementation
* Alek Bollig (binarycoder)
* Alesis Novik
* Aline Riss (akihara)
* Amir Hassan (kallaballa)
* Andris Szell (bandita137)
* André Knispel
* Andrea Palmatè (afxgroup)
* Andrius Šilinskas (thunderstruck)
* Andrius Štikonas
* Anja Keicher (ayne)
* Astrid Halberkamp
* Ben Anderman (crimson_penguin) — unit list
* Boldizsár Lipka (lipk)
* Brilliand
* Burkay Özdemir (Velory) — Poisoning improvement for Formula AI
* chisquare130
* Chris Carpenter (mordocai)
* Chris Hopman (cjhopman)
* Chris Mann (WildPenguin) — Emacs WML-mode
* Chusslove Illich (caslav.ilic) — wmlxgetext improvements
* David Slabý (blaf)
* Daniel Bruegmann
* David Mikos (Coffee) — Coder, animation framework improvements.
* Denny Vaccaro (endercoaster)
* Derek (Gambit)
* devnexen
* DisherProject
* Dmitry K. (nephro)
* Doug Rosvick ([[User:dlr365|dlr365]])
* dorng
* dreamer-88
* Dugi — Context-free name generator
* Duthlet
* EarthCake
* Edward Chernenko
* Ekdohibs
* elvish_sovereign
* Ely Levy (Nakee)
* Étienne Simon (ejls)
* Etkin Baris Ozgul (pokhbocee) — Lua AI
* Eugene Kosov (kevg)
* [mailto:eugeni.stepanov@gmail.com Evgeniy Stepanov] — NativeClient port
* Evgeny Kapun
* FAAB
* Federico Pasco (neverEnough)
* Fedor Khod'kov (teddy/fkhodkov)
* Felix Bauer (flix)
* Fernando Carmona (Ferk)
* Floris Kint (Grimling)
* Francesco Gigli (Jaramir)
* Frank Richter (res)
* Frédéric Wagner
* Fredrik Wikstrom (salass00)
* galegosimpatico
* Galen Brooks (fluffbeast)
* gh0st — 2012 Google Code-in Students' Micro AI development
* Gregory Gauthier (rjaguar3)
* Groggy Dice (groggydice) — wmllint enhancements
* [mailto:kevin.xgr@gmail.com Guorui Xi] (Kevin_Xi)
* Hans-Joachim Gurt (HaJo)
* Herb Pah (haiz)
* holius-fr
* IceTyp
* ilyapopov
* J. Tyne (JaMiT)
* J.R. Blain (Cowboy)
* jstitch
* Jacek Kominek (BroodKiller)
* [mailto:benetnash@icpnet.pl Jan Polak] (benetnash) — Formula AI contributions
* Jan Zvánovec (jaz)
* [mailto:babataz@gmail.com Jean-Baptiste Poittevin] (BBT)
* Jeff Breidenbach (jab) — Bilinear interpolation
* [mailto:jleldridge27@gmail.com Jeffrey Eldridge] (jleldridge)
* Jérôme (segfault)
* Jim Carroll (Jimm)
* Jody Northup (Upthorn) — Prospective student (world persistence)
* Joeri Melis
* Joey L. Maalouf (JDog)
* [mailto:john@jo.hnanthony.com John Anthony] — campaignd work, mainly security-based
* John B. Messerly (jbm)
* John Harvey (johndh) — minor race descriptions; bats, goblins, mechanical, merfolk, monster, naga, ogre
* Jonathan Combs (ScegfOd) — log activating dialog
* Jonas Lihnell (Roze)
* Jonas Kölker
* [mailto:jorda@ettin.org Jordà Polo] (ettin) — website, i18n, ui
* Josef Reidinger (qk)
* Joseph Gelfand
* Joshua Hudson
* josteph
* Jozrael
* Justin DiSabatino (Turuk)
* Kamil Kaczmarczyk (lampak)
* [mailto:karl.miller.km@gmail.com Karl Miller] (karlm)
* Karol Kozub (automagic)
* Kevin Montalva (Ryckes)
* Kevin Yap (iKevinY)
* Konrad Schwede (Konrad2)
* Kristoffer Grönlund (kegie)
* Krogen
* Laurent Birtz
* legoktm
* leonardoInf
* lilinitsy
* Lovens Weche (LovCAPONE)
* Luiz Fernando de Faria Pereira (lfernando)
* [mailto:lutheroto@gmail.com Luther Thompson]
* lv-zheng
* [mailto:code@hryniuk.pl Łukasz Hryniuk]
* Maksim Orlovich (SadEagle)
* Mark McGuire (TronPaul)
* Martin Bede — 2012 Google Code-in Students' Micro AI development
* [mailto:hrubymar10@gmail.com Martin Hrubý] ([[User:hrubymar10|hrubymar10]])
* Mateusz Kolaczek (PL_kolek)
* Matt Renfer (Des) — Prose revision
* Matthias Schoeck (mattsc) — AI improvements
* matthiaskrgr — Running address sanitizer to catch leaks
* Maxim Biro (nurupo)
* Maximilian Fricke (madmax28)
* Maximilian Lupke (malumalu)
* Marius Spix (spixi)
* Michael Flowers (MJ)
* Michael Schmahl
* Michael Strebel (Nostromus)
* midzer
* Miguel Zapico (elricz)
* mstrebel
* [mailto:greywhind@users.sourceforge.net Nathan Partlan] ([[User:Greywhind|Greywhind]])
* [mailto:nathan.b.walker@vanderbilt.edu Nathan Walker] (RiftWalker)
* neoedmund
* newfrenchy83
* Niall Burton (Leonard03)
* niegenug
* Nobun — wmlxgettext
* [mailto:zabivator@gmail.com Oleg Tsarev]
* Olivier Faure (PoignardAzur)
* [mailto:asqueados@gmail.com Pablo J. Urbano Santos] ([[User:Lord Ork|Lord Ork]])
* Patryk Obara (dreamer_)
* Paul Smedley (Creeping)
* Paŭlo Ebermann ([[User:Pauxlo|Pauxlo]])
* PBechon
* Peter Elmers
* Peter Mawhorter ([[User:solsword|solsword]]) — Python TC script upgrade
* Petr Sobotka (Pietro)
* [mailto:root@delroth.is-a-geek.org Pierre Bourdon] (delroth)
* pquentin
* Pranav Deshpande (universecoder)
* Priit Laes (plaes)
* Pubudu Gunawardena (ugudu)
* Qi Mo (qmo2015)
* Quetzalcoatl
* Randy Kostiuk (Randypk) — Bug fixes
* RatArmy (fujimo-t)
* Reuben Rakete (rocketbang)
* Richard Yao (srk9) — Bug fixes
* Rikard Falkeborn
* Robert Spencer — 2012 Google Code-in Students' Micro AI development
* Robert Wallace (Robertdebrus)
* Rocco J Carello (rogue)
* Roland Hautz (duncan_shriek)
* Rolf Sievers (Lizard)
* Ronny Standtke
* rrigby
* Ryan Frame
* Ryan Henszey
* Ryan Roden-Corrent (rcorre) — Hotkey release and scroll key rebinding
* [mailto:sachith500@gmail.com Sachith Seneviratne] (sachith500) — Bug fixes at the moment. GSoC Aspirant
* Samuel Kim — 2012 Google Code-in Students' Micro AI development
* Sean Yeh
* Sebastian Goll (afran)
* Sebastian Kölle (aquileia)
* Serge Martin (EdB)
* [mailto:stomasortiz@gmail.com Sergio Tomás Ortiz]
* Severin Glöckner (Shiki, Sevu)
* Simon Forsyth (Alarantalara)
* [mailto:simon_smith@zen.co.uk Simon Smith] ([[User:Simons_Mith|Simons Mith]]) — Style guide, help with the application of the style guide, and some tips
* SoapGentoo
* starius
* Stéphane Gimenez (gim)
* [mailto:Majora700@gmail.com Steven Panek] ([[User:Espreon|Espreon]])
* [mailto:sylecn@gmail.com sylecn]
* [mailto:nsytyi@gmail.com Sytyi Nick] (Sytyi) — WML validation
* [mailto:ptablot@mopong.net Talbot Pierre] (Trademark)
* Tamas K. (negusnyul)
* techtonik
* the_beagle — Wose race description
* The Gnat
* Thibault Févry (iwontbecreative) — Some GCI tasks and utils/wiki_grabber.py cleanup.
* Thom Diment (UnwiseOwl)
* [mailto:hankerspace@gmail.com Thomas Martinet] (hankerspace)
* [mailto:thomas.prevost@gmail.com Thomas Prevost] (zancdar)
* Thonsew
* Thorny23
* Tobias Frei (ToBeFree)
* Tomasz Sikorski (Tomsik)
* Tommy Schmitz
* Tommy (yobbo)
* Toom Lõhmus (Ravana)
* tsr
* Valentin Deschaintre (Zazweda, Epyde) — Zone guardian Micro AI
* vitiv — 2012 Google Code-in Students' Micro AI development
* [mailto:viy@altlinux.org viy]
* Vladimír Slávik — Miscellaneous text formatting and translation engine related help
* vn971, vgaming
* Wedge009
* Yang Yifan (Xara)
* Zas
=== Bots ===
* CIA
* irker
* janebot
* shikadibot
* wesbot
== Translators ==
=== Afrikaans Translation ===
* András Salamon (ott)
* Erhard Eiselen
* Len van Dalsen (Numbers13) — current maintainer
* Nico Oliver (nicoza)
* Renier Maritz
=== Ancient Greek Translation ===
=== Arabic Translation ===
* Amnay Mokhtari
=== Asturian Translation ===
=== Basque Translation ===
* Alfredo Beaumont (ziberpunk)
* Julen Landa (genars)
* Mikel Olasagasti (Hey_neken)
=== Bulgarian Translation ===
* Anton Tsigularov (Atilla)
* Bono Nonchev
* Denica Mincheva (Deni)
* Georgi Dimitrov (oblak)
* Ivan Petrov (TheWhiteKnight) — current maintainer
* Nikolay Vladimirov (Turki)
* Steven Genchev (blademaster83)
* Valentin Yankov (kartacha)
=== Catalan Translation ===
* Carles Company (brrr)
* Dan Rosàs Garcia (focks)
* Daniel López (Azazelo)
* Joan Queralt
* Jonatan Alamà (tin)
* [mailto:jorda@ettin.org Jordà Polo] (ettin)
* Jose Gordillo (kilder)
* J.R. Dolcet Castro (Malin Keshar)
* Marc Orcau
* Mark Recasens
* [mailto:miquel.angel.burgos@gmail.com Miquel-Àngel Burgos i Fradeja] — current maintainer
* Pau Rul·lan Ferragut
* Roberto Garcia (Motxales)
=== Chinese Translation ===
* AxalaraFlameheart (AxalaraFlame)
* Brian lee
* chisquare130
* [mailto:cloudidust@gmail.com CloudiDust] ([[User:CloudiDust|CloudiDust]]) — current maintainer
* cryaciccl
* Dionysus
* 逆天的高级菜鸟 (Gaojicainiao)
* Henry Zhu (Hardwood) — iOS announcements translation into Chinese
* Huang Hongye (Dugucloud) — translation and image localization
* Huang Huan
* Huang Lechuan
* leaf
* Luojie-dune
* MrKing
* 网上佳公子
* Owlet
* pianton
* SealMe
* spider5
* StephDC
* [mailto:sylecn@gmail.com sylecn]
* Teamzhangmeng
* vinneymail
* wind
* Yifan
* yym514
* zen
=== Chinese (Taiwan) Translation ===
* 楊綮銘
* 李昆融
* 李信融
=== Croatian Translation ===
* Ivica Đurenec (charlieh65)
* Nino Gunjača
=== Czech Translation ===
* Alexander Slávik (Olin)
* Anežka Bubeníčková (Bubu)
* Čestmír Houska
* David Nečas (Yeti)
* David Novotný (Draqen)
* [mailto:jan.dedic@gmail.com Jaromír Dědič]
* Karel Doleček
* Lukáš Faltýnek
* [mailto:hrubymar10@gmail.com Martin Hrubý] ([[User:hrubymar10|hrubymar10]])
* Martin Šín
* Michal Žejdl
* Mintaka
* [mailto:tapik@buchtovi.cz Oto Buchta] ([[User:Tapik|tapik]])
* Petr Kopač (Ferda)
* Petr Kovár (Juans)
* Rudolf Orság
* Septim
* Sofronius
* Vít Komárek
* Vít Krčál
* Vladimír Slávik
=== Danish Translation ===
* Anders K. Madsen (madsen)
* Ask Hjorth Larsen
* Bjarke Sørensen (basher)
* Jesper Fuglsang Wolff (ulven)
* Joe Hansen
* Kenneth Nielsen
* Mark Michelsen (skovbaer)
* Mathias Bundgaard Svensson (freaken)
* Ole Laursen
=== Dutch Translation ===
* [mailto:AI0867@gmail.com Alexander van Gessel] (AI/AI0867) — previous translation maintainer
* Arne Deprez
* Astrid Halberkamp
* Floris Kint (Grimling)
* Foppe Benedictus
* [mailto:oudshoorn@eitri.nl IJsbrand Oudshoorn]
* Joeri Melis
* Jon Jacobs
* Koen Douterloigne
* Koen Vervloesem (koan)
* Lala
* Maarten Albrecht
* Merijn de Vet — translation maintainer
* Pieter Vermeylen (Onne)
* Rico van Coevorden
* Rob van der Vleugel
* Roel Thijs (Roel)
* Roger Koot
* Thomas Hugo de Groot
* Tobe Deprez
* WimPapa
=== English (GB) Translation ===
* András Salamon (ott)
* Eric S. Raymond (ESR)
* pjr
* [mailto:Majora700@gmail.com Steven Panek] ([[User:Espreon|Espreon]])
* Thomas Hockings ([[User:Deusite|Deusite]])
* Wedge009
=== English (Shaw) Translation ===
* [mailto:arcriley@ubuntu.com Arc Riley] ([[User:ArcRiley|ArcRiley]]) — translation maintainer
* [mailto:reportingsjr@gmail.com Jon Neal] (reportingsjr)
* [mailto:thomas@thurman.org.uk Thomas Thurman] (marnanel)
=== Esperanto Translation ===
* Aleksej Korgenkov (Grimpanto)
* Francesco Lorenzon (Likso)
* Ľubo Fajth
* Maarten Albrecht
* Rastislav Šarišský (Asto)
=== Estonian Translation ===
* Kaido Kikkas (UncleOwl)
* Mart Tõnso
=== Filipino Translation ===
* Joset Anthony Zamora (eradicus)
* Karen Eve Eso (keeve)
=== Finnish Translation ===
* Ankka
* Jaakko Saarikko — translation maintainer
* Jarkko Patteri (Jarkko)
* Juhana Uuttu
* Jussi Rautio (jgrr)
* kko
* Matias Parmala
* Matias Pigg
* Mikko Nikkilä (Miccoh)
* Mikko Kraft (deserter)
* Miriam Green
* Niklas Laxström (Nikerabbit)
* Otto Oikarinen
* paxed
* Samu Voutilainen (Smar)
* Santtu Pajukanta (Japsu)
* Simo Sutela
* Veikko Pukkila (swege)
=== French Translation ===
* Antoine Garnier
* Antoine Imboden
* Aurélien Brevers (Breversa)
* Aurélien Paulus
* Arnaud Garoux (La vie en wose)
* Benoit Astruc
* [mailto:benoit.timbert@free.fr Benoît Timbert] ([[User:Noyga|Noyga]]) — translation maintainer
* Bruno Fève (PP)
* Cédric Duval
* Damian Gryski (dmg)
* [[User:Damien|Damien Jacquot]] — lead translator
* DaringTremayne
* David Pradier
* Éric Pierre (Gari)
* Fabrice Boulakia
* Florence Guettaa (inflow)
* François Mariage (Paquito)
* François Orieux
* Geoffroy Douillié ([[User:Gdou|gdou]])
* Gérard Bodin (Gnork)
* Guillaume Delacourt
* Guillaume Duwelz-Rebert
* Guillaume Guigou
* [mailto:massart.guillaume@wanadoo.fr Guillaume Massart] (Piou2fois)
* Guillaume Melquiond (silene)
* Guillaume Pascal
* Jean Privat (Tout)
* Jean-Louis Passerin (Zoltic)
* Jean-Luc Menut
* Jean-Luc Richard (Le Gnome)
* Jean-Joseph Paget
* Jehan Hysseo (Jey)
* Jérémy Rosen (Boucman)
* Julien Moncel
* Julien Tailleur
* Marc Scheffer
* Mathieu Guilbaud
* Mendes Oulamara
* Michel Poléni (Thanatloc)
* Nicolas Boudin (Blurgk)
* [mailto:philippe.plantier@naema.org Philippe Plantier] ([[User:Ayin|Ayin]])
* Philippe Rasquinet
* Pierre Rudloff
* Sébastien Raynaud (Galactic turkey)
* Sylvain Jeanne
* Thierry Bothorel
* Solena Le Moigne
* William Dupré
* [mailto:ydirson@altern.org Yann Dirson]
=== Friulian Translation ===
=== Galician Translation ===
* [mailto:adriyetichaves@gmail.com Adrián Chaves Fernández] (Gallaecio)
* Fran Diéguez
* Jacobo Abel Fernández García — inactive
* Javier Pico
* Manuel Meixide
* Marce Villarino
* [mailto:leandro.regueiro@gmail.com Leandro Regueiro] (unho) — translation maintainer
* Victor Portela
* Proxecto Trasno — translation project (http://trasno.net)
=== German Translation ===
* Aaron Winter (Bitron)
* Alexander Ginschel (mcpgal)
* Alexander Laux
* Alexander Zurek (Alresu)
* Andre Schmidt (schmidta)
* Boris Stumm (quijote_)
* Celina Mainz (Mailina)
* Chewan
* Christoph Berg (chrber) — former translation maintainer
* Christoph Lange (madelgijs)
* Drakefriend
* Elias Fromm (Karpadorsch)
* Elias Pschernig (allefant)
* ghype
* Lennard
* Lorenzo Hardt (HeroOfGaming)
* Rhonda D'Vine (Rhonda)
* Jan Greve (Jan)
* Jan Heiner Laberenz (jan-heiner)
* Kai Ensenbach
* Konrad Schwede (Konrad2)
* [mailto:marcel_miebach@gmx.de Marcel Miebach] (retr0virus)
* Mark de Wever ([[User:SkeletonCrew|Mordante/SkeletonCrew]])
* Matthias Gianfelice (MatthiasG)
* [mailto:Crazy-Ivanovic@gmx.net Nils Kneuper] (Ivanovic)
* Oliver Lange (Crommy)
* Ronny Standtke
* Ruben Philipp Wickenhäuser (The Very Uhu)
* Severin Glöckner (Shiki, Sevu) — current translation maintainer
* Stephan Grochtmann (Schattenstephan)
* Tobias Schönau (SonIcco)
* Uz-Valentin Friedrich
* vonHalenbach
=== Greek Translation ===
* Alexander Alexiou (Santi/fnaek)
* Evangelos Papakirikou
* Harry Kaimenas
* Katerina Sykioti
* Konstantinos Egarhos
* Konstantinos Karasavvas
* Mik2303
* Nikos Astroylakis (Greek Dubbings Maker)
* Nikos Papadopoulos (galicae)
* Nikos the Great
* Panagiotis Famelis (Kesnar)
* Papadopoulos Themistoklis
* Spiros, Giorgis
=== Hebrew Translation ===
* Ariel Ben-Yehuda
* Oron Peled
* Ely Levy (Nakee)
=== Hungarian Translation ===
* Barthalos Márton (Aldebaran Ghrelin)
* Czakó Csaba (Horus)
* Erdélyi Kristóf
* Fábián Balázs (nermal93)
* Hamar Krisztián
* Kádár-Németh Krisztián (Rudanar Firmus)
* Kékkői László (BlackEvil)
* Kelemen Zoltán (kele)
* Kovács Dániel (Consalamander)
* Majsa Norbert (wias)
* Máthé Katalin (katkadu)
* Németh Tamás (nTOMasz)
* Pintér Csaba (piere)
* Salamon András (ott)
* Soltész Adrián (majominia)
* Széll Tamás (TomJoad)
* Udvari Gábor (Udi)
* Udvari Zsolt
* Vasvári Péter (honorshark)
=== Icelandic Translation ===
* Arngrímur Stefánsson
* Gabríel A. Pétursson
=== Indonesian Translation ===
* Ardhi (earthboy)
* Benny Lin
* [mailto:sevennightmare@tutanota.de Irsyad Musthafa] — translation maintainer
* Iwan
* [mailto:inkraiswitras@yahoo.com Nicky Inkrais Witras] — previous translation maintainer
* [mailto:yuris_wicaksana@yahoo.com Yuristyawan Pambudi Wicaksana] — previous translation maintainer
=== Irish Translation ===
* Mountain_King — translation maintainer
=== Italian Translation ===
* Alessandro Barbazza
* Alessio D'Ascanio (otaku)
* Americo Iacovizzi (DarkAmex)
* [mailto:arosella@yahoo.com Antonio Rosella]
* crys0000
* Elvish_Hunter
* Eugenio Favalli (ElvenProgrammer)
* Federico Tomassetti
* Filippo Abbruzzo (Gwain)
* isazi
* Luciano Montanaro (Luciano)
* Michele Maresi (mich)
* RokStar
* Stefano Coccato (BioHazardX)
=== Japanese Translation ===
* BlueStar
* clearpotion
* h22
* [mailto:broadbarredfirefish@gmail.com Hironori Fujimoto] (RatArmy) — translation maintainer
* [mailto:iwaim.sub@gmail.com IWAI, Masaharu] ([[User:Iwaim|iwaim]])
* [mailto:kateitekino_hito@yahoo.co.jp kateiteki]
* kudoh
* Maxwell Stibbard Hawkes
* [mailto:mishanhideaki88@gmail.com mishan]
* いいむらなおき (amatubu) - Naoki Iimura
* [mailto:okyada@gmail.com 岡田信人 - Nobuhito Okada]
* np
* [mailto:pasta0915[at]gmail.com Shoot MORII] (pastak)
* OOTA, Masato(oo)
* Q
* R.N
* rouiza
* [mailto:le.sahara@gmail.com sahara]
* Shigerello
* [mailto:suto3suto3@gmail.com suto3]
* 瀟湘夜雨
* Taigaku Okuiso
* Takanobu Hirai
* tamanegi
* [mailto:yma9yma@gmail.com yma]
* Yuji Matsumoto
=== Korean Translation ===
* mistzone — current maintainer
=== Latin Translation ===
* Eric S. Raymond (ESR) — general semantician
* Mark Polo (mpolo) — original maintainer
* Michael Babich ([[User:Aethaeryn|Aethaeryn]]) — current maintainer
* [mailto:Majora700@gmail.com Steven Panek] ([[User:Espreon|Espreon]])
* Thomas Hockings ([[User:Deusite|Deusite]])
=== Latvian Translation ===
* Artis Rozentāls
* Gvido Bruveris — Maintainer
* [mailto:rei4dan@gmail.com Reinis Danne]
=== Lithuanian Translation ===
* Andrius Štikonas
* Deimantė Tankus (Diamond)
* Jurgis Sūdžius (Dievas)
* Lukas Gasiūnas (LucasLT)
* Marius Tauba (morlock)
* Raimundas Zabarauskas
* Vytautas Šaltenis (rtfb)
=== Macedonian Translation ===
* Dimitar Ilccov (Mythological)
=== Marathi Translation ===
* [mailto:sujitrjadhav@gmail.com सुजित जाधव] ([[User:sujitrjadhav|Sujit R Jadhav]])
=== Norwegian Translation ===
* Asgeir Aakre (YbeRn00b)
* Erik J. Mesoy (Circon)
* Gaute Jao (Gauteamus)
* Hallvard Norheim Bø (Lysander)
* Håvard Korsvoll
* Pål Inge Larsen (PsyBird)
* Susanne Mesoy (Rarlgland)
=== Old English Translation ===
* [mailto:eirikvw@aim.com Eirik Westcoat]
* [mailto:axonfifty@gmail.com Gottweiß]
* [mailto:Majora700@gmail.com Steven Panek] ([[User:Espreon|Espreon]]) — Maintainer
=== Polish Translation ===
* Agata Chmiel
* Arkadiusz Danilecki (szopen)
* Bartek Waresiak (Dragonking)
* Kamil Matuszewski (LiamTailor)
* Karol Nowak (grzywacz)
* Magdalena Chmiel (Ryouko)
* Marek Kalnik (wdev)
* Michał Hartliński
* Michał Jedynak (Artanis)
* Michał Ligowski (misiorysio)
* Paweł Albecki (gidgnulur)
* Paweł Jackowski (fatality)
* Piotr Kruszewski (Hejnewar)
* Piotr Makarewicz (ForPeace) — Current maintainer
* Robert Wolniak (Szkodnix)
* Roman Polesek (rimskij)
* Sebastian Basierski
* Tadeusz Kopeć
* Zbigniew Banach (vonBureck)
=== Portuguese Translation ===
* Carlos Sousa
* Luis Passos
* trewe — Current maintainer
=== Portuguese (Brazil) Translation ===
* Ambra Viviani Loos
* Andrei Machado — Current maintainer
* Antonio Vildes Barbosa
* Bruno Macabeus
* Celso Goya
* [mailto:cbterra@gmail.com Claudio Terra]
* Claus Aranha
* Di Teixeira (Moroder)
* Diego Inácio Goergen
* [mailto:fred.maranhao@gmail.com Fred Maranhão]
* Hugo Neiva de Melo
* Michel Loos
* Renato Cunha
* Ricardo Sodré Andrade
* Romero Gonçalves
* Sérgio de Miranda Costa
* Tiago Souza (Salvador)
=== Romanian Translation ===
* Unknown
=== Russian Translation ===
* Aldarisvet — Previous maintainer
* [mailto:allryn@pisem.net Aleksandr Aleks]
* Alexandr Gridnev
* Alexandr Menovchicov
* Alexey Remizov
* Alexey Zakharchenko
* Andrey Tikhonov ([[User:tiandrey|tiandrey]])
* Anthony Kolesov
* Artem Khrapov ([[User:Kabachuha|kabachuha]]) — Current maintainer
* Azamat Hackimov ([[User:Winterheart|winterheart]])
* [mailto:BabylonASАТyandexDОTru BabylonAS] ([[User:BabylonAS|BabylonAS]])
* [[User:catbegemot|catbegemot]]
* Danila Evstifeyev (MyOtheHedgeFox)
* Denis Revin (Dut_Norshi)
* Dmitry Brilev (dobryl)
* Fardeil
* Fedor Gavrilov (gallowzbird)
* Fedor Khod'kov (teddy/fkhodkov)
* Ilya Kaznacheev
* Ilya Kotov
* Ishayahu Lastov (Ishayahu)
* Kirill Baranov
* Mikhail Melnik (ZumZoom)
* Nikita Ushkin
* Roman Tuchin (Sankt)
* Sergey Popov (loonycyborg)
* Valentina Mukhamedzhanova (umirra)
* Victor Sergienko (singalen)
* [mailto:vicza@zmail.ru Victor Zabavin]
* Vlad Glagolev
* Yellow Horror
=== Scottish Gaelic Translation ===
* [mailto:fios@foramnagaidhlig.net GunChleoc] — Current maintainer
=== Serbian Translation ===
* Branko Kokanovic (kokan)
* [mailto:caslav.ilic@gmx.net Caslav Ilic]
* [mailto:daliborddjuric@gmail.com Dalibor Djuric]
* [mailto:sreckotoroman@gmail.com Srecko Toroman] (FreeCraft)
=== Slovak Translation ===
* Aceman
* Ivan Kovacs
* Ján Sučan (Bhujanga)
* Marian Kluvanec
* Martin Dzbor
* Martin Plávala (Empy)
* Stano Hoferek (Elven)
* [[User:Viliam|Viliam Bur]]
=== Slovenian Translation ===
* Gregor Petrin
* Jaka Kranjc (lynx)
* Klemen Košir (nNa)
* Matej Repinc
=== Spanish Translation ===
* Alvin Eloy Luna Castro
* Chucho Pulgoso
* David Martínez Moreno
* Diego Grande Rodríguez (Buhako)
* Diego J.
* Fernando Cerezal
* Flamma
* Francisco Muñoz (fmunoz)
* Gabriel Rodríguez (Chewie)
* [mailto:gusgins@gmail.com Gustavo Gingins] (gins)
* [mailto:shadowm2006@gmail.com Iris Morelle] ([[User:Shadowm|Irydacea/shadowm]])
* Iván Herrero (navitux)
* Javier C.H. (perseo)
* Jose Gordillo (kilder)
* Jose Manuel Gomez (joseg)
* Josu Díaz de Arcaya
* Masacroso
* Martín R. Dapás
* Pedro Llorens (PeterPorty)
* Roberto Romero (sildur)
* Sergi March (sergi34)
* [mailto:Majora700@gmail.com Steven Panek] ([[User:Espreon|Espreon]])
* [mailto:quianaaelonin@gmail.com Víctor M. Estrada] (Aelonin/Darkmage)
* Xavier Novella Sinde (XavierNovella)
=== Swedish Translation ===
* Alex Alowersson — current maintainer
* Alexander Kjäll (capitol)
* Andreas Tyrberg
* Åse Petersson (tintin)
* Elias Sevelin (aXidal)
* Gustav Tiger
* Hugo Gerlach (Entrimo)
* Leo Danielson (Lugo Moll)
* Niklas Bolmdahl
* Stefan Bergström (tephlon)
* [mailto:susanna.bjorverud@telia.com Susanna Björverud] (sanna)
* Ulrika Uddeborg
* wint3r
=== Turkish Translation ===
* Ali Erdem Karaçay(Arsivnet)
* Enes Akın (yekialem)
* İhsan Akın
* Kosif
* Nilgün Belma Bugüner
* Pınar Yanardağ (moonquelle)
* Selim Farsakoğlu
=== Ukrainian Translation ===
* Anton Okhrimenko (AncientGeneral)
* [mailto:mansonigor@gmail.com Igor Paliychuk]
* [mailto:arobson@yandex.ru robson] ([[User:Robson|Robson]])
=== Valencian (southern Catalan) Translation ===
* Bernardo Arlandis
* Robert Millan
* Tomás Roig
=== Vietnamese Translation ===
* Huynh Yen Loc
* Le Ngoc Nguyen Chinh
* Pham Hoang Duy
* Pham Thanh Nam
* Pham Thi Yen
=== RACV’s Translation ===
* Mario Rodríguez (Mavorte)
== Sceptre of Fire ==
=== Campaign Design ===
* Joseph Simmons (turin)
=== Campaign Maintenance ===
* Lari Nieminen (zookeeper)
* doofus-01
* nemaara
=== WML Assistance ===
* David Simmons (Dacyn)
* Eli Dupree (Elvish Pillager)
* Lari Nieminen (zookeeper)
* MadMax
=== Artwork and Graphics Design ===
* Asereje
* Blarumyrran — the new Dwarvish Miner sprite
* Emilien Rotival (LordBob) — new portraits
* James Woo (Pickslide) — old portraits
* John-Robert Funck (XJaPaN)
* JonasNL — Dwarvish Miner attack and defense animations
* Peter Geinitz (Wayfarer)
* Pixelmind — Khrakrahs portrait
* Richard Kettering (Jetrel)
* RusHHouR — old gold and coal piles
* doofus-01
== Son Of The Black Eye ==
=== Campaign Design ===
* Benjamin Drieu (Benj) — conception and original design
* Taurus — completion
=== Campaign Maintenance ===
* Lari Nieminen (zookeeper) — current maintainer
* Taurus
=== Prose, Grammatical and WML Assistance ===
* Eric S. Raymond (ESR)
=== Artwork and Graphics ===
* Christian Sirviö (Girgistian) — portraits (sketches)
* Phil Barber (thespaceinvader) — portraits (coloring)
* Sonny T Yamada (SkyOne) — Sprite animations (defense and magic) of orcish shamans
== Northern Rebirth ==
=== Campaign Design ===
* Taurus
=== Artwork and Graphics Design ===
* Battlesquid
* Nicholas Kerpan (Thrawn)
* Richard Kettering (Jetrel)
* Xandar86
=== Prose, Grammatical and WML Assistance ===
* Eric S. Raymond (ESR)
=== Code and Translation Assistance ===
* David Philippi (Torangan)
* Scott Klempner
=== Campaign Maintenance ===
* Charles Dang (vultraz)
== Liberty ==
=== Original Campaign Design ===
* Scott Klempner
=== Latest Rewrite ===
* nemaara
=== Campaign Maintenance ===
* Lari Nieminen (zookeeper)
* Eric S. Raymond (ESR) — Original prose-doctoring and preparation for mainline
=== Artwork and Graphics Design ===
* Brendan Sellner
* Kathrin Polikeit (Kitty) — portraits
* Shadow
* Blarumyrran — story images, Rogue Mage line sprites
* Sonny T Yamada (SkyOne) — Sprite animations (defense and attack) of Rogue Mage line
== Delfadors Memoirs ==
=== Creator and Original Designer ===
* [[User:jp30|Josh Parsons]] — Original designer, responsible for first scenarios 2-10; maintained it up to 0.5.2
=== Co-Authors ===
* Oto 'tapik' Buchta — First scenario, various improvements
* Spiros Alexiou (Santi/fnaek) — Scenarios 12 and following.
* Eric S. Raymond (ESR) — Prose- and script-doctoring, Wesnoth continuity fixes.
=== Campaign Maintenance ===
* Jeffrey 'Sigurd' Westcoat (SigurdFireDragon) — former maintainer
=== WML Programming and Assistance ===
* Fabi — WML bug fixing and polishing.
* Eric S. Raymond (ESR) — Side-mutation and recall-list handling.
* Iris Morelle (Irydacea/shadowm) — WML help
=== Graphics ===
* Kathrin Polikeit (Kitty)
=== Additional thanks to ===
* Arkadiusz D. Danilecki — Inspiration and borrowings from his 'A New Order'
== Heir To The Throne ==
=== Campaign Design ===
* David White (Sirp)
=== Campaign Maintenance ===
* Dimitar Ilccov (Mythological)
* Lari Nieminen (zookeeper) — current maintainer
* Scott Klempner
=== Artwork and Graphics Design ===
* doofus-01 — new sprites and animations (Princess, Battle Princess, Dark Queen, Sea Orc)
* Emilien Rotival (LordBob) — portraits (Delfador, Asheviere, Moremirmu)
* Francisco Muñoz (fmunoz)
* Kathrin Polikeit (Kitty) — portraits (Konrad, Li'sar, Kalenz, Chantal)
* Neoriceisgood
* Richard Kettering (Jetrel)
=== Miscellaneous ===
* Patrick Parker (Sapient) — WML assistance
== Secrets of the Ancients ==
=== Campaign Design, Programming, and Artwork ===
* Dan Gerhards (beetlenaut)
=== Campaign Maintenance ===
* Jeffrey 'Sigurd' Westcoat (SigurdFireDragon) — former maintainer
=== Additional Artwork ===
* Wussel — Some improvements to the ship.
== Legend of Wesmere ==
=== Creator and Lead Designer ===
* [mailto:moka1@otenet.gr Spiros, George and Alexander Alexiou] ([[User:Santi|Santi/fnaek]]) — Main designers, former maintainers.
=== Campaign Maintenance ===
* Fabi/Fendrin — Current maintainer
* Spiros, George and Alexander Alexiou (Santi/fnaek)
=== Prose-doctoring and adaptation for mainline ===
* Eric S. Raymond (esr)
* Fabi/Fendrin — Major WML rewrite for mainline
=== WML Assistance ===
* Alexander van Gessel (AI/AI0867) — bugfixing and general WML cleanups
* Iris Morelle (Irydacea/shadowm) — for A LOT of help with WML and interesting campaign suggestions
* Lari Nieminen (zookeeper) — for A LOT of help with WML
=== Artificial Intelligence ===
* Yurii Chernyi (crab) — coding of the new ai and help with corresponding redesigns
=== Graphics ===
* Bora Orcal (bera) — goblin horn rouser
* Kathrin Polikeit (Kitty) — who did a great job with portraits and other graphics
-the main reason for having a polished campaign
* Steven Panek (Espreon) — map artist
=== Additional thanks to ===
* Scott — for help with WML, especially the use of store/unstore
* WhiteWizard — Initial porting to 1.2
* Disto — for elvish units
* RedLTeut — for great improvements to the initial invisible elvish units
* Dacyn — who was of great help in the beginning of this project
* Big Bad Joe
* breversa
* Invisible Philosopher
* js138
* l'ultimo cruco
* Mad Max
* Rhuvaen
* SelfishWeirdo
* Scott
* Sly
* Teldar
* Turin
* And the rest of the Wesnoth community for feedback,
criticism, help with WML code and graphics.
== The South Guard ==
=== Campaign Design ===
* William Carey (aelius)
=== Latest Campaign Revision ===
* nemaara
=== Campaign Maintenance ===
* nemaara — current maintainer
* Lari Nieminen (zookeeper)
* Eric S. Raymond (ESR)
* Wintermute
=== Artwork and Graphics Design ===
* J.W. Bjerk (eleazar)
* Kathrin Polikeit (Kitty) — portraits
* Lari Nieminen (zookeeper)
* Scavenger — new story images and Mal M'Brin portrait
* rhyging5
* Shadow
* William Carey (aelius)
== Two Brothers ==
=== Campaign Design ===
* Eric J. Mesoy (Circon)
* Nils Kneuper (Ivanovic)
=== Prose and Story Edits ===
* Eric S. Raymond (esr)
* A-Red
=== Campaign Maintenance ===
* Nils Kneuper (Ivanovic)
* Charles Dang (vultraz)
=== Artwork and Graphics Design ===
* Arkadiusz Danileki (szopen)
* Kathrin Polikeit (Kitty) — current portraits
* MadMax
* Stefan
=== Miscellaneous ===
* Bartek Waresiak (Dragonking)
* Christoph Berg (chrber)
* Daravel
* Jozrael
* And special thanks to everyone else who I forgot to mention.
== Under the Burning Suns ==
=== Campaign Design ===
* Asa Swain
* Piotr Cychowski (Mist/cycholka)
=== Campaign Maintenance ===
* Iris Morelle (Irydacea/shadowm)
* Jan Rietema (Rhuvaen)
* Lari Nieminen (zookeeper)
* Piotr Cychowski (Mist/cycholka)
* Simon Forsyth (Alarantalara)
* Steven Panek (Espreon)
=== Artwork and Graphics Design ===
* Dan Gerhards (beetlenaut) — new Flesh Golem sprites
* Kwandulin — New Kaleh and Nym sprites
* doofus-01 — Monster Crab sprite
* Hogne Haskjold (Frame)
* Iris Morelle (Irydacea/shadowm)
* J.W. Bjerk (Eleazar)
* James Woo (Pickslide)
* Javier Hoyos (Vendanna)
* Marcus Rosén (sleepwalker) — Dark Assassin sprite and animations
* Mark Goodenough (Ranger M)
* Mikolaj Machowski (Emdot)
* Murray Cook (Zhukov)
* Peter Geinitz (Shadow)
* Richard Kettering (Jetrel)
* Sangel
* Samuel Wilson (megane)
* Scott Klempner
* Vincent Langner (Vyncyn) — Spider Lich and Human Commander sprites
* Zerovirus — Naga Hunter sprite
=== Miscellaneous ===
* Fabian Müller (Fabi/Fendrin)
* Mark Polo
* Matthias Schoeck (mattsc) — Messenger AI
* Isaac
* Ringcaat (Thorin N. Tatge)
* And special thanks to everyone else who I forgot to mention.
== Descent Into Darkness ==
=== Original Campaign Design ===
* esci
=== Latest Campaign Revision ===
* nemaara
=== Artwork and Graphics Design ===
* Blarumyrran — story images
* Emilien Rotival (LordBob) — current portraits
* theycallmerooster — old portraits
=== Miscellaneous ===
* josteph — dialogue comments and revisions
== Dead Water ==
=== Campaign design and programming ===
* Dan Gerhards (beetlenaut)
=== Script-doctoring and cleanup for mainline ===
* Eric S. Raymond (ESR)
=== Artwork ===
* Kathrin Polikeit (Kitty) — Portraits for brawler, Kai Krellis, Gwabbo, and Caladon
* Justin Nichols (JustinOperable) — Portrait for Cylanna
* Zerovirus — Kai Krellis sprites
* Francisco Muñoz (fmunoz) — Attack icons
== The Rise Of Wesnoth ==
=== Campaign Design ===
* James Spencer (Shade)
=== Campaign Maintenance ===
* Dimitar Ilccov (Mythological)
* Lari Nieminen (zookeeper) — current maintainer
* Scott Klempner
=== Artwork and Graphics Design ===
* Blarumyrran — the new Vampire Lady sprite
* J.W. Bjerk (eleazar)
* Lari Nieminen (zookeeper)
* Emilien Rotival (LordBob) — new portraits and story art
* Michael Gil de Muro (grp21) — old portraits
* pixelmind — Shek'kahan portrait
=== WML Contributors ===
* Iris Morelle (Irydacea/shadowm)
* Lari Nieminen (zookeeper)
== The Hammer of Thursagan ==
=== Author ===
* Eric S. Raymond (esr)
=== Special Guest Designer ===
* Taurus
=== Art ===
* Kim Holm (DUHH)
* Phil Barber (thespaceinvader)
* Vincent Langner (Vyncyn) — New Dwarvish Witness line sprites and animations
=== Brainstorming, playtesting, and spousal support ===
* Cathy O. Raymond
=== Campaign Maintenance ===
* Charles Dang (vultraz)
== Eastern Invasion ==
=== Campaign Design ===
* Joseph Simmons (turin)
=== Campaign Maintenance ===
* Dimitar Ilccov (Mythological)
* Lari Nieminen (zookeeper) — current maintainer
* Astrid Halberkamp
=== Campaign Epilogue and Continuity ===
* Eric S. Raymond (ESR)
=== Prose and Story Edits ===
* Loci
=== Artwork and Graphics Design ===
* Aaron Redfern (A-Red) — New Owaec sprites
* Emilien Rotival (LordBob) — new portraits
* James Woo (Pickslide) — old portraits
* Neoriceisgood
[[Category:Generated]]

Download

2021-10-25T17:55:54Z

Shadowm: space

Welcome to the ''Battle for Wesnoth'' downloads page. The BfW project team officially releases the source code and builds for Windows, macOS, and various Linux distributions.

If the latest binaries are not currently available for your OS, please check back in a few days to see if they have been placed here. Packagers have been informed of the release, please be patient. In the meantime, read the [[FAQ#A_new_version_is_out.2C_but_where_is_the_download_for_.5BWindows.2C_Mac_OS_X.2C_etc..5D.3F|FAQ]].

__NOTOC__
== Stable (1.16 branch) ==
1.16.x is the current stable branch. These releases are recommended for most players, as they provide a well-tested and balanced game experience with only occasional bug-fix updates. Each version of this branch is compatible with each other. The online player community for it is also the largest and the add-ons server has a vast selection of content.
{{StableDownload}}

==== GNU/Linux ====
* There are binaries for many different GNU/Linux distributions. Not all are always up to date with the current release. Please have a look at the [[WesnothBinariesLinux|Linux binary page]] for more information about the binaries for your distribution.

==== Miscellaneous ====
* [https://sourceforge.net/projects/wesnoth/files/ SourceForge page for current and all previous versions]

== Development (1.15 branch) ==
1.15.x is the current development branch, boasting new exciting features. However, there may be occasional bugs or performance problems in these releases. Content creators, coders, and players who want to preview the future of Wesnoth may be interested in checking out our work in this branch.

People familiar with version control systems and building the game from source may follow Wesnoth development even more closely using the [[WesnothRepository|Git repository]] instead.
{{DevDownload}}

==== GNU/Linux ====
* There are binaries for many different GNU/Linux distributions. Not all are always up to date with the current release. Please have a look at the [[WesnothBinariesLinux|Linux binary page]] for more information about the binaries for your distribution.

==== Miscellaneous ====
* [https://sourceforge.net/projects/wesnoth/files/ SourceForge page for current and all previous versions]

== License ==
''Main article: [[Wesnoth:Copyrights]]''

This program is free software; you can redistribute it and/or modify it under the terms of the [https://www.gnu.org/licenses/gpl-2.0.html GNU General Public License version 2], as published by the [https://www.fsf.org Free Software Foundation], or at your option, any later version.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. See the GNU General Public License for more details.

Some assets included with the game are provided under the terms of the [https://creativecommons.org/licenses/by-sa/4.0/ Creative Commons Attribution-ShareAlike 4.0 license].

== See also ==
* [https://changelog.wesnoth.org/1.14 Changelog for the stable version]
* [https://changelog.wesnoth.org Changelog for the development version]
* [[WesnothRepository]] - bleeding edge version from the repository

[[Category:Building and Installing]]

Screenshots

2021-10-24T06:56:18Z

Shadowm:

== Wesnoth 1.16 ==
<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-1.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-1-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-2.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-2-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-3.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-3-192.jpg]
</center>

<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-4.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-4-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-5.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-5-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-6.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-6-192.jpg]
</center>

<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-7.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-7-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-8.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-8-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-9.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.16.0-9-192.jpg]
</center>

== Wesnoth 1.14 ==
<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-1.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-1-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-2.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-2-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-3.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-3-192.jpg]
</center>

<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-4.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-4-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-5.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-5-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-6.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-6-192.jpg]
</center>

<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-7.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-7-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-8.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-8-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-9.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-9-192.jpg]
</center>

<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-10.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-10-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-11.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-11-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-12.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.14.0-12-192.jpg]
</center>

== Wesnoth 1.12 ==
<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-1.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-1-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-2.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-2-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-3.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-3-192.jpg]
</center>

<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-4.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-4-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-5.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-5-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-6.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-6-192.jpg]
</center>

<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-7.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-7-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-8.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-8-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-9.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-9-192.jpg]
</center>

<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-11.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-11-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-12.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-12-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-13.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.0-13-192.jpg]
</center>

<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.4-1.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.4-1-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.4-2.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.4-2-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.4-3.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.4-3-192.jpg]
</center>

<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.4-4.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.4-4-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.5-1.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.5-1-192.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.12.5-2.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.12.5-2-192.jpg]
</center>

== Wesnoth 1.11.8 ==
<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.11.8-1.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.11.8-1-175.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.11.8-2.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.11.8-2-175.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.11.8-3.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.11.8-3-175.jpg]
</center>

<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.11.8-4.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.11.8-4-175.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.11.8-5.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.11.8-5-175.jpg]
</center>

== Wesnoth 1.11.7 ==
<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.11.7-1.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.11.7-1-175.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.11.7-2.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.11.7-2-175.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.11.7-3.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.11.7-3-175.jpg]
</center>

<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.11.7-4.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.11.7-4-175.jpg]
</center>

== Wesnoth 1.11.6 ==
<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.11.6-1.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.11.6-1-175.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.11.6-2.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.11.6-2-175.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.11.6-3.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.11.6-3-175.jpg]
</center>
<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.11.6-4.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.11.6-4-175.jpg]
</center>

== Wesnoth 1.10 ==
<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.10-1.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.10-1-175.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.10-2.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.10-2-175.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.10-3.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.10-3-175.jpg]
</center>
<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.10-4.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.10-4-175.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.10-5.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.10-5-175.jpg]
</center>

== Wesnoth 1.9.0 ==
<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.9.0-1.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.9.0-1-175.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.9.0-2.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.9.0-2-175.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.9.0-3.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.9.0-3-175.jpg]
</center>
<center>
[https://www.wesnoth.org/images/sshots/wesnoth-1.9.0-4.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.9.0-4-175.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.9.0-5.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.9.0-5-175.jpg]
[https://www.wesnoth.org/images/sshots/wesnoth-1.9.0-6.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.9.0-6-175.jpg]
</center>

== See also ==
* [[Older Screenshots]]
* [[Ancient Screenshots]]

__NOTOC__

[[Category:Art and Screenshots]]

Credits

2021-10-23T06:14:34Z

Shadowm: Credits update in preparation for the 1.16.0 release

<div class="tright"> __TOC__ </div>
__NOEDITSECTION__
In July 2003, '''David White''' released the first version of Wesnoth. Since
then, many people have joined the project, contributing in very different ways.

To make any changes to this list, please modify
<code class="noframe">about.cfg</code> in the repo or ask any developer to do
it for you.

== Core Contributors ==
=== Programming ===
* [mailto:dave@whitevine.net David White] (Sirp) — Founding Developer
<hr style='clear:none'>
* [mailto:AI0867@gmail.com Alexander van Gessel] (AI/AI0867)
* Alfredo Beaumont (ziberpunk) — autotools
* Ali El Gariani ([[User:Alink|alink]]) — coder, bug fixes, optimizations, interface usability
* András Salamon ([[User:Ott|ott]]) — QA, bug fixing, subediting, game mechanics
* Andreas Löf (Aginor)
* Anonymissimus — bug fixes and features mostly related to the wml engine or lua interface
* [mailto:artemkhrapov2001ATyandexDOTru Artem Khrapov] ([[User:Kabachuha|kabachuha]]) — addons server rework, incremental updates and uploads feature; i18n, UI and quality of life improvements; bugfixes
* [mailto:dragonking@o2.pl Bartek Waresiak] (Dragonking) — unit balancing, Formula AI
* Benoît Timbert ([[User:Noyga|Noyga]])
* Bram Ridder (Morloth) — editor improvements
* [mailto:bruno@wolff.to Bruno Wolff III] ([[User:bruno|bruno]]) — campaign web interface, bug fixing, minor coder
* Cameron Morland
* Cédric Duval — coder, internationalization manager
* Charles Dang (vultraz) — General fixes, cleanup and improvements to various areas.
* Chris Beck (iceiceice/involution) — Bug fixes and features esp. engine-related or multiplayer-related. Added WML unit testing system, improvements to travis-CI.
* Celtic Minstrel
* Daniel Franke (dfranke)
* Daniel (gfgtdf)
* David Hilton
* Dominic Bolin (Xan)
* Elias Pschernig (allefant)
* Elvish_Hunter
* Eric S. Raymond (ESR) — Macro library reorganization, major UI makeover introducing lightweight transparent popups and linger mode, maintenance tools for WML, eight campaigns lifted from UMC, one all-original campaign, editor refactoring, many many code cleanups, and svn-to-git migration.
* Eugen Jiresch (euschn) — savegame improvements
* [mailto:fabianmueller5_at_gmx.de Fabian Müller] ([[User:fabi|fabi/fendrin]])
* [mailto:gabrielmorin~_-AT-_~gmail.com Gabriel Morin] (gabba) — Whiteboard project, naming hotseat players, delay shroud updates on game start.
* Greg Copeland (Oracle) — coding; Server optimizations.
* Gregory Lundberg (TadCarlucci) — Cleanup of campaigns code
* [mailto:cornmander@cornmander.com Gregory Shikhman] (corn) — coding; upload log maintenance/improvements
* Guillaume Melquiond (silene) — coding, bug fixes
* [mailto:billybiset@gmail.com Guillermo Biset] (billynux) — Bug fixer, remover of upload stats, network module rewrite, ANA, boost::asio
* [mailto:shadowm2006@gmail.com Iris Morelle] ([[User:Shadowm|Irydacea/shadowm]]) — Miscellaneous WML, i18n and UI features, improvements and bugfixes; refactoring and extension of add-ons management code; features and refactoring of image-path functions mechanism; cache manager UI and paths/game version dialog; campaignd refactoring and maintenance
* Jérémy Rosen ([[User:Boucman|Boucman]]) — coder
* [mailto:mcnabb@gravity.psu.edu John W. C. McNabb] (Darth Fool) — coder, graphics
* Jon Daniel (worduk) — coder, bug fixes
* Jörg Hinrichs (Yogi Bear/YogiHH)
* [mailto:justin.zaun@gmail.com Justin Zaun] (jzaun) — coder, scenario designer
* Jyrki Vesterinen
* Karol Nowak (grzywacz) — bug fixes, sound sources, gp2x port
* [mailto:erl@erl.se Kristoffer Erlandsson] (erl) — help system, editor
* [mailto:lao.geek@gmail.com Lao] ([[User:lao|lao]]) — bug fixes and candidate to GSoC 2008
* Mark de Wever ([[User:SkeletonCrew|Mordante/SkeletonCrew]]) — coder, bug fixes, various features, multi-letter terrain system, gui system.
* Martin Renold (maxy/martinxyz) — performance and gui bug fixes
* Matthias Kretz — optimizations
* Moritz Göbelbecker (mog) — Work on the terrain engine
* Nicolas Weeger (Ryo) — Python API
* [mailto:patrick_x99@hotmail.com Patrick Parker] ([[User:Sapient|Sapient]]) — improvements to user interface, WML engine, various features
* [mailto:paniemin@cc.hut.fi Pauli Nieminen] (suokko) — Bug fixing; usually targeting MP or WML engine
* [mailto:philippe.plantier@naema.org Philippe Plantier] ([[User:Ayin|Ayin]]) — several parts of the code, notably terrain graphics code
* Rusty Russell (rusty)
* Sergey Popov (loonycyborg) — scons
* singalen — iOS port
* Soliton — bug fixes and various small features usually in multiplayer context
* Steve Cotton (octalot)
* Steven Oxley (xonev)
* Thomas Baumhauer (Baufo)
* [mailto:timotei21@gmail.com Timotei Dolean] (timotei) — Eclipse UMC plugin
* Tomasz Śniatowski (ilor) — Editor
* [mailto:ydirson@altern.org Yann Dirson] — gettext support, tinygui
* [mailto:terraninfo@terraninfo.net Yurii Chernyi] (Crab) — AI
=== General Purpose Administration and Coordination ===
* Charles Dang (vultraz) — Current release manager (1.13.3-present)
<hr style='clear:none'>
* Crossbow/Miyo — Past release manager
* [mailto:shadowm2006@gmail.com Iris Morelle] ([[User:Shadowm|Irydacea/shadowm]]) — Past release manager (1.12.1-1.12.6 / 1.13.0-1.13.2)
* [mailto:isaac@sindominio.net Isaac Clerencia] — Past release manager, Debian packager
* [mailto:Crazy-Ivanovic@gmx.net Nils Kneuper] (Ivanovic) — Past release manager, internationalization manager, OpenPandora packager, A Tale of Two Brothers, German translation
* Noy — General purpose administration, unit balancing
* Pentarctagon
=== Internationalization Managers ===
* Cédric Duval — coder, internationalization manager
* David Philippi (Torangan) — internationalization manager, wescamp
* Mark Michelsen (skovbaer) — Slackware packager
* [mailto:Crazy-Ivanovic@gmx.net Nils Kneuper] (Ivanovic) — administrator, release manager, internationalization manager, OpenPandora packager, A Tale of Two Brothers, german translation
* [mailto:susanna.bjorverud@telia.com Susanna Björverud] (sanna)
=== Trailers ===
* ancestral — 1.12 trailer
* Pedro Caseiro (Kasdel) — 1.14 trailer
* Felix Merveille (felixmerveille) — 1.16 trailer edits and additions
=== Artwork and Graphics ===
* Emilien Rotival (LordBob) — portrait director - focus on loyalists, trolls, monsters
* Francisco Muñoz (fmunoz) — founding artist and former lead artist, worked consistently on all aspects till around v0.7-0.9.
* Hogne Håskjold (frame/freim) — terrain art director, made much of the current terrains (esp. mountains)
* J.W. Bjerk ([[User:Eleazar|Eleazar]]) — terrain art director (esp. Chasm, Cave, Water), sprite animations, various visual tweaks
* James Woo (Pickslide) — portraits (major focus on orcs and campaigns, especially UtBS, TEI, TSoF)
* Kathrin Polikeit (Kitty) — portrait director - focus on mages/necromancers, elvish, naga, merfolk, and troll unit trees
* Lari Nieminen (zookeeper) — sprite animation, various visual tweaks, titlescreen and campaign maps (v1.11+), water animations (v1.13+)
* Neoriceisgood — sprite creator and animator (major focus on drakes, dwarves, saurians)
* Pekka Aikio (pekka) — tiles, esp. castles, and attack icons
* Phil Barber (thespaceinvader) — Dwarf and Saurian portraits, most of the drake animations, and a large amount on other stuff, esp. the dwarves.
* Richard Kettering ([[User:Jetryl|Jetrel]]) — art director/slave, major focus on sprites, portraits, buildings, and icons
* Timo Honkasalo (Sgt. Groovy) — New high-res logo for the game
<hr style='clear:none'>
* Alex Jarocha-Ernst (Jormungandr) — portraits
* Christophe Anjard (Christophe33) — made many of the old (c. v0.6) terrains, and some sprites for the dwarves
* Erkki Lonkainen (Eternal) — created and animated many replacement sprites (esp. ogre, orc assassin & spear units, and cockatrice)
* Jason Lutes — portraits (major focus on humans, some campaign portraits)
* Johann de Venecia (Johann) — drew the new campaign story art for HttT
* Leonhard — made several of the new attack icons
* Marcus Rosén (sleepwalker) — Animations (esp. Saurians, Dwarves, Horseman), dunefolk sprites, and portraits (Mermaid Initiate & Dune Herbalist)
* Mark Goodenough (Ranger M) — sprite animator
* Maximiliano Buis (Redeth) — Made nearly all of the idle animations, and some death animations (as of 1.3.1)
* Michael Gil de Muro (grp21) — portraits (for the campaign 'The Rise of Wesnoth')
* Moritz Göbelbecker (mog) — tiles, esp. swamp, encampment, ice, and work with lava/chasm
* Niall Burton (Leonard03) — Minimalistic logo render
* Peter Geinitz (Shadow/Wayfarer) — sprite creator and animator
* Robert Bolin (Zebulon) — tiles, sprite editing and animations
<hr style='clear:none'>
* Andrew James Patterson (Kamahawk) — sprites
* antwerpz — sprite creator/animator for old saurian units
* Diego Brea (Cobretti) — sprite creator/animator
* EEL (EELuminatus) — sprite animator, provided death animations for the woses, some of the orcs, and an attack animation for the revenant
* Eli Dupree (Elvish Pillager) — sprites and animations
* Eric Holdos (Rev. V!)
* Gareth Miller (Gafgarion) — made some early sprites/tiles
* Gerald Clears (Smok'em Jags) — sprite animator
* James Barton (Sangel) — sprites
* Jami — rogue death and red mage idle animations
* Jerzy Brzozowski (Mefisto) — Various sprites and animations, tropical forests.
* Jesse Holland (Kestenvarn) — map illustrator of old titlescreen and campaign maps (v1.1 - v1.10)
* Johanna Manninen (lohari) — edited tiles, ported freeciv tiles used in very early versions of wesnoth
* John Muccigrosso (Eponymous Archon) — made some early sprites, such as the human bowmen
* Kuno Raffin (lurker) — Various terrain artwork
* Michael Mielewczik (Mille) — sprite animator
* Mikko Kraft (Deserter) — sprite animator
* Musketaquid — animated windmill / stone path
* Slainte — made sprites for c. v0.6 mages, also made many of the old attack icons
* Simon Forsyth (Alarantalara) — cave terrain
* Stephen Metcalf (Neoskel) — major help with shadow standardization (over half the units), made some missing zombie variants
* Stephen Stone (Disto) — sprite animator
* Svetac — made many of the old attack icons
* Tristan Millner (tatmf) — made old portrait of dwarven fighter
* Zhukov — sprite animator
<hr style='clear:none'>
* Aaron Redfern (A-Red) — Sprites and animations
* Adrian Sheehy (Major) — various sprites animations
* Alexander Brown (Cloud) — Sprite animations
* Anton Ecker (Kaldred) — burnt villages
* battlestar — - some scenery graphics including burnt tent.
* Ben Wenzel (artisticdude) — Sprite animations
* Blarumyrran — New storm trident, staff and ankh item pictures, various attack icons, river ford tiles, drake and human city villages
* Bora Orcal (bera) — Goblin portrait sketches
* Cernunnos — merfolk villages
* Charles Dang (vultraz) — Icons for new editor and updated terrain icons
* Chris Wilson (Valkier) — portraits
* Christian Sirviö (Girgistian) — portraits (sketches), and some attack animations for the orcs
* Clinton Bell — various animations
* Dan Gerhards (beetlenaut) — various sprites and animations
* Daniel Borgmann (dborg) — semi-transparent map grid
* Daniel Foerster (pydsigner/pyndragon) — Icon overlays for the About dialog button
* Kwandulin — Standing animations (Skeleton Archer, Bone Shooter, Orcish Archer, Dwarvish Fighter, Ulfserker, Stalwart, Runesmith), minor fixes
* doofus-01 — orcish fort and villages, desert mountains, mine walls, sea forts, portraits for walking corpse and soulless
* Elena Astanina (ayona) — log-cabin villages
* Eric Butler (Erk) — desert and merfolk villages
* Evan Crook (Flametrooper) — sprite animator (TC conversion)
* Garrett Wessner (Stilgar) — gold coin pile
* Gideon Chia (Deonjo) — new 'units' icon for general status bar
* Guangcong Luo (Zarel) — Multiplayer status icons for 1.7.x
* Highhole — revised storm trident
* Homunculus — dead great tree terrain
* [mailto:shadowm2006@gmail.com Iris Morelle] ([[User:Shadowm|Irydacea/shadowm]]) — Minor item/unit edits; animated lit brazier; ported gryphon rider animation to generic gryphon; Ancient Lich for 1.12.x
* Irrevenant — Skeleton archer death and recruit animations, new ankh touch ups, new dark adept touch ups, elvish marshal standing animation
* Irwin Ismail (Swordy) — original projectile/attack icon for chakram
* Jason Frailey (Valdroni) — scorpion portrait
* Jimmy Olsson (Azlan) — made old icons for windows version
* Joakim Persson (JAP) — Knalgan flag set
* John Mercer (Stern) — Giant Rat graphics
* John-Robert Funck (XJaPaN) — sprite animator
* Jonatan Alamà (tin) — made red logo used until before v1.0
* Justin Nichols (JustinOperable) — Portrait artwork
* Kim Holm (DUHH) — Portrait artwork
* Lukasz Wawrowski (inferno8) — Drake attack icons with fmunoz and map backgrounds for Isar’s Cross
* Lordlewis — mace item sprite
* Mattias Westlund (West) — new color cursors
* Nicholas Kerpan (Thrawn) — human thief portrait
* Pixelmind — various animations
* Randall Walls (slightcrazed) — sprite animator
* rhyging5 — various animations
* RusHHouR — New signpost (1.4.1)
* Samuel Wilson (megane) — random dice icon fix after 1.4.0
* Santiago Iborra (Quellion) — Portrait artwork
* Simeon Dear (Trilby) — Sprite animations
* Zoomo — Sprite animations
* Zaggy1024 — Wolf rider death animation
* Eisfrei — Elvish shaman idle animations
* Happy Wose — Wose idle frames and Elder wose death animation
* Wolfy — Female arch mage idle animation
* mystic x the unknown — Mage death animation
* Sonny T Yamada (SkyOne) — shadow standardization of many campaign units
* Vincent Langner (Vyncyn) — Walking Corpse and Soulless wolf variations, young roc base and attack sprite
* ZygoUgo — Giant Rat portrait
* ghype — sprite animation and dunefolk base frames
=== Music ===
* Aleksi Aubry-Carlson (Aleksi)
* Doug Kaufman (dkaufman) — http://dougkaufman.net/
* Gianmarco Leone (gmlion)
* Jeremy Nicoll (jeremy2/eltiare)
* Joseph Toscano (ZhayTee) — zhaymusic.com
* Mattias Westlund (West) — music coordinator/composer
* Ryan Reilly (Rain)
* Stephen Rozanc (TreizeCouleurs)
* Timothy Pinkham (TimothyP)
* Tyler Johnson
=== Sound Effects ===
* Corey Woodworth (woodwizzle) — hit and die sounds
* J.W. Bjerk ([[User:Eleazar|Eleazar]])
* Lari Nieminen (zookeeper) — focus on attack, weapon and user interface sounds
* Adam Rinsky (Action Jack) — dwarf hit and die sounds
* Leonardo Magno Sampaio (leorock116) — mace, staff and club sounds
=== Campaign Design ===
* Asa Swain (quartex) — Under the Burning Suns
* Astrid Halberkamp — Campaign maintenance and various improvements
* Benjamin Drieu
* Charles Dang (vultraz) — Campaign maintenance and various improvements
* Dacyn
* Dan Gerhards (beetlenaut) — Dead Water, Secrets of the Ancients
* David White (Sirp) — Heir to the Throne
* Eric J. Mesoy (Circon) — A Tale of Two Brothers
* Eric S. Raymond (ESR) — The Hammer of Thursagan
* esci — Descent into Darkness
* Francisco Muñoz (fmunoz) — founding artist and former lead artist, worked consistently on all aspects till around v0.7-0.9.
* James Spencer (Shade) — The Rise of Wesnoth
* Jeffrey 'Sigurd' Westcoat (SigurdFireDragon)
* Joseph Simmons (Turin) — The Eastern Invasion, The Sceptre of Fire
* Justin Zaun (jzaun) — coder, scenario designer
* Lari Nieminen (zookeeper) — redesign of various scenarios and other enhancement
* [mailto:Crazy-Ivanovic@gmx.net Nils Kneuper] (Ivanovic) — A Tale of Two Brothers
* Santi/fnaek — The Legend of Wesmere
* Scott Klempner — Heir to the Throne, The Rise of Wesnoth, Liberty
* Taurus — Northern Rebirth, Son of the Black-Eye
* William Carey (aelius) — The South Guard
=== Multiplayer Maps and Balancing ===
* George Birthisel (happygrue/Wintermute) — Unit balancing, Dunefolk Era
* Hejnewar — balancing for Age of Heroes, revised dunefolk
* Jake Bailey (jb) — multiplayer maps
* Joshua Northey (Becephalus) — multiplayer maps (mostly 2vs2 and up)
* Mike Quiñones (Doc Paterson) — multiplayer maps (mostly 1vs1)
* Noy — general purpose administration, unit balancing
* Peter Groen (pg) — multiplayer maps
* Ruben Philipp Wickenhäuser (The Very Uhu) — multiplayer maps
* Soliton — unit balancing
* Tom Chance (telex4) — multiplayer maps
* [mailto:kleinfel@wpi.edu Zack Kleinfeld] — multiplayer maps, unit balancing
=== Packagers ===
* ancestral — Apple OS X packager (1.12.1 and later)
* [mailto:hrubymar10@gmail.com Martin Hrubý] ([[User:hrubymar10|hrubymar10]]) — Apple macOS packager (1.13.11 and later)
* Matthias Schoeck (mattsc) — Apple OS X packager (1.11.8 and later)
* [mailto:Crazy-Ivanovic@gmx.net Nils Kneuper] (Ivanovic) — OpenPandora packager
* Rhonda D'Vine (Rhonda) — Debian/Ubuntu packager
* Sebastian Kölle (aquileia) — Visual Studio SDK maintainer
* Sergey Popov (loonycyborg) — Microsoft Windows packager and MinGW SDK maintainer
* [mailto:ports@toco-domains.de Torsten Zühlsdorff] — FreeBSD Packager
* Vincent Cheng (vincent_c) — Debian/Ubuntu packager
<hr style='clear:none'>
* [mailto:ben@happyspork.com Ben Anderman] (crimson_penguin) — Apple OS X packager (for 1.5.6 and later)
* Cyril Bouthors (CyrilB) — Debian packager, patron
* Darryl Dixon
* edge
* Isaac Clerencia — Debian packager
* Jay Hopping
* Jörg Hinrichs (Yogi Bear/YogiHH) — Microsoft Windows packager
* Laurent Wacrenier (lwa) — Apple OS X packager (for v1.4 and before)
* Marcin Konicki (ahwayakchih) — BeOS packager
* Marcus Phillips (Sithrandel) — Apple OS X packager (for v1.0 and before)
* Mark Michelsen (skovbaer) — Slackware packager
* Muhammad Amir Ayub (anakayub) — Apple OS X packager
* Piotr Cychowski (Mist/cycholka) — Microsoft Windows packager
* singalen — iOS port
* Simon Forsyth (Alarantalara) — Apple OS X Packager (1.9.6 and later)
* Vlad Glagolev (Stealth) — OpenBSD packager
=== Miscellaneous Contributors ===
* Aaron Keisch-Walter (Exasperation)
* Aaron Winter (Byteron)
* Adam Leffew
* Adrian Iosif (Zappaman)
* Aishiko — Unit instance recall cost implementation
* Alek Bollig (binarycoder)
* Alesis Novik
* Aline Riss (akihara)
* Amir Hassan (kallaballa)
* Andris Szell (bandita137)
* André Knispel
* Andrea Palmatè (afxgroup)
* Andrius Šilinskas (thunderstruck)
* Andrius Štikonas
* Anja Keicher (ayne)
* Astrid Halberkamp
* Ben Anderman (crimson_penguin) — unit list
* Boldizsár Lipka (lipk)
* Brilliand
* Burkay Özdemir (Velory) — Poisoning improvement for Formula AI
* chisquare130
* Chris Carpenter (mordocai)
* Chris Hopman (cjhopman)
* Chris Mann (WildPenguin) — Emacs WML-mode
* Chusslove Illich (caslav.ilic) — wmlxgetext improvements
* David Slabý (blaf)
* Daniel Bruegmann
* David Mikos (Coffee) — Coder, animation framework improvements.
* Denny Vaccaro (endercoaster)
* Derek (Gambit)
* devnexen
* DisherProject
* Dmitry K. (nephro)
* Doug Rosvick ([[User:dlr365|dlr365]])
* dorng
* dreamer-88
* Dugi — Context-free name generator
* Duthlet
* EarthCake
* Edward Chernenko
* Ekdohibs
* elvish_sovereign
* Ely Levy (Nakee)
* Étienne Simon (ejls)
* Etkin Baris Ozgul (pokhbocee) — Lua AI
* Eugene Kosov (kevg)
* [mailto:eugeni.stepanov@gmail.com Evgeniy Stepanov] — NativeClient port
* Evgeny Kapun
* FAAB
* Federico Pasco (neverEnough)
* Fedor Khod'kov (teddy/fkhodkov)
* Felix Bauer (flix)
* Fernando Carmona (Ferk)
* Floris Kint (Grimling)
* Francesco Gigli (Jaramir)
* Frank Richter (res)
* Frédéric Wagner
* Fredrik Wikstrom (salass00)
* galegosimpatico
* Galen Brooks (fluffbeast)
* gh0st — 2012 Google Code-in Students' Micro AI development
* Gregory Gauthier (rjaguar3)
* Groggy Dice (groggydice) — wmllint enhancements
* [mailto:kevin.xgr@gmail.com Guorui Xi] (Kevin_Xi)
* Hans-Joachim Gurt (HaJo)
* Herb Pah (haiz)
* holius-fr
* IceTyp
* ilyapopov
* J. Tyne (JaMiT)
* J.R. Blain (Cowboy)
* jstitch
* Jacek Kominek (BroodKiller)
* [mailto:benetnash@icpnet.pl Jan Polak] (benetnash) — Formula AI contributions
* Jan Zvánovec (jaz)
* [mailto:babataz@gmail.com Jean-Baptiste Poittevin] (BBT)
* Jeff Breidenbach (jab) — Bilinear interpolation
* [mailto:jleldridge27@gmail.com Jeffrey Eldridge] (jleldridge)
* Jérôme (segfault)
* Jim Carroll (Jimm)
* Jody Northup (Upthorn) — Prospective student (world persistence)
* Joeri Melis
* Joey L. Maalouf (JDog)
* [mailto:john@jo.hnanthony.com John Anthony] — campaignd work, mainly security-based
* John B. Messerly (jbm)
* John Harvey (johndh) — minor race descriptions; bats, goblins, mechanical, merfolk, monster, naga, ogre
* Jonathan Combs (ScegfOd) — log activating dialog
* Jonas Lihnell (Roze)
* Jonas Kölker
* [mailto:jorda@ettin.org Jordà Polo] (ettin) — website, i18n, ui
* Josef Reidinger (qk)
* Joseph Gelfand
* Joshua Hudson
* josteph
* Jozrael
* Justin DiSabatino (Turuk)
* Kamil Kaczmarczyk (lampak)
* [mailto:karl.miller.km@gmail.com Karl Miller] (karlm)
* Karol Kozub (automagic)
* Kevin Montalva (Ryckes)
* Kevin Yap (iKevinY)
* Konrad Schwede (Konrad2)
* Kristoffer Grönlund (kegie)
* Krogen
* Laurent Birtz
* legoktm
* leonardoInf
* lilinitsy
* Lovens Weche (LovCAPONE)
* Luiz Fernando de Faria Pereira (lfernando)
* [mailto:lutheroto@gmail.com Luther Thompson]
* lv-zheng
* [mailto:code@hryniuk.pl Łukasz Hryniuk]
* Maksim Orlovich (SadEagle)
* Mark McGuire (TronPaul)
* Martin Bede — 2012 Google Code-in Students' Micro AI development
* [mailto:hrubymar10@gmail.com Martin Hrubý] ([[User:hrubymar10|hrubymar10]])
* Mateusz Kolaczek (PL_kolek)
* Matt Renfer (Des) — Prose revision
* Matthias Schoeck (mattsc) — AI improvements
* matthiaskrgr — Running address sanitizer to catch leaks
* Maxim Biro (nurupo)
* Maximilian Fricke (madmax28)
* Maximilian Lupke (malumalu)
* Marius Spix (spixi)
* Michael Flowers (MJ)
* Michael Schmahl
* Michael Strebel (Nostromus)
* midzer
* Miguel Zapico (elricz)
* mstrebel
* [mailto:greywhind@users.sourceforge.net Nathan Partlan] ([[User:Greywhind|Greywhind]])
* [mailto:nathan.b.walker@vanderbilt.edu Nathan Walker] (RiftWalker)
* neoedmund
* newfrenchy83
* Niall Burton (Leonard03)
* niegenug
* Nobun — wmlxgettext
* [mailto:zabivator@gmail.com Oleg Tsarev]
* Olivier Faure (PoignardAzur)
* [mailto:asqueados@gmail.com Pablo J. Urbano Santos] ([[User:Lord Ork|Lord Ork]])
* Patryk Obara (dreamer_)
* Paul Smedley (Creeping)
* Paŭlo Ebermann ([[User:Pauxlo|Pauxlo]])
* PBechon
* Peter Elmers
* Peter Mawhorter ([[User:solsword|solsword]]) — Python TC script upgrade
* Petr Sobotka (Pietro)
* [mailto:root@delroth.is-a-geek.org Pierre Bourdon] (delroth)
* pquentin
* Pranav Deshpande (universecoder)
* Priit Laes (plaes)
* Pubudu Gunawardena (ugudu)
* Qi Mo (qmo2015)
* Quetzalcoatl
* Randy Kostiuk (Randypk) — Bug fixes
* RatArmy (fujimo-t)
* Reuben Rakete (rocketbang)
* Richard Yao (srk9) — Bug fixes
* Rikard Falkeborn
* Robert Spencer — 2012 Google Code-in Students' Micro AI development
* Robert Wallace (Robertdebrus)
* Rocco J Carello (rogue)
* Roland Hautz (duncan_shriek)
* Rolf Sievers (Lizard)
* Ronny Standtke
* rrigby
* Ryan Frame
* Ryan Henszey
* Ryan Roden-Corrent (rcorre) — Hotkey release and scroll key rebinding
* [mailto:sachith500@gmail.com Sachith Seneviratne] (sachith500) — Bug fixes at the moment. GSoC Aspirant
* Samuel Kim — 2012 Google Code-in Students' Micro AI development
* Sean Yeh
* Sebastian Goll (afran)
* Sebastian Kölle (aquileia)
* Serge Martin (EdB)
* [mailto:stomasortiz@gmail.com Sergio Tomás Ortiz]
* Severin Glöckner (Shiki, Sevu)
* Simon Forsyth (Alarantalara)
* [mailto:simon_smith@zen.co.uk Simon Smith] ([[User:Simons_Mith|Simons Mith]]) — Style guide, help with the application of the style guide, and some tips
* SoapGentoo
* starius
* Stéphane Gimenez (gim)
* [mailto:Majora700@gmail.com Steven Panek] ([[User:Espreon|Espreon]])
* [mailto:sylecn@gmail.com sylecn]
* [mailto:nsytyi@gmail.com Sytyi Nick] (Sytyi) — WML validation
* [mailto:ptablot@mopong.net Talbot Pierre] (Trademark)
* Tamas K. (negusnyul)
* techtonik
* the_beagle — Wose race description
* The Gnat
* Thibault Févry (iwontbecreative) — Some GCI tasks and utils/wiki_grabber.py cleanup.
* Thom Diment (UnwiseOwl)
* [mailto:hankerspace@gmail.com Thomas Martinet] (hankerspace)
* [mailto:thomas.prevost@gmail.com Thomas Prevost] (zancdar)
* Thonsew
* Thorny23
* Tobias Frei (ToBeFree)
* Tomasz Sikorski (Tomsik)
* Tommy Schmitz
* Tommy (yobbo)
* Toom Lõhmus (Ravana)
* tsr
* Valentin Deschaintre (Zazweda, Epyde) — Zone guardian Micro AI
* vitiv — 2012 Google Code-in Students' Micro AI development
* [mailto:viy@altlinux.org viy]
* Vladimír Slávik — Miscellaneous text formatting and translation engine related help
* vn971, vgaming
* Wedge009
* Yang Yifan (Xara)
* Zas
=== Bots ===
* CIA
* irker
* janebot
* shikadibot
* wesbot
== Translators ==
=== Afrikaans Translation ===
* András Salamon (ott)
* Erhard Eiselen
* Len van Dalsen (Numbers13) — current maintainer
* Nico Oliver (nicoza)
* Renier Maritz
=== Ancient Greek Translation ===
=== Arabic Translation ===
* Amnay Mokhtari
=== Asturian Translation ===
=== Basque Translation ===
* Alfredo Beaumont (ziberpunk)
* Julen Landa (genars)
* Mikel Olasagasti (Hey_neken)
=== Bulgarian Translation ===
* Anton Tsigularov (Atilla)
* Bono Nonchev
* Denica Mincheva (Deni)
* Georgi Dimitrov (oblak)
* Ivan Petrov (TheWhiteKnight) — current maintainer
* Nikolay Vladimirov (Turki)
* Steven Genchev (blademaster83)
* Valentin Yankov (kartacha)
=== Catalan Translation ===
* Carles Company (brrr)
* Dan Rosàs Garcia (focks)
* Daniel López (Azazelo)
* Joan Queralt
* Jonatan Alamà (tin)
* [mailto:jorda@ettin.org Jordà Polo] (ettin)
* Jose Gordillo (kilder)
* J.R. Dolcet Castro (Malin Keshar)
* Marc Orcau
* Mark Recasens
* [mailto:miquel.angel.burgos@gmail.com Miquel-Àngel Burgos i Fradeja] — current maintainer
* Pau Rul·lan Ferragut
* Roberto Garcia (Motxales)
=== Chinese Translation ===
* AxalaraFlameheart (AxalaraFlame)
* Brian lee
* chisquare130
* [mailto:cloudidust@gmail.com CloudiDust] ([[User:CloudiDust|CloudiDust]]) — current maintainer
* cryaciccl
* Dionysus
* 逆天的高级菜鸟 (Gaojicainiao)
* Henry Zhu (Hardwood) — iOS announcements translation into Chinese
* Huang Hongye (Dugucloud) — translation and image localization
* Huang Huan
* Huang Lechuan
* leaf
* Luojie-dune
* MrKing
* 网上佳公子
* Owlet
* pianton
* SealMe
* spider5
* StephDC
* [mailto:sylecn@gmail.com sylecn]
* Teamzhangmeng
* vinneymail
* wind
* Yifan
* yym514
* zen
=== Chinese (Taiwan) Translation ===
* 楊綮銘
* 李昆融
* 李信融
=== Croatian Translation ===
* Ivica Đurenec (charlieh65)
* Nino Gunjača
=== Czech Translation ===
* Alexander Slávik (Olin)
* Anežka Bubeníčková (Bubu)
* Čestmír Houska
* David Nečas (Yeti)
* David Novotný (Draqen)
* [mailto:jan.dedic@gmail.com Jaromír Dědič]
* Karel Doleček
* Lukáš Faltýnek
* [mailto:hrubymar10@gmail.com Martin Hrubý] ([[User:hrubymar10|hrubymar10]])
* Martin Šín
* Michal Žejdl
* Mintaka
* [mailto:tapik@buchtovi.cz Oto Buchta] ([[User:Tapik|tapik]])
* Petr Kopač (Ferda)
* Petr Kovár (Juans)
* Rudolf Orság
* Septim
* Sofronius
* Vít Komárek
* Vít Krčál
* Vladimír Slávik
=== Danish Translation ===
* Anders K. Madsen (madsen)
* Ask Hjorth Larsen
* Bjarke Sørensen (basher)
* Jesper Fuglsang Wolff (ulven)
* Joe Hansen
* Kenneth Nielsen
* Mark Michelsen (skovbaer)
* Mathias Bundgaard Svensson (freaken)
* Ole Laursen
=== Dutch Translation ===
* [mailto:AI0867@gmail.com Alexander van Gessel] (AI/AI0867) — previous translation maintainer
* Arne Deprez
* Astrid Halberkamp
* Floris Kint (Grimling)
* Foppe Benedictus
* [mailto:oudshoorn@eitri.nl IJsbrand Oudshoorn]
* Joeri Melis
* Jon Jacobs
* Koen Douterloigne
* Koen Vervloesem (koan)
* Lala
* Maarten Albrecht
* Merijn de Vet — translation maintainer
* Pieter Vermeylen (Onne)
* Rico van Coevorden
* Rob van der Vleugel
* Roel Thijs (Roel)
* Roger Koot
* Thomas Hugo de Groot
* Tobe Deprez
* WimPapa
=== English (GB) Translation ===
* András Salamon (ott)
* Eric S. Raymond (ESR)
* pjr
* [mailto:Majora700@gmail.com Steven Panek] ([[User:Espreon|Espreon]])
* Thomas Hockings ([[User:Deusite|Deusite]])
* Wedge009
=== English (Shaw) Translation ===
* [mailto:arcriley@ubuntu.com Arc Riley] ([[User:ArcRiley|ArcRiley]]) — translation maintainer
* [mailto:reportingsjr@gmail.com Jon Neal] (reportingsjr)
* [mailto:thomas@thurman.org.uk Thomas Thurman] (marnanel)
=== Esperanto Translation ===
* Aleksej Korgenkov (Grimpanto)
* Francesco Lorenzon (Likso)
* Ľubo Fajth
* Maarten Albrecht
* Rastislav Šarišský (Asto)
=== Estonian Translation ===
* Kaido Kikkas (UncleOwl)
* Mart Tõnso
=== Filipino Translation ===
* Joset Anthony Zamora (eradicus)
* Karen Eve Eso (keeve)
=== Finnish Translation ===
* Ankka
* Jarkko Patteri (Jarkko)
* Jussi Rautio (jgrr)
* kko
* Matias Parmala
* Matias Pigg
* Mikko Nikkilä (Miccoh)
* Mikko Kraft (deserter)
* Miriam Green
* Niklas Laxström (Nikerabbit)
* paxed
* Samu Voutilainen (Smar)
* Santtu Pajukanta (Japsu)
* Simo Sutela
* Veikko Pukkila (swege)
=== French Translation ===
* Antoine Garnier
* Antoine Imboden
* Aurélien Brevers (Breversa)
* Aurélien Paulus
* Arnaud Garoux (La vie en wose)
* Benoit Astruc
* [mailto:benoit.timbert@free.fr Benoît Timbert] ([[User:Noyga|Noyga]]) — translation maintainer
* Bruno Fève (PP)
* Cédric Duval
* Damian Gryski (dmg)
* [[User:Damien|Damien Jacquot]] — lead translator
* DaringTremayne
* David Pradier
* Éric Pierre (Gari)
* Fabrice Boulakia
* Florence Guettaa (inflow)
* François Mariage (Paquito)
* François Orieux
* Geoffroy Douillié ([[User:Gdou|gdou]])
* Gérard Bodin (Gnork)
* Guillaume Delacourt
* Guillaume Duwelz-Rebert
* Guillaume Guigou
* [mailto:massart.guillaume@wanadoo.fr Guillaume Massart] (Piou2fois)
* Guillaume Melquiond (silene)
* Guillaume Pascal
* Jean Privat (Tout)
* Jean-Louis Passerin (Zoltic)
* Jean-Luc Menut
* Jean-Luc Richard (Le Gnome)
* Jean-Joseph Paget
* Jehan Hysseo (Jey)
* Jérémy Rosen (Boucman)
* Julien Moncel
* Julien Tailleur
* Marc Scheffer
* Mathieu Guilbaud
* Mendes Oulamara
* Michel Poléni (Thanatloc)
* Nicolas Boudin (Blurgk)
* [mailto:philippe.plantier@naema.org Philippe Plantier] ([[User:Ayin|Ayin]])
* Philippe Rasquinet
* Pierre Rudloff
* Sébastien Raynaud (Galactic turkey)
* Sylvain Jeanne
* Thierry Bothorel
* Solena Le Moigne
* William Dupré
* [mailto:ydirson@altern.org Yann Dirson]
=== Friulian Translation ===
=== Galician Translation ===
* [mailto:adriyetichaves@gmail.com Adrián Chaves Fernández] (Gallaecio)
* Fran Diéguez
* Jacobo Abel Fernández García — inactive
* Javier Pico
* Manuel Meixide
* Marce Villarino
* [mailto:leandro.regueiro@gmail.com Leandro Regueiro] (unho) — translation maintainer
* Victor Portela
* Proxecto Trasno — translation project (http://trasno.net)
=== German Translation ===
* Aaron Winter (Bitron)
* Alexander Ginschel (mcpgal)
* Alexander Laux
* Alexander Zurek (Alresu)
* Andre Schmidt (schmidta)
* Boris Stumm (quijote_)
* Celina Mainz (Mailina)
* Chewan
* Christoph Berg (chrber) — former translation maintainer
* Christoph Lange (madelgijs)
* Drakefriend
* Elias Fromm (Karpadorsch)
* Elias Pschernig (allefant)
* ghype
* Lennard
* Lorenzo Hardt (HeroOfGaming)
* Rhonda D'Vine (Rhonda)
* Jan Greve (Jan)
* Jan Heiner Laberenz (jan-heiner)
* Kai Ensenbach
* Konrad Schwede (Konrad2)
* [mailto:marcel_miebach@gmx.de Marcel Miebach] (retr0virus)
* Mark de Wever ([[User:SkeletonCrew|Mordante/SkeletonCrew]])
* Matthias Gianfelice (MatthiasG)
* [mailto:Crazy-Ivanovic@gmx.net Nils Kneuper] (Ivanovic)
* Oliver Lange (Crommy)
* Ronny Standtke
* Ruben Philipp Wickenhäuser (The Very Uhu)
* Severin Glöckner (Shiki, Sevu) — current translation maintainer
* Stephan Grochtmann (Schattenstephan)
* Tobias Schönau (SonIcco)
* Uz-Valentin Friedrich
* vonHalenbach
=== Greek Translation ===
* Alexander Alexiou (Santi/fnaek)
* Evangelos Papakirikou
* Harry Kaimenas
* Katerina Sykioti
* Konstantinos Egarhos
* Konstantinos Karasavvas
* Mik2303
* Nikos Astroylakis (Greek Dubbings Maker)
* Nikos Papadopoulos (galicae)
* Nikos the Great
* Panagiotis Famelis (Kesnar)
* Papadopoulos Themistoklis
* Spiros, Giorgis
=== Hebrew Translation ===
* Ariel Ben-Yehuda
* Oron Peled
* Ely Levy (Nakee)
=== Hungarian Translation ===
* Barthalos Márton (Aldebaran Ghrelin)
* Czakó Csaba (Horus)
* Erdélyi Kristóf
* Fábián Balázs (nermal93)
* Hamar Krisztián
* Kádár-Németh Krisztián (Rudanar Firmus)
* Kékkői László (BlackEvil)
* Kelemen Zoltán (kele)
* Kovács Dániel (Consalamander)
* Majsa Norbert (wias)
* Máthé Katalin (katkadu)
* Németh Tamás (nTOMasz)
* Pintér Csaba (piere)
* Salamon András (ott)
* Soltész Adrián (majominia)
* Széll Tamás (TomJoad)
* Udvari Gábor (Udi)
* Udvari Zsolt
* Vasvári Péter (honorshark)
=== Icelandic Translation ===
* Arngrímur Stefánsson
* Gabríel A. Pétursson
=== Indonesian Translation ===
* Ardhi (earthboy)
* Benny Lin
* [mailto:sevennightmare@tutanota.de Irsyad Musthafa] — translation maintainer
* Iwan
* [mailto:inkraiswitras@yahoo.com Nicky Inkrais Witras] — previous translation maintainer
* [mailto:yuris_wicaksana@yahoo.com Yuristyawan Pambudi Wicaksana] — previous translation maintainer
=== Irish Translation ===
* Mountain_King — translation maintainer
=== Italian Translation ===
* Alessandro Barbazza
* Alessio D'Ascanio (otaku)
* Americo Iacovizzi (DarkAmex)
* [mailto:arosella@yahoo.com Antonio Rosella]
* crys0000
* Elvish_Hunter
* Eugenio Favalli (ElvenProgrammer)
* Federico Tomassetti
* Filippo Abbruzzo (Gwain)
* isazi
* Luciano Montanaro (Luciano)
* Michele Maresi (mich)
* RokStar
* Stefano Coccato (BioHazardX)
=== Japanese Translation ===
* BlueStar
* clearpotion
* h22
* [mailto:broadbarredfirefish@gmail.com Hironori Fujimoto] (RatArmy) — translation maintainer
* [mailto:iwaim.sub@gmail.com IWAI, Masaharu] ([[User:Iwaim|iwaim]])
* [mailto:kateitekino_hito@yahoo.co.jp kateiteki]
* kudoh
* Maxwell Stibbard Hawkes
* [mailto:mishanhideaki88@gmail.com mishan]
* いいむらなおき (amatubu) - Naoki Iimura
* [mailto:okyada@gmail.com 岡田信人 - Nobuhito Okada]
* np
* [mailto:pasta0915[at]gmail.com Shoot MORII] (pastak)
* OOTA, Masato(oo)
* Q
* R.N
* rouiza
* [mailto:le.sahara@gmail.com sahara]
* Shigerello
* [mailto:suto3suto3@gmail.com suto3]
* 瀟湘夜雨
* Taigaku Okuiso
* Takanobu Hirai
* tamanegi
* [mailto:yma9yma@gmail.com yma]
* Yuji Matsumoto
=== Korean Translation ===
* mistzone — current maintainer
=== Latin Translation ===
* Eric S. Raymond (ESR) — general semantician
* Mark Polo (mpolo) — original maintainer
* Michael Babich ([[User:Aethaeryn|Aethaeryn]]) — current maintainer
* [mailto:Majora700@gmail.com Steven Panek] ([[User:Espreon|Espreon]])
* Thomas Hockings ([[User:Deusite|Deusite]])
=== Latvian Translation ===
* Artis Rozentāls
* Gvido Bruveris — Maintainer
* [mailto:rei4dan@gmail.com Reinis Danne]
=== Lithuanian Translation ===
* Andrius Štikonas
* Deimantė Tankus (Diamond)
* Jurgis Sūdžius (Dievas)
* Lukas Gasiūnas (LucasLT)
* Marius Tauba (morlock)
* Raimundas Zabarauskas
* Vytautas Šaltenis (rtfb)
=== Macedonian Translation ===
* Dimitar Ilccov (Mythological)
=== Marathi Translation ===
* [mailto:sujitrjadhav@gmail.com सुजित जाधव] ([[User:sujitrjadhav|Sujit R Jadhav]])
=== Norwegian Translation ===
* Asgeir Aakre (YbeRn00b)
* Erik J. Mesoy (Circon)
* Gaute Jao (Gauteamus)
* Hallvard Norheim Bø (Lysander)
* Håvard Korsvoll
* Pål Inge Larsen (PsyBird)
* Susanne Mesoy (Rarlgland)
=== Old English Translation ===
* [mailto:eirikvw@aim.com Eirik Westcoat]
* [mailto:axonfifty@gmail.com Gottweiß]
* [mailto:Majora700@gmail.com Steven Panek] ([[User:Espreon|Espreon]]) — Maintainer
=== Polish Translation ===
* Agata Chmiel
* Arkadiusz Danilecki (szopen)
* Bartek Waresiak (Dragonking)
* Kamil Matuszewski (LiamTailor)
* Karol Nowak (grzywacz)
* Magdalena Chmiel (Ryouko)
* Marek Kalnik (wdev)
* Michał Hartliński
* Michał Jedynak (Artanis)
* Michał Ligowski (misiorysio)
* Paweł Albecki (gidgnulur)
* Paweł Jackowski (fatality)
* Piotr Kruszewski (Hejnewar)
* Piotr Makarewicz (ForPeace) — Current maintainer
* Robert Wolniak (Szkodnix)
* Roman Polesek (rimskij)
* Sebastian Basierski
* Tadeusz Kopeć
* Zbigniew Banach (vonBureck)
=== Portuguese Translation ===
* Carlos Sousa
* Luis Passos
* trewe — Current maintainer
=== Portuguese (Brazil) Translation ===
* Ambra Viviani Loos
* Andrei Machado — Current maintainer
* Antonio Vildes Barbosa
* Bruno Macabeus
* Celso Goya
* [mailto:cbterra@gmail.com Claudio Terra]
* Claus Aranha
* Di Teixeira (Moroder)
* Diego Inácio Goergen
* [mailto:fred.maranhao@gmail.com Fred Maranhão]
* Hugo Neiva de Melo
* Michel Loos
* Renato Cunha
* Ricardo Sodré Andrade
* Romero Gonçalves
* Sérgio de Miranda Costa
* Tiago Souza (Salvador)
=== Romanian Translation ===
* Unknown
=== Russian Translation ===
* Aldarisvet — Previous maintainer
* [mailto:allryn@pisem.net Aleksandr Aleks]
* Alexandr Gridnev
* Alexandr Menovchicov
* Alexey Remizov
* Alexey Zakharchenko
* Andrey Tikhonov ([[User:tiandrey|tiandrey]])
* Anthony Kolesov
* Artem Khrapov ([[User:Kabachuha|kabachuha]]) — Current maintainer
* Azamat Hackimov ([[User:Winterheart|winterheart]])
* [mailto:BabylonASАТyandexDОTru BabylonAS] ([[User:BabylonAS|BabylonAS]])
* [[User:catbegemot|catbegemot]]
* Danila Evstifeyev (MyOtheHedgeFox)
* Denis Revin (Dut_Norshi)
* Dmitry Brilev (dobryl)
* Fardeil
* Fedor Gavrilov (gallowzbird)
* Fedor Khod'kov (teddy/fkhodkov)
* Ilya Kaznacheev
* Ilya Kotov
* Ishayahu Lastov (Ishayahu)
* Kirill Baranov
* Mikhail Melnik (ZumZoom)
* Nikita Ushkin
* Roman Tuchin (Sankt)
* Sergey Popov (loonycyborg)
* Valentina Mukhamedzhanova (umirra)
* Victor Sergienko (singalen)
* [mailto:vicza@zmail.ru Victor Zabavin]
* Vlad Glagolev
* Yellow Horror
=== Scottish Gaelic Translation ===
* [mailto:fios@foramnagaidhlig.net GunChleoc] — Current maintainer
=== Serbian Translation ===
* Branko Kokanovic (kokan)
* [mailto:caslav.ilic@gmx.net Caslav Ilic]
* [mailto:daliborddjuric@gmail.com Dalibor Djuric]
* [mailto:sreckotoroman@gmail.com Srecko Toroman] (FreeCraft)
=== Slovak Translation ===
* Aceman
* Ivan Kovacs
* Ján Sučan (Bhujanga)
* Marian Kluvanec
* Martin Dzbor
* Martin Plávala (Empy)
* Stano Hoferek (Elven)
* [[User:Viliam|Viliam Bur]]
=== Slovenian Translation ===
* Gregor Petrin
* Jaka Kranjc (lynx)
* Klemen Košir (nNa)
* Matej Repinc
=== Spanish Translation ===
* Alvin Eloy Luna Castro
* Chucho Pulgoso
* David Martínez Moreno
* Diego Grande Rodríguez (Buhako)
* Diego J.
* Fernando Cerezal
* Flamma
* Francisco Muñoz (fmunoz)
* Gabriel Rodríguez (Chewie)
* [mailto:gusgins@gmail.com Gustavo Gingins] (gins)
* [mailto:shadowm2006@gmail.com Iris Morelle] ([[User:Shadowm|Irydacea/shadowm]])
* Iván Herrero (navitux)
* Javier C.H. (perseo)
* Jose Gordillo (kilder)
* Jose Manuel Gomez (joseg)
* Josu Díaz de Arcaya
* Masacroso
* Martín R. Dapás
* Pedro Llorens (PeterPorty)
* Roberto Romero (sildur)
* Sergi March (sergi34)
* [mailto:Majora700@gmail.com Steven Panek] ([[User:Espreon|Espreon]])
* [mailto:quianaaelonin@gmail.com Víctor M. Estrada] (Aelonin/Darkmage)
* Xavier Novella Sinde (XavierNovella)
=== Swedish Translation ===
* Alex Alowersson — current maintainer
* Alexander Kjäll (capitol)
* Andreas Tyrberg
* Åse Petersson (tintin)
* Elias Sevelin (aXidal)
* Gustav Tiger
* Hugo Gerlach (Entrimo)
* Leo Danielson (Lugo Moll)
* Niklas Bolmdahl
* Stefan Bergström (tephlon)
* [mailto:susanna.bjorverud@telia.com Susanna Björverud] (sanna)
* Ulrika Uddeborg
* wint3r
=== Turkish Translation ===
* Ali Erdem Karaçay(Arsivnet)
* Enes Akın (yekialem)
* İhsan Akın
* Kosif
* Nilgün Belma Bugüner
* Pınar Yanardağ (moonquelle)
* Selim Farsakoğlu
=== Ukrainian Translation ===
* Anton Okhrimenko (AncientGeneral)
* [mailto:mansonigor@gmail.com Igor Paliychuk]
* [mailto:arobson@yandex.ru robson] ([[User:Robson|Robson]])
=== Valencian (southern Catalan) Translation ===
* Bernardo Arlandis
* Robert Millan
* Tomás Roig
=== Vietnamese Translation ===
* Huynh Yen Loc
* Le Ngoc Nguyen Chinh
* Pham Hoang Duy
* Pham Thanh Nam
* Pham Thi Yen
=== RACV’s Translation ===
* Mario Rodríguez (Mavorte)
== Sceptre of Fire ==
=== Campaign Design ===
* Joseph Simmons (turin)
=== Campaign Maintenance ===
* Lari Nieminen (zookeeper)
* doofus-01
* nemaara
=== WML Assistance ===
* David Simmons (Dacyn)
* Eli Dupree (Elvish Pillager)
* Lari Nieminen (zookeeper)
* MadMax
=== Artwork and Graphics Design ===
* Asereje
* Blarumyrran — the new Dwarvish Miner sprite
* Emilien Rotival (LordBob) — new portraits
* James Woo (Pickslide) — old portraits
* John-Robert Funck (XJaPaN)
* JonasNL — Dwarvish Miner attack and defense animations
* Peter Geinitz (Wayfarer)
* Pixelmind — Khrakrahs portrait
* Richard Kettering (Jetrel)
* RusHHouR — old gold and coal piles
* doofus-01
== Son Of The Black Eye ==
=== Campaign Design ===
* Benjamin Drieu (Benj) — conception and original design
* Taurus — completion
=== Campaign Maintenance ===
* Lari Nieminen (zookeeper) — current maintainer
* Taurus
=== Prose, Grammatical and WML Assistance ===
* Eric S. Raymond (ESR)
=== Artwork and Graphics ===
* Christian Sirviö (Girgistian) — portraits (sketches)
* Phil Barber (thespaceinvader) — portraits (coloring)
* Sonny T Yamada (SkyOne) — Sprite animations (defense and magic) of orcish shamans
== Northern Rebirth ==
=== Campaign Design ===
* Taurus
=== Artwork and Graphics Design ===
* Battlesquid
* Nicholas Kerpan (Thrawn)
* Richard Kettering (Jetrel)
* Xandar86
=== Prose, Grammatical and WML Assistance ===
* Eric S. Raymond (ESR)
=== Code and Translation Assistance ===
* David Philippi (Torangan)
* Scott Klempner
=== Campaign Maintenance ===
* Charles Dang (vultraz)
== Liberty ==
=== Original Campaign Design ===
* Scott Klempner
=== Latest Rewrite ===
* nemaara
=== Campaign Maintenance ===
* Lari Nieminen (zookeeper)
* Eric S. Raymond (ESR) — Original prose-doctoring and preparation for mainline
=== Artwork and Graphics Design ===
* Brendan Sellner
* Kathrin Polikeit (Kitty) — portraits
* Shadow
* Blarumyrran — story images, Rogue Mage line sprites
* Sonny T Yamada (SkyOne) — Sprite animations (defense and attack) of Rogue Mage line
== Delfadors Memoirs ==
=== Creator and Original Designer ===
* [[User:jp30|Josh Parsons]] — Original designer, responsible for first scenarios 2-10; maintained it up to 0.5.2
=== Co-Authors ===
* Oto 'tapik' Buchta — First scenario, various improvements
* Spiros Alexiou (Santi/fnaek) — Scenarios 12 and following.
* Eric S. Raymond (ESR) — Prose- and script-doctoring, Wesnoth continuity fixes.
=== Campaign Maintenance ===
* Jeffrey 'Sigurd' Westcoat (SigurdFireDragon) — former maintainer
=== WML Programming and Assistance ===
* Fabi — WML bug fixing and polishing.
* Eric S. Raymond (ESR) — Side-mutation and recall-list handling.
* Iris Morelle (Irydacea/shadowm) — WML help
=== Graphics ===
* Kathrin Polikeit (Kitty)
=== Additional thanks to ===
* Arkadiusz D. Danilecki — Inspiration and borrowings from his 'A New Order'
== Heir To The Throne ==
=== Campaign Design ===
* David White (Sirp)
=== Campaign Maintenance ===
* Dimitar Ilccov (Mythological)
* Lari Nieminen (zookeeper) — current maintainer
* Scott Klempner
=== Artwork and Graphics Design ===
* doofus-01 — new sprites and animations (Princess, Battle Princess, Dark Queen, Sea Orc)
* Emilien Rotival (LordBob) — portraits (Delfador, Asheviere, Moremirmu)
* Francisco Muñoz (fmunoz)
* Kathrin Polikeit (Kitty) — portraits (Konrad, Li'sar, Kalenz, Chantal)
* Neoriceisgood
* Richard Kettering (Jetrel)
=== Miscellaneous ===
* Patrick Parker (Sapient) — WML assistance
== Secrets of the Ancients ==
=== Campaign Design, Programming, and Artwork ===
* Dan Gerhards (beetlenaut)
=== Campaign Maintenance ===
* Jeffrey 'Sigurd' Westcoat (SigurdFireDragon) — former maintainer
=== Additional Artwork ===
* Wussel — Some improvements to the ship.
== Legend of Wesmere ==
=== Creator and Lead Designer ===
* [mailto:moka1@otenet.gr Spiros, George and Alexander Alexiou] ([[User:Santi|Santi/fnaek]]) — Main designers, former maintainers.
=== Campaign Maintenance ===
* Fabi/Fendrin — Current maintainer
* Spiros, George and Alexander Alexiou (Santi/fnaek)
=== Prose-doctoring and adaptation for mainline ===
* Eric S. Raymond (esr)
* Fabi/Fendrin — Major WML rewrite for mainline
=== WML Assistance ===
* Alexander van Gessel (AI/AI0867) — bugfixing and general WML cleanups
* Iris Morelle (Irydacea/shadowm) — for A LOT of help with WML and interesting campaign suggestions
* Lari Nieminen (zookeeper) — for A LOT of help with WML
=== Artificial Intelligence ===
* Yurii Chernyi (crab) — coding of the new ai and help with corresponding redesigns
=== Graphics ===
* Bora Orcal (bera) — goblin horn rouser
* Kathrin Polikeit (Kitty) — who did a great job with portraits and other graphics
-the main reason for having a polished campaign
* Steven Panek (Espreon) — map artist
=== Additional thanks to ===
* Scott — for help with WML, especially the use of store/unstore
* WhiteWizard — Initial porting to 1.2
* Disto — for elvish units
* RedLTeut — for great improvements to the initial invisible elvish units
* Dacyn — who was of great help in the beginning of this project
* Big Bad Joe
* breversa
* Invisible Philosopher
* js138
* l'ultimo cruco
* Mad Max
* Rhuvaen
* SelfishWeirdo
* Scott
* Sly
* Teldar
* Turin
* And the rest of the Wesnoth community for feedback,
criticism, help with WML code and graphics.
== The South Guard ==
=== Campaign Design ===
* William Carey (aelius)
=== Latest Campaign Revision ===
* nemaara
=== Campaign Maintenance ===
* nemaara — current maintainer
* Lari Nieminen (zookeeper)
* Eric S. Raymond (ESR)
* Wintermute
=== Artwork and Graphics Design ===
* J.W. Bjerk (eleazar)
* Kathrin Polikeit (Kitty) — portraits
* Lari Nieminen (zookeeper)
* Scavenger — new story images and Mal M'Brin portrait
* rhyging5
* Shadow
* William Carey (aelius)
== Two Brothers ==
=== Campaign Design ===
* Eric J. Mesoy (Circon)
* Nils Kneuper (Ivanovic)
=== Prose and Story Edits ===
* Eric S. Raymond (esr)
* A-Red
=== Campaign Maintenance ===
* Nils Kneuper (Ivanovic)
* Charles Dang (vultraz)
=== Artwork and Graphics Design ===
* Arkadiusz Danileki (szopen)
* Kathrin Polikeit (Kitty) — current portraits
* MadMax
* Stefan
=== Miscellaneous ===
* Bartek Waresiak (Dragonking)
* Christoph Berg (chrber)
* Daravel
* Jozrael
* And special thanks to everyone else who I forgot to mention.
== Under the Burning Suns ==
=== Campaign Design ===
* Asa Swain
* Piotr Cychowski (Mist/cycholka)
=== Campaign Maintenance ===
* Iris Morelle (Irydacea/shadowm)
* Jan Rietema (Rhuvaen)
* Lari Nieminen (zookeeper)
* Piotr Cychowski (Mist/cycholka)
* Simon Forsyth (Alarantalara)
* Steven Panek (Espreon)
=== Artwork and Graphics Design ===
* Dan Gerhards (beetlenaut) — new Flesh Golem sprites
* Kwandulin — New Kaleh and Nym sprites
* doofus-01 — Monster Crab sprite
* Hogne Haskjold (Frame)
* Iris Morelle (Irydacea/shadowm)
* J.W. Bjerk (Eleazar)
* James Woo (Pickslide)
* Javier Hoyos (Vendanna)
* Marcus Rosén (sleepwalker) — Dark Assassin sprite and animations
* Mark Goodenough (Ranger M)
* Mikolaj Machowski (Emdot)
* Murray Cook (Zhukov)
* Peter Geinitz (Shadow)
* Richard Kettering (Jetrel)
* Sangel
* Samuel Wilson (megane)
* Scott Klempner
* Vincent Langner (Vyncyn) — Spider Lich and Human Commander sprites
* Zerovirus — Naga Hunter sprite
=== Miscellaneous ===
* Fabian Müller (Fabi/Fendrin)
* Mark Polo
* Matthias Schoeck (mattsc) — Messenger AI
* Isaac
* Ringcaat (Thorin N. Tatge)
* And special thanks to everyone else who I forgot to mention.
== Descent Into Darkness ==
=== Original Campaign Design ===
* esci
=== Latest Campaign Revision ===
* nemaara
=== Artwork and Graphics Design ===
* Blarumyrran — story images
* Emilien Rotival (LordBob) — current portraits
* theycallmerooster — old portraits
=== Miscellaneous ===
* josteph — dialogue comments and revisions
== Dead Water ==
=== Campaign design and programming ===
* Dan Gerhards (beetlenaut)
=== Script-doctoring and cleanup for mainline ===
* Eric S. Raymond (ESR)
=== Artwork ===
* Kathrin Polikeit (Kitty) — Portraits for brawler, Kai Krellis, Gwabbo, and Caladon
* Justin Nichols (JustinOperable) — Portrait for Cylanna
* Zerovirus — Kai Krellis sprites
* Francisco Muñoz (fmunoz) — Attack icons
== The Rise Of Wesnoth ==
=== Campaign Design ===
* James Spencer (Shade)
=== Campaign Maintenance ===
* Dimitar Ilccov (Mythological)
* Lari Nieminen (zookeeper) — current maintainer
* Scott Klempner
=== Artwork and Graphics Design ===
* Blarumyrran — the new Vampire Lady sprite
* J.W. Bjerk (eleazar)
* Lari Nieminen (zookeeper)
* Emilien Rotival (LordBob) — new portraits and story art
* Michael Gil de Muro (grp21) — old portraits
* pixelmind — Shek'kahan portrait
=== WML Contributors ===
* Iris Morelle (Irydacea/shadowm)
* Lari Nieminen (zookeeper)
== The Hammer of Thursagan ==
=== Author ===
* Eric S. Raymond (esr)
=== Special Guest Designer ===
* Taurus
=== Art ===
* Kim Holm (DUHH)
* Phil Barber (thespaceinvader)
* Vincent Langner (Vyncyn) — New Dwarvish Witness line sprites and animations
=== Brainstorming, playtesting, and spousal support ===
* Cathy O. Raymond
=== Campaign Maintenance ===
* Charles Dang (vultraz)
== Eastern Invasion ==
=== Campaign Design ===
* Joseph Simmons (turin)
=== Campaign Maintenance ===
* Dimitar Ilccov (Mythological)
* Lari Nieminen (zookeeper) — current maintainer
* Astrid Halberkamp
=== Campaign Epilogue and Continuity ===
* Eric S. Raymond (ESR)
=== Prose and Story Edits ===
* Loci
=== Artwork and Graphics Design ===
* Aaron Redfern (A-Red) — New Owaec sprites
* Emilien Rotival (LordBob) — new portraits
* James Woo (Pickslide) — old portraits
* Neoriceisgood
[[Category:Generated]]

Credits

2021-10-23T02:40:06Z

Shadowm: Credits update in preparation for the 1.16.0 release

<div class="tright"> __TOC__ </div>
__NOEDITSECTION__
In July 2003, '''David White''' released the first version of Wesnoth. Since
then, many people have joined the project, contributing in very different ways.

To make any changes to this list, please modify
<code class="noframe">about.cfg</code> in the repo or ask any developer to do
it for you.

== Core Contributors ==
=== Programming ===
* [mailto:dave@whitevine.net David White] (Sirp) — Founding Developer
<hr style='clear:none'>
* [mailto:AI0867@gmail.com Alexander van Gessel] (AI/AI0867)
* Alfredo Beaumont (ziberpunk) — autotools
* Ali El Gariani ([[User:Alink|alink]]) — coder, bug fixes, optimizations, interface usability
* András Salamon ([[User:Ott|ott]]) — QA, bug fixing, subediting, game mechanics
* Andreas Löf (Aginor)
* Anonymissimus — bug fixes and features mostly related to the wml engine or lua interface
* [mailto:artemkhrapov2001ATyandexDOTru Artem Khrapov] ([[User:Kabachuha|kabachuha]]) — addons server rework, incremental updates and uploads feature; i18n, UI and quality of life improvements; bugfixes
* [mailto:dragonking@o2.pl Bartek Waresiak] (Dragonking) — unit balancing, Formula AI
* Benoît Timbert ([[User:Noyga|Noyga]])
* Bram Ridder (Morloth) — editor improvements
* [mailto:bruno@wolff.to Bruno Wolff III] ([[User:bruno|bruno]]) — campaign web interface, bug fixing, minor coder
* Cameron Morland
* Cédric Duval — coder, internationalization manager
* Charles Dang (vultraz) — General fixes, cleanup and improvements to various areas.
* Chris Beck (iceiceice/involution) — Bug fixes and features esp. engine-related or multiplayer-related. Added WML unit testing system, improvements to travis-CI.
* Celtic Minstrel
* Daniel Franke (dfranke)
* Daniel (gfgtdf)
* David Hilton
* Dominic Bolin (Xan)
* Elias Pschernig (allefant)
* Elvish_Hunter
* Eric S. Raymond (ESR) — Macro library reorganization, major UI makeover introducing lightweight transparent popups and linger mode, maintenance tools for WML, eight campaigns lifted from UMC, one all-original campaign, editor refactoring, many many code cleanups, and svn-to-git migration.
* Eugen Jiresch (euschn) — savegame improvements
* [mailto:fabianmueller5_at_gmx.de Fabian Müller] ([[User:fabi|fabi/fendrin]])
* [mailto:gabrielmorin~_-AT-_~gmail.com Gabriel Morin] (gabba) — Whiteboard project, naming hotseat players, delay shroud updates on game start.
* Greg Copeland (Oracle) — coding; Server optimizations.
* Gregory Lundberg (TadCarlucci) — Cleanup of campaigns code
* [mailto:cornmander@cornmander.com Gregory Shikhman] (corn) — coding; upload log maintenance/improvements
* Guillaume Melquiond (silene) — coding, bug fixes
* [mailto:billybiset@gmail.com Guillermo Biset] (billynux) — Bug fixer, remover of upload stats, network module rewrite, ANA, boost::asio
* [mailto:shadowm2006@gmail.com Iris Morelle] ([[User:Shadowm|Irydacea/shadowm]]) — Miscellaneous WML, i18n and UI features, improvements and bugfixes; refactoring and extension of add-ons management code; features and refactoring of image-path functions mechanism; cache manager UI and paths/game version dialog; campaignd refactoring and maintenance
* Jérémy Rosen ([[User:Boucman|Boucman]]) — coder
* [mailto:mcnabb@gravity.psu.edu John W. C. McNabb] (Darth Fool) — coder, graphics
* Jon Daniel (worduk) — coder, bug fixes
* Jörg Hinrichs (Yogi Bear/YogiHH)
* [mailto:justin.zaun@gmail.com Justin Zaun] (jzaun) — coder, scenario designer
* Jyrki Vesterinen
* Karol Nowak (grzywacz) — bug fixes, sound sources, gp2x port
* [mailto:erl@erl.se Kristoffer Erlandsson] (erl) — help system, editor
* [mailto:lao.geek@gmail.com Lao] ([[User:lao|lao]]) — bug fixes and candidate to GSoC 2008
* Mark de Wever ([[User:SkeletonCrew|Mordante/SkeletonCrew]]) — coder, bug fixes, various features, multi-letter terrain system, gui system.
* Martin Renold (maxy/martinxyz) — performance and gui bug fixes
* Matthias Kretz — optimizations
* Moritz Göbelbecker (mog) — Work on the terrain engine
* Nicolas Weeger (Ryo) — Python API
* [mailto:patrick_x99@hotmail.com Patrick Parker] ([[User:Sapient|Sapient]]) — improvements to user interface, WML engine, various features
* [mailto:paniemin@cc.hut.fi Pauli Nieminen] (suokko) — Bug fixing; usually targeting MP or WML engine
* [mailto:philippe.plantier@naema.org Philippe Plantier] ([[User:Ayin|Ayin]]) — several parts of the code, notably terrain graphics code
* Rusty Russell (rusty)
* Sergey Popov (loonycyborg) — scons
* singalen — iOS port
* Soliton — bug fixes and various small features usually in multiplayer context
* Steve Cotton (octalot)
* Steven Oxley (xonev)
* Thomas Baumhauer (Baufo)
* [mailto:timotei21@gmail.com Timotei Dolean] (timotei) — Eclipse UMC plugin
* Tomasz Śniatowski (ilor) — Editor
* [mailto:ydirson@altern.org Yann Dirson] — gettext support, tinygui
* [mailto:terraninfo@terraninfo.net Yurii Chernyi] (Crab) — AI
=== General Purpose Administration and Coordination ===
* Charles Dang (vultraz) — Current release manager (1.13.3-present)
<hr style='clear:none'>
* Crossbow/Miyo — Past release manager
* [mailto:shadowm2006@gmail.com Iris Morelle] ([[User:Shadowm|Irydacea/shadowm]]) — Past release manager (1.12.1-1.12.6 / 1.13.0-1.13.2)
* [mailto:isaac@sindominio.net Isaac Clerencia] — Past release manager, Debian packager
* [mailto:Crazy-Ivanovic@gmx.net Nils Kneuper] (Ivanovic) — Past release manager, internationalization manager, OpenPandora packager, A Tale of Two Brothers, German translation
* Noy — General purpose administration, unit balancing
* Pentarctagon
=== Internationalization Managers ===
* Cédric Duval — coder, internationalization manager
* David Philippi (Torangan) — internationalization manager, wescamp
* Mark Michelsen (skovbaer) — Slackware packager
* [mailto:Crazy-Ivanovic@gmx.net Nils Kneuper] (Ivanovic) — administrator, release manager, internationalization manager, OpenPandora packager, A Tale of Two Brothers, german translation
* [mailto:susanna.bjorverud@telia.com Susanna Björverud] (sanna)
=== Trailers ===
* ancestral — 1.12 trailer
* Pedro Caseiro (Kasdel) — 1.14 trailer
=== Artwork and Graphics ===
* Emilien Rotival (LordBob) — portrait director - focus on loyalists, trolls, monsters
* Francisco Muñoz (fmunoz) — founding artist and former lead artist, worked consistently on all aspects till around v0.7-0.9.
* Hogne Håskjold (frame/freim) — terrain art director, made much of the current terrains (esp. mountains)
* J.W. Bjerk ([[User:Eleazar|Eleazar]]) — terrain art director (esp. Chasm, Cave, Water), sprite animations, various visual tweaks
* James Woo (Pickslide) — portraits (major focus on orcs and campaigns, especially UtBS, TEI, TSoF)
* Kathrin Polikeit (Kitty) — portrait director - focus on mages/necromancers, elvish, naga, merfolk, and troll unit trees
* Lari Nieminen (zookeeper) — sprite animation, various visual tweaks, titlescreen and campaign maps (v1.11+), water animations (v1.13+)
* Neoriceisgood — sprite creator and animator (major focus on drakes, dwarves, saurians)
* Pekka Aikio (pekka) — tiles, esp. castles, and attack icons
* Phil Barber (thespaceinvader) — Dwarf and Saurian portraits, most of the drake animations, and a large amount on other stuff, esp. the dwarves.
* Richard Kettering ([[User:Jetryl|Jetrel]]) — art director/slave, major focus on sprites, portraits, buildings, and icons
* Timo Honkasalo (Sgt. Groovy) — New high-res logo for the game
<hr style='clear:none'>
* Alex Jarocha-Ernst (Jormungandr) — portraits
* Christophe Anjard (Christophe33) — made many of the old (c. v0.6) terrains, and some sprites for the dwarves
* Erkki Lonkainen (Eternal) — created and animated many replacement sprites (esp. ogre, orc assassin & spear units, and cockatrice)
* Jason Lutes — portraits (major focus on humans, some campaign portraits)
* Johann de Venecia (Johann) — drew the new campaign story art for HttT
* Leonhard — made several of the new attack icons
* Marcus Rosén (sleepwalker) — Animations (esp. Saurians, Dwarves, Horseman), dunefolk sprites, and portraits (Mermaid Initiate & Dune Herbalist)
* Mark Goodenough (Ranger M) — sprite animator
* Maximiliano Buis (Redeth) — Made nearly all of the idle animations, and some death animations (as of 1.3.1)
* Michael Gil de Muro (grp21) — portraits (for the campaign 'The Rise of Wesnoth')
* Moritz Göbelbecker (mog) — tiles, esp. swamp, encampment, ice, and work with lava/chasm
* Niall Burton (Leonard03) — Minimalistic logo render
* Peter Geinitz (Shadow/Wayfarer) — sprite creator and animator
* Robert Bolin (Zebulon) — tiles, sprite editing and animations
<hr style='clear:none'>
* Andrew James Patterson (Kamahawk) — sprites
* antwerpz — sprite creator/animator for old saurian units
* Diego Brea (Cobretti) — sprite creator/animator
* EEL (EELuminatus) — sprite animator, provided death animations for the woses, some of the orcs, and an attack animation for the revenant
* Eli Dupree (Elvish Pillager) — sprites and animations
* Eric Holdos (Rev. V!)
* Gareth Miller (Gafgarion) — made some early sprites/tiles
* Gerald Clears (Smok'em Jags) — sprite animator
* James Barton (Sangel) — sprites
* Jami — rogue death and red mage idle animations
* Jerzy Brzozowski (Mefisto) — Various sprites and animations, tropical forests.
* Jesse Holland (Kestenvarn) — map illustrator of old titlescreen and campaign maps (v1.1 - v1.10)
* Johanna Manninen (lohari) — edited tiles, ported freeciv tiles used in very early versions of wesnoth
* John Muccigrosso (Eponymous Archon) — made some early sprites, such as the human bowmen
* Kuno Raffin (lurker) — Various terrain artwork
* Michael Mielewczik (Mille) — sprite animator
* Mikko Kraft (Deserter) — sprite animator
* Musketaquid — animated windmill / stone path
* Slainte — made sprites for c. v0.6 mages, also made many of the old attack icons
* Simon Forsyth (Alarantalara) — cave terrain
* Stephen Metcalf (Neoskel) — major help with shadow standardization (over half the units), made some missing zombie variants
* Stephen Stone (Disto) — sprite animator
* Svetac — made many of the old attack icons
* Tristan Millner (tatmf) — made old portrait of dwarven fighter
* Zhukov — sprite animator
<hr style='clear:none'>
* Aaron Redfern (A-Red) — Sprites and animations
* Adrian Sheehy (Major) — various sprites animations
* Alexander Brown (Cloud) — Sprite animations
* Anton Ecker (Kaldred) — burnt villages
* battlestar — - some scenery graphics including burnt tent.
* Ben Wenzel (artisticdude) — Sprite animations
* Blarumyrran — New storm trident, staff and ankh item pictures, various attack icons, river ford tiles, drake and human city villages
* Bora Orcal (bera) — Goblin portrait sketches
* Cernunnos — merfolk villages
* Charles Dang (vultraz) — Icons for new editor and updated terrain icons
* Chris Wilson (Valkier) — portraits
* Christian Sirviö (Girgistian) — portraits (sketches), and some attack animations for the orcs
* Clinton Bell — various animations
* Dan Gerhards (beetlenaut) — various sprites and animations
* Daniel Borgmann (dborg) — semi-transparent map grid
* Daniel Foerster (pydsigner/pyndragon) — Icon overlays for the About dialog button
* Kwandulin — Standing animations (Skeleton Archer, Bone Shooter, Orcish Archer, Dwarvish Fighter, Ulfserker, Stalwart, Runesmith), minor fixes
* doofus-01 — orcish fort and villages, desert mountains, mine walls, sea forts, portraits for walking corpse and soulless
* Elena Astanina (ayona) — log-cabin villages
* Eric Butler (Erk) — desert and merfolk villages
* Evan Crook (Flametrooper) — sprite animator (TC conversion)
* Garrett Wessner (Stilgar) — gold coin pile
* Gideon Chia (Deonjo) — new 'units' icon for general status bar
* Guangcong Luo (Zarel) — Multiplayer status icons for 1.7.x
* Highhole — revised storm trident
* Homunculus — dead great tree terrain
* [mailto:shadowm2006@gmail.com Iris Morelle] ([[User:Shadowm|Irydacea/shadowm]]) — Minor item/unit edits; animated lit brazier; ported gryphon rider animation to generic gryphon; Ancient Lich for 1.12.x
* Irrevenant — Skeleton archer death and recruit animations, new ankh touch ups, new dark adept touch ups, elvish marshal standing animation
* Irwin Ismail (Swordy) — original projectile/attack icon for chakram
* Jason Frailey (Valdroni) — scorpion portrait
* Jimmy Olsson (Azlan) — made old icons for windows version
* Joakim Persson (JAP) — Knalgan flag set
* John Mercer (Stern) — Giant Rat graphics
* John-Robert Funck (XJaPaN) — sprite animator
* Jonatan Alamà (tin) — made red logo used until before v1.0
* Justin Nichols (JustinOperable) — Portrait artwork
* Kim Holm (DUHH) — Portrait artwork
* Lukasz Wawrowski (inferno8) — Drake attack icons with fmunoz and map backgrounds for Isar’s Cross
* Lordlewis — mace item sprite
* Mattias Westlund (West) — new color cursors
* Nicholas Kerpan (Thrawn) — human thief portrait
* Pixelmind — various animations
* Randall Walls (slightcrazed) — sprite animator
* rhyging5 — various animations
* RusHHouR — New signpost (1.4.1)
* Samuel Wilson (megane) — random dice icon fix after 1.4.0
* Santiago Iborra (Quellion) — Portrait artwork
* Simeon Dear (Trilby) — Sprite animations
* Zoomo — Sprite animations
* Zaggy1024 — Wolf rider death animation
* Eisfrei — Elvish shaman idle animations
* Happy Wose — Wose idle frames and Elder wose death animation
* Wolfy — Female arch mage idle animation
* mystic x the unknown — Mage death animation
* Sonny T Yamada (SkyOne) — shadow standardization of many campaign units
* Vincent Langner (Vyncyn) — Walking Corpse and Soulless wolf variations, young roc base and attack sprite
* ZygoUgo — Giant Rat portrait
* ghype — sprite animation and dunefolk base frames
=== Music ===
* Aleksi Aubry-Carlson (Aleksi)
* Doug Kaufman (dkaufman) — http://dougkaufman.net/
* Gianmarco Leone (gmlion)
* Jeremy Nicoll (jeremy2/eltiare)
* Joseph Toscano (ZhayTee) — zhaymusic.com
* Mattias Westlund (West) — music coordinator/composer
* Ryan Reilly (Rain)
* Stephen Rozanc (TreizeCouleurs)
* Timothy Pinkham (TimothyP)
* Tyler Johnson
=== Sound Effects ===
* Corey Woodworth (woodwizzle) — hit and die sounds
* J.W. Bjerk ([[User:Eleazar|Eleazar]])
* Lari Nieminen (zookeeper) — focus on attack, weapon and user interface sounds
* Adam Rinsky (Action Jack) — dwarf hit and die sounds
* Leonardo Magno Sampaio (leorock116) — mace, staff and club sounds
=== Campaign Design ===
* Asa Swain (quartex) — Under the Burning Suns
* Astrid Halberkamp — Campaign maintenance and various improvements
* Benjamin Drieu
* Charles Dang (vultraz) — Campaign maintenance and various improvements
* Dacyn
* Dan Gerhards (beetlenaut) — Dead Water, Secrets of the Ancients
* David White (Sirp) — Heir to the Throne
* Eric J. Mesoy (Circon) — A Tale of Two Brothers
* Eric S. Raymond (ESR) — The Hammer of Thursagan
* esci — Descent into Darkness
* Francisco Muñoz (fmunoz) — founding artist and former lead artist, worked consistently on all aspects till around v0.7-0.9.
* James Spencer (Shade) — The Rise of Wesnoth
* Jeffrey 'Sigurd' Westcoat (SigurdFireDragon)
* Joseph Simmons (Turin) — The Eastern Invasion, The Sceptre of Fire
* Justin Zaun (jzaun) — coder, scenario designer
* Lari Nieminen (zookeeper) — redesign of various scenarios and other enhancement
* [mailto:Crazy-Ivanovic@gmx.net Nils Kneuper] (Ivanovic) — A Tale of Two Brothers
* Santi/fnaek — The Legend of Wesmere
* Scott Klempner — Heir to the Throne, The Rise of Wesnoth, Liberty
* Taurus — Northern Rebirth, Son of the Black-Eye
* William Carey (aelius) — The South Guard
=== Multiplayer Maps and Balancing ===
* George Birthisel (happygrue/Wintermute) — Unit balancing, Dunefolk Era
* Hejnewar — balancing for Age of Heroes, revised dunefolk
* Jake Bailey (jb) — multiplayer maps
* Joshua Northey (Becephalus) — multiplayer maps (mostly 2vs2 and up)
* Mike Quiñones (Doc Paterson) — multiplayer maps (mostly 1vs1)
* Noy — general purpose administration, unit balancing
* Peter Groen (pg) — multiplayer maps
* Ruben Philipp Wickenhäuser (The Very Uhu) — multiplayer maps
* Soliton — unit balancing
* Tom Chance (telex4) — multiplayer maps
* [mailto:kleinfel@wpi.edu Zack Kleinfeld] — multiplayer maps, unit balancing
=== Packagers ===
* ancestral — Apple OS X packager (1.12.1 and later)
* [mailto:hrubymar10@gmail.com Martin Hrubý] ([[User:hrubymar10|hrubymar10]]) — Apple macOS packager (1.13.11 and later)
* Matthias Schoeck (mattsc) — Apple OS X packager (1.11.8 and later)
* [mailto:Crazy-Ivanovic@gmx.net Nils Kneuper] (Ivanovic) — OpenPandora packager
* Rhonda D'Vine (Rhonda) — Debian/Ubuntu packager
* Sebastian Kölle (aquileia) — Visual Studio SDK maintainer
* Sergey Popov (loonycyborg) — Microsoft Windows packager and MinGW SDK maintainer
* [mailto:ports@toco-domains.de Torsten Zühlsdorff] — FreeBSD Packager
* Vincent Cheng (vincent_c) — Debian/Ubuntu packager
<hr style='clear:none'>
* [mailto:ben@happyspork.com Ben Anderman] (crimson_penguin) — Apple OS X packager (for 1.5.6 and later)
* Cyril Bouthors (CyrilB) — Debian packager, patron
* Darryl Dixon
* edge
* Isaac Clerencia — Debian packager
* Jay Hopping
* Jörg Hinrichs (Yogi Bear/YogiHH) — Microsoft Windows packager
* Laurent Wacrenier (lwa) — Apple OS X packager (for v1.4 and before)
* Marcin Konicki (ahwayakchih) — BeOS packager
* Marcus Phillips (Sithrandel) — Apple OS X packager (for v1.0 and before)
* Mark Michelsen (skovbaer) — Slackware packager
* Muhammad Amir Ayub (anakayub) — Apple OS X packager
* Piotr Cychowski (Mist/cycholka) — Microsoft Windows packager
* singalen — iOS port
* Simon Forsyth (Alarantalara) — Apple OS X Packager (1.9.6 and later)
* Vlad Glagolev (Stealth) — OpenBSD packager
=== Miscellaneous Contributors ===
* Aaron Keisch-Walter (Exasperation)
* Aaron Winter (Byteron)
* Adam Leffew
* Adrian Iosif (Zappaman)
* Aishiko — Unit instance recall cost implementation
* Alek Bollig (binarycoder)
* Alesis Novik
* Aline Riss (akihara)
* Amir Hassan (kallaballa)
* Andris Szell (bandita137)
* André Knispel
* Andrea Palmatè (afxgroup)
* Andrius Šilinskas (thunderstruck)
* Andrius Štikonas
* Anja Keicher (ayne)
* Astrid Halberkamp
* Ben Anderman (crimson_penguin) — unit list
* Boldizsár Lipka (lipk)
* Brilliand
* Burkay Özdemir (Velory) — Poisoning improvement for Formula AI
* chisquare130
* Chris Carpenter (mordocai)
* Chris Hopman (cjhopman)
* Chris Mann (WildPenguin) — Emacs WML-mode
* Chusslove Illich (caslav.ilic) — wmlxgetext improvements
* David Slabý (blaf)
* Daniel Bruegmann
* David Mikos (Coffee) — Coder, animation framework improvements.
* Denny Vaccaro (endercoaster)
* Derek (Gambit)
* devnexen
* DisherProject
* Dmitry K. (nephro)
* Doug Rosvick ([[User:dlr365|dlr365]])
* dorng
* dreamer-88
* Dugi — Context-free name generator
* Duthlet
* EarthCake
* Edward Chernenko
* Ekdohibs
* elvish_sovereign
* Ely Levy (Nakee)
* Étienne Simon (ejls)
* Etkin Baris Ozgul (pokhbocee) — Lua AI
* Eugene Kosov (kevg)
* [mailto:eugeni.stepanov@gmail.com Evgeniy Stepanov] — NativeClient port
* Evgeny Kapun
* FAAB
* Federico Pasco (neverEnough)
* Fedor Khod'kov (teddy/fkhodkov)
* Felix Bauer (flix)
* Fernando Carmona (Ferk)
* Floris Kint (Grimling)
* Francesco Gigli (Jaramir)
* Frank Richter (res)
* Frédéric Wagner
* Fredrik Wikstrom (salass00)
* galegosimpatico
* Galen Brooks (fluffbeast)
* gh0st — 2012 Google Code-in Students' Micro AI development
* Gregory Gauthier (rjaguar3)
* Groggy Dice (groggydice) — wmllint enhancements
* [mailto:kevin.xgr@gmail.com Guorui Xi] (Kevin_Xi)
* Hans-Joachim Gurt (HaJo)
* Herb Pah (haiz)
* holius-fr
* IceTyp
* ilyapopov
* J. Tyne (JaMiT)
* J.R. Blain (Cowboy)
* jstitch
* Jacek Kominek (BroodKiller)
* [mailto:benetnash@icpnet.pl Jan Polak] (benetnash) — Formula AI contributions
* Jan Zvánovec (jaz)
* [mailto:babataz@gmail.com Jean-Baptiste Poittevin] (BBT)
* Jeff Breidenbach (jab) — Bilinear interpolation
* [mailto:jleldridge27@gmail.com Jeffrey Eldridge] (jleldridge)
* Jérôme (segfault)
* Jim Carroll (Jimm)
* Jody Northup (Upthorn) — Prospective student (world persistence)
* Joeri Melis
* Joey L. Maalouf (JDog)
* [mailto:john@jo.hnanthony.com John Anthony] — campaignd work, mainly security-based
* John B. Messerly (jbm)
* John Harvey (johndh) — minor race descriptions; bats, goblins, mechanical, merfolk, monster, naga, ogre
* Jonathan Combs (ScegfOd) — log activating dialog
* Jonas Lihnell (Roze)
* Jonas Kölker
* [mailto:jorda@ettin.org Jordà Polo] (ettin) — website, i18n, ui
* Josef Reidinger (qk)
* Joseph Gelfand
* Joshua Hudson
* josteph
* Jozrael
* Justin DiSabatino (Turuk)
* Kamil Kaczmarczyk (lampak)
* [mailto:karl.miller.km@gmail.com Karl Miller] (karlm)
* Karol Kozub (automagic)
* Kevin Montalva (Ryckes)
* Kevin Yap (iKevinY)
* Konrad Schwede (Konrad2)
* Kristoffer Grönlund (kegie)
* Krogen
* Laurent Birtz
* legoktm
* leonardoInf
* lilinitsy
* Lovens Weche (LovCAPONE)
* Luiz Fernando de Faria Pereira (lfernando)
* [mailto:lutheroto@gmail.com Luther Thompson]
* lv-zheng
* [mailto:code@hryniuk.pl Łukasz Hryniuk]
* Maksim Orlovich (SadEagle)
* Mark McGuire (TronPaul)
* Martin Bede — 2012 Google Code-in Students' Micro AI development
* [mailto:hrubymar10@gmail.com Martin Hrubý] ([[User:hrubymar10|hrubymar10]])
* Mateusz Kolaczek (PL_kolek)
* Matt Renfer (Des) — Prose revision
* Matthias Schoeck (mattsc) — AI improvements
* matthiaskrgr — Running address sanitizer to catch leaks
* Maxim Biro (nurupo)
* Maximilian Fricke (madmax28)
* Maximilian Lupke (malumalu)
* Marius Spix (spixi)
* Michael Flowers (MJ)
* Michael Schmahl
* Michael Strebel (Nostromus)
* midzer
* Miguel Zapico (elricz)
* mstrebel
* [mailto:greywhind@users.sourceforge.net Nathan Partlan] ([[User:Greywhind|Greywhind]])
* [mailto:nathan.b.walker@vanderbilt.edu Nathan Walker] (RiftWalker)
* neoedmund
* newfrenchy83
* Niall Burton (Leonard03)
* niegenug
* Nobun — wmlxgettext
* [mailto:zabivator@gmail.com Oleg Tsarev]
* Olivier Faure (PoignardAzur)
* [mailto:asqueados@gmail.com Pablo J. Urbano Santos] ([[User:Lord Ork|Lord Ork]])
* Patryk Obara (dreamer_)
* Paul Smedley (Creeping)
* Paŭlo Ebermann ([[User:Pauxlo|Pauxlo]])
* PBechon
* Peter Elmers
* Peter Mawhorter ([[User:solsword|solsword]]) — Python TC script upgrade
* Petr Sobotka (Pietro)
* [mailto:root@delroth.is-a-geek.org Pierre Bourdon] (delroth)
* pquentin
* Pranav Deshpande (universecoder)
* Priit Laes (plaes)
* Pubudu Gunawardena (ugudu)
* Qi Mo (qmo2015)
* Quetzalcoatl
* Randy Kostiuk (Randypk) — Bug fixes
* RatArmy (fujimo-t)
* Reuben Rakete (rocketbang)
* Richard Yao (srk9) — Bug fixes
* Rikard Falkeborn
* Robert Spencer — 2012 Google Code-in Students' Micro AI development
* Robert Wallace (Robertdebrus)
* Rocco J Carello (rogue)
* Roland Hautz (duncan_shriek)
* Rolf Sievers (Lizard)
* Ronny Standtke
* rrigby
* Ryan Frame
* Ryan Henszey
* Ryan Roden-Corrent (rcorre) — Hotkey release and scroll key rebinding
* [mailto:sachith500@gmail.com Sachith Seneviratne] (sachith500) — Bug fixes at the moment. GSoC Aspirant
* Samuel Kim — 2012 Google Code-in Students' Micro AI development
* Sean Yeh
* Sebastian Goll (afran)
* Sebastian Kölle (aquileia)
* Serge Martin (EdB)
* [mailto:stomasortiz@gmail.com Sergio Tomás Ortiz]
* Severin Glöckner (Shiki, Sevu)
* Simon Forsyth (Alarantalara)
* [mailto:simon_smith@zen.co.uk Simon Smith] ([[User:Simons_Mith|Simons Mith]]) — Style guide, help with the application of the style guide, and some tips
* SoapGentoo
* starius
* Stéphane Gimenez (gim)
* [mailto:Majora700@gmail.com Steven Panek] ([[User:Espreon|Espreon]])
* [mailto:sylecn@gmail.com sylecn]
* [mailto:nsytyi@gmail.com Sytyi Nick] (Sytyi) — WML validation
* [mailto:ptablot@mopong.net Talbot Pierre] (Trademark)
* Tamas K. (negusnyul)
* techtonik
* the_beagle — Wose race description
* The Gnat
* Thibault Févry (iwontbecreative) — Some GCI tasks and utils/wiki_grabber.py cleanup.
* Thom Diment (UnwiseOwl)
* [mailto:hankerspace@gmail.com Thomas Martinet] (hankerspace)
* [mailto:thomas.prevost@gmail.com Thomas Prevost] (zancdar)
* Thonsew
* Thorny23
* Tobias Frei (ToBeFree)
* Tomasz Sikorski (Tomsik)
* Tommy Schmitz
* Tommy (yobbo)
* Toom Lõhmus (Ravana)
* tsr
* Valentin Deschaintre (Zazweda, Epyde) — Zone guardian Micro AI
* vitiv — 2012 Google Code-in Students' Micro AI development
* [mailto:viy@altlinux.org viy]
* Vladimír Slávik — Miscellaneous text formatting and translation engine related help
* vn971, vgaming
* Wedge009
* Yang Yifan (Xara)
* Zas
=== Bots ===
* CIA
* irker
* janebot
* shikadibot
* wesbot
== Translators ==
=== Afrikaans Translation ===
* András Salamon (ott)
* Erhard Eiselen
* Len van Dalsen (Numbers13) — current maintainer
* Nico Oliver (nicoza)
* Renier Maritz
=== Ancient Greek Translation ===
=== Arabic Translation ===
* Amnay Mokhtari
=== Asturian Translation ===
=== Basque Translation ===
* Alfredo Beaumont (ziberpunk)
* Julen Landa (genars)
* Mikel Olasagasti (Hey_neken)
=== Bulgarian Translation ===
* Anton Tsigularov (Atilla)
* Bono Nonchev
* Denica Mincheva (Deni)
* Georgi Dimitrov (oblak)
* Ivan Petrov (TheWhiteKnight) — current maintainer
* Nikolay Vladimirov (Turki)
* Steven Genchev (blademaster83)
* Valentin Yankov (kartacha)
=== Catalan Translation ===
* Carles Company (brrr)
* Dan Rosàs Garcia (focks)
* Daniel López (Azazelo)
* Joan Queralt
* Jonatan Alamà (tin)
* [mailto:jorda@ettin.org Jordà Polo] (ettin)
* Jose Gordillo (kilder)
* J.R. Dolcet Castro (Malin Keshar)
* Marc Orcau
* Mark Recasens
* [mailto:miquel.angel.burgos@gmail.com Miquel-Àngel Burgos i Fradeja] — current maintainer
* Pau Rul·lan Ferragut
* Roberto Garcia (Motxales)
=== Chinese Translation ===
* AxalaraFlameheart (AxalaraFlame)
* Brian lee
* chisquare130
* [mailto:cloudidust@gmail.com CloudiDust] ([[User:CloudiDust|CloudiDust]]) — current maintainer
* cryaciccl
* Dionysus
* 逆天的高级菜鸟 (Gaojicainiao)
* Henry Zhu (Hardwood) — iOS announcements translation into Chinese
* Huang Hongye (Dugucloud) — translation and image localization
* Huang Huan
* Huang Lechuan
* leaf
* Luojie-dune
* MrKing
* 网上佳公子
* Owlet
* pianton
* SealMe
* spider5
* StephDC
* [mailto:sylecn@gmail.com sylecn]
* Teamzhangmeng
* vinneymail
* wind
* Yifan
* yym514
* zen
=== Chinese (Taiwan) Translation ===
* 楊綮銘
* 李昆融
* 李信融
=== Croatian Translation ===
* Ivica Đurenec (charlieh65)
* Nino Gunjača
=== Czech Translation ===
* Alexander Slávik (Olin)
* Anežka Bubeníčková (Bubu)
* Čestmír Houska
* David Nečas (Yeti)
* David Novotný (Draqen)
* [mailto:jan.dedic@gmail.com Jaromír Dědič]
* Karel Doleček
* Lukáš Faltýnek
* [mailto:hrubymar10@gmail.com Martin Hrubý] ([[User:hrubymar10|hrubymar10]])
* Martin Šín
* Michal Žejdl
* Mintaka
* [mailto:tapik@buchtovi.cz Oto Buchta] ([[User:Tapik|tapik]])
* Petr Kopač (Ferda)
* Petr Kovár (Juans)
* Rudolf Orság
* Septim
* Sofronius
* Vít Komárek
* Vít Krčál
* Vladimír Slávik
=== Danish Translation ===
* Anders K. Madsen (madsen)
* Ask Hjorth Larsen
* Bjarke Sørensen (basher)
* Jesper Fuglsang Wolff (ulven)
* Joe Hansen
* Kenneth Nielsen
* Mark Michelsen (skovbaer)
* Mathias Bundgaard Svensson (freaken)
* Ole Laursen
=== Dutch Translation ===
* [mailto:AI0867@gmail.com Alexander van Gessel] (AI/AI0867) — previous translation maintainer
* Arne Deprez
* Astrid Halberkamp
* Floris Kint (Grimling)
* Foppe Benedictus
* [mailto:oudshoorn@eitri.nl IJsbrand Oudshoorn]
* Joeri Melis
* Jon Jacobs
* Koen Douterloigne
* Koen Vervloesem (koan)
* Lala
* Maarten Albrecht
* Merijn de Vet — translation maintainer
* Pieter Vermeylen (Onne)
* Rico van Coevorden
* Rob van der Vleugel
* Roel Thijs (Roel)
* Roger Koot
* Thomas Hugo de Groot
* Tobe Deprez
* WimPapa
=== English (GB) Translation ===
* András Salamon (ott)
* Eric S. Raymond (ESR)
* pjr
* [mailto:Majora700@gmail.com Steven Panek] ([[User:Espreon|Espreon]])
* Thomas Hockings ([[User:Deusite|Deusite]])
* Wedge009
=== English (Shaw) Translation ===
* [mailto:arcriley@ubuntu.com Arc Riley] ([[User:ArcRiley|ArcRiley]]) — translation maintainer
* [mailto:reportingsjr@gmail.com Jon Neal] (reportingsjr)
* [mailto:thomas@thurman.org.uk Thomas Thurman] (marnanel)
=== Esperanto Translation ===
* Aleksej Korgenkov (Grimpanto)
* Francesco Lorenzon (Likso)
* Ľubo Fajth
* Maarten Albrecht
* Rastislav Šarišský (Asto)
=== Estonian Translation ===
* Kaido Kikkas (UncleOwl)
* Mart Tõnso
=== Filipino Translation ===
* Joset Anthony Zamora (eradicus)
* Karen Eve Eso (keeve)
=== Finnish Translation ===
* Ankka
* Jarkko Patteri (Jarkko)
* Jussi Rautio (jgrr)
* kko
* Matias Parmala
* Matias Pigg
* Mikko Nikkilä (Miccoh)
* Mikko Kraft (deserter)
* Miriam Green
* Niklas Laxström (Nikerabbit)
* paxed
* Samu Voutilainen (Smar)
* Santtu Pajukanta (Japsu)
* Simo Sutela
* Veikko Pukkila (swege)
=== French Translation ===
* Antoine Garnier
* Antoine Imboden
* Aurélien Brevers (Breversa)
* Aurélien Paulus
* Arnaud Garoux (La vie en wose)
* Benoit Astruc
* [mailto:benoit.timbert@free.fr Benoît Timbert] ([[User:Noyga|Noyga]]) — translation maintainer
* Bruno Fève (PP)
* Cédric Duval
* Damian Gryski (dmg)
* [[User:Damien|Damien Jacquot]] — lead translator
* DaringTremayne
* David Pradier
* Éric Pierre (Gari)
* Fabrice Boulakia
* Florence Guettaa (inflow)
* François Mariage (Paquito)
* François Orieux
* Geoffroy Douillié ([[User:Gdou|gdou]])
* Gérard Bodin (Gnork)
* Guillaume Delacourt
* Guillaume Duwelz-Rebert
* Guillaume Guigou
* [mailto:massart.guillaume@wanadoo.fr Guillaume Massart] (Piou2fois)
* Guillaume Melquiond (silene)
* Guillaume Pascal
* Jean Privat (Tout)
* Jean-Louis Passerin (Zoltic)
* Jean-Luc Menut
* Jean-Luc Richard (Le Gnome)
* Jean-Joseph Paget
* Jehan Hysseo (Jey)
* Jérémy Rosen (Boucman)
* Julien Moncel
* Julien Tailleur
* Marc Scheffer
* Mathieu Guilbaud
* Mendes Oulamara
* Michel Poléni (Thanatloc)
* Nicolas Boudin (Blurgk)
* [mailto:philippe.plantier@naema.org Philippe Plantier] ([[User:Ayin|Ayin]])
* Philippe Rasquinet
* Pierre Rudloff
* Sébastien Raynaud (Galactic turkey)
* Sylvain Jeanne
* Thierry Bothorel
* Solena Le Moigne
* William Dupré
* [mailto:ydirson@altern.org Yann Dirson]
=== Friulian Translation ===
=== Galician Translation ===
* [mailto:adriyetichaves@gmail.com Adrián Chaves Fernández] (Gallaecio)
* Fran Diéguez
* Jacobo Abel Fernández García — inactive
* Javier Pico
* Manuel Meixide
* Marce Villarino
* [mailto:leandro.regueiro@gmail.com Leandro Regueiro] (unho) — translation maintainer
* Victor Portela
* Proxecto Trasno — translation project (http://trasno.net)
=== German Translation ===
* Aaron Winter (Bitron)
* Alexander Ginschel (mcpgal)
* Alexander Laux
* Alexander Zurek (Alresu)
* Andre Schmidt (schmidta)
* Boris Stumm (quijote_)
* Celina Mainz (Mailina)
* Chewan
* Christoph Berg (chrber) — former translation maintainer
* Christoph Lange (madelgijs)
* Drakefriend
* Elias Fromm (Karpadorsch)
* Elias Pschernig (allefant)
* ghype
* Lennard
* Lorenzo Hardt (HeroOfGaming)
* Rhonda D'Vine (Rhonda)
* Jan Greve (Jan)
* Jan Heiner Laberenz (jan-heiner)
* Kai Ensenbach
* Konrad Schwede (Konrad2)
* [mailto:marcel_miebach@gmx.de Marcel Miebach] (retr0virus)
* Mark de Wever ([[User:SkeletonCrew|Mordante/SkeletonCrew]])
* Matthias Gianfelice (MatthiasG)
* [mailto:Crazy-Ivanovic@gmx.net Nils Kneuper] (Ivanovic)
* Oliver Lange (Crommy)
* Ronny Standtke
* Ruben Philipp Wickenhäuser (The Very Uhu)
* Severin Glöckner (Shiki, Sevu) — current translation maintainer
* Stephan Grochtmann (Schattenstephan)
* Tobias Schönau (SonIcco)
* Uz-Valentin Friedrich
* vonHalenbach
=== Greek Translation ===
* Alexander Alexiou (Santi/fnaek)
* Evangelos Papakirikou
* Harry Kaimenas
* Katerina Sykioti
* Konstantinos Egarhos
* Konstantinos Karasavvas
* Mik2303
* Nikos Astroylakis (Greek Dubbings Maker)
* Nikos Papadopoulos (galicae)
* Nikos the Great
* Panagiotis Famelis (Kesnar)
* Papadopoulos Themistoklis
* Spiros, Giorgis
=== Hebrew Translation ===
* Ariel Ben-Yehuda
* Oron Peled
* Ely Levy (Nakee)
=== Hungarian Translation ===
* Barthalos Márton (Aldebaran Ghrelin)
* Czakó Csaba (Horus)
* Erdélyi Kristóf
* Fábián Balázs (nermal93)
* Hamar Krisztián
* Kádár-Németh Krisztián (Rudanar Firmus)
* Kékkői László (BlackEvil)
* Kelemen Zoltán (kele)
* Kovács Dániel (Consalamander)
* Majsa Norbert (wias)
* Máthé Katalin (katkadu)
* Németh Tamás (nTOMasz)
* Pintér Csaba (piere)
* Salamon András (ott)
* Soltész Adrián (majominia)
* Széll Tamás (TomJoad)
* Udvari Gábor (Udi)
* Udvari Zsolt
* Vasvári Péter (honorshark)
=== Icelandic Translation ===
* Arngrímur Stefánsson
* Gabríel A. Pétursson
=== Indonesian Translation ===
* Ardhi (earthboy)
* Benny Lin
* [mailto:sevennightmare@tutanota.de Irsyad Musthafa] — translation maintainer
* Iwan
* [mailto:inkraiswitras@yahoo.com Nicky Inkrais Witras] — previous translation maintainer
* [mailto:yuris_wicaksana@yahoo.com Yuristyawan Pambudi Wicaksana] — previous translation maintainer
=== Irish Translation ===
* Mountain_King — translation maintainer
=== Italian Translation ===
* Alessandro Barbazza
* Alessio D'Ascanio (otaku)
* Americo Iacovizzi (DarkAmex)
* [mailto:arosella@yahoo.com Antonio Rosella]
* crys0000
* Elvish_Hunter
* Eugenio Favalli (ElvenProgrammer)
* Federico Tomassetti
* Filippo Abbruzzo (Gwain)
* isazi
* Luciano Montanaro (Luciano)
* Michele Maresi (mich)
* RokStar
* Stefano Coccato (BioHazardX)
=== Japanese Translation ===
* BlueStar
* clearpotion
* h22
* [mailto:broadbarredfirefish@gmail.com Hironori Fujimoto] (RatArmy) — translation maintainer
* [mailto:iwaim.sub@gmail.com IWAI, Masaharu] ([[User:Iwaim|iwaim]])
* [mailto:kateitekino_hito@yahoo.co.jp kateiteki]
* kudoh
* Maxwell Stibbard Hawkes
* [mailto:mishanhideaki88@gmail.com mishan]
* いいむらなおき (amatubu) - Naoki Iimura
* [mailto:okyada@gmail.com 岡田信人 - Nobuhito Okada]
* np
* [mailto:pasta0915[at]gmail.com Shoot MORII] (pastak)
* OOTA, Masato(oo)
* Q
* R.N
* rouiza
* [mailto:le.sahara@gmail.com sahara]
* Shigerello
* [mailto:suto3suto3@gmail.com suto3]
* 瀟湘夜雨
* Taigaku Okuiso
* Takanobu Hirai
* tamanegi
* [mailto:yma9yma@gmail.com yma]
* Yuji Matsumoto
=== Korean Translation ===
* mistzone — current maintainer
=== Latin Translation ===
* Eric S. Raymond (ESR) — general semantician
* Mark Polo (mpolo) — original maintainer
* Michael Babich ([[User:Aethaeryn|Aethaeryn]]) — current maintainer
* [mailto:Majora700@gmail.com Steven Panek] ([[User:Espreon|Espreon]])
* Thomas Hockings ([[User:Deusite|Deusite]])
=== Latvian Translation ===
* Artis Rozentāls
* Gvido Bruveris — Maintainer
* [mailto:rei4dan@gmail.com Reinis Danne]
=== Lithuanian Translation ===
* Andrius Štikonas
* Deimantė Tankus (Diamond)
* Jurgis Sūdžius (Dievas)
* Lukas Gasiūnas (LucasLT)
* Marius Tauba (morlock)
* Raimundas Zabarauskas
* Vytautas Šaltenis (rtfb)
=== Macedonian Translation ===
* Dimitar Ilccov (Mythological)
=== Marathi Translation ===
* [mailto:sujitrjadhav@gmail.com सुजित जाधव] ([[User:sujitrjadhav|Sujit R Jadhav]])
=== Norwegian Translation ===
* Asgeir Aakre (YbeRn00b)
* Erik J. Mesoy (Circon)
* Gaute Jao (Gauteamus)
* Hallvard Norheim Bø (Lysander)
* Håvard Korsvoll
* Pål Inge Larsen (PsyBird)
* Susanne Mesoy (Rarlgland)
=== Old English Translation ===
* [mailto:eirikvw@aim.com Eirik Westcoat]
* [mailto:axonfifty@gmail.com Gottweiß]
* [mailto:Majora700@gmail.com Steven Panek] ([[User:Espreon|Espreon]]) — Maintainer
=== Polish Translation ===
* Agata Chmiel
* Arkadiusz Danilecki (szopen)
* Bartek Waresiak (Dragonking)
* Kamil Matuszewski (LiamTailor)
* Karol Nowak (grzywacz)
* Magdalena Chmiel (Ryouko)
* Marek Kalnik (wdev)
* Michał Hartliński
* Michał Jedynak (Artanis)
* Michał Ligowski (misiorysio)
* Paweł Albecki (gidgnulur)
* Paweł Jackowski (fatality)
* Piotr Kruszewski (Hejnewar)
* Piotr Makarewicz (ForPeace) — Current maintainer
* Robert Wolniak (Szkodnix)
* Roman Polesek (rimskij)
* Sebastian Basierski
* Tadeusz Kopeć
* Zbigniew Banach (vonBureck)
=== Portuguese Translation ===
* Carlos Sousa
* Luis Passos
* trewe — Current maintainer
=== Portuguese (Brazil) Translation ===
* Ambra Viviani Loos
* Andrei Machado — Current maintainer
* Antonio Vildes Barbosa
* Bruno Macabeus
* Celso Goya
* [mailto:cbterra@gmail.com Claudio Terra]
* Claus Aranha
* Di Teixeira (Moroder)
* Diego Inácio Goergen
* [mailto:fred.maranhao@gmail.com Fred Maranhão]
* Hugo Neiva de Melo
* Michel Loos
* Renato Cunha
* Ricardo Sodré Andrade
* Romero Gonçalves
* Sérgio de Miranda Costa
* Tiago Souza (Salvador)
=== Romanian Translation ===
* Unknown
=== Russian Translation ===
* Aldarisvet — Previous maintainer
* [mailto:allryn@pisem.net Aleksandr Aleks]
* Alexandr Gridnev
* Alexandr Menovchicov
* Alexey Remizov
* Alexey Zakharchenko
* Andrey Tikhonov ([[User:tiandrey|tiandrey]])
* Anthony Kolesov
* Artem Khrapov ([[User:Kabachuha|kabachuha]]) — Current maintainer
* Azamat Hackimov ([[User:Winterheart|winterheart]])
* [mailto:BabylonASАТyandexDОTru BabylonAS] ([[User:BabylonAS|BabylonAS]])
* [[User:catbegemot|catbegemot]]
* Danila Evstifeyev (MyOtheHedgeFox)
* Denis Revin (Dut_Norshi)
* Dmitry Brilev (dobryl)
* Fardeil
* Fedor Gavrilov (gallowzbird)
* Fedor Khod'kov (teddy/fkhodkov)
* Ilya Kaznacheev
* Ilya Kotov
* Ishayahu Lastov (Ishayahu)
* Kirill Baranov
* Mikhail Melnik (ZumZoom)
* Nikita Ushkin
* Roman Tuchin (Sankt)
* Sergey Popov (loonycyborg)
* Valentina Mukhamedzhanova (umirra)
* Victor Sergienko (singalen)
* [mailto:vicza@zmail.ru Victor Zabavin]
* Vlad Glagolev
* Yellow Horror
=== Scottish Gaelic Translation ===
* [mailto:fios@foramnagaidhlig.net GunChleoc] — Current maintainer
=== Serbian Translation ===
* Branko Kokanovic (kokan)
* [mailto:caslav.ilic@gmx.net Caslav Ilic]
* [mailto:daliborddjuric@gmail.com Dalibor Djuric]
* [mailto:sreckotoroman@gmail.com Srecko Toroman] (FreeCraft)
=== Slovak Translation ===
* Aceman
* Ivan Kovacs
* Ján Sučan (Bhujanga)
* Marian Kluvanec
* Martin Dzbor
* Martin Plávala (Empy)
* Stano Hoferek (Elven)
* [[User:Viliam|Viliam Bur]]
=== Slovenian Translation ===
* Gregor Petrin
* Jaka Kranjc (lynx)
* Klemen Košir (nNa)
* Matej Repinc
=== Spanish Translation ===
* Alvin Eloy Luna Castro
* Chucho Pulgoso
* David Martínez Moreno
* Diego Grande Rodríguez (Buhako)
* Diego J.
* Fernando Cerezal
* Flamma
* Francisco Muñoz (fmunoz)
* Gabriel Rodríguez (Chewie)
* [mailto:gusgins@gmail.com Gustavo Gingins] (gins)
* [mailto:shadowm2006@gmail.com Iris Morelle] ([[User:Shadowm|Irydacea/shadowm]])
* Iván Herrero (navitux)
* Javier C.H. (perseo)
* Jose Gordillo (kilder)
* Jose Manuel Gomez (joseg)
* Josu Díaz de Arcaya
* Masacroso
* Martín R. Dapás
* Pedro Llorens (PeterPorty)
* Roberto Romero (sildur)
* Sergi March (sergi34)
* [mailto:Majora700@gmail.com Steven Panek] ([[User:Espreon|Espreon]])
* [mailto:quianaaelonin@gmail.com Víctor M. Estrada] (Aelonin/Darkmage)
* Xavier Novella Sinde (XavierNovella)
=== Swedish Translation ===
* Alex Alowersson — current maintainer
* Alexander Kjäll (capitol)
* Andreas Tyrberg
* Åse Petersson (tintin)
* Elias Sevelin (aXidal)
* Gustav Tiger
* Hugo Gerlach (Entrimo)
* Leo Danielson (Lugo Moll)
* Niklas Bolmdahl
* Stefan Bergström (tephlon)
* [mailto:susanna.bjorverud@telia.com Susanna Björverud] (sanna)
* Ulrika Uddeborg
* wint3r
=== Turkish Translation ===
* Ali Erdem Karaçay(Arsivnet)
* Enes Akın (yekialem)
* İhsan Akın
* Kosif
* Nilgün Belma Bugüner
* Pınar Yanardağ (moonquelle)
* Selim Farsakoğlu
=== Ukrainian Translation ===
* Anton Okhrimenko (AncientGeneral)
* [mailto:mansonigor@gmail.com Igor Paliychuk]
* [mailto:arobson@yandex.ru robson] ([[User:Robson|Robson]])
=== Valencian (southern Catalan) Translation ===
* Bernardo Arlandis
* Robert Millan
* Tomás Roig
=== Vietnamese Translation ===
* Huynh Yen Loc
* Le Ngoc Nguyen Chinh
* Pham Hoang Duy
* Pham Thanh Nam
* Pham Thi Yen
=== RACV’s Translation ===
* Mario Rodríguez (Mavorte)
== Sceptre of Fire ==
=== Campaign Design ===
* Joseph Simmons (turin)
=== Campaign Maintenance ===
* Lari Nieminen (zookeeper)
* doofus-01
* nemaara
=== WML Assistance ===
* David Simmons (Dacyn)
* Eli Dupree (Elvish Pillager)
* Lari Nieminen (zookeeper)
* MadMax
=== Artwork and Graphics Design ===
* Asereje
* Blarumyrran — the new Dwarvish Miner sprite
* Emilien Rotival (LordBob) — new portraits
* James Woo (Pickslide) — old portraits
* John-Robert Funck (XJaPaN)
* JonasNL — Dwarvish Miner attack and defense animations
* Peter Geinitz (Wayfarer)
* Pixelmind — Khrakrahs portrait
* Richard Kettering (Jetrel)
* RusHHouR — old gold and coal piles
* doofus-01
== Son Of The Black Eye ==
=== Campaign Design ===
* Benjamin Drieu (Benj) — conception and original design
* Taurus — completion
=== Campaign Maintenance ===
* Lari Nieminen (zookeeper) — current maintainer
* Taurus
=== Prose, Grammatical and WML Assistance ===
* Eric S. Raymond (ESR)
=== Artwork and Graphics ===
* Christian Sirviö (Girgistian) — portraits (sketches)
* Phil Barber (thespaceinvader) — portraits (coloring)
* Sonny T Yamada (SkyOne) — Sprite animations (defense and magic) of orcish shamans
== Northern Rebirth ==
=== Campaign Design ===
* Taurus
=== Artwork and Graphics Design ===
* Battlesquid
* Nicholas Kerpan (Thrawn)
* Richard Kettering (Jetrel)
* Xandar86
=== Prose, Grammatical and WML Assistance ===
* Eric S. Raymond (ESR)
=== Code and Translation Assistance ===
* David Philippi (Torangan)
* Scott Klempner
=== Campaign Maintenance ===
* Charles Dang (vultraz)
== Liberty ==
=== Original Campaign Design ===
* Scott Klempner
=== Latest Rewrite ===
* nemaara
=== Campaign Maintenance ===
* Lari Nieminen (zookeeper)
* Eric S. Raymond (ESR) — Original prose-doctoring and preparation for mainline
=== Artwork and Graphics Design ===
* Brendan Sellner
* Kathrin Polikeit (Kitty) — portraits
* Shadow
* Blarumyrran — story images, Rogue Mage line sprites
* Sonny T Yamada (SkyOne) — Sprite animations (defense and attack) of Rogue Mage line
== Delfadors Memoirs ==
=== Creator and Original Designer ===
* [[User:jp30|Josh Parsons]] — Original designer, responsible for first scenarios 2-10; maintained it up to 0.5.2
=== Co-Authors ===
* Oto 'tapik' Buchta — First scenario, various improvements
* Spiros Alexiou (Santi/fnaek) — Scenarios 12 and following.
* Eric S. Raymond (ESR) — Prose- and script-doctoring, Wesnoth continuity fixes.
=== Campaign Maintenance ===
* Jeffrey 'Sigurd' Westcoat (SigurdFireDragon) — former maintainer
=== WML Programming and Assistance ===
* Fabi — WML bug fixing and polishing.
* Eric S. Raymond (ESR) — Side-mutation and recall-list handling.
* Iris Morelle (Irydacea/shadowm) — WML help
=== Graphics ===
* Kathrin Polikeit (Kitty)
=== Additional thanks to ===
* Arkadiusz D. Danilecki — Inspiration and borrowings from his 'A New Order'
== Heir To The Throne ==
=== Campaign Design ===
* David White (Sirp)
=== Campaign Maintenance ===
* Dimitar Ilccov (Mythological)
* Lari Nieminen (zookeeper) — current maintainer
* Scott Klempner
=== Artwork and Graphics Design ===
* doofus-01 — new sprites and animations (Princess, Battle Princess, Dark Queen, Sea Orc)
* Emilien Rotival (LordBob) — portraits (Delfador, Asheviere, Moremirmu)
* Francisco Muñoz (fmunoz)
* Kathrin Polikeit (Kitty) — portraits (Konrad, Li'sar, Kalenz, Chantal)
* Neoriceisgood
* Richard Kettering (Jetrel)
=== Miscellaneous ===
* Patrick Parker (Sapient) — WML assistance
== Secrets of the Ancients ==
=== Campaign Design, Programming, and Artwork ===
* Dan Gerhards (beetlenaut)
=== Campaign Maintenance ===
* Jeffrey 'Sigurd' Westcoat (SigurdFireDragon) — former maintainer
=== Additional Artwork ===
* Wussel — Some improvements to the ship.
== Legend of Wesmere ==
=== Creator and Lead Designer ===
* [mailto:moka1@otenet.gr Spiros, George and Alexander Alexiou] ([[User:Santi|Santi/fnaek]]) — Main designers, former maintainers.
=== Campaign Maintenance ===
* Fabi/Fendrin — Current maintainer
* Spiros, George and Alexander Alexiou (Santi/fnaek)
=== Prose-doctoring and adaptation for mainline ===
* Eric S. Raymond (esr)
* Fabi/Fendrin — Major WML rewrite for mainline
=== WML Assistance ===
* Alexander van Gessel (AI/AI0867) — bugfixing and general WML cleanups
* Iris Morelle (Irydacea/shadowm) — for A LOT of help with WML and interesting campaign suggestions
* Lari Nieminen (zookeeper) — for A LOT of help with WML
=== Artificial Intelligence ===
* Yurii Chernyi (crab) — coding of the new ai and help with corresponding redesigns
=== Graphics ===
* Bora Orcal (bera) — goblin horn rouser
* Kathrin Polikeit (Kitty) — who did a great job with portraits and other graphics
-the main reason for having a polished campaign
* Steven Panek (Espreon) — map artist
=== Additional thanks to ===
* Scott — for help with WML, especially the use of store/unstore
* WhiteWizard — Initial porting to 1.2
* Disto — for elvish units
* RedLTeut — for great improvements to the initial invisible elvish units
* Dacyn — who was of great help in the beginning of this project
* Big Bad Joe
* breversa
* Invisible Philosopher
* js138
* l'ultimo cruco
* Mad Max
* Rhuvaen
* SelfishWeirdo
* Scott
* Sly
* Teldar
* Turin
* And the rest of the Wesnoth community for feedback,
criticism, help with WML code and graphics.
== The South Guard ==
=== Campaign Design ===
* William Carey (aelius)
=== Latest Campaign Revision ===
* nemaara
=== Campaign Maintenance ===
* nemaara — current maintainer
* Lari Nieminen (zookeeper)
* Eric S. Raymond (ESR)
* Wintermute
=== Artwork and Graphics Design ===
* J.W. Bjerk (eleazar)
* Kathrin Polikeit (Kitty) — portraits
* Lari Nieminen (zookeeper)
* Scavenger — new story images and Mal M'Brin portrait
* rhyging5
* Shadow
* William Carey (aelius)
== Two Brothers ==
=== Campaign Design ===
* Eric J. Mesoy (Circon)
* Nils Kneuper (Ivanovic)
=== Prose and Story Edits ===
* Eric S. Raymond (esr)
* A-Red
=== Campaign Maintenance ===
* Nils Kneuper (Ivanovic)
* Charles Dang (vultraz)
=== Artwork and Graphics Design ===
* Arkadiusz Danileki (szopen)
* Kathrin Polikeit (Kitty) — current portraits
* MadMax
* Stefan
=== Miscellaneous ===
* Bartek Waresiak (Dragonking)
* Christoph Berg (chrber)
* Daravel
* Jozrael
* And special thanks to everyone else who I forgot to mention.
== Under the Burning Suns ==
=== Campaign Design ===
* Asa Swain
* Piotr Cychowski (Mist/cycholka)
=== Campaign Maintenance ===
* Iris Morelle (Irydacea/shadowm)
* Jan Rietema (Rhuvaen)
* Lari Nieminen (zookeeper)
* Piotr Cychowski (Mist/cycholka)
* Simon Forsyth (Alarantalara)
* Steven Panek (Espreon)
=== Artwork and Graphics Design ===
* Dan Gerhards (beetlenaut) — new Flesh Golem sprites
* Kwandulin — New Kaleh and Nym sprites
* doofus-01 — Monster Crab sprite
* Hogne Haskjold (Frame)
* Iris Morelle (Irydacea/shadowm)
* J.W. Bjerk (Eleazar)
* James Woo (Pickslide)
* Javier Hoyos (Vendanna)
* Marcus Rosén (sleepwalker) — Dark Assassin sprite and animations
* Mark Goodenough (Ranger M)
* Mikolaj Machowski (Emdot)
* Murray Cook (Zhukov)
* Peter Geinitz (Shadow)
* Richard Kettering (Jetrel)
* Sangel
* Samuel Wilson (megane)
* Scott Klempner
* Vincent Langner (Vyncyn) — Spider Lich and Human Commander sprites
* Zerovirus — Naga Hunter sprite
=== Miscellaneous ===
* Fabian Müller (Fabi/Fendrin)
* Mark Polo
* Matthias Schoeck (mattsc) — Messenger AI
* Isaac
* Ringcaat (Thorin N. Tatge)
* And special thanks to everyone else who I forgot to mention.
== Descent Into Darkness ==
=== Original Campaign Design ===
* esci
=== Latest Campaign Revision ===
* nemaara
=== Artwork and Graphics Design ===
* Blarumyrran — story images
* Emilien Rotival (LordBob) — current portraits
* theycallmerooster — old portraits
=== Miscellaneous ===
* josteph — dialogue comments and revisions
== Dead Water ==
=== Campaign design and programming ===
* Dan Gerhards (beetlenaut)
=== Script-doctoring and cleanup for mainline ===
* Eric S. Raymond (ESR)
=== Artwork ===
* Kathrin Polikeit (Kitty) — Portraits for brawler, Kai Krellis, Gwabbo, and Caladon
* Justin Nichols (JustinOperable) — Portrait for Cylanna
* Zerovirus — Kai Krellis sprites
* Francisco Muñoz (fmunoz) — Attack icons
== The Rise Of Wesnoth ==
=== Campaign Design ===
* James Spencer (Shade)
=== Campaign Maintenance ===
* Dimitar Ilccov (Mythological)
* Lari Nieminen (zookeeper) — current maintainer
* Scott Klempner
=== Artwork and Graphics Design ===
* Blarumyrran — the new Vampire Lady sprite
* J.W. Bjerk (eleazar)
* Lari Nieminen (zookeeper)
* Emilien Rotival (LordBob) — new portraits and story art
* Michael Gil de Muro (grp21) — old portraits
* pixelmind — Shek'kahan portrait
=== WML Contributors ===
* Iris Morelle (Irydacea/shadowm)
* Lari Nieminen (zookeeper)
== The Hammer of Thursagan ==
=== Author ===
* Eric S. Raymond (esr)
=== Special Guest Designer ===
* Taurus
=== Art ===
* Kim Holm (DUHH)
* Phil Barber (thespaceinvader)
* Vincent Langner (Vyncyn) — New Dwarvish Witness line sprites and animations
=== Brainstorming, playtesting, and spousal support ===
* Cathy O. Raymond
=== Campaign Maintenance ===
* Charles Dang (vultraz)
== Eastern Invasion ==
=== Campaign Design ===
* Joseph Simmons (turin)
=== Campaign Maintenance ===
* Dimitar Ilccov (Mythological)
* Lari Nieminen (zookeeper) — current maintainer
* Astrid Halberkamp
=== Campaign Epilogue and Continuity ===
* Eric S. Raymond (ESR)
=== Prose and Story Edits ===
* Loci
=== Artwork and Graphics Design ===
* Aaron Redfern (A-Red) — New Owaec sprites
* Emilien Rotival (LordBob) — new portraits
* James Woo (Pickslide) — old portraits
* Neoriceisgood
[[Category:Generated]]

LuaAPI/UpdatingFrom14

2021-10-06T19:15:57Z

Shadowm: Fix a couple of mistakes

This page contains a summary of the major Lua API changes between 1.12 and 1.15, to help make updating older code simpler.

In general, when it says "renamed", the new function is a drop-in replacement for the old one. When it says "replaced", the new function probably has a different API (such as different arguments) or might not even be a function at all.

For some of these that are more than just a simple rename, an example is given where the old, pre-1.16 code is shown commented out and the new code is shown below it.

=== Functions in wesnoth namespace ===

* '''weesnoth.remove_fog''' renamed to '''wesnoth.sides.remove_fog'''
* '''wesnoth.add_ai_component''' renamed to '''wesnoth.sides.add_ai_component'''
* '''wesnoth.add_fog''' renamed to '''wesnoth.sides.place_fog'''
* '''wesnoth.add_modification''' renamed to '''wesnoth.units.add_modification'''
* '''wesnoth.add_sound_source''' replaced with '''wesnoth.audio.sources''' mapping (write to key)
**<syntaxhighlight lang=lua>
-- wesnoth.add_sound_source{id=my_id, x=15, y=22, sound='my-sound.ogg'}
wesnoth.audio.sources.my_id = {x=15, y=22, sound='my-sound.ogg'}
</syntaxhighlight>
* '''wesnoth.add_tile_overlay''' renamed to '''wesnoth.interface.add_hex_overlay'''
* '''wesnoth.add_widget_definition''' renamed to '''gui.add_widget_definition'''
* '''wesnoth.advance_unit''' renamed to '''wesnoth.units.advance'''
* '''wesnoth.alert''' renamed to '''gui.alert'''
* '''wesnoth.allow_end_turn''' renamed to '''wesnoth.interface.allow_end_turn'''
* '''wesnoth.append_ai''' renamed to '''wesnoth.sides.append_ai'''
* '''wesnoth.canonical_path''' renamed to '''filesystem.canonical_path'''
* '''wesnoth.change_ai_component''' renamed to '''wesnoth.sides.change_ai_component'''
* '''wesnoth.clear_messages''' renamed to '''wesnoth.interface.clear_chat_messages'''
* '''wesnoth.color_adjust''' replaced with '''wesnoth.interface.color_adjust'''
* '''wesnoth.compare_versions''' replaced with '''wesnoth.version''', which creates a version object that can be compared with standard comparison operators
**<syntaxhighlight lang=lua>
-- if wesnoth.compare_versions(wesnoth.game_config.version, '<=', '1.13') then
if wesnoth.current_version() <= wesnoth.version '1.13' then
-- do version-specific stuff
end</syntaxhighlight>
* '''wesnoth.confirm''' renamed to '''gui.confirm'''
* '''wesnoth.copy_unit''' renamed to '''wesnoth.units.clone'''
* '''wesnoth.create_animator''' renamed to '''wesnoth.units.create_animator'''
* '''wesnoth.create_side''' renamed to '''wesnoth.sides.create'''
* '''wesnoth.create_unit''' renamed to '''wesnoth.units.create'''
* '''wesnoth.create_weapon''' renamed to '''wesnoth.units.create_weapon'''
* '''wesnoth.debug_ai''' renamed to '''wesnoth.sides.debug_ai'''
* '''wesnoth.debug''' renamed to '''wml.tostring'''; in addition, it now produces an output that is valid WML, meaning that <syntaxhighlight lang=lua inline>wml.parse(wml.tostring(wml_table))</syntaxhighlight> will output a clone of '''wml_table''' (though for this purpose there's a separate '''wml.clone''' function which is probably faster).
* '''wesnoth.delay''' renamed to '''wesnoth.interface.delay'''
* '''wesnoth.delete_ai_component''' renamed to '''wesnoth.sides.delete_ai_component'''
* '''wesnoth.deselect_hex''' renamed to '''wesnoth.interface.deselect_hex'''
* '''wesnoth.end_level''' replaced with assignable '''wesnoth.scenario.end_level_data'''
* '''wesnoth.end_turn''' renamed to '''wesnoth.interface.end_turn'''
* '''wesnoth.erase_unit''' renamed to '''wesnoth.units.erase'''
* '''wesnoth.eval_conditional''' renamed to '''wml.eval_conditional'''
* '''wesnoth.extract_unit''' renamed to '''wesnoth.units.extract'''
* '''wesnoth.find_cost_map''' renamed to '''wesnoth.paths.find_cost_map'''
* '''wesnoth.find_path''' renamed to '''wesnoth.paths.find_path'''
* '''wesnoth.find_reach''' renamed to '''wesnoth.paths.find_reach'''
* '''wesnoth.find_vacant_tile''' renamed to '''wesnoth.paths.find_vacant_hex'''
* '''wesnoth.find_vision_range''' renamed to '''wesnoth.paths.find_vision_range'''
* '''wesnoth.float_label''' renamed to '''wesnoth.interface.float_label'''
* '''wesnoth.format_conjunct_list''' renamed to '''stringx.format_conjunct_list'''
* '''wesnoth.format_disjunct_list''' renamed to '''stringx.format_disjunct_list'''
* '''wesnoth.format''' renamed to '''stringx.vformat''' and can also be called directly on a string literal
* '''wesnoth.gamestate_inspector''' renamed to '''gui.show_inspector'''
* '''wesnoth.get_all_vars''' replaced with read-only variable '''wml.all_variables''' (but it should still be used sparingly)
* '''wesnoth.get_displayed_unit''' renamed to '''wesnoth.interface.get_displayed_unit'''
* '''wesnoth.get_end_level_data''' replaced with readable '''wesnoth.scenario.end_level_data'''
* '''wesnoth.get_image_size''' renamed to '''filesystem.image_size'''
* '''wesnoth.get_max_liminal_bonus''' replaced with read-only '''wesnoth.current.schedule.liminal_bonus'''
* '''wesnoth.get_mouseover_tile''' renamed to '''wesnoth.interface.get_hovered_hex'''
* '''wesnoth.get_recall_units''' renamed to '''wesnoth.units.find_on_recall'''
* '''wesnoth.get_selected_tile''' renamed to '''wesnoth.interface.get_selected_hex'''
* '''wesnoth.get_side_variable''' and '''wesnoth.set_side_variable''' replaced by '''variables''' member in side data (found in '''wesnoth.sides''' array). This otherwise works the same as '''wml.variables'''.
** <syntaxhighlight lang=lua>
-- local old_value = wesnoth.get_side_variable(1, 'my_value')
local old_value = wesnoth.sides[1].variables['my_value'] -- or variables.myvalue
local new_value = old_value * 2
-- wesnoth.set_side_variable(1, 'my_value', new_value)
wesnoth.sides[1].variables['my_value'] = new_value
</syntaxhighlight>
* '''wesnoth.get_sides''' renamed to '''wesnoth.sides.find'''
* '''wesnoth.get_sound_source''' replaced with '''wesnoth.audio.sources''' mapping (read key)
* '''wesnoth.get_starting_location''' replaced by '''starting_location''' member in side data
* '''wesnoth.get_time_of_day''' replaced with '''wesnoth.schedule.get_time_of_day''' and '''wesnoth.schedule.get_illumination''' as well as '''wesnoth.current.schedule.time_of_day'''
** <syntaxhighlight lang=lua>
-- local global_tod = wesnoth.get_time_of_day(wesnoth.current.turn + 1)
local global_tod = wesnoth.schedule.get_time_of_day(nil, wesnoth.current.turn + 1)
-- local base_tod = wesnoth.get_time_of_day(wesnoth.current.turn + 1, {44, 23})
local base_tod = wesnoth.schedule.get_time_of_day({44, 23}, wesnoth.current.turn + 1)
-- local final_tod = wesnoth.get_time_of_day(wesnoth.current.turn + 1, {44, 23, true})
local final_tod = wesnoth.schedule.get_illumination({44, 24}, wesnoth.current.turn + 1)
</syntaxhighlight>
* '''wesnoth.get_time_stamp''' renamed to '''wesnoth.ms_since_init'''
* '''wesnoth.get_traits''' replaced with '''wesnoth.game_config.global_traits''', which is the table it formerly returned
* '''wesnoth.get_unit''' renamed to '''wesnoth.units.get'''
* '''wesnoth.get_units''' renamed to '''wesnoth.units.find_on_map'''
* '''wesnoth.get_variable''' and '''wesnoth.set_variable''' are replaced by '''wml.variables''' which can be indexed with a variable path - set a variable by assigning to it
** <syntaxhighlight lang=lua>
-- local old_value = wesnoth.get_variable('my_array[2].value')
local old_value = wesnoth.variables['my_array[2].value']
local new_value = old_value * 2
-- wesnoth.set_variable('my_array[2].value', new_value)
wesnoth.variables['my_array[2].value'] = new_value
</syntaxhighlight>
* '''wesnoth.have_file''' renamed to '''filesystem.have_file'''
* '''wesnoth.highlight_hex''' renamed to '''wesnoth.interface.highlight_hex'''
* '''wesnoth.invoke_synced_command''' renamed to '''wesnoth.sync.invoke_command'''
* '''wesnoth.is_enemy''' renamed to '''wesnoth.sides.is_enemy'''
* '''wesnoth.is_fogged''' renamed to '''wesnoth.sides.is_fogged'''
* '''wesnoth.is_shrouded''' renamed to '''wesnoth.sides.is_shrouded'''
* '''wesnoth.is_skipping_messages''' renamed to '''wesnoth.interface.is_skipping_messages'''
* '''wesnoth.lock_view''' renamed to '''wesnoth.interface.lock'''
* '''wesnoth.match_side''' renamed to '''wesnoth.sides.matches'''
* '''wesnoth.match_unit''' renamed to '''wesnoth.units.matches'''
* '''wesnoth.message''' renamed to '''wesnoth.interface.add_chat_message'''
* '''wesnoth.music_list''' renamed to '''wesnoth.audio.music_list'''
* '''wesnoth.open_help''' renamed to '''gui.show_help'''
* '''wesnoth.place_shroud''' replaced with '''wesnoth.sides.place_shroud''' and '''wesnoth.sides.override_shroud'''
* '''wesnoth.play_sound''' renamed to '''wesnoth.audio.play'''
* '''wesnoth.put_recall_unit''' renamed to '''wesnoth.units.to_recall'''
* '''wesnoth.put_unit''' renamed to '''wesnoth.units.to_map'''
* '''wesnoth.random''' renamed to '''mathx.random'''
* '''wesnoth.read_file''' renamed to '''filesystem.read_file'''
* '''wesnoth.remove_modifications''' renamed to '''wesnoth.units.remove_modifications'''
* '''wesnoth.remove_sound_source''' replaced with '''wesnoth.audio.sources''' mapping (assign nil to key)
* '''wesnoth.remove_tile_overlay''' renamed to '''wesnoth.interface.remove_hex_overlay'''
* '''wesnoth.replace_schedule''' renamed to '''wesnoth.schedule.replace'''
* '''wesnoth.scroll_to_tile''' renamed to '''wesnoth.interface.scroll_to_hex'''
* '''wesnoth.scroll''' renamed to '''wesnoth.interface.scroll'''
* '''wesnoth.select_unit''' renamed to '''wesnoth.units.select''' (also available as wesnoth.interface.select_unit)
* '''wesnoth.set_end_campaign_credits''' replaced with assignable '''wesnoth.scenario.show_credits'''
* '''wesnoth.set_end_campaign_text''' replaced with assignable '''wesnoth.scenario.end_text''' and '''wesnoth.scenario.end_text_duration'''
* '''wesnoth.set_next_scenario''' replaced with assignable '''wesnoth.scenario.next'''
* '''wesnoth.set_side_id''' renamed to '''wesnoth.sides.set_id'''
* '''wesnoth.set_time_of_day''' (which was undocumented and unofficial) replaced with assigning '''wesnoth.current.schedule.time_of_day''', though that only covers part of the original functionality
* '''wesnoth.show_lua_console''' renamed to '''gui.show_lua_console'''
* '''wesnoth.show_menu''' renamed to '''gui.show_menu'''
* '''wesnoth.show_message_box''' renamed to '''gui.show_prompt'''
* '''wesnoth.show_message_dialog''' renamed to '''gui.show_narration'''
* '''wesnoth.show_popup_dialog''' renamed to '''gui.show_popup'''
* '''wesnoth.show_story''' renamed to '''gui.show_story'''
* '''wesnoth.skip_messages''' renamed to '''wesnoth.interface.skip_messages'''
* '''wesnoth.sound_volume''' replaced with read-write '''wesnoth.audio.volume'''
* '''wesnoth.switch_ai''' renamed to '''wesnoth.sides.switch_ai'''
* '''wesnoth.synchronize_choice''' renamed to '''wesnoth.sync.evaluate_single'''
* '''wesnoth.synchronize_choices''' renamed to '''wesnoth.sync.evaluate_multiple'''
* '''wesnoth.teleport''' renamed to '''wesnoth.units.teleport'''
* '''wesnoth.theme_items''' renamed to '''wesnoth.interface.game_display''' - it's still a table with the same keys as before
* '''wesnoth.tovconfig''' renamed to '''wml.tovconfig'''
* '''wesnoth.transform_unit''' renamed to '''wesnoth.units.transform'''
* '''wesnoth.unit_ability''' renamed to '''wesnoth.units.ability'''
* '''wesnoth.unit_defense''' renamed to '''wesnoth.units.chance_to_be_hit'''
* '''wesnoth.unit_jamming_cost''' renamed to '''wesnoth.units.jamming_on'''
* '''wesnoth.unit_movement_cost''' renamed to '''wesnoth.units.movement_on'''
* '''wesnoth.unit_resistance''' renamed to '''wesnoth.units.resistance'''
* '''wesnoth.unit_vision_cost''' renamed to '''wesnoth.units.vision_on'''
* '''wesnoth.unsynced''' renamed to '''wesnoth.sync.run_unsynced'''
* '''wesnoth.view_locked''' renamed to '''wesnoth.interface.is_locked'''
* '''wesnoth.wml_matches_filter''' renamed to '''wml.matches_filter'''
* '''wesnoth.zoom''' renamed to '''wesnoth.interface.zoom'''

==== wesnoth.tovconfig and related functions in plugins ====

The '''wesnoth.tovconfig''' function has been removed from the plugin context. This will have no effect on most people, as the plugin context is rarely used. A plugin context is any Lua script loaded using the <tt>--plugin</tt> command-line parameter, primarily intended for creating bots on the multiplayer server.

If you were calling '''wesnoth.tovconfig''' in a plugin, then you have several options for updating your code. If you simply needed to verify that a variable holds a valid WML table, you can use '''wml.valid''' instead. If you need to substitute variables into a WML table, you can also use '''wml.interpolate''' to replicate the behaviour of '''wml.tovconfig''', supplying the variables themselves as an extra argument (another WML table).

In addition, the helper functions '''parsed''', '''literal''', '''shallow_parsed''', and '''shallow_literal''' are not available in the plugin context.

==== GUI2 API ====

There has been a major rehaul of the GUI2 API for arbitrary custom dialogs. See [[LuaAPI/types/widget]] and [[LuaAPI/gui/widget]] for details; the changes are also summarized below.

* '''wesnoth.add_dialog_tree_node''' renamed to '''gui.widget.add_item_of_type''' and now takes a reference to the widget instead of a path to it; use '''gui.widget.find''' to convert a path to a reference
* '''wesnoth.get_dialog_value''' and '''wesnoth.set_dialog_value''' removed; instead access the appropriate member of the widget, such as '''selected_index''' or '''selected''' or '''text''' or '''value''' or '''percentage''' or '''selected_item_path''' or '''unfolded''' or '''unit''' or '''label'''. Some of these may be write-only.
* '''wesnoth.remove_dialog_item''' renamed to '''gui.widget.remove_items_at''' and now takes a reference to the widget instead of a path to it; use '''gui.widget.find''' to convert a path to a reference.
* '''wesnoth.set_dialog_active''' removed; instead assign the '''enabled''' member of a widget
**<syntaxhighlight lang=lua >
-- local function preshow()
local function preshow(self)
local var_a = true
-- whatever you are doing to determine if button should be active
-- wesnoth.set_dialog_active(var_a, "my_button_id")
local widget_handle = self:find('my_button_id') -- or just self.my_button_id
widget_handle.enabled = var_a
-- ...
end
</syntaxhighlight>
* '''wesnoth.set_dialog_callback''' removed; instead simply assign to a widget's callback handler, eg <syntaxhighlight lang=lua inline>my_widget.on_modified = function() end</syntaxhighlight>
**<syntaxhighlight lang=lua >
-- local function preshow()
local function preshow(self)
local function on_text_modified()
-- Do whatever you need to do
end
-- This example shows an on_modified event; there's also on_left_click and on_button_click
-- Use one of the click events if you were setting the callback on a button.
-- wesnoth.set_dialog_callback(on_text_modified, "my_text_id")
local widget_handle = self:find('my_text_id') -- or just self.my_text_id
widget_handle.on_modified = set_dialog_callback
-- Or you could have defined the function here like this:
-- function widget_handle.on_modified()
-- ...
end
</syntaxhighlight>
* '''wesnoth.set_dialog_canvas''' renamed to '''gui.widget.set_canvas''' and now takes a reference to the widget instead of a path to it; use '''gui.widget.find''' to convert a path to a reference
* '''wesnoth.set_dialog_focus''' renamed to '''gui.widget.focus''' and now takes a reference to the widget instead of a path to it; use '''gui.widget.find''' to convert a path to a reference
**<syntaxhighlight lang=lua >
-- local function preshow()
local function preshow(self)
-- wesnoth.set_dialog_focus("my_text_id")
local widget_handle = self:find('my_text_id') -- or just self.my_text_id
widget_handle:focus()
-- ...
end
</syntaxhighlight>
* '''wesnoth.set_dialog_markup''' removed; instead assign the '''use_markup''' member of a widget
* '''wesnoth.set_dialog_tooltip''' removed; instead assign the '''tooltip''' member of a widget
**<syntaxhighlight lang=lua >
-- local function preshow()
local function preshow(self)
local var_a = 'Some explanation'
-- whatever you are doing to determine the button's tooltip
-- wesnoth.set_dialog_tooltip(var_a, "my_button_id")
local widget_handle = self:find('my_button_id') -- or just self.my_button_id
widget_handle.tooltip = var_a
-- ...
end
</syntaxhighlight>
* '''wesnoth.set_dialog_visible''' removed; instead assign the '''visible''' member of a widget
**<syntaxhighlight lang=lua >
-- local function preshow()
local function preshow(self)
local var_a = true
-- whatever you are doing to determine if button should be visible
-- wesnoth.set_dialog_visible(var_a, "my_button_id")
local widget_handle = self:find('my_button_id') -- or just self.my_button_id
widget_handle.visible = var_a
-- ...
end
</syntaxhighlight>
* '''wesnoth.show_dialog''' renamed to '''gui.show_dialog'''
* The '''preshow''' and '''postshow''' functions passed to '''gui.show_dialog''' now take a single parameter, which is a reference to the dialog's root widget (a widget of type "window"). This can be passed to '''gui.widget.find''' to look up widgets by their path. You can also access direct child widgets by simply indexing the root widget.

==== Map API ====

Due to a major rehaul of the map API, many map functions are now methods on the map object, available as '''wesnoth.current.map''' (abbreviated in the below listing to just '''map''').

* '''wesnoth.add_time_area''' renamed to '''wesnoth.map.place_area'''
* '''wesnoth.get_locations''' renamed to '''wesnoth.map.find'''
* '''wesnoth.get_map_size''' replaced with '''map.playable_width''', '''map.playable_height''', and '''map.border_size'''
**<syntaxhighlight lang=lua>
-- local width, height, border_size = wesnoth.get_map_size()
local width, height = wesnoth.current.map.playable_width, wesnoth.current.map.playable_height
local border_size = wesnoth.current.map.border_size
-- local width_with_border, height_with_border = width + border_size * 2, height + border_size * 2
local width_with_border, height_with_border = wesnoth.current.map.width and wesnoth.current.map.height
</syntaxhighlight
* '''wesnoth.get_terrain_info''' replaced with '''wesnoth.terrain_types'''
**<syntaxhighlight lang=lua>
-- local info = wesnoth.get_terrain_info('Gg')
local info = wesnoth.terrain_types['Gg']
</syntaxhighlight>
* '''wesnoth.get_terrain''' replaced with '''map[{x,y}]'''
**<syntaxhighlight lang=lua>
-- local terrain = wesnoth.get_terrain(x, y)
local terrain = wesnoth.current.map[{x,y}]
-- local terrain_under_unit = wesnoth.get_terrain(unit.x, unit.y)
local terrain_under_unit = wesnoth.current.map[unit]
</syntaxhighlight>
* '''wesnoth.get_village_owner''' renamed to '''wesnoth.map.get_owner'''
* '''wesnoth.get_villages''' replaced with '''wesnoth.map.find''' (with '''gives_income = true''')
**<syntaxhighlight lang=lua>
-- For example, get all villages in [time_area]id=shadowed
-- local villages = wesnoth.get_villages{area = 'shadowed'}
local villages = wesnoth.map.find{area = 'shadowed', gives_income = true}
</syntaxhighlight>
* '''wesnoth.label''' renamed to '''wesnoth.map.add_label'''
* '''wesnoth.match_location''' renamed to '''wesnoth.map.matches'''
* '''wesnoth.remove_time_area''' renamed to '''wesnoth.map.remove_area'''
* '''wesnoth.set_terrain''' replaced with assigning '''map[{x,y}]''' - helper functions in '''wesnoth.map''' expose the more advanced assignment operations ('''replace_overlay''', '''replace_both''', '''replace_if_failed''') - just assign the result of one of these functions to the hex
**<syntaxhighlight lang=lua>
-- wesnoth.set_terrain(x, y, 'Gg')
wesnoth.current.map[{x,y}] = 'Gg'
-- Or be explicit about layer:
wesnoth.current.map[{x,y}] = wesnoth.map.replace_both 'Gg'
-- wesnoth.set_terrain(x, y, 'Gg', 'base')
wesnoth.current.map[{x,y}] = wesnoth.map.replace_base 'Gg'
-- wesnoth.set_terrain(x, y, '^Vh', 'overlay')
wesnoth.current.map[{x,y}] = wesnoth.map.relace_overlay '^Vh'
-- wesnoth.set_terrain(x, y, 'Gg^Vh', 'overlay', true)
wesnoth.current.map[{x,y}] = wesnoth.map.replace_if_failed('Gg^Vh', 'overlay')
</syntaxhighlight>
* '''wesnoth.set_village_owner''' renamed to '''wesnoth.map.set_owner'''
* '''wesnoth.special_locations''' renamed to '''map.special_locations''' (note: the length operator is no longer supported)
* '''wesnoth.terrain_mask''' replaced with '''map:terrain_mask'''

The following functions are only available in map generation scripts:

* '''wesnoth.create_filter''' renamed to '''wesnoth.map.filter'''
* '''wesnoth.create_map''' renamed to '''wesnoth.map.create'''
* '''wesnoth.default_generate_height_map''' renamed to '''wesnoth.map.generate_height_map'''
* '''wesnoth.generate_default_map''' renamed to '''wesnoth.map.generate'''
* '''map:get_locations''' renamed to '''map:find'''
* '''map:get_tiles_radius''' replaced with '''map::find_in_radius''' (and the order of arguments changed)
**<syntaxhighlight lang=lua>
-- This example assumes you have a variable f defined as in World Conquest (engine.lua)
-- local in_radius = map:get_tiles_radius(12, 22, f.terrain 'Gg', 5)
local in_radius = map:find_in_radius(12, 22, 5, f.terrain 'Gg')
</syntaxhighlight>

=== helper module ===

The helper module is being phased out, so quite a lot of things have been moved out of it. This section is written under the assumption that you loaded it with <syntaxhighlight lang=lua inline>local helper = wesnoth.require "helper"</syntaxhighlight> or the like, but many people call it '''H''' instead of '''helper''', so keep that in mind.

* '''helper.child_array''' renamed to '''wml.child_array'''
* '''helper.child_count''' renamed to '''wml.child_count'''
* '''helper.child_range''' renamed to '''wml.child_range'''
* '''helper.distance_between''' renamed to '''wesnoth.map.distance_between'''
* '''helper.find_attack''' renamed to '''wesnoth.units.find_attack'''
* '''helper.get_child''' renamed to '''wml.get_child'''
* '''helper.get_nth_child''' renamed to '''wml.get_nth_child'''
* '''helper.get_user_choice''' renamed to '''gui.get_user_choice'''
* '''helper.get_variable_array''' renamed to '''wml.array_access.get'''
* '''helper.get_variable_proxy_array''' renamed to '''wml.array_access.get_proxy'''
* '''helper.literal''' renamed to '''wml.literal'''
* '''helper.modify_unit''' renamed to '''wesnoth.units.modify'''
* '''helper.move_unit_fake''' renamed to '''wesnoth.interface.move_unit_fake'''
* '''helper.parsed''' renamed to '''wml.parsed'''
* '''helper.rand''' renamed to '''mathx.random_choice'''
* '''helper.round''' renamed to '''mathx.round'''
* '''helper.set_variable_array''' renamed to '''wml.array_access.set'''
* '''helper.set_wml_tag_metatable''' replaced with '''wml.tag''', which is a table that works exactly the same as what this function would return
**<syntaxhighlight lang=lua>
-- local T = helper.set_wml_tag_metatable{}
local T = wml.tag -- Or you can dispense with T and use wml.tag directly
</syntaxhighlight>
* '''helper.set_wml_var_metatable''' replaced with '''wml.variable.proxy''', which is a table that works exactly the same as what this function would return
* '''helper.shallow_literal''' renamed to '''wml.shallow_literal'''
* '''helper.shallow_parsed''' renamed to '''wml.shallow_parsed'''
* '''helper.shuffle''' renamed to '''mathx.shuffle'''
* '''helper.wml_error''' renamed to '''wml.error'''

=== items module ===

There were also a few things in an "items" module that have been moved into the main API.

* '''items.place_halo''' renamed to '''wesnoth.interface.add_item_halo'''
* '''items.place_image''' renamed to '''wesnoth.interface.add_item_image'''
* '''items.remove''' renamed to '''wesnoth.interface.remove_item'''

[[Category:Lua Reference]]

BuildingScenarios/es

2021-08-24T08:27:51Z

Shadowm: Update links to macro-reference.html

{{Translations}}
{| style="float:right"
|
__NOTOC__
|}

<div class="navtemplate">Enlaces de creación: [[BuildingMaps/es | Mapas]] | [[BuildingScenarios/es | Escenarios]] | [[BuildingCampaigns/es | Campañas]] | [[MultiplayerContent| Multijugadores]] | [[BuildingUnits | Unidades]] </div class="navtemplate">
 
{| style="right; margin-left:1em;"
|__TOC__
|}
 
= Escenarios =
 
Los escenarios de Wesnoth son niveles individuales que forman parte de las campañas. También pueden ser mapas avanzados, con personajes y elementos adicionales, que pueden ser jugados por múltiples jugadores. Cada escenario contiene dos archivos: el primero es un mapa (vea [[BuildingMaps]]; y el segundo, es el archivo de configuración (conocido como archivo «config»). Este último, se utiliza para describir todo sobre el escenario. Ambos archivos tienen que estar escritos en el código de carácteres ASCII (acrónimo en inglés para «código estándar estadounidense para el intercambio de información») y deben poder editarse en cualquier editor de texto (e.g. vi, notepad, etc.). No se recomienda utilizar un procesador de textos (e.g. Microsoft Word; OpenOffice Writer; etc.), pero si aún así decide hacerlo, no olvide guardar el archivo como un tipo texto (e.i. .txt).
 
* '''Nota:''' los escenarios siempre son escritos en el [[ReferenceWML | lenguaje de marcado de Wesnoth]] (mejor conocido por sus siglas en inglés «WML», que significan «Wesnoth Markup Language»).
 
Esta sección se divide en varias partes, que incluyen un tutorial básico y la explicación del uso de técnicas avanzadas y complejas. Se espera que, al finalizar la lectura de todas las partes de esta sección, usted tenga el conocimiento necesario para crear su propios escenarios para «La Batalla por Wesnoth».
 
'''(La mayoría de los enlaces llevan a sitios completamente en el idioma inglés, salvo aquellos que indican lo contrario.)'''
 
<div class="navtemplate">
==== Índice ====
===== Creando escenarios =====
:* [[BuildingScenariosSimple|Simple]] - [[BuildingScenariosIntermediate | Intermedio]] - [[BuildingScenariosAdvanced|Avanzado]]
:* [[BuildingScenariosSamples|Código de ejemplo]] - ejemplo básico de un código
:* [[ShroudDataWML|Tutorial SHROUD_DATA]] - un tutorial en «shroud_data»
:* [[BuildingScenariosBalancing|Creando un balance]] - cómo balancear su escenario
</div class="navtemplate">
 
<div class="navtemplate">

==== Índice de etiqueta rápida ====
[[ScenarioWML]] - las etiquetas de nivel superior: [scenario], [multiplayer], [test] y [tutorial]
:* [[EventWML]] - cómo describir un evento
:** [[FilterWML]]
:** [[DirectActionsWML]], [[InterfaceActionsWML]], [[InternalActionsWML]]
:* [[SideWML]] - cómo describir una facción
:** [[SingleUnitWML]]
:** [[ShroudDataWML]]
:* [[MapGeneratorWML]] - el generador de mapas al azar
:* [[TimeWML]] - cómo describir un día
:* [[IntroWML]] - cómo describir la pantalla de introducción
:* [https://www.wesnoth.org/macro-reference.html Macro Reference] - un conjunto de preprocesadores que puede utilizar
</div class="navtemplate">
 

== También vea ==

* [[Create | Crear]] '''(en español)'''
* [[ReferenceWML]] - referencias para el lenguaje de marcado de Wesnoth («WML»)
 
<div class="navtemplate">Enlaces de creación: [[BuildingMaps/es | Mapas]] | [[BuildingScenarios/es | Escenarios]] | [[BuildingCampaigns/es | Campañas]] | [[MultiplayerContent| Multijugadores]] | [[BuildingUnits | Unidades]] </div class="navtemplate">

[[Category:Create]]

DescriptionWML

2021-08-24T08:23:57Z

Shadowm: Update links to macro-reference.html

{{WML Tags}}
== Description texts ==

{{DevFeature1.15|1}} '''Support for the image-icon plus text format in this section has been removed. See the WML Format section further down on this page for the supported format.'''

A description is a part of the value of a menu attribute.
It represents a single option in the difficulty selection menu for a campaign, which consists of an image (called the ''icon'') followed by text. When appropriate, the icon should use [[ImagePathFunctions]] to replace any magenta with a team color.

The description tag uses a special format:

* ''';''' if another description precedes it

* '''*''' if it should be the default selection

* '''&''image''=''text''''' image with one text description

* '''&''image''=''text''=''text2''''' image with two text descriptions

Single text items are always enclosed in '''"''', and can be joined together (concatenated) with '''+'''. This allows the text to contain translatable items and span multiple lines. (Marking text with '''_''' indicates that it is translatable.)

A sample difficulty description tag might look like this:

difficulty_descriptions="&" + "units/elves-wood/elvish-fighter.png~TC(1,magenta)" + "=" + _"Fighter" + "=" + _"(easiest)" +
";*" + "&" + "units/elves-wood/elvish-hero.png~TC(1,magenta)" + "=" + _"Hero" +
";" + "&" + "units/elves-wood/elvish-champion.png~TC(1,magenta)" + "=" + _"Champion" + "=" + _"(hardest)"

The utility macros (see the [https://www.wesnoth.org/macro-reference.html#file:utils.cfg Macro Reference]) '''{MENU_IMG_TXT ''icon'' ''text''}'''
and '''{MENU_IMG_TXT2 ''icon'' ''text'' ''text-2''}'''
can be used to create descriptions more easily. The above example would become:

difficulty_descriptions={MENU_IMG_TXT2 "units/elves-wood/elvish-fighter.png~TC(1,magenta)" _"Fighter" _"(easiest)"} +
";*" + {MENU_IMG_TXT "units/elves-wood/elvish-hero.png~TC(1,magenta)" _"Hero"} + ";" +
{MENU_IMG_TXT2 "units/elves-wood/elvish-champion.png~TC(1,magenta)" _"Champion" _"(hardest)"}

====Alternative Description Implementation====

For still greater clarity, I have the following suggestion:
Before the start of the [campaign] tag, create a set of #define commands as follows:
# Image definitions
# NB Don't forget the trailing + symbols for all but the last entry.
#define EASY_IMAGE
"&units/elves-wood/elvish-fighter.png~TC(1,magenta)"+
#enddef

#define NORMAL_IMAGE
";*&units/elves-wood/elvish-hero.png~TC(1,magenta)"+
#enddef

#define HARD_IMAGE
";&units/elves-wood/elvish-champion.png~TC(1,magenta)"+
#enddef

# Difficulty ratings
#po: NB be sure to retain the = signs in the translated text.
#define EASY_TEXT
_"=Fighter=(easiest)"+
#enddef

#define NORMAL_TEXT
_"=Hero"+
#enddef

#define HARD_TEXT
_"=Champion=(hardest)"
#enddef

'''Note:''' The above example assumes three difficulty levels, which gives six difficulty entries – three for the pictures and three for the text. If you have more or fewer than three difficulty levels, make sure that the last entry does ''not'' have a trailing plus sign and that all the others do. Note also that the first image description ''doesn't'' start with a semicolon, whereas the second and subsequent ones do. Finally, only the default difficulty entry is marked with a * character.

If you set up your difficulty strings in this way you can then use a standard difficulty_descriptions tag that you will rarely need to alter. Note that this string does ''not'' contain any plus signs. You have to have them in the difficulty ratings strings instead to avoid upsetting the Wesnoth preprocessor:

difficulty_descriptions={EASY_IMAGE}{EASY_TEXT}{NORMAL_IMAGE}{NORMAL_TEXT}{HARD_IMAGE}{HARD_TEXT}

The only time you would need to alter this string is if you have more or fewer than three difficulty levels for your campaign.

[[User:Simons Mith|Simons Mith]] 20:16, 18 November 2011 (UTC)

== WML Format ==

{{DevFeature1.13|2}}

As of 1.13.2, the DescriptionWML format has changed to use WML tags. It goes in either a '''[difficulty]''' tag within '''[campaign]''' or an '''[option]''' tag within '''[message]''' and comprises the following attributes:

* '''default''': If yes, this item is the default selection (assuming no other items also have default=yes).
* '''image''': Optional path to an image file to display.
* '''label''': Text to display in the first text column.
* '''description''': Text to display in the second text column.

== See Also ==

* [[CampaignWML]]
* [[EraWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

PreprocessorRef

2021-08-24T08:21:36Z

Shadowm: /* Built-in macros */ fix english

{{WML Tags}}
== Overview ==

Wesnoth loads just one configuration file directly: '''data/_main.cfg'''. However the '''WML preprocessor''' allows to include more files. Whenever a WML file is read by Wesnoth, it is passed through the preprocessor.

The preprocessor can interpret a simple language of string expansions known as ''macros''. A macro should always be defined '''before''' the place where it needs to be used.

The preprocessor is applied recursively, so included files will be parsed for macros, and after macro expansion will be parsed for macros again, and so on. As a result, you should not write a recursive macro that references itself, because it will cause errors (but, alas, not necessarily error messages).

== Preprocessor directives ==

The following directives are used to create and use ''macros'', i.e. shortcuts which reduce repetition of information. See [https://www.wesnoth.org/macro-reference.html the macro reference] for the list of predefined core macros.

The preprocessor has changed several times, so don't expect old Wesnoth versions to behave exactly the same as the current stable and development series.

'''Note:''' In multiplayer scenarios, these directives will appear to work only for the host and not for other clients. This is because the preprocessor is run only on the host, and the clients receive the resultant WML from the server. It's particularly important to keep this in mind before using preprocessor conditionals.

=== #define ===

'''Syntax: #define ''symbol'' [''parameters''] ''<newline>'' ''substitution'' #enddef'''

All subsequent occurences of '''{''symbol'' [''arguments'']}''' (see below) will be replaced by the contents of the ''substitution'' block, with all occurrences of any parameter {''parameter''} within ''substitution'' replaced by the corresponding value in ''arguments''. For example, the ENEMY_UNIT macro for the [[#Macro inclusions|macro inclusion]] example below could be defined as follows:

<syntaxhighlight lang="wml">
#define ENEMY_UNIT TYPE X Y
## the ordering above is important, since the preprocessor does not distinguish
## data into different types; only the ordering is used to determine which
## arguments apply to which parameters.
[unit]
type={TYPE} ## the unit will be of type TYPE, so different
## instantiations
## of this macro can create different units.
x={X}
y={Y}
side=2 ## the unit will be an enemy, regardless of the parameter
## values. This reduces "repetition of information",
## since it is no longer necessary to specify
## each created unit as an enemy.
[/unit]
#enddef
</syntaxhighlight>

(See [[SingleUnitWML]] for further information on creating units using WML.)

'''Note:''' The final line break before #enddef is included in the expansion. This means that if the symbol is used in the middle of a line, you should place the #enddef immediately after the value has ended, without a line break in between.

'''Important note:''' Although macros may look like they're simplifying the code, they do not help with wml bloating. Macros are very good at ''disguising'' WML bloat, but they do nothing to ''alleviate'' it. So instead of using macros to generate redundant and repetitive instructions, you should be considering how to eliminate redundancy through programming techniques of abstraction. The most popular way to improve your code is using custom [[EventWML|events]] and [[InternalActionsWML#.5Bfire_event.5D|fire_event]] tags. See also: [[Wml_optimisation]].

=== #arg ===

{{DevFeature1.13|7}}

'''Syntax: #arg ''symbol'' ''<newline>'' ''default value'' #endarg'''

Defines an optional argument for a macro along with its default value. Optional arguments can be used to make a macro more flexible and to allow its user to specify certain parameters only when necessary.

For example, one could define a shortcut macro for [message] with only one required argument (the text displayed), but several optional ones:

<syntaxhighlight lang="wml">
#define MESSAGE TEXT

#arg SPEAKER_ID
narrator
#endarg

#arg CAPTION
#endarg

#arg SOUND
#endarg

#arg IMG
#endarg

[message]
speaker={SPEAKER_ID}
message={TEXT}
caption={CAPTION}
sound={SOUND}
image={IMG}
[/message]
#enddef
</syntaxhighlight>

The caller of the macro can then decide which, if any, of the default values to override:
<syntaxhighlight lang="wml">
{MESSAGE _"Halt!" SPEAKER_ID="Guard Captain"}
{MESSAGE _"Two days pass..." IMG=wesnoth-icon.png SOUND=ambient/morning.ogg}
{MESSAGE _"..."}
{MESSAGE _"Welcome!" CAPTION=_"Elóndra's shop of wonders" IMG=portraits/elves/shyde.png}
{MESSAGE _"*smash*" SPEAKER_ID="Bridge Troll" SOUND=mace.ogg}
</syntaxhighlight>

'''Note:''' As with #enddef, the final line break before #endarg is included in the default value. This means that if the symbol is used in the middle of a line, you should place the #endarg immediately after the value has ended, without a line break in between.

=== #undef ===

'''Syntax:''' '''#undef ''symbol'' '''

Removes the previous definition of the macro named ''symbol''.

=== Inclusion directive {} ===

This directive can be used to include macros, single files or sets of files from a target directory.

==== File/directory inclusions ====

'''Syntax: {''path''}'''

Includes the file with the specified ''path'', which will in turn run the preprocessor on it and perform any required substitutions or inclusions within it. The ''path'' may not contain ''..'' or the inclusion will be skipped.

The exact location in which the ''path'' will be resolved will depend on its prefix:

* '''{''path''}''': If ''path'' isn't a known macro (see below), the game will assume it's a relative path to a file in the main game '''data/''' directory and include it.
* '''{~''path''}''': As above, but instead of the game data directory, the path is resolved relative to the user '''data/''' directory, where user made add-ons can normally be found.
* '''{./''path''}''': The path is resolved relative to the location of the current file containing this inclusion.

Information for locating the user data and game data directories can be found in [[EditingWesnoth]].

Forward slashes ('''/''') should '''always''' be used as the path delimiter, even if your platform uses a different symbol such as colons (''':''') or backslashes ('''\''')! It is also very important to respect the '''actual letter case''' used to name files and directories for compatibility with case-sensitive filesystems on Unix-based operating systems.

When ''path'' points to a directory instead of a file, the preprocessor will include all files found within with the '''.cfg''' extension, in alphabetical order; files without this extension (such as '''.map''' or '''.png''' files) are ignored.

Some directories are handled in a special fashion according to their contents:

* If there's a file named '''_main.cfg''' in the target directory, only that file will be included and preprocessed. It may include other files from its own directory or subdirectories within it, of course. This is used for managing WML directories as self-contained packages, like user made add-ons.
* If there are files named '''_main.cfg''' in subdirectories of the target and there isn't one in the target itself, they will be all preprocessed. Given the following layout:
dir/
dir/a/_main.cfg
dir/a/other.cfg
dir/b/_main.cfg
dir/b/other.cfg
dir/other.cfg
Using '''{dir}''' will cause dir/a/_main.cfg, dir/b/_main.cfg and dir/other.cfg to be included.
* If there's a file named '''_final.cfg''' but no '''_main.cfg''', the file is guaranteed to be included and processed ''after'' all the other files in the directory.
* If there's a file named '''_initial.cfg''' but no '''_main.cfg''', the file is guaranteed to be included and processed ''before'' all the other files in the directory.

==== Macro inclusions ====

'''Syntax: {''symbol'' [''arguments''] [''optional arguments'']}'''

If the macro named ''symbol'' is defined, the preprocessor will replace this instruction by the expression ''symbol'' was previously defined as, using ''arguments'' as parameters. The number of normal arguments must be exactly the same as in the original definition or an error will occur. Optional arguments can only be placed '''after''' all normal arguments, however they can be specified in any order desired.

You can create multiple word arguments by using parentheses to delimit the contents. For example, in '''{ENEMY_UNIT Wolf Rider 18 24}''' the four words will be interpreted as separate arguments and cause the preprocessor to fail since the macro was defined above with only three; instead, you should use '''{ENEMY_UNIT (Wolf Rider) 18 24}'''.

Optional arguments can also be delimited by placing parentheses, however they must be placed around both the argument name '''and''' content:

<syntaxhighlight lang="wml">
{MESSAGE _"I'll smash you!" (SPEAKER_ID=Bridge Troll) } # Correct
{MESSAGE _"I'll smash you!" SPEAKER_ID=(Bridge Troll) } # Wrong
</syntaxhighlight>

This way even complex arguments can be passed:

<syntaxhighlight lang="wml">
{MODIFY_UNIT (
[filter_adjacent]
canrecruit=yes
[/filter_adjacent]
) side 2}
</syntaxhighlight>

Using the name of an existing macro as the name of a macro argument is possible, but the argument will always take precedence over the original macro:

<syntaxhighlight lang="wml">
#define VARIABLE
#enddef
#define MACRO VARIABLE
{VARIABLE} # is calling for the argument, not for the macro above
#enddef
</syntaxhighlight>

=== #ifdef and #ifndef ===

Unlike the other preprocessor directives, '''#ifdef''' and '''#ifndef''' are not mere conveniences. They are often necessary to distinguish between different gameplay modes or difficulties (see [[#Built-in macros|Built-in macros]] below).

'''Syntax:''' '''#ifdef ''symbol'' ''substitution-if-defined'' [#else ''substitution-if-not-defined'' ] #endif'''

If ''symbol'' has been defined with '''#define''' or as a built-in macro, the whole block will be replaced by ''substitution-if-defined''. If not, it will be replaced by ''substitution-if-not-defined'' if it is available.

'''#ifndef''' is the exact opposite of '''#ifdef''', reversing the logic:

'''Syntax:''' '''#ifndef ''symbol'' ''substitution-if-not-defined'' [#else ''substitution-if-defined''] #endif'''

=== #ifhave and #ifnhave ===

'''Syntax:''' '''#ifhave ''path'' ''substitution-if-path-exists'' [#else ''substitution-if-path-does-not-exist''] #endif'''

Checks for the existence of a file. Uses the same relative paths as include directives (see below).

Example:

<syntaxhighlight lang="wml">
#ifhave ~add-ons/My_Addon/_main.cfg
{MY_ADDON_MACROS}
#endif
</syntaxhighlight>

'''#ifnhave''' does the opposite of '''#ifhave''':

'''Syntax:''' '''#ifnhave ''path'' ''substitution-if-path-does-not-exist'' [#else ''substitution-if-path-exists''] #endif'''

=== #ifver and #ifnver ===

'''Syntax:''' '''#ifver ''symbol'' ''operator'' ''version-number'' ''<newline>'' ''substitution-if-condition-met'' [#else ''substitution-if-condition-not-met''] #endif'''

Compares a version number defined in a macro against an argument for conditional block inclusions, like ''#ifdef'' and ''#ifhave''. ''operator'' is one of ''=='' (equal), ''!='' (not equal), ''<'' (less), ''<='' (less or equal), ''>'' (greater), ''>='' (greater or equal). The specified ''symbol'' should have been previously defined as plain text without more macro inclusions within it, and it must not require any arguments.

Versions with text suffixes are sorted in binary order and come after all versions with the same number. The most common suffixes begin with "+", but as this represents multiple possible versions, comparing versions against it is not recommended.

Example:
<syntaxhighlight lang="wml">
#ifver WESNOTH_VERSION >= 1.9.7+
[message]
speaker=narrator
message= _ "I’m on Wesnoth 1.9.7+, 1.9.8 or later!"
[/message]
#else
#ifver WESNOTH_VERSION == 1.9.7
[message]
speaker=narrator
message= _ "I’m on Wesnoth 1.9.7, and I’ll include some workaround code for bug #9001!"
[/message]
#endif
#endif
</syntaxhighlight>

'''#ifnver''' does the opposite of '''#ifver''':

'''Syntax:''' '''#ifnver ''symbol'' ''operator'' ''version-number'' ''<newline>'' ''substitution-if-condition-not-met'' [#else ''substitution-if-condition-met''] #endif'''

=== #error ===

'''Syntax:''' '''#error [''message'']'''

Causes the WML preprocessor to fail unconditionally upon encountering the line. For add-ons, this will cause the game to display an error and return to the titlescreen if the add-on is required for the user's action (such as playing a campaign or loading a saved game). For core WML, this will cause the game to quit entirely.

Please note that in spite of the example below, it is '''not''' advisable to use this mechanism in published add-ons for version or feature-checking, since the message is not displayed in a form that permits translation and the additional trace information may confuse players. This directive is only intended as a debugging aid for content creators.

Example:
<syntaxhighlight lang="wml">
#ifver WESNOTH_VERSION < 1.11.10
#error This add-on does not support Wesnoth 1.11.10!
#endif
</syntaxhighlight>

=== #warning ===

'''Syntax:''' '''#warning [''message'']'''

Causes the WML preprocessor to emit a warning upon encountering the line. The message will '''only''' be relayed to stderr, not to the player in the game UI. This directive is only intended as a debugging aid for content creators.

Example:
<syntaxhighlight lang="wml">
#ifver WESNOTH_VERSION < 1.11.10
#warning On Wesnoth 1.11.9 or earlier, bug workarounds enabled!
#endif
</syntaxhighlight>

=== #deprecated ===

{{DevFeature1.13|11}}

'''Syntax:''' '''#deprecated 1 ''message'''''

'''Syntax:''' '''#deprecated 2 ''version'' ''message'''''

'''Syntax:''' '''#deprecated 3 ''version'' ''message'''''

'''Syntax:''' '''#deprecated 4 ''message'''''

The effect of this directive depends on whether it appears within a macro definition.

* If it appears at file level, outside any macro definition, then it immediately outputs a warning saying that the file is deprecated, with the provided message. Multiple '''#deprecated''' directives at toplevel in a single file will result in separate messages.
* If it appears inside a macro definition ('''#define ... #enddef'''), then it doesn't output anything. Instead, it marks the macro as deprecated. When that macro is later used, only then will the preprocessor output a warning saying that the macro is deprecated, with the provided message. Multiple '''#deprecated''' directives within a single macro will be merged into one message.

Note that deprecation messages will only appear if they have been set to. {{DevFeature1.13|12}} This can be done by enabling debug mode, or by going to Advanced Preferences and setting the log-level for the deprecation logdomain. (This can also be done on the command-line.)

If you provide a deprecation level of 2 or 3, it is required to indicate the earliest version in which the feature could be removed. However, if you provide a deprecation level of 1 or 4, any provided ''version'' will instead be parsed as part of the message, so you will probably not want to provide one at all. Other deprecation levels are not valid. See the documentation for [[InterfaceActionsWML#.5Bdeprecated_message.5D|[deprecated_message]]] for the meaning of the various ''level'' values.

== Built-in macros ==

The following macros are automatically defined with empty contents (unless specified otherwise) by the game engine depending on the configuration or gameplay mode.

* A campaign define symbol (see ''define'' in [[CampaignWML]]): defined when playing a single-player campaign.
* A campaign difficulty level, usually '''EASY''', '''NORMAL''' or '''HARD''' (see ''difficulties'' in [[CampaignWML]]): defined according to the chosen difficulty when starting a single-player campaign, also stored in saved games.
* '''MULTIPLAYER''': defined when in multiplayer mode.
* '''TUTORIAL''': defined when playing the tutorial campaign.
* '''EDITOR''': defined when running the built-in map editor.
* '''DEBUG_MODE''': defined when the game has been launched in debug mode (i.e. with '''-d''' or '''--debug''' in the command line).
* '''APPLE''': defined while processing the main game data when running on Mac OS X.
* '''WESNOTH_VERSION''': defined containing just the game version number when running the WML preprocessor.
* '''CURRENT_FILE''': Expands to the name of the current WML file.
* '''CURRENT_DIRECTORY''': Expands to the preprocessor path of the parent directory for the current WML file (e.g. for <code><user data dir>/data/add-ons/My_Addon/_main.cfg</code> this evaluates to <code>~add-ons/My_Addon</code>).
* '''LEFT_BRACE''': {{DevFeature1.15|2}} Expands to <code>{</code>.
* '''RIGHT_BRACE''': {{DevFeature1.15|2}} Expands to <code>}</code>.

A ''very large'' number of additional macros are provided as part of the default game core WML. For a full list of those, check the [https://www.wesnoth.org/macro-reference.html macro reference].

== Command-line preprocessor ==

'''Syntax: --preprocess ''<source file/directory>'' ''<target directory>'' '''

Or the short form:

'''Syntax: -p ''<source file/directory>'' ''<target directory>'' '''

You can specify a list of predefined defines with:

'''Syntax: --preprocess-defines=DEFINE1,DEFINE2,etc'''

comma separated list of defines to be used by '--preprocess' command. If 'SKIP_CORE' is in the define list the data/core won't be preprocessed.

The command will preprocess first the common config files in the main game ''data/'' directory, and afterwards the specified ones. You can specify a single file to be preprocessed (if you want to preprocess multiple separate files, you'll need to run a different command line for each one), or an entire directory, which will be preprocessed according to the rules used by the inclusion directive above.

The resulted preprocessed files will be written in the target directory. There will be two types of files: .cfg files --- the normal ones, and .plain files containing line markers and textdomain changes.

If by chance, the simple macro define doesn't suffice, you can use:

'''Syntax: --preprocess-input-macros <file>'''

To import an existing file that contains macros, and they will be available in the defines database before processing the specified files.

There is also the possibility to export the preprocessed defines/macro list with:

'''Syntax: --preprocess-output-macros [<target file>]'''

This file could be fed to the 'input-macros' argument next time you run it. For example, a scenario would be: parsing just the core first time, and for the intended target files, you would add SKIP_CORE but import the generated macros file - that will be faster than preprocessing the core again. If the target file is not specified, the output file will be _MACROS_.cfg in the target directory of the preprocess's command.

If ''file/directory'' and ''target directory'' are not absolute paths, they will be considered relative to the game's executable path.

Some examples:

* Preprocess the entire tutorial dir, and write the results in the ~/result folder:
-p ~/wesnoth/data/campaigns/tutorial ~/result
* Add the MULTIPLAYER define to the list and preprocess a scenario's config file:
-p ~/.wesnoth/data/add-ons/My_Campaign/scenarios/01_First_Scenario.cfg ~/result --preprocess-defines=MULTIPLAYER
* Add the MY_CAMPAIGN and HARD defines before preprocessing a campaign's files:
-p ~/.wesnoth/data/add-ons/My_Campaign ~/result --preprocess-defines=MY_CAMPAIGN,HARD

If you want a more detailed (and potentially overwhelming) log, you can simply add the switches '''--log-debug=all''' or '''--log-info=all''' to the command line, so you can see how things are preprocessed in detail.

== See Also ==

* [[SyntaxWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

PreprocessorRef

2021-08-24T08:18:56Z

Shadowm: Update links to macro-reference.html

{{WML Tags}}
== Overview ==

Wesnoth loads just one configuration file directly: '''data/_main.cfg'''. However the '''WML preprocessor''' allows to include more files. Whenever a WML file is read by Wesnoth, it is passed through the preprocessor.

The preprocessor can interpret a simple language of string expansions known as ''macros''. A macro should always be defined '''before''' the place where it needs to be used.

The preprocessor is applied recursively, so included files will be parsed for macros, and after macro expansion will be parsed for macros again, and so on. As a result, you should not write a recursive macro that references itself, because it will cause errors (but, alas, not necessarily error messages).

== Preprocessor directives ==

The following directives are used to create and use ''macros'', i.e. shortcuts which reduce repetition of information. See [https://www.wesnoth.org/macro-reference.html the macro reference] for the list of predefined core macros.

The preprocessor has changed several times, so don't expect old Wesnoth versions to behave exactly the same as the current stable and development series.

'''Note:''' In multiplayer scenarios, these directives will appear to work only for the host and not for other clients. This is because the preprocessor is run only on the host, and the clients receive the resultant WML from the server. It's particularly important to keep this in mind before using preprocessor conditionals.

=== #define ===

'''Syntax: #define ''symbol'' [''parameters''] ''<newline>'' ''substitution'' #enddef'''

All subsequent occurences of '''{''symbol'' [''arguments'']}''' (see below) will be replaced by the contents of the ''substitution'' block, with all occurrences of any parameter {''parameter''} within ''substitution'' replaced by the corresponding value in ''arguments''. For example, the ENEMY_UNIT macro for the [[#Macro inclusions|macro inclusion]] example below could be defined as follows:

<syntaxhighlight lang="wml">
#define ENEMY_UNIT TYPE X Y
## the ordering above is important, since the preprocessor does not distinguish
## data into different types; only the ordering is used to determine which
## arguments apply to which parameters.
[unit]
type={TYPE} ## the unit will be of type TYPE, so different
## instantiations
## of this macro can create different units.
x={X}
y={Y}
side=2 ## the unit will be an enemy, regardless of the parameter
## values. This reduces "repetition of information",
## since it is no longer necessary to specify
## each created unit as an enemy.
[/unit]
#enddef
</syntaxhighlight>

(See [[SingleUnitWML]] for further information on creating units using WML.)

'''Note:''' The final line break before #enddef is included in the expansion. This means that if the symbol is used in the middle of a line, you should place the #enddef immediately after the value has ended, without a line break in between.

'''Important note:''' Although macros may look like they're simplifying the code, they do not help with wml bloating. Macros are very good at ''disguising'' WML bloat, but they do nothing to ''alleviate'' it. So instead of using macros to generate redundant and repetitive instructions, you should be considering how to eliminate redundancy through programming techniques of abstraction. The most popular way to improve your code is using custom [[EventWML|events]] and [[InternalActionsWML#.5Bfire_event.5D|fire_event]] tags. See also: [[Wml_optimisation]].

=== #arg ===

{{DevFeature1.13|7}}

'''Syntax: #arg ''symbol'' ''<newline>'' ''default value'' #endarg'''

Defines an optional argument for a macro along with its default value. Optional arguments can be used to make a macro more flexible and to allow its user to specify certain parameters only when necessary.

For example, one could define a shortcut macro for [message] with only one required argument (the text displayed), but several optional ones:

<syntaxhighlight lang="wml">
#define MESSAGE TEXT

#arg SPEAKER_ID
narrator
#endarg

#arg CAPTION
#endarg

#arg SOUND
#endarg

#arg IMG
#endarg

[message]
speaker={SPEAKER_ID}
message={TEXT}
caption={CAPTION}
sound={SOUND}
image={IMG}
[/message]
#enddef
</syntaxhighlight>

The caller of the macro can then decide which, if any, of the default values to override:
<syntaxhighlight lang="wml">
{MESSAGE _"Halt!" SPEAKER_ID="Guard Captain"}
{MESSAGE _"Two days pass..." IMG=wesnoth-icon.png SOUND=ambient/morning.ogg}
{MESSAGE _"..."}
{MESSAGE _"Welcome!" CAPTION=_"Elóndra's shop of wonders" IMG=portraits/elves/shyde.png}
{MESSAGE _"*smash*" SPEAKER_ID="Bridge Troll" SOUND=mace.ogg}
</syntaxhighlight>

'''Note:''' As with #enddef, the final line break before #endarg is included in the default value. This means that if the symbol is used in the middle of a line, you should place the #endarg immediately after the value has ended, without a line break in between.

=== #undef ===

'''Syntax:''' '''#undef ''symbol'' '''

Removes the previous definition of the macro named ''symbol''.

=== Inclusion directive {} ===

This directive can be used to include macros, single files or sets of files from a target directory.

==== File/directory inclusions ====

'''Syntax: {''path''}'''

Includes the file with the specified ''path'', which will in turn run the preprocessor on it and perform any required substitutions or inclusions within it. The ''path'' may not contain ''..'' or the inclusion will be skipped.

The exact location in which the ''path'' will be resolved will depend on its prefix:

* '''{''path''}''': If ''path'' isn't a known macro (see below), the game will assume it's a relative path to a file in the main game '''data/''' directory and include it.
* '''{~''path''}''': As above, but instead of the game data directory, the path is resolved relative to the user '''data/''' directory, where user made add-ons can normally be found.
* '''{./''path''}''': The path is resolved relative to the location of the current file containing this inclusion.

Information for locating the user data and game data directories can be found in [[EditingWesnoth]].

Forward slashes ('''/''') should '''always''' be used as the path delimiter, even if your platform uses a different symbol such as colons (''':''') or backslashes ('''\''')! It is also very important to respect the '''actual letter case''' used to name files and directories for compatibility with case-sensitive filesystems on Unix-based operating systems.

When ''path'' points to a directory instead of a file, the preprocessor will include all files found within with the '''.cfg''' extension, in alphabetical order; files without this extension (such as '''.map''' or '''.png''' files) are ignored.

Some directories are handled in a special fashion according to their contents:

* If there's a file named '''_main.cfg''' in the target directory, only that file will be included and preprocessed. It may include other files from its own directory or subdirectories within it, of course. This is used for managing WML directories as self-contained packages, like user made add-ons.
* If there are files named '''_main.cfg''' in subdirectories of the target and there isn't one in the target itself, they will be all preprocessed. Given the following layout:
dir/
dir/a/_main.cfg
dir/a/other.cfg
dir/b/_main.cfg
dir/b/other.cfg
dir/other.cfg
Using '''{dir}''' will cause dir/a/_main.cfg, dir/b/_main.cfg and dir/other.cfg to be included.
* If there's a file named '''_final.cfg''' but no '''_main.cfg''', the file is guaranteed to be included and processed ''after'' all the other files in the directory.
* If there's a file named '''_initial.cfg''' but no '''_main.cfg''', the file is guaranteed to be included and processed ''before'' all the other files in the directory.

==== Macro inclusions ====

'''Syntax: {''symbol'' [''arguments''] [''optional arguments'']}'''

If the macro named ''symbol'' is defined, the preprocessor will replace this instruction by the expression ''symbol'' was previously defined as, using ''arguments'' as parameters. The number of normal arguments must be exactly the same as in the original definition or an error will occur. Optional arguments can only be placed '''after''' all normal arguments, however they can be specified in any order desired.

You can create multiple word arguments by using parentheses to delimit the contents. For example, in '''{ENEMY_UNIT Wolf Rider 18 24}''' the four words will be interpreted as separate arguments and cause the preprocessor to fail since the macro was defined above with only three; instead, you should use '''{ENEMY_UNIT (Wolf Rider) 18 24}'''.

Optional arguments can also be delimited by placing parentheses, however they must be placed around both the argument name '''and''' content:

<syntaxhighlight lang="wml">
{MESSAGE _"I'll smash you!" (SPEAKER_ID=Bridge Troll) } # Correct
{MESSAGE _"I'll smash you!" SPEAKER_ID=(Bridge Troll) } # Wrong
</syntaxhighlight>

This way even complex arguments can be passed:

<syntaxhighlight lang="wml">
{MODIFY_UNIT (
[filter_adjacent]
canrecruit=yes
[/filter_adjacent]
) side 2}
</syntaxhighlight>

Using the name of an existing macro as the name of a macro argument is possible, but the argument will always take precedence over the original macro:

<syntaxhighlight lang="wml">
#define VARIABLE
#enddef
#define MACRO VARIABLE
{VARIABLE} # is calling for the argument, not for the macro above
#enddef
</syntaxhighlight>

=== #ifdef and #ifndef ===

Unlike the other preprocessor directives, '''#ifdef''' and '''#ifndef''' are not mere conveniences. They are often necessary to distinguish between different gameplay modes or difficulties (see [[#Built-in macros|Built-in macros]] below).

'''Syntax:''' '''#ifdef ''symbol'' ''substitution-if-defined'' [#else ''substitution-if-not-defined'' ] #endif'''

If ''symbol'' has been defined with '''#define''' or as a built-in macro, the whole block will be replaced by ''substitution-if-defined''. If not, it will be replaced by ''substitution-if-not-defined'' if it is available.

'''#ifndef''' is the exact opposite of '''#ifdef''', reversing the logic:

'''Syntax:''' '''#ifndef ''symbol'' ''substitution-if-not-defined'' [#else ''substitution-if-defined''] #endif'''

=== #ifhave and #ifnhave ===

'''Syntax:''' '''#ifhave ''path'' ''substitution-if-path-exists'' [#else ''substitution-if-path-does-not-exist''] #endif'''

Checks for the existence of a file. Uses the same relative paths as include directives (see below).

Example:

<syntaxhighlight lang="wml">
#ifhave ~add-ons/My_Addon/_main.cfg
{MY_ADDON_MACROS}
#endif
</syntaxhighlight>

'''#ifnhave''' does the opposite of '''#ifhave''':

'''Syntax:''' '''#ifnhave ''path'' ''substitution-if-path-does-not-exist'' [#else ''substitution-if-path-exists''] #endif'''

=== #ifver and #ifnver ===

'''Syntax:''' '''#ifver ''symbol'' ''operator'' ''version-number'' ''<newline>'' ''substitution-if-condition-met'' [#else ''substitution-if-condition-not-met''] #endif'''

Compares a version number defined in a macro against an argument for conditional block inclusions, like ''#ifdef'' and ''#ifhave''. ''operator'' is one of ''=='' (equal), ''!='' (not equal), ''<'' (less), ''<='' (less or equal), ''>'' (greater), ''>='' (greater or equal). The specified ''symbol'' should have been previously defined as plain text without more macro inclusions within it, and it must not require any arguments.

Versions with text suffixes are sorted in binary order and come after all versions with the same number. The most common suffixes begin with "+", but as this represents multiple possible versions, comparing versions against it is not recommended.

Example:
<syntaxhighlight lang="wml">
#ifver WESNOTH_VERSION >= 1.9.7+
[message]
speaker=narrator
message= _ "I’m on Wesnoth 1.9.7+, 1.9.8 or later!"
[/message]
#else
#ifver WESNOTH_VERSION == 1.9.7
[message]
speaker=narrator
message= _ "I’m on Wesnoth 1.9.7, and I’ll include some workaround code for bug #9001!"
[/message]
#endif
#endif
</syntaxhighlight>

'''#ifnver''' does the opposite of '''#ifver''':

'''Syntax:''' '''#ifnver ''symbol'' ''operator'' ''version-number'' ''<newline>'' ''substitution-if-condition-not-met'' [#else ''substitution-if-condition-met''] #endif'''

=== #error ===

'''Syntax:''' '''#error [''message'']'''

Causes the WML preprocessor to fail unconditionally upon encountering the line. For add-ons, this will cause the game to display an error and return to the titlescreen if the add-on is required for the user's action (such as playing a campaign or loading a saved game). For core WML, this will cause the game to quit entirely.

Please note that in spite of the example below, it is '''not''' advisable to use this mechanism in published add-ons for version or feature-checking, since the message is not displayed in a form that permits translation and the additional trace information may confuse players. This directive is only intended as a debugging aid for content creators.

Example:
<syntaxhighlight lang="wml">
#ifver WESNOTH_VERSION < 1.11.10
#error This add-on does not support Wesnoth 1.11.10!
#endif
</syntaxhighlight>

=== #warning ===

'''Syntax:''' '''#warning [''message'']'''

Causes the WML preprocessor to emit a warning upon encountering the line. The message will '''only''' be relayed to stderr, not to the player in the game UI. This directive is only intended as a debugging aid for content creators.

Example:
<syntaxhighlight lang="wml">
#ifver WESNOTH_VERSION < 1.11.10
#warning On Wesnoth 1.11.9 or earlier, bug workarounds enabled!
#endif
</syntaxhighlight>

=== #deprecated ===

{{DevFeature1.13|11}}

'''Syntax:''' '''#deprecated 1 ''message'''''

'''Syntax:''' '''#deprecated 2 ''version'' ''message'''''

'''Syntax:''' '''#deprecated 3 ''version'' ''message'''''

'''Syntax:''' '''#deprecated 4 ''message'''''

The effect of this directive depends on whether it appears within a macro definition.

* If it appears at file level, outside any macro definition, then it immediately outputs a warning saying that the file is deprecated, with the provided message. Multiple '''#deprecated''' directives at toplevel in a single file will result in separate messages.
* If it appears inside a macro definition ('''#define ... #enddef'''), then it doesn't output anything. Instead, it marks the macro as deprecated. When that macro is later used, only then will the preprocessor output a warning saying that the macro is deprecated, with the provided message. Multiple '''#deprecated''' directives within a single macro will be merged into one message.

Note that deprecation messages will only appear if they have been set to. {{DevFeature1.13|12}} This can be done by enabling debug mode, or by going to Advanced Preferences and setting the log-level for the deprecation logdomain. (This can also be done on the command-line.)

If you provide a deprecation level of 2 or 3, it is required to indicate the earliest version in which the feature could be removed. However, if you provide a deprecation level of 1 or 4, any provided ''version'' will instead be parsed as part of the message, so you will probably not want to provide one at all. Other deprecation levels are not valid. See the documentation for [[InterfaceActionsWML#.5Bdeprecated_message.5D|[deprecated_message]]] for the meaning of the various ''level'' values.

== Built-in macros ==

The following macros are automatically defined with empty contents (unless specified otherwise) by the game engine depending on the configuration or gameplay mode.

* A campaign define symbol (see ''define'' in [[CampaignWML]]): defined when playing a single-player campaign.
* A campaign difficulty level, usually '''EASY''', '''NORMAL''' or '''HARD''' (see ''difficulties'' in [[CampaignWML]]): defined according to the chosen difficulty when starting a single-player campaign, also stored in saved games.
* '''MULTIPLAYER''': defined when in multiplayer mode.
* '''TUTORIAL''': defined when playing the tutorial campaign.
* '''EDITOR''': defined when running the built-in map editor.
* '''DEBUG_MODE''': defined when the game has been launched in debug mode (i.e. with '''-d''' or '''--debug''' in the command line).
* '''APPLE''': defined while processing the main game data when running on Mac OS X.
* '''WESNOTH_VERSION''': defined containing just the game version number when running the WML preprocessor.
* '''CURRENT_FILE''': Expands to the name of the current WML file.
* '''CURRENT_DIRECTORY''': Expands to the preprocessor path of the parent directory for the current WML file (e.g. for <code><user data dir>/data/add-ons/My_Addon/_main.cfg</code> this evaluates to <code>~add-ons/My_Addon</code>).
* '''LEFT_BRACE''': {{DevFeature1.15|2}} Expands to <code>{</code>.
* '''RIGHT_BRACE''': {{DevFeature1.15|2}} Expands to <code>}</code>.

Note that the macros above are only those generated by wesnoth engine itself. For a list of macros defined outside engine, see here: https://www.wesnoth.org/macro-reference.html

== Command-line preprocessor ==

'''Syntax: --preprocess ''<source file/directory>'' ''<target directory>'' '''

Or the short form:

'''Syntax: -p ''<source file/directory>'' ''<target directory>'' '''

You can specify a list of predefined defines with:

'''Syntax: --preprocess-defines=DEFINE1,DEFINE2,etc'''

comma separated list of defines to be used by '--preprocess' command. If 'SKIP_CORE' is in the define list the data/core won't be preprocessed.

The command will preprocess first the common config files in the main game ''data/'' directory, and afterwards the specified ones. You can specify a single file to be preprocessed (if you want to preprocess multiple separate files, you'll need to run a different command line for each one), or an entire directory, which will be preprocessed according to the rules used by the inclusion directive above.

The resulted preprocessed files will be written in the target directory. There will be two types of files: .cfg files --- the normal ones, and .plain files containing line markers and textdomain changes.

If by chance, the simple macro define doesn't suffice, you can use:

'''Syntax: --preprocess-input-macros <file>'''

To import an existing file that contains macros, and they will be available in the defines database before processing the specified files.

There is also the possibility to export the preprocessed defines/macro list with:

'''Syntax: --preprocess-output-macros [<target file>]'''

This file could be fed to the 'input-macros' argument next time you run it. For example, a scenario would be: parsing just the core first time, and for the intended target files, you would add SKIP_CORE but import the generated macros file - that will be faster than preprocessing the core again. If the target file is not specified, the output file will be _MACROS_.cfg in the target directory of the preprocess's command.

If ''file/directory'' and ''target directory'' are not absolute paths, they will be considered relative to the game's executable path.

Some examples:

* Preprocess the entire tutorial dir, and write the results in the ~/result folder:
-p ~/wesnoth/data/campaigns/tutorial ~/result
* Add the MULTIPLAYER define to the list and preprocess a scenario's config file:
-p ~/.wesnoth/data/add-ons/My_Campaign/scenarios/01_First_Scenario.cfg ~/result --preprocess-defines=MULTIPLAYER
* Add the MY_CAMPAIGN and HARD defines before preprocessing a campaign's files:
-p ~/.wesnoth/data/add-ons/My_Campaign ~/result --preprocess-defines=MY_CAMPAIGN,HARD

If you want a more detailed (and potentially overwhelming) log, you can simply add the switches '''--log-debug=all''' or '''--log-info=all''' to the command line, so you can see how things are preprocessed in detail.

== See Also ==

* [[SyntaxWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

InternalActionsWML

2021-08-24T08:18:25Z

Shadowm: Update links to macro-reference.html

{{WML Tags}}

Part of [[ActionWML]], Internal actions are actions that WML uses internally that do not directly affect game play (or, at least, are not readily apparent to the player). For example, storing a variable is an internal action.

== Variable Actions ==

These actions are focused, in one way or another, on [[VariablesWML|variables]]. Creating them, modifying them, capturing game data to them, you name it, these actions are all about the variables.

=== [set_variable] ===

The '''[set_variable]''' tag is used to create and manipulate WML variables. The [https://www.wesnoth.org/macro-reference.html#VARIABLE VARIABLE] macro is a quick syntactic shortcut for simple variable creation and the [https://www.wesnoth.org/macro-reference.html#VARIABLE_OP VARIABLE_OP] macro is a quick syntactic shortcut for performing simple mathematical operations on variables.

* '''name''': the name of the variable to manipulate

* '''value''': set the variable to the given value (can be numeric or string).Use literal for no substitution. (see [[VariablesWML]])

* '''literal''': set the variable to the given value (can be numeric or string). This does not interpret any dollar signs.

* '''to_variable''': set the variable to the value of the given variable, e.g. 'to_variable=temp' would be equivalent to 'value=$temp'.

* '''add''': add the given amount to the variable.

* '''sub''': subtract the given amount from the variable.

* '''multiply''': multiply the variable by the given number. The result is a float. To negate a number, multiply by -1. If you negate 0, the result is a floating-point negative zero -0. To display -0 as 0, use a second tag with add=0; it will flip -0 to 0 but not affect other numbers.

* '''divide''': divide the variable by the given number. The result is a float. Wesnoth 1.9 and later no longer uses integer division. Use a second tag with round=floor if you relied on this.

* '''modulo''': returns the remainder of a division.

* '''abs''': Returns the absolute value of the variable.

* '''root''': Use '''root=square''' to calculate the square root. {{DevFeature1.15|0}} Also supports '''root=cube''' and arbitrary integer roots.

* '''power''': Raise the variable to some power.

* '''rand''': the variable will be randomly set. You may provide a comma separated list of possibilities, e.g. 'rand=Bob,Bill,Bella'. You may provide a range of numbers (integers), e.g. 'rand=3..5'. You may combine these, e.g. 'rand=100,1..9', in which case there would be 1/10th chance of getting 100, just like for each of 1 to 9. If a number or item is repeated, it is sampled more frequently as appropriate. See [[MultiplayerContent]] for more info on the MP case. Using rand= will automatically result in the current action being non undoable. Ignoring possible [allow_undo].

* '''time=stamp''': Retrieves a timestamp in milliseconds since wesnoth was started, can be used as timing aid. Don't try to use this as random value in MP since it will cause an OOS.

* '''string_length''': Retrieves the length in characters of the string passed as this attribute's value; such string is parsed and variable substitution applied automatically (see [[VariablesWML]] for details).

* '''[join]''' joins an array of strings to create a textual list
** '''variable''': name of the array
** '''key''': the key of each array element(array[$i].foo) in which the strings are stored
** '''separator''': separator to connect the elements
** '''remove_empty''': whether to ignore empty elements

* '''ipart''': Assigns the integer part (the part to the left of the decimal point) of the referenced variable.

* '''fpart''': Assigns the decimal part (the part to the right of the decimal point) of the referenced variable.

* '''round''': Rounds the variable to the specified number of digits of precision. Negative precision works as expected (rounding 19517 to -2 = 19500). Special values:
**'''round=ceil''': Rounds upward to the nearest integer.
**'''round=floor''': Rounds down to the nearest integer.
**'''round=trunc''': {{DevFeature1.15|0}} Rounds towards zero; this is the same operation as '''ipart''', but operating on the value already contained in the variable rather than the value assigned to the key.

* '''min''', '''max''': {{DevFeature1.15|9}} Specify a comma-separated list of numbers; either the smallest or largest number in the list will be assigned to the variable.

* '''reverse=yes''': {{DevFeature1.15|9}} Reverses the string value of the variable. For example, "delfador" becomes "rodafled".

* '''formula''': Calculate the new value of the variable from a [[Wesnoth_Formula_Language|WFL]] formula operating on the old value. This is similar to using the '''$(...)''' syntax but avoids the possibility of WFL syntax errors if a referenced variable is empty.

=== [set_variables] ===

Manipulates a WML array or container

* '''name''': the name of the array or container to manipulate

* '''mode''': one of the following values:
** ''replace'': will clean the array '''name''' and replace it with given data
** ''append'': will append given data to the current array
** ''merge'': will merge in the given data into '''name'''. Attributes in '''[value]''' will overwrite any existing already in '''name'''. Tags in '''[value]''' modify the corresponding tag of the original value of '''name''', so for example the first '''[attack]''' tag in '''[value]''' would modify the first '''[attack]''' tag of '''name''' rather than appending a new '''[attack]''' tag. A few special syntaxes are supported:
*** ''__remove=yes'': When used in a subtag, causes the corresponding subtag in '''name''' to be deleted rather than merged. Deletion happens after any other subtags have been merged.
*** ''add_to_xxx'': Adds its integer value to the integer value of '''xxx''' in '''name''', and sets '''xxx''' in '''name''' to the result. {{DevFeature1.13|8}} Now adds as real numbers rather than integers.
*** ''concat_to_xxx'': {{DevFeature1.13|8}} Similar to '''add_to_xxx''', but does string concatenation instead of numerical addition.
** ''insert'': will insert the given data at the index specified in the '''name''' attribute, such as name=my_array[1]. The default index is zero, which will insert to the front of the array. '''Note:''' if an invalid index is used, empty containers will be created before the insertion is performed. In other words, do not attempt to insert at an index greater than (or equal to) the array's current length. This limitation may be removed in future versions.

* '''to_variable''': data will be set to the given array

* '''[value]''': the WML inside the [value] tags will be stored in data, variables will be interpolated directly, use $| in order to escape the $ sign, you can store arrays of WML by supplying multiple [value] tags. ([[#Using_.5Bset_variables.5D_to_Create_Arrays_of_WML|See Example]])

* '''[literal]''': same as '''[value]''', but variables will not be substituted, '''[literal]''' and '''[value]''' can not be used in the same [set_variables] tag, i.e. you can not create arrays by piling a mix of '''[value]''' and '''[literal]''' tags

*'''[split]''' splits a textual list into an array which will then be set to data
** '''list''': textual list to split
** '''key''': the key of each array element(array[$i].foo) in which the strings are stored
** '''separator''': separator to separate the elements
** '''remove_empty''': whether to ignore empty elements

{{DevFeature1.13|4}} You can now mix '''[value]''', '''[literal]''', and '''[split]''' in the same '''[set_variables]''' tag. They will be processed in order of appearance. Multiple instances of [split] are also supported now.

=== Capturing Game Data ===

These actions capture different bits of game data and store them to variables so they can be examined and/or manipulated.

==== [store_gold] ====

Stores a side's gold into a variable.

* '''[[StandardSideFilter]]''': The first matching side's gold will be stored in the variable "variable".
* '''variable''': (default='gold') the name of the variable to store the gold in

==== [store_locations] ====

Stores a series of locations that pass certain criteria into an array. Each member of the array has members 'x' and 'y' (the position) and 'terrain' (the terrain type) and 'owner_side' (villages only). The array will include any unreachable border hexes, if applicable.

* [[StandardLocationFilter]]: a location or location range which specifies the locations to store. By default, all locations on the map are stored.

* '''variable''': the name of the variable (array) into which to store the locations.

* '''mode''': {{DevFeature1.13|0}} defaults to ''always_clear'', which clears the variable, whether or not a match is found. If mode is set to ''replace'', the variable will not be cleared, and locations which match the filter will overwrite existing elements at the start of the array, leaving any additional elements intact if the original array contained more elements than there are locations matching the filter. If mode is set to ''append'', the variable will not be cleared, and locations which match the filter will be added to the array after the existing elements.

==== [store_reachable_locations] ====

Stores locations reachable by the given units. Can store either the movement, attack or vision ranges.

* '''[filter]''': a [[StandardUnitFilter]]. The locations reachable by any of the matching units will be stored.
* '''[filter_location]''': (optional) a [[StandardLocationFilter]]. Only locations which also match this filter will be stored.
* '''range''': possible values ''movement'' (default), ''attack'', ''vision''. If ''movement'', stores the locations within the movement range of the unit, taking Zone of Control into account. If ''attack'', stores the attack range (movement range + 1 hex). See note below for ''vision''.
* '''moves''': possible values ''current'' (default), ''max''. For ''movement'' and ''attack'', specifies whether to use the current or maximum movement points when calculating the range. Ignored for ''vision''.
* '''viewing_side''': If left unset then fog and shroud are ignored, hidden ambushers are not ignored, and the real reach of the units is stored. If set to a non-zero number, then the area stored for each unit matching the SUF is based on the information visible to that unit's side; it doesn't matter which non-zero number is given. Ignored completely for ''vision''.
* '''variable''': the name of the variable (array) into which to store the locations.

In 1.14 and before, the ''vision'' range is calculated as max movement range ignoring ZoC + 1 hex.

{{DevFeature1.15|12}} ''vision'' uses the same calculations as the fog and shroud, and handles:
* units with vision costs different to movement costs
* units whose vision points aren't the same as their max movement points
* jamming by enemy units

==== [store_map_dimensions] ====

Stores the map dimensions in a variable.

* '''variable''': the name of the variable where the values will be saved into. If it is skipped, a variable 'map_size' is used, and its contents overridden, if they existed already. The result is a container variable, with members ''width'' and ''height''.

==== [store_side] ====

Stores information about a certain side in a variable.

'''Keys:'''
* '''[[StandardSideFilter]]''': All matching sides are stored. (An array is created if several sides match - access it with side[2].team_name and so on.)
* '''variable''': the name of the variable to store the information in (default: "side")
* '''mode''':{{DevFeature1.13|0}} defaults to ''always_clear'', which clears the variable, whether or not a match is found. If mode is set to ''replace'', the variable will not be cleared, and sides which match the filter will overwrite existing elements at the start of the array, leaving any additional elements intact if the original array contained more elements than there are sides matching the filter. If mode is set to ''append'', the variable will not be cleared, and sides which match the filter will be added to the array after the existing elements.
'''Result'''

Variable will contain following members:
* '''color''': Team color used for ellipses, sprites, and flags. Will be one of the id's found in data/core/team-colors.cfg or a custom color defined by [[GameConfigWML#Color_Palettes|[color_range]]].
* '''controller''': Indicates type of player that control this side. ''Note: In networked multiplayer, the controller attribute may not be the same on all clients. Be very careful or you have OOS errors.''
** '''human''': Human player
** '''ai''': If players assigns "Computer Player" to "Player/Type" in game lobby
** '''null''': If players assigns "Empty" to "Player/Type" in game lobby
* '''fog''': Indicates whether this side is affected by fog of war.
* '''gold''': The amount of gold the side has.
* '''hidden''': (boolean) If 'yes', side is not shown in status table.
* '''income''': Income for this side (base income + all village income. AKA gross income. Note that this is different from the [side] income key).
* '''name''': Name of player.
* '''recruit''': A comma-separated list of unit types that can be recruited by this side.
* '''shroud''': Whether this side is affected by shroud.
* '''side''': The $side_number of the side belonging to this container
* '''team_name''': String representing the team's description.
* '''user_team_name''': Translated string representing the team's description.
* '''village_gold''': The amount of gold given to this side per village it controls per turn.
* '''scroll_to_leader''': (boolean) Whether the game view scrolls to the side leader at the start of their turn.
* '''flag''': Flag animation for villages owned by this side (see [[SideWML|[side]]]). Unless previously specified in [side] or changed with WML (see [[DirectActionsWML#.5Bmodify_side.5D|[modify_side]]]), this value may be empty for the default flag animation.
* '''flag_icon''': Flag icon for the status bar for this side (see [[SideWML|[side]]]). Unless previously specified in [side] or changed with WML (see [[DirectActionsWML#.5Bmodify_side.5D|[modify_side]]]), this value may be empty for the default flag icon.
* '''village_support''': The number of unit levels this side is able to support (does not pay upkeep on) per village it controls.
* '''defeat_condition''': {{DevFeature1.13|7}} When the side will be considered defeated. See description at [[SideWML]], [[ScenarioWML#Scenario_End_Conditions]]
* '''faction''': {{DevFeature1.13|7}} id of the selected faction, string (multiplayer-only)
* '''faction_name''': {{DevFeature1.13|7}} Name of the selected faction, string (multiplayer-only)
* '''num_units''' {{DevFeature1.13|7}}: The number of units the side currently has on the map.
* '''num_villages''' {{DevFeature1.13|7}}: The number of villages the side currently controls.
* '''total_upkeep''' {{DevFeature1.13|7}}: The number of unit levels the side is currently supporting.
* '''expenses''' {{DevFeature1.13|7}}: The amount of gold the side is currently spending to support units.
* '''net_income''' {{DevFeature1.13|7}}: The income the side gains per turn after expenses.
* '''base_income''' {{DevFeature1.13|8}}: The income the side gains per turn (same as [side] income key)

* {{DevFeature1.13|7}} All other keys and tags of the side that are contained in [[LuaWML:Sides#wesnoth.sides|wesnoth.sides]] .__cfg

==== [store_starting_location] ====

Stores the starting location of a side's leader in a variable. The variable is a composite type which will have members 'x', 'y', 'terrain' and 'owner_side' (villages only)

* [[StandardSideFilter]]: The starting locations of all matching sides will be stored. If multiple sides are matched, a WML array will be created.
* '''variable''': (default='location'): the name of the variable to store the location in
* '''mode''':{{DevFeature1.13|0}} defaults to ''always_clear'', which clears the variable, whether or not a match is found. If mode is set to ''replace'', the variable will not be cleared, and the starting locations of the sides which match the filter will overwrite existing elements at the start of the array, leaving any additional elements intact if the original array contained more elements than there are locations matching the filter. If mode is set to ''append'', the variable will not be cleared, and the starting locations of the matching sides will be added to the array after the existing elements.

==== [store_time_of_day] ====

Stores time of day information from the current scenario into a WML variable container.

* '''x, y''': Location to store the time for. [[DirectActionsWML#.5Btime_area.5D|Time areas]] matter; illumination does not. If this is omitted, the global (location-independent) time is stored.

* '''variable''': (default='time_of_day') name of the container on which to store the information. The container will be filled with the same attributes found on [[TimeWML]].

* '''turn''': (defaults to the current turn number) changes the turn number for which time of day information should be retrieved.

==== [store_turns] ====

Stores the turn limit (the maximum number of turns). If there is no limit, this stores ''-1''.

* '''variable''': (default='turns') the name of the variable in which to store the turn limit.

==== [store_unit] ====

Stores details about units into a [[VariablesWML#Container|container]] variable. When a unit is stored, all keys and tags in the unit definition may be manipulated, including some others, with [[InternalActionsWML#.5Bset_variable.5D|[set_variable]]]. A sample '''list of these tags and keys''' can be found at [[InternalActionsWMLUnitTags]].

If you have a doubt about what keys are valid or what the valid value range is for each key, code a [store_unit] event, save the game, and examine what keys are in the file (or just examine the '''[unit]''' tag(s) in any save file). One can also use the [[CommandMode|:inspect]] command or the [[InterfaceActionsWML#.5Binspect.5D|[inspect]]] tag to open a game-state inspector dialog, which can be used to view unit properties.

Common usage is to manipulate a unit by using '''[store_unit]''' to store it into a variable, followed by manipulation of the variable, and then [[DirectActionsWML#.5Bunstore_unit.5D|[unstore_unit]]] to re-create the unit with the modified variables.

''Note: stored units also exist on the field, and modifying the stored variable will not automatically change the stats of the units. You need to use [unstore_unit]. See also [[DirectActionsWML#.5Bunstore_unit.5D|[unstore_unit]]] and [[ConditionalActionsWML#.5Bforeach.5D|[foreach]]].

* '''[filter]''' with a [[StandardUnitFilter]] as argument. All units matching this filter will be stored. If there are multiple units, they will be stored into an array of variables. The units will be stored in order of their internal ''underlying_id'' attribute, which is usually in creation order (but you normally should not depend on the order).

* '''variable''': the name of the variable into which to store the unit(s)

* '''mode''': defaults to ''always_clear'', which clears the variable, whether or not a match is found. If mode is set to ''replace'', the variable will not be cleared, and units which match the filter will overwrite existing elements at the start of the array, leaving any additional elements intact if the original array contained more elements than there are units matching the filter. If mode is set to ''append'', the variable will not be cleared, and units which match the filter will be added to the array after the existing elements.

* '''kill''': if 'yes' the units that are stored will be removed from play. This is useful for instance to remove access to a player's recall list, with the intent to restore the recall list later.

==== [store_unit_defense] ====

{{DevFeature1.13|9}}

{{DevFeature1.15|7}} Fixed, was broken in 1.15.3

Stores in a variable the defense of a unit on a particular terrain. If terrain or location is not specified, the terrain on which the unit currently stands is used. (Note: it is a WML defense, so the higher it is, the weaker unit's defense is. A footpad on castle has 70% defense, so this function stores the value 30.)

* StandardUnitFilter
* '''loc_x''', '''loc_y''': x and y of a valid map location. The terrain on this location will be used for the defense calculation.
* '''terrain''': The terrain code for which unit defense should be calculated. If '''terrain''' is specified, '''loc_x''' and '''loc_y''' are ignored.
* '''variable''': the name of the variable into which to store the defense. default: "terrain_defense"

==== [store_unit_defense_on] ====

{{DevFeature1.15|7}} Similar to [store_unit_defense], but stores the same number that would be shown in the UI. For example, a footpad on castle has 70% defense, so this stores the value 70.

Takes the same attributes as [store_unit_defense], and defaults to storing the value in "terrain_defense".

==== [store_unit_type] ====

Stores a unit type definition into a variable.

* '''type''': (required) the defined ID of the unit type, for example "Goblin Knight". Do not use a translation mark or it will not work correctly for different languages. A comma-separated list of IDs may also be used to store an array of unit types.

* '''variable''': the name of the variable into which to store the unit type information (default "unit_type")

* '''mode''':{{DevFeature1.13|0}} defaults to ''always_clear'', which clears the variable. If mode is set to ''replace'', the variable will not be cleared, and the unit type will overwrite the existing element at the start of the array, leaving any additional elements intact if the original array contained more elements. If mode is set to ''append'', the variable will not be cleared, and the unit type will be added to the array after the existing elements.

==== [store_unit_type_ids] ====

* '''variable''': the name of the variable into which to store a comma-separated list of all unit type IDs including all from all loaded addons

==== [store_villages] ====

Stores a series of locations of villages that pass certain criteria into an array. Each member of the result array will have members 'x' and 'y' (the position) and 'terrain' (the terrain type) and 'owner_side'.

Note: This differs from using [store_locations] only in that the hexes considered for match are restricted to those with villages (those whose terrain type has its 'gives_income' flag set to true), in the same way that use of either the 'owner_side' key or the '[filter_owner]' will. In fact, if either of these are present, [store_villages] and [store_locations] will behave identically.

* '''variable''': the name of the variable (array) into which to store the locations (default: "location")
* '''[[StandardLocationFilter]]''' tags and keys as arguments

==== [store_items] ====

Stores current items in the scenario into an array. Each entry has at least members x and y and can have all of the other keys listed in the documentation of [[InterfaceActionsWML#.5Bitem.5D|[item]]] (depending on what was set during creating the item).

*'''variable''': name of the wml variable array to use (default "items")
*'''[[StandardLocationFilter]]''' keys as arguments: only items on locations matching this [[StandardLocationFilter]] will be stored
*'''item_name''': {{DevFeature1.15|0}} if given, only items created with a matching '''[item]name=''' will be stored. As of 1.15.0, this does not support comma-separated lists.

==== [store_relative_direction] ====

{{DevFeature1.13|0}}

Gets the relative direction from one hex to another. This is an interface to the function wesnoth uses to decide how a unit will face while it is moving / attacking / defending.

* '''[source]''' x and y must describe a map location
* '''[destination]''' similar
* '''variable''' name of the variable to store string result in (one of 'n', 'nw', 'ne', 's', 'sw', 'se')
* '''mode''' optional. 0 is the default setting corresponding to default wesnoth implementation used in animations. 1 is an alternate "radially symmetric" mode. The default mode breaks ties in the direction of south, since this makes more units face the player directly on screen. The radially symmetric mode breaks ties in the direction of counter-clockwise, and might be more appropriate in some cases.

==== [find_path] ====

A WML interface to the pathfinder. Calculates the path between a unit and a location and returns the result in a WML variable, that contains also an array for every step of the path (including the starting hex).

*'''[traveler]''': [[StandardUnitFilter]], only the first matching unit will be used for calculation
*'''[destination]''': [[StandardLocationFilter]]
*'''variable''': the variable name where the result will be stored, if no value is supplied 'path' will be used as default name. Each step will be stored in a [step] array inside that variable.
*'''allow_multiple_turns''': default no, if yes also moves that require more than one turn will be calculated.
*'''check_visibility''': default no, if yes the path will not be computed if some hexes are not visible due to shroud.
*'''check_teleport''': default yes; if no, teleport won't be taken in account while computing path.
*'''check_zoc''': default yes; if no, unit ZOCs won't be considered while calculating the path.
*'''nearest_by''': {{DevFeature1.15|2}} possible values "movement_cost" (default), "steps", "hexes"; if the [destination] SLF matches multiple hexes, the one that would need the least movement points to reach may not be the one that's closest as measured by '''hexes''', or closest as measured by steps, from the starting point. This option chooses which measurement to prefer.

More detail about multiple destinations and the return structure is on [[FindPathExplanation]] (moved out of this page because it has an image in it).

This is the structure of the variable returned by [find_path]:
[path]
hexes = non-zero if a path was successfully found.
if the path is calculated to an impassable hex, or the move requires multiple turns
and allow_multiple_turns is no, its value will be 0.
from_x, from_y = location of the unit
to_x, to_y = destination
movement_cost = total movement cost required by unit to reach that hex
required_turns = total turns required by unit to reach that hex
[step]
x, y = location of the step
terrain = terrain of the step
movement_cost = movement cost required by unit to reach that hex
required_turns = turns required by unit to reach that hex
[/step]
[/path]

==== [unit_worth] ====
Takes only an inline [[StandardUnitFilter]] (only the first matching unit will be used for calculation) and outputs the following variables:
*''cost'', the current unit cost;
*''next_cost'', the cost of the most expensive advancement;
*''health'', the health of the unit in percentage;
*''experience'', current experience in percentage;
*''unit_worth'', how much the unit is worth.

Mainly used for internal AI checks, but one could in theory just do anything with it.

[event]
name=moveto
[unit_worth]
x,y=$x1,$y1
[/unit_worth]
[message]
id=$unit.id
message=_"I cost $cost gold, with $health|% of my hitpoints and $experience|% on the way to cost $next_cost|.
I am estimated to be worth $unit_worth"
[/message]
[clear_variable]
name=cost,next_cost,health,experience,unit_worth
[/clear_variable]
[/event]

=== [clear_variable] ===

This will delete the given variable. This tag can delete a scalar or an entire array; it can also delete one container at an array index. The macro [https://www.wesnoth.org/macro-reference.html#CLEAR_VARIABLE CLEAR_VARIABLE] is a shortcut for this tag.

This action is good to use to clean up the set of variables; for example, a well-behaved scenario will delete any variables that should not be kept for the next scenario before the end of the scenario. One can also clear tags and variables of stored units; for example, one can remove [trait]s and [object]s.

* '''name''': the name of the variable to clear. This can also be a comma-separated list of multiple variable names.
** If a name ends with an array index, then it deletes that one container, and shifts the indexes of all subsequent containers. For example, <code>{CLEAR_VARIABLE my_awesome_array[2]}</code> deletes <code>my_awesome_array[2]</code>, but then moves <code>my_awesome_array[3]</code> to <code>my_awesome_array[2]</code>, moves <code>my_awesome_array[4]</code> to <code>my_awesome_array[3]</code>, and so on until the end of the array.
** Note that <code>{CLEAR_VARIABLE my_awesome_array}</code> deletes the entire array, but <code>{CLEAR_VARIABLE my_awesome_array[0]}</code> deletes only the first container.

=== [sync_variable] ===

{{DevFeature1.13|0}}

Sets one or multiple variables to the same value as on all clients and also on replays, it uses the value from the currently active side.
* '''name''' the name of the variable to synchonize this can be a comma seperated list.

== Other Internal Actions ==

Believe it or not, there are some internal actions that are not focused primarily on variables. They are all grouped here.

=== [fire_event] ===

Trigger a WML event (used often for [[EventWML#Custom_events|custom events]])

* '''name''': the name of event to trigger
** ''(Optional)'' {{DevFeature1.13|6}}

* '''id''': ''(Optional)'' the id of a single event to trigger {{DevFeature1.13|6}}

* '''[primary_unit]''': ''(Optional)'' Primary unit for the event. Will never match on a recall list unit. The first unit matching the filter will be chosen.
**[[StandardUnitFilter]] as argument. Do not use a [filter] tag.

* '''[secondary_unit]''': ''(Optional)'' Same as '''[primary_unit]''' except for the secondary unit.
**[[StandardUnitFilter]] as argument. Do not use a [filter] tag.

* '''[primary_attack]''': Information passed to the primary attack filter and $weapon variable on the new event.

* '''[secondary_attack]''': Information passed to the second attack filter and $second_weapon variable on the new event.

=== [remove_event] ===
{{DevFeature1.13|0}} Removes the event with the specified id.

* '''id''': the id of the event to remove. May be a comma separated list.

=== [insert_tag] ===

Inserts a variable as WML. In other words, the value of the passed [[VariablesWML#Container|container variable]] will be injected into the game as if they had been written out in WML form. ([[#.5Binsert_tag.5D_Example|See Example]]).

Tag insertion is a special case in that it can be used in places where other ActionWML cannot be used. The basic rule is that anywhere that $variable syntax works, tag insertion will also work. In practice this means pretty much everywhere except directly within top-level scenario tags.

*'''name''': The ["name"] to be given to the tag. This must be a tag which would be valid at the place where [insert_tag] is used, for anything to happen. (For example, if used as ActionWML, it should be a [[ActionWML]] tag name, and it may be a recognized subtag such as "option" when used within a [message]).

*'''variable''': Name of the container variable which will have its value inserted into the tag. If the container variable is a WML array, [insert_tag] will insert a different tag for each of its elements.

=== [role] ===

Tries to find a unit to assign a role to. This is useful if you want to choose a non-major character to say some things during the game. Once a role is assigned, you can use '''role=''' in a unit filter to identify the unit with that role (See [[FilterWML]]). However, there is no guarantee that roles will ever be assigned. You can use '''[have_unit]''' (see [[ConditionalActionsWML#Condition_Tags|Condition Tags]]) to see whether a role was assigned. This tag uses a [[StandardUnitFilter]] (without [filter]) with the modification to order the search by type, mark only the first unit found with the role, and the role attribute is not used in the search. If for some reason you want to search for units that have or don't have existing roles, you can use one or more [not] filters. The will check recall lists in addition to units on the map. In normal use, you will probably want to include a ''side'' attribute to force the unit to be on a particular side.

* '''role''': the value to store as the unit's role. This role is not used in the [[StandardUnitFilter]] when doing the search for the unit to assign this role to.

* '''type''': a comma-separated list of possible types the unit can be. If any types are given, then units will be searched by type in the order listed. If no type is given, then no particular order with respect to type is guaranteed.

* '''search_recall_list''': {{DevFeature1.13|5}} whether to consider units on the recall list when assigning the role. Can be either yes or no, defaults to yes. {{DevFeature1.13|6}} If set to 'only', then units on the map are not considered when assigning the role - only units on the recall list can receive it.

* '''[else]''' {{DevFeature1.13|5}} ActionWML to execute if the game is unable to find a unit to assign the role to. For example, this could be used to create a new unit satisfying the role.

* '''[auto_recall]''' {{DevFeature1.13|6}} If present, and the role is assigned to a unit on the recall list, then that unit is recalled. Supports all unique keys of [[DirectActionsWML#.5Brecall.5D|[recall]]], but no [[StandardUnitFilter]].

* [[StandardUnitFilter]], do not use a [filter] sub-tag. SUF's role= and type= keys are not used: if you want to use them, use a nested SUF wrapped inside a [and] tag.

=== [random_placement] ===
{{DevFeature1.13|2}}

Selects randomly a given number of locations from a given set of locations and exectutes the given code for each of those locations.

* '''[filter_location]''': a [[StandardLocationFilter]].
* '''[command]''': contains ActionWml that is executed for each of the locations.
* '''num_items''': the number of locations that should be selected. There are several ways of specifying this:
** An integer, giving the exact number of locations to use. (Variable substitution is supported too.)
** {{DevFeature1.15|0}} A percentage, meaning that fraction of the total available spaces.
** {{DevFeature1.15|0}} A [[Wesnoth_Formula_Language|WFL]] formula. It has access to one variable, ''size'', which is the total number of available spaces. In order to identify it as a WFL formula, the entire expression must be enclosed in parentheses. (Do not use a '''$''', as that will cause it to see ''size'' as zero.)
** A Lua expression. As with a WFL expression, it can access the ''size'' variable. {{DevFeature1.15|0}} This is now deprecated.
* '''variable''': The name of the variable that contains the current location during the execution of [command]. This is a container with the attributes x, y, n and terrain.
* '''min_distance''': The minimum distance of 2 chosen locations, a value less than 0 means that the same locations can be chosen more than one time.
* '''allow_less''': If yes, the tag will not show an error in case there were less than num_items locations available.

=== Flow control actions ===

{{DevFeature1.13|2}}

There are three actions that alter the flow of execution. They are '''[break]''', '''[continue]''', and '''[return]'''. All of them take no arguments.

* '''[break]''': The nearest enclosing loop immediately stops executing, and control continues with the next action after the end of that loop. If there is no enclosing loop, this is equivalent to '''[return]'''.
* '''[continue]''': The nearest enclosing loop immediately stops executing, and control continues at the beginning of that loop, with any iteration variables updated for the next iteration. If there is no enclosing loop, this is an error.
* '''[return]''': Control immediately returns to the Wesnoth engine. This completely exits the current event, including any nested events, such that the [message] will not be displayed in the below example. No further WML actions are executed in this context. Any separate, subsequent events will be run as usual.
<syntaxhighlight lang=wml>
[event]
name=moveto
[fire_event]
name=return_please
[/fire_event]
[message]
message="Made it back"
[/message]
[/event]
[event]
name=return_please
[return][/return]
[/event]
</syntaxhighlight>

=== [unsynced] ===

{{DevFeature1.13|?}}

Runs the contained actionwml in a unsynced context, that means actions performed inside [unsynced] are not synced over the network. for example
<syntaxhighlight lang=wml>
[event]
name=moveto
{VARIABLE_OP message rand "Hi,Hello,How are you?"}
[message]
message = $message
[/message]
{CLEAR_VARIABLE message}
[allow_undo]
[/allow_undo]
[/event]
</syntaxhighlight>
will print the same message to all clients, but also disallow undoing (regardless of [allow_undo]) for that moveto becasue it requests a synced random seed form the server. However this code
<syntaxhighlight lang=wml>
[event]
name=moveto
[unsynced]
{VARIABLE_OP message rand "Hi,Hello,How are you?"}
[message]
message = $message
[/message]
{CLEAR_VARIABLE message}
[/unsynced]
[allow_undo]
[/allow_undo]
[/event]
</syntaxhighlight>
will not prevent undoing, but might print a different message for each client in a multiplayer game (or during a sp replay), so `[unsynced]` should not be used for actions that actually change the gamestate otherwise you'll get OOS

== Examples ==

=== Using [set_variables] to Create Arrays of WML ===

<syntaxhighlight lang=wml>
[set_variables]
name=arr
mode=replace
[value]
foo=bar
[/value]
[value]
foo=more
[/value]
[/set_variables]
{DEBUG_MSG $arr[0].foo}
{DEBUG_MSG $arr[1].foo}
</syntaxhighlight>

This will produce two output messages, first one saying '''bar''' and next one saying '''more'''.

=== [insert_tag] Example ===

<syntaxhighlight lang=wml>
[event]
name=moveto

[set_variable]
name=temp.speaker
value=Konrad
[/set_variable]

[set_variable]
name=temp.message
value= _ "Yo Kalenz!"
[/set_variable]

[insert_tag]
name=message
variable=temp
[/insert_tag]
[/event]
</syntaxhighlight>

This is effectively identical to:

<syntaxhighlight lang=wml>
[event]
name=moveto

[message]
speaker=Konrad
message= _ "Yo Kalenz!"
[/message]
[/event]
</syntaxhighlight>

== See Also ==
* [[VariablesWML]]
* [[ActionWML]]
** [[ConditionalWML]]
** [[DirectActionsWML]]
** [[InterfaceActionsWML]]
* [[EventWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]
[[Category: ActionsWML]]

BuildingScenarios

2021-08-24T08:17:44Z

Shadowm: https links

{{Translations}}
{| style="float:right"
|
__NOTOC__
|}

{{Create}}

<div class="thumb tright"><div>
[https://www.wesnoth.org/images/sshots/wesnoth-1.11.8-1.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.11.8-1-175.jpg]
<div class="thumbcaption">The Elves Besieged</div></div>
</div>

Wesnoth scenarios are the individual levels within the game. They can be as simple or advanced as you choose, ranging from two sides who must fight each other to multiple sides with different characters, custom items, and complicated events. This page is split into several sections, starting with the basics and moving into more complex techniques. When you're done, you should have all the knowledge necessary to create your own scenarios.

Each scenario is made up of two files: the map file and the configuration file. The former, the map itself, is discussed in [[BuildingMaps]]. The latter describes everything about, and what occurs in, a scenario, from the setup of sides, units, music, events, and so on. Both files are plaintext are can be edited in any standard text editor. If you decide to use a wordprocessor, please make sure to Save As text (preferably with a .cfg extension), not as rich text.

Remember that you can use the scenarios that ship with the game for reference should you get stuck. They cover a wide range of techniques, so it's likely you'll find an example of what you need.

If you still don't understand something or can't get it to work, feel free to ask for assistance in the [https://forums.wesnoth.org/viewforum.php?f=23 WML Workshop] on the forums.

== The Wesnoth Markup Language ==

Scenarios are written in the [[ReferenceWML|Wesnoth Markup Language]] (WML), a custom language written specially to work with the game. It sports a relatively simple tag/key-based syntax, a complete guide to which can be found on the [[SyntaxWML]] page.

=== Quick Tag Index ===

Below follows an index of the basic WML tags used to create scenarios.

:* [[ScenarioWML]]: The top level tags [scenario], [multiplayer], [test], and [tutorial]
:* [[IntroWML]]: Setting up the intro screen
:* [[TimeWML]]: Setting up the time schedule
:* [[SideWML]]: Describing a side
:** [[SingleUnitWML]]: The syntax of a single unit
:** [[ShroudDataWML]]
:* [[EventWML]]: An event that happens in the scenario
:** [[FilterWML]]: All about filters
:** [[DirectActionsWML]], [[InterfaceActionsWML]], [[InternalActionsWML]]
:* [[MapGeneratorWML]]: The random map generator
:* [https://www.wesnoth.org/macro-reference.html Macro Reference]: A set of useful macro shortcuts you can use

=== Sample Code ===

A nice collection of simple beginner code to look at is documented on the [[BuildingScenariosSamples | Samples]] page, showcasing the basic usage and structure of WML in an actual coding sense.

== Scenarios and the Map Editor ==

<div class="thumb tright"><div>
[https://www.wesnoth.org/images/sshots/wesnoth-1.11.8-5.jpg https://www.wesnoth.org/images/sshots/wesnoth-1.11.8-5-175.jpg]
<div class="thumbcaption">Scenario Data</div></div>
</div>

As of Wesnoth 1.12, the Map Editor has become more fully featured, and includes options to define more basic scenario-related content for your scenario, such as name, unit placement, graphical items, time of day schedules, etc, without having to manually write the code yourself. However, the editor cannot create more complex WML. Those interesting snippets still have to be written by hand. These functions are most useful for creating a simple scenario from a map, or streamlining your workflow in creating a more complicated scenario.

In order to edit scenario metadata, select File → New Scenario. By default, the editor opens with a blank map file open only.

NOTE: Scenario-specific content will not be saved unless you also select the File → Save Scenario option before exit. Otherwise, you will simply get a map file.

== Building Your Scenario ==

:• [[BuildingScenariosSimple|Simple]] • [[BuildingScenariosIntermediate|Intermediate]] • [[BuildingScenariosAdvanced|Advanced]]

Creating a scenario is no simple task. Generally, you should have a premise mapped out for the scenario before you begin. Who will your protagonists face? What events will occur? How long will it be? You might decide to revise your plans as you code and test them. It will generally take many iterations of writing, coding, and playtesting until your scenario reaches a product you are satisfied with.

A discussion on tweaking and balancing your scenario to make it more fun is found on the [[BuildingScenariosBalancing|Balancing]] page. ESR has more handy tips in his [http://catb.org/~esr/wesnoth/campaign-design-howto.html Campaign Design How-To] article, and as mentioned before, don't hesitate to ask for help in the [https://forums.wesnoth.org/viewforum.php?f=23 WML Workshop].

A handy breakdown of the code of a scenario, line-by-line, is available on the three pages linked here. Each explores gradually more complex WML concepts.

== See Also ==

* [[ReferenceWML]] - WML master reference

BuildingScenarios

2021-08-24T08:16:51Z

Shadowm: Update links to macro-reference.html

{{Translations}}
{| style="float:right"
|
__NOTOC__
|}

{{Create}}

<div class="thumb tright"><div>
[http://www.wesnoth.org/images/sshots/wesnoth-1.11.8-1.jpg http://www.wesnoth.org/images/sshots/wesnoth-1.11.8-1-175.jpg]
<div class="thumbcaption">The Elves Besieged</div></div>
</div>

Wesnoth scenarios are the individual levels within the game. They can be as simple or advanced as you choose, ranging from two sides who must fight each other to multiple sides with different characters, custom items, and complicated events. This page is split into several sections, starting with the basics and moving into more complex techniques. When you're done, you should have all the knowledge necessary to create your own scenarios.

Each scenario is made up of two files: the map file and the configuration file. The former, the map itself, is discussed in [[BuildingMaps]]. The latter describes everything about, and what occurs in, a scenario, from the setup of sides, units, music, events, and so on. Both files are plaintext are can be edited in any standard text editor. If you decide to use a wordprocessor, please make sure to Save As text (preferably with a .cfg extension), not as rich text.

Remember that you can use the scenarios that ship with the game for reference should you get stuck. They cover a wide range of techniques, so it's likely you'll find an example of what you need.

If you still don't understand something or can't get it to work, feel free to ask for assistance in the [http://forums.wesnoth.org/viewforum.php?f=23 WML Workshop] on the forums.

== The Wesnoth Markup Language ==

Scenarios are written in the [[ReferenceWML|Wesnoth Markup Language]] (WML), a custom language written specially to work with the game. It sports a relatively simple tag/key-based syntax, a complete guide to which can be found on the [[SyntaxWML]] page.

=== Quick Tag Index ===

Below follows an index of the basic WML tags used to create scenarios.

:* [[ScenarioWML]]: The top level tags [scenario], [multiplayer], [test], and [tutorial]
:* [[IntroWML]]: Setting up the intro screen
:* [[TimeWML]]: Setting up the time schedule
:* [[SideWML]]: Describing a side
:** [[SingleUnitWML]]: The syntax of a single unit
:** [[ShroudDataWML]]
:* [[EventWML]]: An event that happens in the scenario
:** [[FilterWML]]: All about filters
:** [[DirectActionsWML]], [[InterfaceActionsWML]], [[InternalActionsWML]]
:* [[MapGeneratorWML]]: The random map generator
:* [https://www.wesnoth.org/macro-reference.html Macro Reference]: A set of useful macro shortcuts you can use

=== Sample Code ===

A nice collection of simple beginner code to look at is documented on the [[BuildingScenariosSamples | Samples]] page, showcasing the basic usage and structure of WML in an actual coding sense.

== Scenarios and the Map Editor ==

<div class="thumb tright"><div>
[http://www.wesnoth.org/images/sshots/wesnoth-1.11.8-5.jpg http://www.wesnoth.org/images/sshots/wesnoth-1.11.8-5-175.jpg]
<div class="thumbcaption">Scenario Data</div></div>
</div>

As of Wesnoth 1.12, the Map Editor has become more fully featured, and includes options to define more basic scenario-related content for your scenario, such as name, unit placement, graphical items, time of day schedules, etc, without having to manually write the code yourself. However, the editor cannot create more complex WML. Those interesting snippets still have to be written by hand. These functions are most useful for creating a simple scenario from a map, or streamlining your workflow in creating a more complicated scenario.

In order to edit scenario metadata, select File → New Scenario. By default, the editor opens with a blank map file open only.

NOTE: Scenario-specific content will not be saved unless you also select the File → Save Scenario option before exit. Otherwise, you will simply get a map file.

== Building Your Scenario ==

:• [[BuildingScenariosSimple|Simple]] • [[BuildingScenariosIntermediate|Intermediate]] • [[BuildingScenariosAdvanced|Advanced]]

Creating a scenario is no simple task. Generally, you should have a premise mapped out for the scenario before you begin. Who will your protagonists face? What events will occur? How long will it be? You might decide to revise your plans as you code and test them. It will generally take many iterations of writing, coding, and playtesting until your scenario reaches a product you are satisfied with.

A discussion on tweaking and balancing your scenario to make it more fun is found on the [[BuildingScenariosBalancing|Balancing]] page. ESR has more handy tips in his [http://catb.org/~esr/wesnoth/campaign-design-howto.html Campaign Design How-To] article, and as mentioned before, don't hesitate to ask for help in the [http://forums.wesnoth.org/viewforum.php?f=23 WML Workshop].

A handy breakdown of the code of a scenario, line-by-line, is available on the three pages linked here. Each explores gradually more complex WML concepts.

== See Also ==

* [[ReferenceWML]] - WML master reference

ConventionsWML

2021-08-24T08:16:20Z

Shadowm: Update links to macro-reference.html

The purpose of this page is to list conventions of WML --
that is, things that make WML more readable and flexible.

== Use wmlscope, wmllint, and wmlindent ==

The WML [[Maintenance_tools|maintenance tools]] will help you ensure that your WML is clean, up-to-date, and correct. Use them early and often; they will save you a lot of trouble later by catching entire classes of WML bugs before a user can ever see them.

== Macros ==

Using macros is useful for decreasing the size of a file,
and for making it clear that you are doing the same thing several times.
It is economical to use '''[https://www.wesnoth.org/macro-reference.html macros from the standard library]''' rather than writing your own whenever you can, but don't hesitate to write your own when the standard library does not do what you need.

A good rule for when to write a macro is to use them whenever information or code is being duplicated and all the duplications might have to be changed in the same way later. For information on how to create and use macros, see [[PreprocessorRef]].

Conventionally, your macro definitions should live in one or more files within a directory called utils under your main campaign directory. Be sure to
include that directory in your _main.cfg.

== Indentation ==

We used to have complicated recommendations for indentation. Now we have a WML indenting program and much simpler rules.

Be aware that no matter how you indent your WML, if it's accepted into mainline we are going to run <tt>wmlindent</tt> on it and smash it into the house style. We do this so our WML maintainers won't have to cope with lots of idiosyncratic indentation variants. You can make your WML more readable by writing in the house style to begin with.

# Indent each level with '''4 spaces'''.
# Indent attributes a level deeper than their parent tag.
# Indent macros as though the <tt>#define/#enddef</tt> are an outermost level; that is, the macro body starts with one level of indenting. Same applies to <tt>#undef</tt>.
# Don't indent <tt>#ifdef</tt>/<tt>#ifndef</tt>/<tt>#else</tt>/<tt>#endif</tt> at all
# Indent comments at the same level as the text they go with.

When in doubt, run <tt>wmlindent</tt> on your code. See [[Maintenance tools]] for more description of this program.

:'''Note:''' Although 4 spaces is the mainline style, there's absolutely ''nothing'' wrong with tabs either. Those of you who prefer a simpler Notepad program should not feel compelled to use spacebar and/or delete key four times the necessary amount when you can simply use tabs. In any case, it is very easy to convert these to the standard convention using <tt>wmlindent</tt>, so don't be scared to use your preferred method of indentation when working with WML. The most important thing to keep in mind is that your code should be uniformly indented, nested to the proper level, and using a form of whitespace that is easy for you to read, work with, and debug.

== Naming files ==

First of all, don't put spaces in filenames;
this causes errors on some systems.
Use underscores('''_''') instead.

If the IDs of your scenarios are different from their names,
name the files after the IDs, not the names.
That way it is easier to tell which scenario is next.

On some systems, filenames are case-sensitive. This means that if the ID has capital or lowercase letters, then the files must have identical capital or lowercase letters.

Use the scenario number and an underscore as a name prefix of your scenario files, and if you have more than 9 of these put 0 at the beginning of single-digit numbers. This will make them list in order, which is convenient for people trying to read your campaign.

While many campaigns use the same sort of number prefixing for their map files, it's better not to if (as sometimes happens) your campaign needs to use the same map twice.

== WML variables ==

(For information about what WML variables are, see [[VariablesWML]].)
These shouldn't be used except when necessary.
[have_unit] tags can often be used instead.
Also, make sure that your scenarios
clear meaningless variables using [clear_variable].

For variable values, use 'yes' and 'no' for boolean values. (Wesnoth does not accept 1 or 0 as boolean values; see [[ConditionalActionsWML#Boolean Values]].

== See Also ==
* [[ReferenceWML]]

[[Category:WML Reference]]

DirectActionsWML

2021-08-24T08:13:36Z

Shadowm: Update links to macro-reference.html

{{WML Tags}}
== Direct actions ==

Direct actions are actions that have a direct effect on gameplay. They can be used inside of [[EventWML|events]].

The following tags are actions:

=== [endlevel] ===
Ends the scenario.
* '''result''': before the scenario is over, all events with ''name=result'' are triggered. If ''result=victory'', the player progresses to the next level (i.e., the next scenario in single player); if ''result=defeat'', the game returns to the main menu.

When the result is "victory" the following keys can be used:
* '''bonus''': whether the player should get bonus gold (maximum possible gold that could have been earned by waiting the level out). The default is bonus=yes. {{DevFeature1.13|2}} Alternatively, a number, defining the bonus multiple (1.0 meaning full).
* '''carryover_report''': whether the player should receive a summary of the scenario outcome, the default is carryover_report=yes.
* '''save''': whether a start-of-scenario save should be created for the next scenario, the default is save=yes. Do not confuse this with saving of replays for the current scenario.
* '''replay_save''': whether a replay save for the current scenario is allowed, the default is replay_save=yes. If yes, the player's settings in preferences will be used to determine if a replay is saved. If no, will override and not save a replay.
* '''linger_mode''': If ...=yes, the screen is greyed out and there's the possibility to save before advancing to the next scenario, the default is linger_mode=yes.
* '''reveal_map''': (Multiplayer only) (Default is 'yes') If 'no', shroud doesn't disappear when game ended.
* '''next_scenario''': (default specified in '''[scenario]''' tag) the ID of the next scenario that should be played. All units that side 1 controls at this point become available for recall in ''next_scenario''.
* '''carryover_percentage''': by default 80% of the gold is carried over to the next scenario, with this key the amount can be changed.
* '''carryover_add''': if yes the gold will be added to the starting gold the next scenario, if no the next scenario will start with the amount of the current scenario (after taxes) or the minimum in the next scenario. Default is no.
* '''music''': (default specified in '''[scenario]''' or '''[game_config]''' tags) a comma-separated list of music tracks from which one will be chosen and played once after any events related to the end of level result are executed; by default, victory_music is used on victory, and defeat_music on defeat.
* '''end_credits''': Whether to display the credits screen at the end of a single-player campaign. Defaults to ''yes''. Note that this has cumulative effects over the campaign - it persists even if the endlevel does not trigger the end of the campaign. See also [[CampaignWML]].
* '''end_text''': (translatable) Text that is shown centered in a black screen at the end of a campaign. Defaults to "The End". Note that this has cumulative effects over the campaign - it persists even if the endlevel does not trigger the end of the campaign. See also [[CampaignWML]].
* '''end_text_duration''': Delay, in milliseconds, before displaying the game credits at the end of a campaign. In other words, for how much time '''end_text''' is displayed on screen. Defaults to 3500. Note that this has cumulative effects over the campaign - it persists even if the endlevel does not trigger the end of the campaign. See also [[CampaignWML]].
* <strike>'''[next_scenario_settings]''': Any tags or attribute children of this optional argument to [endlevel] are merged into the scenario/multiplayer tag of the *next* scenario. This allows you to e.g. reconfigure the [side] tags or settings, just before load. </strike> This feature was removed in 1.11.17, it might be redesigned and reintroduced.
* <strike>'''[next_scenario_append]''': Any tags of this optional argument are appended at high level to the next scenario. This is most appropriate for [event] tags, although you may find other uses. Example test scenario for these features: https://gna.org/support/download.php?file_id=20119 </strike> This feature was removed in 1.11.17, it might be redesigned and reintroduced.
* '''[result]''' {{DevFeature1.13|0}} Allows specification of a side specific result, this is for competitive multiplayer scenarios/campaigns where it might happen that one player wins but another player loses. The following attributes are accepted and have the same effect as in '''[endlevel]''':
** '''result'''
** '''bonus'''
** '''carryover_percentage'''
** '''carryover_add'''

And there is also
** '''side''' The number of the side for which these results should apply.

=== [unit] ===
Creates a unit (either on the map, on a recall list, or into a variable for later use.) For syntax see [[SingleUnitWML]].
* {{Short Note:Predefined Macro|GENERIC_UNIT}}

This tag can also recall an existing unit, which happens when:
* the '''id=''' attribute is used
* a unit with that '''id=''' already exists
* (might be unnecessary) the existing unit is on the side's recall list
in this case, the unit is recalled at the '''x,y=''' or '''location_id=''' given, and any other data in the tag is ignored.

Campaign authors: a usual way to recall plot-necessary heroes is to use a macro with the data for creating that hero. This helps during debugging, because you can skip to scenarios and the recall-or-create functionality means that any units which are normally met in a previous scenario are automatically created (otherwise some scenarios may be an instant loss). This can only be used for units that must survive the previous scenarios, as it would recreate units if they died in a previous scenario.
For example,
[https://github.com/wesnoth/wesnoth/blob/1.14.7/data/campaigns/Heir_To_The_Throne/utils/httt_utils.cfg#L685 HttT's NEED_DELFADOR macro].

=== [recall] ===
Recalls a unit taking into account any [http://wiki.wesnoth.org/SingleUnitWML filter_recall] of the leader. The unit is recalled free of charge, and is placed near its leader, e.g., if multiple leaders are present, near the first found which would be able to normally recall it.

If neither a valid map location is provided nor a leader on the map would be able to recall it, the tag is ignored.

* [[StandardUnitFilter]]: the first matching unit will be recalled. If no units match this tag is ignored. Do not use a [filter] tag. If a comma separated list is given, every unit currently considered for recall is checked against all the types (not each single one of the types against all units).
* '''x,y''': the unit is placed here instead of next to the leader.
* '''location_id''': {{DevFeature1.15|0}} the name of a special map location to recall to. Used instead of '''x,y'''.
* '''show''': yes/no, default yes: whether the unit is animated (faded in) or instantly displayed
* '''fire_event''': boolean yes|no (default no); whether any according prerecall or recall events shall be fired.
* '''check_passability''': (boolean yes|no, default yes): If yes, checks for terrain passability when placing the unit (a nearby passable hex is chosen).
* '''[secondary_unit]''': {{DevFeature1.13|?}} If present and show=yes, a matching unit will be chosen and their recruiting animation played.

=== [teleport] ===
Teleports a unit on map. {{Short Note:Predefined Macro|TELEPORT_UNIT}}
* '''[filter]''': [[StandardUnitFilter]] the first unit matching this filter will be teleported.
* '''x,y''': the hex to teleport to. If that hex is occupied, the closest unoccupied hex will be used instead.
* '''location_id''': {{DevFeature1.15|0}} the name of a special map location to teleport to. Used instead of '''x,y'''.
* '''clear_shroud''': should shroud be cleared on arrival
* '''animate''': should a teleport animation be played (if the unit doesn't have a teleport animation, it will fade out/fade in)
* '''check_passability''': (boolean yes|no, default yes): normally, units will not be teleported into terrain that is impassable for them. Setting this attribute to "no" permits it.

(Note: There is also a ability named teleport, see [[AbilitiesWML]].)

=== [terrain_mask] ===
Changes the terrain on the map. See [[TerrainMaskWML]].

=== [terrain] ===
Changes the terrain on the map.
* '''terrain''': the character of the terrain to use. See [[TerrainCodesWML]] to see what letter a type of terrain uses.
* [[StandardLocationFilter]]. This [[StandardLocationFilter]]'s terrain= key is used for the new terrain, filtering by terrain can be done with a nested [[StandardLocationFilter]]: [and]terrain=terrain_string_to_be_filtered_for.
* '''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.

If you want to remove the overlays from a terrain and leave only the base, use:
layer=overlay
terrain="^"

Note: When a hex changes from a village terrain to a non-village terrain, and a team owned that village it loses that village. When a hex changes from a non-village terrain to a village terrain and there is a unit on that hex it does not automatically capture the village. The reason for not capturing villages is that there are too many choices to make; should a unit lose its movement points, should capture events be fired. It is easier to do this as wanted by the author in WML.

=== [gold] ===
Gives sides gold.
* '''amount''': the amount of gold to give.
* '''side''': (default=1) the number of the side to give the gold to. Can be a comma-separated list of sides. note: Default side=1 for empty side= is deprecated.
* [[StandardSideFilter]] tags and keys; default for empty side= is all sides, as usual in a SSF.

=== [unstore_unit] ===
Creates a unit from a game variable, and activates it on the playing field or recall list. This must be a specific variable describing a unit, and may not be an array (if it is, only the first unit will be unstored).

This may be useful in different contexts:
* To update a unit on the map after having edited its WML. This usage is common, but discouraged - if possible, you should use [[#.5Bmodify_unit.5B|[modify_unit]]] or [[#.5Bobject.5B|[object]]] instead.
* To place a previously-defined unit into the scenario, if it was directly defined in a WML variable, using [unit] with the key '''to_variable'''. This usage is rather uncommon.
* To place a unit back into the game that was removed earlier, for example a hero that leaves the party for awhile and then comes back.

The variable is not cleared. To unstore units from an array variable, iterate over the array. See [[SyntaxWML]] and [[VariablesWML/How to use variables]] for more information about variable usage. See also [[InternalActionsWML#.5Bstore_unit.5D|[store_unit]]], [[ConditionalActionsWML|For]], [[ConditionalActionsWML#.5Bwhile.5D|[while]]] and [[InternalActionsWML#.5Bclear_variable.5D|[clear_variable]]].

The tag takes the following keys:
* '''variable''': This is required to indicate the name of the variable to read the unit from.
* '''Placement keys''':
** '''x''' ,'''y''': By default, the unit will be placed at the location specified in the variable, but if these keys are present, the unit will be placed at that location instead. To place the unit on the recall list of its side, use '''x,y=recall,recall'''. (If you want to change the said, you need to first update ''$unit.side'' in the variable before unstoring.)
** '''location_id''': {{DevFeature1.15|0}} The name of a special map location to unstore to. Used instead of '''x,y'''.
** '''find_vacant''' (yes|no, default no): Whether the unit should be placed on the nearest vacant tile to its specified location. If this is set to 'no' (default), then any unit on the same tile as the unit being unstored will be destroyed.
** '''check_passability''' (yes|no, default yes): Only relevant if '''find_vacant=yes'''. In that case, this determines whether game will try to find a passable tile for the unit. If set to no, the unit may be placed on an impassable tile. Note that if both '''find_vacant''' and '''check_passability''' are set, then the unit's position may be shifted even if there is not a unit on the target space, if that space is not passable for the unit.
* '''Animation keys''' (these determine the visual effect of how the unit is placed or updated):
** '''text''': (translatable) A floating text to display above the unit, such as a damage amount.
** '''male_text''', '''female_text''': {{DevFeature1.13|2}} (translatable) gender-specific versions of the above
** '''red''', '''green''', '''blue''': (default=0,0,0) the color of the text. Values vary from 0-255. You may find it convenient to use the {COLOR_HARM} or {COLOR_HEAL} macro instead. (Use {COLOR_HARM} or {COLOR_HEAL} instead of the whole red,green,blue= line.)
** '''animate''': (boolean yes|no, default yes) Determines whether to play any animations associated with the unstore. Currently this only affects the advancement animation ("levelout" and "levelin", defaulting to a fade to white and back) if the unit ends up advancing.
* '''Side-effect keys''' (these directly modify the behaviour of the action):
** '''advance''': (default=yes) if yes the unit is advanced if it has enough XP. When modifying XP, make sure to do it from inside a [[EventWML#Multiplayer_safety|synchronized event]] or it may lead to OOS errors, especially when several advancement paths exist. Note that advance and post advance events are called, so infinite loops can happen.
** '''fire_event''' (yes|no, default no): Whether any advance/post advance events shall be fired if an advancement takes place. This also affects whether the unit placed event is fired.

Units can be unstored with negative (or zero) hit points. This can be useful if modifying a unit in its last_breath event (as the unit's death is already the next step), but tends to look wrong in other cases. In particular, it is possible to have units with negative hit points in play. Such units are aberrations, subject to unusual behavior as the game compensates for them. (For example, such units are currently automatically hit–and killed–in combat.) The details of the unusual behavior are subject to change between stable releases without warning.

=== [allow_recruit] ===
Allows a side to recruit units it couldn't previously recruit.
* '''type''': the types of units that the side can now recruit.
* '''side''': (default=1) the number of the side that is being allowed to recruit the units. This can be a comma-separated list note: Default side=1 for empty side= is deprecated.
* [[StandardSideFilter]] tags and keys; default for empty side= is all sides, as usual in a SSF.

=== [allow_extra_recruit] ===
Allows a leader to recruit units it couldn't previously recruit.
These types add to the types the leader can recruit because of [side]recruit=.
* '''extra_recruit''': the types of units that the unit can now recruit.
* '''[[StandardUnitFilter]]''': All units matching this filter are modified. Does not match on recall list units.

=== [disallow_recruit] ===
Prevents a side from recruiting units it could previously recruit.
* '''type''': the types of units that the side can no longer recruit. {{DevFeature1.13|0}} If omitted, all recruits for matching sides will be disallowed.
* '''side''': (default=1) the number of the side that may no longer recruit the units. This can be a comma-separated list note: Default side=1 for empty side= is deprecated.
* [[StandardSideFilter]] tags and keys; default for empty side= is all sides, as usual in a SSF.

=== [disallow_extra_recruit] ===
Prevents a leader from recruiting units it could previously recruit.
* '''extra_recruit''': the types of units that the side can no longer recruit.
* '''[[StandardUnitFilter]]''': All units matching this filter are modified. Does not match on recall list units.

=== [set_recruit] ===
Sets the units a side can recruit.
* '''recruit''': the types of units that the side can now recruit.
* '''side''': The number of the side that is having its recruitment set. This can be a comma-separated list.
* [[StandardSideFilter]] tags and keys; default for empty side= is all sides, as usual in a SSF.

=== [set_extra_recruit] ===
Sets the units a leader can recruit.
* '''extra_recruit''': the types of units that the leader can now recruit.
* '''[[StandardUnitFilter]]''': All units matching this filter are modified. Does not match on recall list units.

=== [modify_side] ===
Modifies some details of a given side in the middle of a scenario. '''The following listed properties are the only properties that [modify_side] can affect!'''
* '''side''': (default=1) the number of the side that is to be changed. note: Default side=1 for empty side= is deprecated.
* '''[filter_side]''' with a [[StandardSideFilter]] as argument
* '''income''': the income given at the begining of each turn.
* '''recruit''': a list of unit types, replacing the side's current recruitment list.
* '''team_name''': the team in which the side plays the scenario.
* '''user_team_name''': a translatable string representing the team's description. This has no effect on alliances. Defaults to ''team_name''.
* '''side_name''': {{DevFeature1.13|?}} a translatable string representing the side leader's description.
* '''gold''': the amount of gold the side owns.
* '''village_gold''': the income setting per village for the side.
* '''controller''': the identifier string of the side's controller. Uses the same syntax of the ''controller'' key in the [[SideWML|[side]]] tag. warning: in multiplayer, changing the controller of a side might result in OOS during some events like, for example 'side_turn_end'; see [https://github.com/wesnoth/wesnoth/issues/2563 issue #2563].
* '''fog''': a boolean string (yes/no) describing the status of Fog for the side.
* '''shroud''': a boolean string describing the status of Shroud for the side.
* '''hidden''': a boolean string specifying whether side is shown in status table.
* '''color''': a team color range specification, name (e.g. "red", "blue"), or number (e.g. "1", "2") for this side. The default color range names, numbers, and definitions can be found in data/core/team_colors.cfg.
* '''[ai]''': sets/changes AI parameters for the side. Only parameters that are specified in the tag are changed, this does not reset others to their default values. Uses the same syntax as described in [[AiWML]]. Note that [modify_side][ai] works for all simple AI parameters and some, but not all, of the composite ones. If in doubt, use [http://wiki.wesnoth.org/AiWML#Adding_and_Deleting_Aspects_with_the_.5Bmodify_ai.5D_Tag [modify_ai]] instead, which always works. {{DevFeature1.13|?}} If this contains an '''ai_algorithm''', the AI parameters will be reset to those of the indicated AI before adding any additional parameters included in the tag. In other words, this allows replacing the AI config rather than appending to it.
* '''switch_ai''': replaces a side ai with a new AI from specified file(ignoring those AI parameters above). Path to file follows the usual WML convention.
* '''reset_maps''': If set to "yes", then the shroud is spread to all hexes, covering the parts of the map that had already been explored by the side, including hexes currently seen. (Seen hexes will be cleared at the end of most events; they can also be manually cleared with {{tag|InterfaceActionsWML|redraw}}.) This is only effective if shroud is on, but this is evaluated after shroud= (and before shroud_data=).
* '''reset_view''': If set to "yes", then the fog of war is spread to all hexes, covering the parts of the map that had already been seen this turn by the side, including hexes currently seen, excluding hexes affected by multi-turn {{tag|DirectActionsWML|lift_fog}}. (Seen hexes will be cleared at the end of most events; they can also be manually cleared with {{tag|InterfaceActionsWML|redraw}}.) This is only effective if fog is on, but this is evaluated after fog=.
* '''share_maps''': change the share_maps side attribute. Be sure to use shroud=yes for that side and have it as an ally
* '''share_view''': change the share_view side attribute. Be sure to use fog=yes for that side and have it as an ally
* '''share_vision''': change both the above at the same time
* '''shroud_data''': changes to the side's shroud, using the same format as when defining the [side].
* '''suppress_end_turn_confirmation''': Boolean value controlling whether or not a player is asked for confirmation when skipping a turn.
* '''scroll_to_leader''': Boolean value controlling whether or not the game view scrolls to the side leader at the start of their turn when present.
* '''flag''': Flag animation for villages owned by this side (see [[SideWML|[side]]]).
* '''flag_icon''': Flag icon used for this side in the status bar (see [[SideWML|[side]]]).
* '''village_support''': The number of unit levels this side is able to support (does not pay upkeep on) per village it controls.
* '''defeat_condition''' {{DevFeature1.13|0}}: When the side is considered defeated (see [[SideWML|[side]]]).
* '''[set_variable]''', '''[clear_variable]''' {{DevFeature1.15|3}} Sets or clears a variable within the side; uses the same syntax as [[InternalActionsWML#.5Bset_variable.5D|[set_variable]]] or [[InternalActionsWML#.5Bclear_variable.5D|[clear_variable]]] in ActionWML.
* '''[variables]''' {{DevFeature1.15|3}} The contents of this tag is merged into the side's variables.

=== [modify_turns] ===
Modifies the turn limit in the middle of a scenario.
* '''value''': the new turn limit.
* '''add''': if used instead of ''value'', specifies the number of turns to add to the current limit (can be negative).
* '''current''': changes the current turn number after applying turn limit modifications, if any. It is not possible to change the turn number to exceed the turn limit (1 <= current turns <= max turns).

=== [allow_end_turn] ===
Allows human players to end their turn through the user interface if they were previously affected by the '''[disallow_end_turn]''' action. This action doesn't take any arguments.

=== [disallow_end_turn] ===
Disallows human players to end their turn through the user interface. This action doesn't require arguments.
* '''reason''' (translatable): {{DevFeature1.15|0}} Allows to optionally specify a reason.

=== [capture_village] ===
Changes the ownership of a village.
* [[StandardLocationFilter]]: all village locations matching the filter are affected.
* '''side''': the side that takes control of the village. This side needs to have a leader (canrecruit=yes). If the side key is not given, the village will become neutral (unless [filter_side] is present, in which case that side fiter decides, see below).
* '''[filter_side]''' with [[StandardSideFilter]] tags and keys as arguments; if both this tag and inline side= are present it's an error. Otherwise, the first matching side gets ownership (or the village becomes neutral if none match).
* '''fire_event''' (boolean yes|no, default: no): Whether any capture events shall be fired.

=== [kill] ===
Removes all units (including units in a recall list) that match the filter from the game.
* [[StandardUnitFilter]]: Selection criterion; do not use a [filter] tag.
* '''animate''' (default 'no'): if 'yes', displays the unit dying (fading away). {{DevFeature1.13|8}} If '''[secondary_unit]''' is given, also plays the victory animation of that unit.
* '''fire_event''' (default 'no'): if 'yes', triggers any appropriate 'die' events (See [[EventWML]]). Note that events are only fired for killed units that have been on the map (as opposed to recall list).
* '''[secondary_unit]''' with a [[StandardUnitFilter]] as argument. Do not use a [filter] tag. Has an effect only if fire_event=yes ({{DevFeature1.13|8}} or if it has a victory animation and animate=yes). The first on-map unit matching the filter becomes second_unit in any fired die and last breath events. If an on-map unit matches and if there are several units killed with a single [kill] tag, second_unit is this same unit for all of them. If no on-map unit matches or [secondary_unit] isn't present, the variable second_unit in each of the die and last breath events is always the same as the variable unit (the dying unit).
* '''[primary_attack]''', '''[secondary_attack]''' {{DevFeature1.13|8}} The attacks to use for matching the animation. Useful for example on the wose, whose death animation depends on the damage type it was killed by.

=== [move_unit] ===
Moves a unit along a path on the map. The path can be specified exactly, or as a series of waypoints that the unit will pass through.
* [[StandardUnitFilter]] as argument; do not use a [filter] tag. All units matching the filter are moved. If the target location is occupied, the nearest free location is chosen.
* '''to_x''' (unsigned integer): The units are moved to this x coordinate. Can be a comma-separated list, in which case the unit follows this given path during the move.
* '''to_y''' (unsigned integer): The units are moved to this y coordinate. Can be a comma-separated list.
* '''dir''' (string): {{DevFeature1.15|0}} Performs a relative movement instead of an absolute movement. For example, dir=n,n,nw will move two spaces north and then one space to the northwest. This is used instead of '''to_x''' and '''to_y'''.
* '''to_location''': {{DevFeature1.15|0}} Moves matching units to locations placed in the map editor with the "New Location" button. Can be a comma-separated list. This is used instead of '''to_x''' and '''to_y'''.
* '''check_passability''' (boolean yes|no, default yes): Whether the terrain the unit is moved to should be checked for suiting the unit. (If it does not, a nearby suitable hex is chosen.)
* '''force_scroll''': Whether to scroll the map or not even when [[InterfaceActionsWML#.5Block_view.5D|[lock_view]]] is in effect or ''Follow Unit Actions'' is disabled in ''Advanced Preferences''. Defaults to using [[InterfaceActionsWML#.5Bmove_unit_fake.5D|[move_unit_fake]]]'s default value.
* '''clear_shroud''': {{DevFeature1.15|0}} (boolean yes|no, default no) Whether to remove shroud and fog after the unit was moved, but before events are fired. It will not clear all alongside the path, only around the target destination.
* '''fire_event''' (boolean yes|no, default no): Whether any according moveto events shall be fired. The target location ($x1, $y1 in the event) may not be the same location that the unit was tried to be moved to, if the original target location is occupied or impassable.

=== [modify_ai] ===
Changes AI objects (aspects, goals, candidate actions or stages) for a specified side. See [[Modifying_AI_Components#The_.5Bmodify_ai.5D_Tag|Modifying AI Components]] for full description.

* '''action''' (string): Takes values 'add', 'change', 'delete' or 'try_delete' to do just that for the AI object.
* '''path''' (string): Describes which AI object is to be modified.
* '''[facet]''', '''[goal]''', '''[candidate_action]''' or '''[stage]''': Details about the AI object to be modified.
* [[StandardSideFilter]] tags and keys; default for empty side= is all sides, as usual in a SSF.

=== [modify_unit] ===
works similar to the MODIFY_UNIT macro.
* '''[filter]''' with a [[StandardUnitFilter]] as argument. All units matching this filter are modified. Matches on recall list units too.
* '''[object]''', '''[trait]''', {{DevFeature1.13|5}} '''[advancement]''' - The given modifications will be immediately applied to all units matching the filter. ([object] is described further below)
** '''delayed_variable_substitution''' {{DevFeature1.13|5}} (boolean yes|no, default no): If set to "yes", the wml block contained in this [object], [trait], or [advancement] is not variable-substituted at execution time of the event containing this [modify_unit]. You need this for any effect that uses variable substitution or when using [effect][filter] with a $this_unit. {{DevFeature1.13|9}} This is no longer needed when adding ABILITY_TELEPORT, ABILITY_LEADERSHIP or SPECIAL_BACKSTAB.
** Do not use a '''[modifications]''' tag, as this may skip some of the special-case handling for newly added objects, traits and advancements.
* '''[effect]''' {{DevFeature1.13|6}} Applies the effect directly to the unit. See [[EffectWML]].
* '''[set_variable]''', '''[clear_variable]''' {{DevFeature1.15|3}} Sets or clears a variable within the unit; uses the same syntax as [[InternalActionsWML#.5Bset_variable.5D|[set_variable]]] or [[InternalActionsWML#.5Bclear_variable.5D|[clear_variable]]] in ActionWML.
* Accepts generally the syntax inside of wml unit variables created by [store_unit] which can be viewed in a savefile or by using the [[CommandMode|inspect command]]. Cannot remove things or add/alter unit animations. Subtags with the same name must be written in the correct order to match them with the tag they are supposed to modify. Note that keys will be processed in arbitrary order, which may cause problems if you use formulas that depend on other formulas. To work around this you may need to use the tag twice with the same filter.
example usage (see also the test scenario):
<syntaxhighlight lang='wml'>
[modify_unit]
[filter]
x,y=38,6
[/filter]
hitpoints=10
{TRAIT_HEALTHY}
[/modify_unit]
</syntaxhighlight>

The unit which is currently modified is accessible via $this_unit, e.g. hitpoints = "$($this_unit.hitpoints / 2)" to set the hitpoints of all units to half of their particular maxima. This this_unit variable is independent from the this_unit variable available in the SUF used to determine which units to modify (first all matching units are gathered, and then all those are modified).

'''Note:''' Some some properties of the units are reset sometimes (for example when the unit advances or when [remove_object] is called), so it's usually better to change them with [object] ([object] inside [modify_unit]) than to change those properties directly via [modify_unit]. The following properties are _not_ reset in [remove_object] and are thus safe to use directly in [modify_unit]:
* '''side'''
* '''gender'''
* '''name'''
* '''canrecruit'''
* '''unrenamable'''
* '''extra_recruit'''
* '''[variables]'''
* '''facing'''
* '''goto_x, goto_y'''
* '''hitpoints'''
* '''experience'''
* '''moves'''
* '''[status]''' (not sure on this one)
* '''attacks_left'''
* '''role'''

=== [transform_unit] ===
Transforms every unit on the map matching the filter to the given unit type. Keeps intact hit points, experience and status. If the unit is transformed to a non-living type (undead or mechanical), it will be also unpoisoned. Hit points will be changed if necessary to respect the transformed unit's maximum hit points.
* [[StandardUnitFilter]]: do not use a [filter] tag.
* '''transform_to''': the unit type in which all the units matching the filter will be transformed. If missing, the units will follow their normal advancement.

=== [petrify] ===

* [[StandardUnitFilter]] as an argument. Do not use a [filter] tag. All units matching this filter are petrified. Recall list units are included.

=== [unpetrify] ===
* [[StandardUnitFilter]] as an argument. Do not use a [filter] tag. All units matching this filter are unpetrified. Recall list units are included.

=== [object] ===
Gives some unit an object which modifies their stats in some way.
* '''id''': (Optional) allows the item to be removed later. By default, an object with a defined ID can only be picked up once per scenario, even if it is removed later or first_time_only=no is set for the event. You can remove this restriction by setting take_only_once=no. For filtering objects, it might be simpler to use a custom key such as item_id. The id string can contain only letters, numbers and underscores.
* '''take_only_once''': (default yes) {{DevFeature1.13|6}} If set to "no", the object's ID does not prevent it from being taken more than once.
* '''delayed_variable_substitution''' (boolean yes|no, default no): If set to "yes", the wml block contained in this [object] is not variable-substituted at execution time of the event where this [object] is within. You need this for any effect that uses variable substitution or when using [effect][filter] with a $this_unit. {{DevFeature1.13|9}} This is no longer needed when adding ABILITY_TELEPORT, ABILITY_LEADERSHIP or SPECIAL_BACKSTAB.
* '''[effect]''': one or more effect elements may be listed. See [[EffectWML]] for a description of [effect].
* '''duration''':
**if 'scenario', effects only last until the end of the scenario.
**if 'forever' or not set, effects never wear off.
** if 'turn', effects only last until the start of the unit's next turn (when the unit refreshes movement and attacks). (Like other start-of-turn behavior, objects with a duration of "turn" won't expire before turn 2.)
** {{DevFeature1.13|1}} if 'turn end' or 'turn_end', effects only last until the end of the unit's next turn (exactly like the slowed status).
* '''[filter]''' with a [[StandardUnitFilter]] as argument. The first unit found that matches the filter will be given the object. Only on-map units are considered. If no unit matches or no [filter] is supplied, it is tried to apply the object to the unit at the $x1,$y1 location of the event where this [object] is in. The case of no unit being at that spot is handled in the same way as no unit matching a given filter ([else] commands executed, cannot_use_message displayed). Note that units on the recall list will not be checked. To add an [object] to a unit on the recall list you have to use '''[modify_unit][object]'''.
* '''[then]''': a subtag that lets you execute actions if the filter conditions are met. The most common action that should be inside here is a '''[remove_item]''' tag, but you could probably put any tags that otherwise work in a [then] tag.
* '''[else]''': a subtag that lets you execute actions if the filter conditions are *not* met.
* '''silent''': whether or not messages should be suppressed. Default is "no". {{DevFeature1.13|2}} If no description is provided, this defaults to yes, but can still be overridden.
* '''image''': the displayed image of the object.
* '''name''': (translatable) displayed as a caption of the image.

* '''description''': (translatable) displayed as a message of the image.
* '''cannot_use_message''': (translatable) displayed instead of '''description''' if no unit passes the filter test.

=== [remove_object] ===

{{DevFeature1.13|6}}

Removes an object from matching units.

* [[StandardUnitFilter]]: All units matching the filter have matching objects removed. Use no [filter] tag.
* '''object_id''': The id of the object to be removed.

Note that some unit properties are not restored ideally, e.g. current unit's health reversion might not work as expected (max_hitpoints will though). {{DevFeature1.15|0}} This was fixed.

Note that remove_object worked the following way: Step1) remove thos objects from the unit wml, Step2) Rebuild the unit to make the changes effective. Step2 implies that changes done for example via [modify_unit] (or via the [store_unit] + [set_variable] + [unstore_unit] technique) will be reset if those changes change a property that is a property of the unit type. See the note under [modify_unit] to get a list of properties that can safely be changes via [modify_unit]

=== [remove_shroud] ===
Removes some shroud from the map for a certain side (only relevant for sides that have shroud=yes).
* '''side''': (default=1) the side for which to remove shroud. This can be a comma-separated list of sides. note: Default side=1 for empty side= is deprecated.
* '''[filter_side]''' with a [[StandardSideFilter]] as argument
* [[StandardLocationFilter]]: the range of tiles for which shroud should be removed

=== [place_shroud] ===
Places some shroud on the map for a certain side (only relevant for sides that have shroud=yes).
* '''side''': (default=1) the side for which to place shroud. This can be a comma-separated list. note: Default side=1 for empty side= is deprecated.
* '''[filter_side]''' with a [[StandardSideFilter]] as argument
* [[StandardLocationFilter]]: the range of tiles on which shroud should be placed

=== [lift_fog] ===
Lifts the fog of war from parts of the map for a certain side (only relevant for sides that have fog=yes), allowing a player to witness what occurs there even if that player has no units within vision range.
* '''[filter_side]''' with a [[StandardSideFilter]] indicating which sides should be affected.
* [[StandardLocationFilter]]: the tiles from which fog should be lifted.
* '''multiturn''': ''yes/no, default:no''. The default (not multiturn) causes fog to be removed in the same way that normal vision works; the cleared tiles will remain cleared until fog is recalculated (which normally happens when a side ends its turn). When multiturn is set to "yes", the cleared tiles remain clear until {{tag||reset_fog}} cancels the clearing. This allows tiles to remain clear for multiple turns, or to be refogged before the end of the current turn (without also refogging all tiles). Multiturn lifted fog is not shared with allies (even when share_vision=all).

=== [reset_fog] ===
The primary use of this tag is to remove multiturn lifted fog (created by {{tag||lift_fog}}), which causes the fog to reset to what it would have been had WML not interfered. (That is, hexes that a side's units could not see at any point this turn will be re-fogged, while seen hexes remain defogged.)
* '''[filter_side]''' with a [[StandardSideFilter]] indicating which sides should be affected.
* [[StandardLocationFilter]]: the fog reset will be restricted to these tiles.
* '''reset_view''': ''yes/no, default: no'' If set to "yes", then in addition to removing multiturn fog, the side's current view is canceled (independent of the SLF). This means that all hexes will become fogged for the side unless multiturn fog exists outside the tiles selected by the SLF. Normally, one would want the currently seen hexes to become clear of fog; this is done automatically at the end of many events, and it can be done manually with {{tag|InterfaceActionsWML|redraw}}.
Omitting both the SSF and the SLF would cancel all earlier uses of [lift_fog].
Additionally setting reset_view="yes" would cause the side's entire map to be fogged (unless an ally keeps hexes clear by sharing its view).

=== [allow_undo] ===
Normally when an event with a handler fires, the player's undo stack is cleared, preventing all actions performed so far from being undone. Including this tag in the event handler prevents the stack from being cleared for this reason, allowing the player to undo actions. (However, the stack might still be cleared for other reasons, such as fog being cleared or combat occurring.) In the common cases, this means '''[allow_undo]''' allows the current action to be undone even though an event was handled. There is a less common case, though — specifically when handling a menu item, where there is no current action — and in this case, '''[allow_undo]''' means merely that earlier actions can still be undone.
* Using this tag in a menu item has an additional side effect in 1.11. Starting with version 1.11.1, executing a WML menu item normally counts as doing something as far as the "you have not started your turn yet" dialog is concerned. However, a menu item whose handler includes '''[allow_undo]''' will not count.

The types of actions that can be undone are movement, recalling, and dismissing a unit from the recall list. If an action is undone, only the position (or existence) of the involved unit will be restored; any altered variables or changes to the game will remain changed after the action is undone. It is up to the scenario designer to avoid abusing this command.
* Technically, if '''[allow_undo]''' is inside an '''[event]''' with ''first_time_only=yes'' (the default setting), and the user undoes the event, then the state of the game has changed in this way: the event will not fire a second time, even though the user undid the action the first time.
* Although recalling can be undone, recruitment can not be undone; this seems to apply even when the recruit's traits are not randomly-generated (tested on 1.12.6 and 1.14.4+dev).

If an '''[event]''' uses both '''[allow_undo]''' and [[InternalActionsWML#.5Bfire_event.5D|'''[fire_event]''']] then the '''[allow_undo]''' must be after the '''[fire_event]'''.

Due to a bug in 1.12 (https://gna.org/bugs/?23323) '''[allow_undo]''' should not be used in events that use one of the following things because it might cause OOS:
* [message] with [option]s
* [get_global_variable]
* wesnoth.synchronize_choice

While in 1.13 using '''[allow_undo]''' together with those things won't give you a guaranteed OOS, there are some non-obvious situations where it will, for example assume the following event:

[event]
name="moveto"
[message]
message = "message"
[option]
label = "option 1"
[command]
[/command]
[/option]
[option]
label = "option 2"
[command]
[/command]
[/option]
[/message]
[allow_undo]
[/allow_undo]
[/event]

It will cause OOS when the message is undone: since the event is already executed (erased) on one client only , the clients will disagree about how many choices happen during the next moveto action.

=== [on_undo] ===
{{DevFeature1.13|2}}
Contains commands to execute when the player undoes the action which triggered the parent event.
*'''delayed_variable_substitution''' {{DevFeature1.13|5}}: ''yes/no, default no (always no before 1.13.5)'' As in [[EventWML]], specifies whether to perform variable substitution when the parent event is run, or when the contents are run. If delayed substitution is used, [[SyntaxWML#Automatically_Stored_Variables|automatically stored variables]] from the parent event context are available, but may occasionally have unexpected values. (In particular, $unit.x and $unit.y may not have the expected value when undoing a move event, though $x1 and $y1 should be correct.)

Note:
It is not clear where whether the actionwml in [on_undo] in executed before or after the action is undone. Also, specially for enter/leave_hex events the units position when executing the [on_undo] code is usually different than when executing the original event. The recommended way to work around these issues is to refer to the unit by id instead of position and store all other needed information variables as 'upvalues'. You can also move the actual undo code to an external event. For example
[event]
name="undo_blah"
first_time_only=no
[store_unit]
id="$moved_unit_id"
[/store_unit]
... do undo stuff stuff
[/event]

...
... in some other event
[on_undo]
# store ''upvalues
{VARIABLE moved_unit_id $unit.id}
# call actual undo handler
[fire_event]
name = "undo_blah"
[/fire_event]
[on_undo]

=== [on_redo] ===
{{DevFeature1.13|2}}
Same as [on_undo], except executes the commands on redo. Note that the parent event is not triggered again on a redo.

{{DevFeature1.13|8}} [on_redo] is deprecated and has no effect anymore.

Note that [on_redo] is not guaranteed to be called when redoing an action, the engine might also decide to just fire the original events again.

=== [cancel_action] ===
Although Wesnoth 1.12 does not have this tag, it is the default behavior of {{tag|EventWML|enter_hex}}/{{tag|EventWML|leave_hex}} events in that version.

{{DevFeature1.13|9}} In this version, [cancel_action] is recognised, but has no effect (a bug).

{{DevFeature1.13|11}}
In an {{tag|EventWML|enter_hex}}/{{tag|EventWML|leave_hex}} event, interrupt the movement, leaving the unit where it is. This is intended to be used with an event that gives the player new information, to let the player choose whether to change their plans. For example, if the player has commanded a unit to move from (1,1) to (3,3) and attack a unit on (4,4); then a [cancel_action] inside an [enter_hex] event on (2,2) would make the unit stop on (2,2). A [cancel_action] inside an [enter_hex] on (3,3) would let the player choose whether to attack.

=== [heal_unit] ===
Heal a unit. The variable '''$heal_amount''' will be set to the exact number of points healed (i.e can be less than the parameter '''amount''' if the unit is fully healed). $heal_amount contains only the number of hitpoints the first unit that was found got healed. When the variable is not needed, use {CLEAR_VARIABLE heal_amount} after this tag.
* '''[filter]''': [[StandardUnitFilter]] All matching on-map units are healed. If no filter is supplied, it is tried to take the unit at $x1, $y1.
* '''[filter_second]''': [[StandardUnitFilter]] all the units matching the filter ''and'' having the ''heals'' ability will have their animation played (if ''animate'' is set to yes) for each of the units healed.
* '''amount''': (integer, default full) the maximum points the unit(s) will be healed. This can't be used to set the unit's hitpoints below 1 or above the unit's maximum hitpoints. If "full", it fully heals the unit.
* '''animate''': a boolean which indicate if the healing animations must be played. (default no)
* '''moves''': (integer, default 0) The maximum current movement points the units will be "healed". Can't set below 0 or above max_moves. If "full", sets moves to max_moves.
* '''restore_attacks''': (boolean, default no) Whether the units' attacks_left should be reset to their max_attacks (usually 1).
* '''restore_statuses''': (boolean, default yes) Whether standard statuses should be reset to "no". This affects poisoned, slowed, petrified and unhealable.

=== [harm_unit] ===
Harms every unit matching the filter, for the specific damage amount.
* '''[filter]''': [[StandardUnitFilter]] all matching units will be harmed (required).
* '''[filter_second]''': [[StandardUnitFilter]] if present, the first matching unit will attack all the units matching the filter above.
* '''amount''': the amount of damage that will be done (required).
* '''alignment''': (default neutral) applies an alignment to the damage, this means that if alignment=chaotic, the damage will be increased at night and reduced at day.
* '''damage_type''': if present, amount will be altered by unit resistance to the damage type specified.
* '''kill''': (default yes) if yes, when a harmed unit goes to or below 0 HP, it is killed; if no its HP are set to 1.
* '''fire_event''': (default no) if yes, when a unit is killed by harming, the corresponding events are fired. If yes, also the corresponding advance and post advance events are fired.
* '''animate''': (default no) if yes, scrolls to each unit before harming it and plays its defense (or attack, if it's the harmer) and death animations. Special values supported, other than the usual yes and no, are "attacker", that means only the harmer will be animated, and "defender", that means only the harmed units will be animated. If the supplied value is yes, attacker or defender also advancement animations are played.
* '''[primary_attack], [secondary_attack]''': these set the weapon against which the harmed units will defend, and that the harming unit will use to attack, respectively (notice this is the opposite of '''[filter]''' and '''[filter_second]''' above). This allows for playing specific defense and attack animations. Both tags are expected to contain a [[FilterWML#Filtering_Weapons|Standard Weapon Filter]].
* '''delay''': if animate=yes, sets the delay (in milliseconds, default 500) between each unit harming.
* '''variable''': if present, the damage caused to the unit, altered by resistances, will be stored in a WML array with the given name, under the "harm_amount" key.
* '''poisoned, slowed, petrified, unhealable''': (default no) if yes, every harmed unit that doesn't already have such status will have it set.
* '''experience''': if yes, and there is a harmer, experience will be attributed like in regular combat.
* '''resistance_multiplier''': the harmed unit's resistance is multiplied by the supplied value; this means that a value lower than 1 increases it, and a value greater than 1 decreases it. Default value is 1, that means no modification.

=== [time_area] ===
How a day should progress in a given area. Everywhere not specified in a [time_area] tag is affected by the [time] tags in the [scenario] tag.
* [[StandardLocationFilter]]: the locations to affect. ''note: only for [event][time_area]s - at scenario toplevel [time_area] does not support [[StandardLocationFilter]], only location ranges''
* '''[time]''': one or more tags describing the new schedule, see [[TimeWML]].
* '''id''': an unique identifier assigned to a time_area. Optional, unless you want to remove the time_area later or reference it from a location filter elsewhere. Can be a comma-separated list when removing time_areas, see below.
* '''remove''': (boolean) yes/no value. Indicates whether the specified time_area should be removed. Requires an identifier. If no identifier is used, however, all time_areas are removed.
* '''current_time''': The time slot number (starting with zero) active at the creation of the area.

''Example:'' (caves in parts of a map)
<syntaxhighlight lang=wml>
[time_area]
id = cave_area
x = 1-2,4-5
y = 1-2,1-2
{UNDERGROUND}
[/time_area]
</syntaxhighlight>

Specifying an id allows the area to be referenced from location filters. Example:
<syntaxhighlight lang=wml>
[time_area]
id = glyphs
x = 9,14
y = 11,3
[/time_area]
[event]
name = moveto
first_time_only=no
[filter]
side = 1
[filter_location]
area = glyphs
[/filter_location]
[/filter]
# Do something, for example healing the unit
[/event]
</syntaxhighlight>

=== [remove_time_area] ===

{{DevFeature1.13|2}}

This is a syntactic shortcut for [time_area] remove=.
* '''id''': Comma-separated list of time area ids to remove.

=== [end_turn] ===
End the current side's turn. The current event is finished before the turn is ended. Also, if the current event (where the tag appears) has been fired by another event, that event (and the complete stack of other possible parent events) is ended before [end_turn] comes into affect. Also, events following the event stack that fired [end_turn] are not omitted (e.g. [end_turn] is used by a side turn event and a turn refresh event does something afterwards).

=== [replace_map] ===

Replaces the entire map.
* '''map''': Content of a wesnoth map file. Example:
map="{campaigns/Heir_To_The_Throne/maps/01_The_Elves_Besieged.map}"
* '''map_file''': {{DevFeature1.13|?}} Path to a Wesnoth map file; can be used instead of '''map'''. The file will be loaded when the tag is executed, rather than being embedded wholesale in the preprocessed WML. Example:
map_file=campaigns/Heir_To_The_Throne/maps/01_The_Elves_Besieged.map
{{DevFeature1.15|3}} If the file is not found directly, it will be searched for in the [[BinaryPathWML|[binary_path]]]. Assuming a standard campaign or add-on layout, the example above can be replaced by:
map_file=01_The_Elves_Besieged.map
* '''expand''': if 'yes', allows the map size to increase. The expansion direction is currently always bottom-right.
* '''shrink''': if 'yes', allows the map size to decrease. If the map size is reduced, any units that would no longer be on the map due to its coordinates no longer existing will be put into the recall list.
Note: When a hex changes from a village terrain to a non-village terrain, and a team owned that village it loses that village. When a hex changes from a non-village terrain to a village terrain and there is a unit on that hex it does not automatically capture the village. The reason for not capturing villages it that there are too many choices to make; should a unit lose its movement points, should capture events be fired. It is easier to do this as wanted by the author in WML.

=== [replace_schedule] ===
Replace the time of day schedule of the entire scenario.
* [[TimeWML]]: the new schedule.
* '''current_time''': The time slot number (starting with zero) active at schedule replacement.

=== [tunnel] ===

Create a tunnel between some locations, later usable by units to move from source hex to target hex (using the movement cost of unit on the target terrain).

'''Behavior Change as of Wesnoth 1.13.6:''' Vision is now possible (and enabled by default) through tunnels and allied units on the exit hex do not block a tunnel by default any more. This is done in order for moves through tunnels to be consistent with other moves. The previous behavior can still be accomplished by using the new optional keys listed below.

* '''[filter]''': (required) [[StandardUnitFilter]] the units which can use the tunnel. Leave empty for "all units".
* '''[source]''': (required) [[StandardLocationFilter]] the source hex(es).
* '''[target]''': (required) [[StandardLocationFilter]] the target hex(es).
* '''id''': (optional) identifier for the tunnel, to allow removing.
* '''remove''': (boolean, default: no) If yes, removes all defined tunnels with the same ID (then only id= is necessary).
* '''bidirectional''': (boolean, default: yes) If yes, creates also a tunnel in the other direction.
* '''always_visible''': (boolean, default: no) If yes, the possible movement of enemies under fog can be seen.
* '''allow_vision''': (boolean, default: yes) {{DevFeature1.13|6}} If no, vision through a tunnel is not possible. Note that in that case the tunnel cannot be used if the tunnel exit is under shroud (which previously was ''always'' the case).
* '''pass_allied_units''': (boolean, default: yes) {{DevFeature1.13|6}} If no, allied (including own) units on the exit hex block a tunnel.
* '''delayed_variable_substitution''' (boolean, default: yes): If yes, the WML block contained in this [tunnel] is not variable-substituted at execution time of the event where this [tunnel] is within. Instead, variables are substituted when the tunnel is used by a unit. See [[EventWML#Nested_Events]]

(Note: The tunnel tag can also be used inside the [[AbilitiesWML|[teleport]]] ability, without remove= and id=).

=== [do_command] ===

{{DevFeature1.13|0}}

Executes a command, specified using the same syntax as a [command] tag in [[ReplayWML]]. Not all [command]'s are valid: only these are accepted

* [attack]
* [move]
* [recruit]
* [recall]
* [disband]
* [fire_event]
* [lua_ai] {{DevFeature1.13|12}} This has been removed and is replaced with [custom_command]

The tags corresponding to player actions generally use the same codepath as if a player had ordered it. That means for example that only moves that player would be allowed to do are possible, and movement is interrupted when sighting enemy unit.

One purpose of this tag is to allow scripting of noninteractive scenarios -- without a tag like this, this might require elaborate mechanisms to coerce ais in order to test these code paths.

This command should be replay safe if it is either invoked in a synced context, ''or'' invoked in code that is never synced, like AI code, a select event, or a menu item with `synced = false`. However, if you use desynchronized logic ''during'' an event that is otherwise synced, invoking [do_command] based on that desynchronized logic will result in out-of-sync errors during the replay; in this case, you must explicitly synchronize which command to do using something like the lua function wesnoth.sync.evaluate_single.

=== [put_to_recall_list] ===

{{DevFeature1.13|0}}

Puts a unit to the recall list of its side.
* '''[[StandardUnitFilter]]''': the unit(s) to get put to the recall list.
* '''heal''': (default=no) Whether the unit should be refreshed, similar to the unit moving to the recall list at the end of a scenario.

== Useful Macros ==
There are some predefined macros that you find useful for direct actions. You can find a complete list along with a detailed explanation of how they work [https://www.wesnoth.org/macro-reference.html here].
* '''{MOVE_UNIT}''': Moves a unit to another location in the map and the player sees the movement (unlike [teleport])
* '''{FULL_HEAL}''': Brings a unit to full HP
* '''{LOYAL_UNIT}''': Create a loyal unit
* '''{MODIFY_TERRAIN_MASK}''': Modify an area of terrain

== See Also ==

* [[InternalActionsWML]]
* [[InterfaceActionsWML]]
* [[EventWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]
[[Category: ActionsWML]]

CampaignWML

2021-08-24T08:11:18Z

Shadowm: Update links to macro-reference.html

{{WML Tags}}



This page describes how the campaign is displayed in the "Campaign" menu, and how it starts.

==The [campaign] Tag==

The following keys and tags are recognized in '''[campaign]''' tags:
* '''id''': the internal campaign identifier used to classify saved games
* '''icon''': the image displayed in the campaign selection menu
* '''name''': (translatable) name displayed in the campaign selection menu
* '''abbrev''': (translatable) abbreviation used as a prefix for savefile names made from this campaign
* '''image''': the image shown in the information pane when this campaign is selected in the campaign selection menu (typically a transparent, 350×350 pixels portrait)
* '''background''': {{DevFeature1.15|9}} the image used as a backdrop for the Campaigns menu (typically a high resolution image intended for displaying fullscreen in story screens). If blank or unspecified, a stock story background from core is used.
* '''description''': (translatable) text shown in the information pane when this campaign is selected in the campaign selection menu
* '''description_alignment''': {{DevFeature1.13|3}} The text alignment of the description. Choose between "left" (default), "center", or "right".
* '''type''': campaign's type to specify if it should be visible in singleplayer, multiplayer or both. Possible values are "sp", "mp" and "hybrid". Defaults to "sp".
* '''define'''='''''CAMPAIGN_SYMBOL''''' when this campaign is started, the preprocessor symbol '''''CAMPAIGN_SYMBOL''''' will be defined. See '''#ifdef''' in [[PreprocessorRef]] for how this can be used to isolate parts of the campaign file from other campaigns. Only the tags '''[campaign]''' and '''[binary_path]''' (see [[BinaryPathWML]]) should go outside of '''#ifdef ''CAMPAIGN_SYMBOL'''''. This symbol will be defined ''before'' any .cfg is preprocessed. Important note: starting with 1.7.13, [binary_path] does no longer need to be outside of the '''#ifdef ''CAMPAIGN_SYMBOL''''' block to make custom binary data available, which could easily cause overwrites. E.g. icon=data/add-ons/whatever/something.png is supposed to work. This seems to have been a bug since at least BfW 1.0 which means that practically all available examples of user made add-ons are wrong in this aspect.
* '''extra_defines''': a comma(''',''') separated list of preprocessor symbols. Those symbols will be defined ''before'' any .cfg is preprocessed. Currently supported extra_defines are:
<ul>
;ENABLE_ARMAGEDDON_DRAKE
:allows the advancement ''Inferno Drake'' -> ''Armageddon Drake''
;ENABLE_DWARVISH_ARCANISTER
:allows the advancement ''Dwarvish Runemaster'' -> ''Dwarvish Arcanister''
;ENABLE_DWARVISH_RUNESMITH
:allows the advancement ''Dwarvish Fighter'' -> ''Dwarvish Runesmith''
;DISABLE_GRAND_MARSHAL
:disallows the advancement ''General'' -> ''Grand Marshal''
;ENABLE_ANCIENT_LICH
:allows the advancement ''Lich'' -> ''Ancient Lich''
;ENABLE_DEATH_KNIGHT
:allows the advancement ''Revenant'' -> ''Death Knight'
;ENABLE_TROLL_SHAMAN
:allows the advancement ''Troll Whelp'' -> ''Troll Shaman''
;ENABLE_WOLF_ADVANCEMENT
:allows the advancements ''Wolf'' -> ''Great Wolf'' -> ''Direwolf''
;ENABLE_NIGHTBLADE {{DevFeature1.13|0}}
:allows the advancement ''Orcish Slayer'' -> ''Orcish Nightblade''
;ENABLE_PARAGON {{DevFeature1.15|1}}
:allows the advancement ''Dune Blademaster'' -> ''Dune Paragon''
;ENABLE_WOSE_SHAMAN {{DevFeature1.15|1}}
:allows the advancement ''Wose'' -> ''Wose Shaman''
</ul>
* '''difficulties''': a comma(''',''') separated list of preprocessor symbols, exactly one of which will be stored depending on the difficulty setting chosen when the campaign is started. The symbols '''EASY''', '''NORMAL''', and '''HARD''' are usually used, and there are several macros in utils.cfg (see [https://www.wesnoth.org/macro-reference.html#file:utils.cfg| Macro Reference]) which check for these values to set WML keys to different values depending on difficulty. If you use different difficulty symbols, you may need to define your own versions of these macros. {{DevFeature1.13|2}} This key has been deprecated in favor of [difficulty] define=.
* '''difficulty_descriptions''': the menu of difficulties; this is a list of descriptions (see [[DescriptionWML]]) that correspond to different difficulty levels. Since each description is a menu option for a difficulty level, this must provide the same number of descriptions as there are levels in the ''difficulties'' list. {{DevFeature1.13|2}} This key has been deprecated in favor of [difficulty] define=
* '''[difficulty]''': {{DevFeature1.13|2}} specifies a single campaign difficulty. The following keys are accepted:
** '''define''': the preprocessor symbol defined when this difficulty is selected. Uses the same format as an entry in the old ''difficulties'' list.
** '''image''': the image to display for this difficulty in the selection menu
** '''label''': a flavor label describing this difficulty. Displayed second after the image
** '''description''': a description of the difficulty, usually along the lines of "Beginner" or "Challenging". Displayed third after the image.
** '''default''': whether this is the difficulty which will be selected by default when the difficulty selection menu is displayed.
** '''auto_markup''': {{DevFeature1.15|0}} By default, the description is shown in small, gray text within parentheses. Setting '''auto_markup=no''' disables these, so no markup will be applied implicitly. Any markup in '''description''' will be honored regardless of this setting.
* '''allow_difficulty_change''': Allows difficulty switching during an ongoing campaign. Default:yes
* '''first_scenario''': the ID of the first scenario in the campaign; see ''id'' in [[ScenarioWML]]
* '''[options]''': {{DevFeature1.13|1}} Allows configuration options to be displayed to the user, see [[OptionWML]]
* '''rank''': a number that determines the order of campaigns in the campaign selection menu. Lower ''rank'' campaigns appear earlier, with unranked campaigns at the end. Currently the mainline campaigns use multiples of 10 from 0 to 399, with 0-99 for Novice campaigns, 100-199 for Intermediate campaigns, and 200-399 for Expert campaigns; if you specify this, it should not be less than 400. (Note: This replaces an older convention that topped out at 50.) {{DevFeature1.14|6}} a number that determines the order of campaigns in the campaign selection menu. Lower rank campaigns appear earlier, with unranked campaigns at the end. Currently the mainline campaigns use multiples of 5 from 0 to 249, with 0-49 for Rookie campaigns, 50-99 for Novice campaigns, 100-149 for Intermediate campaigns, 150-199 for Hard campaigns, and 200-249 for Expert campaigns; if you specify this, it should not be less than 300.
* '''start_year''': a string that determines the order of campaigns when the campaign selection menu is sorted by date. The date needs a year number and an epoch, for example '''20 BW''', '''20 YW''', '''20 BF''' or '''20 AF'''. In Wesnoth 1.14, this is the only place in which this date-parsing is used.
* '''end_year''': a string that helps determine the order of campaigns when two campaigns have the same '''start_year'''. Ignored if '''start_year''' is not set.
* '''year''': shortcut for specifying both '''start_year''' and '''end_year''', for campaigns that happen inside a single calendar year. Ignored if '''start_year''' is given.
* '''[about]''': inserts your own credits into the game's list of credits. See [[CreditsWML]] for syntax.
* '''end_credits''': Whether to display the credits screen at the end of the campaign. Defaults to ''yes''.
* '''end_text''': (translatable) Text that is shown centered in a black screen at the end of a campaign. Defaults to "The End".
* '''end_text_duration''': Delay, in milliseconds, before displaying the game credits at the end of a campaign. In other words, for how much time '''end_text''' is displayed on screen. Defaults to 3500. {{DevFeature1.15|6}} This value is capped at 5000 (5 seconds).
* '''[event]''': {{DevFeature1.13|2}} events placed here will be automatically inserted into all scenarios of the campaign.

The following keys are additionally recognized in multiplayer:
* '''min_players''': Minimum number of players which the campaign supports. This only serves to inform users when choosing a campaign. Defaults to 2.
* '''max_players''': Maximum number of players which the campaign supports. This only serves to inform users when choosing a campaign. Defaults to either '''min_players''' or 2, whichever is higher.
* '''allow_era_choice''': Whether to allow era selection (when set to ''yes'') or hide it and use a default one when creating a game (when set to ''no''). Defaults to ''yes''.
* '''require_campaign''': Whether clients are required to have this campaign installed beforehand to be allowed join a game using this campaign. Possible values 'yes' (the default) and 'no'.

== See Also ==

* [[PreprocessorRef]]
* [[ScenarioWML]]
* [[ReferenceWML]]
* [[PblWML]]

[[Category: WML Reference]]

Wml optimisation

2021-08-24T08:10:02Z

Shadowm: Update links to macro-reference.html, other links too

==The basics==
The first thing you need to know: '''If you have no problems with performance, then don't bother'''.
Any optimisation is supposed to help you in following situations:
* The game freezes for several seconds after each user action
* Your scenario loading time is longer than several minutes
* Your add-on codebase is larger than 5 megabytes

===What you should know next===
*[[PreprocessorRef#Preprocessor_directives|Macros]]
*[[EventWML]]
*[[EventWML#Custom_events|Custom events]]
*[[ConditionalActionsWML#.5Bwhile.5D|While loops]]

===How do I optimise my code?===

So, you've written your campaign, scenario or era and it works. Congratulations, but your work is far from over! If your campaign or scenario is big enough, you'll often notice that it runs very slowly, and you need to do something about it. Or maybe you have a powerful computer and you'd like to make sure that other, weaker machines won't have troubles with running your content. Or perhaps, you just want to learn how to write code that not only works, but is also efficient.

The first thing to know, since apparently it's not stressed enough, macros '''do not''' improve performance! Macros only make your code more readable and easier to maintain. Try to refrain from using big macros, and more importantly, avoid using macros inside macros (inside macros, inside macros... yes, I've seen it happen, and yes I've tried doing it myself when I was new to wml). Under the covers, WML macros are replaced by the code they represent, and if there are macros inside macros (especially big ones), lines of code multiply horribly fast.

What's a better way to write code that appears often? ''Custom events''' and ''while loops''! By defining a '''custom event''', and firing it when needed, you'll save a lot of code lines, make your code nicer to read and much more efficient. Same goes for the '''while loop''': instead of copy/pasting your code, try to use a loop, whenever you can. Let's take a look at this example problem: whenever side 1 unit enters a village, you want to place 5 walking corpses around this village. Let's say there are 6 villages in question with coordinates (1,1), (2,2), (3,3), (4,4), (5,5), (6,6).

====Inefficient example====

#NOTE: remember, this should work alright, but it is not efficient! Imagine if you have much more villages in mind, or you want to spawn more zombies

#define SPAWN_ZOMBIES X Y SIDE
[unit]
side={SIDE}
type=Walking Corpse
x,y={X},{Y}
placement=map_passable
[unit]
[unit]
side={SIDE}
type=Walking Corpse
x,y={X},{Y}
placement=map_passable
[unit]
[unit]
side={SIDE}
type=Walking Corpse
x,y={X},{Y}
placement=map_passable
[unit]
[unit]
side={SIDE}
type=Walking Corpse
x,y={X},{Y}
placement=map_passable
[unit]
[unit]
side={SIDE}
type=Walking Corpse
x,y={X},{Y}
placement=map_passable
[unit]
#enddef

[event]
name=moveto
[filter]
side=1
x,y=1,1
[or]
x,y=2,2
[/or]
[or]
x,y=3,3
[/or]
[or]
x,y=4,4
[/or]
[or]
x,y=5,5
[/or]
[or]
x,y=6,6
[/or]
[/filter]

{SPAWN_ZOMBIES $unit.x $unit.y 2}
[/event]

Looks pretty innocent, right? But imagine that there are more villages. Or better yet, imagine you want to increase the amount of zombies, you'll have to copy/paste even more, and it's easy to make a mistake while doing it.

====More efficient example====

#first, let's define our custom event:
[event]
name=spawn_zombies
first_time_only=no
#it's easy to forget, but you have to set first_time_only in custom events too
{VARIABLE i 0}
[while]
[variable]
name=i
less_than_equal_to=5
#repeating the loop 5 times for 5 zombies, note how easy it is now to change the amount of zombies you want to spawn!
[/variable]
[do]
[unit]
side=2
type=Walking Corpse
x,y=$unit.x,$unit.y
#unit variable is passed to this event from the parent event.
placement=map_passable
[unit]
{VARIABLE_OP i add 1}
[/do]
[/while]
{CLEAR_VARIABLE i}
[/event]

[event]
name=moveto
[filter]
side=1
x,y=1,1
[or]
x,y=2,2
[/or]
[or]
x,y=3,3
[/or]
[or]
x,y=4,4
[/or]
[or]
x,y=5,5
[/or]
[or]
x,y=6,6
[/or]
[/filter]

[fire_event]
name=spawn_zombies
[/fire_event]
[/event]

===Fired events vs macros===

But if ''fire events'' are so cool and efficient, what is the advantage of using ''macros''? Good question. As you can see, custom events have one issue: ''it's harder to set dynamic variables in fired events''. When defining macros, you specify arguments and those arguments are declared ''whenever we're using that macro'' and can be changed in any way you, and more importantly, someone else wants. Remember, that you might want to start a bigger project and invite someone to help you with the code. '''Macros are obvious and transparent in usage''' - when reading a macro definition you always know what is the changing variable and what is a constant. In custom events, it is not so obvious.

Let's take a look at one of the default macros included with wesnoth:

#define ABILITY_REGENERATES
# Canned definition of the Regenerate ability to be included in an [abilities]
# clause.
[regenerate]
value=8
id=regenerates
name= _ "regenerates"
female_name= _ "female^regenerates"
description= _ "Regenerates:
The unit will heal itself 8 HP per turn. If it is poisoned, it will remove the poison instead of healing."
affect_self=yes
poison=cured
[/regenerate]
#enddef

This is a good macro, because replacing it by a custom event would be complicated and messy and it wouldn't save a lot of code, anyway. Another example is

#define GENERIC_UNIT SIDE TYPE X Y
# Creates a generic unit of TYPE belonging to SIDE at X,Y, which has a
# random name, gender and traits (just like a recruited unit).
[unit]
side={SIDE}
type={TYPE}
x={X}
y={Y}
generate_name=yes
random_traits=yes
random_gender=yes
upkeep=full
[/unit]
#enddef

This time, making a custom event would be fairly easy, but it would be much less transparent in usage. The code {GENERIC_UNIT 1 Spearman 12 3} is self-explanatory, simple and versatile.

==Macros that are included in multiple scenarios==
If you have a macro that's included in every scenario of a campaign, in every map of a map-pack, or in multiple units of an era, then the macro will be expanded multiple times. If macro is an '''[event]''' and the expanded version is huge (for example, if it uses nested macros), then using the '''[[ModificationWML#The_.5Bresource.5D_toplevel_tag|[resource]]]''' tag can reduce it to a single copy.

This can be an easy and quick optimisation, as the old macro can be replaced with one that just contains the '''[load_resource]''' tag.

==Do not treat macroses as functions==
Main advantage of macroses is that they allow you to reuse your code with less effort. But you need to take into account how ''exactly'' they are used by Wesnoth. Look at the example

#define CREATE_REINFORCMENT SIDE
{VARIABLE temp_side {SIDE}}
[variable]
name = temp_side
value = 1
[/variable]
[if]
{VARIABLE_CONDITIONAL temp_side equals 1}
[then]
{GENERIC_UNIT 1 "Walking Corpse" 12 3}
[/then]
[/if]
[if]
{VARIABLE_CONDITIONAL temp_side equals 2}
[then]
{GENERIC_UNIT 2 "Spearman" 3 16}
[/then]
[/if]
{CLEAR_VARIABLE temp_side}
#enddef
[event]
name=turn 10
{CREATE_REINFORCMENT 1}
{CREATE_REINFORCMENT 2}
[/event]

In this example I wanted to create additional units for each side at turn 10. Side 1 is undeads and side 2 is loyalists. Everything looks good, but there is a mistake. When Wesnoth loads scenario, all macroses are substituted with their meaning. This example becomes:

[event]
name="turn 10"
[set_variable]
name="temp_side"
value=1
[/set_variable]
[if]
[variable]
equals=1
name="temp_side"
[/variable]
[then]
[unit]
generate_name=yes
random_gender=yes
random_traits=yes
side=1
type="Walking Corpse"
upkeep="full"
x=12
y=3
[/unit]
[/then]
[/if]
[if]
[variable]
equals=2
name="temp_side"
[/variable]
[then]
# PART 1 BEGINS
[unit]
generate_name=yes
random_gender=yes
random_traits=yes
side=2
type="Spearman"
upkeep="full"
x=3
y=16
[/unit]
# PART 1 ENDS
[/then]
[/if]
[clear_variable]
name="temp_side"
[/clear_variable]
[set_variable]
name="temp_side"
value=2
[/set_variable]
[if]
[variable]
equals=1
name="temp_side"
[/variable]
[then]
# PART 2 BEGINS
[unit]
generate_name=yes
random_gender=yes
random_traits=yes
side=1
type="Walking Corpse"
upkeep="full"
x=12
y=3
[/unit]
# PART 2 ENDS
[/then]
[/if]
[if]
[variable]
equals=2
name="temp_side"
[/variable]
[then]
[unit]
generate_name=yes
random_gender=yes
random_traits=yes
side=2
type="Spearman"
upkeep="full"
x=3
y=16
[/unit]
[/then]
[/if]
[clear_variable]
name="temp_side"
[/clear_variable]
[/event]

Obviously part 1 and part 2 will never happen. It makes conditional check useless while you code becomes more complex. This is very common mistake even in advanced scenarios and add-ons. To avoid this problem, you need to follow the rule: '''Do not make conditional actions based on values of arguments'''. If you need to do this, then you need to think over situation again. In our example it might be:

[event]
name=turn 10
{GENERIC_UNIT 1 "Walking Corpse" 12 3}
{GENERIC_UNIT 2 "Spearman" 3 16}
[/event]

==Analogies to "real" programming==

Now that you know how to use macros and custom events to optimise your code, let's take a moment to think how you could use your knowledge outside Wesnoth. You've probably heard about c++, python, lua or any other programming language. Just like them, WML has some common features but under slightly different names. For example, instead of making custom ''events'', you're making custom ''functions'' and ''procedures'' that can be used further in your code in a very similar way. That's why understanding optimisation is so important - it'll help you understand real programming problems, and develop good habits!

==Further reading==

*[[Advanced_Optimisations_and_Hacks|More complex optimisations]] - read this only if you believe you know everything!
*[https://www.wesnoth.org/macro-reference.html Macro reference]
*[[LuaWML]]
*[[ConventionsWML]]

[[Category:WML_Tips]]

IntroWML

2021-08-24T08:08:57Z

Shadowm: Update links to macro-reference.html

{{WML Tags}}
== IntroWML ==

The '''[story]''' tag is a series of images and text to display as the first part of the intro screen. It can appear in [[ScenarioWML]] or {{DevFeature1.13|8}} as [[InterfaceActionsWML#.5Bstory.5D|ActionWML]].

The '''[deprecated_message]''', '''[wml_message]''', '''[image]''', and '''[insert_tag]''' tags are allowed beneath '''[story]'''. Most other WML tags will not be recognized in this context. Note, however, that messages produced by the first two tags will not appear in the game interface until the actual game map appears.

The only other tags currently recognized within '''[story]''' and '''[part]''' are '''[if]'''/'''[then]'''/'''[else]''' ({{DevFeature1.13|0}}: also '''[elseif]''') and '''[switch]'''/'''[case]'''. These can be used to show parts conditionally on the values of variables.

See also the journey and battle macros, in the [https://www.wesnoth.org/macro-reference.html#file:image-utils.cfg Macro Reference]

=== [story] ===

* '''text_layout''': specifies the area of the screen where the story text will be displayed. It allows the ''top'', ''middle'' and ''bottom'' values; the latter is used by default.
* '''title_alignment''': specifies the alignment of the title box. It allows the ''left'', ''center'' and ''right'' values; the first is used by default.

=== [part] ===

'''[part]''' is a special tag recognized only beneath '''[story]'''. Each '''[part]''' represents one image and text.
The part is displayed until the user clicks on the "Next>>>" button.

The following key/tags are recognized for '''[part]''':
* '''background''': the image to display. Story images are usually created specially for this purpose, except for the map.
* '''scale_background''': Whether to scale the background, default yes.
* '''story''': (translatable) the text to display below the image.
* '''show_title''': whether to display the title of the scenario at the top
* '''title''': specifies a custom title to display instead of the name of the scenario. If specified, it implies '''show_title=yes'''. If parent '''[story]''' is used through [[InterfaceActionsWML#.5Bstory.5D|ActionWML]] with '''show_title=yes''', the '''title''' key must be explicitly specified, it does not default to scenario title and leads to missing-title error if omitted.
* '''music''': change to this music
* '''sound''': a list of sound files; the engine will choose one at random and play it once while displaying the story part.

=== [background_layer] ===

A layer of the background of the story screen.

* '''image''': path to the image file.
* '''scale_vertically''': whether the image should be scaled to fill the screen in the vertical dimension. Default yes.
* '''scale_horizontally''': whether the image should be scaled to fill the screen in the horizontal dimension. Default yes.
* '''scale''': a shortcut to set scale_vertically and scale_horizontally at once. If specified, the values of the former two keys will be ignored.
* '''keep_aspect_ratio''': whether the aspect ratio of the image should be preserved while scaling. Default yes.
* '''tile_vertically''': whether the image should be tiled in the vertical direction. Tiling happens after aligning the image to the center of the screen. Default no.
* '''tile_horizontally''': whether the image should be tiled in the horizontal direction. Tiling happens after aligning the image to the center of the screen. Default no.
* '''tile''': a shortcut to set tile_vertically and tile_horizontally at once. If specified, the values of the former two keys will be ignored.
* '''base_layer''': whether is this the layer to align the overlay images to. Default no.

=== [image] ===

An image to display.

* '''x''', '''y''': the location to draw the image, using the pixels of the '''base_layer''' background image as the coordinate system.
* '''centered''': If "yes", use the center of the image as the anchor point when placing at the x,y coordinates, if "no" then use the top-left corner.
* '''file''': the image to display.
* '''delay''': the time to delay drawing this image.
* '''resize_with_background''': {{DevFeature1.15|7}} if "yes", apply the same scaling as applied to the '''base_layer'''

Each image is placed using the pixels of the background_layer as the coordinate system; each image's location moves to compensate when the background image is scaled. Example: my background image is a map with a city at pixel 160,100; I put a battle marker on that city using '''x,y,centered=160,100,yes'''. When a user plays the game they will see the map enlarged to fill the window (regardless of its size), and the battle marker will still be on top of the city.

== See Also ==

* [[ReferenceWML]]

[[Category: WML Reference]]

UnderTheBurningSuns

2021-06-25T20:03:58Z

Shadowm: remove random bit of fanon that might actually have been the page starter's own invention

This campaign takes place eons after the others. At the height of Wesnoth's power, an additional sun was created and magically raised into the sky. Millennia later, entropy has its due: The fertile plains of Wesnoth have turned to desert. There are few survivors from the age of the empire. The focus of these scenarios are the Quenoth Elves, who are particularly well adapted to living on the sands.

In terms of gameplay, Under the Burning Suns' scenarios tend to be somewhat longer than in other campaigns. They are not boring, though, as victory conditions typically change several times before the scenario is 'won'.

== Campaign-Level Strategy ==

=== Gameplay ===

Under the Burning Suns changes several of the rules you may be used to from other scenarios. Here is a list of the most crucial changes:
* regarding movement and defense, sand is the new forest
* Elves' movement cost in caves is 2 (not 3)
* Your elves are lawful and subject to the day-night cycle, which has changed quite a bit:
** First Dawn
** First Morning, Midday, Afternoon (3 turns of daylight)
** First Dusk
** The Short Dark (Night)
** Second Dawn
** Second Morning, Midday, Afternoon (3 turns of daylight)
** Second Dusk
** The Long Dark 1-4
* Most known units still work the same way, however:
** Sorceress line has been removed
** Healers may become level-4 (Illuminates, also slightly improved damage & resistances)
** Ranger and above can backstab
** a new type of level-2 skirmishing cavalry
** a new type of infantry, Desert Hunters: slowing ranged attack, skirmishers from level 2

===Kaleh and Nym ===

<big>As Quenoth elves (Wesnoth 1.14.x and later)</big>

These characters don't level up like ordinary units. Every time they reach maximum XP, their HP and attack damage will improve a bit, and you're asked what else you want them to learn on top of that, like "become a better warrior" or
"become a better hunter". You needn't worry about the choice: none of the abilities is game-breaking in one way or another, and eventually they'll learn almost all of them.

* On the first level-up, you'll have three choices "warrior", "hunter" or "leader". Whichever you choose, you'll still be able to choose the other two on later level ups.
* On the second level-up and later, you'll also be able to choose specializations that say "choose only one". You'll be able to choose one for each of Warrior, Hunter and Leader.

<big>As Desert elves (Wesnoth 1.13.x and earlier)</big>

The skill tree is different to the Quenoth version, for example "become a better swordsman" or "learn to use the bolas". The two most important things to know are:

* the very first swordsman<->archer choice defines his later field of excellence (he'll be merely good in the other)
* bolas and leadership are mutually exclusive

=== Unit advancement ===

There's no way to know this beforehand, but you'll have to fight a some big underground battles. The army you build during the first scenarios should be capable of fighting in caves. There are two main variables to consider for underground battles:
# Can each unit move at least 3 cave hexes per turn?
# How can I maximize damage in narrow corridors?

Because of these two priorities, deciding which units to level in early campaigns is very important. For instance, the following units are not as effective:
* Marksman/Sharpshooter (marksmanship ain't necessary, and besides they're too brittle)
* Hero/Champion (unless they're quick)
* Scout/Rider/Outrider (as slow as infantry, but weaker)

There are more effective units:
* Ranger/Avenger have range attack (anti-troll) and backstab (+damage)
* Captain/Marshal have leadership (+damage)
* Sentinel's "slow" attack minimizes the damage taken; skirmish may break deadlocks

== The Morning After ==

* '''Objectives''':
** Rescue (all?) surviving elves in villages
** Defeat the Necromancer (L2) leader to the North
* '''Must survive''': Kaleh, Nym, Zhul, Garak
* '''Turn limit''': ?? / 32 / ?? (Easy/Medium/Hard)
* '''Starting units''': Kaleh, Nym
* '''Starting gold''': 0

Some strange meteors have destroyed the homes of our heroes. Kaleh and Nym must search for survivors by capturing all villages. Landing on an empty village will sometimes flush out a few elves. In the beginning, they will be battling Mud-crawlers. Since you have no keep in which to recruit, put the Mud-crawlers to the sword and save all the new units. Note that, unlike other campaigns, Giant Mud-crawlers here will not spawn smaller Mud-crawlers upon their death. Also note that the grey brown trail around the lake is not as good defensively for you as the sand.

The villages will lead you counter-clockwise around the lake. At the southernmost portion of the lake you'll find a shattered bridge leading to a shrine in the center of the lake. You don't have to go there right away, but the scenario won't complete until you rescue the Druid and both Shamans there. Be aware that stepping off the island will trigger the obligatory Cuttlefish. If you don't yet have Garak, I'd wait on the island until dawn - this thing will be a bit tough for any of the other characters you currently possess.

Garak the Captain will be found with a few recruits on the Training Ground, which is just to the East of the bridge. It's possible that your people headed for the bridge will trigger this encounter - you'll find a bigger mob of Mud-crawlers than you've seen so far, and likely get some bruises cleaning them out. However, don't go out of your way to level Garak up. He has his own... destiny.

After dealing with the Mud-crawlers and Cuttlefish, keep heading around the lake. The villages on the East side represent the remains of the stables - capturing them will give you Scouts. If the Scouts explore the outer edges of the map, they will find more a few more villages and units, though no more Mud-crawlers. You're now ready for bigger game!

Completing the circuit around the lake reveals the destroyed keep on the North side. The tribe leader Tanuil is pronounced dead, Kaleh now leads the tribe. On turn 11, a Necromancer Xanthos will show up to lead the Undead against the elves. Head north to take the battle to his keep. On turn 16 the Quenoth hunting party returns on the North edge of the map, somewhat westward of Xanthos.

== Across the Harsh Sands ==

* '''Objectives''':
** Kaleh must reach "Pinnacle Rock" at the North end of the map.
** Defeat the Outlaw leader.
* '''Must survive''': Kaleh, Nym, Zhul, Garak
* '''Turn limit''': ?? / 60 / ?? (Easy / Medium / Hard)
* '''Starting units''': Kaleh, Nym, Zhul, Garak
* '''Starting gold''': 300

<big>Scenario-specific gameplay rules</big>

In addition to the two-sun daily cycle for this entire campaign, this particular scenario has more particular rules involving water economy, which make it play quite differently than usual: Your refugees are traveling through an "extra-barren" area and they are short on water-skins and even food. They are therefore at risk of ''dehydrating''. The rule for this effect triggering is:

If a unit is:

* At the ''beginning'' of a turn,
* during the ''day'': any of Dawn, Morning, Midday, Afternoon, Dusk;
* On a ''sandy'' hex: sand, road, rubble or sand-dunes;
* ''Without a nearby healer'' - a Shaman, Mystic etc. standing in an adjacent hex;

Then the unit will experience "thirst" and lose:

* - 4 / 5 / 6 HP (Easy / Medium / Hard)
* -1 point of damage on each attack (melee and ranged)

with the effects being cumulative. The HP loss may be healed by any healer, during the day or the night - but the attack degradation is only healed at an oasis, i.e. by being located on a water hex at the beginning of a turn.

You may be wondering "What about staying in villages?" - well, there are effectively no villages along your way. Instead, the water hexes of oases heal 8 points of damage, regardless of the source of damage, in addition to removing the effects of dehydration. Thus, an oasis becomes a point of healing, surrounded by no-damage grasland hexes where you can roam free without a healer buddy.

<big>Map Layout</big>

This is a long vertical map. You start at the South end and move North. At your destination there's the headquarters The Black Hand, a band of outlaws. (Not that it's clear what being an "outlaw" even means in a tribal, stateless, semi-nomadic society and in the middle of the desert, but whatever.) Between you and them, other than desert, dunes and mountains, are 4 oases; these are located at east and west edges of the level, with occasional short stretches of road peeking out of the sands, indicating the direction of the next one. The oases are (in order):

# The small oasis you start in.
# An oasis with Giant Scoprions.
# An oasis with a contigent from an outlaw band, The Black Hand ().
# An oasis surrounded by a castle (complete with a keep and a leader), inhabited either by:
## A colony of Ogres, or
## A Wight with his undead minions
# A "mirage oasis" which disappears as you near it

<big>Recruitment and formation</big>

While 60 turns might sound like a lot, your navigation in this level is quite constrained: In the day, by the risk of dehydration, and at night by roving Ghosts (see below). So, don't stay in the keep too long; you should be able to handle everything you'll run across with a single castle's worth of troops (6 units) if you're careful. If you're not careful, it doesn't matter how many troops you get. Also, remember there are no villages on your way, and all of your recruits are supported "out-of-pocket".

All your recalled/recruited units can become dehydrated - including healers, therefore you should keep your healers in pairs. A reasonable formation is a "hedgehog" around Zhul and a Quenoth Mystic:

__
__/U \__
/U \__/U \
\__/H \__/
/U \__/U \
\__/H \__/
/U \__/U \
\__/U \__/
\__/

or along a diagonal axis:
__
__/U \__
__/U \__/U \
/U \__/H \__/
\__/H \__/U \
/U \__/U \__/
\__/U \__/
\__/

this is 10 units: 2 healers ('H') + 8 any other ('U') = 4 starting units + 6 recalls/recruits. Out of those six, make one the Mystic/Shaman; another - a Quenoth Scout, and the other four could be, say, two Quenoth Fighters and two Tuaroch Riders.

Why place the two healers adjacent to each other? Because a healer, by him/herself, is ''not'' in itself safe from dehydration, so the healers must support each other.

<big>Strategy</big>

Your hedgehog will begin following the remains of the old road East-North-East. You won't be able to keep the hedgehog together if the group travels faster than 5 hexes per turn - the speed of the slowest unit - so that Scout you got will not be very effective right now beyond increasing you range of view. That's okay, we'll be able to let it loose soon. At night, of course, you can break this formation - but you must reform it before Dawn to avoid dehydration.

One reason you might break formation at night is your being attacked by roving ghosts: Indeed, in most areas (outside oases), and at every turn of night (including dusk but excluding dawn), one or two Ghosts will appear near to your units, to "prey on the weak". You're not all that weak, but a Ghost may be able to pick off a wounded character of yours if you just keep the hedgehog formation. If your characters have high HP, you have the option of just ignoring the Ghosts' harassment - after all, your units are ineffective against them (except for Garak), and they against you with your good sand defense; they will spontaneously disappear at dawn.

You should arrive at the second oasis at about first-dusk, and promptly be attacked by the Scorpions - who have decent desert movement and vision range - plus the roving Ghosts. Focus on the Scorpions first, unless you can land a terminal blow on a low-HP ghost; in fact, the Ghosts might even attack some Scorpions for you. After you take out the Scorpions, you'll find a Traveler's Ring. This artifact will make the designated unit invulnerable to hunger and thirst. Give it to your Scout; it can take off on its own without getting dehydrated.

If you somehow got dehydrated on day 1, or took a really bad beating - you might wish to rest in the oasis (remember: +8 HP in the water) before reforming your hedgehog; the bandit bathers' oasis is due West-by-Northwest.

As you approach the midline of the level, you'll find it a hilly region infested by several Ogres. Despite their high HP, they're not so difficult to beat, since they're slow in sand and will not all gang up on you; they're not Chaotic, so they won't get a bonus when you're able to break formation; they have no ranged attack; and - if you catch them on sand hexes, you'll have twice their chance to hit. A Pathfinder (leveled Scout), Nym, or Kaleh - with the hunting skill - can slow them down to make sure even their relaliation loses its sting. The issue you may have here is your formation, which will likely break up (unless you go very slowly), and in daytime will result in some dehydration - that will be a handicap in your next encounter.

If you dispose of the entire group of Ogres, you'll receive a special treat: A Loyal [http://units.wesnoth.org/1.15/mainline/en_US/Dust%20Devil.html Dust Devil] - an elemental earth spirit. It has a respectable arcane-type melee attack, and a nice impact-type swarm ranged attack - both effective against the Undead. If that's not enough - it has 8 MP and low movement cost over most terrain, _and_ it has at least 50% defense everywhere, _and_ it recovers 6 HP per turn on sand or dirt hexes; so it's an excellent scout. It won't be your "tank" against the Undead, though, due to limited HP and its vulnerability to cold and arcane attacks.

The Black Hand's pool outing oasis is next: You'll find a mixed bag of Bandits, Thugs, Poachers and Trappers enjoying the pool (after all, it's not like they have a lot of crime to attend to). If you had your Scout in their sights before, they might have even joined the fray against the Ogres and yourself. By now should have some extra leveled-up units, so it won't be anything you can't handle - especially if you make sure to fight in daytime. The main issue here being the hills and the Ogres having impeded your formation. Depending on how effective you are in keeping everybody together, you might have some units go into battle wounded rather than wait for the healers to attend to them. When you are done here tack East-by-Northeast towards the castle oasis.

Close to the castle, you'll chance upon a Red Mage named Elyssa, who is being changed by a force of skeletal units. You'll obviously save her - you just let her fill the empty spot in your hedgehog formation (with the scout no longer needing its former spot). Remember she's very effective against the Undead - but you need to keep her safe from the counter-attacks of Skeletons and Revenants.

As for the castle itself - there is some random roll-of-the-dice which decides whether you'll find Ogres or the Undead in it. If it's the Wight leader (an L2), it will have an "honor guard" of four units (Ghosts on Medium difficulty), and will have amassed some money for recruiting (it has a high base-income despite the lack of villages). Remember that Wights are quite mobile, and this one won't hesitate to leave its castle to target someone vulnerable.

The last (non-)oasis has a signpost at its entrance, announcing you've reached the home of the Black Hand of (existentially-unemployed) outlaws. When you cross some horizontal line, they will have already begun recruiting in earnest - and between the leader's basic income and their tent villages, they can recruit two units each turn without any gold reserves... So, hurry North. The leader of bandits is named Thorn, an L2 Outlaw (on Medium; probably a fugitive on Hard); when you take him out, he bargains for his life - and when you accept, he takes all of the remaining bandits with him.

The bandit leader's offering in exchange for his life is a vial of Holy Water. As you may recall from other campaigns, the unit which picks it up has its melee attack change type to arcane. Choose carefully - you probably want to give this to a unit with a pierce-type attack, add
Now you have a second unit with a highly-effective attack against the Undead (in addition to the trampling Tuaroch riders).

When you complete your objectives, you get a 20-per-turn early finish bonus (which doesn't correspond to the number of villages), before carryover deduction.

== A Stirring in the Night ==

* '''Alternative Objectives''':
** Survive until the (elongated) night is over with no more than 6 villages lost, or
** Defeat both Undead leaders
* '''Must survive''': Kaleh, Nym, Zhul, Garak
* '''Starting units''': Kaleh, Nym, Zhul, Garak
* '''Turn limit''': ?? / 12 / ?? (Easy / Medium / Hard)
* '''Starting gold''': 200

<big>Layout</big>

This map is on the small side compared to the last scenario - it's just the surroundings of the Elves' encampment for a single night: Tents/villages and some bonfires, on sand and sandy hills, at the edge of proper hills with a bit of forest. The right of the level is a North-South path between the (5-hex + keep) castles of two Undead leaders: A Lich and a Death Knight. They are, in fact, each other's enemies, and you are just in the way: One of your villages is almost smack on the path; and four more are close to it (one turn for a Ghost, two turns at most for other Undead, from the path). Your castle is on the left of the level, with an oasis blocking the way - meaning it takes a few turns to get from there to where the action is.

<big>Strategy</big>

This scenario has a special consequence for the rest of the campaign: Whenever you lose a tent/village to enemy forces in this scenario, its inhabitants are turned to un-death, i.e. part of the group Elvish survivors from your village is lost. The consequence: Higher recruitment price for units, for the rest of the ''entire campaign'', if more than 3 tents/villages are lost. And it doesn't help if you regain a village - those inhabitants are just gone. So - protecting villages from the Undead is job #1.

Seeing how the rival Undead forces are fighting each other, not you - you would expect that such protection shouldn't be that big of a deal. Unfortunately, they seem to be rather fond of tents... Undead units will opportunistically leave the N-S path to capture a tent/village - particularly the high-mobility units like Ghosts and Bats. On the other hand, the Undead also crave mortal flesh (a little retroactive pun there), so when faced with a choice between a village + sentry and an empty village - they won't always go for the village, especially if it's farther away from the N-S path. Still, play it safe and try to man villages that are within an enemy's movement range, whenever this is tenable.

This scenario feels quite different depending of how frugal and speedy you were in your voyage North. If you were reasonable and kept a tight formation with ~10 or a few more units, and didn't meander too much - you should be awash in gold. If that's the case, you will probably want to aim for the two Undead leaders; three rounds of recruitment/recall should be sufficient in this case. on Hard, that might be less feasible even with the extra gold, or require much more cannon fodder. If you've started this scenario with a lot less gold then you're in for more of a challenge, and will be hard-pressed to take the maximalist stance of "no village left behind".

The first couple of turns of the level, though, are not effected by your recruitment - since even scouts will take until turn 3 to even arrive at the Eastern villages. An important first dilemma is whether to protect that easternmost village in "no-man's land", in the middle of the path. Do that, and you've guaranteed most of the Undead's attention will be directed at _you_: They have to go through you to get to their rivals anyway.

As for recruitment and recall - bear in mind that all fighting will be at night - a major disadvantage for you vis-a-vis the Undead. That means it is even more important to utilize their movement impairment in the sand, to isolate and gang up on them. And you will have a lot of switching-of-positions, to get to villages which come into danger: The Bats and Ghosts will fly around you, and later there's another surprise (see below). Fighters will be rather un-useful for this purpose - slow (even the quick ones) and with the wrong attack types (except if one of your fighters took the holy water potion); Tuaroch riders have Impact attacks, and if you have L2 stalwarts they'll defend pretty well from the skeletal units - but they're even slower; when you recall or recruit some on turn X, they will come into play on turn X+3 or X+4 (!), and will be mostly limited to one region of the map.

This means that, in this scenario, the Dustbok riders - the Scout line of units - must shine. You'll need quite a bunch of them to support and replace your early-turn front-line units. They bruise easy, but remember that, after being attacked, they can retaliate and retreat on he same turn (their Disengage ability) - this will come in very handy. You will likely find yourself attacking with a wounder Scout, moving it away, then replacing it with a fresh one, on the same village, and attacking again. When leveling Scouts on this level, Pathfinders will be much more useful than Archers, due to their ability to Slow. This is important to reduce your losses against the damage-bonus-enhanced Undead.

If you plan on disposing of the Undead leaders, try moving in earlier rather than later, even at the price of unit losses, because both leaders make 20 gold per turn before any income from villages, and will often recruit a pair of units per turn. Keep in mind that voodoo ceremony Garak undertook before this battle: If you keep him in good health, he can repeat his attack on an enemy target again and again: The Lich is where you should send him, since its melee is much weaker than the Death Knight's.

On Hard, you're more likely to be on the defensive throughout the scenario - requiring some good luck, as well judicious use of slowing and leadership. If any of your Archers have leveled-up to be Desert Rangers, their Backstab ability may also come in handy.

On turn 7, a contingent of Orcs - a patrol? - moves down the path from the Northwestern outcropping. These are certainly easier to deal with - you can properly stab them; but that doesn't make their weapons sting any less. Make sure and keep your terrain benefit by sticking to the sand. Their leader, Ganthos, has no keep - but he does have an income; so if you let him, he will sneak down the Western edge of the map and use your own keep while his minions ravage the encampment. Finally, note that the Orcs are quite willing to attack the Undead, not just your own units, and may do so if a lot of the Death Knight (Northeast leader)'s minions remain.

Garak will meet his demise at the end of this scenario, in a rather arbitrary way (which, even after being foreshadowed, seems rather arbitrary). But - you can't let him die earlier.

== Descending Into Darkness ==

Starting now, you lose the comfort and protection of the sand. The terrain here is primarily hills and mountains, interlaced with river and swamp. When you initially step into the mountains, Goblins will appear. The mountain road forks West or North. The western fork leads you to a bridge over the river that has a village on either side. Stepping anywhere close to here triggers the appearance of more Goblins and some Naga led by an Orcish Slayer [or Assassin on Easy difficulty]. It's probably more fight than the two villages are worth. However, if you're playing on Medium or Hard, you have to fight these sooner or later - may as well face them now before you get too busy. Plus, you can choose to face them during daylight.

The northern fork takes you over another bridge to the keep of Panok the Direwolf Rider. He moves ridiculously fast, so you might have a hard time pinning him down. His troops are mostly Goblins, so consider him to be a warmup for the tougher foes you'll face in the caverns. Upon his death, he drops a ring and possibly triggers the Naga and the Slayer.

From here, there are two roads: the North, and the West. Both lead to tunnels into the mountains, and each ends in the keep of an Orcish Warlord [Orcish Warrior on Easy]. The exit tunnel could randomly be behind either keep. Though the two keeps are linked by paths inside the mountain, it might be quicker overall to leave Kaleh outside until you determine whether he needs to go East or West. You could either split your troops and tackle the entrances separately, or send the whole bunch down the closest hole. In that case, expect a pitched battle as the furthest Orc reinforces the nearest.

The turn after Kaleh first enters either cavern, he will be pursued by a Cloaked Figure/Dark Assassin. It doesn't matter if Kaleh is surrounded, the Assassin will temporarily displace any Elf or Orc that is in his way when he appears. Other findings:
*If you follow the river where it enters the mountain, it will lead you to a Goblin Impaler guarding a treasure chest. Not exceptionally tough, but he will fight from solid ground while you stand in the water. The chest contains 40 to 80 gold.
*Continuing around the river, there is a passageway [coordinates 18,10] that ends in a pool. If you step into the pool, you will find a glowing blade. You may choose to either take it or leave it. If you take it, that character's melee attack will now deal cold damage, but a monster will appear to block your escape. It's only level one [and cute at that!], but again it will be on dry land while you will be starting in water. It's kind of a long trip, so you'd be unlikely to finish it before the end of the scenario unless you send a Scout or other fast unit. Alternately, if Nym didn't get the Holy Water, have her get it.

== A Subterranean Struggle ==

You're in a tunnel headed East. Soon you will see a squad of Giant Ants in front of you, while a Cave Spider tries to sneak up behind you. You can ignore the Ants for now, as the Spider is more dangerous: it poisons with its melee attack and slows with its ranged attack. Eventually you find yourself in a great chamber where Dwarves and Trolls are doing battle. You are forced to choose which side to ally with, and then you will be required to eliminate the other side. Your choice will stay with you for a few more scenarios, as the campaign forks after this. Fortunately, there is a keep right in front of you, though the battle is currently raging in it.

Soon after choosing sides [probably about the time you get your keep clear], your opponent will pull a sneak attack that nearly wipes out your allies. Most of the rest retreat. The ball is now in your hands. Three turns later, they make it up to you by giving some of their troops for you to command. Finally, some loyal troops. If you are allied with the Dwarves, the two tribes of Trolls are Southeast and Southwest from your keep. If you are allied with the Trolls, the two tribes of Dwarves are Northeast and Northwest from your keep.

Guard Kaleh well: some time after receiving your reinforcements, the Cloaked Assassin will reappear. This time s/he will Slow Kaleh and take up to half his hit points. There's some more crazy talk, and the Slow effect lasts until the Assassin has been removed again. Note that even if your troops now succeed in destroying the enemy tribes, this scenario won't end until the Assassin has been dealt with.

==Diverging Campaign Path==
===In the Tunnels of the Trolls===
You start in a small keep with few places to go. The tunnel leading West is where you just came from. To kick things off, move a unit to the East-most dirt hex. At the end of the turn, Dwarven demolitions will make this wall an entrance to the Troll kingdom. You will immediately see a Troll leader and his minions in a keep. Don't get too excited; he's not your target, merely an outpost. However, the clock is ticking, so finish them off quickly. Afterward you might wish to use his keep to recruit an additional healer to support Zhul, and if you have a unit with the cold blade bring them as well.. Since it costs no upkeep, you may as well recall all the Dwarves that you've been given by your allies.

This cavern has exits leading North, East, and South. North only goes to the edge of the map. East leads to some Trolls interrogating some Dwarves. Play your cards right and you'll be able to rescue a Dwarvish Stalwart, who joins your party out of gratitude [though he's not grateful enough to be Loyal...]. South is the exit going toward the objective. This leads into a large lava cavern. Similar to the second scenario, you'll need to keep as many troops as possible gathered around a healer. However, the lava hexes are not safe for your units to end their turns on, other than the flying units. This is going to slow down your progress, as most units will not be able to use all their movement points.

The Troll Shamen blow up the bridge going directly to them, so you'll have to take an alternate route clockwise around the rim of the lava pit. They will conjure up a fire elemental to slow your progress; after you kill it, it will periodically regenerate. Additionally, as you reach certain checkpoints the Shamen will create more Fire Guardians, though these don't regenerate. When you reach the southern part of the rim, you'll be rewarded by a small pool of water that will heal whomever is standing in it by ten points per turn. The rim is interrupted here by a rock projection sticking out to bar your way. After this, you have to proceed by "island hopping".

By the way, there are two passages on the western side of the lava pit that aren't strictly necessary to get to, but might be worth exploring [flying units only]. The lower is blocked by the ghost of a Dwarf who died in the upper. Burying the remains of the Dwarf allows you to proceed further down the lower passageway to a Troll crypt guarded by a Zombie Troll Whelp. Flying over the Chasm allows you to loot the crypt for the poison wand it contains. Whomever picks it up will add poison damage to their melee attacks.

When you reach the spit of land that the Shamen are standing on, one will run to the boss. I got lucky in that the other chose to stand in the lava to get around me. He was a lot easier to finish off then. ;^) After that, follow South and East. The tunnel quickly narrows down to a single lane, and your progress will be impeded by some Whelps. The lair has a pair of alcoves containing Troll dead, who will eventually be turned into Zombies to further slow you down. By the time you deal with these and the army of Trolls the boss is recruiting, you might not have much time left. Finally take out the other Shaman and the Chieftain. Good luck!

<Big>Dealing With Dwarves</Big>

This is mostly just dialog, though if you have kept Elyssa alive she will decide to stay and study the Dwarves. As a parting gift, she presents you with a flaming sword, and you can recruit/recall any unit to take and deal out fire damage. Too bad she'll be drowning soon. The other bad news is that all of your loyal troops will also be staying down here when you go up into the outer world. Only one Dwarf will volunteer to guide you. If you saved the Stalwart, it'll be him.

=== In the Domain of the Dwarves ===
You start in a small keep with few places to go. The tunnel leading East is where you just came from. To kick things off, move a unit to the West-most dirt hex. At the end of the turn, Troll fire magic will make this wall an entrance to the Dwarven kingdom. You will immediately see a small contingent of Dwarves in a fortress. Since it costs no upkeep, you may as well recall all the Trolls that you've been given by your allies. If you're going the send Zhul after the hidden bonus, you might also want to bring in another healer.

The area around the fortress has several tunnels. Going clockwise from your current position, the South-East avenue only goes to the edge of the map. South-West leads to a humorous scene of a Dwarven drill instructor berating his troops. Bring two mid-level Trolls, preferrably a mix of melee and ranged types to deal with these. Past this will be a Troll being tortured by a Dwarf. He pretty much rescues himself, but joins your party out of gratitude. North-West is the exit going toward the objective. North is a Dwarf guarding what will become a dead end.

The main path crosses two single hex wide bridges over a chasm. After you push the Dwarves back to the bridges you can fly Zhul over the chasm to support your front line. The leader of this Dwarven contingent challenges you to get up close and personal. After you do, however, he blows up the main entrance to the Dwarven Keep. Now you'll have to make a right turn detour through the Black Lake.

By the time you get your feet wet, you'll see a Dread Bat and some Giant Tentacles. If Zhul hasn't been upgraded to Desert Star yet, the Bat might be a tough match for her. Maybe have her hang back until the bat has been fireballed or rocklobbed. After the rest of your troops finish wading through the lake, they'll take the left. If you're going after the goody, have Zhul perhaps assisted by a Troll companion occupy the island in the northern part of the lake. There is a Dwarven Hermit speaking some Gollum-like speech. When he dies all your troops will have access to his amulet, which is basically a key. Send somebody to the South-East portion of the lake, where the amulet will get you past the concealed door to reveal a Dwarven crypt. Avoid the Dread Bat in his keep on the East side of the lake.

Anybody can do it, but wading through the water will take prohibitively long for characters who can't fly. If it were appropriate to the topic, i'd question why somebody who can easily fly over a Chasm can't fly over Deep Water, but it's not. Anyway, looting the crypt gets you a belt of strength that is supposedly good for 12 additional hit points. I say "supposedly" because I've repeatedly seen Zhul end up with 52 hits, not 53. Zhul could really use this, as she gets no additional hit points when levelling up to Desert Star. You won't be able to see the crypt, but it's in the center of the chamber at the end of the tunnel. Even with flying here, i had a hard time getting there before the Dwarf Chieftain was dead. I had to replay the end of the turn several times, as he repeatedly kept suiciding himself on my Druid. Anyway, upon putting on the belt your exit will be blocked by a ghost. It'll be kind of tough, but hopefully the chieftain will be dead before you're on the ropes.

Back to the mainland, the Chieftain and his troops will be almost directly west of where your people get back on land. There's a wall in the way, though, with entrances on both the North and South portions of it. The southern route is slightly closer, but is also a chokepoint. Send some faster troops the northern way to attack the Dwarves' rear.

<Big>Talking With Trolls</Big>

This is mostly just dialog, though if you have kept Elyssa alive she will decide to stay and study the Trolls. As a parting gift, she presents you with a flaming sword, and you can recruit/recall any unit to take it and deal out fire damage. Too bad she'll be drowning soon. The other bad news is that all of your loyal troops will also be staying down here when you go up into the outer world. Only one Troll will volunteer to guide you. If you saved the victim of Vengeful Dwarf, it'll be him.

== Out Of The Frying Pan ==
Thankfully, this is the last of the underground fighting. It's too bad you can't recruit more of the Dwarves/Trolls you've allied with, as they could really help here. Your opponents have dammed the river and the whole tunnel system is being flooded. This is bad: every turn you will lose several hexes of floor. Recruit/recall no more than a single castle's worth of troops, as you'll lose more to drowning than to fighting. Actually, it's best to not recruit any units, though you should recall the Dust Devil, since it is loyal; you are going to need your gold later at a second keep, and you don't want to pay upkeep until then.

It is best to play this similar to "The Elves Beseiged". Don't fight any more than you absolutely have to, prefer to instead move past the enemies and let them drown behind you. Water areas that you haven't seen yet won't rise, so don't send fast scouts ahead of your slower troops (an exception: the Dust Devil doesn't trigger the "more water" events, except for the one at the end of the secret passage).

The first cavern will have your exit blocked by three of your opponents, be they Dwarf or Troll. Next is a scattering of Giant Ants. They don't put up much of a fight. The exit is the North West tunnel. The following cavern is populated by three humans who decide to attack you. The tunnel behind them is also flooding, so you need to make haste to the western tunnel. The next cavern is marked by a magical warding [looks like clouds] that blocks passage except through the red rune 'gate'. It won't hurt to step onto the rune, but upon leaving it the lead character will be burned for 25%-35% of their total hit points while both gates disappear. Also, a variety mix of undead will suddenly appear in the chamber. Some of them will gather around around the entrance chokehold, so you'll need skirmish ability to effectively assist the now lonely lead character. If you have Grog, best to send him in first, as he can heal up the damage by the time the battle is over. Also, his impact weapon is best used against the skeletons in the back of the room. The same goes for Rogrimir, naturally, but he'll need healing afterward.

There is a secret door at 24,49 that will lead you around the red rune room. It has more water there, though [not to mention the Soulless], so it's another opportunity to have good troops drowned. The cavern where this tunnel connects back behind the red runed room has two blue runes that will heal whomever steps upon them to 100%, but not cure poison. They are also only good for a few uses, so probably just use it to heal Zhul and your badly bruised ally.

The exits out of the blue runed room are thus: South is back to the red runed room. South-West is the water-logged Soulless. North-West is the 'Training Room'. A ghostly teacher in back of the room runs his ghostly students through weapons drills with you as targets. Destroying the students is not helpful, as the master keeps reanimating them. You need to take him out, but the Zone of Control of the students keeps you from getting to him. Yet another call for the Skirmish ability. I don't bother going in there, as there's no real gain for the amount of time you'll have to spend here. What i like to think of as the 'main exit' from the blue runed room is due north. This leads to a sleeping area where you will be assaulted by the skeletal remains of its former inhabitants. Your ally should have half of them cleaned up by the time the last of your troops gets in. This route is slightly longer in terms of hexes than going through the Training Room, but i still get through in fewer turns.

Besides, there is a goody to be had this way: North of the skeletons is the lab area. You'll find the secret door at 17,36. Inside, you'll find a red rune blocking the way, then two more further up. Stepping upon the first rune causes the character to suffer the usual 25%-35% damage PLUS poison. Then the other two runes are covered by angry monsters [failed experiments]. Both are first level. Behind them is a Frankenstein-style monster trapped in a ring of fire. If you Skirmish past the two, you can break the ring to release the second level Flesh Golem. It will fight for you. You have to be careful, as its Berserk fighting style can be a double edged weapon. Nonetheless, it can be useful to have another Chaotic fighter on your side.

The next room beyond either the Training Room or sleeping area is the sacrificial altar. Setting foot in here conjures two second-level fire demons the next turn. Bring out your Cold Blade and whatever ranged weapons you have handy. Note that every time you step on the tiled floor around the altar you are given the chance to pull a lever. Do not pull the lever until all your people are in this room and ready to leave. Pulling the lever opens two secret passages behind the Altar. The eastern is your exit; the western is flooded. Six turns after you pull the lever, the entire temple area will be Deep Water.

The exit goes through a Crypt area that is guarded by a Spider Lich. It is tough, but vulnerable to Fire and impact damage; you should still have both. After you leave the Crypt, you will again be stopped by: the ever mysterious Cloaked Assassin. This time you are able to capture him and get his whole sad story. I think it was about turn 30 or so that i got my people past the dangers of the raging waters. Woo-hoo!: you've made it out into the sand again, and are ready for some real fighting!! Fortunately there's a rather haughty group of humans who seem to think your people are meant to be sacrificed to their 'Dark Lady'.

By all means, start recalling troops to teach them a lesson. You probably need to spend all your gold. Figure the opposition is 20-something in Sergeant Durstrag's tribe plus five messengers and periodic visits by vengeful undead. These will mostly just bother your troops who are near the South end of the valley. Don't bother looking for the messenger; it isn't on the map yet. At some point, a messenger will materialize just East of the oasis. After taking him out, you only have a half dozen or so turns to finish off Sergeant Durstrag or another messenger will be created, along with his escorts. Don't forget the chest of gold just South of your Keep. If the battle goes on long enough, the flood waters will eventually come out of the side of mountain on the West end of the valley and make a new river.

== Blood is Thicker than Water ==
Out of the frying pan, into hot water! Let's break this down into parts for each objective:
===Free the Mermen===
If you click too rapidly through the introductory text you will miss some crucial details: Namely that your enemies lie to the northwest, and that you're looking for ''five'' merfolk. It's worthwhile to get them all, as each will become a loyal troop once freed from the cage. The humans are Loyalist factioned in three tribes. They are not the mysterious 'Iron Council', just followers. The leader is a third level commander while the other two are second level lieutenants. Depending on the level of difficulty, you could be seeing things like Shock Troopers, Swordsmen and Cavaliers. Probably about three keeps worth should be good. If you wipe out all the bad guys before the sacrifice, but don't free all five merfolk, your troops will just wander idly until the time of the sacrifice. Freeing the fifth mermaid starts the rebellion, thus potentially saving a few turns for the end of scenario bonus.

It's easy to miss the the fifth Mermaid, as she is hidden in the small cave just north of the eastmost humans' keep. This is in deep water, so the land lubbers won't be able to help. Have the Mermaid Priestess and another Merman approach the island from the East side. The cage there holds a Mermaid Enchantress and is guarded by a few Walking Corpses/Souless. The other large island in the Northwest is closed off, you won't be able to get there yet. If it isn't obvious, use your freed merpeople very sparingly on land. Unless the humans are standing on the shore, or otherwise making themselves easy targets, just park your finny allies in the water. Sometimes they can jump on a village to prevent a wounded bad guy from getting a rest. If you have dealt with all the humans before turn 16, don't just stand around. Start shifting all the elves where they will next be needed next: the east side of the mainland and the eastmost island. Dwarves, Trolls, and Golems move slowly enough that they probably won't make it to the rebels before the rebellion is over. May as well leave them on the North-West island [the village at 20,23 is a good location] in readiness for the third objective, possibly accompanied by any of your elves with a move of 5.

On turn 16, any merpeople still caught will be pan-fried in a little butter as an offering to the Dark Lady. This is performed by a briefly seen Necromancer named Hekuba. He is a member of the Iron Council. Or is that an Iron Chef? Should any leaders of the Loyalists still remain, they will depart to prepare 'Plan B'. Sigh. It was so much easier to get to them on the mainland. If they are all dead, the Iron Council will then begin 'Plan C'.
===The Rebellion===
After the Dark Lady is newly invigorated by the sacrifice, the apparition of Eloh appears to (and appeals to) one of your elves. He expresses his faith in the apparition, and challenges you for leadership of the elves. You'll have to fight him for supremacy, and you won't be able to recruit new troops until this is over. Zhul will be torn between her admiration of Kaleh and Eloh. She will go to Eloh and sell Kaleh's goodness. The apparition rebuffs Zhul and petrifies her. If you don't have any other healers you might wish to recall some before making the long trek East. The rebel base is the northeast island. This was inaccessible to non-swimmers, but the merfolk will show you some Shallow Water paths to the island. If you're feeling shorthanded, you can wait offshore (backed up by a healer, of course) and hammer the defenders in the water. They seem quite eager to rush out to you. It might take a little longer this way, though.

As you approach the island, some Crab Men will appear and attempt to eat you. They're not terribly tough, but they're in their natural element and you're not. As insurance, have the ranged attack merfolk provide a screen in the deep water around you. The melee attack merfolk could perhaps approach the island from the north side. There is a river that goes right to where Eloh is standing. Four successful hits from Merman Warrior can do it...

If you have Kromph, the Flesh Golem, it will soon fall under the sway of the Dark Lady. It talks to itself for a few turns as a warning. When that happens, best surround it with ranged attacks. It changes sides on the beginning of your turn, so you can blast it before it gets a chance to attack. If you manage to strike down Eloh before she complete's Kromph's sub&shy;version, her final command to it causes it to collapse into a heap of confusion. Oh, but we barely knew ye...

If your costs to recruit are high as a result of the battle between the Spectres, it might interest you to know that the rebel elves are not your target - Eloh and Tanstafaal are. Whenever you destroy the apparition and capture Tanstafaal, the remaining elves will automatically switch over to your side. You might not want the extra overhead for the rest of this scenario, though. Besides, they screen Tanstafaal so well that most of them will have to be done in to get to him. Oh, and Zhul comes around after the apparition is gone.

===Capture Ships===
The next fight will take place on the formerly closed northwest island. This is the home of the Iron Council - a trio of Necromancers. Hekuba is their leader and stays on his keep. The other two are free to move and not even shy about stepping into the water. Nevertheless, they can hold their own out there at night. Plan C is the Necromancers raising the seabed to provide Shallow Water paths from the island - they actually think they're attacking YOU. Well, pride goeth before a fall. With the settling of the rebellion, you are able to recruit again. If you find yourself needing to do that, you have to chose whether it is better to use Tanstafaal's keep and march them all the way back West, or detour Kaleh down to one of the humans' keeps south of the action.

The troops of the Iron Council include a mixed bag of skeletal types and if plan B is place the human leaders will also be here. Hekuba can recruit the same troops as the humans did, plus more Necromancers, Skeletons/Revenants and Skeletal Archers/Bone Shooters. You'll have quite a fight on your hands to make landfall. After you do get on solid ground things aren't so bad. Of course, if the enemy captures the island at 20,23, you'll have to fight them through the water twice. It's probably better to continue to press them at night to prevent that. It'll be a little easier to take on the Necromancers if you can level up the Enchantress and the Priestess.

The bad guys won't be able to destroy the ships. For game purposes, the ships are actually villages. Thus, the worst thing that can happen to the ships is they get recaptured. The merfolk can't cross or occupy ship terrain - not even after they've been captured. I suppose they would have a hard time climbing ladders. When you have all four, the scenario immediately ends. You might wish to finish off any of your opponents that are close before capturing the last ship.

== Speaking With The Fishes ==
Just dialog. A curiosity is that the queen of the Merfolk - Melusand - is giving all your people a seashell brooch, but doesn't say what they're good for other than they enable her to track your progress!

== The Battle for Zocthanol Isle ==
Wow! This time around you'll have to battle five tribes, plus bats. You immediately have to head West along the southern shore of the island, searching for a keep. You'll soon find a Saurian Oracle who looks like he doesn't really need the keep he's sitting in. It's not a particularly tough fight, but you're under time pressure to immediately begin churning out units. As soon as Kaleh takes his seat in the center of the keep, your loyal merfolk return bringing the remaining ships and a group of merfolk you can recruit. They also capture the villages South of you, so you can immediately begin sending the troops North. Zhul makes a comment about not needing gold if you lose. I will simplify: this is the last scenario in which you do any recruiting, so you may as well bust the budget. You still have to face down four tribes. From left to right:

* '''Naga #1:''' If you follow the Shallow Water from your keep North, it'll lead to a small keep with a Naga Myrmidon. His tribe is not heavily populated, but you'll see them first due to closeness. Send half your loyal merfolk up there to deal with them, and recruit some new merfolk to assist.
* '''Undead:''' Not too far North of your keep will be a Draug recruiting a fairly strong assortment of undead: Blood Bats, Ghosts/Wraiths, various second level skeletal types, Soul Shooters, and Necrophages. On higher levels of difficulty, there will be Spectres and Draugs as well.
* '''Orcs:''' On the northeast corner of the island will be a peninsula. There you'll find a Orcish Sovereign recruiting a stiff mix of Orcs and leveled Wolf Riders, nothing under second level.
* '''Naga #2:''' On the east side of the island is more shallow water leading to another Naga Myrmidon. He is a twin to the western Naga, but he'll have more time to recruit before you get to him. Packs of Naga Hunters shooting poison can be deadly day or night. You can take them out with a mix of fast Elves supported by Mermen and a healer. If you're not used to recruiting merfolk, please note that the Mermaid Initiate is not capable of any healing or curing until she's levelled up.

The other threat you'll face are the bats that show up every dusk and harry you until morning. Easy difficulty gives you five Vampire Bats every night. Higher levels of difficulty take away two of those, but add Blood Bats. Like the Ghosts in the second scenario, these are not worth chasing after. They will, however, pick off the weakest of your troops. Anybody who is below 20 hit points is vulnerable at night. Hedgehog like crazy at night, if you don't have enough units for a massive line. If the bats don't see any likely targets, they will unflag any of your unguarded villages. You don't need the money, however, so who cares?

As soon as you have the keep, victory conditions change to reaching the black citadel. However, that'll take some work, as hordes of undead will soon begin pouring down your way. If you dally in recruiting/recalling, you might get flanked by Direwolf Riders and packs of Naga on your eastern side. Send the Dwarf/Troll (You ''do'' still have him, don't you?) along with Nym, Zhul and what's left of your initial landing to deal with the undead while the faster troops you recall head East along the beach. By all means also send whomever has the holy water North. Your merfolk can nail down your watery flanks, both west and east. You'll also need some sturdy elves to block the gap between the lagoons. You'll need another healer for the eastern front, and ideally a third to support the middle. If you don't have the Mermaid Priestess/Diviner in the eastern group, better send along a Shyde/Star.

Melusand told you that the black citadel was in the center of the island. It is, if by "center" you mean "north side". However, it is surrounded by mountains, so merfolk will be of no help there. If any undead come to the coast, then merfolk spellcasters could be helpful. There's a secret area off the northwest shore of the island that the merfolk could explore if they have nothing better to do. A wrecked ship is guarded by a Sea Serpent. Just South of the ship is a sunken treasure worth a little gold. We're really not worried about gold anymore, however. Northwest of the wreck is a sandbar containing another merman in a cage. Inside is a badly wounded Merman Triton. You can send him and the rest of your mermen east across the top of the board and then down to the orc leader.

You might reach the black citadel before finishing off the Orc. If so, victory conditions change: you will need to kill both the undead and orcish leaders before being able to open the door. After finishing them off, victory conditions change again: now get any unit to the door of the black citadel. Since you probably won't need ''everybody'' to take on the Orc, you may as well leave somebody near the citadel. When the door is open, there's some drama that ends up in having Kaleh, Nym, and Zhul go into the citadel to again face the apparition of Eloh. If your ally is still alive, he comes along as well.

== The Final Confrontation ==
Earlier I alluded to the fact that during this battle you won't be able to recruit. You come into a hexagonal cave/chamber that is partially paved and partly rock floor. It somewhat reminded me of "The Duel" scenario ending the Eastern Invasion campaign. It's just the people I mentioned in the last paragraph of the Zocthanol scenario: Kaleh, Nym, Zhul and possibly Grog or Rogrimir. The Apparition of Eloh will be in the front of you, and she will have charmed some of your young troops to use against you. The objective is to defeat the apparition, quite possibly the easiest objective ever. By all means have the ally go first, since he will move faster and defend better on the cavern floor. When i did it, Grog the Troll Warrior took her out in a single move: both swings connected and she was done.

While this may not be as emotionally satisfying as having Kaleh or Zhul finish her off, it has the beneficial effect of leaving more characters able to move to fulfill the second objective. The two recruits are freed from their charm, if you are able to keep them alive in this pit of despair. After the apparition is gone you get to see "the man behind the curtain" so to speak. The evil creature doing all this isn't a standard brand demon, but some relation to Cthulhu. Yechnagoth is composed of a brain (Central Body), energy source (Pulsing Spires), and multiple fists (Crawling Horrors.) Don't even waste your time attacking the Central Body yet. Note that the Spires are a different team than the others.

As long as the Pulsing Spires are alive, the Central Body has 100% resistance to any attack AND it fully heals every turn. Every turn it can attack any adjacent unit, spray slime [hurts 10-12 points and slows] on any unit in the cavern, AND summon one or more new Crawlers. There is no turn limit, but you want to hurry before you get overwhelmed by Crawling Horrors. Due to my lucky start, I was able to finish before turn 5. The Spires have no melee attack, so hammer them as you reach them. (Well, even their ranged attack is nothing to write home about.) Even though the paved parts of the floor all lead to the Central Body, try not to have any character end their turn next to it until the Pulsing Spires are gone. You might find yourself using the hedgehog again, with characters not actively attacking surrounding Zhul to heal up from the constant depredations of the Crawlers.

After you have taken out the third Spire, the Central Body becomes a Weakened Central Body, which is a much more reasonable opponent. The healing stops, and the hit points, resistances and attack damages drop. Again, two mighty hammer blows could finish it off. Congratulations! You've just won yourself a tropical paradise island!!

[[Category:Campaigns - Walkthroughs]]

User:Shadowm

2021-06-11T16:44:57Z

Shadowm: Replaced content with "== Subpages == These are mostly new or updated pages I'm working on at the moment (assuming I didn't forget about them), although they may also include other content of m..."

== Subpages ==

These are mostly new or updated pages I'm working on at the moment (assuming I didn't forget about them), although they may also include other content of my own.

{{Special:PrefixIndex/{{FULLPAGENAME}}/}}

Support

2021-05-28T10:27:44Z

Shadowm:

__NOTOC__
There are many ways to get help — from online documentation to support from the community on Discord, IRC or forums. If you are experiencing problems, you should consider [[ReportingBugs|reporting a bug]].

== Forums ==

<ul style="-moz-column-count:2;-webkit-column-count:2;column-count:2">
<li>[//forums.wesnoth.org/ Official Wesnoth forums]
<li>[[Glossary|Wesnoth Acronyms]] - forum lingo
<li>[http://www.wesnoth.cn Chinese wesnoth forums]
<li>[http://wif.altervista.org/index.php Wesnoth Italian Forums (W.I.F)]
<li>[http://www.wesnothlife.ru/forum/ Russian Wesnoth Forums (WesnothLife)]
<li>[http://www.wesnoth.com.pl/news.php Polish Wesnoth Website]
<li>[http://wesnoth.fsf.hu/ Hungarian Wesnoth Website]
<li>[http://www35.atwiki.jp/weswiki/ Japanese Wesnoth Website]
</ul>

== Discord ==

Wesnoth maintains a presence on Discord through its own [https://discord.gg/battleforwesnoth official Discord server]. Several channels are bridged to IRC in order to allow Discord and IRC users to interact with each other.

== IRC ==

IRC (Internet Relay Chat) is a time-tested communications system that offers greater flexibility and extensibility than modern chat platforms. For more information, check out [//en.wikipedia.org/wiki/Internet_Relay_Chat Wikipedia's article] and [http://www.irchelp.org/ IRCHelp.org].

Unless otherwise noted, all channels are hosted at the [https://libera.chat/ Libera.Chat] IRC network. If you don't have an IRC client installed or your firewall blocks ports 6667, 6697, and other [https://libera.chat/guides/connect supported ports], you can use [https://web.libera.chat Libera.Chat's web client] instead.

=== Main channels ===

* [irc://irc.libera.chat/%23wesnoth #wesnoth] This channel is for general conversation amongst Wesnoth players and developers.
* [irc://irc.libera.chat/%23wesnoth-umc-dev #wesnoth-umc-dev] The channel for questions and conversations related to Wesnoth content development, including WML and Lua coding.
* [irc://irc.libera.chat/%23wesnoth-offtopic #wesnoth-offtopic] The channel for social talk and discussion of subjects unrelated to Wesnoth.
* [irc://irc.libera.chat/%23wesnoth-dev #wesnoth-dev] The development discussion channel. Most contributors and developers (including artists, WML/Lua and C++ coders, and Wesnoth.org staff) hang around here, exchanging ideas and patches.

=== International channels ===


* [irc://irc.libera.chat/%23wesnoth-de #wesnoth-de] The German language channel, used mainly by players and translators.


Note: All public conversations on official Wesnoth channels are permanently logged at [https://irclogs.wesnoth.org/ <code>irclogs.wesnoth.org</code>]. This includes messages sent to IRC through the Discord bridge.

== Mailing Lists ==

* [https://mailman.wesnoth.org/listinfo/dev Dev] ([https://mailman.wesnoth.org/pipermail/dev/ archives]) The mailing list for discussing mainline development issues; it is not intended for bug reports or feature requests. See [[ReportingBugs]] for those.
* [https://mailman.wesnoth.org/listinfo/commits/ Commits] ([https://mailman.wesnoth.org/pipermail/commits/ archives]) All commits made to the mainline source repository are automatically posted to this list for those who want or need to keep track of them.
* [https://mailman.wesnoth.org/listinfo/i18n/ i18n] ([https://mailman.wesnoth.org/pipermail/i18n/ archives]) The internationalization (i18n) mailing list; all translation team maintainers and the i18n managers should subscribe and keep track of announcements and discussions taking place in this list.
* [https://mailman.wesnoth.org/listinfo/packagers/ Packagers] ([https://mailman.wesnoth.org/pipermail/packagers/ archives]) The packagers mailing list is used by the development team to notify packagers and distributors of new releases, along with information about changes to the processes of building or obtaining Wesnoth's source code.

[[Category:Troubleshooting and Bugs]]

Support

2021-05-28T10:22:34Z

Shadowm:

__NOTOC__
There are many ways to get help — from online documentation to support from the community on Discord, IRC or forums. If you are experiencing problems, you should consider [[ReportingBugs|reporting a bug]].

== Forums ==

<ul style="-moz-column-count:2;-webkit-column-count:2;column-count:2">
<li>[//forums.wesnoth.org/ Official Wesnoth forums]
<li>[[Glossary|Wesnoth Acronyms]] - forum lingo
<li>[http://www.wesnoth.cn Chinese wesnoth forums]
<li>[http://wif.altervista.org/index.php Wesnoth Italian Forums (W.I.F)]
<li>[http://www.wesnothlife.ru/forum/ Russian Wesnoth Forums (WesnothLife)]
<li>[http://www.wesnoth.com.pl/news.php Polish Wesnoth Website]
<li>[http://wesnoth.fsf.hu/ Hungarian Wesnoth Website]
<li>[http://www35.atwiki.jp/weswiki/ Japanese Wesnoth Website]
</ul>

== Discord ==

Wesnoth maintains a presence on Discord through its own [https://discord.gg/battleforwesnoth official Discord server]. Several channels are bridged to IRC in order to allow Discord and IRC users to interact with each other.

== IRC ==

IRC (Internet Relay Chat) is a time-tested communications system that offers greater flexibility and extensibility than modern chat platforms. For more information, check out [//en.wikipedia.org/wiki/Internet_Relay_Chat Wikipedia's article] and [http://www.irchelp.org/ IRCHelp.org].

Unless otherwise noted, all channels are hosted at the [https://libera.chat/ Libera.Chat] IRC network. If you don't have an IRC client installed or your firewall blocks ports 6667, 6697, and other [https://libera.chat/guides/connect supported ports], you can use [https://web.libera.chat Libera.Chat's web client] instead.

=== Main channels ===

* [irc://irc.libera.chat/%23wesnoth #wesnoth] This channel is for general conversation amongst Wesnoth players and developers.
* [irc://irc.libera.chat/%23wesnoth-umc-dev #wesnoth-umc-dev] The channel for questions and conversations related to Wesnoth content development, including WML and Lua coding.
* [irc://irc.libera.chat/%23wesnoth-offtopic #wesnoth-offtopic] The social and off-topic channel for miscellaneous talk and discussion of subjects not directly related to Wesnoth.
* [irc://irc.libera.chat/%23wesnoth-dev #wesnoth-dev] The development discussion channel. Most contributors and developers (including artists, WML/Lua and C++ coders, and Wesnoth.org staff) hang around here, exchanging ideas and patches.

=== International channels ===


* [irc://irc.libera.chat/%23wesnoth-de #wesnoth-de] The German language channel, used mainly by players and translators.


Note: All public conversations on official Wesnoth channels are permanently logged at [https://irclogs.wesnoth.org/ <code>irclogs.wesnoth.org</code>]. This includes messages sent to IRC through the Discord bridge.

== Mailing Lists ==

* [https://mailman.wesnoth.org/listinfo/dev Dev] ([https://mailman.wesnoth.org/pipermail/dev/ archives]) The mailing list for discussing mainline development issues; it is not intended for bug reports or feature requests. See [[ReportingBugs]] for those.
* [https://mailman.wesnoth.org/listinfo/commits/ Commits] ([https://mailman.wesnoth.org/pipermail/commits/ archives]) All commits made to the mainline source repository are automatically posted to this list for those who want or need to keep track of them.
* [https://mailman.wesnoth.org/listinfo/i18n/ i18n] ([https://mailman.wesnoth.org/pipermail/i18n/ archives]) The internationalization (i18n) mailing list; all translation team maintainers and the i18n managers should subscribe and keep track of announcements and discussions taking place in this list.
* [https://mailman.wesnoth.org/listinfo/packagers/ Packagers] ([https://mailman.wesnoth.org/pipermail/packagers/ archives]) The packagers mailing list is used by the development team to notify packagers and distributors of new releases, along with information about changes to the processes of building or obtaining Wesnoth's source code.

[[Category:Troubleshooting and Bugs]]

Support

2021-05-28T10:21:07Z

Shadowm:

__NOTOC__
There are many ways to get help — from online documentation to support from the community on Discord, IRC or forums. If you are experiencing problems, you should consider [[ReportingBugs|reporting a bug]].

== Forums ==

<ul style="-moz-column-count:2;-webkit-column-count:2;column-count:2">
<li>[//forums.wesnoth.org/ Official Wesnoth forums]
<li>[[Glossary|Wesnoth Acronyms]] - forum lingo
<li>[http://www.wesnoth.cn Chinese wesnoth forums]
<li>[http://wif.altervista.org/index.php Wesnoth Italian Forums (W.I.F)]
<li>[http://www.wesnothlife.ru/forum/ Russian Wesnoth Forums (WesnothLife)]
<li>[http://www.wesnoth.com.pl/news.php Polish Wesnoth Website]
<li>[http://wesnoth.fsf.hu/ Hungarian Wesnoth Website]
<li>[http://www35.atwiki.jp/weswiki/ Japanese Wesnoth Website]
</ul>

== Discord ==

Wesnoth maintains a presence on Discord through its own [https://discord.gg/battleforwesnoth official Discord server]. Several channels are bridged to IRC in order to allow Discord and IRC users to interact with each other.

== IRC ==

IRC (Internet Relay Chat) is a time-tested communications system that offers greater flexibility and extensibility than modern chat platforms. For more information, check out [//en.wikipedia.org/wiki/Internet_Relay_Chat Wikipedia's article] and [http://www.irchelp.org/ IRCHelp.org].

Unless otherwise noted, all channels are hosted at the [https://libera.chat/ Libera.Chat] IRC network. If you don't have an IRC client installed or your firewall blocks ports 6667, 6697, and other [https://libera.chat/guides/connect supported ports], you can use [https://web.libera.chat Libera.Chat's web client] instead.

=== Main channels ===

* [irc://irc.libera.chat/%23wesnoth #wesnoth] This channel is for general conversation amongst Wesnoth players and developers.
* [irc://irc.libera.chat/%23wesnoth-umc-dev #wesnoth-umc-dev] The channel for questions and conversations related to Wesnoth content development, including WML and Lua coding.
* [irc://irc.libera.chat/%23wesnoth-offtopic #wesnoth-offtopic] The social and off-topic channel for miscellaneous talk and discussion of subjects not directly related to Wesnoth.
* [irc://irc.libera.chat/%23wesnoth-dev #wesnoth-dev] The development discussion channel. Most contributors and developers (including artists, WML/Lua and C++ coders, and Wesnoth.org staff) hang around here, exchanging ideas and patches.

=== International channels ===


* [irc://irc.libera.chat/%23wesnoth-de #wesnoth-de] The German language channel, used mainly by players and translators.


Note: Public conversations on official Wesnoth channels are logged at [https://irclogs.wesnoth.org/ <code>irclogs.wesnoth.org</code>]. This includes messages sent to IRC through the Discord bridge.

== Mailing Lists ==

* [https://mailman.wesnoth.org/listinfo/dev Dev] ([https://mailman.wesnoth.org/pipermail/dev/ archives]) The mailing list for discussing mainline development issues; it is not intended for bug reports or feature requests. See [[ReportingBugs]] for those.
* [https://mailman.wesnoth.org/listinfo/commits/ Commits] ([https://mailman.wesnoth.org/pipermail/commits/ archives]) All commits made to the mainline source repository are automatically posted to this list for those who want or need to keep track of them.
* [https://mailman.wesnoth.org/listinfo/i18n/ i18n] ([https://mailman.wesnoth.org/pipermail/i18n/ archives]) The internationalization (i18n) mailing list; all translation team maintainers and the i18n managers should subscribe and keep track of announcements and discussions taking place in this list.
* [https://mailman.wesnoth.org/listinfo/packagers/ Packagers] ([https://mailman.wesnoth.org/pipermail/packagers/ archives]) The packagers mailing list is used by the development team to notify packagers and distributors of new releases, along with information about changes to the processes of building or obtaining Wesnoth's source code.

[[Category:Troubleshooting and Bugs]]

Support

2021-05-28T10:11:55Z

Shadowm:

__NOTOC__
There are many ways to get help — from online documentation to support from the community on Discord, IRC or forums. If you are experiencing problems, you should consider [[ReportingBugs|reporting a bug]].

== Forums ==

<ul style="-moz-column-count:2;-webkit-column-count:2;column-count:2">
<li>[//forums.wesnoth.org/ Official Wesnoth forums]
<li>[[Glossary|Wesnoth Acronyms]] - forum lingo
<li>[http://www.wesnoth.cn Chinese wesnoth forums]
<li>[http://wif.altervista.org/index.php Wesnoth Italian Forums (W.I.F)]
<li>[http://www.wesnothlife.ru/forum/ Russian Wesnoth Forums (WesnothLife)]
<li>[http://www.wesnoth.com.pl/news.php Polish Wesnoth Website]
<li>[http://wesnoth.fsf.hu/ Hungarian Wesnoth Website]
<li>[http://www35.atwiki.jp/weswiki/ Japanese Wesnoth Website]
</ul>

== Discord ==

Wesnoth maintains a presence on Discord through its own [https://discord.gg/battleforwesnoth official Discord server]. Several channels are bridged to IRC in order to allow Discord and IRC users to interact with each other.

== IRC ==

IRC (Internet Relay Chat) is a time-tested communications system that offers greater flexibility and extensibility than modern chat platforms. For more information, check out [//en.wikipedia.org/wiki/Internet_Relay_Chat Wikipedia's article] and [http://www.irchelp.org/ IRCHelp.org].

All of the following channels are hosted at the [https://libera.chat/ Libera.Chat] IRC network unless otherwise noted. If you don't have an IRC client installed on your machine or are behind a firewall that blocks ports 6667, 6697, and other [https://libera.chat/guides/connect supported ports], you can use [https://web.libera.chat Libera.Chat's web client] instead.

=== Main channels ===

* [irc://irc.libera.chat/%23wesnoth #wesnoth]: This channel is for general conversation amongst Wesnoth players and developers.
* [irc://irc.libera.chat/%23wesnoth-umc-dev #wesnoth-umc-dev]: The channel for questions and conversations related to Wesnoth content development, including WML and Lua coding.
* [irc://irc.libera.chat/%23wesnoth-offtopic #wesnoth-offtopic]: The social and off-topic channel for miscellaneous talk and discussion of subjects not directly related to Wesnoth.
* [irc://irc.libera.chat/%23wesnoth-dev #wesnoth-dev]: The development discussion channel. Most contributors and developers (WML, C++ and art people alike) hang around here, exchanging ideas and code patches.

=== International channels ===


* [irc://irc.libera.chat/%23wesnoth-de #wesnoth-de (German channel)]: The German look-alike of #wesnoth, mainly used by German-speaking players and translators.


Note: Public conversations on official Wesnoth channels are logged at [https://irclogs.wesnoth.org/ <code>irclogs.wesnoth.org</code>]. This includes messages sent to IRC through the Discord bridge.

== Mailing Lists ==

* [https://mailman.wesnoth.org/listinfo/dev Dev] ([https://mailman.wesnoth.org/pipermail/dev/ archives]): the mailing list for discussing mainline development issues; it is not intended for bug reports or feature requests. See [[ReportingBugs]] for those.
* [https://mailman.wesnoth.org/listinfo/commits/ Commits] ([https://mailman.wesnoth.org/pipermail/commits/ archives]): all commits made to the mainline source repository are automatically echoed in this list for those who want or need to keep track of them. This list is currently unused.
* [https://mailman.wesnoth.org/listinfo/i18n/ i18n] ([https://mailman.wesnoth.org/pipermail/i18n/ archives]): the internationalization (i18n) mailing list; all translation team maintainers and the i18n managers should subscribe and keep track of announcements and discussions taking place in this list.

[[Category:Troubleshooting and Bugs]]

Support

2021-05-23T03:14:27Z

Shadowm: /* Main channels */

__NOTOC__
There are many ways to get help. From online documentation to support from the community on IRC or forums.

== Wiki Resources ==
* [[Play|Online Players Guide]] - Game manual, walkthroughs, strategy guides, and more.
* [[Create|Content-Creation Guide]] - Manual showing how to create new campaigns for Wesnoth.
* [[StartingPoints|Starting Points]] - List of pages to serve as starting point for diving deeply into the wiki...
* [https://r.wesnoth.org/rules#w0mp Multiplayer Information] - Info about server moderators, useful MP commands, and our online Code of Conduct.
* [http://wiki.wesnothlife.ru/ Russian Wesnoth Wiki]

== Reporting Bugs ==
If you are experiencing problems, you should consider [[ReportingBugs|reporting a bug]].

== Community ==

Before asking for help with some technical problem in the official forums, please read [//forums.wesnoth.org/viewtopic.php?t=25660 How to report a bug properly] for instructions and pointers.

=== Forums ===
* [//forums.wesnoth.org/ Official Wesnoth forums]
* [[Glossary|Wesnoth Acronyms]] - forum lingo
* [http://www.wesnoth.cn Chinese wesnoth forums]
* [http://wif.altervista.org/index.php Wesnoth Italian Forums (W.I.F)]
* [http://www.wesnothlife.ru/forum/ Russian Wesnoth Forums (WesnothLife)]
* [http://www.wesnoth.com.pl/news.php Polish Wesnoth Website]
* [http://wesnoth.fsf.hu/ Hungarian Wesnoth Website]
* [http://www35.atwiki.jp/weswiki/ Japanese Wesnoth Website]

=== IRC ===
If you don't know what Internet Relay Chat (IRC) is, check out [//en.wikipedia.org/wiki/Internet_Relay_Chat Wikipedia's article] and [http://www.irchelp.org/ IRCHelp.org].

All of the following channels are hosted at the [https://libera.chat/ Libera.Chat] IRC network unless otherwise noted. If you don't have an IRC client installed on your machine or are behind a strict firewall that blocks [https://libera.chat/guides/connect Libera.Chat's supported ports], you can use a compatible Web IRC service such as [https://kiwiirc.com/nextclient/irc.libera.chat:+6697/ Kiwi IRC].

==== Main channels ====

* [irc://irc.libera.chat/%23wesnoth #wesnoth]: This channel is for general conversation amongst Wesnoth players and developers.
* [irc://irc.libera.chat/%23wesnoth-umc-dev #wesnoth-umc-dev]: The channel for questions and conversations related to Wesnoth content development, including WML and Lua coding.
* [irc://irc.libera.chat/%23wesnoth-offtopic #wesnoth-offtopic]: The social and off-topic channel for miscellaneous talk and discussion of subjects not directly related to Wesnoth.
* [irc://irc.libera.chat/%23wesnoth-dev #wesnoth-dev]: The development discussion channel. Most contributors and developers (WML, C++ and art people alike) hang around here, exchanging ideas and code patches.

==== International channels ====


* [irc://irc.libera.chat/%23wesnoth-de #wesnoth-de (German channel)]: The German look-alike of #wesnoth, mainly used by German-speaking players and translators.


You can also see the [http://irclog.wesnoth.org/ logs] of some official Wesnoth channels.

=== Mailing Lists ===
* [https://mailman.wesnoth.org/listinfo/dev Dev] ([https://mailman.wesnoth.org/pipermail/dev/ archives]): the mailing list for discussing mainline development issues; it is not intended for bug reports or feature requests. See [[ReportingBugs]] for those.
* [https://mailman.wesnoth.org/listinfo/commits/ Commits] ([https://mailman.wesnoth.org/pipermail/commits/ archives]): all commits made to the mainline source repository are automatically echoed in this list for those who want or need to keep track of them. This list is currently unused.
* [https://mailman.wesnoth.org/listinfo/i18n/ i18n] ([https://mailman.wesnoth.org/pipermail/i18n/ archives]): the internationalization (i18n) mailing list; all translation team maintainers and the i18n managers should subscribe and keep track of announcements and discussions taking place in this list.

[[Category:Troubleshooting and Bugs]]

Support

2021-05-23T00:17:17Z

Shadowm: /* IRC */

__NOTOC__
There are many ways to get help. From online documentation to support from the community on IRC or forums.

== Wiki Resources ==
* [[Play|Online Players Guide]] - Game manual, walkthroughs, strategy guides, and more.
* [[Create|Content-Creation Guide]] - Manual showing how to create new campaigns for Wesnoth.
* [[StartingPoints|Starting Points]] - List of pages to serve as starting point for diving deeply into the wiki...
* [https://r.wesnoth.org/rules#w0mp Multiplayer Information] - Info about server moderators, useful MP commands, and our online Code of Conduct.
* [http://wiki.wesnothlife.ru/ Russian Wesnoth Wiki]

== Reporting Bugs ==
If you are experiencing problems, you should consider [[ReportingBugs|reporting a bug]].

== Community ==

Before asking for help with some technical problem in the official forums, please read [//forums.wesnoth.org/viewtopic.php?t=25660 How to report a bug properly] for instructions and pointers.

=== Forums ===
* [//forums.wesnoth.org/ Official Wesnoth forums]
* [[Glossary|Wesnoth Acronyms]] - forum lingo
* [http://www.wesnoth.cn Chinese wesnoth forums]
* [http://wif.altervista.org/index.php Wesnoth Italian Forums (W.I.F)]
* [http://www.wesnothlife.ru/forum/ Russian Wesnoth Forums (WesnothLife)]
* [http://www.wesnoth.com.pl/news.php Polish Wesnoth Website]
* [http://wesnoth.fsf.hu/ Hungarian Wesnoth Website]
* [http://www35.atwiki.jp/weswiki/ Japanese Wesnoth Website]

=== IRC ===
If you don't know what Internet Relay Chat (IRC) is, check out [//en.wikipedia.org/wiki/Internet_Relay_Chat Wikipedia's article] and [http://www.irchelp.org/ IRCHelp.org].

All of the following channels are hosted at the [https://libera.chat/ Libera.Chat] IRC network unless otherwise noted. If you don't have an IRC client installed on your machine or are behind a strict firewall that blocks [https://libera.chat/guides/connect Libera.Chat's supported ports], you can use a compatible Web IRC service such as [https://kiwiirc.com/nextclient/irc.libera.chat:+6697/ Kiwi IRC].

==== Main channels ====

* [irc://irc.libera.chat/%23wesnoth #wesnoth]: This channel is for general conversation amongst Wesnoth players and developers.
* [irc://irc.libera.chat/%23wesnoth-dev #wesnoth-dev]: The development discussion channel. Most contributors and developers (WML, C++ and art people alike) hang around here, exchanging ideas and code patches.

==== International channels ====


* [irc://irc.libera.chat/%23wesnoth-de #wesnoth-de (German channel)]: The German look-alike of #wesnoth, mainly used by German-speaking players and translators.


You can also see the [http://irclog.wesnoth.org/ logs] of some official Wesnoth channels.

=== Mailing Lists ===
* [https://mailman.wesnoth.org/listinfo/dev Dev] ([https://mailman.wesnoth.org/pipermail/dev/ archives]): the mailing list for discussing mainline development issues; it is not intended for bug reports or feature requests. See [[ReportingBugs]] for those.
* [https://mailman.wesnoth.org/listinfo/commits/ Commits] ([https://mailman.wesnoth.org/pipermail/commits/ archives]): all commits made to the mainline source repository are automatically echoed in this list for those who want or need to keep track of them. This list is currently unused.
* [https://mailman.wesnoth.org/listinfo/i18n/ i18n] ([https://mailman.wesnoth.org/pipermail/i18n/ archives]): the internationalization (i18n) mailing list; all translation team maintainers and the i18n managers should subscribe and keep track of announcements and discussions taking place in this list.

[[Category:Troubleshooting and Bugs]]

DevelopersHome

2021-05-22T23:53:43Z

Shadowm:

== General Information ==
* Links
** [http://changelog.wesnoth.org Changelog] - the most recent changes made to the game
** [https://github.com/wesnoth/wesnoth/commits/master Latest commits] - Up-to-date commit messages

* Coding Guidelines
** [[Git_for_Wesnoth_Crash_Course]] - guide for contributors who are new to git
** [[HackingWesnoth]] - guide for programmers
** [[CodingStandards]] - for programmers
** [[DeveloperGuide]] - for those who received repository commit rights
** [[SoftwareTesting]] - for programmers

* Library documentation
** [http://cppreference.com C++ Reference]
** [http://www.boost.org/doc/ Boost documentation]

* Debugging Tips
** [[DebuggingWesnoth]]

== Tools and Packaging ==
* Supporting Websites
** [[WesnothRepository]] - accessing the source code
** http://gettext.wesnoth.org/ - gettext status
* Compiling and Building
** [https://github.com/wesnoth/wesnoth/blob/master/INSTALL.md Compiling Wesnoth] - how to compile Battle for Wesnoth (it's not hard)
* Packaging and Releasing
** [[ReleasingWesnoth]] - steps to follow to release a new version
* Documentation
** Doxygen - Documentation generator
* More stuff
** [[MaintenanceTools]] WMLLint, WMLIndent and WMLScope
** [[UsingGooglePerformanceTools]] to profile Wesnoth CPU and memory usage.

== I want to start coding, what can I do? ==
* [[EasyCoding]] - Bugs and features that are easy to implement for new coders
* [[NotSoEasyCoding]] - Bugs and features which are doable but lacking someone working on them
* [[GettingStarted]]
* [https://forums.wesnoth.org/viewtopic.php?f=12&t=34904 Frequently Proposed Ideas] - summary of past often-repeated forum discussions
* [[Glossary]]

== Game - Create content ==
* [[BuildingScenarios]] and related useful forum discussions:
** [http://www.wesnoth.org/forum/viewtopic.php?t=4188 Beginning Campaign Development]
** [http://www.wesnoth.org/forum/viewtopic.php?t=4301 A Balancing Act]
* [[ReferenceWML]]
* [[CompatibilityStandards#Deprecation_levels_-_When_to_remove_deprecated_features|DeprecationLevels]]

== Code documentation ==
* http://devdocs.wesnoth.org - generated code documentation
* AI
** [[Wesnoth_AI]] - Starting point for AI documentation
* Themes
** [[ThemeSystem]] - customizing the screen layout for the game and the editor
* Multiplayer
** [[WesnothdDesign]] - Guide to the design of wesnothd, the multiplayer server.
* Gui2 - The new Gui-Framework
** [https://devdocs.wesnoth.org/group__GUIWidgetWML.html Widgets]
** [[GUIToolkit]]
** [https://devdocs.wesnoth.org/GUILayout.html Layout]
** Gui2 WML
*** [https://devdocs.wesnoth.org/group__GUICanvasWML.html GUICanvas]
*** [https://devdocs.wesnoth.org/GUIToolkitWML.html GUIToolkit]
*** [https://devdocs.wesnoth.org/group__GUIWindowDefinitionWML.html WindowDefinitionWML]

== Communication, Feedback, Events ==
* http://bugs.wesnoth.org/ - bug reports and feature requests
* http://patches.wesnoth.org/ - patches/pull requests

* Mailing lists
** https://mailman.wesnoth.org

* IRC
** [irc://irc.wesnoth.org/#wesnoth-dev Libera.Chat/#wesnoth-dev] - IRC (alias to irc.libera.chat)
** http://irclog.wesnoth.org/ - IRC logs

* Forum - http://forum.wesnoth.org

* This wiki - http://www.wesnoth.org/wiki/Main_Page

* FOSDEM
** [[Fosdem2008]]
** [[Fosdem2009]]
** [[Fosdem2010]]
** [[Fosdem2011]]
** [[Fosdem2012]]

* Google Summer of Code
** [[SummerOfCodeIdeas]] - Ideas for GSoC
** [[SoC_Information_for_Google]] - Our organization profile for Google
** [[SoC_People_to_bug_on_IRC]] - Who GSoC students can ask for help

== Miscellaneous ==
* [[DebugMode]] and [[CommandMode]] - in game debugging commands
* [http://www.wesnoth.org/units/trunk/animations.html Missing unit animations] - what's available and what's missing
* http://units.wesnoth.org/ - Unit reference

[[Category:Development]]

UsefulLinks

2021-05-22T23:47:43Z

Shadowm:

__TOC__
{|class=wikitable
!colspan=2 style='text-align:left'|
=== Battle for Wesnoth ===
|-
|Home Page || http://www.wesnoth.org/
|-
|GitHub Project Page || https://github.com/wesnoth/
|-
|Page on TheLinuxGameTome || http://happypenguin.org/show?Battle%20for%20Wesnoth
|-
|Freshmeat entry || http://freshmeat.net/projects/wesnoth/
|-
|Changelog || http://changelog.wesnoth.org/ [http://stable-changelog.wesnoth.org stable]
|-
|This wiki || http://wiki.wesnoth.org/
|-
|The manual || http://manual.wesnoth.org/
|-
|Translation statistics || http://gettext.wesnoth.org/
|-
|Add-on server web interface || http://addonlist.wesnoth.org/ [http://stable-addons.wesnoth.org stable] [http://dev-addons.wesnoth.org dev]
|-
|Multiplayer server statistics || http://wesnothd.wesnoth.org/
|-
|Multiplayer replays || http://replays.wesnoth.org
|-
|Unit advancement tree || http://units.wesnoth.org/
|-
|Forum for users and developers || http://forums.wesnoth.org/ [http://forums.wesnoth.org/search.php?search_id=newposts new posts]
|-
|List of Frequently Proposed Ideas || https://forums.wesnoth.org/viewtopic.php?f=12&t=34904
|-
|IRC channel (Libera.Chat) || ircs://irc.libera.chat/#wesnoth
|-
|Discord server || https://discord.gg/battleforwesnoth
|-
|IRC logs || https://wesnoth.org/irclogs/
|-
|Twitter Account || https://twitter.com/Wesnoth
|-
!colspan=2 style='text-align:left'|
=== Developers ===
|-|Git web interface || https://github.com/wesnoth/wesnoth
|-
|Git homepage || http://git-scm.com/
|-
|Git documentation || http://git-scm.com/documentation
|-
|Code documentation || http://devdocs.wesnoth.org/
|-
|Mailing lists || https://mailman.wesnoth.org/
|-
|Bug/Feature tracker || http://bugs.wesnoth.org/
|-
|Patch tracker || http://patches.wesnoth.org/
|-
|ohloh statistics || http://www.ohloh.net/p/wesnoth
|-
|wesnoth.org server stats || http://collectd.wesnoth.org
|-
|IRC channel (Libera.Chat) || ircs://irc.libera.chat/wesnoth-dev
|-
!colspan=2 style='text-align:left'|

=== Other Links ===
|-
|1vs1 Wesnoth ladder || http://wesnoth.gamingladder.info/
|-
|Wesnoth matches with commentary || http://www.youtube.com/user/NekisBrutalWesnoth
|-
|Wesnoth campaign with commentary in german || https://www.youtube.com/playlist?list=PLc3DmuDuA2imW1vg9xXMNjGHm8VaXvEaz
|-
|WSNPP || http://wiki.wesnoth.org/WSNPP
|-
|Run Wesnoth online (Windows) || http://spoon.net/the-battle-for-wesnoth
|-
!colspan=2 style='text-align:left'|
=== Multilingual Players' Sites ===
|-
|Community in China || http://wesnoth.cn/
|}

[[Category:Wesnoth Wiki]]

WesCamp

2021-05-22T23:43:55Z

Shadowm:

''Note: WesCamp was a translation project, but activity stopped around 2014. Please follow the links in the See Also section for updated documentation.''

== If you are someone who just wants to translate ==

Then, simply go to http://gettext.wesnoth.org, and download the .po file of your chosen add-on and language. Then read the information '''for translators''' on this page here to know whom to tell what you are working on, and where to submit your translations.

=== Translators ===

Translating add-ons works the same as translating mainline. All of the information about this already exists in the wiki (see the links below). The files you need are located in the project’s [https://github.com/wescamp Github repositories] (they might take a bit of effort to locate. Alternatively, you can use [http://gettext.wesnoth.org gettext.wesnoth.org]). When they are translated, send them to [mailto:AI0867_AT_gmail.com AI/AI0867].

Before you start translating you should:
* Look at the subpage of the add-on you wish to translate to see if someone is already working on it.
* Contact the translation team for your target language for guidance.

If you have questions, join the [irc://irc.libera.chat/wesnoth #wesnoth] channel on the Libera.Chat IRC network and ask in there. Of course, you will also get answers if you ask your questions in the [http://forums.wesnoth.org/viewforum.php?f=7 Translations & Internationalization forum], or e-mail [mailto:AI0867_AT_gmail.com AI/AI0867].

== See Also ==

* [[GettextForWesnothDevelopers|GetText for Developers]] - how make code translatable (both mainline and UMC)
* [[GettextForTranslators|GetText for Translators]] - how to translate Wesnoth using [[GetText]]
* [[WesnothTranslations|Wesnoth Translations]]
* [[TranslatorsGuide|Translators' Guide]]
* [http://gettext.wesnoth.org Translation statistics]
* [https://github.com/wescamp WesCamp project at Github]
* [[Wescamp.py_Instructions|Wescamp for Maintainers]]

[[Category:Translations|*]]
[[Category:Campaigns]]

WesnothManual

2021-05-22T23:43:06Z

Shadowm:

This document is identical to the manual shipped with the game, thus it is protected from editing. To suggest improvements to the manual, make your changes to the [[ManualSuggestions|Manual Suggestions]].

== Available Languages ==

The HTML manual is available in various languages. To read the manual, just click the link of the language of your choice.

=== Stable version ===
* [https://www.wesnoth.org/manual/stable/manual.id.html Bahasa Indonesian]
* [https://www.wesnoth.org/manual/stable/manual.zh_TW.html Chinese (Traditional)]
* [https://www.wesnoth.org/manual/stable/manual.zh_CN.html Chinese (Zhongwen)]
* [https://www.wesnoth.org/manual/stable/manual.cs.html Czech]
* [https://www.wesnoth.org/manual/stable/manual.en_GB.html English (GB)]
* [https://www.wesnoth.org/manual/stable/manual.en.html English (US)]
* [https://www.wesnoth.org/manual/stable/manual.et.html Estonian]
* [https://www.wesnoth.org/manual/stable/manual.fi.html Finnish]
* [https://www.wesnoth.org/manual/stable/manual.fr.html French]
* [https://www.wesnoth.org/manual/stable/manual.gl.html Galician]
* [https://www.wesnoth.org/manual/stable/manual.de.html German]
* [https://www.wesnoth.org/manual/stable/manual.hu.html Hungarian]
* [https://www.wesnoth.org/manual/stable/manual.it.html Italian]
* [https://www.wesnoth.org/manual/stable/manual.ja.html Japanese]
* [https://www.wesnoth.org/manual/stable/manual.pl.html Polish]
* [https://www.wesnoth.org/manual/stable/manual.pt.html Portuguese]
* [https://www.wesnoth.org/manual/stable/manual.pt_BR.html Portuguese (Brazil)]
* [https://www.wesnoth.org/manual/stable/manual.ru.html Russian]
* [https://www.wesnoth.org/manual/stable/manual.sr.html Serbian]
* [https://www.wesnoth.org/manual/stable/manual.sr@latin.html Serbian (Latin transliteration)]
* [https://www.wesnoth.org/manual/stable/manual.sr@ijekavian.html Serbian (Ijekavian transliteration)]
* [https://www.wesnoth.org/manual/stable/manual.sr@ijekavianlatin.html Serbian (Ijekavian Latin transliteration)]
* [https://www.wesnoth.org/manual/stable/manual.sk.html Slovak]
* [https://www.wesnoth.org/manual/stable/manual.es.html Spanish]
* [https://www.wesnoth.org/manual/stable/manual.uk.html Ukrainian]
* [https://www.wesnoth.org/manual/stable/manual.vi.html Vietnamese]

=== Development version ===
* [https://www.wesnoth.org/manual/dev/manual.id.html Bahasa Indonesian]
* [https://www.wesnoth.org/manual/dev/manual.zh_TW.html Chinese (Traditional)]
* [https://www.wesnoth.org/manual/dev/manual.zh_CN.html Chinese (Zhongwen)]
* [https://www.wesnoth.org/manual/dev/manual.cs.html Czech]
* [https://www.wesnoth.org/manual/dev/manual.en_GB.html English (GB)]
* [https://www.wesnoth.org/manual/dev/manual.en.html English (US)]
* [https://www.wesnoth.org/manual/dev/manual.et.html Estonian]
* [https://www.wesnoth.org/manual/dev/manual.fi.html Finnish]
* [https://www.wesnoth.org/manual/dev/manual.fr.html French]
* [https://www.wesnoth.org/manual/dev/manual.gl.html Galician]
* [https://www.wesnoth.org/manual/dev/manual.de.html German]
* [https://www.wesnoth.org/manual/dev/manual.hu.html Hungarian]
* [https://www.wesnoth.org/manual/dev/manual.it.html Italian]
* [https://www.wesnoth.org/manual/dev/manual.ja.html Japanese]
* [https://www.wesnoth.org/manual/dev/manual.pl.html Polish]
* [https://www.wesnoth.org/manual/dev/manual.pt.html Portuguese]
* [https://www.wesnoth.org/manual/dev/manual.pt_BR.html Portuguese (Brazil)]
* [https://www.wesnoth.org/manual/dev/manual.ru.html Russian]
* [https://www.wesnoth.org/manual/dev/manual.sr.html Serbian]
* [https://www.wesnoth.org/manual/dev/manual.sr@latin.html Serbian (Latin transliteration)]
* [https://www.wesnoth.org/manual/dev/manual.sr@ijekavian.html Serbian (Ijekavian transliteration)]
* [https://www.wesnoth.org/manual/dev/manual.sr@ijekavianlatin.html Serbian (Ijekavian Latin transliteration)]
* [https://www.wesnoth.org/manual/dev/manual.sk.html Slovak]
* [https://www.wesnoth.org/manual/dev/manual.es.html Spanish]
* [https://www.wesnoth.org/manual/dev/manual.uk.html Ukrainian]
* [https://www.wesnoth.org/manual/dev/manual.vi.html Vietnamese]

== See Also ==
* [https://forum.wesnoth.org/ Official Wesnoth Forums]
* [https://discord.gg/battleforwesnoth Official Wesnoth Discord]
* [ircs://irc.libera.chat/wesnoth Official #wesnoth IRC channel on Libera.Chat]
* [[WesnothMan|wesnoth(6) man page]]
* [[ManualSuggestions|Manual Suggestions]] - If you have any ideas for improvements, post them here

{{Play}}

[[Category:Review on Release]]