WML for Complete Beginners: Chapter 3 - Revision history

Celtic Minstrel: Use syntax highlighting

2023-01-29T19:52:44Z

Use syntax highlighting

Show changes

Celtic Minstrel: Update some obsolete stuff

2023-01-29T19:46:41Z

Update some obsolete stuff

Celtic Minstrel: Nicer index and navigation

2023-01-29T19:01:02Z

Nicer index and navigation

Octalot: /* Defining the Campaign */ Refer to a different tutorial to avoid the obsolete [campaign]difficulty_descriptions attribute

2021-12-06T07:24:12Z

‎Defining the Campaign: Refer to a different tutorial to avoid the obsolete [campaign]difficulty_descriptions attribute

Octalot: /* The Binary Path */ Since 1.15.3, binary_path supports map_file

2020-09-07T20:04:21Z

‎The Binary Path: Since 1.15.3, binary_path supports map_file

Volatus: /* The Preprocessor */

2020-06-16T16:31:13Z

‎The Preprocessor

William: /* Directory Inclusion */

2015-11-10T09:14:35Z

‎Directory Inclusion

William: /* Directory Inclusion */

2015-11-10T08:48:18Z

‎Directory Inclusion

Implementor37: /* Chapter 3: The _main.cfg */ added warning about accidently saving a _main.cfg.txt file

2015-03-17T21:18:02Z

‎Chapter 3: The _main.cfg: added warning about accidently saving a _main.cfg.txt file

Implementor37: Added link to the next chapter of WML_for_Complete_Beginners (Chapter 4)

2015-03-17T15:41:50Z

Added link to the next chapter of WML_for_Complete_Beginners (Chapter 4)

@@ Line 56: / Line 56: @@
 This tells the game that the text strings in this file belong to the text domain you just defined above
-Next we need to give the attributes '''id''','''name''','''abbrev''','''icon''','''image''','''first_scenario''','''description''','''difficulties''', and '''difficulty_descriptions'''. Don't assign any values to these attributes yet, we'll do that in a moment. For now, just make sure that you have all of these attributes in between the campaign tags, like so (the exact order of the attributes doesn't matter, but it is recommended that you follow the order given below to make things easier for yourself when following this tutorial):
+Next we need to give the attributes '''id''', '''name''', '''abbrev''', '''icon''', '''image''', '''first_scenario''', and '''description''', and define your campaign difficulties. Don't assign any values to these attributes yet, we'll do that in a moment. For now, just make sure that you have all of these attributes in between the campaign tags, like so (the exact order of the attributes doesn't matter, but it is recommended that you follow the order given below to make things easier for yourself when following this tutorial):
   [campaign]
@@ Line 98: / Line 98: @@
 *'''The "description" Attribute'''
-*'''The "difficulties" Attribute'''
+*'''Campaign difficulties'''
-*'''The "difficulty_descriptions" Attribute'''
+The campaign difficulties can be set with the [[CampaignWML|difficulty]] tag or the <tt>CAMPAIGN_DIFFICULTY</tt>macro. Please refer to a [[MakingCampaignInWML2#Difficulty|this tutorial]], and in that tutorial read on to its [[MakingCampaignInWML2#MACROS|macros]] section too.
   [campaign]
@@ Line 114: / Line 112: @@
       first_scenario=my_first_scenario
       description= _ "This is my first campaign."
-      difficulties=EASY
+      {CAMPAIGN_DIFFICULTY EASY  "units/human-loyalists/spearman.png~RC(magenta>red)" ( _ "Spearman") ( _ "Normal")}
   [/campaign]
@@ Line 130: / Line 127: @@
 You will only need to include a binary path if your campaign contains custom images, sounds or music that is not included in mainline Wesnoth. If you do not have any custom images, sounds or music, then you should not include a binary path. Since we will be including some custom images in our campaign, we are going to need to include a binary path.
 To create a binary path, use the following syntax:

@@ Line 1: / Line 1: @@
 ==Chapter 3: The _main.cfg==
@@ Line 176: / Line 178: @@
 (note: no units yet, save that for the adding custom units section)
-Next Chapter:
+{{Navigation|[[WML for Complete Beginners: Chapter 2|'''Chapter 2'''<br>The Userdata Directory<br>and the Campaign Folder]]|[[WML for Complete Beginners: Chapter 4|'''Chapter 4'''<br>Creating Your First Scenario]]}}
 [[Category:WML_for_Complete_Beginners]]

← Older revision		Revision as of 07:24, 6 December 2021
Line 99:		Line 99:

	*'''The "difficulty_descriptions" Attribute'''		*'''The "difficulty_descriptions" Attribute'''
		+
		+	'''Note:''' {{DevFeature1.13\|2}} The "difficulties" and "difficulty_descriptions" attributes have been replaced by the [[CampaignWML\|difficulty]] tag. Please refer to a [[MakingCampaignInWML2#Difficulty\|more recently-written tutorial]], and in that tutorial read on to its [[MakingCampaignInWML2#MACROS\|macros]] section too.

	[campaign]		[campaign]

@@ Line 126: / Line 126: @@
 You will only need to include a binary path if your campaign contains custom images, sounds or music that is not included in mainline Wesnoth. If you do not have any custom images, sounds or music, then you should not include a binary path. Since we will be including some custom images in our campaign, we are going to need to include a binary path.
 To create a binary path, use the following syntax:
@@ Line 132: / Line 134: @@
   [/binary_path]
 This tells the game to search the specified userdata directory whenever it cannot locate a certain file in the gamedata directory. Note that the value of the "path" key must always begin with "data/add-ons/" followed by the name of your campaign folder.
 ====Directory Inclusion====

@@ Line 115: / Line 115: @@
 ===The Preprocessor===
-(discuss preprocessor directives, binary path, directory inclusion, etc.)
+Before any WML file is read by Wesnoth, it goes through the preprocessor. The preprocessor will prepare the file to be read by the game. It doesn't actually recognize WML. In fact, it ignores it. Instead, it reads the '''preprocessor directives''', used to create and use [https://www.wesnoth.org/macro-reference.xhtml macros]. Macros are used to reduce the repetition of information just like pronouns do with names and identifiers in the English language. Don't worry about macros now, we will talk about them later.
 ====Preprocessor Directives====
@@ Line 133: / Line 135: @@
 ====Directory Inclusion====
 (The final _main.cfg should end up looking something like this:)

@@ Line 178: / Line 178: @@
 Previous Chapter:
 [[WML for Complete Beginners: Chapter 2]]
 [[Category:WML_for_Complete_Beginners]]

@@ Line 7: / Line 7: @@
 So let's get started creating a "_main.cfg" file so that the game can find your campaign.
-Navigate to your campaign folder, if you aren't already there. Now create a new text file and name it "_main.cfg" (just like that, including the underscore but without the quotes). Now you have created a file called "_main.cfg", but we're not done yet. Right now the file is empty, so the game still won't be able to locate your campaign yet. But fear not, all you have to do is write some specific WML inside the "_main.cfg" file and the game will be able to find your campaign just fine.
+Navigate to your campaign folder, if you aren't already there. Now create a new text file and name it "_main.cfg" (just like that, including the underscore but without the quotes). Make sure you select a save-type of 'all files' and not 'text document (.txt)' for this file.  If you selected 'text document (.txt)' you will actually save a file named "_main.cfg.txt" which will not be recognized by Wesnoth.  Now you have created a file called "_main.cfg", but we're not done yet. Right now the file is empty, so the game still won't be able to locate your campaign yet. But fear not, all you have to do is write some specific WML inside the "_main.cfg" file and the game will be able to find your campaign just fine.
 ===The Text Domain===

← Older revision		Revision as of 15:41, 17 March 2015
Line 172:		Line 172:

	(note: no units yet, save that for the adding custom units section)		(note: no units yet, save that for the adding custom units section)
		+
		+	[[WML for Complete Beginners: Chapter 4]]

	[[Category:WML_for_Complete_Beginners]]		[[Category:WML_for_Complete_Beginners]]