The Battle for Wesnoth Wiki - User contributions [en]

Talk:ReferenceWMLDump

2007-07-16T11:51:48Z

Meriton: Request for clarification: Substitution mode of [set_variable]value= in stable branch

Kernigh wrote:
: Since Wesnoth 1.1.5, all simple substitution was eliminated in favor of complex substitution, which is more versatile.

There is no source for this claim, and my tests contradict it: In wesnoth 1.2.5, the WML snippet
{VARIABLE foo_bar 42}
{VARIABLE b bar}
[gold]
side=1
amount=$foo_$b
[/gold]
does nothing, but
{VARIABLE foo_bar 42}
{VARIABLE b bar}
{VARIABLE_OP temp format $foo_$b}
[gold]
side=1
amount=$temp
[/gold]
adds 42 gold to side 1. I have therefore reverted the edit. Please only change the content of this page if you are sure you are right.

[[User:Meriton|Meriton]] 15:25, 15 July 2007 (CEST)

: In the source file wesnoth-1.2.5/changelog, under the section for "Wesnoth 1.1.5", it states, "all [event] tags shall perform complex substitution".

: Further, the following example passes wesnoth 1.2.5, and at least demonstrates that the [allow_recruit]type= key permits complex substitution:

# works in 1.2.5
[event]
name=start
{VARIABLE title "Sharpshooter"}
{VARIABLE name title}
[allow_recruit]
type="Elvish $$name||"
side=1
[/allow_recruit]
[/event]

: When I made a copy of 2p - Blitz with this event, side 1 was able to recruit Elvish Sharpshooters.

: To show why your test failed, I suggest that "$foo_$b" is not a valid complex suggestion. (I do not know why "$foo_$b" does not work; maybe there is a bug in 1.2.5, or I misunderstand how complex substitution works.)

:: But if this is not a valid expression, how can it be correctly interpreted by [set_variable]format=, which after all does complex substitution, too? [[User:Meriton|Meriton]] 22:17, 15 July 2007 (CEST)

: The wiki page claims that [message]message= allows complex substitution, so I extended your example to be:

{VARIABLE foo_bar 42}
{VARIABLE b bar}
[gold]
side=2
amount=$foo_$b
# broken in 1.2.5
[/gold]

[message]
speaker=narrator
message=$foo_$b
# broken in 1.2.5
[/message]

: When I tested this, side 2 failed to gain 42 gold, and the message box can up with an empty message! --[[User:Kernigh|Kernigh]] 16:35, 15 July 2007 (CEST)

There is a bug with complex substitution in the stable branch; it the value starts with '$' as the very first character then it will (sometimes) switch back to simple substitution. This bug was fixed by eliminating simple substitution in the development branch. As a workaround, you can put a space as the first charatcer in the message, like this: message=" $foo_$b". --[http://www.wesnoth.org/mw/index.php?title=Talk:VariablesWML&diff=16471&oldid=16468 ''unsigned talk from Sapient'']

: I have to admit that my previous claim (" Since Wesnoth 1.1.5, all simple substitution was eliminated in favor of complex substitution, which is more versatile.") was incorrect, because of the above description of how Wesnoth sometimes does "switch back to simple substitution". --[[User:Kernigh|Kernigh]] 22:00, 15 July 2007 (CEST)

Let me see if I got this right: In theory, all attributes that perform any substitution perform complex substitution, but due to a bug, complex substitution sometimes does simple substitution instead. We therefore tell users that only simple substitution is performed in the stable branch, because that is the only thing that is guaranteed to work. [[User:Meriton|Meriton]] 22:17, 15 July 2007 (CEST)

Incorrect. I suggest you disregard Kernigh's statement, because it is misleading and false. There is still *lots* of simple substitution in the stable branch. (Including the bug with complex substitution sometimes reverting to simple substitution when the first character is '$'). If you are doing anything complex with WML you should be using the development branch because many improvements have been made. --Sapient

Ok, thanks for the clarification. --Meriton

=== Substitution mode of [set_variable]value= in stable branch ===

In the forums, governor claimed
: {VARIABLE var1 $var2.xxxx} is valid.
which desugars to
[set_variable]
name=var1
value=$var2.xxxx
[/set_variable]
I tested this in 1.2.5 with the code
{VARIABLE foo bar}
{VARIABLE test $foo}
Inspection of the save file revealed that "test" had been set to "bar".

What is the substitution mode for [set_variable]value= in the current stable branch?

Talk:ReferenceWMLDump

2007-07-16T11:41:17Z

Meriton:

Talk:ReferenceWMLDump

2007-07-15T20:17:43Z

Meriton: a comment and a question

Talk:SyntaxWML

2007-07-15T13:49:04Z

Meriton: success story for workaround with empty variable

== Empty Values ==

The workaround I posted was helpful to check whether a variable is initialized:

[variable]
name=to_be_tested
equals=$empty
[/variable]

(tested with wesnoth 1.2.5)

Interesting it doesn't work with [set_variable]format=.

[[User:Meriton|Meriton]] 15:49, 15 July 2007 (CEST)

Talk:ReferenceWMLDump

2007-07-15T13:25:21Z

Meriton: no, wesnoth 1.2.5 does not have complex substitution everywhere ...

Talk:ReferenceWMLDump

2007-07-14T16:08:12Z

Meriton: removed outdated discussion

SyntaxWML

2007-07-05T22:23:14Z

Meriton: /* Empty Values */

{{WML Tags}}
Wesnoth syntax has two basic elements: ''tags'' and ''attributes''.
Further, ''attributes'' consist of ''keys'' and ''values''.
Tag names and keys cannot contain whitespace.
Any line beginning with a pound ('''#''') sign is considered by
WML as a comment, except for preprocessor declarations beginning
with #.
* '''[tag-name] ''data'' [/tag-name]''' is a tag. Tags are used to partition information. A ''top level'' tag is one that is not inside any other tag. Each top level tag describes something about the game. Different tags work differently. For information about how a certain tag works, see [[ReferenceWML]].
* '''[+tag-name] ''data'' [/tag-name]''' means that ''data'' will be considered as part of the data for the most recent [''tag-name''] tag. The ''data'' of '''[+tag-name]''' will be considered as coming after all data in '''[tag-name]''', so attributes of '''[+tag-name]''' will replace attributes of the original '''[tag-name]'''.
* '''''key=value newline''''' is an ''attribute'', or an assignment of a value to a key. When this line is processed, the value of ''key'' for the tag that the attribute is in is set or changed to ''value''. All text from '=' until the end of the line is considered to be part of ''value''. Note that ''key'' is not a WML variable (with the exception of [[VariablesWML]]); the value it is set to has a use which is determined by C++ code, not WML code. In order to change the value of a WML variable, you need to use '''[set_variable]''' (see [[InternalActionsWML]]). '''There should be no space between the key and the '=' symbol!''' If there is whitespace, the attribute assignment is ignored. Note that ''key'' should contain only alphanumerics or underscores (''a-zA-Z0-9_''); no ''+'' or ''-'' characters are allowed.
* '''''key1,key2,key3=value1,value2,value3 newline''''' is a multiple assignment. If there are extra keys, they will be set to an empty value. If there are extra values the last key will be set to the comma separated list of all remaining values. It is the same as
key1=value1
key2=value2
key3=value3

Although a value can be just text corresponding to a function of
its key (these values are displayed in quotes (') in
[[ReferenceWML]]), a value can also be encoded:
* '''"''multiple-line-value''"''' a multiple-line value must be enclosed in quotes, to prevent it being interpreted as a single-line value. Note that ''multiple-line-value'' doesn't have to have multiple lines; it can simply be a single-line value enclosed in quotes for clarity.
* '''''_ "text"''''' is a ''translatable'' value. ''text'' is English (US) text that will be displayed in-game at some point. Gettext (see [[GetText]]) is used to determine what to display if English (US) is not the current language.
* '''''value-1 + value-2''''' can be used to concatenate two different strings. If you want to have a value that actually has a plus sign ('''+''') in it, you need to enclose the string containing the '''+''' character in quotes (see '''''"multiple-line-value"''''' above).
* '''''$variable-name''''' a ''variable'' value depends on the value of the WML variable ''variable-name''. See [[VariablesWML]] for more information on WML-variable based values.

=== Empty Values ===
Usually, wesnoth does not distinguish between a key that has not been provided, and a key that has been assigned an empty value. To provide a key with an empty value, you can write
key=$empty
where 'empty' is a WML variable that has not been assigned yet. (This is not technically an empty value, and hence wesnoth will notice that this key has been provided, but will become empty during variable substitution.)

=== Example ===
[scenario]
id=Elves Besieged
[side]
side,gold=1,100
[/side]
[+side]
recruit=Elvish Fighter,Elvish Archer
[/side]
[/scenario]
In this example, [scenario] is a top level tag. When these
lines are read, WML will know that there is a scenario with
the ID "Elves Besieged". Later, when WML is told to play
that scenario, it will read the [side] tag and give 100 gold
to side 1. Then it will read the [+side] tag.
It interprets this tag as belonging to side 1, since the
most recent [side] belonged to side 1. So the [+side] tag
allows side 1 to recruit Elvish Fighters and Elvish Archers.
(Then it will crash, as the leader of side 1 has no unit type.
But this isn't really important.)

Notes: Normally the order and indentation of attributes and tags
does not matter, as long as the levels within tags are not changed.
So the above example could have been written:
[scenario]
[side]
gold=100
side=1
[/side]
id=Elves Besieged
[/scenario]
Data inside tags should be separated with tabbing; see [[ConventionsWML]].

== See Also ==

* [[PreprocessorRef]]
* [[ReferenceWML]]

[[Category: WML Reference]]

SyntaxWML

2007-07-05T22:07:12Z

Meriton: /* Empty Values */

{{WML Tags}}
Wesnoth syntax has two basic elements: ''tags'' and ''attributes''.
Further, ''attributes'' consist of ''keys'' and ''values''.
Tag names and keys cannot contain whitespace.
Any line beginning with a pound ('''#''') sign is considered by
WML as a comment, except for preprocessor declarations beginning
with #.
* '''[tag-name] ''data'' [/tag-name]''' is a tag. Tags are used to partition information. A ''top level'' tag is one that is not inside any other tag. Each top level tag describes something about the game. Different tags work differently. For information about how a certain tag works, see [[ReferenceWML]].
* '''[+tag-name] ''data'' [/tag-name]''' means that ''data'' will be considered as part of the data for the most recent [''tag-name''] tag. The ''data'' of '''[+tag-name]''' will be considered as coming after all data in '''[tag-name]''', so attributes of '''[+tag-name]''' will replace attributes of the original '''[tag-name]'''.
* '''''key=value newline''''' is an ''attribute'', or an assignment of a value to a key. When this line is processed, the value of ''key'' for the tag that the attribute is in is set or changed to ''value''. All text from '=' until the end of the line is considered to be part of ''value''. Note that ''key'' is not a WML variable (with the exception of [[VariablesWML]]); the value it is set to has a use which is determined by C++ code, not WML code. In order to change the value of a WML variable, you need to use '''[set_variable]''' (see [[InternalActionsWML]]). '''There should be no space between the key and the '=' symbol!''' If there is whitespace, the attribute assignment is ignored. Note that ''key'' should contain only alphanumerics or underscores (''a-zA-Z0-9_''); no ''+'' or ''-'' characters are allowed.
* '''''key1,key2,key3=value1,value2,value3 newline''''' is a multiple assignment. If there are extra keys, they will be set to an empty value. If there are extra values the last key will be set to the comma separated list of all remaining values. It is the same as
key1=value1
key2=value2
key3=value3

Although a value can be just text corresponding to a function of
its key (these values are displayed in quotes (') in
[[ReferenceWML]]), a value can also be encoded:
* '''"''multiple-line-value''"''' a multiple-line value must be enclosed in quotes, to prevent it being interpreted as a single-line value. Note that ''multiple-line-value'' doesn't have to have multiple lines; it can simply be a single-line value enclosed in quotes for clarity.
* '''''_ "text"''''' is a ''translatable'' value. ''text'' is English (US) text that will be displayed in-game at some point. Gettext (see [[GetText]]) is used to determine what to display if English (US) is not the current language.
* '''''value-1 + value-2''''' can be used to concatenate two different strings. If you want to have a value that actually has a plus sign ('''+''') in it, you need to enclose the string containing the '''+''' character in quotes (see '''''"multiple-line-value"''''' above).
* '''''$variable-name''''' a ''variable'' value depends on the value of the WML variable ''variable-name''. See [[VariablesWML]] for more information on WML-variable based values.

=== Empty Values ===
Usually, wesnoth does not distinguish between a key that has not been provided, and a key that has been assigned an empty value. To provide a key with an empty value, you can write
key=$empty
where 'empty' is a WML variable that has not been assigned yet. (This is not technically an empty value, and hence wesnoth will notice that this key has been provided, but becomes empty during variable substitution.)

=== Example ===
[scenario]
id=Elves Besieged
[side]
side,gold=1,100
[/side]
[+side]
recruit=Elvish Fighter,Elvish Archer
[/side]
[/scenario]
In this example, [scenario] is a top level tag. When these
lines are read, WML will know that there is a scenario with
the ID "Elves Besieged". Later, when WML is told to play
that scenario, it will read the [side] tag and give 100 gold
to side 1. Then it will read the [+side] tag.
It interprets this tag as belonging to side 1, since the
most recent [side] belonged to side 1. So the [+side] tag
allows side 1 to recruit Elvish Fighters and Elvish Archers.
(Then it will crash, as the leader of side 1 has no unit type.
But this isn't really important.)

Notes: Normally the order and indentation of attributes and tags
does not matter, as long as the levels within tags are not changed.
So the above example could have been written:
[scenario]
[side]
gold=100
side=1
[/side]
id=Elves Besieged
[/scenario]
Data inside tags should be separated with tabbing; see [[ConventionsWML]].

== See Also ==

* [[PreprocessorRef]]
* [[ReferenceWML]]

[[Category: WML Reference]]

SyntaxWML

2007-07-05T22:06:02Z

Meriton: clarified previous edit

{{WML Tags}}
Wesnoth syntax has two basic elements: ''tags'' and ''attributes''.
Further, ''attributes'' consist of ''keys'' and ''values''.
Tag names and keys cannot contain whitespace.
Any line beginning with a pound ('''#''') sign is considered by
WML as a comment, except for preprocessor declarations beginning
with #.
* '''[tag-name] ''data'' [/tag-name]''' is a tag. Tags are used to partition information. A ''top level'' tag is one that is not inside any other tag. Each top level tag describes something about the game. Different tags work differently. For information about how a certain tag works, see [[ReferenceWML]].
* '''[+tag-name] ''data'' [/tag-name]''' means that ''data'' will be considered as part of the data for the most recent [''tag-name''] tag. The ''data'' of '''[+tag-name]''' will be considered as coming after all data in '''[tag-name]''', so attributes of '''[+tag-name]''' will replace attributes of the original '''[tag-name]'''.
* '''''key=value newline''''' is an ''attribute'', or an assignment of a value to a key. When this line is processed, the value of ''key'' for the tag that the attribute is in is set or changed to ''value''. All text from '=' until the end of the line is considered to be part of ''value''. Note that ''key'' is not a WML variable (with the exception of [[VariablesWML]]); the value it is set to has a use which is determined by C++ code, not WML code. In order to change the value of a WML variable, you need to use '''[set_variable]''' (see [[InternalActionsWML]]). '''There should be no space between the key and the '=' symbol!''' If there is whitespace, the attribute assignment is ignored. Note that ''key'' should contain only alphanumerics or underscores (''a-zA-Z0-9_''); no ''+'' or ''-'' characters are allowed.
* '''''key1,key2,key3=value1,value2,value3 newline''''' is a multiple assignment. If there are extra keys, they will be set to an empty value. If there are extra values the last key will be set to the comma separated list of all remaining values. It is the same as
key1=value1
key2=value2
key3=value3

Although a value can be just text corresponding to a function of
its key (these values are displayed in quotes (') in
[[ReferenceWML]]), a value can also be encoded:
* '''"''multiple-line-value''"''' a multiple-line value must be enclosed in quotes, to prevent it being interpreted as a single-line value. Note that ''multiple-line-value'' doesn't have to have multiple lines; it can simply be a single-line value enclosed in quotes for clarity.
* '''''_ "text"''''' is a ''translatable'' value. ''text'' is English (US) text that will be displayed in-game at some point. Gettext (see [[GetText]]) is used to determine what to display if English (US) is not the current language.
* '''''value-1 + value-2''''' can be used to concatenate two different strings. If you want to have a value that actually has a plus sign ('''+''') in it, you need to enclose the string containing the '''+''' character in quotes (see '''''"multiple-line-value"''''' above).
* '''''$variable-name''''' a ''variable'' value depends on the value of the WML variable ''variable-name''. See [[VariablesWML]] for more information on WML-variable based values.

=== Empty Values ===
Usually, wesnoth does not distinguish between a key that has not been assigned, and a key that has been assigned an empty value. To assign an empty value, you can write
key=$empty
where 'empty' is a WML variable that has not been assigned yet. (This is not technically an empty value, and hence wesnoth will notice that this key has been provided, but becomes empty during variable substitution.)

=== Example ===
[scenario]
id=Elves Besieged
[side]
side,gold=1,100
[/side]
[+side]
recruit=Elvish Fighter,Elvish Archer
[/side]
[/scenario]
In this example, [scenario] is a top level tag. When these
lines are read, WML will know that there is a scenario with
the ID "Elves Besieged". Later, when WML is told to play
that scenario, it will read the [side] tag and give 100 gold
to side 1. Then it will read the [+side] tag.
It interprets this tag as belonging to side 1, since the
most recent [side] belonged to side 1. So the [+side] tag
allows side 1 to recruit Elvish Fighters and Elvish Archers.
(Then it will crash, as the leader of side 1 has no unit type.
But this isn't really important.)

Notes: Normally the order and indentation of attributes and tags
does not matter, as long as the levels within tags are not changed.
So the above example could have been written:
[scenario]
[side]
gold=100
side=1
[/side]
id=Elves Besieged
[/scenario]
Data inside tags should be separated with tabbing; see [[ConventionsWML]].

== See Also ==

* [[PreprocessorRef]]
* [[ReferenceWML]]

[[Category: WML Reference]]

SyntaxWML

2007-07-05T21:33:45Z

Meriton: Mentioned that assigning the empty string to an attribute is usually ignored.

{{WML Tags}}
Wesnoth syntax has two basic elements: ''tags'' and ''attributes''.
Further, ''attributes'' consist of ''keys'' and ''values''.
Tag names and keys cannot contain whitespace.
Any line beginning with a pound ('''#''') sign is considered by
WML as a comment, except for preprocessor declarations beginning
with #.
* '''[tag-name] ''data'' [/tag-name]''' is a tag. Tags are used to partition information. A ''top level'' tag is one that is not inside any other tag. Each top level tag describes something about the game. Different tags work differently. For information about how a certain tag works, see [[ReferenceWML]].
* '''[+tag-name] ''data'' [/tag-name]''' means that ''data'' will be considered as part of the data for the most recent [''tag-name''] tag. The ''data'' of '''[+tag-name]''' will be considered as coming after all data in '''[tag-name]''', so attributes of '''[+tag-name]''' will replace attributes of the original '''[tag-name]'''.
* '''''key=value newline''''' is an ''attribute'', or an assignment of a value to a key. When this line is processed, the value of ''key'' for the tag that the attribute is in is set or changed to ''value''. All text from '=' until the end of the line is considered to be part of ''value''. Note that ''key'' is not a WML variable (with the exception of [[VariablesWML]]); the value it is set to has a use which is determined by C++ code, not WML code. In order to change the value of a WML variable, you need to use '''[set_variable]''' (see [[InternalActionsWML]]). '''There should be no space between the key and the '=' symbol!''' If there is whitespace, the attribute assignment is ignored. For most keys, the assignment is also ignored if ''value'' is the empty string. Note that ''key'' should contain only alphanumerics or underscores (''a-zA-Z0-9_''); no ''+'' or ''-'' characters are allowed.
* '''''key1,key2,key3=value1,value2,value3 newline''''' is a multiple assignment. If there are extra keys, they will be set to an empty value. If there are extra values the last key will be set to the comma separated list of all remaining values. It is the same as
key1=value1
key2=value2
key3=value3

Although a value can be just text corresponding to a function of
its key (these values are displayed in quotes (') in
[[ReferenceWML]]), a value can also be encoded:
* '''"''multiple-line-value''"''' a multiple-line value must be enclosed in quotes, to prevent it being interpreted as a single-line value. Note that ''multiple-line-value'' doesn't have to have multiple lines; it can simply be a single-line value enclosed in quotes for clarity.
* '''''_ "text"''''' is a ''translatable'' value. ''text'' is English (US) text that will be displayed in-game at some point. Gettext (see [[GetText]]) is used to determine what to display if English (US) is not the current language.
* '''''value-1 + value-2''''' can be used to concatenate two different strings. If you want to have a value that actually has a plus sign ('''+''') in it, you need to enclose the string containing the '''+''' character in quotes (see '''''"multiple-line-value"''''' above).
* '''''$variable-name''''' a ''variable'' value depends on the value of the WML variable ''variable-name''. See [[VariablesWML]] for more information on WML-variable based values.

Example:
[scenario]
id=Elves Besieged
[side]
side,gold=1,100
[/side]
[+side]
recruit=Elvish Fighter,Elvish Archer
[/side]
[/scenario]
In this example, [scenario] is a top level tag. When these
lines are read, WML will know that there is a scenario with
the ID "Elves Besieged". Later, when WML is told to play
that scenario, it will read the [side] tag and give 100 gold
to side 1. Then it will read the [+side] tag.
It interprets this tag as belonging to side 1, since the
most recent [side] belonged to side 1. So the [+side] tag
allows side 1 to recruit Elvish Fighters and Elvish Archers.
(Then it will crash, as the leader of side 1 has no unit type.
But this isn't really important.)

Notes: Normally the order and indentation of attributes and tags
does not matter, as long as the levels within tags are not changed.
So the above example could have been written:
[scenario]
[side]
gold=100
side=1
[/side]
id=Elves Besieged
[/scenario]
Data inside tags should be separated with tabbing; see [[ConventionsWML]].

== See Also ==

* [[PreprocessorRef]]
* [[ReferenceWML]]

[[Category: WML Reference]]

BuildingCampaignsTheCampaignFile

2007-03-10T17:05:09Z

Meriton: that space fooled my wesnoth's preprocessor parser

Each campaign must contain a WML file which contains a [campaign] tag. In order for the campaign to be translatable, it must also contain a [textdomain] tag, which should precede the [campaign] tag.

This file contains the information the game needs to find the rest of the bits of your campaign scattered in other files and put them together to have a playable campaign. Much information about this file can be found in the [[CampaignWML]] entry. What follows is a description of each line of the campaign file and an explanation of what it does.

For our purposes I'll assume we've already created a campaign called simple_campaign with the directory structure outlined in [[BuildingCampaignsDirectoryStructure]].

The first line of the campaign file is the [textdomain] WML tag, which specifies where the game should look for translations to the strings in the campaign. The textdomain tag specifies a name for the textdomain, which is what is used in the [campaign] tag, and in f ex campaign scenarios to connect the strings with translations. The textdomain should be unique, and start with 'wesnoth-', to ensure that it does not conflict with other textdomains that might be specified on a given system.
The textdomain also specifies a path to the directory where the compiled translation files will be stored. This should be a file inside the campaign directory.

Ex.
[textdomain]
name="wesnoth-Simple_Campaign"
path="data/campaigns/simple_campaign/translations"
[/textdomain]

Then follows the [campaign] WML tag that lets the game know this is a campaign:

[campaign]

First associate the campaign with the textdomain you have just defined:
#textdomain wesnoth-Simple_Campaign

The next group of lines uniquely identifies the campaign:

name= _ "A Simple Campaign"
define=CAMPAIGN_SIMPLE_CAMPAIGN

[In earlier version, there was also ''id'' which was a unique identifier used for translation, but now has no effect.]

''name'' is the name of your campaign that the user will see. It must be in quotation marks and be preceded by an underscore to facilitate translation. ''define'' creates a key that lets the game know when a user has selected to play a scenario from your campaign. More on it in a bit. If you are missing any of these your campaign will not work correctly.

The next group gives the user information about your campaign when he selects it from the campaign menu:

icon=a_wesnoth_icon.png
image= simple_campaign_logo.png
description= _ "Some text about my campaign!"

''icon'' is a reference to any of the standard Wesnoth images. It will be displayed in the campaign selection menu. When appropriate, it should use [[ImagePathFunctionWML]] to give the icon a team color instead of magenta. ''image'' is an image that will be displayed when a user clicks on the campaign. ''description'' is a text description that will be shown to the user at the same time as ''image''. Note that none of these three are strictly necessary, but they do make your campaign look nice and professional.

difficulties=EASY,NORMAL,HARD
difficulty_descriptions={MENU_IMG_TXT2 *&units/human-loyalists/peasant.png?TC(1,magenta) _"Civilian" _"(trivial)"} +
";" + {MENU_IMG_TXT2 units/human-loyalists/spearman.png?TC(1,magenta) _"Soldier" _"(simple)"} +
";" + {MENU_IMG_TXT2 units/human-loyalists/pikeman.png?TC(1,magenta) _"Veteran" _"(easy)"}

''difficulties'' creates three definitions for three different difficulty levels. For more information on difficulty levels and balancing see [[BuildingCampaignsBalancing]].

first_scenario=the_first_scenario

''first_scenario'' is a reference to the scenario ''id'' of the scenario that you intend to be loaded and played first.
This line is essential. Note that while　you are debugging and testing your campaign, it's often useful to change this line to the scenario you're working on so　you don't have to play through all
the scenarios that come before it. (You could also just play through your campaign saving at each level.)

[/campaign]

That's all that needs to be in the [campaign] tag, so we can close it here.

There's more we want to do, though: we've　got to tell Wesnoth where our various
additional files are located (i.e. our maps, scenarios, units, images, and sounds).

You should put everything not in the [campaign] tag inside
#ifdef CAMPAIGN_SIMPLE_CAMPAIGN
...
#endif
so that your custom macros, WML code, and inclusion of files do not affect other campaigns and slow the game down. The only exception to this is the [binary_path] tag specifying the path to custom images in your campaign, but you should only put this outside the #ifdef if you need custom images for the campaign selection menu and the difficulty selection menu. Otherwise even this belongs inside the #ifdef.

A fairly minimal #ifdef section might just contain a link to your scenarios.

#ifdef CAMPAIGN_SIMPLE_CAMPAIGN

{@campaigns/simple_campaign/scenarios}

#endif

The {@campaigns/simple_campaign/scenarios} line just looks in your campaign's "scenarios" directory and parses any .cfg files it finds there (see [[BuildingScenarios]] for information on making your scenario files). If you have any other .cfg files (macros, custom terrains, etc.), you can link them in a similar way. If you want to use custom units however, you will have to link them from inside a [+units] tag (using the "+" adds them to wesnoth's stored units - this is important) like so:

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

== Next: ==
* [[BuildingCampaignsThePBLFile]]

[http://www.example.com link title]
----
--[[User:Dfrf|Dfrf]] 17:16, 15 December 2006 (CET)== See Also ==

* [[BuildingCampaignsDirectoryStructure]]
* [[BuildingCampaigns]]
yyy''Italic text'''''Bold text'''[[Link title]]