https://wiki.wesnoth.org/api.php?action=feedcontributions&feedformat=atom&user=OpensourcejunkieThe Battle for Wesnoth Wiki - User contributions [en]2026-06-06T01:27:55ZUser contributionsMediaWiki 1.31.16https://wiki.wesnoth.org/index.php?title=BuildingScenariosSimple&diff=28649BuildingScenariosSimple2009-03-13T22:30:25Z<p>Opensourcejunkie: /* Making it all work */</p>
<hr />
<div>{{BuildingScenariosNav}}<br />
<br />
= Learning things step by step =<br />
<br />
Here we will show you a very simple scenario file and explain each line of it.<br />
The file is not fully functional, but it will show the basics needed to describe what a scenario is all about.<br />
<br />
'''Before reading this, it might prove useful to read something about the syntax of the Wesnoth Markup Language: [[SyntaxWML]]'''<br />
<br />
== First part ==<br />
<br />
<blockquote><br />
<pre><br />
<nowiki><br />
[scenario]<br />
<br />
id=01_test-1<br />
next_scenario=02_test-more<br />
<br />
name=A Simple Test Scenario<br />
map_data="{@campaigns/Test_Campaign/maps/testmap}"<br />
turns=20<br />
<br />
{DAWN}<br />
{MORNING}<br />
{AFTERNOON}<br />
{DUSK}<br />
{FIRST_WATCH}<br />
{SECOND_WATCH}<br />
<br />
music=wesnoth-1.ogg<br />
<br />
[event]<br />
name=prestart<br />
[objectives]<br />
side=1<br />
[objective]<br />
description= _ "Defeat Enemy Leader"<br />
condition=win<br />
[/objective]<br />
[objective]<br />
description= _ "Death of Konrad"<br />
condition=lose<br />
[/objective]<br />
[objective]<br />
description= _ "Turns run out"<br />
condition=lose<br />
[/objective]<br />
[/objectives]<br />
[/event]<br />
</nowiki><br />
</pre><br />
<br />
''continued below''<br />
<br>&nbsp;&nbsp;&nbsp; <font size=5>↓ ↓ ↓</font><br />
</blockquote> <br />
Every scenario must be enclosed in a tag; the <code>[scenario]</code> tag is used for campaign scenarios. The first set of attributes in the scenario tag describe the very basics of this scenario:<br />
<br />
* <code>id</code> (short for ''identifier'') is the computer's name for your scenario and is not displayed during the game. However, it will be used to display game statistics (they will be graphed at http://stats.wesnoth.org in numerical order, so it's also a good idea to give the <code>id</code>'s a number). This name is also referenced in other tags and files, ''e.g.,'' inside a <code>[campaign]</code> tag using the <code>first_scenario</code> attribute (see [[BuildingCampaignsTheCampaignFile]]) or inside a <code>[scenario]</code> tag using the <code>next_scenario</code> attribute (see below).<br />
<br />
* The value of the <code>next_scenario</code> attribute is the <code>id</code> (see above) of the scenario that is played after this one is won. Units from this scenario will be available for recall (unless you modify the recall list, but that's stuff for later). If your scenario is not part of a campaign, or if this is the last scenario you should either skip this line or put <code>next_scenario=null</code> inside the file. This will tell the game to display the ''End'' screen when this scenario is won.<br />
<br />
* The value of the <code>name</code> attribute is shown on the introduction screen before each scenario is played (this may contain a picture of a map or anything else you fancy. See [[BuildingScenariosIntermediate]] for an explanation on how to do that). It's also used to generate the default names of saved files for the level.<br />
<br />
* The next attribute, <code>map_data</code> is a little tricky. Normally, the map data (the text that is used to generate a map) goes directly inside of the quotation marks. However, it is often useful to keep that map data in a separate file, and then include that file (still inside the quotation marks) using a [[PreprocessorRef|preprocesser]] command. The code <code>{@campaigns/Test_Campaign/maps/testmap}</code> does just that, telling the wesnoth engine to look in the file <code>campaigns/Test_Campaign/maps/testmap</code> for the map data. The <code>@</code> symbol tells wesnoth to search for the map file in both the ''userdata'' directory and the ''gamedata'' directory (see [[EditingWesnoth]] and [[PreprocessorRef]] for more information). You can create and edit map files using wesnoth's built-in [[Editor2|map editor]] (see [[BuildingMaps]] for more information).<br />
<br />
* Finally, the last attribute in the top set of keys is <code>turns</code>. This is the number of turns a player is given to finish the scenario (it can be changed during the game, but again, that is stuff for later). If the player fails to finish the scenario in the given time, he has lost (''i.e.,'' the ''defeat'' event is triggered. See [[EventWML]] for more.)<br />
<br />
The next section is a group of macros which will be processed by Wesnoth's [[PreprocessorRef|preprocesser]]. Macros are essentially [[WML]] shortcuts. They allow you to define certain pieces of code which can be re-used whenever they are needed. Wesnoth provides you with a whole series of standard, pre-written macros to make life easier, but you yourself can write them too (again, stuff for later). <br />
Let's get back to this example! The macros listed above describe how a day in this scenario will progress. The list of macros above is the normal day used throughout Wesnoth. If you want the entire scenario to take place at night, remove all the macros except for <code>{SECOND_WATCH}</code>. Doing this might, for example, be useful if you've set Konrad to fight the Undead and also want the Undead to have the upper hand throughout the scenario. Remember, though, by setting this to a single time of day rather than the normal diurnal progression shown above, your scenario will effectively take place during one day (or night) rather than across many days as most scenarios do.<br />
<br />
The <code>music</code> attribute takes for its value the name of a music file (see [[MusicListWML]] for more). This file must be in the <code>music/</code> directory and <b>must</b> be in [http://en.wikipedia.org/wiki/Ogg Ogg] format.<br />
<br />
A tag you'll get to know very well when making scenarios is <code>[event]...[/event]</code>. <code>event</code> tags are used to describe what should be done when various sorts of ''events'' take place. The specific type of event is stated in the <code>event</code>'s <code>name</code> attribute. In this case we're describing the so-called <code>prestart</code> event. This event occurs just ''after'' all the introduction screens for the scenario have been shown but just ''before'' the map itself is displayed. This prestart event is used to set the scenario's objectives, i.e. the contents of the ''Scenario Objectives Dialog'' that will appear once the scenario begins. The purpose of the Scenario Objectives Dialog is to inform the player what must be accomplished to win the scenario and what circumstances bring about defeat. These winning and losing circumstances are defined using the <code>[objectives]</code> tag (N.B. that <code>objectives</code> is plural). Further, each circumstance is defined in its own <code>[objective]</code> (N.B. the singular here) tag with winning circumstances setting <code>condition</code> to <code>win</code>, and with losing circumstances setting it to <code>lose</code>. In the example above, <code>objectives</code> states victory to be "Defeat Enemy Leader". For defeat, however, <code>[objectives]</code> gives the player ''two'' possibilities: either "Death of Konrad" or "Turns run out" (any number of either winning or losing <code>[objective]</code> tags may be given). Accordingly, the Scenario Objectives Dialog will look vaguely like:<br />
<br />
<table border=1><tr><td><br />
'''<font size=e>A Simple Test Scenario</font>'''<br />
<br>'''Victory:'''<br />
<br><font color=green>Defeat Enemy Leader</font><br />
<br>'''Defeat:'''<br />
<br><font color=red>Death of Konrad<br />
<br>Turns run out</font><br />
<br><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[ OK ]<br />
</td></tr></table><br />
<br />
Note that the <code>[objectives]</code> tag doesn't define the circumstances of victory or defeat to the game engine. It merely tells the player what they are. Special victory or defeat conditions will have to be coded into the scenario using various [event]s.<br />
<br />
The <code>side</code> attribute in <code>[objectives]</code> indicates that the conditions defined here by the <code>[objective]</code> tags are for the faction or alliance ''side 1'' alone (see below). In a single-player game, side 1 would usually indicate the player's faction or alliance). The underscore ("_") facilitates translation using [[GetText|Gettext]].<br />
<br />
== Second part ==<br />
So far so good! The last necessary part describes what the players (both human and<br />
computer) start with, what they can do, and what they can't do. Each of the players is described in a <code>[side]</code> tag with the word ''side'' referring to a player's faction, band, or horde.<br />
<br />
<blockquote><br />
&nbsp;&nbsp;&nbsp; <font size=5>↑ ↑ ↑</font><br />
<br>''continued from above''<br />
<pre><br />
<nowiki><br />
[side]<br />
side=1<br />
controller=human<br />
team_name=2<br />
user_team_name= _ "Konrad's forces"<br />
<br />
type=Commander<br />
id=Konrad<br />
canrecruit=yes<br />
<br />
recruit=Elvish Fighter,Elvish Archer,Horseman,Mage,Elvish Shaman<br />
<br />
{GOLD 100 50 0}<br />
{INCOME 10 5 0}<br />
[/side] <br />
[/scenario]<br />
</nowiki><br />
</pre><br />
</blockquote><br />
<br />
Above you can see a sample <code>[side]</code> for the human player, Konrad. The first group of attributes in the <code>[side]</code> tag pertains to the side generally:<br />
* <code>side</code>: the leader of this side is placed on the tile represented by this digit (see [[BuildingMaps]]). It's a number from 1 to 9.<br />
* <code>controller</code> takes either of two possible values: <code>human</code> or <code>ai</code> (''i.e.,'' ''artificial intelligence'', meaning your computer). If you don't specify this attribute, <code>ai</code> is the default.<br />
* <code>team_name</code> describes which team the side is on. It defaults to the same number as <code>side</code>, but setting it to <code>2</code> allies this side with side 2 (if you haven't changed the <code>team_name</code> of side 2).<br />
* <code>user_team_name</code> is the name displayed when you view the side stats (by pressing <tt>alt+s</tt> during gameplay). The underscore ("_") facilitates translation using [[GetText|Gettext]].<br />
<br />
The next group of attributes describe the leader of this side:<br />
* <code>canrecruit</code>: This attribute can be set to <code>yes</code> or <code>no</code> (the boolean equivalents <code>1</code> and <code>0</code> or <code>true</code> and <code>false</code> also work). If this is set to <code>no</code>, the leader won't be able to recruit (not much of a leader then, is he?). Any side without a <code>canrecruit=yes</code> attribute statement automatically loses, so be sure to include this attribute.<br />
* <code>type</code> describes what type of unit the leader will be. The possible values are listed in [http://units.wesnoth.org the Wesnoth unit tables].<br />
* <code>id</code> is the name and identifier of the leader.<br />
<br />
In a campaign, all of these "leader-describing" attributes are ignored for human players (except <code>canrecruit</code>), since the leader from the previous scenario is carried over into the current one. The exception to this is, of course, the first scenario, because there is no leader from previous scenarios. However, the <code>type</code> attribute is still necessary to prevent the scenario from crashing, so be sure to include it.<br />
<br />
The last attribute, <code>recruit</code>, is a comma-separated list of [http://units.wesnoth.org unit types]. These types will become the side's recruitment list. This too is only necessary in a human player's first scenario, because the recruit list is carried over from one scenario to the next.<br />
<br />
Finally, two macros are called. The first, <code>GOLD</code> takes three positive numbers. These indicate the amount of money the player will start with on the <var>easy</var>, <var>normal</var>, and <var>hard</var> difficulty levels, respectively. For a human-controlled side (<code>controller=human</code>), this specifies only the <i>minimum</i> amount of gold. The actual amount the player starts with can be larger if the player has retained gold from previous scenarios. The second macro, <code>INCOME</code>, is analogous to <code>GOLD</code> but for the base income. The defaults values for <code>GOLD</code> and <code>INCOME</code> are 100 gold and 2 base income, respectively.<br />
<br />
== Making it all work ==<br />
To make this scenario playable, we need to make a campaign for it (see [[BuildingCampaignsTheCampaignFile]]).<br />
This should '''not''' be stored in the main directory <tt>data/campaigns</tt> but rather inside <tt>userdata/data/campaigns</tt>. This prevents the breaking of mainline campaigns or, even worse, the entire game (see [[BuildingCampaignsDirectoryStructure]]).<br />
Please note that all files (''i.e.'', the campaign file and the scenario files for each level) must be saved with the file extension <tt>.cfg</tt> (''e.g.'', <tt>testcampaign.cfg</tt>).<br />
The following is a short, example campaign file:<br />
<br />
[campaign]<br />
name= _ "Test Campaign"<br />
first_scenario=test-1<br />
difficulties=EASY,NORMAL,HARD<br />
<br />
difficulty_descriptions= _ "&elvish-fighter.png=Easy;*&elvish-hero.png=Medium;&elvish-champion.png=Hard"<br />
icon=elvish-fighter.png<br />
[/campaign]<br />
<br />
The <code>[campaign]</code> tag describes the campaign. The first attribute, <code>name</code>, is displayed in the campaign selector box during gameplay. The second, <code>first_scenario</code>, is set to the ID number of the first scenario of the campaign. Subsequent scenarios are referenced by the <code>next_scenario</code> attribute of their immediately preceding scenarios (see above in the first part of this tutorial). Since the first scenario, obviously, doesn't have a predecessor, it is referenced here in the <code>campaign</code> tag.<br />
<br />
The attribute <code>difficulties=EASY,NORMAL,HARD</code> tells Wesnoth to use the value <code>EASY</code> if the first difficulty choice is chosen during gameplay, <code>NORMAL</code> if the second is chosen, and <code>HARD</code> if the third is chosen.<br />
The expression <code>#ifdef</code> can be used later to test the value of this attribute (see [[PreprocessorRef]]).<br />
It is recommended that you do not use any names other than <code>EASY</code>, <code>NORMAL</code>, or <code>HARD</code> for your macros because doing so will cause some standard macros, such as <code>{GOLD}</code> and <code>{INCOME}</code>, to not work properly.<br />
<br />
Two optional attributes are <code>difficulty_descriptions</code> and <code>icon</code>.<br />
As its value, <code>icon</code> holds the filename of an image to represent this campaign which will be displayed in the campaign list during gameplay.<br />
The <code>difficulty_descriptions</code> attribute must have in its value the same number of (quote-enclosed) list items as <code>difficulties</code> has in its (not quote-enclosed) list items. This list length for both attributes is most commonly three. Also note that the list for <code>difficulty_desciptions</code> is not only quote-enclosed, but its items are separated by semicolons rather than commas. Unsurprising, in our example during gameplay <tt>elvish-fighter.png</tt> would display associated with the <i>easy</i> level, <tt>elvish-hero.png</tt> with <i>normal</i>, and <tt>elvish-champion.png</tt> with <i>hard</i>.<br />
<br />
Each list item in <code>difficulty_description</code> begins with an ampersand ("&"). This is followed by the filename of the image, then an equal sign ("="), and finally the text to display (<i>i.e.</i>, "Easy". Take note that text displayed for the easy level is not "EASY": the text used is that in <code>difficulty_descriptions</code>, not <code>difficulties</code>. Similary, the normal level's text is "Medium"). <br />
<br />
Optionally you may place an asterisk ("*") before one of list items of <code>difficulty_desciptions</code> which will cause that corresponding difficulty level to be selected as the default during gameplay. In the example above, the normal level (along with its elvish hero) is selected as the default.<br />
<br />
== See Also ==<br />
* [[BuildingMaps]] & [[WesnothMapEditor]]<br />
* [[ScenarioWML]] & [[SyntaxWML]]<br />
* [[BuildingScenarios]]<br />
<br />
[[Category:Create]]</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingScenariosSimple&diff=28648BuildingScenariosSimple2009-03-13T22:19:47Z<p>Opensourcejunkie: /* Second part */</p>
<hr />
<div>{{BuildingScenariosNav}}<br />
<br />
= Learning things step by step =<br />
<br />
Here we will show you a very simple scenario file and explain each line of it.<br />
The file is not fully functional, but it will show the basics needed to describe what a scenario is all about.<br />
<br />
'''Before reading this, it might prove useful to read something about the syntax of the Wesnoth Markup Language: [[SyntaxWML]]'''<br />
<br />
== First part ==<br />
<br />
<blockquote><br />
<pre><br />
<nowiki><br />
[scenario]<br />
<br />
id=01_test-1<br />
next_scenario=02_test-more<br />
<br />
name=A Simple Test Scenario<br />
map_data="{@campaigns/Test_Campaign/maps/testmap}"<br />
turns=20<br />
<br />
{DAWN}<br />
{MORNING}<br />
{AFTERNOON}<br />
{DUSK}<br />
{FIRST_WATCH}<br />
{SECOND_WATCH}<br />
<br />
music=wesnoth-1.ogg<br />
<br />
[event]<br />
name=prestart<br />
[objectives]<br />
side=1<br />
[objective]<br />
description= _ "Defeat Enemy Leader"<br />
condition=win<br />
[/objective]<br />
[objective]<br />
description= _ "Death of Konrad"<br />
condition=lose<br />
[/objective]<br />
[objective]<br />
description= _ "Turns run out"<br />
condition=lose<br />
[/objective]<br />
[/objectives]<br />
[/event]<br />
</nowiki><br />
</pre><br />
<br />
''continued below''<br />
<br>&nbsp;&nbsp;&nbsp; <font size=5>↓ ↓ ↓</font><br />
</blockquote> <br />
Every scenario must be enclosed in a tag; the <code>[scenario]</code> tag is used for campaign scenarios. The first set of attributes in the scenario tag describe the very basics of this scenario:<br />
<br />
* <code>id</code> (short for ''identifier'') is the computer's name for your scenario and is not displayed during the game. However, it will be used to display game statistics (they will be graphed at http://stats.wesnoth.org in numerical order, so it's also a good idea to give the <code>id</code>'s a number). This name is also referenced in other tags and files, ''e.g.,'' inside a <code>[campaign]</code> tag using the <code>first_scenario</code> attribute (see [[BuildingCampaignsTheCampaignFile]]) or inside a <code>[scenario]</code> tag using the <code>next_scenario</code> attribute (see below).<br />
<br />
* The value of the <code>next_scenario</code> attribute is the <code>id</code> (see above) of the scenario that is played after this one is won. Units from this scenario will be available for recall (unless you modify the recall list, but that's stuff for later). If your scenario is not part of a campaign, or if this is the last scenario you should either skip this line or put <code>next_scenario=null</code> inside the file. This will tell the game to display the ''End'' screen when this scenario is won.<br />
<br />
* The value of the <code>name</code> attribute is shown on the introduction screen before each scenario is played (this may contain a picture of a map or anything else you fancy. See [[BuildingScenariosIntermediate]] for an explanation on how to do that). It's also used to generate the default names of saved files for the level.<br />
<br />
* The next attribute, <code>map_data</code> is a little tricky. Normally, the map data (the text that is used to generate a map) goes directly inside of the quotation marks. However, it is often useful to keep that map data in a separate file, and then include that file (still inside the quotation marks) using a [[PreprocessorRef|preprocesser]] command. The code <code>{@campaigns/Test_Campaign/maps/testmap}</code> does just that, telling the wesnoth engine to look in the file <code>campaigns/Test_Campaign/maps/testmap</code> for the map data. The <code>@</code> symbol tells wesnoth to search for the map file in both the ''userdata'' directory and the ''gamedata'' directory (see [[EditingWesnoth]] and [[PreprocessorRef]] for more information). You can create and edit map files using wesnoth's built-in [[Editor2|map editor]] (see [[BuildingMaps]] for more information).<br />
<br />
* Finally, the last attribute in the top set of keys is <code>turns</code>. This is the number of turns a player is given to finish the scenario (it can be changed during the game, but again, that is stuff for later). If the player fails to finish the scenario in the given time, he has lost (''i.e.,'' the ''defeat'' event is triggered. See [[EventWML]] for more.)<br />
<br />
The next section is a group of macros which will be processed by Wesnoth's [[PreprocessorRef|preprocesser]]. Macros are essentially [[WML]] shortcuts. They allow you to define certain pieces of code which can be re-used whenever they are needed. Wesnoth provides you with a whole series of standard, pre-written macros to make life easier, but you yourself can write them too (again, stuff for later). <br />
Let's get back to this example! The macros listed above describe how a day in this scenario will progress. The list of macros above is the normal day used throughout Wesnoth. If you want the entire scenario to take place at night, remove all the macros except for <code>{SECOND_WATCH}</code>. Doing this might, for example, be useful if you've set Konrad to fight the Undead and also want the Undead to have the upper hand throughout the scenario. Remember, though, by setting this to a single time of day rather than the normal diurnal progression shown above, your scenario will effectively take place during one day (or night) rather than across many days as most scenarios do.<br />
<br />
The <code>music</code> attribute takes for its value the name of a music file (see [[MusicListWML]] for more). This file must be in the <code>music/</code> directory and <b>must</b> be in [http://en.wikipedia.org/wiki/Ogg Ogg] format.<br />
<br />
A tag you'll get to know very well when making scenarios is <code>[event]...[/event]</code>. <code>event</code> tags are used to describe what should be done when various sorts of ''events'' take place. The specific type of event is stated in the <code>event</code>'s <code>name</code> attribute. In this case we're describing the so-called <code>prestart</code> event. This event occurs just ''after'' all the introduction screens for the scenario have been shown but just ''before'' the map itself is displayed. This prestart event is used to set the scenario's objectives, i.e. the contents of the ''Scenario Objectives Dialog'' that will appear once the scenario begins. The purpose of the Scenario Objectives Dialog is to inform the player what must be accomplished to win the scenario and what circumstances bring about defeat. These winning and losing circumstances are defined using the <code>[objectives]</code> tag (N.B. that <code>objectives</code> is plural). Further, each circumstance is defined in its own <code>[objective]</code> (N.B. the singular here) tag with winning circumstances setting <code>condition</code> to <code>win</code>, and with losing circumstances setting it to <code>lose</code>. In the example above, <code>objectives</code> states victory to be "Defeat Enemy Leader". For defeat, however, <code>[objectives]</code> gives the player ''two'' possibilities: either "Death of Konrad" or "Turns run out" (any number of either winning or losing <code>[objective]</code> tags may be given). Accordingly, the Scenario Objectives Dialog will look vaguely like:<br />
<br />
<table border=1><tr><td><br />
'''<font size=e>A Simple Test Scenario</font>'''<br />
<br>'''Victory:'''<br />
<br><font color=green>Defeat Enemy Leader</font><br />
<br>'''Defeat:'''<br />
<br><font color=red>Death of Konrad<br />
<br>Turns run out</font><br />
<br><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[ OK ]<br />
</td></tr></table><br />
<br />
Note that the <code>[objectives]</code> tag doesn't define the circumstances of victory or defeat to the game engine. It merely tells the player what they are. Special victory or defeat conditions will have to be coded into the scenario using various [event]s.<br />
<br />
The <code>side</code> attribute in <code>[objectives]</code> indicates that the conditions defined here by the <code>[objective]</code> tags are for the faction or alliance ''side 1'' alone (see below). In a single-player game, side 1 would usually indicate the player's faction or alliance). The underscore ("_") facilitates translation using [[GetText|Gettext]].<br />
<br />
== Second part ==<br />
So far so good! The last necessary part describes what the players (both human and<br />
computer) start with, what they can do, and what they can't do. Each of the players is described in a <code>[side]</code> tag with the word ''side'' referring to a player's faction, band, or horde.<br />
<br />
<blockquote><br />
&nbsp;&nbsp;&nbsp; <font size=5>↑ ↑ ↑</font><br />
<br>''continued from above''<br />
<pre><br />
<nowiki><br />
[side]<br />
side=1<br />
controller=human<br />
team_name=2<br />
user_team_name= _ "Konrad's forces"<br />
<br />
type=Commander<br />
id=Konrad<br />
canrecruit=yes<br />
<br />
recruit=Elvish Fighter,Elvish Archer,Horseman,Mage,Elvish Shaman<br />
<br />
{GOLD 100 50 0}<br />
{INCOME 10 5 0}<br />
[/side] <br />
[/scenario]<br />
</nowiki><br />
</pre><br />
</blockquote><br />
<br />
Above you can see a sample <code>[side]</code> for the human player, Konrad. The first group of attributes in the <code>[side]</code> tag pertains to the side generally:<br />
* <code>side</code>: the leader of this side is placed on the tile represented by this digit (see [[BuildingMaps]]). It's a number from 1 to 9.<br />
* <code>controller</code> takes either of two possible values: <code>human</code> or <code>ai</code> (''i.e.,'' ''artificial intelligence'', meaning your computer). If you don't specify this attribute, <code>ai</code> is the default.<br />
* <code>team_name</code> describes which team the side is on. It defaults to the same number as <code>side</code>, but setting it to <code>2</code> allies this side with side 2 (if you haven't changed the <code>team_name</code> of side 2).<br />
* <code>user_team_name</code> is the name displayed when you view the side stats (by pressing <tt>alt+s</tt> during gameplay). The underscore ("_") facilitates translation using [[GetText|Gettext]].<br />
<br />
The next group of attributes describe the leader of this side:<br />
* <code>canrecruit</code>: This attribute can be set to <code>yes</code> or <code>no</code> (the boolean equivalents <code>1</code> and <code>0</code> or <code>true</code> and <code>false</code> also work). If this is set to <code>no</code>, the leader won't be able to recruit (not much of a leader then, is he?). Any side without a <code>canrecruit=yes</code> attribute statement automatically loses, so be sure to include this attribute.<br />
* <code>type</code> describes what type of unit the leader will be. The possible values are listed in [http://units.wesnoth.org the Wesnoth unit tables].<br />
* <code>id</code> is the name and identifier of the leader.<br />
<br />
In a campaign, all of these "leader-describing" attributes are ignored for human players (except <code>canrecruit</code>), since the leader from the previous scenario is carried over into the current one. The exception to this is, of course, the first scenario, because there is no leader from previous scenarios. However, the <code>type</code> attribute is still necessary to prevent the scenario from crashing, so be sure to include it.<br />
<br />
The last attribute, <code>recruit</code>, is a comma-separated list of [http://units.wesnoth.org unit types]. These types will become the side's recruitment list. This too is only necessary in a human player's first scenario, because the recruit list is carried over from one scenario to the next.<br />
<br />
Finally, two macros are called. The first, <code>GOLD</code> takes three positive numbers. These indicate the amount of money the player will start with on the <var>easy</var>, <var>normal</var>, and <var>hard</var> difficulty levels, respectively. For a human-controlled side (<code>controller=human</code>), this specifies only the <i>minimum</i> amount of gold. The actual amount the player starts with can be larger if the player has retained gold from previous scenarios. The second macro, <code>INCOME</code>, is analogous to <code>GOLD</code> but for the base income. The defaults values for <code>GOLD</code> and <code>INCOME</code> are 100 gold and 2 base income, respectively.<br />
<br />
== Making it all work ==<br />
To make this scenario playable, we need to make a campaign for it (see [[BuildingCampaignsTheCampaignFile]]).<br />
This should '''not''' be stored in the main directory <tt>data/campaigns</tt> but rather inside <tt>userdata/data/campaigns</tt>. This prevents the breaking of mainline campaigns or, even worse, the entire game (see [[BuildingCampaignsDirectoryStructure]]).<br />
Please note that all files (''i.e.'', the campaign file and the scenario files for each level) must be saved with the file extension <tt>.cfg</tt> (''e.g.'', <tt>testcampaign.cfg</tt>).<br />
The following is a short, example campaign file:<br />
<br />
[campaign]<br />
name= _ "Test Campaign"<br />
first_scenario=test-1<br />
difficulties=EASY,NORMAL,HARD<br />
<br />
difficulty_descriptions= _ "&elvish-fighter.png=Easy;*&elvish-hero.png=Medium;&elvish-champion.png=Hard"<br />
icon=elvish-fighter.png<br />
[/campaign]<br />
<br />
The <code>[campaign]</code> tag describes the campaign. The first attribute, <code>name</code>, is displayed in the campaign selector box during gameplay. The second, <code>first_scenario</code>, is set to the ID number of the first scenario of the campaign. Subsequent scenarios are referenced by the <code>next_scenario</code> attribute of their immediately preceding scenarios (see above in the first part of this tutorial). Since the first scenario, obviously, doesn't have a predecessor, it is referenced here in the <code>campaign</code> tag.<br />
<br />
The attribute <code>difficulties=EASY,NORMAL,HARD</code> tells Wesnoth to use the value <code>EASY</code> if the first difficulty choice is chosen during gameplay, <code>NORMAL</code> if the second is chosen, and <code>HARD</code> if the third is chosen.<br />
The expression <code>#ifdef</code> can be used later to test the value of this attribute (see [[PreprocessorRef]]).<br />
It is recommended that you do not use any names other than <code>EASY</code>, <code>NORMAL</code>, or <code>HARD</code> for your macros because doing so will cause some standard macros, such as <code>{GOLD}</code> and <code>{INCOME}</code>, to not work properly.<br />
<br />
Two optional attributes are <code>difficulty_descriptions</code> and <code>icon</code>.<br />
As its value, <code>icon</code> holds the filename of an image to represent this campaign which will be displayed in the campaign list during gameplay.<br />
The <code>difficulty_descriptions</code> attribute must have in its value the same number of (string-enclosed) list items as <code>difficulties</code> has in its (not string-enclosed) list items. This list length for both attributes is most commonly three. Also note that the list for <code>difficulty_desciptions</code> is not only string enclosed, but its items are separated by semicolons rather than commas. Unsurprising, in our example during gameplay <tt>elvish-fighter.png</tt> would display associated with the <i>easy</i> level, <tt>elvish-hero.png</tt> with <i>normal</i>, and <tt>elvish-champion.png</tt> with <i>hard</i>.<br />
<br />
Each list item in <code>difficulty_description</code> begins with an ampersand ("&"). This is followed by the filename of the image, then an equal sign ("="), and finally the text to display (<i>i.e.</i>, "Easy". Take note that text displayed for the easy level is not "EASY": the text used is that in <code>difficulty_descriptions</code>, not <code>difficulties</code>. Similary, the normal level's text is "Medium"). <br />
<br />
Optionally you may place an asterisk ("*") before one of list items of <code>difficulty_desciptions</code> which will cause that corresponding difficulty level to be selected as the default during gameplay. In the example above, the normal level (along with its elvish hero) is selected as the default.<br />
<br />
== See Also ==<br />
* [[BuildingMaps]] & [[WesnothMapEditor]]<br />
* [[ScenarioWML]] & [[SyntaxWML]]<br />
* [[BuildingScenarios]]<br />
<br />
[[Category:Create]]</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingScenariosSimple&diff=28646BuildingScenariosSimple2009-03-13T22:10:40Z<p>Opensourcejunkie: /* Second part */ updating code && clarifying some things && fixing some misconceptions</p>
<hr />
<div>{{BuildingScenariosNav}}<br />
<br />
= Learning things step by step =<br />
<br />
Here we will show you a very simple scenario file and explain each line of it.<br />
The file is not fully functional, but it will show the basics needed to describe what a scenario is all about.<br />
<br />
'''Before reading this, it might prove useful to read something about the syntax of the Wesnoth Markup Language: [[SyntaxWML]]'''<br />
<br />
== First part ==<br />
<br />
<blockquote><br />
<pre><br />
<nowiki><br />
[scenario]<br />
<br />
id=01_test-1<br />
next_scenario=02_test-more<br />
<br />
name=A Simple Test Scenario<br />
map_data="{@campaigns/Test_Campaign/maps/testmap}"<br />
turns=20<br />
<br />
{DAWN}<br />
{MORNING}<br />
{AFTERNOON}<br />
{DUSK}<br />
{FIRST_WATCH}<br />
{SECOND_WATCH}<br />
<br />
music=wesnoth-1.ogg<br />
<br />
[event]<br />
name=prestart<br />
[objectives]<br />
side=1<br />
[objective]<br />
description= _ "Defeat Enemy Leader"<br />
condition=win<br />
[/objective]<br />
[objective]<br />
description= _ "Death of Konrad"<br />
condition=lose<br />
[/objective]<br />
[objective]<br />
description= _ "Turns run out"<br />
condition=lose<br />
[/objective]<br />
[/objectives]<br />
[/event]<br />
</nowiki><br />
</pre><br />
<br />
''continued below''<br />
<br>&nbsp;&nbsp;&nbsp; <font size=5>↓ ↓ ↓</font><br />
</blockquote> <br />
Every scenario must be enclosed in a tag; the <code>[scenario]</code> tag is used for campaign scenarios. The first set of attributes in the scenario tag describe the very basics of this scenario:<br />
<br />
* <code>id</code> (short for ''identifier'') is the computer's name for your scenario and is not displayed during the game. However, it will be used to display game statistics (they will be graphed at http://stats.wesnoth.org in numerical order, so it's also a good idea to give the <code>id</code>'s a number). This name is also referenced in other tags and files, ''e.g.,'' inside a <code>[campaign]</code> tag using the <code>first_scenario</code> attribute (see [[BuildingCampaignsTheCampaignFile]]) or inside a <code>[scenario]</code> tag using the <code>next_scenario</code> attribute (see below).<br />
<br />
* The value of the <code>next_scenario</code> attribute is the <code>id</code> (see above) of the scenario that is played after this one is won. Units from this scenario will be available for recall (unless you modify the recall list, but that's stuff for later). If your scenario is not part of a campaign, or if this is the last scenario you should either skip this line or put <code>next_scenario=null</code> inside the file. This will tell the game to display the ''End'' screen when this scenario is won.<br />
<br />
* The value of the <code>name</code> attribute is shown on the introduction screen before each scenario is played (this may contain a picture of a map or anything else you fancy. See [[BuildingScenariosIntermediate]] for an explanation on how to do that). It's also used to generate the default names of saved files for the level.<br />
<br />
* The next attribute, <code>map_data</code> is a little tricky. Normally, the map data (the text that is used to generate a map) goes directly inside of the quotation marks. However, it is often useful to keep that map data in a separate file, and then include that file (still inside the quotation marks) using a [[PreprocessorRef|preprocesser]] command. The code <code>{@campaigns/Test_Campaign/maps/testmap}</code> does just that, telling the wesnoth engine to look in the file <code>campaigns/Test_Campaign/maps/testmap</code> for the map data. The <code>@</code> symbol tells wesnoth to search for the map file in both the ''userdata'' directory and the ''gamedata'' directory (see [[EditingWesnoth]] and [[PreprocessorRef]] for more information). You can create and edit map files using wesnoth's built-in [[Editor2|map editor]] (see [[BuildingMaps]] for more information).<br />
<br />
* Finally, the last attribute in the top set of keys is <code>turns</code>. This is the number of turns a player is given to finish the scenario (it can be changed during the game, but again, that is stuff for later). If the player fails to finish the scenario in the given time, he has lost (''i.e.,'' the ''defeat'' event is triggered. See [[EventWML]] for more.)<br />
<br />
The next section is a group of macros which will be processed by Wesnoth's [[PreprocessorRef|preprocesser]]. Macros are essentially [[WML]] shortcuts. They allow you to define certain pieces of code which can be re-used whenever they are needed. Wesnoth provides you with a whole series of standard, pre-written macros to make life easier, but you yourself can write them too (again, stuff for later). <br />
Let's get back to this example! The macros listed above describe how a day in this scenario will progress. The list of macros above is the normal day used throughout Wesnoth. If you want the entire scenario to take place at night, remove all the macros except for <code>{SECOND_WATCH}</code>. Doing this might, for example, be useful if you've set Konrad to fight the Undead and also want the Undead to have the upper hand throughout the scenario. Remember, though, by setting this to a single time of day rather than the normal diurnal progression shown above, your scenario will effectively take place during one day (or night) rather than across many days as most scenarios do.<br />
<br />
The <code>music</code> attribute takes for its value the name of a music file (see [[MusicListWML]] for more). This file must be in the <code>music/</code> directory and <b>must</b> be in [http://en.wikipedia.org/wiki/Ogg Ogg] format.<br />
<br />
A tag you'll get to know very well when making scenarios is <code>[event]...[/event]</code>. <code>event</code> tags are used to describe what should be done when various sorts of ''events'' take place. The specific type of event is stated in the <code>event</code>'s <code>name</code> attribute. In this case we're describing the so-called <code>prestart</code> event. This event occurs just ''after'' all the introduction screens for the scenario have been shown but just ''before'' the map itself is displayed. This prestart event is used to set the scenario's objectives, i.e. the contents of the ''Scenario Objectives Dialog'' that will appear once the scenario begins. The purpose of the Scenario Objectives Dialog is to inform the player what must be accomplished to win the scenario and what circumstances bring about defeat. These winning and losing circumstances are defined using the <code>[objectives]</code> tag (N.B. that <code>objectives</code> is plural). Further, each circumstance is defined in its own <code>[objective]</code> (N.B. the singular here) tag with winning circumstances setting <code>condition</code> to <code>win</code>, and with losing circumstances setting it to <code>lose</code>. In the example above, <code>objectives</code> states victory to be "Defeat Enemy Leader". For defeat, however, <code>[objectives]</code> gives the player ''two'' possibilities: either "Death of Konrad" or "Turns run out" (any number of either winning or losing <code>[objective]</code> tags may be given). Accordingly, the Scenario Objectives Dialog will look vaguely like:<br />
<br />
<table border=1><tr><td><br />
'''<font size=e>A Simple Test Scenario</font>'''<br />
<br>'''Victory:'''<br />
<br><font color=green>Defeat Enemy Leader</font><br />
<br>'''Defeat:'''<br />
<br><font color=red>Death of Konrad<br />
<br>Turns run out</font><br />
<br><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[ OK ]<br />
</td></tr></table><br />
<br />
Note that the <code>[objectives]</code> tag doesn't define the circumstances of victory or defeat to the game engine. It merely tells the player what they are. Special victory or defeat conditions will have to be coded into the scenario using various [event]s.<br />
<br />
The <code>side</code> attribute in <code>[objectives]</code> indicates that the conditions defined here by the <code>[objective]</code> tags are for the faction or alliance ''side 1'' alone (see below). In a single-player game, side 1 would usually indicate the player's faction or alliance). The underscore ("_") facilitates translation using [[GetText|Gettext]].<br />
<br />
== Second part ==<br />
So far so good! The last necessary part describes what the players (both human and<br />
computer) start with, what they can do, and what they can't do. Each of the players is described in a <code>[side]</code> tag with the word ''side'' referring to a player's faction, band, or horde.<br />
<br />
<blockquote><br />
&nbsp;&nbsp;&nbsp; <font size=5>↑ ↑ ↑</font><br />
<br>''continued from above''<br />
<pre><br />
<nowiki><br />
[side]<br />
side=1<br />
controller=human<br />
team_name=2<br />
user_team_name= _ "Konrad's forces"<br />
<br />
type=Commander<br />
id=Konrad<br />
canrecruit=yes<br />
<br />
recruit=Elvish Fighter,Elvish Archer,Horseman,Mage,Elvish Shaman<br />
<br />
{GOLD 100 50 0}<br />
{INCOME 10 5 0}<br />
[/side] <br />
[/scenario]<br />
</nowiki><br />
</pre><br />
</blockquote><br />
<br />
Above you can see a sample <code>[side]</code> for the human player, Konrad. The first group of attributes in the <code>[side]</code> tag pertains to the side generally:<br />
* <code>side</code>: the leader of this side is placed on the tile represented by this digit (see [[BuildingMaps]]). It's a number from 1 to 9.<br />
* <code>controller</code> takes either of two possible values: <code>human</code> or <code>ai</code> (''i.e.,'' ''artificial intelligence'', meaning your computer). If you don't specify this attribute, <code>ai</code> is the default.<br />
* <code>team_name</code> describes which team the side is on. It defaults to the same number as <code>side</code>, but setting it to <code>2</code> allies this side with side 2 (if you haven't changed the <code>team_name</code> of side 2).<br />
* <code>user_team_name</code> is the name displayed when you view the side stats (by pressing <tt>alt+s</tt> during gameplay). The underscore ("_") facilitates translation using [[GetText|Gettext]].<br />
<br />
The next group of attributes describe the leader of this side:<br />
* <code>canrecruit</code>: This attribute can be set to <code>yes</code> or <code>no</code> (the boolean equivalents <code>1</code> and <code>0</code> or <code>true</code> and <code>false</code> also work). If this is set to <code>no</code>, the leader won't be able to recruit (not much of a leader then, is he?). Any side without a <code>canrecruit=yes</code> attribute statement automatically loses, so be sure to include this attribute.<br />
* <code>type</code> describes what type of unit the leader will be. The possible values are listed in [http://units.wesnoth.org the Wesnoth unit tables].<br />
* <code>id</code> is the name and identifier of the leader.<br />
<br />
In a campaign, all of these "leader-describing" attributes are ignored for human players (except <code>canrecruit</code>), since the leader from the previous scenario is carried over into the current one. The exception to this is, of course, the first scenario, because there is no leader from previous scenarios. However, the <code>type</code> attribute is still necessary to prevent the scenario from crashing, so be sure to include it.<br />
<br />
The last attribute, <code>recruit</code>, is a comma-separated list of [http://units.wesnoth.org unit types]. These types will become the side's recruitment list. This too is only necessary in a human player's first scenario, because the recruit list is carried over from one scenario to the next.<br />
<br />
Finally, two macros are called. The first, {{LinkMacroP|GOLD|easy normal hard}} takes three positive numbers. These indicate the amount of money the player will start with on the <var>easy</var>, <var>normal</var>, and <var>hard</var> difficulty levels. For a human-controlled side (<code>controller=human</code>), this specifies only the <i>minimum</i> amount of gold. The actual amount the player starts with can be larger if the player has retained gold from previous scenarios. The second macro, {{LinkMacroP|INCOME|easy normal hard}}, is analogous to <code>GOLD</code> but for the base income. The defaults values for <code>GOLD</code> and <code>INCOME</code> are 100 gold and 2 base income, respectively.<br />
<br />
== Making it all work ==<br />
To make this scenario playable, we need to make a campaign for it (see [[BuildingCampaignsTheCampaignFile]]).<br />
This should '''not''' be stored in the main directory <tt>data/campaigns</tt> but rather inside <tt>userdata/data/campaigns</tt>. This prevents the breaking of mainline campaigns or, even worse, the entire game (see [[BuildingCampaignsDirectoryStructure]]).<br />
Please note that all files (''i.e.'', the campaign file and the scenario files for each level) must be saved with the file extension <tt>.cfg</tt> (''e.g.'', <tt>testcampaign.cfg</tt>).<br />
The following is a short, example campaign file:<br />
<br />
[campaign]<br />
name= _ "Test Campaign"<br />
first_scenario=test-1<br />
difficulties=EASY,NORMAL,HARD<br />
<br />
difficulty_descriptions= _ "&elvish-fighter.png=Easy;*&elvish-hero.png=Medium;&elvish-champion.png=Hard"<br />
icon=elvish-fighter.png<br />
[/campaign]<br />
<br />
The <code>[campaign]</code> tag describes the campaign. The first attribute, <code>name</code>, is displayed in the campaign selector box during gameplay. The second, <code>first_scenario</code>, is set to the ID number of the first scenario of the campaign. Subsequent scenarios are referenced by the <code>next_scenario</code> attribute of their immediately preceding scenarios (see above in the first part of this tutorial). Since the first scenario, obviously, doesn't have a predecessor, it is referenced here in the <code>campaign</code> tag.<br />
<br />
The attribute <code>difficulties=EASY,NORMAL,HARD</code> tells Wesnoth to use the value <code>EASY</code> if the first difficulty choice is chosen during gameplay, <code>NORMAL</code> if the second is chosen, and <code>HARD</code> if the third is chosen.<br />
The expression <code>#ifdef</code> can be used later to test the value of this attribute (see [[PreprocessorRef]]).<br />
It is recommended that you do not use any names other than <code>EASY</code>, <code>NORMAL</code>, or <code>HARD</code> for your macros because doing so will cause some standard macros, such as <code>{GOLD}</code> and <code>{INCOME}</code>, to not work properly.<br />
<br />
Two optional attributes are <code>difficulty_descriptions</code> and <code>icon</code>.<br />
As its value, <code>icon</code> holds the filename of an image to represent this campaign which will be displayed in the campaign list during gameplay.<br />
The <code>difficulty_descriptions</code> attribute must have in its value the same number of (string-enclosed) list items as <code>difficulties</code> has in its (not string-enclosed) list items. This list length for both attributes is most commonly three. Also note that the list for <code>difficulty_desciptions</code> is not only string enclosed, but its items are separated by semicolons rather than commas. Unsurprising, in our example during gameplay <tt>elvish-fighter.png</tt> would display associated with the <i>easy</i> level, <tt>elvish-hero.png</tt> with <i>normal</i>, and <tt>elvish-champion.png</tt> with <i>hard</i>.<br />
<br />
Each list item in <code>difficulty_description</code> begins with an ampersand ("&"). This is followed by the filename of the image, then an equal sign ("="), and finally the text to display (<i>i.e.</i>, "Easy". Take note that text displayed for the easy level is not "EASY": the text used is that in <code>difficulty_descriptions</code>, not <code>difficulties</code>. Similary, the normal level's text is "Medium"). <br />
<br />
Optionally you may place an asterisk ("*") before one of list items of <code>difficulty_desciptions</code> which will cause that corresponding difficulty level to be selected as the default during gameplay. In the example above, the normal level (along with its elvish hero) is selected as the default.<br />
<br />
== See Also ==<br />
* [[BuildingMaps]] & [[WesnothMapEditor]]<br />
* [[ScenarioWML]] & [[SyntaxWML]]<br />
* [[BuildingScenarios]]<br />
<br />
[[Category:Create]]</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingScenariosSimple&diff=28645BuildingScenariosSimple2009-03-13T22:02:51Z<p>Opensourcejunkie: /* First part */</p>
<hr />
<div>{{BuildingScenariosNav}}<br />
<br />
= Learning things step by step =<br />
<br />
Here we will show you a very simple scenario file and explain each line of it.<br />
The file is not fully functional, but it will show the basics needed to describe what a scenario is all about.<br />
<br />
'''Before reading this, it might prove useful to read something about the syntax of the Wesnoth Markup Language: [[SyntaxWML]]'''<br />
<br />
== First part ==<br />
<br />
<blockquote><br />
<pre><br />
<nowiki><br />
[scenario]<br />
<br />
id=01_test-1<br />
next_scenario=02_test-more<br />
<br />
name=A Simple Test Scenario<br />
map_data="{@campaigns/Test_Campaign/maps/testmap}"<br />
turns=20<br />
<br />
{DAWN}<br />
{MORNING}<br />
{AFTERNOON}<br />
{DUSK}<br />
{FIRST_WATCH}<br />
{SECOND_WATCH}<br />
<br />
music=wesnoth-1.ogg<br />
<br />
[event]<br />
name=prestart<br />
[objectives]<br />
side=1<br />
[objective]<br />
description= _ "Defeat Enemy Leader"<br />
condition=win<br />
[/objective]<br />
[objective]<br />
description= _ "Death of Konrad"<br />
condition=lose<br />
[/objective]<br />
[objective]<br />
description= _ "Turns run out"<br />
condition=lose<br />
[/objective]<br />
[/objectives]<br />
[/event]<br />
</nowiki><br />
</pre><br />
<br />
''continued below''<br />
<br>&nbsp;&nbsp;&nbsp; <font size=5>↓ ↓ ↓</font><br />
</blockquote> <br />
Every scenario must be enclosed in a tag; the <code>[scenario]</code> tag is used for campaign scenarios. The first set of attributes in the scenario tag describe the very basics of this scenario:<br />
<br />
* <code>id</code> (short for ''identifier'') is the computer's name for your scenario and is not displayed during the game. However, it will be used to display game statistics (they will be graphed at http://stats.wesnoth.org in numerical order, so it's also a good idea to give the <code>id</code>'s a number). This name is also referenced in other tags and files, ''e.g.,'' inside a <code>[campaign]</code> tag using the <code>first_scenario</code> attribute (see [[BuildingCampaignsTheCampaignFile]]) or inside a <code>[scenario]</code> tag using the <code>next_scenario</code> attribute (see below).<br />
<br />
* The value of the <code>next_scenario</code> attribute is the <code>id</code> (see above) of the scenario that is played after this one is won. Units from this scenario will be available for recall (unless you modify the recall list, but that's stuff for later). If your scenario is not part of a campaign, or if this is the last scenario you should either skip this line or put <code>next_scenario=null</code> inside the file. This will tell the game to display the ''End'' screen when this scenario is won.<br />
<br />
* The value of the <code>name</code> attribute is shown on the introduction screen before each scenario is played (this may contain a picture of a map or anything else you fancy. See [[BuildingScenariosIntermediate]] for an explanation on how to do that). It's also used to generate the default names of saved files for the level.<br />
<br />
* The next attribute, <code>map_data</code> is a little tricky. Normally, the map data (the text that is used to generate a map) goes directly inside of the quotation marks. However, it is often useful to keep that map data in a separate file, and then include that file (still inside the quotation marks) using a [[PreprocessorRef|preprocesser]] command. The code <code>{@campaigns/Test_Campaign/maps/testmap}</code> does just that, telling the wesnoth engine to look in the file <code>campaigns/Test_Campaign/maps/testmap</code> for the map data. The <code>@</code> symbol tells wesnoth to search for the map file in both the ''userdata'' directory and the ''gamedata'' directory (see [[EditingWesnoth]] and [[PreprocessorRef]] for more information). You can create and edit map files using wesnoth's built-in [[Editor2|map editor]] (see [[BuildingMaps]] for more information).<br />
<br />
* Finally, the last attribute in the top set of keys is <code>turns</code>. This is the number of turns a player is given to finish the scenario (it can be changed during the game, but again, that is stuff for later). If the player fails to finish the scenario in the given time, he has lost (''i.e.,'' the ''defeat'' event is triggered. See [[EventWML]] for more.)<br />
<br />
The next section is a group of macros which will be processed by Wesnoth's [[PreprocessorRef|preprocesser]]. Macros are essentially [[WML]] shortcuts. They allow you to define certain pieces of code which can be re-used whenever they are needed. Wesnoth provides you with a whole series of standard, pre-written macros to make life easier, but you yourself can write them too (again, stuff for later). <br />
Let's get back to this example! The macros listed above describe how a day in this scenario will progress. The list of macros above is the normal day used throughout Wesnoth. If you want the entire scenario to take place at night, remove all the macros except for <code>{SECOND_WATCH}</code>. Doing this might, for example, be useful if you've set Konrad to fight the Undead and also want the Undead to have the upper hand throughout the scenario. Remember, though, by setting this to a single time of day rather than the normal diurnal progression shown above, your scenario will effectively take place during one day (or night) rather than across many days as most scenarios do.<br />
<br />
The <code>music</code> attribute takes for its value the name of a music file (see [[MusicListWML]] for more). This file must be in the <code>music/</code> directory and <b>must</b> be in [http://en.wikipedia.org/wiki/Ogg Ogg] format.<br />
<br />
A tag you'll get to know very well when making scenarios is <code>[event]...[/event]</code>. <code>event</code> tags are used to describe what should be done when various sorts of ''events'' take place. The specific type of event is stated in the <code>event</code>'s <code>name</code> attribute. In this case we're describing the so-called <code>prestart</code> event. This event occurs just ''after'' all the introduction screens for the scenario have been shown but just ''before'' the map itself is displayed. This prestart event is used to set the scenario's objectives, i.e. the contents of the ''Scenario Objectives Dialog'' that will appear once the scenario begins. The purpose of the Scenario Objectives Dialog is to inform the player what must be accomplished to win the scenario and what circumstances bring about defeat. These winning and losing circumstances are defined using the <code>[objectives]</code> tag (N.B. that <code>objectives</code> is plural). Further, each circumstance is defined in its own <code>[objective]</code> (N.B. the singular here) tag with winning circumstances setting <code>condition</code> to <code>win</code>, and with losing circumstances setting it to <code>lose</code>. In the example above, <code>objectives</code> states victory to be "Defeat Enemy Leader". For defeat, however, <code>[objectives]</code> gives the player ''two'' possibilities: either "Death of Konrad" or "Turns run out" (any number of either winning or losing <code>[objective]</code> tags may be given). Accordingly, the Scenario Objectives Dialog will look vaguely like:<br />
<br />
<table border=1><tr><td><br />
'''<font size=e>A Simple Test Scenario</font>'''<br />
<br>'''Victory:'''<br />
<br><font color=green>Defeat Enemy Leader</font><br />
<br>'''Defeat:'''<br />
<br><font color=red>Death of Konrad<br />
<br>Turns run out</font><br />
<br><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[ OK ]<br />
</td></tr></table><br />
<br />
Note that the <code>[objectives]</code> tag doesn't define the circumstances of victory or defeat to the game engine. It merely tells the player what they are. Special victory or defeat conditions will have to be coded into the scenario using various [event]s.<br />
<br />
The <code>side</code> attribute in <code>[objectives]</code> indicates that the conditions defined here by the <code>[objective]</code> tags are for the faction or alliance ''side 1'' alone (see below). In a single-player game, side 1 would usually indicate the player's faction or alliance). The underscore ("_") facilitates translation using [[GetText|Gettext]].<br />
<br />
== Second part ==<br />
So far so good! The last necessary part describes what the players (both human and<br />
computer) start with, what they can do, and what they can't do. Each of the players is described in a <code>[side]</code> tag with the word ''side'' referring to a player's faction, band, or horde.<br />
<br />
<blockquote><br />
&nbsp;&nbsp;&nbsp; <font size=5>↑ ↑ ↑</font><br />
<br>''continued from above''<br />
<pre><br />
<nowiki><br />
[side]<br />
side=1<br />
controller=human<br />
team_name=2<br />
user_team_name= _ "Konrad's forces"<br />
<br />
type=Commander<br />
description=Konrad<br />
canrecruit=yes<br />
<br />
recruit=Elvish Fighter,Elvish Archer,Horseman,Mage,Elvish Shaman<br />
<br />
{GOLD 100 50 0}<br />
{INCOME 10 5 0}<br />
[/side] <br />
[/scenario]<br />
</nowiki><br />
</pre><br />
</blockquote><br />
<br />
Above you can see a sample <code>[side]</code> for the human player, Konrad. The first group of attributes in the <code>[side]</code> tag pertains to the side generally:<br />
* <code>side</code>: the leader of this side is placed on the tile represented by this digit (see [[BuildingMaps]]). It's a number from 1 to 9.<br />
* <code>controller</code> takes either of two possible values: <code>human</code> or <code>ai</code> (''i.e.,'' ''artificial intelligence'', meaning your computer). If you don't specify this attribute, <code>ai</code> is the default.<br />
* <code>team_name</code> describes which team the side is on. It defaults to the same number as <code>side</code>, but setting it to <code>2</code> allies this side with side 2 (if you haven't changed the <code>team_name</code> of side 2).<br />
* <code>user_team_name</code> is the name displayed when you view the side stats (by pressing <tt>alt+s</tt> during gameplay). The underscore ("_") facilitates translation using [[GetText|Gettext]].<br />
<br />
The next group of attributes describe the leader of this side:<br />
* <code>canrecruit</code>: This attribute can be set to <code>yes</code> or <code>no</code> (the boolean equivalents <code>1</code> and <code>0</code> or <code>true</code> and <code>false</code> also work). If this is set to <code>no</code>, the leader won't be able to recruit (not much of a leader then, is he?). Any team without a <code>canrecruit=yes</code> attribute statement automatically loses, so be sure to include this attribute.<br />
* <code>type</code> describes what type of unit the leader will be. The possible values are listed in [http://units.wesnoth.org the Wesnoth unit tables].<br />
* <code>description</code> is the name and description of the leader.<br />
<br />
In a campaign, all of these "leader-describing" attributes are ignored for human players (except <code>canrecruit</code>), since the leader from the previous scenario is carried over into the current one. However, <code>type</code> is still neccesary to prevent the scenario from crashing, so be sure to include it.<br />
<br />
The last attribute, <code>recruit</code>, is a comma-separated list of [http://units.wesnoth.org unit types].<br />
<br />
Finally, two macros are called. The first, {{LinkMacroP|GOLD|easy normal hard}} takes three positive numbers. These indicate the amount of money the player will start with on the <var>easy</var>, <var>normal</var>, and <var>hard</var> difficulty levels. For a human-controlled side (<code>controller=human</code>), this specifies only the <i>minimum</i> amount of gold. The actual amount the player starts with can be larger if the player has retained gold from previous scenarios. The second macro, {{LinkMacroP|INCOME|easy normal hard}}, is analogous to <code>GOLD</code> but for the base income. The defaults values for <code>GOLD</code> and <code>INCOME</code> are 100 gold and 2 base income, respectively.<br />
<br />
== Making it all work ==<br />
To make this scenario playable, we need to make a campaign for it (see [[BuildingCampaignsTheCampaignFile]]).<br />
This should '''not''' be stored in the main directory <tt>data/campaigns</tt> but rather inside <tt>userdata/data/campaigns</tt>. This prevents the breaking of mainline campaigns or, even worse, the entire game (see [[BuildingCampaignsDirectoryStructure]]).<br />
Please note that all files (''i.e.'', the campaign file and the scenario files for each level) must be saved with the file extension <tt>.cfg</tt> (''e.g.'', <tt>testcampaign.cfg</tt>).<br />
The following is a short, example campaign file:<br />
<br />
[campaign]<br />
name= _ "Test Campaign"<br />
first_scenario=test-1<br />
difficulties=EASY,NORMAL,HARD<br />
<br />
difficulty_descriptions= _ "&elvish-fighter.png=Easy;*&elvish-hero.png=Medium;&elvish-champion.png=Hard"<br />
icon=elvish-fighter.png<br />
[/campaign]<br />
<br />
The <code>[campaign]</code> tag describes the campaign. The first attribute, <code>name</code>, is displayed in the campaign selector box during gameplay. The second, <code>first_scenario</code>, is set to the ID number of the first scenario of the campaign. Subsequent scenarios are referenced by the <code>next_scenario</code> attribute of their immediately preceding scenarios (see above in the first part of this tutorial). Since the first scenario, obviously, doesn't have a predecessor, it is referenced here in the <code>campaign</code> tag.<br />
<br />
The attribute <code>difficulties=EASY,NORMAL,HARD</code> tells Wesnoth to use the value <code>EASY</code> if the first difficulty choice is chosen during gameplay, <code>NORMAL</code> if the second is chosen, and <code>HARD</code> if the third is chosen.<br />
The expression <code>#ifdef</code> can be used later to test the value of this attribute (see [[PreprocessorRef]]).<br />
It is recommended that you do not use any names other than <code>EASY</code>, <code>NORMAL</code>, or <code>HARD</code> for your macros because doing so will cause some standard macros, such as <code>{GOLD}</code> and <code>{INCOME}</code>, to not work properly.<br />
<br />
Two optional attributes are <code>difficulty_descriptions</code> and <code>icon</code>.<br />
As its value, <code>icon</code> holds the filename of an image to represent this campaign which will be displayed in the campaign list during gameplay.<br />
The <code>difficulty_descriptions</code> attribute must have in its value the same number of (string-enclosed) list items as <code>difficulties</code> has in its (not string-enclosed) list items. This list length for both attributes is most commonly three. Also note that the list for <code>difficulty_desciptions</code> is not only string enclosed, but its items are separated by semicolons rather than commas. Unsurprising, in our example during gameplay <tt>elvish-fighter.png</tt> would display associated with the <i>easy</i> level, <tt>elvish-hero.png</tt> with <i>normal</i>, and <tt>elvish-champion.png</tt> with <i>hard</i>.<br />
<br />
Each list item in <code>difficulty_description</code> begins with an ampersand ("&"). This is followed by the filename of the image, then an equal sign ("="), and finally the text to display (<i>i.e.</i>, "Easy". Take note that text displayed for the easy level is not "EASY": the text used is that in <code>difficulty_descriptions</code>, not <code>difficulties</code>. Similary, the normal level's text is "Medium"). <br />
<br />
Optionally you may place an asterisk ("*") before one of list items of <code>difficulty_desciptions</code> which will cause that corresponding difficulty level to be selected as the default during gameplay. In the example above, the normal level (along with its elvish hero) is selected as the default.<br />
<br />
== See Also ==<br />
* [[BuildingMaps]] & [[WesnothMapEditor]]<br />
* [[ScenarioWML]] & [[SyntaxWML]]<br />
* [[BuildingScenarios]]<br />
<br />
[[Category:Create]]</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=List_of_Campaigns&diff=28447List of Campaigns2009-03-02T16:43:32Z<p>Opensourcejunkie: /* 1.5 Campaign List */</p>
<hr />
<div>''Created and maintained by Turuk. For any changes/updates to your campaign that have not been noted here, please contact me in the forum.''<br />
<br />
<br />
<br />
=='''Key'''==<br />
Broken = Does not work at all<br />
<br>Incomplete = Partially written, no progress<br />
<br>WIP = Partially written, progress<br />
<br>Complete = Completely written, but buggy as well as potential balance issues.<br />
<br>Finished = Completely written, minimal to no bugs, slight balance issues possible.<br />
<br />
<br />
<br />
== '''1.4 Campaign List''' ==<br />
<br />
<br />
'''A New Order'''<br />
<br> ''The old kingdom of Wesnoth lies in ruins, while barbarians are ruling over the people dreaming about old legends. Can Gawen Hagarthen unite them all against the common danger?''<br />
<br>• Author: Szopen<br />
<br>• Maintainer: Rhishisikk<br />
<br>• Status: Complete<br />
<br>• Version: 1.1.6 (45 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21827]<br />
<br />
----<br />
<br />
'''A Rough Life'''<br />
<br> ''You are a young thief dreaming of greatness. Will it befall you, or will you fall looking for it?''<br />
<br>• Author: Jacques_Fol<br />
<br>• Maintainer: Turuk<br />
<br>• Status: Complete<br />
<br>• Version: 0.9.3 (9 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21718]<br />
<br />
----<br />
<br />
'''A Vision Blinded'''<br />
<br> ''Defend the northern forest against what appeared like a routine orcish raid, and unravel the greater conspiracies that lie below its waves.''<br />
<br>• Author: LemonTea<br />
<br>• Maintainer: LemonTea<br />
<br>• Status: Complete<br />
<br>• Version: 0.4.4 (15 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=23463]<br />
<br />
----<br />
<br />
'''Alfhem the Wise'''<br />
<br> ''This is the tale of Alfhelm, called by some the Wise, son of Alfric Conqueror. This is the tale of his victories over his enemies, and his rise to power in the clans of Marauderdom. This is the tale of his journey south and his destruction of the Lavinian Empire. And this is the tale of his demise in the dark forests far to the east of his homeland.''<br />
<br>• Author: Oreb<br />
<br>• Maintainer: Turin<br />
<br>• Status: Complete<br />
<br>• Version: 0.3.2 (18 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=17144]<br />
<br />
----<br />
<br />
'''Attack of the Undead'''<br />
<br> ''Play as a mage to protect your city from the undead.'' <br />
<br>• Author: Wsultzbach<br />
<br>• Maintainer: Wsultzbach<br />
<br>• Status: Finished<br />
<br>• Version: 1.2.8 (5 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?t=14570]<br />
<br />
----<br />
<br />
'''Autumn Kingdoms – Prologue'''<br />
<br> ''All kingdoms fall. Join Captain Aldehar as he witnesses the rise of a revolution, and the changing of an era.''<br />
<br>• Author: Devrailis Colandore<br />
<br>• Maintainer: None<br />
<br>• Status: Incomplete<br />
<br>• Version: 0.1.4 (9 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=20549]<br />
<br />
----<br />
<br />
'''Bad Moon Rising'''<br />
<br> ''A soldier of Weldyn is captured by a necromancer. His attempt to escape sets events in motion that could have consequences for all life on the planet.''<br />
<br>• Author: Doofus-01<br />
<br>• Maintainer: Doofus-01<br />
<br>• Status: Complete<br />
<br>• Version: 0.4.5 (20 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=19299]<br />
<br />
----<br />
<br />
'''Battle for Orbivm?'''<br />
<br />
----<br />
<br />
'''Capturing Mar’Than'''<br />
<br> ''Play the role of Denring III as he recaptures the mysterious land of Mar'Than from usurpers.''<br />
<br>• Author: SLJ<br />
<br>• Maintainer: SLJ<br />
<br>• Status: Complete<br />
<br>• Version: 0.9.25 (11 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=11495]<br />
<br />
----<br />
<br />
'''Children of Dragons'''<br />
<br>''Once the most feared creatures in the land of the living, the dragons are all but extinct. But their descendants are just about to make their mark on the world...''<br />
<br>• Author: MarkP<br />
<br>• Maintainer: MarkP<br />
<br>• Status: Complete<br />
<br>• Version: 0.8 (13 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=14241]<br />
<br />
----<br />
<br />
'''Count Kromire'''<br />
<br> ''You are the blood son of a vampire lord, however when the might of the celestial crusades comes knocking, and your father is slain, you flee your lands. However you intend to return, to restore the lands of Kromire to the Kromires, to avenge your father, and most importantly, to make sure that no celestial ever dares come into your mountains again.''<br />
<br>• Author: Velensk<br />
<br>• Maintainer: Velensk<br />
<br>• Status: Finished<br />
<br>• Version: Beta.1 (9 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21560]<br />
<br />
----<br />
<br />
'''Death Is A Circle'''<br />
<br> ''Immortality is the path of an undead. Death is seen as the perfect path. But Death itself is not Immortal. This story is about a Lich that conquered Death. ''<br />
<br>• Author: Orcish_Orc, Y0urb0ss<br />
<br>• Maintainer: Orcish_Orc, Y0urb0ss<br />
<br>• Status: WIP<br />
<br>• Version: 0.2.0 (6 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=22806]<br />
<br />
----<br />
<br />
'''Elvish Legacy'''<br />
<br> ''As Eltharion, Lord of the Wesmere Elves, you must defend your people from orcish raids, a task that will entwine your future with that of the whole kingdom."<br />
<br>• Author: Longbow<br />
<br>• Maintainer: Longbow<br />
<br>• Status: WIP<br />
<br>• Version: 0.0.9 (8 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=23805]<br />
<br />
----<br />
<br />
'''Epic of Vaniyera'''<br />
<br> ''The expansionist Lavinian Legion, led by the Imperator himself, has invaded the northern forests of the Sidhe. It is up to the young Vaniyera to push its armies back from the border..."<br />
<br>• Author: Oreb<br />
<br>• Maintainer: Turin<br />
<br>• Status: Complete<br />
<br>• Version: 0.0.1 (8 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=19490]<br />
<br />
----<br />
<br />
'''Fool's Errand'''<br />
<br> ''Tired of life in a hamlet, young Will leaves home to seek fame and fortune. Does he even stand a chance?''<br />
<br>• Author: Orcish Shyde<br />
<br>• Maintainer: Orcish Shyde<br />
<br>• Status: WIP<br />
<br>• Version: 0.0.1 (1 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=23926]<br />
<br />
----<br />
<br />
'''Forgotten Kingdom'''<br />
<br> ''Help Orlog, a troll chieftan, lead his people to safety in the underground and discover an ancient power long forgotten.''<br />
<br>• Author: Limabean<br />
<br>• Maintainer: Limabean<br />
<br>• Status: WIP<br />
<br>• Version: 0.5 (7 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=23483]<br />
<br />
----<br />
<br />
'''Flight to Freedom'''<br />
<br> ''Lead Malakar and his Drake tribe to freedom from the humans!''<br />
<br>• Author: MadMax<br />
<br>• Maintainer: MadMax<br />
<br>• Status: WIP<br />
<br>• Version: 4.6 (24 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=1887]<br />
<br />
----<br />
<br />
'''Guardian Order'''<br />
<br> ''950 YSW. After a drought which wrecked the little achievements the Human Earldoms have manage to scrape, the country was plagued with rebellions and uprisings of pillagers and marauders. As an officer of the guardian order, you will guard the safety of Wesnoth and Elensefar from infighting as well as threats from beyond.''<br />
<br>• Author: Octavius, xbrianll<br />
<br>• Maintainer: None<br />
<br>• Status: Incomplete<br />
<br>• Version: 0.0.2 (2 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21609]<br />
<br />
----<br />
<br />
'''Hallowed Glade?'''<br />
<br />
----<br />
<br />
'''Invasion From the Unknown'''<br />
<br> ''Long after the Fall, the last forest elves are forced to abandon their safe valley, and find themselves resorting to the dark means of necromancy in order to survive the perils and challenges of this new harsh world. May they finally free the Great Continent from its chaos, or perish in the foolish attempt of restoring peace and life to the lands.''<br />
<br>• Author: Shadow_Master<br />
<br>• Maintainer: Shadow_Master<br />
<br>• Status: Complete<br />
<br>• Version: 1.9.4 (24 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=17827]<br />
<br />
----<br />
<br />
'''Invasion of Eliador'''<br />
<br> ''A peaceful island is about to be invaded by unknown foes travelling towards the eastern shore. It is up to a family of outlaws to warn the island's inhabitants before it's too late.''<br />
<br>• Author: Genosuke<br />
<br>• Maintainer: Genosuke<br />
<br>• Status: Complete<br />
<br>• Version: 1.3.6 (12 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=6556]<br />
<br />
----<br />
<br />
'''Love to Death'''<br />
<br> ''Follow the story of the deathly passion of Aleva, the mage apprentice who crossed all the boundaries of magic to reach what she desired most.''<br />
<br>• Author: Geos<br />
<br>• Maintainer: Geos<br />
<br>• Status: Incomplete<br />
<br>• Version: 0.1.2 (8 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21277]<br />
<br />
----<br />
<br />
'''Necromancer'''<br />
<br> ''There was a death-magicker, Leanna they called her, on the southern border of Wesnoth. She used her dark powers to help and protect the people, and the people harboured and trusted her in return, even at the risk of the Crown's retribution...''<br />
<br>• Author: Orcish Shyde<br />
<br>• Maintainer: Orcish Shyde<br />
<br>• Status: Complete<br />
<br>• Version: 1.0.2 (14 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=23489]<br />
<br />
----<br />
<br />
'''Northern Cross'''<br />
<br> ''As the Northern Alliance strengthens, Weldyn's attempts to maintain hegemony in the area brings many groups into conflict.''<br />
<br>• Author: Glowing Fish<br />
<br>• Maintainer: Glowing Fish<br />
<br>• Status: WIP<br />
<br>• Version: 0.0.5 (2 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=24255]<br />
<br />
----<br />
<br />
'''On Crimson Wings'''<br />
<br> ''Regar, king of the Crimsonwing Drakes, is dead. Feralon, his son and heir, seeks to secure his throne and exact vengeance on those who have wronged his people.''<br />
<br>• Author: Cheradenine<br />
<br>• Maintainer: Cheradenine<br />
<br>• Status: WIP<br />
<br>• Version: 0.4.2 (5 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=23732&p=333281]<br />
<br />
----<br />
<br />
'''Ooze Mini Campaign'''<br />
<br> ''You are an ooze, and you are hungry. Devour the foolish intruders that have entered your domain!''<br />
<br>• Author: SpenceLack<br />
<br>• Maintainer: Mica<br />
<br>• Status: Complete<br />
<br>• Version: 1.2.3 (4 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=17044]<br />
<br />
----<br />
<br />
'''Raajal'''<br />
<br> ''An Arch Mage with the power of resurrection seeks a new apprentice.''<br />
<br>• Author: Genosuke<br />
<br>• Maintainer: Genosuke<br />
<br>• Status: Complete<br />
<br>• Version: 1.2.0 (15 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=20607]<br />
<br />
----<br />
<br />
'''Saving Elensefar'''<br />
<br> ''Meneldur, elvish mariner of Elensefar, is driven to sea by the same orcs who attacked the city. He must gather an army willing to fight for him to regain Elensefar, his adopted homeland.''<br />
<br>• Author: Turin<br />
<br>• Maintainer: Friar Tuck<br />
<br>• Status: Completed<br />
<br>• Version: 1.2.1 (12 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=3072]<br />
<br />
----<br />
<br />
'''Sceptre of Life'''<br />
<br> ''As orcs invade northern Wesnoth, Aeryn, a small town's doctor, is caught in the conflict. Through a series of chance meetings, Aeryn stumbles upon an artifact that could solve the orcish problem forever, or provide the horde with unbridled power.''<br />
<br>• Auther: Opensourcejunkie<br />
<br>• Maintainer: Opensourcejunkie<br />
<br>• Status: WIP<br />
<br>• Version: 0.7.1 (7 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21640]<br />
<br />
----<br />
<br />
'''Shameless Crossover Excuse'''<br />
<br> ''Fugitive dark sorcerer Gwiti Ha'atel discovers he has the power to mess with Wesnoth's continuity. His quest for revenge on the NPCs who have used his portraits will lead him through perils untold and in-jokes unnumbered, but shall pale before the horror he finds at his quest's end.''<br />
<br>• Auther: Orcish Shyde<br />
<br>• Maintainer: Orcish Shyde<br />
<br>• Status: WIP<br />
<br>• Version: 0.3.0 (6 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=23096]<br />
----<br />
<br />
'''Stories of Tarlyn (Two Campaigns in One)'''<br />
<br> ''Ensure the survival of your home town as a member of it's small militia (Tarlyn's Heros).''<br />
<br> ''Protect your clan, as the younger brother to its leader (The Irna Chronicles).''<br />
<br>• Author: AI<br />
<br>• Maintainer: AI<br />
<br>• Status: WIP<br />
<br>• Version: 0.1.1 (6 Scenarios for Tarlyn's Heros; 3 Scenarios for Irna Chronicles)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=19703]<br />
<br />
----<br />
<br />
'''Story of the Wose'''<br />
<br> ''The trees are not always what they seem...''<br />
<br>• Author: Joshudson<br />
<br>• Maintainer: Joshudson<br />
<br>• Status: Finished<br />
<br>• Version: 0.5.4 (6 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=10819]<br />
<br />
----<br />
<br />
'''Struggle For Freedom'''<br />
<br> ''Follow the Eastern Elves in the time of Asheviere. Will they succeed in their struggle for freedom, or will a betrayal at their heart strike them at the brink of victory?''<br />
<br>• Author: Wyrmy<br />
<br>• Maintainer: Wyrmy<br />
<br>• Status: Complete<br />
<br>• Version: 1.4.0 (10 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21615]<br />
<br />
----<br />
<br />
'''The Conquest of a Dark Queen'''<br />
<br> ''Those who save you do not always do so out of concern for you...''<br />
<br>• Author: Mica<br />
<br>• Maintainer: Mica, Turuk<br />
<br>• Status: Complete<br />
<br>• Version: 0.4.0 (10 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21638]<br />
<br />
----<br />
<br />
'''The Dark Hordes'''<br />
<br> ''Lead fugitive dark sorcerer Gwiti Ha'atel to mastery of the undead hordes.''<br />
<br>• Author: SvH<br />
<br>• Maintainer: AI<br />
<br>• Status: WIP<br />
<br>• Version: 0.4.4 (8 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=16576]<br />
<br />
----<br />
<br />
'''The Eight of Cembulad'''<br />
<br> ''Discover the story of Sel Iminar and the Eight of Cembulad.''<br />
<br>• Author: Lintana, Wyrmy<br />
<br>• Maintainer: Wyrmy<br />
<br>• Status:<br />
<br>• Version: 1.0.1 (27 Scenarios)<br />
<br>• Forum Thread: ?<br />
<br />
----<br />
<br />
'''The Fall of Silvium'''<br />
<br> ''You are Caius Regilius, a Tribune, of the province Silvia, located in the northmost reaches of the Lavinian Empire. You reside in the city of Silvium, capital of the province, on the border with the northern barbarians. This is the height of the Lavinian Empire - but the Empire has overextended itself. The city of Silvia lies north of the mountains of Arendia, and is sandwiched between the Marauders and the Sidhe... war is inevitable, and the province of Silvia will almost certainly fall.''<br />
<br>• Author: Turin<br />
<br>• Maintainer: Turin<br />
<br>• Status: Complete<br />
<br>• Version: 0.4.2 (8 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=11536]<br />
<br />
----<br />
<br />
'''The Final Exam'''<br />
<br> ''A young mage Erika must find a magic book to become a true mage.''<br />
<br>• Author: Elven<br />
<br>• Maintainer: Elven<br />
<br>• Status: Complete<br />
<br>• Version: 0.2 (2 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=23398]<br />
<br />
----<br />
<br />
'''The Forgotten Legacy'''<br />
<br> ''The Saurians of the Salty Swamp have been enslaved for far too long from the cruel Blackblood clan of the Orcs. In these bitter times S'Saskin, a bloodborn, rises to lead his people to their forgotten legacy and their destiny...''<br />
<br>• Author: Db0<br />
<br>• Maintainer: Db0<br />
<br>• Status: Incomplete<br />
<br>• Version: 0.5.5 (5 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=9187]<br />
<br />
----<br />
<br />
'''The Griffoon Lads'''<br />
<br> ''Follow the adventures of the lost warrior Jaghuar Gorgone in the street wars of the Far North.''<br />
<br>• Author: Gotrek380<br />
<br>• Maintainer: Gotrek380<br />
<br>• Status: Incomplete<br />
<br>• Version: 0.9.2.2 (16 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=19542]<br />
<br />
----<br />
<br />
'''The Heist'''<br />
<br> ''A plot to steal a king's treasure goes awry.''<br />
<br>• Author: Genosuke<br />
<br>• Maintainer: Genosuke<br />
<br>• Status: Finished<br />
<br>• Version: 1.3.6 (17 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=16819]<br />
<br />
----<br />
<br />
'''The History of Burin'''<br />
<br> ''The history how Burin the Lost traveled into the Green Isle.''<br />
<br>• Author: Uzytkownik<br />
<br>• Maintainer: Uzytkownik<br />
<br>• Status: WIP<br />
<br>• Version: 0.0.0 (7 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21771]<br />
<br />
----<br />
<br />
'''The Tale of Mage (Life of a Mage)'''<br />
<br> ''The young boy Dillon only wanted to live his life in peace. After his village is destroyed by bandits however, he is forced to throw his lot with the magi. It is a difficult life, and little does he know that his destiny may lie along side that of Prince Arand II himself.''<br />
<br>• Author: SkeleRanger<br />
<br>• Maintainer: SkeleRanger<br />
<br>• Status: WIP<br />
<br>• Version: 0.5.1 (25 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21657]<br />
<br />
----<br />
<br />
'''The Rebirth of Magic'''<br />
<br> ''Anbordin, the continent in the Distant West, has been tyrannized ever since the necromancers and mages, the only persons strong enough to defy a king, had either been executed, or in the case of the necromancers, fled to the East Sea. Fyrus, a humble stablehand, is about to rediscover the lost power. Will it be enough to end King Radgeon's oppression?''<br />
<br>• Author: Armageddon<br />
<br>• Maintainer: Armageddon<br />
<br>• Status: Incomplete<br />
<br>• Version: 0.2.1 (3 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21648]<br />
<br />
----<br />
<br />
'''The Three Elves'''<br />
<br> ''Three elves begun their adventure in the northern swamplands. Will they become heroes, or they will start another undead expansion?''<br />
<br>• Author: Elven<br />
<br>• Maintainer: Elven<br />
<br>• Status: WIP<br />
<br>• Version: 0.6.2 (6 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=23395]<br />
<br />
----<br />
<br />
'''The Unstoppable Legion'''<br />
<br> ''The legendary legions of Zharagorn, dormant for centuries, have risen again and city after city is falling in their presence. Only Viktor, a patrol guard, stands between them and domination of the known world.''<br />
<br>• Author: Chris NS<br />
<br>• Maintainer: Chris NS<br />
<br>• Status: Incomplete<br />
<br>• Version: 0.7.1 (16 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=20669]<br />
<br />
----<br />
<br />
'''Trolls!'''<br />
<br> ''You are Eag, the leader of a troll tribe, who lives in a peaceful cave farming mushrooms for food. But a scout brings bad news: dwarves are attempting to mine gold and other valuable minerals in the cave. They have all ready attacked another tribe near you and you have to lead your fighters to help.'' <br />
<br>• Author: Jequ<br />
<br>• Maintainer: Jequ<br />
<br>• Status: WIP<br />
<br>• Version: 0.0.7 (4 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=23469]<br />
<br />
----<br />
<br />
'''War of the Dragon'''<br />
<br> ''The Age of the Dragon has begun, and the first event is the War of the Dragon. The Dark Dragon Kzardizin (Kzar-diz-in) has awoken from his millennium sleep, and intends to conquer the world before he must sleep again. The prophecy of Mirriam says that either he will succeed, or he will be forced back into sleep by three champions, on from the west, one from the north, and one from the east. Now the world has been ignited in war on many fronts, and the windsong prepare to face the on-coming war.''<br />
<br>• Author: Velensk<br />
<br>• Maintainer: Velensk<br />
<br>• Status: WIP<br />
<br>• Version: Part I (8 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=22652]<br />
<br />
----<br />
<br />
'''When Came Out the Shadows'''<br />
<br> ''In the year 612 YW, the Prince Konrad, second of the name, son of King Haldric VII, leaves with the army of Wesnoth at the conquest of an archipelago emerged from the waves. His army mysteriously disappears while hordes of orcs invade the islands. Will you be able to clarify this mystery?''<br />
<br>• Author: Domingo<br />
<br>• Maintainer: Domingo<br />
<br>• Status: Complete<br />
<br>• Version: 0.2.5 (20 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21994]<br />
<br />
----<br />
<br />
'''Winds of Foerroen'''<br />
<br> ''Lord Daelyn, leader of the elvish kingdom of Aesh Aelon, returns from a lengthy expidition to the far eastern lands, only to discover that his kingdom is under siege by an orcish war lord and his minions ...''<br />
<br>• Author: SaintCredence<br />
<br>• Maintainer: SaintCredence<br />
<br>• Status: Incomplete<br />
<br>• Version: 1.0.1 (3 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=20958]<br />
<br />
----<br />
<br />
== '''1.5 Campaign List''' ==<br />
<br />
'''After the Storm'''<br />
<br> ''When the Emperor of Chaos was defeated, the people of the Great Continent thought that peace would finally return to the world. However, the many survivors still loyal to the Emperor would try even the impossible to avenge his death.''<br />
<br>• Author: Shadow Master<br />
<br>• Maintainer: Shadow Master<br />
<br>• Status: WIP<br />
<br>• Version: 0.1.2 (4 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=23984]<br />
<br />
----<br />
<br />
'''Alfhem the Wise'''<br />
<br> ''This is the tale of Alfhelm, called by some the Wise, son of Alfric Conqueror. This is the tale of his victories over his enemies, and his rise to power in the clans of Marauderdom. This is the tale of his journey south and his destruction of the Lavinian Empire. And this is the tale of his demise in the dark forests far to the east of his homeland.''<br />
<br>• Author: Turin<br />
<br>• Maintainer: Turin<br />
<br>• Status: Complete<br />
<br>• Version: 0.3.2 (18 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=17144&hilit=Alfhelm+the+Wise]<br />
<br />
----<br />
<br />
'''Bad Moon Rising'''<br />
<br> ''A soldier of Weldyn is captured by a necromancer. His attempt to escape sets events in motion that could have consequences for all life on the planet.''<br />
<br>• Author: Doofus-01<br />
<br>• Maintainer: Doofus-01<br />
<br>• Status: Complete<br />
<br>• Version: 0.5.7 (20 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=23397]<br />
<br />
----<br />
<br />
'''Coming of the Storm'''<br />
<br> ''A new recruit in the Imperial Army jumps on the first opportunity to transfer to the borders to fight bandits. Little does he know just how much action he will get.''<br />
<br>• Author: TrashMan<br />
<br>• Maintainer: TrashMan<br />
<br>• Status: WIP<br />
<br>• Version: 1.11 (21 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=23361]<br />
<br />
----<br />
<br />
'''Dead Water'''<br />
<br> ''You are Kai Krellis, a merman king, but only a child. A necromancer has arrived and is turning your subjects into undead slaves! Lead your people on a mission to convince a powerful mermaid to help you repel the invasion. The oceans near the Northern Lands are perilous, so you will need cunning and bravery to be survive, but first you need to gain the respect of your troops!''<br />
<br>• Author: Beetlenaut<br />
<br>• Maintainer: Beetlenaut<br />
<br>• Status: Finished<br />
<br>• Version: 0.9.11 (13 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21836]<br />
<br />
----<br />
<br />
'''Delfador's Memoirs'''<br />
<br> ''Wesnoth seems to be slipping inexorably into chaos, as marauding orcs pour south across the Great River, and mysterious and deadly creatures roam the night. Who is the shadowy Iliah-Malal? Can you defeat him before he destroys all life in Wesnoth?''<br />
<br>• Author: JP30<br />
<br>• Maintainer: Santi<br />
<br>• Status: Finished<br />
<br>• Version: 0.10.0 (24 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=13005&start=0]<br />
<br />
----<br />
<br />
'''Epic of Vaniyera'''<br />
<br> ''The expansionist Lavinian Legion, led by the Imperator himself, has invaded the northern forests of the Sidhe. It is up to the young Vaniyera to push its armies back from the border..."<br />
<br>• Author: Oreb<br />
<br>• Maintainer: Turin<br />
<br>• Status: Complete<br />
<br>• Version: 0.0.1 (8 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=19490&start=0&st=0&sk=t&sd=a&hilit=epic+of]<br />
<br />
----<br />
<br />
'''Fiery Menace'''<br />
<br> ''Stop them! They are coming! Experience this adventure-style campaign centering on Drakes and Humans."<br />
<br>• Author: Derekkk<br />
<br>• Maintainer: Derekkk<br />
<br>• Status: Incomplete<br />
<br>• Version: 0.1.0 (1 Scenario)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21914&start=15&st=0&sk=t&sd=a]<br />
<br />
----<br />
<br />
'''Fly From Fighting'''<br />
<br> ''The year is... Well, the orcs don't know exactly what year it is. They are captives in the imperial city of Lavinium, gladiators performing for the emperor Optus Maximus. All it will take, however, is one orc to lead his people to freedom. The Samnis called Sparxus may be that orc."<br />
<br>• Author: Turin, Brutorix<br />
<br>• Maintainer: Turin<br />
<br>• Status: Complete<br />
<br>• Version: 0.1 (7 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21564&start=0]<br />
<br />
----<br />
<br />
'''Invasion From the Unknown'''<br />
<br> ''Long after the Fall, the last forest elves are forced to abandon their safe valley, and find themselves resorting to the dark means of necromancy in order to survive the perils and challenges of this new harsh world. Later, as the shadow of Chaos covers the entire continent, they prepare a counter-attack to the Empire, with one unique goal in their minds: defeat the evil Emperor, whoever it is. Lead these courageous living and non-living warriors to the victory, and rediscover lost secrets of the history.''<br />
<br>• Author: Shadow_Master<br />
<br>• Maintainer: Shadow_Master<br />
<br>• Status: Complete<br />
<br>• Version: 1.10.2 (26 Scenarios; Two Chapters of 13 each)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=17827&hilit=Invasion+From+the+Unknown]<br />
<br />
----<br />
<br />
'''Of Memories Past'''<br />
<br> ''Follow the story of a mage through friends, memories, and dreams."<br />
<br>• Author: Telmo<br />
<br>• Maintainer: Telmo<br />
<br>• Status: WIP<br />
<br>• Version: 0.0.5 (15 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=23272]<br />
<br />
----<br />
<br />
'''Sceptre of Life'''<br />
<br> ''As orcs invade northern Wesnoth, Aeryn, a small town's doctor, is caught in the conflict. Through a series of chance meetings, Aeryn stumbles upon an artifact that could solve the orcish problem forever, or provide the horde with unbridled power.''<br />
<br>• Auther: Opensourcejunkie<br />
<br>• Maintainer: Opensourcejunkie<br />
<br>• Status: WIP<br />
<br>• Version: 0.10.2 (10 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21640]<br />
<br />
----<br />
<br />
'''Tale of a Mage'''<br />
<br> ''The young boy Dillon only wanted to live his life in peace. After his village is destroyed by bandits however, he is forced to throw his lot with the magi. It is a difficult life, and little does he know that his destiny may lie along side that of Prince Arand II himself.''<br />
<br>• Author: SkeleRanger<br />
<br>• Maintainer: SkeleRanger<br />
<br>• Status: Complete<br />
<br>• Version: 0.7.5 (28 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=21657&start=0&st=0&sk=t&sd=a&hilit=tale+of+a+mage]<br />
<br />
----<br />
<br />
'''The Dark Hordes'''<br />
<br> ''Lead fugitive dark sorcerer Gwiti Ha'atel to mastery of the undead hordes.''<br />
<br>• Author: SvH<br />
<br>• Maintainer: AI<br />
<br>• Status: WIP<br />
<br>• Version: 0.6.0 (9 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=16576&start=0&st=0&sk=t&sd=a&hilit=the+dark+hordes]<br />
<br />
----<br />
<br />
'''The Fall of Silvium'''<br />
<br> ''You are Caius Regilius, a Tribune, of the province Silvia, located in the northmost reaches of the Lavinian Empire. You reside in the city of Silvium, capital of the province, on the border with the northern barbarians. This is the height of the Lavinian Empire - but the Empire has overextended itself. The city of Silvia lies north of the mountains of Arendia, and is sandwiched between the Marauders and the Sidhe... war is inevitable, and the province of Silvia will almost certainly fall.''<br />
<br>• Author: Turin<br />
<br>• Maintainer: Turin<br />
<br>• Status: Complete<br />
<br>• Version: 0.4.2 (8 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=11536]<br />
<br />
----<br />
<br />
'''The Knights of the Silver Spire'''<br />
<br> ''This is the story of the Knights of the Silver Spire, and of the Crimson Duke. It chronicles the adventures of the mage Awyn Serransdotter, her knight Karen Strathmore, and her apprentice Alain Brightly at the end of the Golden Age of Wesnoth, in the year 348 YW. It also tells of the mermaid Lenara and how she saved the city of Aethenport from a great darkness.''<br />
<br>• Author: Solsword<br />
<br>• Maintainer: Solsword<br />
<br>• Status: WIP<br />
<br>• Version: 0.1 (2 Scenarios)<br />
<br>• Forum Thread: [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=23754]<br />
<br />
== Add-On Servers ==<br />
Autogenerated lists of addons:<br />
* http://1.2-addonlist.wesnoth.org/<br />
* http://1.4-addonlist.wesnoth.org/<br />
* http://dev-addonlist.wesnoth.org/<br />
<br />
[[Category:Campaigns|*]]</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=ImagePathFunctions&diff=27478ImagePathFunctions2008-11-22T08:29:45Z<p>Opensourcejunkie: /* Syntax */</p>
<hr />
<div>Image Path Functions provide a simple method for WML coders to alter the way their specified images will be displayed in the game. All of the function parameters are included at the end of an image path and should not contain any spaces or special characters (other than those specified here).<br />
<br />
== Team-Color Function ==<br />
In Wesnoth version 1.2, the only Image Path Function was '''~TC()''', which took two comma-separated parameters: the team number and the source color palette. The valid values for both of these parameters are defined in the file ''data/team-colors.cfg''<br />
<br />
=== Syntax ===<br />
'''~TC(''' ''team number'' ''',''' ''source color palette'' ''')'''<br />
*''team number'' - this is the first parameter, a number 1-9 signifying the team number of a unit. Number 1 typically means the red team, 2 typically means the blue team, and so on (unless the scenario color settings for any side have been altered).<br />
*''source color palette'' - the second parameter is a source color palette, usually magenta. Do not surround this parameter with quotes.<br />
<br />
== Re-Color Function ==<br />
May be used to change some colors in an image.<br />
=== Syntax ===<br />
'''~RC(''' ''source color palette'' '''>''' ''color range ID'' ''')'''<br />
*''source color palette'' - the first parameter is a source color palette, usually magenta. Do not surround this parameter with quotes.<br />
*''color range ID'' - this is the second parameter, signifying the ID of a color range defined in the file ''data/core/team-colors.cfg'' (or it may be a custom ID for a color range defined locally). <br />
<br />
{{DevFeature}} In the development version, the following syntax changes the RC function behavior for simply replacing colors matching the source color palette with colors of the target color palette:<br />
<br />
'''~RC(''' ''source color palette'' '''=''' ''target color palette'' ''')'''<br />
<br />
=== Example ===<br />
In the following example, the magenta regions in an elvish captain's image are turned a healthy shade of green:<br />
<br />
[message]<br />
speaker=narrator<br />
image=units/elves-wood/captain.png~RC(magenta>green)<br />
message=_ "Now I am on the green team."<br />
[/message]<br />
<br />
The IDs of the color ranges may be the lowercased English name of the palette's base color (e.g. 'red', 'brown', etc.). They may also be numeric color indices from the palette WML included with the game, but this is not recommended<br />
<br />
== Flip Function ==<br />
May be used to flip an image horizontally and/or vertically<br />
=== Syntax ===<br />
'''~FL(''' ''optional argument list'' ''')'''<br />
*''vertical'' - if the string "vert" is found anywhere in the argument list, the image will be flipped vertically.<br />
*''horizontal'' - if the string "horiz" is found anywhere in the argument list, the image will be flipped horizantally.<br />
*if the argument list is empty, the image will only be flipped horizantally.<br />
<br />
== Greyscale Function ==<br />
May be used to greyscale the image (turn to black and white)<br />
=== Syntax ===<br />
'''~GS( )'''<br />
<br />
== Crop Function {{DevFeature}} ==<br />
Extracts a rectangular section of an image file.<br />
=== Syntax ===<br />
'''~CROP(x,y,width,height)'''<br />
* ''x'',''y'': top-left corner coordinates for the rectangular section extracted. Must be greater or equal than zero, and inside the image's bounds.<br />
* ''width'': width of the selected region. Must be less than or equal to the original image's width.<br />
* ''height'': height of the selected region. Must be less than or equal to the original image's height.<br />
<br />
[[Category:WML Reference]]</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=InterfaceActionsWML&diff=27469InterfaceActionsWML2008-11-21T11:22:34Z<p>Opensourcejunkie: /* Other interface tags */ linked to utility macro reference</p>
<hr />
<div>{{WML Tags}}<br />
== Interface actions ==<br />
<br />
Interface actions are actions that do not have an effect on gameplay;<br />
instead, they show something to the player. The main interface tags<br />
are '''[message]''' and '''[objectives]''', but several other tags affect<br />
the interface also.<br />
<br />
== [message] ==<br />
The most commonly used interface action is [message], which displays a message to the user in a dialog box. It can also be used to take input from the user.<br />
<br />
The following key/tags are accepted for [message]:<br />
* [[StandardUnitFilter]]: the unit whose profile and name are displayed. If no unit matching this filter is found, the message is not displayed (The unit has probably been killed).<br>'''[message]''' elements should be constructed so that it is either guaranteed that a certain unit is alive, or so that dialog flows smoothly even if the message isn't displayed.<br />
<br />
* '''speaker''': an alternative to standard unit filter. You may specify as the value of the speaker attribute a unit description or any of the following special values:<br />
** '''narrator''': the dialog box is displayed without a caption for the unit speaking or a unit image<br />
** '''unit''': the primary unit for the event is speaking<br />
** '''second_unit''': the secondary unit for the event is speaking<br />
<br />
* '''message''': (translatable) the text to display to the right of the image. ''message'' is sometimes multiple lines; if it is, be sure to use quotes(''' ' ''' or ''' " ''')<br />
* '''side_for''': (default: all sides) comma-separated list of sides for who message is shown.<br />
* '''image''': (default: profile image of speaker) the image to display next to the message.<br />
* '''caption''': (default: name of speaker) the caption to display beside the image. Name to be displayed.<br />
* '''duration''': (default: 10) the minimum number of frames for this message to be displayed. (A frame lasts about 30 milliseconds.) During this time any dialog decisions will be disregarded.<br />
* '''sound''': a sound effect (wav file) to play as the message is displayed. This can be a comma-separated list, from which one will be randomly chosen.<br />
* '''[option]''': zero or more '''[option]''' elements may be present. If '''[option]''' elements are present, then each option will be displayed in a menu for the user to select one option.<br />
** ''message'' (translatable) the text displayed for the option (see [[DescriptionWML]])<br />
** '''[show_if]''': if present then this option will only be displayed if the conditional statement in this tag is passed (see [[InternalActionsWML]])<br />
** '''[command]''': an element containing actions which are executed if the option is selected.<br />
* '''[text_input]''': there can be only one [text_input] tag. this adds a text input field to the message.<br />
** '''variable''': the variable that the user's input will be written to<br />
** '''label''': a text label to the left of the input field<br />
** '''max_chars''': the maximum number of characters that may be typed into the field<br />
** '''text''': text that is written into the field in the beginning<br />
* note that '''[option]''' and '''[text_input]''' can only be used in moveto events in MP, otherwise they cause OOS<br />
<br />
Text formatting options for '''[message]'''. These can also be used in unit names (user_description), objectives, and such.<br />
* A tilde (~) as the first character causes the line to be boldfaced.<br />
* An at symbol (@) as the first character causes the line to be green, as done with victory conditions.<br />
* A pound symbol (#) as the first character causes the line to be red, as done with defeat conditions.<br />
* An asterisk (*) as the first character causes the line to be bigger.<br />
* A backquote (`) as the first character causes the line to be smaller.<br />
* If used, the caption key text is boldfaced.<br />
* An RGB colour code in the beginning causes the line to be the given colour. This can still be preceded by the above characters. Example: ''message=_"<255,0,0>Red!"''<br />
<br />
== [objectives] ==<br />
The other tag used for plot development is '''[objectives]'''.<br />
The '''[objectives]''' tag overwrites any previously set objectives,<br />
and displays text which should describe the objectives of the scenario.<br />
Scenario objectives are displayed on the player's first turn after the tag is used,<br />
or as part of the event if it triggers during that player's turn.<br />
Objectives can also be accessed at any time in a scenario using the<br />
"Scenario Objectives" game menu option, making this tag useful for<br />
scenario-specific information that the player may need to refer to during play.<br />
<br />
This tag renders the ''objectives'' attribute of [scenario] obsolete (see ''objectives'', [[ScenarioWML]]).<br />
Instead of using ''objectives'', use '''[objectives]''' to set scenario objectives inside a prestart event.<br />
It can also be used to overwrite the starting objectives mid-scenario.<br />
<br />
Attributes of '''[objectives]''':<br />
* '''side''': Default '0'. The side to set the objectives for. A value of 0 sets objectives for all sides.<br />
* '''summary''': Displayed first in the objectives text, this should describe the basic objective for the overall scenario. Can be omitted.<br />
* '''note''': Displayed last in the objectives text, this is sometimes used for hints or additional information. Can be omitted.<br />
* '''victory_string''': Default ' _ "Victory:"', this text precedes the victory objectives.<br />
* '''defeat_string''': Default ' _ "Defeat:"', this text precedes the defeat objectives.<br />
* '''silent''': Default: not present. If set to "yes", the objectives are silently changed. Else, they will be shown to the user when appropriate.<br />
<br />
Tags of '''[objectives]''':<br />
* '''[objective]''': describes a win or loss condition. Most scenarios have multiple win or loss conditions, so use a separate [objective] subtag for each line; this helps with translations.<br />
** '''description''': text for the specific win or loss condition.<br />
** '''condition''': The color and placement of the text. Values are 'win'(colored green, placed after ''victory_string'') and 'lose'(colored red, placed after ''defeat_string'')<br />
<br />
=== Macros ===<br />
There are a few predefined macros for Objectives that you can use to shorten the code. '''{SET_OBJECTIVES}''', '''{VICTORY_CONDITION}''' and '''{DEFEAT_CONDITION}'''. There are all used together. For more information look [http://www.wesnoth.org/misc/macro-reference.xhtml here]<br />
<br />
== [set_menu_item] ==<br />
This tag is used to add a custom option in the right-click context menu which can then be used to trigger arbitrary WML commands.<br />
<br />
* '''id''': the unique id for this menu item. If a menu item with this id already exists, it allows you to set specific changes to that item.<br />
* '''description''': the in-game text that will appear for this item in the menu.<br />
* '''image''': the image to display next to this item.<br />
* '''needs_select''': if ''yes'' (default ''no''), then the latest select event (see [[EventWML]]) that triggered before this menu item was chosen will be transmitted over the network before this menu item action will be. This only has any effect in networked multiplayer, and is intended to allow more elaborate menu item behaviour there without causing out of sync errors. If you don't know what this means, just leave it false.<br />
* '''[show_if]''': If present, the menu item will only be available if the conditional statement (see [[InternalActionsWML]]) within evaluates to true. When this is evaluated, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked, so it's possible to for example only enable the option on empty hexes or on a particular unit.<br />
* '''[filter_location]''': contains a location filter similar to the one found inside Single Unit Filters (see [[FilterWML]]). The menu item will only be available on matching locations.<br />
* '''[command]''': contains the WML actions to be executed when the menu item is selected. Again, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked on.<br />
<br />
== Other interface tags ==<br />
<br />
The following tags are also action tags:<br />
* '''[item]''': makes a graphical item appear on a certain hex. Note this only places the graphics for an item. It does not make the item do anything. Use a moveto event to make moving onto the item do something. <tt>''('''Hint:''' There are a number of predefined items that are used in various campaigns that you can make use of. You can find [http://www.wesnoth.org/macro-reference.xhtml#file:items.cfg a list of them] if you look into the items.cfg file in the wesnoth install directory (under /data/core/macros))''</tt><br />
** '''x''', '''y''': the location to place the item.<br />
** '''image''': the image (in ''images/'' as .png) to place on the hex.<br />
** '''halo''': an image to place centered on the hex. Use this instead of ''image'' if the image is bigger than the hex.<br />
** '''team_name''': name of the team for which the item is to be displayed (hidden for others). For multiple teams just put all the names in one string, for example separated by commas. {{DevFeature}}<br />
** '''fogged'''(yes/no): controls if the item is to be hidden under fog. By default all items are hidden under fog. {{DevFeature}}<br />
* '''[removeitem]''': removes any graphical items on a given hex<br />
** '''x''', '''y''': the hex to remove items off<br />
** '''image''' {{DevFeature}} if specified, only removes the given image item<br />
* '''[print]''': displays a message across the screen. The message will disappear after a certain time.<br />
** '''text''': (translatable) the text to display.<br />
** '''size''': (default=12) the pointsize of the font to use<br />
** '''duration''': (default=50) the length of time to display the text for. This is measured in the number of 'frames'. A frame in Wesnoth is usually displayed for around 30ms.<br />
** '''red''', '''green''', '''blue''': (default=0,0,0) the color to display the text in. Values vary from 0-255.<br />
* '''[move_unit_fake]''': moves an image of a unit along a certain path on the map. The path does not need to be a continuous list of adjacent hexes, so for example only the start and end points can be given, in which case the straightest line between those points will be calculated and used.<br />
** '''type''': the type of the unit whose image to use<br />
** '''x''': a comma-separated list of x locations to move along<br />
** '''y''': a comma-separated list of y locations to move along (x and y values are matched pairs)<br />
** '''side''': the side of the fake unit, used for team-coloring the fake unit<br />
* '''[hide_unit]''': makes the given unit become invisible. Useful in conjunction with '''[move_unit_fake]''': to move a leader unit into position on-screen. Only one unit may be hidden at a time.<br />
** '''x''', '''y''': location of the unit to be hidden. (NOT a standard unit filter! Just x and y.)<br />
* '''[unhide_unit]''': stops the currently hidden unit from being hidden.<br />
* '''[scroll]''': Scroll a certain number of pixels in a given direction. Useful for earthquake/shaking effects.<br />
** '''x''', '''y''': the number of pixels to scroll along the x and y axis<br />
* '''[scroll_to]''': Scroll to a given hex<br />
** '''x''', '''y''': the hex to scroll to<br />
** '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''true'' (don't scroll to fog) and ''false'' (scroll even to fog), with ''false'' as the default.<br />
* '''[scroll_to_unit]''' Scroll to a given unit<br />
** [[StandardUnitFilter]]<br />
** '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''true'' (don't scroll to fog) and ''false'' (scroll even to fog), with ''false'' as the default.<br />
* '''[sound]''': Plays a sound<br />
** '''name''': the filename of the sound to play (in ''sounds/'' as .wav or .ogg)<br />
** '''repeat''': repeats the sound for a specified additional number of times (default=0)<br />
* '''[sound_source]''': Creates a sound source. "Sound sources" is a general name for a mechanism which makes possible for map elements to emit sounds according to some rules, where "map elements" can be specific locations or terrain types. For now, only sound sources tied to locations are supported.<br />
** '''id''': a unique identification key of the sound source<br />
** '''sounds''': a list of comma separated, randomly played sounds associated with the sound source<br />
** '''delay''': a numerical value (in milliseconds) of the minimal delay between two playbacks of the source's sound if the source remains visible on the screen; if one scrolls out and back in, the source will be considered as ready to play<br />
** '''chance''': a percentage (a value from 0 to 100) describing the chance of the source being activated every second after the delay has passed or when the source's location appears on the screen (note that it cannot play more than one file at the same time)<br />
** '''check_fogged''': possible values "true" and "false" - if true the source will not play if its locations are fogged/shrouded<br />
** '''loop''': number of times a sound sample should be looped if it stays visible. -1 means infinite (~65000) {{DevFeature}}<br />
** '''full_range''': distance in hexes that determines a "circular" area where source plays with full volume, relative to screen center {{DevFeature}}<br />
** '''fade_range''': distance in hexes that determines a "circular" area around the one specified by '''full_range''' where sound volume fades out linearly; by default equals to '''full_range''' {{DevFeature}}<br />
** '''x,y''': a [[StandardLocationFilter]] for the locations associated with the sound source<br />
* '''[remove_sound_source]''': Removes a previously defined sound source.<br />
** '''id''': the identification key of the sound source to remove<br />
* '''[music]''': Switches to playing different music<br />
** '''name''': the filename of the music to play (in ''music/'' as .ogg)<br />
** see [[MusicListWML]] for the correct syntax<br />
* '''[colour_adjust]''': tints the colour of the screen.<br />
** '''red''', '''green''', '''blue''': values from -255 to 255, the amount to tint by for each colour<br />
* '''[delay]''': pauses the game<br />
** '''time''': the time to pause in milliseconds<br />
* '''[redraw]''': redraws the screen (this normally isn't done during events, although some of the other interface actions cause the screen or parts of it to be redrawn).<br />
** '''side''': if used, recalculates fog and shroud for that side. Useful if you for example spawn friendly units in the middle of an event and want the shroud to update accordingly (otherwise units that spawn inside fog would remain invisible for the duration of the event, since the fog would not automatically get cleared around them).<br />
* '''[unit_overlay]''': sets an image that will be drawn over a particular unit, and follow it around<br />
** '''x''', '''y''': the location of the unit to overlay on<br />
** '''image''': the image to place on the unit<br />
* '''[remove_unit_overlay]''': removes a particular overlayed image from a unit<br />
** '''x''', '''y''': the location of the unit to remove an overlay from<br />
** '''image''': the image to remove from the unit<br />
* '''[animate_unit]''': uses the custom animation of a unit to animate it on screen (if the unit has the corresponding animation)<br />
** '''flag''': the key to find the good custom animation in the unit description see the '''[extra_anim]''' description in [[AnimationWML]] Standar anims can be triggered with the following keywors ''leading recruited standing idling levelin levelout healing healed poisoned movement defend attack death victory pre_teleport post_teleport''<br />
** '''[filter]''': a [[StandardUnitFilter]] see [[FilterWML]] by default, the unit at the event location will be animated. You can use this tag to choose any other unit to animate<br />
** '''[primary_attack]''': if this tag is not present, the filter for animation will be triggered with no attack. If it is here, all attacks from the unit will be filtered, and a matching one will be used to filter the animation<br />
** '''[secondary_attack]''': same for the second attack<br />
** '''hit''': the hit type to filter unit on<br />
** '''text''': a text to hover during the animation<br />
** '''text_color''': red,green,blue (displayed r,g,b) value for the text color<br />
** '''with_bars''': whether to display the status bars or not.<br />
* '''[label]''' places a label on the map.<br />
** '''x''', '''y''': the location of the label<br />
** '''text''': what the label should say<br />
** '''team_name''': if specified, the label will only be visible to the given team.<br />
* '''[deprecated_message]''' shows a deprecated message in the message area, this feature is only intended to be used to warn about deprecated macros in mainline. The message is not translatable.<br />
** '''message''': the message to show.<br />
* '''[debug_message]''': outputs a message to Wesnoth's console output. Intended for campaign designers to output silent text to the console, without annoying the player; then, that text might contain information useful for later bug-reporting.<br />
** '''message''': the message to show<br />
** '''logger''': the Wesnoth engine output logger that should catch the text; this might be 'err' (the errors log level), 'warn'/'wrn' (the warnings log level) or anything else (the information log level). Not all information will be displayed depending on the log level chosen when starting Wesnoth.<br />
<br />
== Useful Macros ==<br />
There are some predefined macros that you find useful for interface actions. You can find a complete list along with a detailed explanation of how they work [http://www.wesnoth.org/macro-reference.xhtml here].<br />
* '''{FLOATING_TEXT}''' Float some text over a unit similar to the damage numbers.<br />
* '''{HIGHLIGHT_UNIT}''' Highlight a unit on the map. Use this to show important units<br />
* '''{HIGHLIGHT_IMAGE}''' Places and highlights an image on the map. Use this to show important items or locations<br />
* '''{SET_IMAGE}''' Places an image on the map which has no other function.<br />
* '''{TREMOR}''' Creates a tremor like screenshake<br />
* '''{FLASH_WHITE}''' Flash the screen white momentarily. You can also replace WHITE with RED, BLUE or GREEN for a different colour.<br />
<br />
== See Also ==<br />
* [[DirectActionsWML]]<br />
* [[InternalActionsWML]]<br />
* [[EventWML]]<br />
* [[ReferenceWML]]<br />
<br />
<br />
[[Category: WML Reference]]</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingCampaignsTutorial/FirstCampaign&diff=27196BuildingCampaignsTutorial/FirstCampaign2008-10-22T17:15:42Z<p>Opensourcejunkie: </p>
<hr />
<div>[[BuildingCampaignsTutorial|Building Campaigns Tutorial]] => First Campaign<br />
<br />
<br />
<br />
This section of the tutorial will help you install the skeleton campaign, and customize it to make it your own.<br />
<br />
== Installing The Campaign ==<br />
To install the skeleton campaign, follow the following instructions:<br />
# Download the campaign ([http://www.wesnoth.org/forum/download/file.php?id=25059 link]).<br />
# Unzip the downloaded file.<br />
# Move the newly unzipped folder (entitled "A_Simple_Campaign") into the following directory: "([[EditingWesnoth#Where_is_my_user_data_directory.3F|userdata]])/data/campaigns". Once it's moved, the campaign directory should be located at "([[EditingWesnoth#Where_is_my_user_data_directory.3F|userdata]])/data/campaigns/A_Simple_Campaign".<br />
# Run Wesnoth<br />
# From the main screen, click "Campaign". Scroll down until you find a campaign called "A Simple Campaign". Select it, select a difficulty, and make sure that the first scenario loads. If everything works correctly, then move on to the next section. If at any point you get an error message, or the campaign doesn't appear in the list at all, then make sure that you performed each of the steps above correctly. If you did, and the problem persists, leave a comment on the [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=22618&p=316262#p316262 forum post].</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingCampaignsTutorial/FirstCampaign&diff=27195BuildingCampaignsTutorial/FirstCampaign2008-10-22T17:15:17Z<p>Opensourcejunkie: </p>
<hr />
<div>[[BuildingCampaignsTutorial|Building Campaigns Tutorial]] => First Campaign<br />
<br />
This section of the tutorial will help you install the skeleton campaign, and customize it to make it your own.<br />
<br />
== Installing The Campaign ==<br />
To install the skeleton campaign, follow the following instructions:<br />
# Download the campaign ([http://www.wesnoth.org/forum/download/file.php?id=25059 link]).<br />
# Unzip the downloaded file.<br />
# Move the newly unzipped folder (entitled "A_Simple_Campaign") into the following directory: "([[EditingWesnoth#Where_is_my_user_data_directory.3F|userdata]])/data/campaigns". Once it's moved, the campaign directory should be located at "([[EditingWesnoth#Where_is_my_user_data_directory.3F|userdata]])/data/campaigns/A_Simple_Campaign".<br />
# Run Wesnoth<br />
# From the main screen, click "Campaign". Scroll down until you find a campaign called "A Simple Campaign". Select it, select a difficulty, and make sure that the first scenario loads. If everything works correctly, then move on to the next section. If at any point you get an error message, or the campaign doesn't appear in the list at all, then make sure that you performed each of the steps above correctly. If you did, and the problem persists, leave a comment on the [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=22618&p=316262#p316262 forum post].</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingCampaignsTutorial/FirstCampaign&diff=27194BuildingCampaignsTutorial/FirstCampaign2008-10-22T17:11:43Z<p>Opensourcejunkie: /* Installing The Campaign */</p>
<hr />
<div>This section of the tutorial will help you install the skeleton campaign, and customize it to make it your own.<br />
<br />
== Installing The Campaign ==<br />
To install the skeleton campaign, follow the following instructions:<br />
# Download the campaign ([http://www.wesnoth.org/forum/download/file.php?id=25059 link]).<br />
# Unzip the downloaded file.<br />
# Move the newly unzipped folder (entitled "A_Simple_Campaign") into the following directory: "([[EditingWesnoth#Where_is_my_user_data_directory.3F|userdata]])/data/campaigns". Once it's moved, the campaign directory should be located at "([[EditingWesnoth#Where_is_my_user_data_directory.3F|userdata]])/data/campaigns/A_Simple_Campaign".<br />
# Run Wesnoth<br />
# From the main screen, click "Campaign". Scroll down until you find a campaign called "A Simple Campaign". Select it, select a difficulty, and make sure that the first scenario loads. If everything works correctly, then move on to the next section. If at any point you get an error message, or the campaign doesn't appear in the list at all, then make sure that you performed each of the steps above correctly. If you did, and the problem persists, leave a comment on the [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=22618&p=316262#p316262 forum post].</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingCampaignsTutorial/FirstCampaign&diff=27193BuildingCampaignsTutorial/FirstCampaign2008-10-22T17:04:57Z<p>Opensourcejunkie: /* Installing The Campaign */</p>
<hr />
<div>This section of the tutorial will help you install the skeleton campaign, and customize it to make it your own.<br />
<br />
== Installing The Campaign ==<br />
To install the skeleton campaign, follow the following instructions:<br />
# Download the campaign ([http://www.wesnoth.org/forum/download/file.php?id=25059 link])<br />
# Unzip the downloaded file<br />
# Move the newly unzipped folder (entitled "A_Simple_Campaign") into the following directory: "([[EditingWesnoth#Where_is_my_user_data_directory.3F|userdata]])/data/campaigns". Once it's moved, the campaign directory should be as follows: "([[EditingWesnoth#Where_is_my_user_data_directory.3F|userdata]])/data/campaigns/A_Simple_Campaign"</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingCampaignsTutorial/FirstCampaign&diff=27192BuildingCampaignsTutorial/FirstCampaign2008-10-22T17:03:39Z<p>Opensourcejunkie: </p>
<hr />
<div>This section of the tutorial will help you install the skeleton campaign, and customize it to make it your own.<br />
<br />
== Installing The Campaign ==<br />
To install the skeleton campaign, follow the following instructions:<br />
# Download the campaign ([http://www.wesnoth.org/forum/download/file.php?id=25059 link])<br />
# Unzip the downloaded file<br />
# Move the newly unzipped folder (entitled "A_Simple_Campaign") into the following directory: "([[http://www.wesnoth.org/wiki/EditingWesnoth#Where_is_my_user_data_directory.3F|userdata]])/data/campaigns". Once it's moved, the campaign directory should be as follows: "([[http://www.wesnoth.org/wiki/EditingWesnoth#Where_is_my_user_data_directory.3F|userdata]])/data/campaigns/A_Simple_Campaign"</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingCampaignsTutorial&diff=27191BuildingCampaignsTutorial2008-10-22T16:42:04Z<p>Opensourcejunkie: </p>
<hr />
<div>Often, it seems, the hardest thing for a new campaign developer to accomplish is getting his campaign to work. He creates all of the necessary files, types everything up, and when he tries to run it, an obscure error appears, stopping him from even entering his first scenario. Such errors are often difficult to debug, leaving the aspiring coder with nothing but frustration.<br />
<br />
Because of this, an often-recommended approach is to take another campaign, already written, and use it as a code base to build your own. This tutorial takes that approach, providing a simple campaign that can be (relatively) easily altered to fit your needs.<br />
<br />
The following links will guide you through the different sections of the tutorial. To get started, select the first link (First Campaign), and follow the instructions<br />
<br />
# [[BuildingCampaignsTutorial/FirstCampaign|First Campaign]]<br />
# [[BuildingCampaignsTutorial/FirstScenario|First Scenario]]<br />
# [[BuildingCampaignsTutorial/FirstCustomUnit|First Custom Unit]]<br />
<br />
== Downloads ==<br />
The following is a list of all the files used by this tutorial:<br />
* [http://www.wesnoth.org/forum/download/file.php?id=25059 A Simple Campaign] - a working skeleton campaign that can be built into a real campaign<br />
<br />
== Feedback ==<br />
Feedback on this developing tutorial is much appreciated. You can offer your recommendations on the [http://www.wesnoth.org/forum/viewtopic.php?f=8&t=22618&p=316262#p316262 forum post] dedicated to this tutorial and its corresponding skeleton campaign. Thank you for helping to improve this!</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingCampaignsTutorial&diff=27190BuildingCampaignsTutorial2008-10-22T16:33:29Z<p>Opensourcejunkie: /* Downloads */</p>
<hr />
<div>Often, it seems, the hardest thing for a new campaign developer to accomplish is getting his campaign to work. He creates all of the necessary files, types everything up, and when he tries to run it, an obscure error appears, stopping him from even entering his first scenario. Such errors are often difficult to debug, leaving the aspiring coder with nothing but frustration.<br />
<br />
Because of this, an often-recommended approach is to take another campaign, already written, and use it as a code base to build your own. This tutorial takes that approach, providing a simple campaign that can be (relatively) easily altered to fit your needs.<br />
<br />
The following links will guide you through the different sections of the tutorial. To get started, select the first link (First Campaign), and follow the instructions<br />
<br />
# [[BuildingCampaignsTutorial/FirstCampaign|First Campaign]]<br />
# [[BuildingCampaignsTutorial/FirstScenario|First Scenario]]<br />
# [[BuildingCampaignsTutorial/FirstCustomUnit|First Custom Unit]]<br />
<br />
== Downloads ==<br />
The following is a list of all the files used by this tutorial:<br />
* [http://www.wesnoth.org/forum/download/file.php?id=25059 A Simple Campaign] - a working skeleton campaign that can be built into a real campaign</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingCampaignsTutorial&diff=27189BuildingCampaignsTutorial2008-10-22T16:31:06Z<p>Opensourcejunkie: </p>
<hr />
<div>Often, it seems, the hardest thing for a new campaign developer to accomplish is getting his campaign to work. He creates all of the necessary files, types everything up, and when he tries to run it, an obscure error appears, stopping him from even entering his first scenario. Such errors are often difficult to debug, leaving the aspiring coder with nothing but frustration.<br />
<br />
Because of this, an often-recommended approach is to take another campaign, already written, and use it as a code base to build your own. This tutorial takes that approach, providing a simple campaign that can be (relatively) easily altered to fit your needs.<br />
<br />
The following links will guide you through the different sections of the tutorial. To get started, select the first link (First Campaign), and follow the instructions<br />
<br />
# [[BuildingCampaignsTutorial/FirstCampaign|First Campaign]]<br />
# [[BuildingCampaignsTutorial/FirstScenario|First Scenario]]<br />
# [[BuildingCampaignsTutorial/FirstCustomUnit|First Custom Unit]]<br />
<br />
== Downloads ==<br />
The following is a list of all the files used by this tutorial:<br />
* [http://www.wesnoth.org/forum/download/file.php?id=25059 A Simple Campaign]</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingCampaignsTutorial&diff=27188BuildingCampaignsTutorial2008-10-22T16:27:50Z<p>Opensourcejunkie: </p>
<hr />
<div>Often, it seems, the hardest thing for a new campaign developer to accomplish is getting his campaign to work. He types creates all of the necessary files, types everything up, and when he tries to run it, an obscure error appears, stopping him from even entering his first scenario. Such errors are often difficult to debug, leaving the aspiring coder with nothing but frustration.<br />
<br />
Because of this, an often-recommended approach is to take another campaign, already written, and use it as a code base to build your own. This tutorial takes that approach, providing a simple campaign that can be (relatively) easily altered to fit your needs.<br />
<br />
The following links will guide you through the different sections of the tutorial. To get started, select the first link (First Campaign), and follow the instructions<br />
<br />
# [[BuildingCampaignsTutorial/FirstCampaign|First Campaign]]<br />
# [[BuildingCampaignsTutorial/FirstScenario|First Scenario]]<br />
# [[BuildingCampaignsTutorial/FirstCustomUnit|First Custom Unit]]</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingCampaignsTutorial&diff=27187BuildingCampaignsTutorial2008-10-22T16:27:14Z<p>Opensourcejunkie: </p>
<hr />
<div>Often, it seems, the hardest thing for a new campaign developer to accomplish is getting his campaign to work. He types creates all of the necessary files, types everything up, and when he tries to run it, an obscure error appears, stopping him from even entering his first scenario. Such errors are often difficult to debug, leaving the aspiring coder with nothing but frustration.<br />
<br />
Because of this, an often-recommended approach is to take another campaign, already written, and use it as a code base to build your own. This tutorial takes that approach, providing a simple campaign that can be (relatively) easily altered to fit your needs.<br />
<br />
The following links refer to different sections of the tutorial. To get started, select the first link (First Campaign), and follow the instructions<br />
<br />
# [[BuildingCampaignsTutorial/FirstCampaign|First Campaign]]<br />
# [[BuildingCampaignsTutorial/FirstScenario|First Scenario]]<br />
# [[BuildingCampaignsTutorial/FirstCustomUnit|First Custom Unit]]</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingCampaignsTutorial&diff=27186BuildingCampaignsTutorial2008-10-22T16:23:17Z<p>Opensourcejunkie: </p>
<hr />
<div>Often, it seems, the hardest thing for a new campaign developer to accomplish is getting his campaign to work. He types creates all of the necessary files, types everything up, and when he tries to run it, an obscure error appears, stopping him from even entering his first scenario. Such errors are often difficult to debug, leaving the aspiring coder with nothing but frustration.<br />
<br />
Because of this, an often-recommended approach is to take another campaign, already written, and use it as a code base to build your own. This tutorial uses that approach<br />
<br />
* [[BuildingCampaignsTutorial/FirstCampaign|First Campaign]]<br />
* [[BuildingCampaignsTutorial/FirstScenario|First Scenario]]<br />
* [[BuildingCampaignsTutorial/FirstCustomUnit|First Custom Unit]]</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingCampaignsTutorial/FirstCampaign&diff=27185BuildingCampaignsTutorial/FirstCampaign2008-10-22T16:13:08Z<p>Opensourcejunkie: New page: temp</p>
<hr />
<div>temp</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingCampaignsTutorial&diff=27184BuildingCampaignsTutorial2008-10-22T16:12:57Z<p>Opensourcejunkie: New page: * First Campaign * First Scenario * First Custom Unit</p>
<hr />
<div>* [[BuildingCampaignsTutorial/FirstCampaign|First Campaign]]<br />
* [[BuildingCampaignsTutorial/FirstScenario|First Scenario]]<br />
* [[BuildingCampaignsTutorial/FirstCustomUnit|First Custom Unit]]</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=BuildingCampaigns&diff=27183BuildingCampaigns2008-10-22T16:08:20Z<p>Opensourcejunkie: added a link to the (upcoming campaign tutorial</p>
<hr />
<div>{| style="float:right; margin-left:1em;"<br />
|__TOC__<br />
|}<br />
<br />
This page describes how to make your own user campaign for use with Battle for Wesnoth. Please note that this document is not normative - its author is not a Wesnoth developer. I'm simply reporting on what works for me, and on what developers have prescribed elsewhere.<br />
If you see any errors, please fix them.<br />
<br />
See also [[DebuggingCampaigns]] if your scenario doesn't load.<br />
<br />
There are several steps to building a single player campaign in Wesnoth. The mechanics are covered in the sections below:<br />
<br />
* [[BuildingCampaignsDirectoryStructure]]<br />
* [[BuildingCampaignsTheCampaignFile]]<br />
* [[BuildingCampaignsThePBLFile]]<br />
* [[BuildingCampaignsDistribution]]<br />
* [[WesCamp]] (How to make your campaign translatable, and get in touch with translators)<br />
* [[UMCSandbox]] (Where you can collaborate on UMC projects)<br />
<br />
Because many aspiring campaign developers find the initial creation of a working campaign to be difficult (if not exasperating) a [[BuildingCampaignsTutorial|step-by-step tutorial]] covering the initial phase of campaign development (getting it to work) is under construction. It includes a working campaign that you can install, and then alter to fit your own needs<br />
<br />
Xer has also created a campaign skeleton which is the barebones of a campaign: [http://www.wesnoth.org/forum/download/file.php?id=24587 here]<br />
<br />
What follows is a collection of advice to aspiring campaign designers extracted from the Wesnoth fora. For a more in-depth treatment including heuristics for scenario and campaign balancing, see the [http://catb.org/~esr/wesnoth/campaign-design-howto.html Campaign Design How-To].<br />
<br />
== Start with Something Manageable ==<br />
<br />
If you set out to make an epic campaign spanning the whole history of Wesnoth, you'll likely (not necessarily, though)<br />
become bored or frustrated along the<br />
way somewhere and give up. It's much easier to start with a small story and add elements to it than it is to cut an<br />
epic down to the length of a haiku.<br />
<br />
;Shade (author of The Rise of Wesnoth) wrote<nowiki>:</nowiki><br />
: I started TRoW last April, even after it was scenario complete it was still eating all of my free time (Time not spent sleeping, at school / work, or with loved ones / friends) until mid-November... Even now there is still bugfixing and a couple of things I'd like to add... and keeping it up to date with the game engine and any new happenings on the WML front... so there is still quite a lot to keep you busy after you are done... The forums are littered with half finished epics... Before you commit to an epic think long and hard. I don't want to discourage you too much... But it is a lot of 'work' (& fun)<br />
<br />
== Story First ==<br />
<br />
What separates a campaign from a single scenario is the ability to tell a story. Consequently, what keeps people coming back for more is a good, interesting story mixed with good, interesting game play. If you have a good idea of where the story of your campaign is going when you start, the little<br />
pieces will fall into place much more easily. After all, it worked for Pixar!<br />
<br />
;Scott (author of Liberty, the outlaw campaign) wrote<nowiki>:</nowiki><br />
: Here is how I wrote Liberty.<br />
:# Write a rough story and plot<br />
:# Decide how many scenarios you want to have<br />
:# Divide the story between the scenarios so you can decide what will happen in each scenario<br />
:#* where are you?<br />
:#* who are you fighting and why?<br />
:#* what do you have to do in this scenario?<br />
:#* where does the hero want to go next?<br />
:# Decide on the "hook" for each scenario. There are a lot of different possible setups for scenarios, and if you want to avoid the boring repetition of "Kill the 2 enemy leaders" you can list interesting combinations of enemies, allies, shroud/fog, day/night effects, recruiting and terrain situations, etc. and pick a good mix to keep the combat interesting and fun. <br />
: All of this has happened without doing any WML, but now you have enough to start coding.<br />
<br />
The [http://catb.org/~esr/wesnoth/campaign-design-howto.html Campaign Design How-To] has much more to say about this storyboarding phase of the process.<br />
<br />
== Share Early ==<br />
<br />
Don't be shy to post whatever you've created for others to look at. We all had to learn too, and there are many people on the Scenario and Campaign Development forum (http://www.wesnoth.org/forum/viewforum.php?f=8) who are eager to help people learn.<br />
<br />
;Turin (author of Eastern Invasion) wrote<nowiki>:</nowiki> <br />
: I'm working on a loyalist campaign now. I already have the basic plot. I am wondering if anyone wants to playtest my completed levels (i am done with two). Thus i want to know if i should just post the new files as attachments, or what. There are two map files, two scenario files, an image file, a unit file, and you have to change the game file to access the campaign from the 'campaign menu. So tell me how i should make them accessable.<br />
<br />
== Steal Often ==<br />
<br />
There are too many quotations to pick one for this maxim. The best way to learn how to do something is to copy it from someone else's campaign. It's polite to ask first, and most Campaign designers are happy to see small bits of their WML living in other campaigns.<br />
It's generally poor form to copy whole scenarios, maps, and campaigns, though. And especially poor form to do so without permission.<br />
<br />
== Next: ==<br />
* [[BuildingCampaignsTheCampaignFile]]<br />
<br />
<br />
== See Also ==<br />
<br />
* [[Create]]<br />
* [[BuildingScenarios]]<br />
* [[Using custom themes in campaigns]]<br />
* [[ReferenceWML]]<br />
* [[UserScenarios]]<br />
* [[ExternalUtilities]]<br />
* [http://www.catb.org/~esr/wesnoth/campaign-design-howto.html Campaign Design How To]<br />
<br />
<br />
{{Create}}</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=CampaignWML&diff=26868CampaignWML2008-09-23T16:47:22Z<p>Opensourcejunkie: </p>
<hr />
<div>{{WML Tags}}<br />
== the [campaign] tag ==<br />
<br />
<!--<br />
<br />
Dacyn and/or Invisible Philosopher -- please be careful<br />
you don't reduce the signal-to-noise ratio on the WML pages<br />
when editing! Eg. knowing that a tag is translatable is _important_<br />
for the 29 translations we have in progress. -- ott<br />
<br />
--><br />
<br />
This tag describes a campaign, and is used for the "Campaign" menu<br />
in the title screen.<br />
<br />
The '''[campaign]''' tag has the following attibutes:<br />
* '''id''': the internal campaign identifier used to classify saved games<br />
* '''icon''': the image displayed in the campaign selection menu<br />
* '''name''': (translatable) name displayed in the campaign selection menu<br />
* '''abbrev''': (translatable) abbreviation used as a prefix for savefile names made from this campaign<br />
* '''image''': the image shown in the information pane when this campaign is selected in the campaign selection menu<br />
* '''description''': (translatable) text shown in the information pane when this campaign is selected in the campaign selection menu<br />
* '''define'''='''''CAMPAIGN_SYMBOL''''' when this campaign is started, the preprocessor symbol '''''CAMPAIGN_SYMBOL''''' will be defined. See '''#ifdef''' in [[PreprocessorRef]] for how this can be used to isolate parts of the campaign file from other campaigns. Only the tags '''[campaign]''' and '''[binary_path]''' (see [[BinaryPathWML]]) should go outside of '''#ifdef ''CAMPAIGN_SYMBOL'''''. This symbol will be defined ''before'' any .cfg is preprocessed.<br />
* '''extra_defines''': a comma(''',''') separated list of preprocessor symbols. Those symbols will be defined ''before'' any .cfg is preprocessed.<br />
* '''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.<br />
* '''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.<br />
* '''first_scenario''': the ID of the first scenario in the campaign; see ''id'' in [[ScenarioWML]]<br />
* '''rank''': a number that determines the order of campaigns in the campaign selection menu. Lower ''rank'' campaigns appear earlier, with unranked campaigns at the end. Currently the mainline campaigns use multiples of 10 from 0 to 399, with 0-99 for Novice campaigns, 100-199 for Intermediate campaigns, and 200-399 for Expert campaigns; if you specify this, it should not be less than 400. (Note: This replaces an older convention that topped out at 50.)<br />
* '''[about]''': 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, but none of them will display credits if there is no "id" key present inside [campaign] (see above). The '''[about]''' tag has the following keys:<br />
** '''title''': (translatable) large text used to start a new subsection (writers, artists, units, balancing) in the rolling credits<br />
** '''text''': (translatable, but you probably won't want to make it such) smaller text which is displayed before the contributor names<br />
** '''[entry]''': Contains information about a single contributor. Only the ''name'' key will be used in-game, the other three keys are for display on the Credits website.<br />
*** '''name''': The name of the contributor<br />
*** '''comment''': Optional short note about what that person did<br />
*** '''email''': Optional email address<br />
*** '''wikiuser''': Optional, the user name on the wiki<br />
<br />
== See Also ==<br />
<br />
* [[PreprocessorRef]]<br />
* [[ScenarioWML]]<br />
* [[ReferenceWML]]<br />
* [[PblWML]]<br />
<br />
<br />
[[Category: WML Reference]]</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=MusicListWML&diff=26606MusicListWML2008-09-06T15:18:09Z<p>Opensourcejunkie: /* the [music] tag */</p>
<hr />
<div>{{WML Tags}}<br />
== the [music] tag ==<br />
<br />
This tag is a subtag of [scenario] and [event] which is used to describe a music track to play. You can repeat this tag as many times as you like; if you set the ''append'' tag to ''yes'' they will form a playlist from which tracks will be selected at random.<br />
<br />
Tags describe the music track:<br />
* ''name'' specifies the music file, relative to '"music/"'. This is compulsory.<br />
* ''append=yes'' specifies this is to be added to the current playlist. Without this, the current playlist is replaced by this track. (Note: if the same track is appended multiple times in a row, it will only play once before moving on to the next (different) track)<br />
* ''play_once=yes'' immediately switch to playing this track, but then return to the play list, which is unchanged.<br />
* ''immediate=yes'' immediately switch to playing this track. Without this, the song will play when the entire [event] is over or the current song ends. This exists to force music changes '''during''' dialog exchange or other [event] which take significant time.<br />
* ''ms_before'' (optional) specifies how many milliseconds to delay before playing this track. Currently this does not apply when the scenario first starts, or with ''play_once'' or ''immediate''.<br />
* ''ms_after'' (optional) specifies how many milliseconds to delay after playing this track.<br />
<br />
For a list of music tracks you can use in your scenario, see [[Available Music]].<br />
<br />
=== Example ===<br />
This creates a new playlist with three entries in it. The second track is always preceeded by 1/2 a second of silence.<br />
[music]<br />
name=background-music-1.ogg<br />
[/music]<br />
[music]<br />
name=background-music-2.ogg<br />
ms_before=500<br />
append=yes<br />
[/music]<br />
[music]<br />
name=background-music-3.ogg<br />
append=yes<br />
[/music]<br />
<br />
<br />
<br />
[[Category: WML Reference]]<br />
[[Category:Music]]</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=User:Opensourcejunkie&diff=26402User:Opensourcejunkie2008-08-12T01:46:24Z<p>Opensourcejunkie: create page</p>
<hr />
<div>hey all! maybe I should add some text here...</div>Opensourcejunkiehttps://wiki.wesnoth.org/index.php?title=SideWML&diff=26394SideWML2008-08-12T00:58:24Z<p>Opensourcejunkie: added link to SideSwitchingWML (not yet created)</p>
<hr />
<div>{{WML Tags}}<br />
== the [side] tag ==<br />
<br />
The [side] tag is used to describe a side in a particular scenario.<br />
<br />
The following keys are recognized:<br />
<br />
* '''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.<br />
<br />
* '''controller''': how moves for this side should be inputted.<br />
** '''ai''': the Wesnoth AI makes this side's moves. This is the default setting.<br />
** '''human''': a player controls this side's moves.<br />
** '''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.)<br />
<br />
* '''no_leader''': if "no" (default), then keys describing a unit which will begin on the side's keep will be 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=yes''') and if one is found it will be used instead of the one described in the '''[side]''' tag. Typical keys used for defining the leader unit are '''type''' (mandatory), '''description''', '''id''' {{DevFeature}}, '''user_description''', '''name''' {{DevFeature}} and '''unrenamable=yes''', see [[UnitWML]].<br />
<br />
* '''recruit''': a list of unit types. At the beginning of the scenario, the side gains recruitment of these units.<br />
<br />
* '''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.)<br />
<br />
* '''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]]).<br />
<br />
* '''fog''': if 'yes', this side cannot see any tiles it is not within vision of, except at the start.<br />
<br />
* '''shroud''': if 'yes', this side cannot see any tiles it has not moved within sight of.<br />
<br />
* '''shroud_data''': describes the area which this team has de-shrouded. An example:<br />
|<br />
|00011111000<br />
This would leave the first column on the map unaltered and would change the second column for 11 tiles. A '0' means: shrouded, '1' means unshrouded. You can either call an external file using {@filename} (see [[PreprocessorRef]]) or place the data in quotes. For making an external file see [[BuildingScenariosShroudData]].<br />
<br />
* '''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'.<br />
<br />
* '''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. See [[SideSwitchingWML]].<br />
<br />
* '''team_name''': a non translatable string representing the team's description. Sides with the same team_name are allied. Default ''side''.<br />
<br />
* '''user_team_name''': a translatable string representing the team's description. This has no effect on alliances. Default ''team_name''.<br />
<br />
* '''colour''': May be either a numeric color index or a color name (e.g. 'blue', 'purple', 'orange', etc.). The numeric form is deprecated. The default list of numbers and corresponding colours can be found in data/core/team_colors.cfg.<br />
<br />
* '''flag''': a custom flag animation to use instead of the default one to mark captured villages. An automatic side-coloring is applied.<br />
** 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''<br />
<br />
* '''flag_icon''': a custom flag icon to indicate the side playing in the statusbar (a size of 24x16 is recommended). An automatic side-coloring is applied.<br />
<br />
* '''village_gold''': the amount of gold given to this side per village it controls per turn. Default specified in ''village_income'', '''[game_config]''' ([[GameConfigWML]]). '''Note:''' If you need village gold to be 0. Set the variable to -1.<br />
<br />
* '''share_maps''': whether sides allied with this side see all terrains that this side sees, if they are on shroud.<br />
<br />
* '''share_view''': whether sides allied with this side see the units that this side sees, if they are on FoW (fog).<br />
<br />
* '''disallow_observers''': prevents observers from seeing this side turn. (default: no)<br />
<br />
* '''[ai]''' if '''controller=ai''', gives parameters to the AI. See [[AiWML]].<br />
<br />
* '''[village]''' describes a village the side begins in control of.<br />
** ''x'', ''y'' the location of the village.<br />
<br />
* '''[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]'''.<br />
<br />
<br />
The following keys are multiplayer only:<br />
<br />
* '''allow_player''': if false then this side will not be allowed to be modified and will be hidden during game creation.<br />
<br />
* '''team_lock''': if true then this side's team is not allowed to be modified.<br />
<br />
* '''colour_lock''': if true then this side's color is not allowed to be modified.<br />
<br />
* '''gold_lock''': if true then this side's gold is not allowed to be modified. <br />
<br />
* '''income_lock''': if true then this side's income is not allowed to be modified.<br />
<br />
* '''faction''': this lock this side to this faction.<br />
<br />
* '''faction_from_recruit''' {{DevFeature}}: if true then this side will be locked to the faction that matches the recruits better. (this was enabled by default in 1.4)<br />
<br />
== See Also ==<br />
* [[EraWML]]<br />
* [[ScenarioWML]]<br />
* [[ReferenceWML]]<br />
<br />
<br />
[[Category: WML Reference]]</div>Opensourcejunkie