BuildingScenariosSimple - Revision history

Namhub at 22:06, 10 October 2018

2018-10-10T22:06:00Z

Vultraz: /* Making it all work */

2014-03-06T08:55:39Z

‎Making it all work

Vultraz: /* First part */

2014-02-26T04:18:25Z

‎First part

Vultraz: /* See Also */

2014-02-20T08:09:50Z

‎See Also

Tr0ll at 17:36, 7 October 2012

2012-10-07T17:36:21Z

Tr0ll at 17:35, 7 October 2012

2012-10-07T17:35:20Z

Tr0ll: replace confusing reference to nonexistent ampersand with reference to macro

2012-10-07T17:33:18Z

replace confusing reference to nonexistent ampersand with reference to macro

Bumbadadabum at 21:09, 23 December 2011

2011-12-23T21:09:54Z

Elvish Hunter: /* First part */ Removed reference to old wesnoth-1.ogg

2011-10-27T09:12:57Z

‎First part: Removed reference to old wesnoth-1.ogg

Alarantalara: /* First part */ remove 'both' to fix grammar

2011-08-22T16:53:18Z

‎First part: remove 'both' to fix grammar

← Older revision		Revision as of 22:06, 10 October 2018
Line 1:		Line 1:
	{{BuildingScenariosNav}}		{{BuildingScenariosNav}}
−
−	~~= Learning things step by step =~~

	Here we will show you a very simple scenario file and explain each line of it.		Here we will show you a very simple scenario file and explain each line of it.

@@ Line 145: / Line 145: @@
 == Making it all work ==
 To make this scenario playable, we need to make a campaign for it (see [[BuildingCampaignsTheCampaignFile]]).
-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]]).
+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.
 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>_main.cfg</tt>).
 The following is a short, example campaign file:

@@ Line 67: / Line 67: @@
 * 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. The underscore before the name marks it as translatable.
-* 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>{~add-ons/Test_Campaign/maps/testmap.map}</code> does just that, telling the wesnoth engine to look in the file <code>add-ons/Test_Campaign/maps/testmap</code> for the map data.  The <code>~</code> symbol tells Wesnoth to search for the map file in the ''userdata'' 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).
+* 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>{~add-ons/Test_Campaign/maps/testmap.map}</code> does just that, telling the wesnoth engine to look in the file <code>add-ons/Test_Campaign/maps/testmap</code> for the map data.  The <code>~</code> symbol tells Wesnoth to search for the map file in the ''userdata'' directory (see [[EditingWesnoth]] and [[PreprocessorRef]] for more information).  You can create and edit map files using Wesnoth's built-in map editor (see [[BuildingMaps]] for more information).
 * 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.)

@@ Line 179: / Line 179: @@
 == See Also ==
-* [[BuildingMaps]] & [[WesnothMapEditor]]
+* [[BuildingMaps]]
 * [[ScenarioWML]] & [[SyntaxWML]]
 * [[BuildingScenarios]]
 [[Category:Create]]

@@ Line 174: / Line 174: @@
 The <code>difficulty_descriptions</code> uses a standard syntax. You provide an image, difficulty name, and a level. 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>. You can use whatever names you want, and don't need to stick with easy, normal and hard here. You do need to do this in the <code>difficulties</code> section, because many macros are based off this.
-Each list item in <code>difficulty_description</code> begins with the macro <code>MENU_IMG_TEXT2</code> which simplifies the syntax that follows (see [[DescriptionWML]]). 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").
+Each list item in <code>difficulty_description</code> begins with the macro <code>MENU_IMG_TEXT2</code> which simplifies the syntax (see [[DescriptionWML]]). 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").
 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.

@@ Line 171: / Line 171: @@
 Two optional attributes are <code>difficulty_descriptions</code> and <code>icon</code>.
 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.
-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").
+The <code>difficulty_descriptions</code> uses a standard syntax. You provide an image, difficulty name, and a level. 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>. You can use whatever names you want, and don't need to stick with easy, normal and hard here. You do need to do this in the <code>difficulties</code> section, because many macros are based off this.
 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.

@@ Line 13: / Line 13: @@
 <pre>
 <nowiki>
 [scenario]
@@ Line 18: / Line 19: @@
    next_scenario=02_test-more
-   name=A Simple Test Scenario
+   name= _ "A Simple Test Scenario"
-   map_data="{~add-ons/Test_Campaign/maps/testmap}"
+   map_data="{~add-ons/Test_Campaign/maps/testmap.map}"
    turns=20
@@ Line 55: / Line 56: @@
 <br>&nbsp;&nbsp;&nbsp; <font size=5>↓ ↓ ↓</font>
 </blockquote>
 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:
@@ Line 61: / Line 65: @@
 * 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.
-* 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.
+* 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. The underscore before the name marks it as translatable.
-* 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>{~add-ons/Test_Campaign/maps/testmap}</code> does just that, telling the wesnoth engine to look in the file <code>add-ons/Test_Campaign/maps/testmap</code> for the map data.  The <code>~</code> symbol tells Wesnoth to search for the map file in the ''userdata'' 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).
+* 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>{~add-ons/Test_Campaign/maps/testmap.map}</code> does just that, telling the wesnoth engine to look in the file <code>add-ons/Test_Campaign/maps/testmap</code> for the map data.  The <code>~</code> symbol tells Wesnoth to search for the map file in the ''userdata'' 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).
 * 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.)
@@ Line 108: / Line 112: @@
      type=Commander
      id=Konrad
      canrecruit=yes
@@ Line 129: / Line 134: @@
 * <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.
 * <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].
-* <code>id</code> is the name and identifier of the leader.
+* <code>id</code> is the identifier of the leader, as used by the engine, and is not visible by the player.
 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.
@@ Line 140: / Line 146: @@
 To make this scenario playable, we need to make a campaign for it (see [[BuildingCampaignsTheCampaignFile]]).
 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]]).
-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>).
+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>_main.cfg</tt>).
 The following is a short, example campaign file:
@@ Line 148: / Line 154: @@
     define=CAMPAIGN_TEST_CAMPAIGN
     difficulties=EASY,NORMAL,HARD
-    difficulty_descriptions= _ "&elvish-fighter.png=Easy;*&elvish-hero.png=Medium;&elvish-champion.png=Hard"
+    difficulty_descriptions={MENU_IMG_TXT2 "units/elves-wood/fighter.png" _"Fighter" _"(Beginner)"} +
-    icon=elvish-fighter.png
+    ";*" + {MENU_IMG_TXT2 "units/elves-wood/hero.png" _"Hero" _"(Normal)"} +
   [/campaign]
   #ifdef CAMPAIGN_TEST_CAMPAIGN
-  {~campaigns/test_campaign/scenarios}
+  {~add-ons/test_campaign/scenarios}
   #endif
@@ Line 163: / Line 171: @@
 Two optional attributes are <code>difficulty_descriptions</code> and <code>icon</code>.
 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.
-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>.
+The <code>difficulty_descriptions</code> uses a standard syntax, which is recommended. You provide an image, difficulty name, and a level. 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>. You can use whatever names you want, and don't need to stick with easy, normal and hard here. You do need to do this in the <code>difficulties</code> section, because many macros are based off this.
 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").

@@ Line 29: / Line 29: @@
    {SECOND_WATCH}
-   music=wesnoth-1.ogg
+   music=battle.ogg
    [event]