==Wiki haiku==
Everyone sees it 
Collaborative effort 
Post on the wiki 

==Alternate version==
Everyone sees it 
Collaborative effort 
Post on my wiki 

==Alternate version literary commentary==
There has been some debate as to the true motive behind the recently unearthed alternate version of the only known piece of wiki haiku in existence. Some say that the author actually came up with the alternate version and intended the later version to be the true version. If this is true, it changes the spirit behind the work significantly, transforming it from an upbeat, candy-cane pump-up anthem for wikiness to a deeply personal glimpse into the author's sense of electronic loneliness. The switch from the impersonal article to the possessive pronoun could have also been a translation error, which has been known to occur when translators attempt to render the text in the vernacular from the original ASCII. Some say both versions were composed simultaneously or that the later version is actually the work of another author. Both possibilities pose tremendous difficulties to the infant field of wikihaikuitry. The implications of simultaneous composition are that the author in fact intended to generate controversy by publishing two versions -- sullying what is otherwise a beautiful work. The second challenges a long-held maxium: there has to this point only been one author of wiki haiku. For there to be more than one practitioner of wikihaikuitry without any of his or her work being published is a perplexing and disturbing possibility. Further scholarship is surely needed before the mystery of the alternate version is finally sorted out.

Farewell, 
Scott

WikiHaiku

2006-08-28T16:50:54Z

Scott:

WikiHaiku

2006-08-28T16:50:31Z

Scott:

==Wiki haiku==
Everyone sees it
Collaborative effort
Post on the wiki

==Alternate version==
Everyone sees it
Collaborative effort
Post on my wiki

==Alternate version literary commentary==
There has been some debate as to the true motive behind the recently unearthed alternate version of the only known piece of wiki haiku in existence. Some say that the author actually came up with the alternate version and intended the later version to be the true version. If this is true, it changes the spirit behind the work significantly, transforming it from an upbeat, candy-cane pump-up anthem for wikiness to a deeply personal glimpse into the author's sense of electronic loneliness. The switch from the impersonal article to the possessive pronoun could have also been a translation error, which has been known to occur when translators attempt to render the text in the vernacular from the original ASCII. Some say both versions were composed simultaneously or that the later version is actually the work of another author. Both possibilities pose tremendous difficulties to the infant field of wikihaikuitry. The implications of simultaneous composition are that the author in fact intended to generate controversy by publishing two versions -- sullying what is otherwise a beautiful work. The second challenges a long-held maxium: there has to this point only been one author of wiki haiku. For there to be more than one practitioner of wikihaikuitry without any of his or her work being published is a perplexing and disturbing possibility. Further scholarship is surely needed before the mystery of the alternate version is finally sorted out.

Farewell,
Scott

StartingPoints

2006-08-28T16:49:48Z

Scott: /* Other */

__NOTOC__
Battle for Wesnoth is a turn-based fantasy strategy game.

Defeat all enemy leaders using a well-chosen cadre of troops,
taking care to manage your resources of gold and villages.
All units have their own strengths and weaknesses; to win,
deploy your forces to their best advantage while
denying your foes the chance to do the same. As units gain
experience, they acquire new abilities and become more
powerful. Play in your own language and test your skill
against a smart computer opponent, or join Wesnoth's large
community of on-line players.
Create your own custom units, scenarios or campaigns,
and share them with others.

Battle for Wesnoth is released under the
[http://www.gnu.org/licenses/licenses.html#GPL GPL].
Prebuilt packages are available for most operating systems,
including Windows, Mac OS X, and GNU/Linux, or you can build
your own from source code.

== Getting the Game ==
==== Downloading ====
* [[Download]] - get the most recent source-files and many binaries
** [[WesnothBinaries]] - precompiled for GNU/Linux, BeOS, PDAs, ...
** [[WesnothBinariesLinux]] - precompiled for many GNU/Linux distributions

==== Compiling ====
* [[CompilingWesnoth]] - on Unix, Mac, Windows, GNU/Linux, PDAs, ...
* [[DebuggingWesnoth]] - on GNU/Linux and Unix-like systems
* [[WesnothOnLinuxPDAs]] - on the Qtopia/OPIE and thepdaXrom/Zaurus C series

== Playing the Game ([[Play]]) ==

==== For New Players ====
* [[GettingStarted]] - read me first!
* [[WesnothManual]] - the rules
* [[MainlineScenarios]] - walkthroughs for the game-supplied campaigns

==== For Not-So-New Players ====
* [[AdvancedTactics]] - beating the AI and other people
* [[MultiplayerServers]] - where to play against other people online

==== Reference ====
* [[HotKeysSystem]] - keyboard shortcuts
* [[CommandMode]] - commands you can use in-game
* [[ServerAdministration]] - commands that authenticated users can use to administer the server
* [http://wesnoth.slack.it/units.cgi Units] - Units advancement trees and stats
** [http://wesnoth.slack.it/units.cgi?page=frames Wesnoth Unit List] ([http://wesnoth.slack.it/units.cgi?page=list without frames])
** [http://wesnoth.slack.it/units.cgi?movetypes Movement, defense and resistance tables]
* [[RaceDescriptions]] - Elves, Humans, Dwarves, Orcs, Drakes, Undead, Others
** [[Complete_Faction_List_%28unfinished%29]] - list all user made factions
* [[WesnothAcronyms|Wesnoth Acronyms (by category)]] - common wesnothian acronyms explained
* [[WesnothAcronyms(alphabetic)|Wesnoth Acronyms (alphabetic)]] - common wesnothian acronyms explained

== Tweaking the Game ([[Create]]) ==

* [[UserScenarios]] - user-written scenarios, campaigns and game modifications
* [[ReferenceWML]] and [[AlphabeticalWML]] - all about Wesnoth Markup Language
* [[ReferencePythonAPI]] - upcoming Python interface for AI
* [[BuildingCampaigns]] - how to make your own single player campaigns
* [[MultiplayerCampaigns]] - how to make your own multiplayer campaigns
* [[BuildingScenarios]] - how to make your own scenarios
* [[BuildingUnits]] - how to make your own units
* [[UnitAnalysis]] - tool to analyze units
* [[WesnothMapEditor]] - summary of controls
* [[ExternalUtilities]] - scripts to help create scenarios, campaigns, and graphics
* [[Create_Art#Art_Tutorials|Art Tutorials]] - help in creating art
* [[GraphicLibrary]] - unit and terrain images posted on the forums
* [[Tiles_Status]] - terrain tiles: proposed and in progress.

== Improving the Game ==
* [[ReportingBugs]] - use Gna
* To submit a feature request, use http://bugs.wesnoth.org
* [[FrequentlyProposedIdeas]] - before you propose an idea, check here!
==== Developer information ====
* [[DeveloperResources]] - useful links
* [http://changelog.wesnoth.org Changelog] - the most recent changes made to the game
* [[WesnothSVN]] - accessing the source code
* [[HackingWesnoth]] - guide for programmers
* [[CodingStandards]] - for programmers
* [[UnitDescriptionRewriting]] - coordinating the revision
* [http://wesnoth.slack.it/missing.cgi Missing unit animations and sounds] - what's available and what's missing
* [[WritingYourOwnAI]] - write a C++ plugin
* [[ThemeSystem]] - customizing the screen layout for the game and the editor
* [[ReleasingWesnoth]] - steps to follow to release a new version
* [[WesnothPackagersGuide]] - guidelines for packaging Wesnoth for different platforms
* [[WesnothPreferences]]

==== Game translations ====
* [[GettextForTranslators]] - how to translate Wesnoth under [[GetText]]
* [[WesnothTranslations]] - 11 complete, 2 almost complete, 7 more than halfway, 10 partial
* [[WesCamp]] - a project for translating user-made campaigns

== About the Game ==
* [[WesnothPhilosophy]] - Dave on Wesnoth
* [[WesnothHistory]] - the Ages of Wesnoth
* [[WesnothGeography]] - description of Wesnoth and surrounding lands
* [[WesnothReviews]] - third party reviews of Wesnoth
* [irc://irc.wesnoth.org/wesnoth #wesnoth] - our IRC channel
* [[Donate]] or [http://cafepress.com/wesnoth buy Wesnoth merchandise].
* [[Trailer]] - the Wesnoth trailer

== Other ==
* [[UsefulLinks]]
* [[WesnothLSM]] - presentation at LSM
* [http://wesnoth.slack.it/?WesnothPlayerMap Map of Wesnoth player locations] - add yourself to the map!
* [http://en.wikipedia.org/wiki/Battle_for_Wesnoth Wikipedia entry for Wesnoth]
* [[WikiHaiku]]

== About this Wiki ==
* [[Help:Editing|Editing]] - learn how to edit pages
* [[Sandbox]] - experiment with the wiki
* [[WikiMigration]] - we were looking for a replacement for our old wiki (and ended up using Mediawiki)

StartingPoints

2006-08-28T16:49:38Z

Scott: /* Other */

__NOTOC__
Battle for Wesnoth is a turn-based fantasy strategy game.

Defeat all enemy leaders using a well-chosen cadre of troops,
taking care to manage your resources of gold and villages.
All units have their own strengths and weaknesses; to win,
deploy your forces to their best advantage while
denying your foes the chance to do the same. As units gain
experience, they acquire new abilities and become more
powerful. Play in your own language and test your skill
against a smart computer opponent, or join Wesnoth's large
community of on-line players.
Create your own custom units, scenarios or campaigns,
and share them with others.

Battle for Wesnoth is released under the
[http://www.gnu.org/licenses/licenses.html#GPL GPL].
Prebuilt packages are available for most operating systems,
including Windows, Mac OS X, and GNU/Linux, or you can build
your own from source code.

== Getting the Game ==
==== Downloading ====
* [[Download]] - get the most recent source-files and many binaries
** [[WesnothBinaries]] - precompiled for GNU/Linux, BeOS, PDAs, ...
** [[WesnothBinariesLinux]] - precompiled for many GNU/Linux distributions

==== Compiling ====
* [[CompilingWesnoth]] - on Unix, Mac, Windows, GNU/Linux, PDAs, ...
* [[DebuggingWesnoth]] - on GNU/Linux and Unix-like systems
* [[WesnothOnLinuxPDAs]] - on the Qtopia/OPIE and thepdaXrom/Zaurus C series

== Playing the Game ([[Play]]) ==

==== For New Players ====
* [[GettingStarted]] - read me first!
* [[WesnothManual]] - the rules
* [[MainlineScenarios]] - walkthroughs for the game-supplied campaigns

==== For Not-So-New Players ====
* [[AdvancedTactics]] - beating the AI and other people
* [[MultiplayerServers]] - where to play against other people online

==== Reference ====
* [[HotKeysSystem]] - keyboard shortcuts
* [[CommandMode]] - commands you can use in-game
* [[ServerAdministration]] - commands that authenticated users can use to administer the server
* [http://wesnoth.slack.it/units.cgi Units] - Units advancement trees and stats
** [http://wesnoth.slack.it/units.cgi?page=frames Wesnoth Unit List] ([http://wesnoth.slack.it/units.cgi?page=list without frames])
** [http://wesnoth.slack.it/units.cgi?movetypes Movement, defense and resistance tables]
* [[RaceDescriptions]] - Elves, Humans, Dwarves, Orcs, Drakes, Undead, Others
** [[Complete_Faction_List_%28unfinished%29]] - list all user made factions
* [[WesnothAcronyms|Wesnoth Acronyms (by category)]] - common wesnothian acronyms explained
* [[WesnothAcronyms(alphabetic)|Wesnoth Acronyms (alphabetic)]] - common wesnothian acronyms explained

== Tweaking the Game ([[Create]]) ==

* [[UserScenarios]] - user-written scenarios, campaigns and game modifications
* [[ReferenceWML]] and [[AlphabeticalWML]] - all about Wesnoth Markup Language
* [[ReferencePythonAPI]] - upcoming Python interface for AI
* [[BuildingCampaigns]] - how to make your own single player campaigns
* [[MultiplayerCampaigns]] - how to make your own multiplayer campaigns
* [[BuildingScenarios]] - how to make your own scenarios
* [[BuildingUnits]] - how to make your own units
* [[UnitAnalysis]] - tool to analyze units
* [[WesnothMapEditor]] - summary of controls
* [[ExternalUtilities]] - scripts to help create scenarios, campaigns, and graphics
* [[Create_Art#Art_Tutorials|Art Tutorials]] - help in creating art
* [[GraphicLibrary]] - unit and terrain images posted on the forums
* [[Tiles_Status]] - terrain tiles: proposed and in progress.

== Improving the Game ==
* [[ReportingBugs]] - use Gna
* To submit a feature request, use http://bugs.wesnoth.org
* [[FrequentlyProposedIdeas]] - before you propose an idea, check here!
==== Developer information ====
* [[DeveloperResources]] - useful links
* [http://changelog.wesnoth.org Changelog] - the most recent changes made to the game
* [[WesnothSVN]] - accessing the source code
* [[HackingWesnoth]] - guide for programmers
* [[CodingStandards]] - for programmers
* [[UnitDescriptionRewriting]] - coordinating the revision
* [http://wesnoth.slack.it/missing.cgi Missing unit animations and sounds] - what's available and what's missing
* [[WritingYourOwnAI]] - write a C++ plugin
* [[ThemeSystem]] - customizing the screen layout for the game and the editor
* [[ReleasingWesnoth]] - steps to follow to release a new version
* [[WesnothPackagersGuide]] - guidelines for packaging Wesnoth for different platforms
* [[WesnothPreferences]]

==== Game translations ====
* [[GettextForTranslators]] - how to translate Wesnoth under [[GetText]]
* [[WesnothTranslations]] - 11 complete, 2 almost complete, 7 more than halfway, 10 partial
* [[WesCamp]] - a project for translating user-made campaigns

== About the Game ==
* [[WesnothPhilosophy]] - Dave on Wesnoth
* [[WesnothHistory]] - the Ages of Wesnoth
* [[WesnothGeography]] - description of Wesnoth and surrounding lands
* [[WesnothReviews]] - third party reviews of Wesnoth
* [irc://irc.wesnoth.org/wesnoth #wesnoth] - our IRC channel
* [[Donate]] or [http://cafepress.com/wesnoth buy Wesnoth merchandise].
* [[Trailer]] - the Wesnoth trailer

== Other ==
* [[UsefulLinks]]
* [[WesnothLSM]] - presentation at LSM
* [http://wesnoth.slack.it/?WesnothPlayerMap Map of Wesnoth player locations] - add yourself to the map!
* [http://en.wikipedia.org/wiki/Battle_for_Wesnoth Wikipedia entry for Wesnoth]
* [WikiHaiku]

== About this Wiki ==
* [[Help:Editing|Editing]] - learn how to edit pages
* [[Sandbox]] - experiment with the wiki
* [[WikiMigration]] - we were looking for a replacement for our old wiki (and ended up using Mediawiki)

PblWML

2006-08-22T19:38:04Z

Scott: /* .pbl files */

{{WML Tags}}
== .pbl files ==

=== What is a .pbl file? ===
To upload a campaign you have made, you need a .pbl file.

This is a file with name '''data/campaigns/''campaign-name''.pbl'''. [http://exong.net/wesnoth-attach/files/pblexample_111.png Click here for an example of what we're talking about.]

When you upload a campaign, the file '''data/campaigns/''campaign-name''.cfg'''
and the directory '''data/campaigns/''campaign-name''/''' will be published.
Your campaign must be based entirely on these files.
This may cause your campaign not to upload properly,
for example, if you have custom campaign units in '''data/units/'''.
Be aware that translations in the .pbl-files are '''not''' working, so don't mark these strings translateable.

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

The following keys are recognized for .pbl files:
* ''icon'' an image, displayed leftmost on the "download campaigns" screen. It must be a standard Wesnoth graphic and not a custom one. (Well, a custom graphic will work if the user already has the campaign installed, or if it is a custom graphic from a different campaign that the user has installed.) (Note that the icon used to display your campaign for when it is played can be custom; for more information see [[CampaignWML]].)
* ''title'' displayed to the right of the icon, it is just text. It should usually be the same as the name of your campaign when it is played.
* ''version'' displayed to the right of the title, it is also just text. However the prefered format is x.y.z where x, y and z are numbers and x > 0 implies the campaign is complete and balanced.
* ''author'' displayed to the right of the version, it is also text. Put your name or nickname here. If several people have contributed significantly to the campaign you should list all of their names and perhaps describe what each person was responsible for.
* ''passphrase'' not displayed, it prevents others from modifying the version of your campaign on the campaign server. You do not need to input a passphrase when initially publishind a campaign; if you do not, one will be randomly generated for you.
* ''description'' is not displayed in the client. However it is visible on the web interface to the campaign server. It can be used to give a brief description of your campaign and for pre 1.0 versions let people know how playable it is.

Example:

title="My Campaign"
icon="misc/ball.png"
version="0.1.2"
author="Me, artwork by myself"
passphrase="This is like a password"
description="You get to kill a lot of bad guys. But only the first map is done."

The campaign server keeps track of some other information about uploaded campaigns, 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]].

== See Also ==

* [[ReferenceWML]]
* [[BuildingCampaignsThePBLFile]]
* [[CampaignServerWML]]

[[Category: WML Reference]]

Translatable

2006-08-08T18:58:57Z

Scott: /* Explanation */

== Explanation ==

Items marked with the text {{Translatable}} are WML strings that can be translated. Nearly every string that the player sees can be translated. A program called "gettext" automatically parses your WML files, seeks out strings marked as translatable, and compiles them into a translation template file. Translators can then use this file to create translations of the game into their languages.

-----

Please hit 'back' on your browser to return to the page you were reading or continue for examples.

-----

You, the scenario writer, must mark a string as translatable by including an underscore character "_" before the string starts. Here is an example.
Not translatable:
description="Baldras"

Translatable:
description= _ "Baldras"

When using strings in macros, include the underscore character with the actual text. Gettext does not know how to perform macro or variable substitution, so always keep the underscore with the string it marks.

Bad:
{VARIABLE message_text ("Hello, fair warrior!")}
[message]
message= _ $message_text
[/message]

Good:
{VARIABLE message_text ( _ "Hello, fair warrior!")}
[message]
message=$message_text
[/message]

== See Also ==

* [[SyntaxWML]]

Translatable

2006-08-08T18:58:11Z

Scott: /* Explanation */

== Explanation ==

Items marked with the text {{Translatable}} are WML strings that can be translated. Nearly every string that the player sees can be translated. A program called "gettext" automatically parses your WML files, seeks out strings marked as translatable, and compiles them into a translation template file. Translators can then use this file to create translations of the game into their languages.

-----

Please hit 'back' on your browser to return to the page you were reading or continue for examples.

-----

You, the scenario writer, must mark a string as translatable by including an underscore character "_" before the string starts. Here is an example.
Not translatable:
description="Baldras"

Translatable:
description= _ "Baldras"

When using strings in macros, include the underscore character with the actual text. Gettext does not know how to perform macro substitution, so always keep the underscore with the string it marks.

Bad:
{VARIABLE message_text ("Hello, fair warrior!")}
[message]
message= _ $message_text
[/message]

Good:
{VARIABLE message_text ( _ "Hello, fair warrior!")}
[message]
message=$message_text
[/message]

== See Also ==

* [[SyntaxWML]]

Translatable

2006-08-08T18:57:44Z

Scott: /* Explanation */

== Explanation ==

Items marked with the text {{Translatable}} are WML strings that can be translated. Nearly every string that the player sees can be translated. A program called "gettext" automatically parses your WML files, seeks out strings marked as translatable, and compiles them into a translation template file. Translators can then use this file to create translations of the game into their languages.

Please hit 'back' on your browser to return to the page you were reading or continue for examples.

You, the scenario writer, must mark a string as translatable by including an underscore character "_" before the string starts. Here is an example.
Not translatable:
description="Baldras"

Translatable:
description= _ "Baldras"

When using strings in macros, include the underscore character with the actual text. Gettext does not know how to perform macro substitution, so always keep the underscore with the string it marks.

Bad:
{VARIABLE message_text ("Hello, fair warrior!")}
[message]
message= _ $message_text
[/message]

Good:
{VARIABLE message_text ( _ "Hello, fair warrior!")}
[message]
message=$message_text
[/message]

== See Also ==

* [[SyntaxWML]]

Template:Translatable

2006-08-08T18:55:32Z

Scott:

([[Translatable|translatable]])

Translatable

2006-08-08T18:54:07Z

Scott: new page to explain translatable

=== Explanation ===

Items marked with the text {{Translatable}} are WML strings that can be translated. Nearly every string that the player sees can be translated. A program called "gettext" automatically parses your WML files, seeks out strings marked as translatable, and compiles them into a translation template file. Translators can then use this file to create translations of the game into their languages.

You, the scenario writer, must mark a string as translatable by including an underscore character "_" before the string starts. Here is an example.
Not translatable:
description="Baldras"

Translatable:
description= _ "Baldras"

When using strings in macros, include the underscore character with the actual text. Gettext does not know how to perform macro substitution, so always keep the underscore with the string it marks.

Bad:
{VARIABLE message_text ("Hello, fair warrior!")}
[message]
message= _ $message_text
[/message]

Good:
{VARIABLE message_text ( _ "Hello, fair warrior!")}
[message]
message=$message_text
[/message]

SideWML

2006-08-08T18:45:53Z

Scott: /* the [side] tag */

{{WML Tags}}
== the [side] tag ==

The [side] tag is used to describe a side in a particular scenario.

The following keys are recognized:

* ''side'' a digit. The leader of this side is placed on the tile represented by this digit (see [[BuildingMaps]]). When defining sides, they must be defined in order since the side number is checked against the number of sides seen so far.

* ''controller'' how moves for this side should be inputted.
** 'ai' the Wesnoth AI makes this side's moves. This is the default setting.
** 'human' a player controls this side's moves.
** 'null' the side doesn't get a turn to move and doesn't have a leader generated from the contents of the [side] tag. (It still can get units from [unit] tags in the [side] tag.)

* ''no_leader'' if "no" (default), then keys describing a unit which will begin on the side's keep will be described in the remainder of the '''[side]''' tag, See [[SingleUnitWML]]. Note that if the keys ''x'', ''y'' are included, the leader will begin there regardless of keep location. If this side has a recall list from a previous level, then the recall list will be searched for a leader (using canrecruit) and if one is found it will be used instead of the one described in the '''[side]''' tag.

* ''type'' the unit type of the side's leader. This must be present if ''no_leader'' is not set to "yes." ''Description'', ''type'', ''x'', ''y'', ''profile'', and ''hitpoints'' are examples of keys from [[SingleUnitWML]] that will describe the leader if placed within the [side] tag.

* ''description'' (translatable) the name of the side's leader. It is used in standard unit filter ([[FilterWML]]) and it is not affected by a player renaming a unit.

* ''unrenamable'' if "no" (default), the player can rename the unit. Renaming the unit alters the ''user_description'' key, so the ''description'' key can still be used for filtering. It is generally a good idea to set this to yes in campaigns since dialog will usually refer to the leader by name. It is technically possible to read ''user_description'' into a variable every time you want to call the leader by name, but this is a hassle.

* ''recruit'' a list of unit types. At the beginning of the scenario, the side gains recruitment of these units.

* ''gold'' the starting gold for this side. Default 100. (If gold is carried over from a previous scenario, this value is the minimum starting gold.)

* ''income'' the base income for this side, default 0. This is added to ''base_income'', '''[game_config]''' to determine the side's base income. (see [[GameConfigWML]]).

* ''fog'' if 'yes', this side cannot see any tiles it is not within vision of, except at the start.

* ''shroud'' if 'yes', this side cannot see any tiles it has not moved within sight of.

* ''shroud_data'' describes the area which this team has de-shrouded.

* ''persistent'' whether the side exists in any other scenarios. If '1'(yes), then ''save_id''(see below) becomes active for this side. Default '0'(no); when '''controller=human''', this is always '1'.

* ''save_id'' default ''description'' if available, 'Unknown' otherwise. The ID of the side with respect to the previous and next scenarios. Used to carry over the side's recall list (including the side's leader), recruitment list, and starting gold from scenario to scenario. Also used for the side's displayed name in the victory gold-calculation dialog.

* ''allow_player'' if equal to 'no', then the game creation will not allow this player to be modified. {{DevFeature}}

* ''team_name'' a non translatable string representing the teams description. Sides with the same team_name are allied. Default ''side''.

* ''user_team_name'' a translatable string representing the teams description. This has no effect on alliances. Default ''team_name''.

* ''colour'' if you want side 4 to be the same colour as side 2 normally is, put colour=2.
** The default list of numbers and corresponding colors can be found in data/team_colors.cfg.

* ''flag'' a custom flag animation to use instead of the default one to mark captured villages.
** Example animation that has three frames and loops every 750ms: ''flag=misc/myflag-1.png:250,misc/myflag-2.png:250,misc/myflag-3.png:250''

* ''village_gold'' the amount of gold given to this side per village it controls per turn. Default specified in ''village_gold'', '''[game_config]''' ([[GameConfigWML]]).

* ''share_maps'' whether sides allied with this side see all terrains that this side sees, if they are on shroud.

* ''share_view'' whether sides allied with this side see the units that this side sees, if they are on FoW (fog).

* ''name'', ''id'', ''leader'' not used; see [[EraWML]].

* ''music'' music to play for this player. Default specified in [scenario] (see [[ScenarioWML]]).

* '''[ai]''' if '''controller=ai''', gives parameters to the AI. See [[AiWML]].

* '''[village]''' describes a village the side begins in control of.
** ''x'', ''y'' the location of the village.

* '''[unit]''' describes a unit which begins on the side. See [[SingleUnitWML]]. If the side has a recall list and the unit is not given a location, it will start on the recall list. Note that the ''side'' attribute under '''[unit]''' will be ignored, as the side will come from the ''side'' attribute of '''[side]'''.

== See Also ==
* [[EraWML]]
* [[ScenarioWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

Download

2006-07-29T11:31:41Z

Scott: /* Development */

Welcome to the Battle for Wesnoth downloads page. The BFW project team only officially releases the source code. Binary packages are only provided by community volunteers and hosted here.

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.2C_etc..5D.3F|FAQ]].

__NOTOC__
Jump to: [[Download#Stable_.281.0.x_branch.29|Stable Branch]] | [[Download#Development|Development Branch]]

== Stable (1.0.x branch) ==
The stable files are meant to be used as a stable and rather balanced version of the game. Each version of the 1.0.x branch is compatible to each other. This will not happen in the development branch.

Version 1.0.2 is the latest stable version, updated with several important bugfixes. This version is recommended for most players since the 1.0.x online multiplayer community is very large and user-made campaign server has a robust content selection.

==== Source code ====
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-1.0.2.tar.gz?download Current stable version] (1.0.2, 38.2 MB)
* [[CompilingWesnoth|Compiling Guide]] - how to compile the source code

==== [[BeOS]] ====
* [http://prdownloads.sourceforge.net/wesnoth/Wesnoth-1.0.2-BeOS-x86.pkg.zip?download Current stable version] (1.0.2, 42.3MB)

==== GNU/Linux ====
* There are specific 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 informations about the binaries for your Distribution.

==== Mac OS X ====
* [http://prdownloads.sourceforge.net/wesnoth/Wesnoth_MacOSX_1.0.2.dmg?download Current stable version] (1.0.2, PPC, 53.6 MB)
* [http://lwa.retiaire.org/wesnoth/Wesnoth_MacOSX_1.0.2-lwa.dmg Current stable version - alternate] (1.0.2, PPC, 44MB)
* [http://lwa.retiaire.org/wesnoth/Wesnoth_MacOSX_1.0.2_lite-lwa.dmg Current stable version - lite] (1.0.2, PPC, no art or music, 25MB)

==== MS Windows ====
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-windows-1.0.2.exe?download Current stable version] (1.0.2, 37.0MB)

==== FreeBSD ====
* /usr/ports/games/wesnoth (1.0.1, 37.3MB)

==== Miscellaneous ====
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-1.0.2.tar.gz.md5?download Source code md5sum]
* [http://prdownloads.sourceforge.net/wesnoth/Wesnoth-1.0.2-BeOS-x86.pkg.zip.md5?download BeOS md5sum]
* [http://www.wesnoth.org/wiki/Download_Xdeltas#Source_code Xdelta for the source code]
* [http://www.wesnoth.org/wiki/Download_Xdeltas#MS_Windows Xdelta for the Windows binary]

== Development ==
Version 1.1.8 is the latest development version, boasting updated graphics and new exciting features. However, there may be occasional bugs or performance problems in the development versions since heavy changes are taking place all the time. For balanced and stable gaming, it is recommended you use the latest version of the 1.0.x branch. This version is recommended for coders and campaign developers, as well as those who want to preview the future of Wesnoth.

==== Source code ====
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-1.1.8.tar.gz?download Current Version] (1.1.8, 70 MB)
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-1.1.7.tar.gz?download Previous Version] (1.1.7, 70 MB)
* [[CompilingWesnoth|Compiling Guide]] - how to compile the source code

==== MS Windows ====
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-1.1.8_windows.exe?download Current Version] (1.1.8, 58.7 MB)
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-1.1.7-windows.exe?download Previous Version] (1.1.7, 58.1 MB)

==== Mac OS X ====
* [http://prdownloads.sourceforge.net/wesnoth/Wesnoth_MacOSX_1.1.8.dmg?download Current Version] (1.1.8, Universal, 73.2MB) ([http://www.wesnoth.org/forum/viewtopic.php?t=12237&start=11 note for Japanese players])
* [http://prdownloads.sourceforge.net/wesnoth/Wesnoth_MacOSX_1.1.8_lite.dmg?download Current version - lite] (1.1.8, Universal, no art or music, 43.3MB)
* [http://prdownloads.sourceforge.net/wesnoth/Wesnoth_MacOSX_1.1.7.dmg?download Previous Version] (1.1.7, Universal, 69MB)
* [http://prdownloads.sourceforge.net/wesnoth/Wesnoth_MacOSX_1.1.7_lite.dmg?download Previous version - lite] (1.1.7, Universal, no art or music, 39MB)

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

==== AmigaOS4 ====
* [http://www.amigasoft.net/downloads/Wesnoth.lzh Current Version] (1.1.7, 79MB)

==== OS/2 & eComStation ====
* [http://download.smedley.info/wesnoth-1.1.8-os2.zip Current Version] (1.1.8, 66MB)

==== Miscellaneous ====
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-1.1.5.tar.gz.md5?download md5sum for current source code]
* [http://www.wesnoth.org/wiki/Download_Xdeltas#Source_code Xdelta for the source code]
* [http://sourceforge.net/project/showfiles.php?group_id=89495 SourceForge page for current and all previous versions]

== License ==
This program is free software; you can redistribute it and/or modify it under the terms of the [http://www.fsf.org/copyleft/gpl.html GNU General Public License version 2], as published by the [http://www.fsf.org/ Free Software Foundation].
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.

== See also ==
* [http://changelog.wesnoth.org Changelog]
* [[WesnothBinaries| More binaries]]
* [[WesnothSVN]] - bleeding edge version from SVN

FAQ

2006-07-08T08:07:38Z

Scott: text cleanup for VH's additions

=Frequently Asked Questions=

== General ==

===What is Battle for Wesnoth?===
Battle for Wesnoth is a fantasy turn-based strategy game.

===What license is the game distributed under?===
The project is distributed under the [http://www.fsf.org/copyleft/gpl.html GPL]. All contributors retain copyright on the portions of the project that they contribute.

===How to get informed about new releases?===
Subscribe to new releases at [http://freshmeat.net/subscribe/38720/?url=%2Fprojects%2Fwesnoth%2F Freshmeat].

===A new version is out, but where is the download for [Windows, Mac OS, etc.]?===
The downloads are NOT part of the official project. The BFW team only releases the game's source code. Binary executables or applications are always contributed by community volunteers. If not for these volunteers, there would never be any downloads for us to enjoy. The volunteers compile the game and upload it on their own time, and sometimes they cannot do this in a timely fashion (or at all, at times) Although there are usual packagers designated for each operating system, there are times when other members of the community are asked to step in and contribute when the usual people cannot.

Every time a new version is released, the usual volunteers are always notified by the project leaders. '''Please refrain from making forum posts asking where your download is''' because it doesn't help anything - the packagers already know, and they will get to it as soon as they can. In the past, the Windows and Mac communities have come together to produce home-grown unofficial builds for the community to use, and the renewed interest in community and learning how to compile is generally a good thing.

===Why doesn't Wesnoth have my favorite feature?===
Because we are building this game for ourselves, to suit our own preferences. We're not building the game for you, in large part because this is our hobby, not our job; whether you like it or not is immaterial to us.
You may wonder, then, what the point is of soliciting ideas, as we do on the forum. We, the developers, have certainly come up with many good ideas on our own, but our players often do as well, and generally ones we don't think of ourselves. If a player comes up with an idea we like, we might implement it. Not because they asked for it, but because of its own merits as an addition to our game.

The beautiful thing about the license our game is distributed under, as compared to closed-source, commercial games, is that if you want that feature badly enough, you can take the code and art of our game and modify it yourself; you are free to re-use any work in Wesnoth, as long as you follow the rules of the [http://www.fsf.org/copyleft/gpl.html GPL]. From this, you can build a game exactly the way that you like. Just don't expect us to build that game for you. Building this game is our hobby, not our profession, and you did not pay us to make it; rather, we are the ones who have paid for it, in time and labor.

===Do you want help making this game? How can I help?===
Yes, we want your help. Whether you're a programmer, artist, musician, writer, translator, level designer, playtester, or just have some great suggestions, you're welcome to contribute. How? You can:
* join the [http://www.wesnoth.org/wiki/Project Project]
* share your point of view at the [http://www.wesnoth.org/forum/ Forum]
* talk with us on [irc://irc.wesnoth.org/wesnoth IRC]
* report bugs you find at [[ReportingBugs]]
* update the wiki
* play against us via the Multiplayer menu
* vote for Wesnoth at your favorite gaming web site
* Spread the word!

=== What are the system requirements? ===

We are not completely certain, but an x86 running at 600MHz with 128MB RAM should be adequate. Slower machines will have trouble scrolling large maps or processing AI turns with many units. See the [http://www.wesnoth.org/forum/viewtopic.php?t=7384 forum thread] about minimum and recommended system requirements.

=== I'm bored; how do I speed the game up? ===

There are several preferences you can change to shorten the time that the AI takes to make its moves. "Accelerated Speed" will make units move and fight faster. "Skip AI Moves" will not show the AI's units moving from hex to hex. Finally, you can turn off all combat animations via the "Show Combat" option on the Advanced tab.

=== My computer is too slow; how do I speed the game up? ===

First, turn off the music and sound effects. Turning off the color cursors will make your cursor respond faster. If scrolling the map is slow, run the game in "Full Screen" mode, not in a window. Turn off combat animations via the "Show Combat" option on the Advanced tab. You can try turning off halos and combat results, but this might make gameplay more difficult.

== Gameplay and Controls ==

=== How do I learn to play? ===

If you just want to jump right in, start the game and play the tutorial. If you like reading documentation, see [[WesnothManual]], which is also distributed as a PDF file. At any time while playing, you can select help from the menu button (or hit F1). The online help is quite extensive and provides information on terrains, weapons, traits, abilities, units and a good overview of how to play.

=== My unit leveled up but didn't improve. What happened? ===

This is called "After Maximum Level Advancement" or AMLA for short. While most level 0, 1, and 2 units can advance, some cannot. However, some level 3 units can advance to level 4, or even 5. You can see whether a unit can advance further by right clicking and selecting "description."

After a unit reaches the highest level it can get, every time it gains 100 experience it gains 3 hitpoints. It does not heal when this happens. This is a minor bonus so that experience gained by maxed out units is not altogether wasted. It is generally better to give experience to lower level units, rather than continue to advanced units that have reached their maximum level.

If the unit in question is the Necrophage, this is not a bug. The Necrophage eats the corpses of the dead, allowing it to periodically completely heal. Leveling into itself is how this is carried out.

=== I tried to trap an enemy with several weak units, but it still escaped. What happened? ===

Most units exert a zone of control (or ZOC). IF an enemy moves into one of the six adjacent hexes, the zone of control will prevent it from moving any farther. However some weak units are level 0, meaning they are so weak that they do not have a ZOC. You can still surround an enemy unit entirely with level 0 units to keep it from escaping, but if there is any gap in your ranks, it could escape.

Also, some units have the "skirmish" ability, which allows them to ignore ZOCs.

=== How can I see where an enemy unit can move next turn? ===

During you turn you can click on an enemy unit. Wesnoth will highlight all the hexes the unit can move to in the next turn. This is useful when trying to arrange your units to block an enemy's movement.

=== There's too much luck in this game! ===

Sooner or later, you will become frustrated when your archmage with four 70% attacks misses all four times. This does not mean that the AI is cheating or the random number generator is futzed. It means you are noticing random negative events more than positive ones. During the development of the game, many mathematicians have done sophisticated statistical analysis of the combat system. Likewise, programmers have examined the random number generator. Wesnoth has been deliberately designed so that the streaks of "bad" and "good" luck are a part of the gameplay.

Since Wesnoth is GPLed, it is possible that, after the 1.0 release, a new development team will "fork" the source and produce a version more like Heroes of Might & Magic, with no randomness. Until then, don't charge with your horsemen against rock trolls at night...

=== The (random unit) is overpowered/underpowered! ===

The development team has spent years tweaking the units in the game. Each unit has had its gold cost, attack types, combat damage, defensive values, resistances, upgrade paths, and other stats carefully scrutinized and loudly discussed in the forum. However, the game code and the units were being modified right up until the 1.0 release, so some unbalanced units may have slipped through.

If you have evidence to back up your claim, search the forum for past discussions about this unit, and then try posting.

=== The (random scenario) is too hard/easy! ===

See above answer about random units.

=== What do the different difficulty levels do? ===

That depends on the scenario. Usually, the opponent will get more money and be able to recruit higher-level units at higher difficulty levels, and you will have fewer turns available.

== Maps, Scenarios and Campaigns ==

=== How do I beat scenario _______ ? ===

If you are stuck on a scenario in a campaign, you'll probably find a walkthrough at [[MainlineScenarios]]. Or check out the "Strategies and Tips" forum at http://www.wesnoth.org/forum/viewforum.php?f=3

=== Are there any tools to help me create maps and scenarios? ===
Yes, there is a tool called wesnoth_editor. It is a normal map-editor that should be a good help for creating the plain maps. For creating the scenarios there already is a scenario-editor included in the mac build. But this editor is rather outdated and it exists only for MacOS X. At the moment some community members are working on creating a nice and working scenario editor. You can have a look at the [http://www.wesnoth.org/forum/viewtopic.php?t=6925 forum post] about this tool. You will also find more info at [[CampGen]].

=== How do I download user campaigns? ===
Choose "Campaigns" in the main Wesnoth menu. Then scroll down to the bottom and choose "Get More Campaigns..." or since 1.1.5 there is a "Get add-ons" button in the main menu. This connects you to the campaign server. In the campaign server you can view a list of all available campaigns and download them, as well as posting or deleting your own campaigns.

If you are behind a firewall you may not be able to connect to the campaign server. In this case try to download the campaign directly from the campaign server through the web interface at http://campaigns.wesnoth.org. If you know how to change your firewall settings, then you should open port 15003 (version 1.1.1 and up) or port 15002 (versions 1.1.0 and lower). For added security, you can restrict traffic over those ports to the campaign server's IP address (currently 129.241.104.165).

=== I already created a campaign and published it on the campaign server. How can I get translations for the campaign? ===
Just have a look at [[WesCamp]]. This project is the easiest way to get translations for your campaign. All the info you need you can find at [[WesCamp]].

===How do I place an object or unit on my map with the map editor?===
You can't. You need to make a multiplayer scenario file. There are more details on the [[BuildingMaps|maps]] page.

== Multiplayer ==

===How do i connect to a multiplayer server, when i sit behind a restrictive Firewall?===
You have to open port 14999 to play multiplayer games over the internet. For added security, you can restrict access to the server's IP address (currently 84.207.24.9 for the official server).

===How to find players for multiplayer game?===
Hang around for a while on multiplayer servers and you might find someone to play with. If you observe other people playing you will get informed when someone joins the servers. Maybe you find someone willing to play in the irc channel dedicated to mp: #wesnoth-mp at irc.freenode.net.
You can also join #wesnoth at irc.freenode.net.

===How can I make my computer into a dedicated Wesnoth server?===

To setup a dedicated Wesnoth server, you have to compile the game with the "--enable-server" flag, and after you install, simply run wesnothd from the console. This will start the server, listening on TCP port 15000. To compile the server only you can use the flags "--disable-game --enable server". If you aren't using a linux or mac operating system, there are a few ways you can compile on Windows...here is one way http://www.wesnoth.org/wiki/CompilingWesnoth/CrossCompiling

===Which versions of Wesnoth can play together?===

I'm on a MAC, and my friends are on XP. I would like to play together with them. Is this currently possible?

YES! All you need is to have the same version number.

For a list of Mac-XP-compatible games (including BfW) see: http://www.insidemacgames.com/forum/index.php?showtopic=21818

== Translations ==

===I selected an asian translation and am not able to see the letters correctly. What happened?===

Since the size of the necessary fonts is too large, you'll need to download them separately (if you don't already have them). After that, simply copy the font to the '''fonts/''' directory in your wesnoth installation.
* Chinese font: [ftp://cle.linux.org.tw/pub/fonts/ttf/unicode/Arphic/gkai00mp.ttf gkai00mp.ttf]
* Japanese font: [http://cvs.sourceforge.jp/cgi-bin/viewcvs.cgi/sqs-xml/sqs-font/sazanami-gothic.ttf sazanami-gothic.ttf]

If you have futher questions have a look at [[WesnothAsianLanguages|this]] page.

== Other Questions You Have ==

The best way to get answers to less-frequently asked questions is by visiting the [http://www.wesnoth.org/forum BFW forum]. There are plenty of people willing to help. Make sure you read ALL of the forum sticky notes and announcements before posting.

SpellingMistakes

2006-07-08T07:47:33Z

Scott: /* The Rise of Wesnoth */

This page is meant to be a list for mistakes in campaigns and other texts in the en_US version of the game.

==Eastern Invasion==
The Outpost, line 120 col 54: "Dacyn's return during in two days". "during" should be deleted. 
The Escape Tunnel, line 174 col 61 and line 180 col 61: "I advise you join us". Should be "I advise you to join us". 
Northern Outpost, line 129 col 138: "the Northlands, were we may". "Were" should be "where". 
Evacuation, line 340 col 68: "an chance of success". "an" should be "any". 
Evacuation, line 344 col 40 : "But is appears we will" should be "But it appears we will"

==Heir to the Throne==
* Snow Plains, line 115, col 93: "as an envoy from we North Elves". "we" should be "us".
* Test of the Clan, line 380, col 50: "the easten plains". "easten" should be "eastern".
* Blackwater Port, line 179: "I offer you my support Konrad, and the support of my men" should be "I offer you my support, Konrad, and the support of my men"
* Swamp Of Dread, line 249: "It is is clear" should have one "is" 
* Home of the North Elves, line 24: "Konrad must reach the elvish forest and resist until the end of turns": the objective has changed to resist until the end of the turn. Don't forget! 
* Elven Council, line 110: "How quickly do the race of men mature!": do should be does.
* Plunging Into the Darkness, line 596: "if you most go on with this mad scheme", most -> must.

==The Rise of Wesnoth==

Rise of Wesnoth, line 430: "All life is finite," should have a semi-colon to avoid a run-on sentence 
The Ka'lain, line 305: "you place" -> "your place" 

==The South Guard==
Born to the Banner, line 437 col 50: "intellegent". Should be "intelligent". 
Proven by the Sword, line 238 col 50: "intellegent". Should be "intelligent". 
A Desperate Errand, line 203 col 50: "recieved". Should be "received". 
Vale of Tears, line 182 col 92: "sacking out towns". "out" should be "our". 
Choice in the Fog, line 230 col 76: "whatever enemies lay beyond". "lay" should be "lie". 
Choice in the Fog, line 661 col 121: "you and you men". Second "you" should be "your". 
Tidings Good And Ill, line 336 col 42: "belive". Should be "believe". 
Into the Depths, line 148 col 53: "less valuable in caves that toughness". "that" should be "than". 
Into the Depths, line 384 col 61: "and lite it". "lite" should be "light". 
Into the Depths, line 499 col 51: "The elves I once lead". "lead" should be "led". 
units/4.Infantry_Commander.cfg, line 21 col 48: "infantry Wesnoth". Should be "infantry of Wesnoth". 
utils/sg_story.cfg, line 11 col 263: "men build new towns". "build" should be "built".

==Two Brothers==
Rooting Out a Mage, line 240 col 51: "two day's ride north". "day's" should be "days'". 
The Chase, line 376, col 266: "endevours". Should be "endeavours". 
Guarded Castle, line 442 col 77: "I can count hundred". Should be "I can count a hundred". 
Return to the Village, line 184 col 114: "It was noone here to stop them". "It" should be "There". 
Return to the Village, line 224 col 90: "fixing the damages". Should be "fixing the damage". 
Return to the Village, line 229 col 122: "to face another grim foe to face". "to face" should appear only once.

==Under the Burning Suns==
02 Across the Harsh Sands, line 1416 col 29: "Ogre Ambush". "ambush" should not be capitalised. 
02 Across the Harsh Sands, line 1424 col 21: "Fresh Meat". "meat" should not be capitalised. 
04 Descending Into Darkness, line 1318 col 34: "squirling". Should be "squirreling". 
05 A Subterranean Struggle, line 2251 col 29: "Burn, Burn and Die". Wrongly capitalised: should be "Burn, burn and die". 
05 A Subterranean Struggle, line 2436 col 45: "Help Me". Should be "Help me". 
05 A Subterranean Struggle, line 2452 col 56 and line 2545 col 52: "Fall Back". Should be "Fall back". 
05 A Subterranean Struggle, line 3131 col 40: "I thought that what". Should be "I thought that was what". 
05 A Subterranean Struggle, line 3136 col 320: "trolls secret weapon". "trolls" should be "trolls'". 
05 A Subterranean Struggle, line 3227 col 47: "was was". Should be only one "was". 
06.1 Hunting Trolls, line 781 col 140: "I will once you finish". Should be "I will return once you finish". 
06.2 In the Domain of the Dwarves, line 1325 col 103 and line 1334 col 103: "the maybe". "the" should be "then". 
06.2 In the Domain of the Dwarves, line 1529 col 13: "Good Riddance". Should be "Good riddance". 
06.2 In the Domain of the Dwarves, line 2103 col 94: "shant". Should be "shan't". 
07.1 Dealing with Dwarves, line 604 col 103: "thorne". Should be "thorn". 
07.1 Dealing with Dwarves, line 647 col 121: "cowards's". Should be "coward's". 
07.2 Talking with Trolls, line 646 col 135: "greatful". Should be "grateful". 
08 Out of the Frying Pan, line 1277 col 101: "damned the river". "damned" should be "dammed". 
08 Out of the Frying Pan, line 1277 col 143: "drown its dark waters". Should be "drown in its dark waters". 
08 Out of the Frying Pan, line 2105 col 132: "in from of". Should be "in front of". 
08 Out of the Frying Pan, line 2484 col 31: "The user feel much better". "feel" should be "feels". 
08 Out of the Frying Pan, line 2810 col 240: "getting it the easy treatment". Delete "it". 
08 Out of the Frying Pan, line 3331 col 37: "Follow Us". Should be "Follow us". 
08 Out of the Frying Pan, line 3358 col 50: "it make my skin crawl". "make" should be "makes". 
09 Blood is Thicker than Water, line 345 col 175: "where Esanoo has come from". "has" should be "had". 
09 Blood is Thicker than Water, line 1127 col 95: "seeked". Should be "sought". 
09 Blood is Thicker than Water, line 1487 col 95: "veneance". Should be "vengeance". 
09 Blood is Thicker than Water, line 1779 col 71, line 1904 col 71, line 2034 col 71 and line 2159 col 71: "We've never seem him". "seem" should be "seen". 
09 Blood is Thicker than Water, line 3354 col 22: "Fresh Meat". "Should be "Fresh meat". 
10 Speaking with the Fishes, line 345 col 718: "the human's capital". "human's" should be "humans'". 
10 Speaking with the Fishes, line 882 col 67: "none of us return alive". Should be "none of us will return alive". 
10 Speaking with the Fishes, line 941 col 659: "all other who". "other" should be "others". 
11 The Battle for Zocthanol Isle, line 318 col 454: "guiding out steps". "out" should be "our". 
11 The Battle for Zocthanol Isle, line 1307 col 96: "complimpents". Should be "compliments". 
11 The Battle for Zocthanol Isle, line 1529 col 152 and line 1560 col 152: "extrances". Should be "entrances". 
units/Cave_spider2.cfg, line 24 col 30: "Cave Spiders are roam". Delete "are". 
units/Crab_Man.cfg, line 23 col 98: "the more twisted monsters every recorded". "more" should be "most", and "every" should be "ever". 
units/Dark_Assassin1.cfg, line 33 col 74; units/Dark_Assassin2.cfg,line 33 col 74; and units/Dark_Assassin3.cfg, line 36 col 74: "a moments notice". "moments" should be "moment's". 
units/Desert_Avenger.cfg, line 52 col 209; and units/Desert_Ranger.cfg, line 51 col 238: "backstabing". Should be "backstabbing". 
units/Dwarvish_Pathfinder.cfg, line 27 col 30: "Dwarvish Pathfinders and faster". "and" should be "are". 
units/Dwarvish_Pathfinder.cfg, line 27 col 135: "The often race". "The" should be "They". 
units/Kaleh_Fighter.cfg, line 46 col 88: "Wesnoth". Should be "Quenoth".

==Editor==

==Other (ingame help, ...)==
data/help.cfg:247
familiarise-familiarize

data/help.cfg:317
"foes who" - "foes that"

data/scenarios/multiplayer/2p_Caves_of_the_Basilisk.cfg:148
amoung - among

data/scenarios/multiplayer/2p_Caves_of_the_Basilisk.cfg:128
"The foul Basilik" - The foul Basilisk

data/scenarios/multiplayer/9p_Merkwuerdigliebe.cfg:7
vilages-villages

SpellingMistakes

2006-07-08T07:36:13Z

Scott: /* The Rise of Wesnoth */

This page is meant to be a list for mistakes in campaigns and other texts in the en_US version of the game.

==Eastern Invasion==
The Outpost, line 120 col 54: "Dacyn's return during in two days". "during" should be deleted. 
The Escape Tunnel, line 174 col 61 and line 180 col 61: "I advise you join us". Should be "I advise you to join us". 
Northern Outpost, line 129 col 138: "the Northlands, were we may". "Were" should be "where". 
Evacuation, line 340 col 68: "an chance of success". "an" should be "any". 
Evacuation, line 344 col 40 : "But is appears we will" should be "But it appears we will"

==Heir to the Throne==
* Snow Plains, line 115, col 93: "as an envoy from we North Elves". "we" should be "us".
* Test of the Clan, line 380, col 50: "the easten plains". "easten" should be "eastern".
* Blackwater Port, line 179: "I offer you my support Konrad, and the support of my men" should be "I offer you my support, Konrad, and the support of my men"
* Swamp Of Dread, line 249: "It is is clear" should have one "is" 
* Home of the North Elves, line 24: "Konrad must reach the elvish forest and resist until the end of turns": the objective has changed to resist until the end of the turn. Don't forget! 
* Elven Council, line 110: "How quickly do the race of men mature!": do should be does.
* Plunging Into the Darkness, line 596: "if you most go on with this mad scheme", most -> must.

==The Rise of Wesnoth==

Rise of Wesnoth, line 430: 
"All life is finite," should have a semi-colon to avoid a run-on sentence 
The Ka'lain, line 305 
"you place" -> "your place" 

==The South Guard==
Born to the Banner, line 437 col 50: "intellegent". Should be "intelligent". 
Proven by the Sword, line 238 col 50: "intellegent". Should be "intelligent". 
A Desperate Errand, line 203 col 50: "recieved". Should be "received". 
Vale of Tears, line 182 col 92: "sacking out towns". "out" should be "our". 
Choice in the Fog, line 230 col 76: "whatever enemies lay beyond". "lay" should be "lie". 
Choice in the Fog, line 661 col 121: "you and you men". Second "you" should be "your". 
Tidings Good And Ill, line 336 col 42: "belive". Should be "believe". 
Into the Depths, line 148 col 53: "less valuable in caves that toughness". "that" should be "than". 
Into the Depths, line 384 col 61: "and lite it". "lite" should be "light". 
Into the Depths, line 499 col 51: "The elves I once lead". "lead" should be "led". 
units/4.Infantry_Commander.cfg, line 21 col 48: "infantry Wesnoth". Should be "infantry of Wesnoth". 
utils/sg_story.cfg, line 11 col 263: "men build new towns". "build" should be "built".

==Two Brothers==
Rooting Out a Mage, line 240 col 51: "two day's ride north". "day's" should be "days'". 
The Chase, line 376, col 266: "endevours". Should be "endeavours". 
Guarded Castle, line 442 col 77: "I can count hundred". Should be "I can count a hundred". 
Return to the Village, line 184 col 114: "It was noone here to stop them". "It" should be "There". 
Return to the Village, line 224 col 90: "fixing the damages". Should be "fixing the damage". 
Return to the Village, line 229 col 122: "to face another grim foe to face". "to face" should appear only once.

==Under the Burning Suns==
02 Across the Harsh Sands, line 1416 col 29: "Ogre Ambush". "ambush" should not be capitalised. 
02 Across the Harsh Sands, line 1424 col 21: "Fresh Meat". "meat" should not be capitalised. 
04 Descending Into Darkness, line 1318 col 34: "squirling". Should be "squirreling". 
05 A Subterranean Struggle, line 2251 col 29: "Burn, Burn and Die". Wrongly capitalised: should be "Burn, burn and die". 
05 A Subterranean Struggle, line 2436 col 45: "Help Me". Should be "Help me". 
05 A Subterranean Struggle, line 2452 col 56 and line 2545 col 52: "Fall Back". Should be "Fall back". 
05 A Subterranean Struggle, line 3131 col 40: "I thought that what". Should be "I thought that was what". 
05 A Subterranean Struggle, line 3136 col 320: "trolls secret weapon". "trolls" should be "trolls'". 
05 A Subterranean Struggle, line 3227 col 47: "was was". Should be only one "was". 
06.1 Hunting Trolls, line 781 col 140: "I will once you finish". Should be "I will return once you finish". 
06.2 In the Domain of the Dwarves, line 1325 col 103 and line 1334 col 103: "the maybe". "the" should be "then". 
06.2 In the Domain of the Dwarves, line 1529 col 13: "Good Riddance". Should be "Good riddance". 
06.2 In the Domain of the Dwarves, line 2103 col 94: "shant". Should be "shan't". 
07.1 Dealing with Dwarves, line 604 col 103: "thorne". Should be "thorn". 
07.1 Dealing with Dwarves, line 647 col 121: "cowards's". Should be "coward's". 
07.2 Talking with Trolls, line 646 col 135: "greatful". Should be "grateful". 
08 Out of the Frying Pan, line 1277 col 101: "damned the river". "damned" should be "dammed". 
08 Out of the Frying Pan, line 1277 col 143: "drown its dark waters". Should be "drown in its dark waters". 
08 Out of the Frying Pan, line 2105 col 132: "in from of". Should be "in front of". 
08 Out of the Frying Pan, line 2484 col 31: "The user feel much better". "feel" should be "feels". 
08 Out of the Frying Pan, line 2810 col 240: "getting it the easy treatment". Delete "it". 
08 Out of the Frying Pan, line 3331 col 37: "Follow Us". Should be "Follow us". 
08 Out of the Frying Pan, line 3358 col 50: "it make my skin crawl". "make" should be "makes". 
09 Blood is Thicker than Water, line 345 col 175: "where Esanoo has come from". "has" should be "had". 
09 Blood is Thicker than Water, line 1127 col 95: "seeked". Should be "sought". 
09 Blood is Thicker than Water, line 1487 col 95: "veneance". Should be "vengeance". 
09 Blood is Thicker than Water, line 1779 col 71, line 1904 col 71, line 2034 col 71 and line 2159 col 71: "We've never seem him". "seem" should be "seen". 
09 Blood is Thicker than Water, line 3354 col 22: "Fresh Meat". "Should be "Fresh meat". 
10 Speaking with the Fishes, line 345 col 718: "the human's capital". "human's" should be "humans'". 
10 Speaking with the Fishes, line 882 col 67: "none of us return alive". Should be "none of us will return alive". 
10 Speaking with the Fishes, line 941 col 659: "all other who". "other" should be "others". 
11 The Battle for Zocthanol Isle, line 318 col 454: "guiding out steps". "out" should be "our". 
11 The Battle for Zocthanol Isle, line 1307 col 96: "complimpents". Should be "compliments". 
11 The Battle for Zocthanol Isle, line 1529 col 152 and line 1560 col 152: "extrances". Should be "entrances". 
units/Cave_spider2.cfg, line 24 col 30: "Cave Spiders are roam". Delete "are". 
units/Crab_Man.cfg, line 23 col 98: "the more twisted monsters every recorded". "more" should be "most", and "every" should be "ever". 
units/Dark_Assassin1.cfg, line 33 col 74; units/Dark_Assassin2.cfg,line 33 col 74; and units/Dark_Assassin3.cfg, line 36 col 74: "a moments notice". "moments" should be "moment's". 
units/Desert_Avenger.cfg, line 52 col 209; and units/Desert_Ranger.cfg, line 51 col 238: "backstabing". Should be "backstabbing". 
units/Dwarvish_Pathfinder.cfg, line 27 col 30: "Dwarvish Pathfinders and faster". "and" should be "are". 
units/Dwarvish_Pathfinder.cfg, line 27 col 135: "The often race". "The" should be "They". 
units/Kaleh_Fighter.cfg, line 46 col 88: "Wesnoth". Should be "Quenoth".

==Editor==

==Other (ingame help, ...)==
data/help.cfg:247
familiarise-familiarize

data/help.cfg:317
"foes who" - "foes that"

data/scenarios/multiplayer/2p_Caves_of_the_Basilisk.cfg:148
amoung - among

data/scenarios/multiplayer/2p_Caves_of_the_Basilisk.cfg:128
"The foul Basilik" - The foul Basilisk

data/scenarios/multiplayer/9p_Merkwuerdigliebe.cfg:7
vilages-villages

SpellingMistakes

2006-07-08T07:20:34Z

Scott: /* The Rise of Wesnoth */

This page is meant to be a list for mistakes in campaigns and other texts in the en_US version of the game.

==Eastern Invasion==
The Outpost, line 120 col 54: "Dacyn's return during in two days". "during" should be deleted. 
The Escape Tunnel, line 174 col 61 and line 180 col 61: "I advise you join us". Should be "I advise you to join us". 
Northern Outpost, line 129 col 138: "the Northlands, were we may". "Were" should be "where". 
Evacuation, line 340 col 68: "an chance of success". "an" should be "any". 
Evacuation, line 344 col 40 : "But is appears we will" should be "But it appears we will"

==Heir to the Throne==
* Snow Plains, line 115, col 93: "as an envoy from we North Elves". "we" should be "us".
* Test of the Clan, line 380, col 50: "the easten plains". "easten" should be "eastern".
* Blackwater Port, line 179: "I offer you my support Konrad, and the support of my men" should be "I offer you my support, Konrad, and the support of my men"
* Swamp Of Dread, line 249: "It is is clear" should have one "is" 
* Home of the North Elves, line 24: "Konrad must reach the elvish forest and resist until the end of turns": the objective has changed to resist until the end of the turn. Don't forget! 
* Elven Council, line 110: "How quickly do the race of men mature!": do should be does.
* Plunging Into the Darkness, line 596: "if you most go on with this mad scheme", most -> must.

==The Rise of Wesnoth==

Rise of Wesnoth, line 430:
"All life is finite," should have a semi-colon to avoid a run-on sentence
The Ka'lain, line 305
"you place" -> "your place"

==The South Guard==
Born to the Banner, line 437 col 50: "intellegent". Should be "intelligent". 
Proven by the Sword, line 238 col 50: "intellegent". Should be "intelligent". 
A Desperate Errand, line 203 col 50: "recieved". Should be "received". 
Vale of Tears, line 182 col 92: "sacking out towns". "out" should be "our". 
Choice in the Fog, line 230 col 76: "whatever enemies lay beyond". "lay" should be "lie". 
Choice in the Fog, line 661 col 121: "you and you men". Second "you" should be "your". 
Tidings Good And Ill, line 336 col 42: "belive". Should be "believe". 
Into the Depths, line 148 col 53: "less valuable in caves that toughness". "that" should be "than". 
Into the Depths, line 384 col 61: "and lite it". "lite" should be "light". 
Into the Depths, line 499 col 51: "The elves I once lead". "lead" should be "led". 
units/4.Infantry_Commander.cfg, line 21 col 48: "infantry Wesnoth". Should be "infantry of Wesnoth". 
utils/sg_story.cfg, line 11 col 263: "men build new towns". "build" should be "built".

==Two Brothers==
Rooting Out a Mage, line 240 col 51: "two day's ride north". "day's" should be "days'". 
The Chase, line 376, col 266: "endevours". Should be "endeavours". 
Guarded Castle, line 442 col 77: "I can count hundred". Should be "I can count a hundred". 
Return to the Village, line 184 col 114: "It was noone here to stop them". "It" should be "There". 
Return to the Village, line 224 col 90: "fixing the damages". Should be "fixing the damage". 
Return to the Village, line 229 col 122: "to face another grim foe to face". "to face" should appear only once.

==Under the Burning Suns==
02 Across the Harsh Sands, line 1416 col 29: "Ogre Ambush". "ambush" should not be capitalised. 
02 Across the Harsh Sands, line 1424 col 21: "Fresh Meat". "meat" should not be capitalised. 
04 Descending Into Darkness, line 1318 col 34: "squirling". Should be "squirreling". 
05 A Subterranean Struggle, line 2251 col 29: "Burn, Burn and Die". Wrongly capitalised: should be "Burn, burn and die". 
05 A Subterranean Struggle, line 2436 col 45: "Help Me". Should be "Help me". 
05 A Subterranean Struggle, line 2452 col 56 and line 2545 col 52: "Fall Back". Should be "Fall back". 
05 A Subterranean Struggle, line 3131 col 40: "I thought that what". Should be "I thought that was what". 
05 A Subterranean Struggle, line 3136 col 320: "trolls secret weapon". "trolls" should be "trolls'". 
05 A Subterranean Struggle, line 3227 col 47: "was was". Should be only one "was". 
06.1 Hunting Trolls, line 781 col 140: "I will once you finish". Should be "I will return once you finish". 
06.2 In the Domain of the Dwarves, line 1325 col 103 and line 1334 col 103: "the maybe". "the" should be "then". 
06.2 In the Domain of the Dwarves, line 1529 col 13: "Good Riddance". Should be "Good riddance". 
06.2 In the Domain of the Dwarves, line 2103 col 94: "shant". Should be "shan't". 
07.1 Dealing with Dwarves, line 604 col 103: "thorne". Should be "thorn". 
07.1 Dealing with Dwarves, line 647 col 121: "cowards's". Should be "coward's". 
07.2 Talking with Trolls, line 646 col 135: "greatful". Should be "grateful". 
08 Out of the Frying Pan, line 1277 col 101: "damned the river". "damned" should be "dammed". 
08 Out of the Frying Pan, line 1277 col 143: "drown its dark waters". Should be "drown in its dark waters". 
08 Out of the Frying Pan, line 2105 col 132: "in from of". Should be "in front of". 
08 Out of the Frying Pan, line 2484 col 31: "The user feel much better". "feel" should be "feels". 
08 Out of the Frying Pan, line 2810 col 240: "getting it the easy treatment". Delete "it". 
08 Out of the Frying Pan, line 3331 col 37: "Follow Us". Should be "Follow us". 
08 Out of the Frying Pan, line 3358 col 50: "it make my skin crawl". "make" should be "makes". 
09 Blood is Thicker than Water, line 345 col 175: "where Esanoo has come from". "has" should be "had". 
09 Blood is Thicker than Water, line 1127 col 95: "seeked". Should be "sought". 
09 Blood is Thicker than Water, line 1487 col 95: "veneance". Should be "vengeance". 
09 Blood is Thicker than Water, line 1779 col 71, line 1904 col 71, line 2034 col 71 and line 2159 col 71: "We've never seem him". "seem" should be "seen". 
09 Blood is Thicker than Water, line 3354 col 22: "Fresh Meat". "Should be "Fresh meat". 
10 Speaking with the Fishes, line 345 col 718: "the human's capital". "human's" should be "humans'". 
10 Speaking with the Fishes, line 882 col 67: "none of us return alive". Should be "none of us will return alive". 
10 Speaking with the Fishes, line 941 col 659: "all other who". "other" should be "others". 
11 The Battle for Zocthanol Isle, line 318 col 454: "guiding out steps". "out" should be "our". 
11 The Battle for Zocthanol Isle, line 1307 col 96: "complimpents". Should be "compliments". 
11 The Battle for Zocthanol Isle, line 1529 col 152 and line 1560 col 152: "extrances". Should be "entrances". 
units/Cave_spider2.cfg, line 24 col 30: "Cave Spiders are roam". Delete "are". 
units/Crab_Man.cfg, line 23 col 98: "the more twisted monsters every recorded". "more" should be "most", and "every" should be "ever". 
units/Dark_Assassin1.cfg, line 33 col 74; units/Dark_Assassin2.cfg,line 33 col 74; and units/Dark_Assassin3.cfg, line 36 col 74: "a moments notice". "moments" should be "moment's". 
units/Desert_Avenger.cfg, line 52 col 209; and units/Desert_Ranger.cfg, line 51 col 238: "backstabing". Should be "backstabbing". 
units/Dwarvish_Pathfinder.cfg, line 27 col 30: "Dwarvish Pathfinders and faster". "and" should be "are". 
units/Dwarvish_Pathfinder.cfg, line 27 col 135: "The often race". "The" should be "They". 
units/Kaleh_Fighter.cfg, line 46 col 88: "Wesnoth". Should be "Quenoth".

==Editor==

==Other (ingame help, ...)==
data/help.cfg:247
familiarise-familiarize

data/help.cfg:317
"foes who" - "foes that"

data/scenarios/multiplayer/2p_Caves_of_the_Basilisk.cfg:148
amoung - among

data/scenarios/multiplayer/2p_Caves_of_the_Basilisk.cfg:128
"The foul Basilik" - The foul Basilisk

data/scenarios/multiplayer/9p_Merkwuerdigliebe.cfg:7
vilages-villages

ScenarioWML

2006-07-06T19:57:12Z

Scott: Reverted edit of Viliam, changed back to last version by Placid

{{WML Tags}}
== the toplevel tags [multiplayer], [test], [tutorial], [scenario] ==

The top level tags '''[multiplayer]''', '''[test]''', '''[tutorial]''' and '''[scenario]''' are all formatted the same way.
The difference between these tags is the way that the scenarios they describe are accessed.

The keys ''id'' and ''next_scenario'' affect how scenarios can be accessed.
Whenever a scenario is won, the scenario with id=''next_scenario'' of the same tag type will be played.
Units from the first scenario will be available for recall in the second.

Some scenarios can be played without playing other scenarios first
(in this case there is nothing on the recall list).
These scenarios are called ''initial scenario''s.

A list of initial scenarios, and how to access them:

* All '''[multiplayer]''' scenarios are initial scenarios listed in the multiplayer scenario selector screen (accessed by the "multiplayer" button).

* The '''[test]''' scenario with the attribute '''id=test''' is an initial scenario. This test scenario can be accessed by running the game in test mode. (note: this is NOT the same as debug mode. It can be accessed using -t or --test) You can speed up scenario development a lot by this when used in a clever way: Move a scenario into ~campaigns (so that it will be read even without its campaign being loaded), change it to a [test] scenario, and change the ID to 'test'. Then run Wesnoth in test mode. This saves about a minute for each time you want to test changes to your scenario. However it should not be used for balancing as there will be no recallable units...

* The '''[tutorial]''' scenario with the attribute '''id=tutorial''' is an initial scenario. The tutorial is accessed by clicking on the "tutorial" button.

* Any '''[scenario]''' scenario with an id listed in the value of ''first_scenario'' in a campaign tag (see [[CampaignWML]]) is an initial scenario accessed by selecting that campaign after clicking on the "campaign" button.

== The [scenario] tag ==

The following keys and tags are recognized in '''[scenario]''' tags:

* ''id'' A unique identifier for this scenario.

* ''next_scenario'' The id of the scenario to load when the current one is won. This can be changed dynamically, to build non-linear campaigns.

* ''description'' (translatable) only for multiplayer maps. Will show up as a tooltip when mousing over the minimap in the multiplayer setup screen. Only in >0.8.5

* ''name'' (translatable) is shown in several places in the level, including the intro screen. It is also the default name for saves on the level.

* ''map_data'' inputs valid Wesnoth map data. See [[BuildingMaps]] for a description of the Wesnoth map syntax.

* ''turns'' sets an event on turn ''turns'' causing the player to lose. See also [[EventWML]]

* ''turn_at'' the turn to start on (default=1)

* ''music'' the music file relative to ''./music/'' to play during the scenario

* '''[music]''' {{DevFeature}} specifies the music tracks to play during this scenario, see [[MusicListWML]]. This was introduced after 1.1, obsoleting the old ''music'' key, which specifies the music to play relative to the '"music/'".

* ''theme'' the UI theme that should be used when playing this scenario. See [[Using_custom_themes_in_campaigns]]

* ''objectives'' (translatable) the text displayed in the Scenario Objectives box in-game. Now obsolete; see '''[objectives]''', [[InterfaceActionsWML]].

* ''victory_when_enemies_defeated'' when this is set to 'yes'(default), the player wins once all non-allied units with '''canrecruit=1''' (aka leaders) are killed. (Currently this only controls the win condition for when all enemies are defeated; it does not prevent the player from losing if he has no leader.)

* ''disallow_recall'' when this is set to 'no'(default), the player is allowed to recall units from previous scenarios.

* ''experience_modifier'' the percentage that required XP to level up (for all units in the scenario) is multiplied by. Default 100. Note that when used in a campaign, weird things (like units being above the required XP to level up) can happen if this value is different for different scenarios.

* '''[story]''' describes the intro screen. See [[IntroWML]]

* '''[label]''' sets a label
** ''x'', ''y'' location to set label
** ''text'' the label

* '''[time]''', '''[illuminated_time]''' how a day should progress. See [[TimeWML]]

* '''[time_area]''' how a day should progress in a given area. Everywhere not specified in a [time_area] tag is affected by the [time] and [illuminated_time] tags in the [scenario] tag
** standard location filter
** '''[time]''', '''[illuminated_time]''' how a day should progress in those locations. See [[TimeWML]]

* '''[side]''' describes one player. See [[SideWML]]

* '''[event]''' describes an event that may be triggered at a certain point of the scenario. See [[EventWML]]

* ''map_generation'' another way to generate a map. The map will be generated randomly
** "default" the default random map generator

* '''[generator]''' if this is present, the map and scenario will be generated randomly. See [[MapGeneratorWML]]

== See Also ==

* [[EventWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

CampaignWML

2006-07-06T19:55:28Z

Scott: this is a reference, not a tutorial. Add to the campaign tutorial and link to it from here.

{{WML Tags}}
== the [campaign] tag ==



This tag describes a campaign, and is used for the "Campaign" menu
in the title screen.

The '''[campaign]''' tag has the following attibutes:
* ''icon'' the image displayed in the campaign selection menu
* ''name'' (translatable) name displayed in the campaign selection menu
* ''image'' the image shown in the information pane when this campaign is selected in the campaign selection menu
* ''description'' (translatable) text shown in the information pane when this campaign is selected in the campaign selection menu
* ''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'''''.
* ''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 [[UtilWML]]) 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.
* ''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.
* ''first_scenario'' the ID of the first scenario in the campaign; see ''id'' in [[ScenarioWML]]
* ''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 10 to 50; if you specify this, it should not be less than 51.
* '''[about]''' {{DevFeature}} inserts your own credits into the game's list of credits. The campaign's name automatically is inserted at the top of the rolling credits followed by title/text key pairs. There can be any number of '''[about]''' tags inside a '''[campaign]''' tag. The '''[about]''' tag has the following keys:
** ''title'' (translatable) large text used to start a new subsection (writers, artists, units, balancing) in the rolling credits
** ''text'' (translatable, but you probably won't want to make it such) smaller text intended for the names of developers

The following keys of '''[campaign]''' are obsolete and have no effect:
* ''id'' the internationalization key for the campaign

== See Also ==

* [[PreprocessorRef]]
* [[ScenarioWML]]
* [[ReferenceWML]]
* [[PblWML]]

[[Category: WML Reference]]

CampaignWML

2006-07-06T19:49:14Z

Scott: /* The [campaign] tag */

{{WML Tags}}

Each campaign consists of several scenarios.
Those scenarios are described in their [[ScenarioWML|[scenario]]] tags.
Then, there is usually one campaign file containing information related to the whole campaign.

The [[#The_.5Btextdomain.5D_tag|[textdomain]]] tag specifies where to find translations of campaign texts.

The [[#The_.5Bbinary_data.5D_tag|[binary_data]]] tag specifies where to find campaign specific images, music and sounds; if there are any.

The [[#The_.5Bcampaign.5D_tag|[campaign]]] tag contains general campaign information, that is for example:

* how campaign appears in the game campaign menu
* electable difficulties
* first scenario
* campaign specific credits

The [[#The_.5Babout.5D_tag|[about]]] tag in [campaign] tag is one section of campaign-specific credits.

== The [textdomain] tag ==

Top-level tag; appears directly in [game].

Attributes:
* ''name'' -- symbol of text domain
* ''path'' -- directory containing dictionaries

=== Text domains ===

All texts in game are written in English.
For displaying texts in other languages there are dictionary files: English to another language.
(Dictionary source files have extension "po", compiled dictionaries have extension "mo".)
To make translating and translation maintenance easier, all texts in the game are divided to groups called text domains.
There is one dictionary per text domain per language.
Each campaign is a separate text domain; that is each campaign has its translations in its own files, one per language.

The ''name'' attribute specifies the name of dictionary files.
It should begin by "wesnoth-" followed by the name of campaign.
For example if the name of campaign is "My Campaign", the text domain name is "wesnoth-My_Campaign".
When a WML tag includes preprocessor instruction "#textdomain wesnoth-My_Campaign", it means that all translated texts in this tag (and its subtags) should be found a dictionary file "wesnoth-My_Campaign.mo".
(All [campaign] and [scenario] tags should specify their text domain.)

The ''path'' attribute specifies a directory that contains dictionary files.
A campaign called "My Campaign" could specify a [textdomain] tag like this:

[textdomain]
name="wesnoth-My_Campaign"
path="data/campaigns/My_Campaign/translations"
[/textdomain]

All [campaign] and [scenario] tags in this campaign should start like this:

[campaign]
#textdomain wesnoth-My_Campaign

#...

[/campaign]

[scenario]
#textdomain wesnoth-My_Campaign

#...

[/scenario]

When the game is played in English language, all translatable texts (those preceded by "_" mark) are displayed directly.
When the game is played in any other language, program will try to translate the texts by dictionary whose location is determined by:
* the ''path'' attribute of the current text domain
* the language code of the current language (usually in form "xx" or "xx_XX")
* the ''name'' attribute of the current text domain

For example, if the current language is Esperanto (language code: "eo"), the dictionary will be: (on MS Windows)

%ProgramFiles%\Wesnoth\userdata\data\campaigns\My_Campaign\translations\eo\LC_MESSAGES\wesnoth-My_Campaign.mo

== The [binary_path] tag ==

Top-level tag; appears directly in [game].

Attribute:

* ''path'' -- directory containg campaign-specific binary data

=== Binary files locations ===

Program looks for binary files (images, music, sounds) in the subdirectories of "$data" directory, that is:
* images in "$data/images/"
* music in "$data/music/"
* sounds in "$data/sounds"

Because user-contributed files are in different place, this tag makes program find binary files also in subdirectories of directory specified in ''path'' attribute.
(It means that images should not be in the "''path''" directory, but in "''path''/images/" directory; music in "''path''/music/" directory; sounds in "''path''/sounds/" directory.)
The directory must include the final slash ("/") symbol.

A campaign called "My Campaign" could specify a [binary_path] tag like this:

[binary_path]
path=data/campaigns/My_Campaign/
[/binary_path]

Now when program looks for an image called "example.png", it will try to find the image in the following locations: (on MS Windows)

%ProgramFiles%\Wesnoth\images\example.png
%ProgramFiles%\Wesnoth\userdata\data\campaigns\My_Campaign\images\example.png

=== Binary file conflicts ===

As a matter of custom, user campaigns should avoid conflicts with other image and sound files. If a user image has the same name as another file somewhere, unpredictable results will occur in that one of the files will be used in place of the other.

There are two ways to avoid this: unique filenames and isolation using #ifdef.

# The first way is to give user campaign images, sounds, and music unique filename prefixes. For example, a opening story logo called ''main.jpg'' could exist in several campaigns. Give it a prefix like this: ''mycampaign_main.jpg'' where mycampaign is your campaign's name.
# The second way is to place the [binary_path] statement inside your campaign #ifdef. The statements inside #ifdef are only loaded if someone plays your campaign. This is the best way to do it. The custom images and sounds you use in your campaign will not be exposed to the game until you select the campaign from the menu.

If there are some images you want exposed to the game, use a 2nd [binary_path] tag. This way you will have one public binary path and one private binary path. Since there are probably only one or two images you want to be publicly visible (like the campaign menu icon and menu image), it is much easier to place unique prefixes on these public image files.

Make the second [binary_path] statement outside of the #ifdef that points to another subdirectory of your campaign such as ''./external_binary_data/''. In that directory you would need to make ''images'', ''sounds'', and ''music'' subdirectories. See the full example below.

== The [campaign] tag ==

Top-level tag; appears directly in [game].

Campaign menu attributes:

* ''rank'' -- order of campaign in the campaign selection menu (ranks 1-60 are reserved for mainline campaigns)
* ''icon'' -- small campaign image in the campaign selection menu
* ''name'' -- (translatable) campaign name in the campaign selection menu
* ''description'' -- (translatable) campaign description in the information pane of the campaign selection menu
* ''image'' -- larger campaign image in the information pane of the campaign selection menu

Difficulty attributes:

* ''difficulties'' -- comma-separated list of preprocessor symbols for difficulties
* ''difficulty_descriptions'' -- (partially translatable) menu of difficulties

Preprocessor attribute:

* ''define'' -- preprocessor symbol for campaign

First scenario attribute:

* ''first_scenario'' -- the ID of the first scenario in the campaign

Campaign credits subtag:

* [[#The_.5Babout.5D_tag|[about]]] -- credits for campaign {{DevFeature}}

Obsolete attributes: (do not use them)

* ''id'' -- the internationalization key for the campaign

=== Campaign selection menu ===

Campaign selection menu displays a list of mainline and user-contributed campaigns.
Campaigns are ordered by their ''rank'' attribute (lower to higher, unranked in the end).
Mainline campaigns use multiples of 10 from 10 to 50.
Your campaign's rank should be at least 51; but you do not have to specify it.

In the left part of dialog the ''icon'' and ''name'' of campaign are displayed.
When user selects a campaign, the ''description'' and ''image'' are displayed in the right part.
For example if [campaign] tag looks like this:

[campaign]

icon=small.png
name= _"My Campaign"
description= _"Hero goes somewhere and does something."
image=large.png

#...

[/campaign]

Then the campaign selection menu will look like this:

+------------------------------+---------------------+
| Select a campaign: | |
| [.....] Heir to the Throne | Hero goes somewhere |
| [.....] Son of the Black Eye | and does something. |
| [.....] Eastern Invasion | [ large ] |
| [.....] The Rise of Wesnoth | [ .png ] |
| [small] My Campaign | [OK] |
+------------------------------+---------------------+

=== Difficulty menu ===

From campaign author's view, "difficulty" is a preprocessor symbol, which can be used in scenario script to make gameplay easier or harder.
This is typically done by making difficulty-dependent turn limits, starting gold for enemies, recruiting lists for enemies, AI commands,... but it can be anything.
Exactly one of difficulty symbols is defined during campaign.

Using difficulties in campaign in optional.
It is recommend to use standard symbols "EASY", "NORMAL", "HARD", because a few standard macros use them (file "utils.cfg"; see [[UtilWML]]).
The ''difficulties'' attribute is a comma-separated list of preprocessor symbols to be defined.
These symbols are used internally, and are never displayed to player.
(It means that campaign author can use the symbols "EASY", "NORMAL", "HARD", even if the selection box displays different names, e.g. "Hard", "Very hard", "Nightmare".)
The ''difficulty_descriptions'' is a formatted string that is best created using macros "MENU_IMG_TXT" and "MENU_IMG_TXT2" like this:

[campaign]

#...

difficulties=EASY,NORMAL,HARD
difficulty_descriptions= {MENU_IMG_TXT2 elvish-fighter.png _"Fighter" _"(easiest)"} + ";"
+ "*" + {MENU_IMG_TXT elvish-hero.png _"Hero" } + ";"
+ {MENU_IMG_TXT2 elvish-champion.png _"Champion" _"(hardest)"}

#...

[/campaign]

The semicolon ";" separates items in menu, and the asterisk "*" specifies the default value (see [[DescriptionWML]]).
Number of rows in ''difficulty_descriptions'' must be the same as number of symbols in ''difficulties''.
The difficulty menu will look like this:

+-------------------------------+
| Choose a difficulty: |
| [fighter.] Fighter (easiest) |
| [hero.png] Hero |
| [champion] Champion (hardest) |
+-------------------------------+

=== Campaign symbol ===

Each campaign must define a unique preprocessor symbol, to make program run efficiently (load data faster and use less memory).
This symbol is used to include campaign-specific WML files, that is scenario files and campaign-specific macros.
If you do not care about technical details, skip the following paragraph.

WML files include each other; starting with "$data/game.cfg" which includes some files that also include some files... and so on, up to all the units, campaigns, etc.
There are hundreds of WML files which must be read and parsed; they consume a lot of memory and make program start slowly.
To reduce this amount, scenario files are ''not'' loaded at the start of program; their inclusion is prevented by "#ifdef" preprocessor commands (see [[PreprocessorRef]]).
When starting a campaign (or loading a saved game from campaign), the campaign-specific preprocessor symbol is defined, and WML files are reloaded... now including also scenario files from the current campaign (but not from other campaigns).
Each campaign must define a unique preprocessor symbol, and conditionally include its campaign-specific files, to support this process.
Without it, the campaign would work anyway, but its files would consume memory also when not necessary, e.g. when playing some other campaign.

The ''define'' attribute must contain a unique preprocessor symbol.
It should start with "CAMPAIGN_" followed by the name of campaign.
For example if your campaign is called "My Campaign", you should write:

[campaign]

#...

define=CAMPAIGN_MY_CAMPAIGN

#...

[/campaign]

Then, you have to use this symbol at the end of campaign WML file (after the end of [campaign] tag) to include campaign-specific files (e.g. scenarios) like this:

#ifdef CAMPAIGN_MY_CAMPAIGN
{@campaigns/My_Campaign/scenarios}
#endif

Only the tags [binary_path] and [campaign] should go outside the "#ifdef" section.

=== Selecting first scenario ===

Attribute ''first_scenario'' specifies which scenario should be started first.
Its value must be the same as the value of "id" attribute of the [[ScenarioWML|[scenario]]] tag for given scenario.
For example your campaign can contain:

[campaign]

#...

first_scenario=My_first_scenario

#...

[/campaign]

And the corresponding scenario would contain:

[scenario]

id=My_first_scenario

#...

[/scenario]

Please note that the "id" attribute of the [scenario] tag does not have to be the same as the name of scenario file.
Attribute ''first_scenario'' refers to the "id" attribute of the [scenario] tag, ''not'' to the filename.
(However, you should include all scenario files in your campaign file; read the previous section.)

All scenarios must have unique IDs.
(That is: unique in scope of their campaign.
Because scenarios from different campaigns are never loaded together in memory.)

Campaign tag only specifies the first scenario of the campaign.
Then, each scenario specifies which one will follow.

== The [about] tag ==

{{DevFeature}}

Appears in [campaign] tag.

Attributes:
* ''title'' -- (translatable) title of credits section
* ''text'' -- names of campaign contributors

=== Campaign specific credits ===

A campaign can specify its own credits.
These will be included in the game credits; in the bottom if player has not completed this campaign, in the top if player has completed this campaign.

There can be any number of [about] tags inside a [campaign] tag.
Campaign-specific credits are preceded by the name of campaign.
Each [about] tag contains one section of credits.
Section title is in ''title'' attribute; it must be one of the following values:
* "Campaign Designer"
* "Current Maintainer"
* "Artwork and Graphics Designers"
* "Music"
* "Miscellaneous"

The ''text'' attribute contains the names of contributors, each on separate line.
Example:

#textdomain wesnoth
[about]
title= _"Campaign Designer"
text="Name Surname (nickname)"
[/about]
[about]
title= _"Artwork and Graphics Designers"
text="Artist One
Artist Two"
[/about]

Related forum thread: [http://www.wesnoth.org/forum/viewtopic.php?t=9720 9720].

== A complete example ==

This is a campaign file for campaign "My Campaign"; the file path is "$userdata/campaigns/My_Campaign.cfg".

# This is a main campaign file of campaign "My Campaign".

[textdomain]
name="wesnoth-My_Campaign"
path="data/campaigns/My_Campaign/translations"
[/textdomain]

[campaign]
#textdomain wesnoth-My_Campaign

icon=small.png
name= _"My Campaign"
description= _"Hero goes somewhere and does something."
image=large.png

difficulties=EASY,NORMAL,HARD
difficulty_descriptions= {MENU_IMG_TXT2 elvish-fighter.png _"Fighter" _"(easiest)"} + ";"
+ "*" + {MENU_IMG_TXT elvish-hero.png _"Hero" } + ";"
+ {MENU_IMG_TXT2 elvish-champion.png _"Champion" _"(hardest)"}

define=CAMPAIGN_MY_CAMPAIGN

first_scenario=My_first_scenario

# DEVELOPMENT BRANCH ONLY...

#textdomain wesnoth
[about]
title= _"Campaign Designer"
text="Name Surname (nickname)"
[/about]
[about]
title= _"Artwork and Graphics Designers"
text="Artist One
Artist Two"
[/about]

# ...DEVELOPMENT BRANCH ONLY

[/campaign]

[binary_path]
path=data/campaigns/My_Campaign/external_binary_data/
[/binary_path]

#ifdef CAMPAIGN_MY_CAMPAIGN
[binary_path]
path=data/campaigns/My_Campaign/
[/binary_path]

[+units]
{@campaigns/My_Campaign/units}
[/units]

{@campaigns/My_Campaign/utilities}
{@campaigns/My_Campaign/scenarios}

#endif

== See Also ==

* [[PreprocessorRef]]
* [[ScenarioWML]]
* [[ReferenceWML]]
* [[PblWML]]

[[Category: WML Reference]]

CampaignWML

2006-07-05T11:27:13Z

Scott: /* A complete example */

{{WML Tags}}

Each campaign consists of several scenarios.
Those scenarios are described in their [[ScenarioWML|[scenario]]] tags.
Then, there is usually one campaign file containing information related to the whole campaign.

The [[#The_.5Btextdomain.5D_tag|[textdomain]]] tag specifies where to find translations of campaign texts.

The [[#The_.5Bbinary_data.5D_tag|[binary_data]]] tag specifies where to find campaign specific images, music and sounds; if there are any.

The [[#The_.5Bcampaign.5D_tag|[campaign]]] tag contains general campaign information, that is for example:

* how campaign appears in the game campaign menu
* electable difficulties
* first scenario
* campaign specific credits

The [[#The_.5Babout.5D_tag|[about]]] tag in [campaign] tag is one section of campaign-specific credits.

== The [textdomain] tag ==

Top-level tag; appears directly in [game].

Attributes:
* ''name'' -- symbol of text domain
* ''path'' -- directory containing dictionaries

=== Text domains ===

All texts in game are written in English.
For displaying texts in other languages there are dictionary files: English to another language.
(Dictionary source files have extension "po", compiled dictionaries have extension "mo".)
To make translating and translation maintenance easier, all texts in the game are divided to groups called text domains.
There is one dictionary per text domain per language.
Each campaign is a separate text domain; that is each campaign has its translations in its own files, one per language.

The ''name'' attribute specifies the name of dictionary files.
It should begin by "wesnoth-" followed by the name of campaign.
For example if the name of campaign is "My Campaign", the text domain name is "wesnoth-My_Campaign".
When a WML tag includes preprocessor instruction "#textdomain wesnoth-My_Campaign", it means that all translated texts in this tag (and its subtags) should be found a dictionary file "wesnoth-My_Campaign.mo".
(All [campaign] and [scenario] tags should specify their text domain.)

The ''path'' attribute specifies a directory that contains dictionary files.
A campaign called "My Campaign" could specify a [textdomain] tag like this:

[textdomain]
name="wesnoth-My_Campaign"
path="data/campaigns/My_Campaign/translations"
[/textdomain]

All [campaign] and [scenario] tags in this campaign should start like this:

[campaign]
#textdomain wesnoth-My_Campaign

#...

[/campaign]

[scenario]
#textdomain wesnoth-My_Campaign

#...

[/scenario]

When the game is played in English language, all translatable texts (those preceded by "_" mark) are displayed directly.
When the game is played in any other language, program will try to translate the texts by dictionary whose location is determined by:
* the ''path'' attribute of the current text domain
* the language code of the current language (usually in form "xx" or "xx_XX")
* the ''name'' attribute of the current text domain

For example, if the current language is Esperanto (language code: "eo"), the dictionary will be: (on MS Windows)

%ProgramFiles%\Wesnoth\userdata\data\campaigns\My_Campaign\translations\eo\LC_MESSAGES\wesnoth-My_Campaign.mo

== The [binary_path] tag ==

Top-level tag; appears directly in [game].

Attribute:

* ''path'' -- directory containg campaign-specific binary data

=== Binary files locations ===

Program looks for binary files (images, music, sounds) in the subdirectories of "$data" directory, that is:
* images in "$data/images/"
* music in "$data/music/"
* sounds in "$data/sounds"

Because user-contributed files are in different place, this tag makes program find binary files also in subdirectories of directory specified in ''path'' attribute.
(It means that images should not be in the "''path''" directory, but in "''path''/images/" directory; music in "''path''/music/" directory; sounds in "''path''/sounds/" directory.)
The directory must include the final slash ("/") symbol.

A campaign called "My Campaign" could specify a [binary_path] tag like this:

[binary_path]
path=data/campaigns/My_Campaign/
[/binary_path]

Now when program looks for an image called "example.png", it will try to find the image in the following locations: (on MS Windows)

%ProgramFiles%\Wesnoth\images\example.png
%ProgramFiles%\Wesnoth\userdata\data\campaigns\My_Campaign\images\example.png

=== Binary file conflicts ===

As a matter of custom, user campaigns should avoid conflicts with other image and sound files. If a user image has the same name as another file somewhere, unpredictable results will occur in that one of the files will be used in place of the other.

There are two ways to avoid this: unique filenames and isolation using #ifdef.

# The first way is to give user campaign images, sounds, and music unique filename prefixes. For example, a opening story logo called ''main.jpg'' could exist in several campaigns. Give it a prefix like this: ''mycampaign_main.jpg'' where mycampaign is your campaign's name.
# The second way is to place the [binary_path] statement inside your campaign #ifdef. The statements inside #ifdef are only loaded if someone plays your campaign. This is the best way to do it. The custom images and sounds you use in your campaign will not be exposed to the game until you select the campaign from the menu.

If there are some images you want exposed to the game, use a 2nd [binary_path] tag. This way you will have one public binary path and one private binary path. Since there are probably only one or two images you want to be publicly visible (like the campaign menu icon and menu image), it is much easier to place unique prefixes on these public image files.

Make the second [binary_path] statement outside of the #ifdef that points to another subdirectory of your campaign such as ''./external_binary_data/''. In that directory you would need to make ''images'', ''sounds'', and ''music'' subdirectories. See the full example below.

== The [campaign] tag ==

Top-level tag; appears directly in [game].

Campaign menu attributes:

* ''rank'' -- order of campaign in the campaign selection menu
* ''icon'' -- small campaign image in the campaign selection menu
* ''name'' -- (translatable) campaign name in the campaign selection menu
* ''description'' -- (translatable) campaign description in the information pane of the campaign selection menu
* ''image'' -- larger campaign image in the information pane of the campaign selection menu

Difficulty attributes:

* ''difficulties'' -- comma-separated list of preprocessor symbols for difficulties
* ''difficulty_descriptions'' -- (partially translatable) menu of difficulties

Preprocessor attribute:

* ''define'' -- preprocessor symbol for campaign

First scenario attribute:

* ''first_scenario'' -- the ID of the first scenario in the campaign

Campaign credits subtag:

* [[#The_.5Babout.5D_tag|[about]]] -- credits for campaign {{DevFeature}}

Obsolete attributes: (do not use them)

* ''id'' -- the internationalization key for the campaign

=== Campaign selection menu ===

Campaign selection menu displays a list of mainline and user-contributed campaigns.
Campaigns are ordered by their ''rank'' attribute (lower to higher, unranked in the end).
Mainline campaigns use multiples of 10 from 10 to 50.
Your campaign's rank should be at least 51; but you do not have to specify it.

In the left part of dialog the ''icon'' and ''name'' of campaign are displayed.
When user selects a campaign, the ''description'' and ''image'' are displayed in the right part.
For example if [campaign] tag looks like this:

[campaign]

icon=small.png
name= _"My Campaign"
description= _"Hero goes somewhere and does something."
image=large.png

#...

[/campaign]

Then the campaign selection menu will look like this:

+------------------------------+---------------------+
| Select a campaign: | |
| [.....] Heir to the Throne | Hero goes somewhere |
| [.....] Son of the Black Eye | and does something. |
| [.....] Eastern Invasion | [ large ] |
| [.....] The Rise of Wesnoth | [ .png ] |
| [small] My Campaign | [OK] |
+------------------------------+---------------------+

=== Difficulty menu ===

From campaign author's view, "difficulty" is a preprocessor symbol, which can be used in scenario script to make gameplay easier or harder.
This is typically done by making difficulty-dependent turn limits, starting gold for enemies, recruiting lists for enemies, AI commands,... but it can be anything.
Exactly one of difficulty symbols is defined during campaign.

Using difficulties in campaign in optional.
It is recommend to use standard symbols "EASY", "NORMAL", "HARD", because a few standard macros use them (file "utils.cfg"; see [[UtilWML]]).
The ''difficulties'' attribute is a comma-separated list of preprocessor symbols to be defined.
These symbols are used internally, and are never displayed to player.
(It means that campaign author can use the symbols "EASY", "NORMAL", "HARD", even if the selection box displays different names, e.g. "Hard", "Very hard", "Nightmare".)
The ''difficulty_descriptions'' is a formatted string that is best created using macros "MENU_IMG_TXT" and "MENU_IMG_TXT2" like this:

[campaign]

#...

difficulties=EASY,NORMAL,HARD
difficulty_descriptions= {MENU_IMG_TXT2 elvish-fighter.png _"Fighter" _"(easiest)"} + ";"
+ "*" + {MENU_IMG_TXT elvish-hero.png _"Hero" } + ";"
+ {MENU_IMG_TXT2 elvish-champion.png _"Champion" _"(hardest)"}

#...

[/campaign]

The semicolon ";" separates items in menu, and the asterisk "*" specifies the default value (see [[DescriptionWML]]).
Number of rows in ''difficulty_descriptions'' must be the same as number of symbols in ''difficulties''.
The difficulty menu will look like this:

+-------------------------------+
| Choose a difficulty: |
| [fighter.] Fighter (easiest) |
| [hero.png] Hero |
| [champion] Champion (hardest) |
+-------------------------------+

=== Campaign symbol ===

Each campaign must define a unique preprocessor symbol, to make program run efficiently (load data faster and use less memory).
This symbol is used to include campaign-specific WML files, that is scenario files and campaign-specific macros.
If you do not care about technical details, skip the following paragraph.

WML files include each other; starting with "$data/game.cfg" which includes some files that also include some files... and so on, up to all the units, campaigns, etc.
There are hundreds of WML files which must be read and parsed; they consume a lot of memory and make program start slowly.
To reduce this amount, scenario files are ''not'' loaded at the start of program; their inclusion is prevented by "#ifdef" preprocessor commands (see [[PreprocessorRef]]).
When starting a campaign (or loading a saved game from campaign), the campaign-specific preprocessor symbol is defined, and WML files are reloaded... now including also scenario files from the current campaign (but not from other campaigns).
Each campaign must define a unique preprocessor symbol, and conditionally include its campaign-specific files, to support this process.
Without it, the campaign would work anyway, but its files would consume memory also when not necessary, e.g. when playing some other campaign.

The ''define'' attribute must contain a unique preprocessor symbol.
It should start with "CAMPAIGN_" followed by the name of campaign.
For example if your campaign is called "My Campaign", you should write:

[campaign]

#...

define=CAMPAIGN_MY_CAMPAIGN

#...

[/campaign]

Then, you have to use this symbol at the end of campaign WML file (after the end of [campaign] tag) to include campaign-specific files (e.g. scenarios) like this:

#ifdef CAMPAIGN_MY_CAMPAIGN
{@campaigns/My_Campaign/scenarios}
#endif

Only the tags [binary_path] and [campaign] should go outside the "#ifdef" section.

=== Selecting first scenario ===

Attribute ''first_scenario'' specifies which scenario should be started first.
Its value must be the same as the value of "id" attribute of the [[ScenarioWML|[scenario]]] tag for given scenario.
For example your campaign can contain:

[campaign]

#...

first_scenario=My_first_scenario

#...

[/campaign]

And the corresponding scenario would contain:

[scenario]

id=My_first_scenario

#...

[/scenario]

Please note that the "id" attribute of the [scenario] tag does not have to be the same as the name of scenario file.
Attribute ''first_scenario'' refers to the "id" attribute of the [scenario] tag, ''not'' to the filename.
(However, you should include all scenario files in your campaign file; read the previous section.)

All scenarios must have unique IDs.
(That is: unique in scope of their campaign.
Because scenarios from different campaigns are never loaded together in memory.)

Campaign tag only specifies the first scenario of the campaign.
Then, each scenario specifies which one will follow.

== The [about] tag ==

{{DevFeature}}

Appears in [campaign] tag.

Attributes:
* ''title'' -- (translatable) title of credits section
* ''text'' -- names of campaign contributors

=== Campaign specific credits ===

A campaign can specify its own credits.
These will be included in the game credits; in the bottom if player has not completed this campaign, in the top if player has completed this campaign.

There can be any number of [about] tags inside a [campaign] tag.
Campaign-specific credits are preceded by the name of campaign.
Each [about] tag contains one section of credits.
Section title is in ''title'' attribute; it must be one of the following values:
* "Campaign Designer"
* "Current Maintainer"
* "Artwork and Graphics Designers"
* "Music"
* "Miscellaneous"

The ''text'' attribute contains the names of contributors, each on separate line.
Example:

#textdomain wesnoth
[about]
title= _"Campaign Designer"
text="Name Surname (nickname)"
[/about]
[about]
title= _"Artwork and Graphics Designers"
text="Artist One
Artist Two"
[/about]

Related forum thread: [http://www.wesnoth.org/forum/viewtopic.php?t=9720 9720].

== A complete example ==

This is a campaign file for campaign "My Campaign"; the file path is "$userdata/campaigns/My_Campaign.cfg".

# This is a main campaign file of campaign "My Campaign".

[textdomain]
name="wesnoth-My_Campaign"
path="data/campaigns/My_Campaign/translations"
[/textdomain]

[binary_path]
path=data/campaigns/My_Campaign/external_binary_data/
[/binary_path]

[campaign]
#textdomain wesnoth-My_Campaign

icon=small.png
name= _"My Campaign"
description= _"Hero goes somewhere and does something."
image=large.png

difficulties=EASY,NORMAL,HARD
difficulty_descriptions= {MENU_IMG_TXT2 elvish-fighter.png _"Fighter" _"(easiest)"} + ";"
+ "*" + {MENU_IMG_TXT elvish-hero.png _"Hero" } + ";"
+ {MENU_IMG_TXT2 elvish-champion.png _"Champion" _"(hardest)"}

define=CAMPAIGN_MY_CAMPAIGN

first_scenario=My_first_scenario

# DEVELOPMENT BRANCH ONLY...

#textdomain wesnoth
[about]
title= _"Campaign Designer"
text="Name Surname (nickname)"
[/about]
[about]
title= _"Artwork and Graphics Designers"
text="Artist One
Artist Two"
[/about]

# ...DEVELOPMENT BRANCH ONLY

[/campaign]

#ifdef CAMPAIGN_MY_CAMPAIGN
[binary_path]
path=data/campaigns/My_Campaign/
[/binary_path]

[+units]
{@campaigns/My_Campaign/units}
[/units]

{@campaigns/My_Campaign/utilities}
{@campaigns/My_Campaign/scenarios}

#endif

== See Also ==

* [[PreprocessorRef]]
* [[ScenarioWML]]
* [[ReferenceWML]]
* [[PblWML]]

[[Category: WML Reference]]

CampaignWML

2006-07-05T11:27:00Z

Scott: /* A complete example */

{{WML Tags}}

Each campaign consists of several scenarios.
Those scenarios are described in their [[ScenarioWML|[scenario]]] tags.
Then, there is usually one campaign file containing information related to the whole campaign.

The [[#The_.5Btextdomain.5D_tag|[textdomain]]] tag specifies where to find translations of campaign texts.

The [[#The_.5Bbinary_data.5D_tag|[binary_data]]] tag specifies where to find campaign specific images, music and sounds; if there are any.

The [[#The_.5Bcampaign.5D_tag|[campaign]]] tag contains general campaign information, that is for example:

* how campaign appears in the game campaign menu
* electable difficulties
* first scenario
* campaign specific credits

The [[#The_.5Babout.5D_tag|[about]]] tag in [campaign] tag is one section of campaign-specific credits.

== The [textdomain] tag ==

Top-level tag; appears directly in [game].

Attributes:
* ''name'' -- symbol of text domain
* ''path'' -- directory containing dictionaries

=== Text domains ===

All texts in game are written in English.
For displaying texts in other languages there are dictionary files: English to another language.
(Dictionary source files have extension "po", compiled dictionaries have extension "mo".)
To make translating and translation maintenance easier, all texts in the game are divided to groups called text domains.
There is one dictionary per text domain per language.
Each campaign is a separate text domain; that is each campaign has its translations in its own files, one per language.

The ''name'' attribute specifies the name of dictionary files.
It should begin by "wesnoth-" followed by the name of campaign.
For example if the name of campaign is "My Campaign", the text domain name is "wesnoth-My_Campaign".
When a WML tag includes preprocessor instruction "#textdomain wesnoth-My_Campaign", it means that all translated texts in this tag (and its subtags) should be found a dictionary file "wesnoth-My_Campaign.mo".
(All [campaign] and [scenario] tags should specify their text domain.)

The ''path'' attribute specifies a directory that contains dictionary files.
A campaign called "My Campaign" could specify a [textdomain] tag like this:

[textdomain]
name="wesnoth-My_Campaign"
path="data/campaigns/My_Campaign/translations"
[/textdomain]

All [campaign] and [scenario] tags in this campaign should start like this:

[campaign]
#textdomain wesnoth-My_Campaign

#...

[/campaign]

[scenario]
#textdomain wesnoth-My_Campaign

#...

[/scenario]

When the game is played in English language, all translatable texts (those preceded by "_" mark) are displayed directly.
When the game is played in any other language, program will try to translate the texts by dictionary whose location is determined by:
* the ''path'' attribute of the current text domain
* the language code of the current language (usually in form "xx" or "xx_XX")
* the ''name'' attribute of the current text domain

For example, if the current language is Esperanto (language code: "eo"), the dictionary will be: (on MS Windows)

%ProgramFiles%\Wesnoth\userdata\data\campaigns\My_Campaign\translations\eo\LC_MESSAGES\wesnoth-My_Campaign.mo

== The [binary_path] tag ==

Top-level tag; appears directly in [game].

Attribute:

* ''path'' -- directory containg campaign-specific binary data

=== Binary files locations ===

Program looks for binary files (images, music, sounds) in the subdirectories of "$data" directory, that is:
* images in "$data/images/"
* music in "$data/music/"
* sounds in "$data/sounds"

Because user-contributed files are in different place, this tag makes program find binary files also in subdirectories of directory specified in ''path'' attribute.
(It means that images should not be in the "''path''" directory, but in "''path''/images/" directory; music in "''path''/music/" directory; sounds in "''path''/sounds/" directory.)
The directory must include the final slash ("/") symbol.

A campaign called "My Campaign" could specify a [binary_path] tag like this:

[binary_path]
path=data/campaigns/My_Campaign/
[/binary_path]

Now when program looks for an image called "example.png", it will try to find the image in the following locations: (on MS Windows)

%ProgramFiles%\Wesnoth\images\example.png
%ProgramFiles%\Wesnoth\userdata\data\campaigns\My_Campaign\images\example.png

=== Binary file conflicts ===

As a matter of custom, user campaigns should avoid conflicts with other image and sound files. If a user image has the same name as another file somewhere, unpredictable results will occur in that one of the files will be used in place of the other.

There are two ways to avoid this: unique filenames and isolation using #ifdef.

# The first way is to give user campaign images, sounds, and music unique filename prefixes. For example, a opening story logo called ''main.jpg'' could exist in several campaigns. Give it a prefix like this: ''mycampaign_main.jpg'' where mycampaign is your campaign's name.
# The second way is to place the [binary_path] statement inside your campaign #ifdef. The statements inside #ifdef are only loaded if someone plays your campaign. This is the best way to do it. The custom images and sounds you use in your campaign will not be exposed to the game until you select the campaign from the menu.

If there are some images you want exposed to the game, use a 2nd [binary_path] tag. This way you will have one public binary path and one private binary path. Since there are probably only one or two images you want to be publicly visible (like the campaign menu icon and menu image), it is much easier to place unique prefixes on these public image files.

Make the second [binary_path] statement outside of the #ifdef that points to another subdirectory of your campaign such as ''./external_binary_data/''. In that directory you would need to make ''images'', ''sounds'', and ''music'' subdirectories. See the full example below.

== The [campaign] tag ==

Top-level tag; appears directly in [game].

Campaign menu attributes:

* ''rank'' -- order of campaign in the campaign selection menu
* ''icon'' -- small campaign image in the campaign selection menu
* ''name'' -- (translatable) campaign name in the campaign selection menu
* ''description'' -- (translatable) campaign description in the information pane of the campaign selection menu
* ''image'' -- larger campaign image in the information pane of the campaign selection menu

Difficulty attributes:

* ''difficulties'' -- comma-separated list of preprocessor symbols for difficulties
* ''difficulty_descriptions'' -- (partially translatable) menu of difficulties

Preprocessor attribute:

* ''define'' -- preprocessor symbol for campaign

First scenario attribute:

* ''first_scenario'' -- the ID of the first scenario in the campaign

Campaign credits subtag:

* [[#The_.5Babout.5D_tag|[about]]] -- credits for campaign {{DevFeature}}

Obsolete attributes: (do not use them)

* ''id'' -- the internationalization key for the campaign

=== Campaign selection menu ===

Campaign selection menu displays a list of mainline and user-contributed campaigns.
Campaigns are ordered by their ''rank'' attribute (lower to higher, unranked in the end).
Mainline campaigns use multiples of 10 from 10 to 50.
Your campaign's rank should be at least 51; but you do not have to specify it.

In the left part of dialog the ''icon'' and ''name'' of campaign are displayed.
When user selects a campaign, the ''description'' and ''image'' are displayed in the right part.
For example if [campaign] tag looks like this:

[campaign]

icon=small.png
name= _"My Campaign"
description= _"Hero goes somewhere and does something."
image=large.png

#...

[/campaign]

Then the campaign selection menu will look like this:

+------------------------------+---------------------+
| Select a campaign: | |
| [.....] Heir to the Throne | Hero goes somewhere |
| [.....] Son of the Black Eye | and does something. |
| [.....] Eastern Invasion | [ large ] |
| [.....] The Rise of Wesnoth | [ .png ] |
| [small] My Campaign | [OK] |
+------------------------------+---------------------+

=== Difficulty menu ===

From campaign author's view, "difficulty" is a preprocessor symbol, which can be used in scenario script to make gameplay easier or harder.
This is typically done by making difficulty-dependent turn limits, starting gold for enemies, recruiting lists for enemies, AI commands,... but it can be anything.
Exactly one of difficulty symbols is defined during campaign.

Using difficulties in campaign in optional.
It is recommend to use standard symbols "EASY", "NORMAL", "HARD", because a few standard macros use them (file "utils.cfg"; see [[UtilWML]]).
The ''difficulties'' attribute is a comma-separated list of preprocessor symbols to be defined.
These symbols are used internally, and are never displayed to player.
(It means that campaign author can use the symbols "EASY", "NORMAL", "HARD", even if the selection box displays different names, e.g. "Hard", "Very hard", "Nightmare".)
The ''difficulty_descriptions'' is a formatted string that is best created using macros "MENU_IMG_TXT" and "MENU_IMG_TXT2" like this:

[campaign]

#...

difficulties=EASY,NORMAL,HARD
difficulty_descriptions= {MENU_IMG_TXT2 elvish-fighter.png _"Fighter" _"(easiest)"} + ";"
+ "*" + {MENU_IMG_TXT elvish-hero.png _"Hero" } + ";"
+ {MENU_IMG_TXT2 elvish-champion.png _"Champion" _"(hardest)"}

#...

[/campaign]

The semicolon ";" separates items in menu, and the asterisk "*" specifies the default value (see [[DescriptionWML]]).
Number of rows in ''difficulty_descriptions'' must be the same as number of symbols in ''difficulties''.
The difficulty menu will look like this:

+-------------------------------+
| Choose a difficulty: |
| [fighter.] Fighter (easiest) |
| [hero.png] Hero |
| [champion] Champion (hardest) |
+-------------------------------+

=== Campaign symbol ===

Each campaign must define a unique preprocessor symbol, to make program run efficiently (load data faster and use less memory).
This symbol is used to include campaign-specific WML files, that is scenario files and campaign-specific macros.
If you do not care about technical details, skip the following paragraph.

WML files include each other; starting with "$data/game.cfg" which includes some files that also include some files... and so on, up to all the units, campaigns, etc.
There are hundreds of WML files which must be read and parsed; they consume a lot of memory and make program start slowly.
To reduce this amount, scenario files are ''not'' loaded at the start of program; their inclusion is prevented by "#ifdef" preprocessor commands (see [[PreprocessorRef]]).
When starting a campaign (or loading a saved game from campaign), the campaign-specific preprocessor symbol is defined, and WML files are reloaded... now including also scenario files from the current campaign (but not from other campaigns).
Each campaign must define a unique preprocessor symbol, and conditionally include its campaign-specific files, to support this process.
Without it, the campaign would work anyway, but its files would consume memory also when not necessary, e.g. when playing some other campaign.

The ''define'' attribute must contain a unique preprocessor symbol.
It should start with "CAMPAIGN_" followed by the name of campaign.
For example if your campaign is called "My Campaign", you should write:

[campaign]

#...

define=CAMPAIGN_MY_CAMPAIGN

#...

[/campaign]

Then, you have to use this symbol at the end of campaign WML file (after the end of [campaign] tag) to include campaign-specific files (e.g. scenarios) like this:

#ifdef CAMPAIGN_MY_CAMPAIGN
{@campaigns/My_Campaign/scenarios}
#endif

Only the tags [binary_path] and [campaign] should go outside the "#ifdef" section.

=== Selecting first scenario ===

Attribute ''first_scenario'' specifies which scenario should be started first.
Its value must be the same as the value of "id" attribute of the [[ScenarioWML|[scenario]]] tag for given scenario.
For example your campaign can contain:

[campaign]

#...

first_scenario=My_first_scenario

#...

[/campaign]

And the corresponding scenario would contain:

[scenario]

id=My_first_scenario

#...

[/scenario]

Please note that the "id" attribute of the [scenario] tag does not have to be the same as the name of scenario file.
Attribute ''first_scenario'' refers to the "id" attribute of the [scenario] tag, ''not'' to the filename.
(However, you should include all scenario files in your campaign file; read the previous section.)

All scenarios must have unique IDs.
(That is: unique in scope of their campaign.
Because scenarios from different campaigns are never loaded together in memory.)

Campaign tag only specifies the first scenario of the campaign.
Then, each scenario specifies which one will follow.

== The [about] tag ==

{{DevFeature}}

Appears in [campaign] tag.

Attributes:
* ''title'' -- (translatable) title of credits section
* ''text'' -- names of campaign contributors

=== Campaign specific credits ===

A campaign can specify its own credits.
These will be included in the game credits; in the bottom if player has not completed this campaign, in the top if player has completed this campaign.

There can be any number of [about] tags inside a [campaign] tag.
Campaign-specific credits are preceded by the name of campaign.
Each [about] tag contains one section of credits.
Section title is in ''title'' attribute; it must be one of the following values:
* "Campaign Designer"
* "Current Maintainer"
* "Artwork and Graphics Designers"
* "Music"
* "Miscellaneous"

The ''text'' attribute contains the names of contributors, each on separate line.
Example:

#textdomain wesnoth
[about]
title= _"Campaign Designer"
text="Name Surname (nickname)"
[/about]
[about]
title= _"Artwork and Graphics Designers"
text="Artist One
Artist Two"
[/about]

Related forum thread: [http://www.wesnoth.org/forum/viewtopic.php?t=9720 9720].

== A complete example ==

This is a campaign file for campaign "My Campaign"; the file path is "$userdata/campaigns/My_Campaign.cfg".

# This is a main campaign file of campaign "My Campaign".

[textdomain]
name="wesnoth-My_Campaign"
path="data/campaigns/My_Campaign/translations"
[/textdomain]

[campaign]
#textdomain wesnoth-My_Campaign

icon=small.png
name= _"My Campaign"
description= _"Hero goes somewhere and does something."
image=large.png

difficulties=EASY,NORMAL,HARD
difficulty_descriptions= {MENU_IMG_TXT2 elvish-fighter.png _"Fighter" _"(easiest)"} + ";"
+ "*" + {MENU_IMG_TXT elvish-hero.png _"Hero" } + ";"
+ {MENU_IMG_TXT2 elvish-champion.png _"Champion" _"(hardest)"}

define=CAMPAIGN_MY_CAMPAIGN

first_scenario=My_first_scenario

# DEVELOPMENT BRANCH ONLY...

#textdomain wesnoth
[about]
title= _"Campaign Designer"
text="Name Surname (nickname)"
[/about]
[about]
title= _"Artwork and Graphics Designers"
text="Artist One
Artist Two"
[/about]

# ...DEVELOPMENT BRANCH ONLY

[/campaign]

[binary_path]
path=data/campaigns/My_Campaign/external_binary_data/
[/binary_path]

#ifdef CAMPAIGN_MY_CAMPAIGN
[binary_path]
path=data/campaigns/My_Campaign/
[/binary_path]

[+units]
{@campaigns/My_Campaign/units}
[/units]

{@campaigns/My_Campaign/utilities}
{@campaigns/My_Campaign/scenarios}

#endif

== See Also ==

* [[PreprocessorRef]]
* [[ScenarioWML]]
* [[ReferenceWML]]
* [[PblWML]]

[[Category: WML Reference]]

CampaignWML

2006-07-05T11:24:11Z

Scott: /* The [binary_path] tag */

{{WML Tags}}

Each campaign consists of several scenarios.
Those scenarios are described in their [[ScenarioWML|[scenario]]] tags.
Then, there is usually one campaign file containing information related to the whole campaign.

The [[#The_.5Btextdomain.5D_tag|[textdomain]]] tag specifies where to find translations of campaign texts.

The [[#The_.5Bbinary_data.5D_tag|[binary_data]]] tag specifies where to find campaign specific images, music and sounds; if there are any.

The [[#The_.5Bcampaign.5D_tag|[campaign]]] tag contains general campaign information, that is for example:

* how campaign appears in the game campaign menu
* electable difficulties
* first scenario
* campaign specific credits

The [[#The_.5Babout.5D_tag|[about]]] tag in [campaign] tag is one section of campaign-specific credits.

== The [textdomain] tag ==

Top-level tag; appears directly in [game].

Attributes:
* ''name'' -- symbol of text domain
* ''path'' -- directory containing dictionaries

=== Text domains ===

All texts in game are written in English.
For displaying texts in other languages there are dictionary files: English to another language.
(Dictionary source files have extension "po", compiled dictionaries have extension "mo".)
To make translating and translation maintenance easier, all texts in the game are divided to groups called text domains.
There is one dictionary per text domain per language.
Each campaign is a separate text domain; that is each campaign has its translations in its own files, one per language.

The ''name'' attribute specifies the name of dictionary files.
It should begin by "wesnoth-" followed by the name of campaign.
For example if the name of campaign is "My Campaign", the text domain name is "wesnoth-My_Campaign".
When a WML tag includes preprocessor instruction "#textdomain wesnoth-My_Campaign", it means that all translated texts in this tag (and its subtags) should be found a dictionary file "wesnoth-My_Campaign.mo".
(All [campaign] and [scenario] tags should specify their text domain.)

The ''path'' attribute specifies a directory that contains dictionary files.
A campaign called "My Campaign" could specify a [textdomain] tag like this:

[textdomain]
name="wesnoth-My_Campaign"
path="data/campaigns/My_Campaign/translations"
[/textdomain]

All [campaign] and [scenario] tags in this campaign should start like this:

[campaign]
#textdomain wesnoth-My_Campaign

#...

[/campaign]

[scenario]
#textdomain wesnoth-My_Campaign

#...

[/scenario]

When the game is played in English language, all translatable texts (those preceded by "_" mark) are displayed directly.
When the game is played in any other language, program will try to translate the texts by dictionary whose location is determined by:
* the ''path'' attribute of the current text domain
* the language code of the current language (usually in form "xx" or "xx_XX")
* the ''name'' attribute of the current text domain

For example, if the current language is Esperanto (language code: "eo"), the dictionary will be: (on MS Windows)

%ProgramFiles%\Wesnoth\userdata\data\campaigns\My_Campaign\translations\eo\LC_MESSAGES\wesnoth-My_Campaign.mo

== The [binary_path] tag ==

Top-level tag; appears directly in [game].

Attribute:

* ''path'' -- directory containg campaign-specific binary data

=== Binary files locations ===

Program looks for binary files (images, music, sounds) in the subdirectories of "$data" directory, that is:
* images in "$data/images/"
* music in "$data/music/"
* sounds in "$data/sounds"

Because user-contributed files are in different place, this tag makes program find binary files also in subdirectories of directory specified in ''path'' attribute.
(It means that images should not be in the "''path''" directory, but in "''path''/images/" directory; music in "''path''/music/" directory; sounds in "''path''/sounds/" directory.)
The directory must include the final slash ("/") symbol.

A campaign called "My Campaign" could specify a [binary_path] tag like this:

[binary_path]
path=data/campaigns/My_Campaign/
[/binary_path]

Now when program looks for an image called "example.png", it will try to find the image in the following locations: (on MS Windows)

%ProgramFiles%\Wesnoth\images\example.png
%ProgramFiles%\Wesnoth\userdata\data\campaigns\My_Campaign\images\example.png

=== Binary file conflicts ===

As a matter of custom, user campaigns should avoid conflicts with other image and sound files. If a user image has the same name as another file somewhere, unpredictable results will occur in that one of the files will be used in place of the other.

There are two ways to avoid this: unique filenames and isolation using #ifdef.

# The first way is to give user campaign images, sounds, and music unique filename prefixes. For example, a opening story logo called ''main.jpg'' could exist in several campaigns. Give it a prefix like this: ''mycampaign_main.jpg'' where mycampaign is your campaign's name.
# The second way is to place the [binary_path] statement inside your campaign #ifdef. The statements inside #ifdef are only loaded if someone plays your campaign. This is the best way to do it. The custom images and sounds you use in your campaign will not be exposed to the game until you select the campaign from the menu.

If there are some images you want exposed to the game, use a 2nd [binary_path] tag. This way you will have one public binary path and one private binary path. Since there are probably only one or two images you want to be publicly visible (like the campaign menu icon and menu image), it is much easier to place unique prefixes on these public image files.

Make the second [binary_path] statement outside of the #ifdef that points to another subdirectory of your campaign such as ''./external_binary_data/''. In that directory you would need to make ''images'', ''sounds'', and ''music'' subdirectories. See the full example below.

== The [campaign] tag ==

Top-level tag; appears directly in [game].

Campaign menu attributes:

* ''rank'' -- order of campaign in the campaign selection menu
* ''icon'' -- small campaign image in the campaign selection menu
* ''name'' -- (translatable) campaign name in the campaign selection menu
* ''description'' -- (translatable) campaign description in the information pane of the campaign selection menu
* ''image'' -- larger campaign image in the information pane of the campaign selection menu

Difficulty attributes:

* ''difficulties'' -- comma-separated list of preprocessor symbols for difficulties
* ''difficulty_descriptions'' -- (partially translatable) menu of difficulties

Preprocessor attribute:

* ''define'' -- preprocessor symbol for campaign

First scenario attribute:

* ''first_scenario'' -- the ID of the first scenario in the campaign

Campaign credits subtag:

* [[#The_.5Babout.5D_tag|[about]]] -- credits for campaign {{DevFeature}}

Obsolete attributes: (do not use them)

* ''id'' -- the internationalization key for the campaign

=== Campaign selection menu ===

Campaign selection menu displays a list of mainline and user-contributed campaigns.
Campaigns are ordered by their ''rank'' attribute (lower to higher, unranked in the end).
Mainline campaigns use multiples of 10 from 10 to 50.
Your campaign's rank should be at least 51; but you do not have to specify it.

In the left part of dialog the ''icon'' and ''name'' of campaign are displayed.
When user selects a campaign, the ''description'' and ''image'' are displayed in the right part.
For example if [campaign] tag looks like this:

[campaign]

icon=small.png
name= _"My Campaign"
description= _"Hero goes somewhere and does something."
image=large.png

#...

[/campaign]

Then the campaign selection menu will look like this:

+------------------------------+---------------------+
| Select a campaign: | |
| [.....] Heir to the Throne | Hero goes somewhere |
| [.....] Son of the Black Eye | and does something. |
| [.....] Eastern Invasion | [ large ] |
| [.....] The Rise of Wesnoth | [ .png ] |
| [small] My Campaign | [OK] |
+------------------------------+---------------------+

=== Difficulty menu ===

From campaign author's view, "difficulty" is a preprocessor symbol, which can be used in scenario script to make gameplay easier or harder.
This is typically done by making difficulty-dependent turn limits, starting gold for enemies, recruiting lists for enemies, AI commands,... but it can be anything.
Exactly one of difficulty symbols is defined during campaign.

Using difficulties in campaign in optional.
It is recommend to use standard symbols "EASY", "NORMAL", "HARD", because a few standard macros use them (file "utils.cfg"; see [[UtilWML]]).
The ''difficulties'' attribute is a comma-separated list of preprocessor symbols to be defined.
These symbols are used internally, and are never displayed to player.
(It means that campaign author can use the symbols "EASY", "NORMAL", "HARD", even if the selection box displays different names, e.g. "Hard", "Very hard", "Nightmare".)
The ''difficulty_descriptions'' is a formatted string that is best created using macros "MENU_IMG_TXT" and "MENU_IMG_TXT2" like this:

[campaign]

#...

difficulties=EASY,NORMAL,HARD
difficulty_descriptions= {MENU_IMG_TXT2 elvish-fighter.png _"Fighter" _"(easiest)"} + ";"
+ "*" + {MENU_IMG_TXT elvish-hero.png _"Hero" } + ";"
+ {MENU_IMG_TXT2 elvish-champion.png _"Champion" _"(hardest)"}

#...

[/campaign]

The semicolon ";" separates items in menu, and the asterisk "*" specifies the default value (see [[DescriptionWML]]).
Number of rows in ''difficulty_descriptions'' must be the same as number of symbols in ''difficulties''.
The difficulty menu will look like this:

+-------------------------------+
| Choose a difficulty: |
| [fighter.] Fighter (easiest) |
| [hero.png] Hero |
| [champion] Champion (hardest) |
+-------------------------------+

=== Campaign symbol ===

Each campaign must define a unique preprocessor symbol, to make program run efficiently (load data faster and use less memory).
This symbol is used to include campaign-specific WML files, that is scenario files and campaign-specific macros.
If you do not care about technical details, skip the following paragraph.

WML files include each other; starting with "$data/game.cfg" which includes some files that also include some files... and so on, up to all the units, campaigns, etc.
There are hundreds of WML files which must be read and parsed; they consume a lot of memory and make program start slowly.
To reduce this amount, scenario files are ''not'' loaded at the start of program; their inclusion is prevented by "#ifdef" preprocessor commands (see [[PreprocessorRef]]).
When starting a campaign (or loading a saved game from campaign), the campaign-specific preprocessor symbol is defined, and WML files are reloaded... now including also scenario files from the current campaign (but not from other campaigns).
Each campaign must define a unique preprocessor symbol, and conditionally include its campaign-specific files, to support this process.
Without it, the campaign would work anyway, but its files would consume memory also when not necessary, e.g. when playing some other campaign.

The ''define'' attribute must contain a unique preprocessor symbol.
It should start with "CAMPAIGN_" followed by the name of campaign.
For example if your campaign is called "My Campaign", you should write:

[campaign]

#...

define=CAMPAIGN_MY_CAMPAIGN

#...

[/campaign]

Then, you have to use this symbol at the end of campaign WML file (after the end of [campaign] tag) to include campaign-specific files (e.g. scenarios) like this:

#ifdef CAMPAIGN_MY_CAMPAIGN
{@campaigns/My_Campaign/scenarios}
#endif

Only the tags [binary_path] and [campaign] should go outside the "#ifdef" section.

=== Selecting first scenario ===

Attribute ''first_scenario'' specifies which scenario should be started first.
Its value must be the same as the value of "id" attribute of the [[ScenarioWML|[scenario]]] tag for given scenario.
For example your campaign can contain:

[campaign]

#...

first_scenario=My_first_scenario

#...

[/campaign]

And the corresponding scenario would contain:

[scenario]

id=My_first_scenario

#...

[/scenario]

Please note that the "id" attribute of the [scenario] tag does not have to be the same as the name of scenario file.
Attribute ''first_scenario'' refers to the "id" attribute of the [scenario] tag, ''not'' to the filename.
(However, you should include all scenario files in your campaign file; read the previous section.)

All scenarios must have unique IDs.
(That is: unique in scope of their campaign.
Because scenarios from different campaigns are never loaded together in memory.)

Campaign tag only specifies the first scenario of the campaign.
Then, each scenario specifies which one will follow.

== The [about] tag ==

{{DevFeature}}

Appears in [campaign] tag.

Attributes:
* ''title'' -- (translatable) title of credits section
* ''text'' -- names of campaign contributors

=== Campaign specific credits ===

A campaign can specify its own credits.
These will be included in the game credits; in the bottom if player has not completed this campaign, in the top if player has completed this campaign.

There can be any number of [about] tags inside a [campaign] tag.
Campaign-specific credits are preceded by the name of campaign.
Each [about] tag contains one section of credits.
Section title is in ''title'' attribute; it must be one of the following values:
* "Campaign Designer"
* "Current Maintainer"
* "Artwork and Graphics Designers"
* "Music"
* "Miscellaneous"

The ''text'' attribute contains the names of contributors, each on separate line.
Example:

#textdomain wesnoth
[about]
title= _"Campaign Designer"
text="Name Surname (nickname)"
[/about]
[about]
title= _"Artwork and Graphics Designers"
text="Artist One
Artist Two"
[/about]

Related forum thread: [http://www.wesnoth.org/forum/viewtopic.php?t=9720 9720].

== A complete example ==

This is a campaign file for campaign "My Campaign"; the file path is "$userdata/campaigns/My_Campaign.cfg".

# This is a main campaign file of campaign "My Campaign".

[textdomain]
name="wesnoth-My_Campaign"
path="data/campaigns/My_Campaign/translations"
[/textdomain]

[binary_path]
path=data/campaigns/My_Campaign/
[/binary_path]

[campaign]
#textdomain wesnoth-My_Campaign

icon=small.png
name= _"My Campaign"
description= _"Hero goes somewhere and does something."
image=large.png

difficulties=EASY,NORMAL,HARD
difficulty_descriptions= {MENU_IMG_TXT2 elvish-fighter.png _"Fighter" _"(easiest)"} + ";"
+ "*" + {MENU_IMG_TXT elvish-hero.png _"Hero" } + ";"
+ {MENU_IMG_TXT2 elvish-champion.png _"Champion" _"(hardest)"}

define=CAMPAIGN_MY_CAMPAIGN

first_scenario=My_first_scenario

# DEVELOPMENT BRANCH ONLY...

#textdomain wesnoth
[about]
title= _"Campaign Designer"
text="Name Surname (nickname)"
[/about]
[about]
title= _"Artwork and Graphics Designers"
text="Artist One
Artist Two"
[/about]

# ...DEVELOPMENT BRANCH ONLY

[/campaign]

#ifdef CAMPAIGN_MY_CAMPAIGN

[+units]
{@campaigns/My_Campaign/units}
[/units]

{@campaigns/My_Campaign/scenarios}

#endif

== See Also ==

* [[PreprocessorRef]]
* [[ScenarioWML]]
* [[ReferenceWML]]
* [[PblWML]]

[[Category: WML Reference]]

CampaignWML

2006-07-05T11:22:15Z

Scott: /* The [binary_path] tag */

{{WML Tags}}

Each campaign consists of several scenarios.
Those scenarios are described in their [[ScenarioWML|[scenario]]] tags.
Then, there is usually one campaign file containing information related to the whole campaign.

The [[#The_.5Btextdomain.5D_tag|[textdomain]]] tag specifies where to find translations of campaign texts.

The [[#The_.5Bbinary_data.5D_tag|[binary_data]]] tag specifies where to find campaign specific images, music and sounds; if there are any.

The [[#The_.5Bcampaign.5D_tag|[campaign]]] tag contains general campaign information, that is for example:

* how campaign appears in the game campaign menu
* electable difficulties
* first scenario
* campaign specific credits

The [[#The_.5Babout.5D_tag|[about]]] tag in [campaign] tag is one section of campaign-specific credits.

== The [textdomain] tag ==

Top-level tag; appears directly in [game].

Attributes:
* ''name'' -- symbol of text domain
* ''path'' -- directory containing dictionaries

=== Text domains ===

All texts in game are written in English.
For displaying texts in other languages there are dictionary files: English to another language.
(Dictionary source files have extension "po", compiled dictionaries have extension "mo".)
To make translating and translation maintenance easier, all texts in the game are divided to groups called text domains.
There is one dictionary per text domain per language.
Each campaign is a separate text domain; that is each campaign has its translations in its own files, one per language.

The ''name'' attribute specifies the name of dictionary files.
It should begin by "wesnoth-" followed by the name of campaign.
For example if the name of campaign is "My Campaign", the text domain name is "wesnoth-My_Campaign".
When a WML tag includes preprocessor instruction "#textdomain wesnoth-My_Campaign", it means that all translated texts in this tag (and its subtags) should be found a dictionary file "wesnoth-My_Campaign.mo".
(All [campaign] and [scenario] tags should specify their text domain.)

The ''path'' attribute specifies a directory that contains dictionary files.
A campaign called "My Campaign" could specify a [textdomain] tag like this:

[textdomain]
name="wesnoth-My_Campaign"
path="data/campaigns/My_Campaign/translations"
[/textdomain]

All [campaign] and [scenario] tags in this campaign should start like this:

[campaign]
#textdomain wesnoth-My_Campaign

#...

[/campaign]

[scenario]
#textdomain wesnoth-My_Campaign

#...

[/scenario]

When the game is played in English language, all translatable texts (those preceded by "_" mark) are displayed directly.
When the game is played in any other language, program will try to translate the texts by dictionary whose location is determined by:
* the ''path'' attribute of the current text domain
* the language code of the current language (usually in form "xx" or "xx_XX")
* the ''name'' attribute of the current text domain

For example, if the current language is Esperanto (language code: "eo"), the dictionary will be: (on MS Windows)

%ProgramFiles%\Wesnoth\userdata\data\campaigns\My_Campaign\translations\eo\LC_MESSAGES\wesnoth-My_Campaign.mo

== The [binary_path] tag ==

Top-level tag; appears directly in [game].

Attribute:

* ''path'' -- directory containg campaign-specific binary data

=== Binary files locations ===

Program looks for binary files (images, music, sounds) in the subdirectories of "$data" directory, that is:
* images in "$data/images/"
* music in "$data/music/"
* sounds in "$data/sounds"

Because user-contributed files are in different place, this tag makes program find binary files also in subdirectories of directory specified in ''path'' attribute.
(It means that images should not be in the "''path''" directory, but in "''path''/images/" directory; music in "''path''/music/" directory; sounds in "''path''/sounds/" directory.)
The directory must include the final slash ("/") symbol.

A campaign called "My Campaign" could specify a [binary_path] tag like this:

[binary_path]
path=data/campaigns/My_Campaign/
[/binary_path]

Now when program looks for an image called "example.png", it will try to find the image in the following locations: (on MS Windows)

%ProgramFiles%\Wesnoth\images\example.png
%ProgramFiles%\Wesnoth\userdata\data\campaigns\My_Campaign\images\example.png

=== Binary file conflicts ===

As a matter of custom, user campaigns should avoid conflicts with other image and sound files. If a user image has the same name as another file somewhere, unpredictable results will occur in that one of the files will be used in place of the other.

There are two ways to avoid this: unique filenames and isolation using #ifdef.

The first way is to give user campaign images, sounds, and music unique filename prefixes. For example, a opening story logo called ''main.jpg'' could exist in several campaigns. Give it a prefix like this: ''mycampaign_main.jpg'' where mycampaign is your campaign's name.

The second way is to place the [binary_path] statement inside your campaign #ifdef. The statements inside #ifdef are only loaded if someone plays your campaign. This is the best way to do it. The custom images and sounds you use in your campaign will not be exposed to the game until you select the campaign from the menu.

If there are some images you want exposed to the game, use a 2nd [binary_path] tag. This way you will have one public binary path and one private binary path. Since there are probably only one or two images you want to be publicly visible (like the campaign menu icon and menu image), it is much easier to place unique prefixes on these public image files.

Make the second [binary_path] statement outside of the #ifdef that points to another subdirectory of your campaign such as ''./external_binary_data/''. In that directory you would need to make ''images'', ''sounds'', and ''music'' subdirectories. See the full example below.

== The [campaign] tag ==

Top-level tag; appears directly in [game].

Campaign menu attributes:

* ''rank'' -- order of campaign in the campaign selection menu
* ''icon'' -- small campaign image in the campaign selection menu
* ''name'' -- (translatable) campaign name in the campaign selection menu
* ''description'' -- (translatable) campaign description in the information pane of the campaign selection menu
* ''image'' -- larger campaign image in the information pane of the campaign selection menu

Difficulty attributes:

* ''difficulties'' -- comma-separated list of preprocessor symbols for difficulties
* ''difficulty_descriptions'' -- (partially translatable) menu of difficulties

Preprocessor attribute:

* ''define'' -- preprocessor symbol for campaign

First scenario attribute:

* ''first_scenario'' -- the ID of the first scenario in the campaign

Campaign credits subtag:

* [[#The_.5Babout.5D_tag|[about]]] -- credits for campaign {{DevFeature}}

Obsolete attributes: (do not use them)

* ''id'' -- the internationalization key for the campaign

=== Campaign selection menu ===

Campaign selection menu displays a list of mainline and user-contributed campaigns.
Campaigns are ordered by their ''rank'' attribute (lower to higher, unranked in the end).
Mainline campaigns use multiples of 10 from 10 to 50.
Your campaign's rank should be at least 51; but you do not have to specify it.

In the left part of dialog the ''icon'' and ''name'' of campaign are displayed.
When user selects a campaign, the ''description'' and ''image'' are displayed in the right part.
For example if [campaign] tag looks like this:

[campaign]

icon=small.png
name= _"My Campaign"
description= _"Hero goes somewhere and does something."
image=large.png

#...

[/campaign]

Then the campaign selection menu will look like this:

+------------------------------+---------------------+
| Select a campaign: | |
| [.....] Heir to the Throne | Hero goes somewhere |
| [.....] Son of the Black Eye | and does something. |
| [.....] Eastern Invasion | [ large ] |
| [.....] The Rise of Wesnoth | [ .png ] |
| [small] My Campaign | [OK] |
+------------------------------+---------------------+

=== Difficulty menu ===

From campaign author's view, "difficulty" is a preprocessor symbol, which can be used in scenario script to make gameplay easier or harder.
This is typically done by making difficulty-dependent turn limits, starting gold for enemies, recruiting lists for enemies, AI commands,... but it can be anything.
Exactly one of difficulty symbols is defined during campaign.

Using difficulties in campaign in optional.
It is recommend to use standard symbols "EASY", "NORMAL", "HARD", because a few standard macros use them (file "utils.cfg"; see [[UtilWML]]).
The ''difficulties'' attribute is a comma-separated list of preprocessor symbols to be defined.
These symbols are used internally, and are never displayed to player.
(It means that campaign author can use the symbols "EASY", "NORMAL", "HARD", even if the selection box displays different names, e.g. "Hard", "Very hard", "Nightmare".)
The ''difficulty_descriptions'' is a formatted string that is best created using macros "MENU_IMG_TXT" and "MENU_IMG_TXT2" like this:

[campaign]

#...

difficulties=EASY,NORMAL,HARD
difficulty_descriptions= {MENU_IMG_TXT2 elvish-fighter.png _"Fighter" _"(easiest)"} + ";"
+ "*" + {MENU_IMG_TXT elvish-hero.png _"Hero" } + ";"
+ {MENU_IMG_TXT2 elvish-champion.png _"Champion" _"(hardest)"}

#...

[/campaign]

The semicolon ";" separates items in menu, and the asterisk "*" specifies the default value (see [[DescriptionWML]]).
Number of rows in ''difficulty_descriptions'' must be the same as number of symbols in ''difficulties''.
The difficulty menu will look like this:

+-------------------------------+
| Choose a difficulty: |
| [fighter.] Fighter (easiest) |
| [hero.png] Hero |
| [champion] Champion (hardest) |
+-------------------------------+

=== Campaign symbol ===

Each campaign must define a unique preprocessor symbol, to make program run efficiently (load data faster and use less memory).
This symbol is used to include campaign-specific WML files, that is scenario files and campaign-specific macros.
If you do not care about technical details, skip the following paragraph.

WML files include each other; starting with "$data/game.cfg" which includes some files that also include some files... and so on, up to all the units, campaigns, etc.
There are hundreds of WML files which must be read and parsed; they consume a lot of memory and make program start slowly.
To reduce this amount, scenario files are ''not'' loaded at the start of program; their inclusion is prevented by "#ifdef" preprocessor commands (see [[PreprocessorRef]]).
When starting a campaign (or loading a saved game from campaign), the campaign-specific preprocessor symbol is defined, and WML files are reloaded... now including also scenario files from the current campaign (but not from other campaigns).
Each campaign must define a unique preprocessor symbol, and conditionally include its campaign-specific files, to support this process.
Without it, the campaign would work anyway, but its files would consume memory also when not necessary, e.g. when playing some other campaign.

The ''define'' attribute must contain a unique preprocessor symbol.
It should start with "CAMPAIGN_" followed by the name of campaign.
For example if your campaign is called "My Campaign", you should write:

[campaign]

#...

define=CAMPAIGN_MY_CAMPAIGN

#...

[/campaign]

Then, you have to use this symbol at the end of campaign WML file (after the end of [campaign] tag) to include campaign-specific files (e.g. scenarios) like this:

#ifdef CAMPAIGN_MY_CAMPAIGN
{@campaigns/My_Campaign/scenarios}
#endif

Only the tags [binary_path] and [campaign] should go outside the "#ifdef" section.

=== Selecting first scenario ===

Attribute ''first_scenario'' specifies which scenario should be started first.
Its value must be the same as the value of "id" attribute of the [[ScenarioWML|[scenario]]] tag for given scenario.
For example your campaign can contain:

[campaign]

#...

first_scenario=My_first_scenario

#...

[/campaign]

And the corresponding scenario would contain:

[scenario]

id=My_first_scenario

#...

[/scenario]

Please note that the "id" attribute of the [scenario] tag does not have to be the same as the name of scenario file.
Attribute ''first_scenario'' refers to the "id" attribute of the [scenario] tag, ''not'' to the filename.
(However, you should include all scenario files in your campaign file; read the previous section.)

All scenarios must have unique IDs.
(That is: unique in scope of their campaign.
Because scenarios from different campaigns are never loaded together in memory.)

Campaign tag only specifies the first scenario of the campaign.
Then, each scenario specifies which one will follow.

== The [about] tag ==

{{DevFeature}}

Appears in [campaign] tag.

Attributes:
* ''title'' -- (translatable) title of credits section
* ''text'' -- names of campaign contributors

=== Campaign specific credits ===

A campaign can specify its own credits.
These will be included in the game credits; in the bottom if player has not completed this campaign, in the top if player has completed this campaign.

There can be any number of [about] tags inside a [campaign] tag.
Campaign-specific credits are preceded by the name of campaign.
Each [about] tag contains one section of credits.
Section title is in ''title'' attribute; it must be one of the following values:
* "Campaign Designer"
* "Current Maintainer"
* "Artwork and Graphics Designers"
* "Music"
* "Miscellaneous"

The ''text'' attribute contains the names of contributors, each on separate line.
Example:

#textdomain wesnoth
[about]
title= _"Campaign Designer"
text="Name Surname (nickname)"
[/about]
[about]
title= _"Artwork and Graphics Designers"
text="Artist One
Artist Two"
[/about]

Related forum thread: [http://www.wesnoth.org/forum/viewtopic.php?t=9720 9720].

== A complete example ==

This is a campaign file for campaign "My Campaign"; the file path is "$userdata/campaigns/My_Campaign.cfg".

# This is a main campaign file of campaign "My Campaign".

[textdomain]
name="wesnoth-My_Campaign"
path="data/campaigns/My_Campaign/translations"
[/textdomain]

[binary_path]
path=data/campaigns/My_Campaign/
[/binary_path]

[campaign]
#textdomain wesnoth-My_Campaign

icon=small.png
name= _"My Campaign"
description= _"Hero goes somewhere and does something."
image=large.png

difficulties=EASY,NORMAL,HARD
difficulty_descriptions= {MENU_IMG_TXT2 elvish-fighter.png _"Fighter" _"(easiest)"} + ";"
+ "*" + {MENU_IMG_TXT elvish-hero.png _"Hero" } + ";"
+ {MENU_IMG_TXT2 elvish-champion.png _"Champion" _"(hardest)"}

define=CAMPAIGN_MY_CAMPAIGN

first_scenario=My_first_scenario

# DEVELOPMENT BRANCH ONLY...

#textdomain wesnoth
[about]
title= _"Campaign Designer"
text="Name Surname (nickname)"
[/about]
[about]
title= _"Artwork and Graphics Designers"
text="Artist One
Artist Two"
[/about]

# ...DEVELOPMENT BRANCH ONLY

[/campaign]

#ifdef CAMPAIGN_MY_CAMPAIGN

[+units]
{@campaigns/My_Campaign/units}
[/units]

{@campaigns/My_Campaign/scenarios}

#endif

== See Also ==

* [[PreprocessorRef]]
* [[ScenarioWML]]
* [[ReferenceWML]]
* [[PblWML]]

[[Category: WML Reference]]

SpellingMistakes

2006-07-02T22:59:41Z

Scott: /* The Rise of Wesnoth */

This page is meant to be a list for mistakes in campaigns and other texts in the en_US version of the game.

==Eastern Invasion==
The Outpost, line 120 col 54: "Dacyn's return during in two days". "during" should be deleted. 
The Escape Tunnel, line 174 col 61 and line 180 col 61: "I advise you join us". Should be "I advise you to join us". 
Northern Outpost, line 129 col 138: "the Northlands, were we may". "Were" should be "where". 
Evacuation, line 340 col 68: "an chance of success". "an" should be "any". 
Evacuation, line 344 col 40 : "But is appears we will" should be "But it appears we will"

==Heir to the Throne==
* Snow Plains, line 115, col 93: "as an envoy from we North Elves". "we" should be "us".
* Test of the Clan, line 380, col 50: "the easten plains". "easten" should be "eastern".
* Blackwater Port, line 179: "I offer you my support Konrad, and the support of my men" should be "I offer you my support, Konrad, and the support of my men"
* Swamp Of Dread, line 249: "It is is clear" should have one "is" 
* Home of the North Elves, line 24: "Konrad must reach the elvish forest and resist until the end of turns": the objective has changed to resist until the end of the turn. Don't forget! 
* Elven Council, line 110: "How quickly do the race of men mature!": do should be does.
* Plunging Into the Darkness, line 596: "if you most go on with this mad scheme", most -> must.

==The Rise of Wesnoth==

Rise of Wesnoth, line 430:
"All life is finite," should have a semi-colon to avoid a run-on sentence

==The South Guard==
Born to the Banner, line 437 col 50: "intellegent". Should be "intelligent". 
Proven by the Sword, line 238 col 50: "intellegent". Should be "intelligent". 
A Desperate Errand, line 203 col 50: "recieved". Should be "received". 
Vale of Tears, line 182 col 92: "sacking out towns". "out" should be "our". 
Choice in the Fog, line 230 col 76: "whatever enemies lay beyond". "lay" should be "lie". 
Choice in the Fog, line 661 col 121: "you and you men". Second "you" should be "your". 
Tidings Good And Ill, line 336 col 42: "belive". Should be "believe". 
Into the Depths, line 148 col 53: "less valuable in caves that toughness". "that" should be "than". 
Into the Depths, line 384 col 61: "and lite it". "lite" should be "light". 
Into the Depths, line 499 col 51: "The elves I once lead". "lead" should be "led". 
units/4.Infantry_Commander.cfg, line 21 col 48: "infantry Wesnoth". Should be "infantry of Wesnoth". 
utils/sg_story.cfg, line 11 col 263: "men build new towns". "build" should be "built".

==Two Brothers==
Rooting Out a Mage, line 240 col 51: "two day's ride north". "day's" should be "days'". 
The Chase, line 376, col 266: "endevours". Should be "endeavours". 
Guarded Castle, line 442 col 77: "I can count hundred". Should be "I can count a hundred". 
Return to the Village, line 184 col 114: "It was noone here to stop them". "It" should be "There". 
Return to the Village, line 224 col 90: "fixing the damages". Should be "fixing the damage". 
Return to the Village, line 229 col 122: "to face another grim foe to face". "to face" should appear only once.

==Under the Burning Suns==
02 Across the Harsh Sands, line 1416 col 29: "Ogre Ambush". "ambush" should not be capitalised. 
02 Across the Harsh Sands, line 1424 col 21: "Fresh Meat". "meat" should not be capitalised. 
04 Descending Into Darkness, line 1318 col 34: "squirling". Should be "squirreling". 
05 A Subterranean Struggle, line 2251 col 29: "Burn, Burn and Die". Wrongly capitalised: should be "Burn, burn and die". 
05 A Subterranean Struggle, line 2436 col 45: "Help Me". Should be "Help me". 
05 A Subterranean Struggle, line 2452 col 56 and line 2545 col 52: "Fall Back". Should be "Fall back". 
05 A Subterranean Struggle, line 3131 col 40: "I thought that what". Should be "I thought that was what". 
05 A Subterranean Struggle, line 3136 col 320: "trolls secret weapon". "trolls" should be "trolls'". 
05 A Subterranean Struggle, line 3227 col 47: "was was". Should be only one "was". 
06.1 Hunting Trolls, line 781 col 140: "I will once you finish". Should be "I will return once you finish". 
06.2 In the Domain of the Dwarves, line 1325 col 103 and line 1334 col 103: "the maybe". "the" should be "then". 
06.2 In the Domain of the Dwarves, line 1529 col 13: "Good Riddance". Should be "Good riddance". 
06.2 In the Domain of the Dwarves, line 2103 col 94: "shant". Should be "shan't". 
07.1 Dealing with Dwarves, line 604 col 103: "thorne". Should be "thorn". 
07.1 Dealing with Dwarves, line 647 col 121: "cowards's". Should be "coward's". 
07.2 Talking with Trolls, line 646 col 135: "greatful". Should be "grateful". 
08 Out of the Frying Pan, line 1277 col 101: "damned the river". "damned" should be "dammed". 
08 Out of the Frying Pan, line 1277 col 143: "drown its dark waters". Should be "drown in its dark waters". 
08 Out of the Frying Pan, line 2105 col 132: "in from of". Should be "in front of". 
08 Out of the Frying Pan, line 2484 col 31: "The user feel much better". "feel" should be "feels". 
08 Out of the Frying Pan, line 2810 col 240: "getting it the easy treatment". Delete "it". 
08 Out of the Frying Pan, line 3331 col 37: "Follow Us". Should be "Follow us". 
08 Out of the Frying Pan, line 3358 col 50: "it make my skin crawl". "make" should be "makes". 
09 Blood is Thicker than Water, line 345 col 175: "where Esanoo has come from". "has" should be "had". 
09 Blood is Thicker than Water, line 1127 col 95: "seeked". Should be "sought". 
09 Blood is Thicker than Water, line 1487 col 95: "veneance". Should be "vengeance". 
09 Blood is Thicker than Water, line 1779 col 71, line 1904 col 71, line 2034 col 71 and line 2159 col 71: "We've never seem him". "seem" should be "seen". 
09 Blood is Thicker than Water, line 3354 col 22: "Fresh Meat". "Should be "Fresh meat". 
10 Speaking with the Fishes, line 345 col 718: "the human's capital". "human's" should be "humans'". 
10 Speaking with the Fishes, line 882 col 67: "none of us return alive". Should be "none of us will return alive". 
10 Speaking with the Fishes, line 941 col 659: "all other who". "other" should be "others". 
11 The Battle for Zocthanol Isle, line 318 col 454: "guiding out steps". "out" should be "our". 
11 The Battle for Zocthanol Isle, line 1307 col 96: "complimpents". Should be "compliments". 
11 The Battle for Zocthanol Isle, line 1529 col 152 and line 1560 col 152: "extrances". Should be "entrances". 
units/Cave_spider2.cfg, line 24 col 30: "Cave Spiders are roam". Delete "are". 
units/Crab_Man.cfg, line 23 col 98: "the more twisted monsters every recorded". "more" should be "most", and "every" should be "ever". 
units/Dark_Assassin1.cfg, line 33 col 74; units/Dark_Assassin2.cfg,line 33 col 74; and units/Dark_Assassin3.cfg, line 36 col 74: "a moments notice". "moments" should be "moment's". 
units/Desert_Avenger.cfg, line 52 col 209; and units/Desert_Ranger.cfg, line 51 col 238: "backstabing". Should be "backstabbing". 
units/Dwarvish_Pathfinder.cfg, line 27 col 30: "Dwarvish Pathfinders and faster". "and" should be "are". 
units/Dwarvish_Pathfinder.cfg, line 27 col 135: "The often race". "The" should be "They". 
units/Kaleh_Fighter.cfg, line 46 col 88: "Wesnoth". Should be "Quenoth".

==Editor==

==Other (ingame help, ...)==
data/help.cfg:247
familiarise-familiarize

data/help.cfg:317
"foes who" - "foes that"

data/scenarios/multiplayer/2p_Caves_of_the_Basilisk.cfg:148
amoung - among

data/scenarios/multiplayer/2p_Caves_of_the_Basilisk.cfg:128
"The foul Basilik" - The foul Basilisk

data/scenarios/multiplayer/9p_Merkwuerdigliebe.cfg:7
vilages-villages

Wesnoth Acronyms and Slang

2006-07-01T13:48:11Z

Scott: /* Forum Language */

Use the following list to demystify the various (mostly wesnoth specific) acronyms you may run into at the forum.



== Official Campaigns ==

*EI - "The Eastern Invasion" (campaign name)
*HttT - "Heir to the Throne" (campaign name)
** BoP - "Bay of Pearls" (scenario in "Heir to the Throne" campaign)
** DD - "Dwarven Doors" (scenario in "Heir to the Throne" campaign)
** HotNE - "Home of the North Elves" (scenario in "Heir to the Throne" campaign)
** IotD - "Isle of the Damned" (scenario in "Heir to the Throne" campaign)
** RtW - "Return to Wesnoth" (scenario in "Heir to the Throne" campaign)
** SoE - "Siege of Elensefar" (scenario in "Heir to the Throne" campaign)
** SoF - "Scepter of Fire" (scenario in "Heir to the Throne" campaign)
** TotC - "Test of the Clans" (scenario in "Heir to the Throne" campaign)
** VoD - "Valley of Death" (scenario in "Heir to the Throne" campaign)
*SG - "The South Guard" (campaign name)
*TRoW - "The Rise of Wesnoth" (campaign name)
*TB - "A Tale of Two Brothers" (campaign name)
*UtBS - "Under the Burning Suns" (campaign name)

== Unofficial Campaigns ==

*FtF - "Flight to Freedom" (campaign name)
*LOW - "Legends of Wesmere" (campaign name)
*SE - "Saving Elensefar" (campaign name)
*SoF - "Scepter of Fire" (campaign name)

== Forum Language ==

*AAU - Allies Are Useless
*AMLA - After Maximum Level Advancement
*AH - All Hits
*BfW - Battle for Wesnoth (the name of the game)
*BWH - Been suggested before. We think it's a good idea. Hope to add it eventually.
*CtH - Chance to Hit (also C2H)
*CtbH - Chance to be Hit (also C2bH)
*CtK - Chance to Kill (also C2K)
*CtbK - Chance to be Killed (also C2bK)
*CVS - Old term for up-to-date Wesnoth: [[WesnothCVS]]
*EP - Elvish Pillager, moderator and great man :) at forum
*FoW - Fog of War (i.e. fog)
*FFA - Free For All (playing a map with >2 players without teams)
*HAPMA - Hexes Are Possibly Miles Across - http://www.wesnoth.org/forum/viewtopic.php?t=1882
*HP - Hit points
*IIRWIIR - It Is Ready When It Is Ready
*KISS - Keep It Simple, Stupid: Applies to coding, not game rules (although indirectly it does): see [[WesnothPhilosophy]]
*MP - Movement points
*MP - Multiplayer
*MOP - Monster of perfection
*MoL - Mage of Light
*N3T - No 3-Teams; A belief stating that contests between exactly three opposing forces are inherently unbalanced
*OAB - Options are Bad; In reference to gameplay, not user interface options. Mostly used by Turin. See also [[FrequentlyProposedIdeas]] (idea #1)
*OFWRA - Old Flame War Revival Alert; In other words, we have discussed this before and have no interest in discussing it again, especially if it got ugly
*OT - Off Topic: can refer to either the forum (http://www.wesnoth.org/forum/viewforum.php?f=11) or spam
*RIPLIB - Reduction In Power when Leveling Is Bad: means that when a unit upgrades, at least one of its options should be strictly superior to the original unit. [http://www.wesnoth.org/forum/viewtopic.php?t=1423 Reference 1] / [http://www.wesnoth.org/forum/viewtopic.php?t=7205 Reference 2]
*RPG - Role Playing Game - Wesnoth's experience system: http://www.wesnoth.org/forum/viewtopic.php?t=4385
*RTFM - Read The Manual
*RTS - Real Time Strategy Game - not Wesnoth
*SP - Single Player (Campaigns)
*SVN - Term for up-to-date Wesnoth [[WesnothSVN]] ([[What_Is_SVN]])
*TBS - Turn Based Strategy Game - Wesnoth
*TWP - The Wesnoth Philosophy: [[WesnothPhilosophy]]
*UMC - User Made Campaign (any campaign not packaged with Wesnoth)
*WC - Walking Corpses
*WICOT - WML is capable of this (the requested feature is already possible to script, so no need to hard-code it in C++)
*WINR - Wesnoth Is Not Realistic
*WIN_ - Wesnoth Is Not... (Warcraft, Lord of the Rings, medieval Europe, an RPG, a wargame, a war simulation, etc.)
*WML - Wesnoth Markup Language: [[ReferenceWML]]
*XP - Experience
*ZOC - Zone of Control

== General Acronyms ==

*AFAICT - As Far As I Can Tell(A statement with a disclaimer on truthfulness)
*AFAIK - As Far As I Know (A statement with a disclaimer on truthfulness)
*BTW - By the Way (A statement with a disclaimer on relevance)
*OtOH - On the Other Hand (A contrast)
*EV - Expected Value
*IIRC - If I Recall Correctly (A statement with a disclaimer on truthfulness)
*IMHO - In My Humble Opinion (A statement with a disclaimer on objectiveness)
*IMO - In My Opinion (A statement with a disclaimer on objectiveness)
*NYSPOS - No, you stupid piece of **** (An impolite refutation hidden in an acronym)

== See Also ==

* Enter other resources in here.

WesnothRepository

2006-06-30T15:03:41Z

Scott: /* See Also */

{{Compiling Wesnoth}}
== SVN ==

Wesnoth development currently uses the Subversion
software tool to keep developers in sync with each other. See the
[http://svnbook.org SVN book] for
more on how to use Subversion.

== Browse the code ==

There are currently two main streams of development: trunk (1.1.x) and branch (1.0.x). There is also a branch for a Python interface to the AI. You can use your web browser to navigate through the source code:

http://svn.gna.org/viewcvs/wesnoth/

== Download ==

To check out trunk into a directory ''wesnoth'':
svn co http://svn.gna.org/svn/wesnoth/trunk wesnoth

or to check out the 1.0 branch into a directory ''wesnoth-1.0'':
svn co http://svn.gna.org/svn/wesnoth/branches/1.0 wesnoth-1.0

More info on the repository: https://gna.org/svn/?group=wesnoth

== Update ==

Do this from inside the ''wesnoth'' or ''wesnoth-1.0'' directory where you checked out the repository:
svn update

Note that when you update from Subversion, you should always run 'autogen.sh' if ''configure.ac'' or any of the ''Makefile.am'' files were changed. It is safest to 'make clean' before updating, then update and finally run 'autogen.sh', 'configure' and 'make'.

You may be able to skip the 'autogen.sh' and the 'make clean' if the makefiles and ''configure.ac'' have not changed. If only minor changes were made then even the 'configure' step is optional.

== See Also ==

* [[CompilingWesnoth]]
* [[UsingAutotools]]
* [[What_Is_SVN]]

Wesnoth Acronyms and Slang

2006-06-30T15:02:16Z

Scott: /* Forum Language */

Use the following list to demystify the various (mostly wesnoth specific) acronyms you may run into at the forum.



== Official Campaigns ==

*EI - "The Eastern Invasion" (campaign name)
*HttT - "Heir to the Throne" (campaign name)
** BoP - "Bay of Pearls" (scenario in "Heir to the Throne" campaign)
** DD - "Dwarven Doors" (scenario in "Heir to the Throne" campaign)
** HotNE - "Home of the North Elves" (scenario in "Heir to the Throne" campaign)
** IotD - "Isle of the Damned" (scenario in "Heir to the Throne" campaign)
** RtW - "Return to Wesnoth" (scenario in "Heir to the Throne" campaign)
** SoE - "Siege of Elensefar" (scenario in "Heir to the Throne" campaign)
** SoF - "Scepter of Fire" (scenario in "Heir to the Throne" campaign)
** TotC - "Test of the Clans" (scenario in "Heir to the Throne" campaign)
** VoD - "Valley of Death" (scenario in "Heir to the Throne" campaign)
*SG - "The South Guard" (campaign name)
*TRoW - "The Rise of Wesnoth" (campaign name)
*TB - "A Tale of Two Brothers" (campaign name)
*UtBS - "Under the Burning Suns" (campaign name)

== Unofficial Campaigns ==

*FtF - "Flight to Freedom" (campaign name)
*LOW - "Legends of Wesmere" (campaign name)
*SE - "Saving Elensefar" (campaign name)
*SoF - "Scepter of Fire" (campaign name)

== Forum Language ==

*AAU - Allies Are Useless
*AMLA - After Maximum Level Advancement
*AH - All Hits
*BfW - Battle for Wesnoth (the name of the game)
*BWH - Been suggested before. We think it's a good idea. Hope to add it eventually.
*CtH - Chance to Hit (also C2H)
*CtbH - Chance to be Hit (also C2bH)
*CtK - Chance to Kill (also C2K)
*CtbK - Chance to be Killed (also C2bK)
*CVS - Old term for up-to-date Wesnoth: [[WesnothCVS]]
*EP - Elvish Pillager, moderator and great man :) at forum
*FoW - Fog of War (i.e. fog)
*FFA - Free For All (playing a map with >2 players without teams)
*HAPMA - Hexes Are Possibly Miles Across - http://www.wesnoth.org/forum/viewtopic.php?t=1882
*HP - Hit points
*IIRWIIR - It Is Ready When It Is Ready
*KISS - Keep It Simple, Stupid: Applies to coding, not game rules (although indirectly it does): see [[WesnothPhilosophy]]
*MP - Movement points
*MP - Multiplayer
*MOP - Monster of perfection
*MoL - Mage of Light
*N3T - No 3-Teams; A belief stating that contests between exactly three opposing forces are inherently unbalanced
*OAB - Options are Bad; In reference to gameplay, not user interface options. mostly used by Turin. See also [[FrequentlyProposedIdeas]] (idea #1)
*OFWRA - Old Flame War Revival Alert
*OT - Off Topic: can refer to either the forum (http://www.wesnoth.org/forum/viewforum.php?f=11) or spam
*RIPLIB - Reduction In Power when Leveling Is Bad: means that when a unit upgrades, at least one of its options should be strictly superior to the original unit. [http://www.wesnoth.org/forum/viewtopic.php?t=1423 Reference 1] / [http://www.wesnoth.org/forum/viewtopic.php?t=7205 Reference 2]
*RPG - Role Playing Game - Wesnoth's experience system: http://www.wesnoth.org/forum/viewtopic.php?t=4385
*RTFM - Read The Manual
*RTS - Real Time Strategy Game - not Wesnoth
*SP - Single Player (Campaigns)
*SVN - Term for up-to-date Wesnoth [[WesnothSVN]] ([[What_Is_SVN]])
*TBS - Turn Based Strategy Game - Wesnoth
*TWP - The Wesnoth Philosophy: [[WesnothPhilosophy]]
*UMC - User Made Campaign (any campaign not packaged with Wesnoth)
*WC - Walking Corpses
*WICOT - WML is capable of this (the requested feature is already possible to script, so no need to hard-code it in C++)
*WINR - Wesnoth Is Not Realistic
*WIN_ - Wesnoth Is Not... (Warcraft, Lord of the Rings, medieval Europe, an RPG, a wargame, a war simulation, etc.)
*WML - Wesnoth Markup Language: [[ReferenceWML]]
*XP - Experience
*ZOC - Zone of Control

== General Acronyms ==

*AFAICT - As Far As I Can Tell(A statement with a disclaimer on truthfulness)
*AFAIK - As Far As I Know (A statement with a disclaimer on truthfulness)
*BTW - By the Way (A statement with a disclaimer on relevance)
*OtOH - On the Other Hand (A contrast)
*EV - Expected Value
*IIRC - If I Recall Correctly (A statement with a disclaimer on truthfulness)
*IMHO - In My Humble Opinion (A statement with a disclaimer on objectiveness)
*IMO - In My Opinion (A statement with a disclaimer on objectiveness)
*NYSPOS - No, you stupid piece of **** (An impolite refutation hidden in an acronym)

== See Also ==

* Enter other resources in here.

Wesnoth Acronyms and Slang

2006-06-30T15:02:02Z

Scott: /* Forum Language */

Use the following list to demystify the various (mostly wesnoth specific) acronyms you may run into at the forum.



== Official Campaigns ==

*EI - "The Eastern Invasion" (campaign name)
*HttT - "Heir to the Throne" (campaign name)
** BoP - "Bay of Pearls" (scenario in "Heir to the Throne" campaign)
** DD - "Dwarven Doors" (scenario in "Heir to the Throne" campaign)
** HotNE - "Home of the North Elves" (scenario in "Heir to the Throne" campaign)
** IotD - "Isle of the Damned" (scenario in "Heir to the Throne" campaign)
** RtW - "Return to Wesnoth" (scenario in "Heir to the Throne" campaign)
** SoE - "Siege of Elensefar" (scenario in "Heir to the Throne" campaign)
** SoF - "Scepter of Fire" (scenario in "Heir to the Throne" campaign)
** TotC - "Test of the Clans" (scenario in "Heir to the Throne" campaign)
** VoD - "Valley of Death" (scenario in "Heir to the Throne" campaign)
*SG - "The South Guard" (campaign name)
*TRoW - "The Rise of Wesnoth" (campaign name)
*TB - "A Tale of Two Brothers" (campaign name)
*UtBS - "Under the Burning Suns" (campaign name)

== Unofficial Campaigns ==

*FtF - "Flight to Freedom" (campaign name)
*LOW - "Legends of Wesmere" (campaign name)
*SE - "Saving Elensefar" (campaign name)
*SoF - "Scepter of Fire" (campaign name)

== Forum Language ==

*AAU - Allies Are Useless
*AMLA - After Maximum Level Advancement
*AH - All Hits
*BfW - Battle for Wesnoth (the name of the game)
*BWH - Been suggested before. We think it's a good idea. Hope to add it eventually.
*CtH - Chance to Hit (also C2H)
*CtbH - Chance to be Hit (also C2bH)
*CtK - Chance to Kill (also C2K)
*CtbK - Chance to be Killed (also C2bK)
*CVS - Old term for up-to-date Wesnoth: [[WesnothCVS]]
*EP - Elvish Pillager, moderator and great man :) at forum
*FoW - Fog of War (i.e. fog)
*FFA - Free For All (playing a map with >2 players without teams)
*HAPMA - Hexes Are Possibly Miles Across - http://www.wesnoth.org/forum/viewtopic.php?t=1882
*HP - Hit points
*IIRWIIR - It Is Ready When It Is Ready
*KISS - Keep It Simple, Stupid: Applies to coding, not game rules (although indirectly it does): see [[WesnothPhilosophy]]
*MP - Movement points
*MP - Multiplayer
*MOP - Monster of perfection
*MoL - Mage of Light
*N3T - No 3-Teams; A belief stating that contests between exactly three opposing forces are inherently unbalanced
*OAB - Options are Bad; In reference to gameplay, not user interface options. mostly used by Turin. See also [[FrequentlyProposedIdeas]] (idea #1)
*OFWRA - Old Flame War Revival Alert
*OT - Off Topic: can refer to either the forum (http://www.wesnoth.org/forum/viewforum.php?f=11) or spam
*RIPLIB - Reduction In Power when Leveling Is Bad: means that when a unit upgrades, at least one of its options should be strictly superior to the original unit. [http://www.wesnoth.org/forum/viewtopic.php?t=1423 Reference 1] / [http://www.wesnoth.org/forum/viewtopic.php?t=7205 Reference 2]
*RPG - Role Playing Game - Wesnoth's experience system: http://www.wesnoth.org/forum/viewtopic.php?t=4385
*RTFM - Read The Manual
*RTS - Real Time Strategy Game - not Wesnoth
*SP - Single Player (Campaigns)
*SVN - Term for up-to-date Wesnoth [[WesnothSVN]] [[What_Is_SVN]]
*TBS - Turn Based Strategy Game - Wesnoth
*TWP - The Wesnoth Philosophy: [[WesnothPhilosophy]]
*UMC - User Made Campaign (any campaign not packaged with Wesnoth)
*WC - Walking Corpses
*WICOT - WML is capable of this (the requested feature is already possible to script, so no need to hard-code it in C++)
*WINR - Wesnoth Is Not Realistic
*WIN_ - Wesnoth Is Not... (Warcraft, Lord of the Rings, medieval Europe, an RPG, a wargame, a war simulation, etc.)
*WML - Wesnoth Markup Language: [[ReferenceWML]]
*XP - Experience
*ZOC - Zone of Control

== General Acronyms ==

*AFAICT - As Far As I Can Tell(A statement with a disclaimer on truthfulness)
*AFAIK - As Far As I Know (A statement with a disclaimer on truthfulness)
*BTW - By the Way (A statement with a disclaimer on relevance)
*OtOH - On the Other Hand (A contrast)
*EV - Expected Value
*IIRC - If I Recall Correctly (A statement with a disclaimer on truthfulness)
*IMHO - In My Humble Opinion (A statement with a disclaimer on objectiveness)
*IMO - In My Opinion (A statement with a disclaimer on objectiveness)
*NYSPOS - No, you stupid piece of **** (An impolite refutation hidden in an acronym)

== See Also ==

* Enter other resources in here.

Wesnoth Acronyms and Slang

2006-06-30T15:01:18Z

Scott: /* Forum Language */

Use the following list to demystify the various (mostly wesnoth specific) acronyms you may run into at the forum.



== Official Campaigns ==

*EI - "The Eastern Invasion" (campaign name)
*HttT - "Heir to the Throne" (campaign name)
** BoP - "Bay of Pearls" (scenario in "Heir to the Throne" campaign)
** DD - "Dwarven Doors" (scenario in "Heir to the Throne" campaign)
** HotNE - "Home of the North Elves" (scenario in "Heir to the Throne" campaign)
** IotD - "Isle of the Damned" (scenario in "Heir to the Throne" campaign)
** RtW - "Return to Wesnoth" (scenario in "Heir to the Throne" campaign)
** SoE - "Siege of Elensefar" (scenario in "Heir to the Throne" campaign)
** SoF - "Scepter of Fire" (scenario in "Heir to the Throne" campaign)
** TotC - "Test of the Clans" (scenario in "Heir to the Throne" campaign)
** VoD - "Valley of Death" (scenario in "Heir to the Throne" campaign)
*SG - "The South Guard" (campaign name)
*TRoW - "The Rise of Wesnoth" (campaign name)
*TB - "A Tale of Two Brothers" (campaign name)
*UtBS - "Under the Burning Suns" (campaign name)

== Unofficial Campaigns ==

*FtF - "Flight to Freedom" (campaign name)
*LOW - "Legends of Wesmere" (campaign name)
*SE - "Saving Elensefar" (campaign name)
*SoF - "Scepter of Fire" (campaign name)

== Forum Language ==

*AAU - Allies Are Useless
*AMLA - After Maximum Level Advancement
*AH - All Hits
*BfW - Battle for Wesnoth (the name of the game)
*BWH - Been suggested before. We think it's a good idea. Hope to add it eventually.
*CtH - Chance to Hit (also C2H)
*CtbH - Chance to be Hit (also C2bH)
*CtK - Chance to Kill (also C2K)
*CtbK - Chance to be Killed (also C2bK)
*CVS - Old term for up-to-date Wesnoth: [[WesnothCVS]]
*EP - Elvish Pillager, moderator and great man :) at forum
*FoW - Fog of War (i.e. fog)
*FFA - Free For All (playing a map with >2 players without teams)
*HAPMA - Hexes Are Possibly Miles Across - http://www.wesnoth.org/forum/viewtopic.php?t=1882
*HP - Hit points
*IIRWIIR - It Is Ready When It Is Ready
*KISS - Keep It Simple, Stupid: Applies to coding, not game rules (although indirectly it does): see [[WesnothPhilosophy]]
*MP - Movement points
*MP - Multiplayer
*MOP - Monster of perfection
*MoL - Mage of Light
*N3T - No 3-Teams; A belief stating that contests between exactly three opposing forces are inherently unbalanced
*OAB - Options are Bad; In reference to gameplay, not user interface options. mostly used by Turin. See also [[FrequentlyProposedIdeas]] (idea #1)
*OFWRA - Old Flame War Revival Alert
*OT - Off Topic: can refer to either the forum (http://www.wesnoth.org/forum/viewforum.php?f=11) or spam
*RIPLIB - Reduction In Power when Leveling Is Bad: means that when a unit upgrades, at least one of its options should be strictly superior to the original unit. [http://www.wesnoth.org/forum/viewtopic.php?t=1423 Reference 1] / [http://www.wesnoth.org/forum/viewtopic.php?t=7205 Reference 2]
*RPG - Role Playing Game - Wesnoth's experience system: http://www.wesnoth.org/forum/viewtopic.php?t=4385
*RTFM - Read The Manual
*RTS - Real Time Strategy Game - not Wesnoth
*SP - Single Player (Campaigns)
*SVN - Term for up-to-date Wesnoth [[WesnothSVN]] [[WhatIsSVN]]
*TBS - Turn Based Strategy Game - Wesnoth
*TWP - The Wesnoth Philosophy: [[WesnothPhilosophy]]
*UMC - User Made Campaign (any campaign not packaged with Wesnoth)
*WC - Walking Corpses
*WICOT - WML is capable of this (the requested feature is already possible to script, so no need to hard-code it in C++)
*WINR - Wesnoth Is Not Realistic
*WIN_ - Wesnoth Is Not... (Warcraft, Lord of the Rings, medieval Europe, an RPG, a wargame, a war simulation, etc.)
*WML - Wesnoth Markup Language: [[ReferenceWML]]
*XP - Experience
*ZOC - Zone of Control

== General Acronyms ==

*AFAICT - As Far As I Can Tell(A statement with a disclaimer on truthfulness)
*AFAIK - As Far As I Know (A statement with a disclaimer on truthfulness)
*BTW - By the Way (A statement with a disclaimer on relevance)
*OtOH - On the Other Hand (A contrast)
*EV - Expected Value
*IIRC - If I Recall Correctly (A statement with a disclaimer on truthfulness)
*IMHO - In My Humble Opinion (A statement with a disclaimer on objectiveness)
*IMO - In My Opinion (A statement with a disclaimer on objectiveness)
*NYSPOS - No, you stupid piece of **** (An impolite refutation hidden in an acronym)

== See Also ==

* Enter other resources in here.

SpellingMistakes

2006-06-28T19:21:47Z

Scott: /* Heir to the Throne */

2006-06-09T16:27:01Z

Scott: /* Command Mode */

== Command Mode ==

You can access command mode by typing ' ''':''' ' in a single player or multiplayer scenario.
(Prior to version 1.1.1, you need to type shift - semicolon( ''';''' ). However this isn't possible on all keyboards; if your keyboard doesn't have ':' above ';' you can change the hotkey in the Preferences, or you could edit '''game.cfg''' by hand.')

Note: you can highlight, copy, and paste text in debug mode.

Several vi-like commands are available in command mode. They are defined in ''playturn.cpp'' in the ''turn_info::do_command()'' function:
;<nowiki>:q or :q!</nowiki>
:quit the scenario (without prompting)
;<nowiki>:w</nowiki>
:save the game (without prompting)
;<nowiki>:wq</nowiki>
:save the game and quit the scenario (without prompting)
;<nowiki>:refresh</nowiki>
:redraw the screen
;<nowiki>:droid</nowiki> ''side''
:toggle player on ''side'' between human and AI player. The player/client who controls that side needs to issue this command. If you don't provide ''side'', '1' is assumed.
;<nowiki>:muteall</nowiki>
:toggles muting/silencing of all observers on/off
;<nowiki>:mute</nowiki> ''username''
:mute a specific observer. If no ''username'' is supplied the muted usernames are displayed.
;<nowiki>:kick</nowiki> ''username''
:kick a user in multiplayer. They will be able to rejoin the game. Generally a friendly way to remove someone who is having connection or other difficulties.
;<nowiki>:ban</nowiki> ''username''
:kick and ban a user in multiplayer, and the IP address used by that ''username''.
;<nowiki>:control</nowiki> ''side'' ''username''
:change the controller for ''side'' (write here the number of the side, the side must be controlled by you) to ''username'' (write here the nick of the player or observer)
;<nowiki>:clear</nowiki>
:clear chat messages
;<nowiki>:debug</nowiki>
:switch debug mode on (does not work in multiplayer). Debug mode is turned off by quitting the game.
;<nowiki>:theme</nowiki>
:bring up theme selection menu

===Extra Debugging Commands===
[[DebugMode]] enables additional commands in command mode:

;<nowiki>:n</nowiki>
:skip to next scenario by triggering a win event
;<nowiki>:gold</nowiki> ''amount''
:add ''amount'' gold to the current player's side
;<nowiki>:create</nowiki> ''unit_type''
:create a unit of type specified at last selected hex
;<nowiki>:unit</nowiki> ''attribute=value''
:when a unit is selected, this will set the unit's ''attribute'' to ''value''. See [[SingleUnitWML]] for possible values.

== See Also ==

* [[DebugMode]]
* [[DeveloperResources]]

EventWML

2006-06-09T16:16:36Z

Scott: /* Nested events */

EventWML

2006-06-09T16:15:33Z

Scott: /* the [event] tag */

{{WML Tags}}
== the [event] tag ==

This tag is a subtag of [scenario] (or [unit] - see '''event''', [[UnitWML]]) which is used to describe a set of actions
which trigger at a certain point in the scenario.

keys and tags that describe when the event should trigger:
<ul><li> ''name'' this is not like a normal 'name' key. It is a basic description of when the event will trigger.
* ''prestart'' the event is triggered before a scenario 'starts' -- before anything is shown on the screen at all. You can use this event to set up things like village ownership. For things displayed on-screen such as character dialog, use 'start'.
* ''start'' this event triggers after the map is shown but before the scenario begins
* ''new turn'' this event triggers whenever the last player ends their turn. See also '''first_time_only=no'''. When the last player ends their turn, before any events of this type trigger, the value of the WML variable '''turn_number''' is set to the number of the turn that is beginning.
* ''side turn'' this event triggers when any player ends their turn. When a player ends their turn, before any events of this type trigger, the value of the WML variable '''side_number''' is set to the number of the side of the player about to take their turn.
* ''turn ''X'''' this event triggers at the start of turn ''X''. ''X'' cannot be 1.
* ''time over'' this event triggers on turn ''turns''. (''turns'' is specified in [scenario])
* ''enemies defeated'' this event triggers when all units with '''canrecruit=1''' (i.e. all leaders) not allied with side 1 are killed.
* ''victory'' in this scenario, any tag of the form '''[endlevel] result=victory [/endlevel]''' will be automatically preceded by all actions in this tag. It helps debugging if the victory event allows you to safely advance to any of the possible next maps after using the ":n" command. Scenarios where key units are picked up before the victory, or where some action chosen earlier determines which map to advance to, make it hard to quickly test scenarios in a campaign. (See also [endlevel], [[DirectActionsWML]])
* ''defeat'' in this scenario, any tag of the form '''[endlevel] result=defeat [/endlevel]''' will be automatically preceded by all actions in this tag. (See also [endlevel], [[DirectActionsWML]])
* ''ai turn'' is triggered just before the AI is invoked for a player. This is called after ''side turn'', so if you move a unit here, its movement will not be reset .

Events with the following trigger types can be filtered on (see [[FilterWML]]).
Whenever one of these events is triggered,
the position of ''primary_unit'' is stored in the variables 'x1' and 'y1',
and the position of ''secondary_unit'' is stored in 'x2' and 'y2'.

* ''moveto'' triggers after ''primary_unit'' moves. Usually the location of ''primary_unit'' is also filtered on; remember that this is the location that ''primary_unit'' lands on, not the location it started on or any location it travels on.
* ''sighted'' this event triggers when ''primary_unit'' moves to a location where ''secondary_unit'' is in ''primary_unit'''s sight range.
* ''attack'' this event triggers when ''primary_unit'' attacks ''secondary_unit''.
* ''attacker_hits'' {{DevFeature}} this event triggers when the attacker (''primary_unit'') hits the defender (''secondary_unit'').
* ''attacker_misses'' {{DevFeature}} same as ''attacker_hits'', but is triggered when the attacker misses.
* ''defender_hits'' {{DevFeature}} this event triggers when the attacker (''primary_unit'') is hit in retaliation by the defender (''secondary_unit'').
* ''defender_misses'' {{DevFeature}} same as ''defender_hits'', but is triggered when the defender misses.
* ''attack_end'' {{DevFeature}} is similar to ''attack'', but is instead triggered after the fight, not before. Note that if either unit is killed during the fight, this event triggers before any ''die'' events.
* ''stone'' this event triggers when ''primary_unit'' is hit by an attack with the 'stones' ability (See ''stones'', [[AbilitiesWML]]) by ''secondary_unit'' (''secondary_unit'' is the unit with the 'stones' ability.)
* ''die'' this event triggers when ''primary_unit'' is killed by ''secondary_unit''.
* ''capture'' this event triggers when ''primary_unit'' captures a village. The village may have been previously neutral, or previously owned by another side; merely moving into your own villages does not constitute a capture.
* ''recruit'' this event triggers when ''primary_unit'' is recruited or recalled. (That is, when a unit is recruited or recalled, it will trigger this event and this event's filter will filter that unit.)
* ''advance'' {{DevFeature}} this event triggers just before ''primary_unit'' is going to advance to another unit.
* ''post_advance'' {{DevFeature}} this event triggers just after ''primary_unit'' has advanced to another unit.
* ''select'' {{DevFeature}} triggers when a unit is selected. Mainly useful for the tutorial.

An '''[allow_undo]''' tag anywhere within a moveto event will cancel any lack of undo functionality the event would have
caused. It is up to the scenario designer to avoid abusing this command by allowing undo on events that shouldn't be
undoable. The results of doing this may be strange. This actually does have functionality beyond aesthetics like
signs: suppose you have an event that performs some action depending on the condition of an 'if' statement. This event
might be executed on every single move, but the body of the 'if' statement entered only in a few cases. Previously
this would completely disable undo for the entire scenario, while now it can be made to only disable undo in the cases
where the event mutates the scenario.
</li></ul>

''Primary_unit'' can be referred to as '''unit''' and ''Secondary_unit'' can be referred to as '''second_unit''' in [message] tags. For example:
[event]
name=die
[message]
speaker=second_unit
message="Hahaha, I finally killed you!"
[/message]

[message]
speaker=unit
message="It's not over yet! I'll come back to haunt you!"
[/message]
[/event]

These keys and tags are more complex ways to filter when an event should trigger:
* ''first_time_only'' whether the event should be removed from the scenario after it is triggered. Default is 'yes'.
* '''[filter]''' the event will only trigger if ''primary_unit'' matches this filter.
** standard unit filter - attributes for [filter] are described in [[FilterWML]]
* '''[filter_second]''' is like [filter], but for ''secondary_unit''.
** standard unit filter
* '''[special_filter]''' and '''[special_filter_second]''' {{DevFeature}} can be used to set some additional filtering criteria for ''primary_unit'' and ''secondary_unit'' that are not generally available in a standard unit filter. Can be used in events ''attack'', ''attacker_hits'', ''attacker_misses'', ''defender_hits'', ''defender_misses'' and ''attack_end''.
** ''weapon'' the name of the weapon used.
** ''terrain'' the letter of the terrain the unit is on.

=== Actions triggered by [event] ===

After the trigger conditions have been met, all action tags within the [event] tag are executed in the order they are written in.

There are 3 main types of actions:
* direct actions ([[DirectActionsWML]]) which have a direct effect on gameplay
* display actions ([[InterfaceActionsWML]]) which show something to the user
* internal actions ([[InternalActionsWML]]) which are used by WML internally

Several actions use standard filters to find out which units
to execute the command on. These are denoted by the phrases
"standard unit filter" and "standard location filter".

=== Nested events ===

There is 1 special type of action: event creation. By placing an '''[event]''' tag inside another '''[event]''' tag, the nested event is created when the outer event executes. For example, you could create a portal that opens on turn 10. The outer event executes on turn 10, creating the nested moveto event, which executes when a player steps on a certain spot. An equivalent way of doing this would be to a single moveto event with an if statement to check for turn number, but nested '''[event]''' tags is a simple and elegant way to accomplish more complex tasks without resorting to excessive if statements.

== See Also ==

* [[DirectActionsWML]]
* [[InternalActionsWML]]
* [[InterfaceActionsWML]]
* [[FilterWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

EventWML

2006-06-09T16:14:43Z

Scott: /* the [event] tag */

{{WML Tags}}
== the [event] tag ==

This tag is a subtag of [scenario] (or [unit] - see '''event''', [[UnitWML]]) which is used to describe a set of actions
which trigger at a certain point in the scenario.

keys and tags that describe when the event should trigger:
<ul><li> ''name'' this is not like a normal 'name' key. It is a basic description of when the event will trigger.
* ''prestart'' the event is triggered before a scenario 'starts' -- before anything is shown on the screen at all. You can use this event to set up things like village ownership. For things displayed on-screen such as character dialog, use 'start'.
* ''start'' this event triggers after the map is shown but before the scenario begins
* ''new turn'' this event triggers whenever the last player ends their turn. See also '''first_time_only=no'''. When the last player ends their turn, before any events of this type trigger, the value of the WML variable '''turn_number''' is set to the number of the turn that is beginning.
* ''side turn'' this event triggers when any player ends their turn. When a player ends their turn, before any events of this type trigger, the value of the WML variable '''side_number''' is set to the number of the side of the player about to take their turn.
* ''turn ''X'''' this event triggers at the start of turn ''X''. ''X'' cannot be 1.
* ''time over'' this event triggers on turn ''turns''. (''turns'' is specified in [scenario])
* ''enemies defeated'' this event triggers when all units with '''canrecruit=1''' (i.e. all leaders) not allied with side 1 are killed.
* ''victory'' in this scenario, any tag of the form '''[endlevel] result=victory [/endlevel]''' will be automatically preceded by all actions in this tag. It helps debugging if the victory event allows you to safely advance to any of the possible next maps after using the ":n" command. Scenarios where key units are picked up before the victory, or where some action chosen earlier determines which map to advance to, make it hard to quickly test scenarios in a campaign. (See also [endlevel], [[DirectActionsWML]])
* ''defeat'' in this scenario, any tag of the form '''[endlevel] result=defeat [/endlevel]''' will be automatically preceded by all actions in this tag. (See also [endlevel], [[DirectActionsWML]])
* ''ai turn'' is triggered just before the AI is invoked for a player. This is called after ''side turn'', so if you move a unit here, its movement will not be reset .

Events with the following trigger types can be filtered on (see [[FilterWML]]).
Whenever one of these events is triggered,
the position of ''primary_unit'' is stored in the variables 'x1' and 'y1',
and the position of ''secondary_unit'' is stored in 'x2' and 'y2'.

* ''moveto'' triggers after ''primary_unit'' moves. Usually the location of ''primary_unit'' is also filtered on; remember that this is the location that ''primary_unit'' lands on, not the location it started on or any location it travels on.
* ''sighted'' this event triggers when ''primary_unit'' moves to a location where ''secondary_unit'' is in ''primary_unit'''s sight range.
* ''attack'' this event triggers when ''primary_unit'' attacks ''secondary_unit''.
* ''attacker_hits'' {{DevFeature}} this event triggers when the attacker (''primary_unit'') hits the defender (''secondary_unit'').
* ''attacker_misses'' {{DevFeature}} same as ''attacker_hits'', but is triggered when the attacker misses.
* ''defender_hits'' {{DevFeature}} this event triggers when the attacker (''primary_unit'') is hit in retaliation by the defender (''secondary_unit'').
* ''defender_misses'' {{DevFeature}} same as ''defender_hits'', but is triggered when the defender misses.
* ''attack_end'' {{DevFeature}} is similar to ''attack'', but is instead triggered after the fight, not before. Note that if either unit is killed during the fight, this event triggers before any ''die'' events.
* ''stone'' this event triggers when ''primary_unit'' is hit by an attack with the 'stones' ability (See ''stones'', [[AbilitiesWML]]) by ''secondary_unit'' (''secondary_unit'' is the unit with the 'stones' ability.)
* ''die'' this event triggers when ''primary_unit'' is killed by ''secondary_unit''.
* ''capture'' this event triggers when ''primary_unit'' captures a village. The village may have been previously neutral, or previously owned by another side; merely moving into your own villages does not constitute a capture.
* ''recruit'' this event triggers when ''primary_unit'' is recruited or recalled. (That is, when a unit is recruited or recalled, it will trigger this event and this event's filter will filter that unit.)
* ''advance'' {{DevFeature}} this event triggers just before ''primary_unit'' is going to advance to another unit.
* ''post_advance'' {{DevFeature}} this event triggers just after ''primary_unit'' has advanced to another unit.
* ''select'' {{DevFeature}} triggers when a unit is selected. Mainly useful for the tutorial.

An '''[allow_undo]''' tag anywhere within a moveto event will cancel any lack of undo functionality the event would have
caused. It is up to the scenario designer to avoid abusing this command by allowing undo on events that shouldn't be
undoable. The results of doing this may be strange. This actually does have functionality beyond aesthetics like
signs: suppose you have an event that performs some action depending on the condition of an 'if' statement. This event
might be executed on every single move, but the body of the 'if' statement entered only in a few cases. Previously
this would completely disable undo for the entire scenario, while now it can be made to only disable undo in the cases
where the event mutates the scenario.
</li></ul>

''Primary_unit'' can be referred to as '''unit''' and ''Secondary_unit'' can be referred to as '''second_unit''' in [message] tags. For example:
[event]
name=die
[message]
speaker=second_unit
message="Hahaha, I finally killed you!"
[/message]

[message]
speaker=unit
message="It's not over yet! I'll come back to haunt you!"
[/message]
[/event]

These keys and tags are more complex ways to filter when an event should trigger:
* ''first_time_only'' whether the event should be removed from the scenario after it is triggered. Default is 'yes'.
* '''[filter]''' the event will only trigger if ''primary_unit'' matches this filter.
** standard unit filter - attributes for [filter] are described in [[FilterWML]]
* '''[filter_second]''' is like [filter], but for ''secondary_unit''.
** standard unit filter
* '''[special_filter]''' and '''[special_filter_second]''' {{DevFeature}} can be used to set some additional filtering criteria for ''primary_unit'' and ''secondary_unit'' that are not generally available in a standard unit filter. Can be used in events ''attack'', ''attacker_hits'', ''attacker_misses'', ''defender_hits'', ''defender_misses'' and ''attack_end''.
** ''weapon'' the name of the weapon used.
** ''terrain'' the letter of the terrain the unit is on.

=== Actions triggered by [event] ===

After the trigger conditions have been met, all action tags within the [event] tag are executed in the order they are written in.

There are 3 main types of actions: internal actions ([[InternalActionsWML]]) which are used by WML internally,
display actions ([[InterfaceActionsWML]]) which show something to the user,
and direct actions ([[DirectActionsWML]]) which have a direct effect on gameplay.

Several actions use standard filters to find out which units
to execute the command on. These are denoted by the phrases
"standard unit filter" and "standard location filter".

=== Nested events ===

There is 1 special type of action: event creation. By placing an '''[event]''' tag inside another '''[event]''' tag, the nested event is created when the outer event executes. For example, you could create a portal that opens on turn 10. The outer event executes on turn 10, creating the nested moveto event, which executes when a player steps on a certain spot. An equivalent way of doing this would be to a single moveto event with an if statement to check for turn number, but nested '''[event]''' tags is a simple and elegant way to accomplish more complex tasks without resorting to excessive if statements.

== See Also ==

* [[DirectActionsWML]]
* [[InternalActionsWML]]
* [[InterfaceActionsWML]]
* [[FilterWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]