BuildingCampaignsTheCampaignFile - Revision history

Octalot: /* The Final Result */ Update for CAMPAIGN_DIFFICULTY macro

2018-12-25T20:00:20Z

The Final Result: Update for CAMPAIGN_DIFFICULTY macro

← Older revision		Revision as of 20:00, 25 December 2018
Line 124:		Line 124:
	description= _ "Some text about my campaign!"		description= _ "Some text about my campaign!"

	~~difficulties=~~EASY~~,NORMAL,HARD~~		{CAMPAIGN_DIFFICULTY EASY "units/human-peasants/peasant.png~RC(magenta>red)" ( _ "Civilian") ( _ "Beginner")}
	~~difficulty_descriptions={MENU_IMG_TXT2 *&~~units/human-~~loyalists~~/peasant.png~TC(1,magenta) _"Civilian" _"~~(trivial~~)"} +		{CAMPAIGN_DIFFICULTY NORMAL "units/human-loyalists/spearman.png~RC(magenta>red)" ( _ "Soldier") ( _ "Normal")} {DEFAULT_DIFFICULTY}
	"~~;" + {MENU_IMG_TXT2~~ units/human-loyalists/spearman.png~TC(1,magenta) _"Soldier" _"~~(simple~~)"} +		{CAMPAIGN_DIFFICULTY HARD "units/human-loyalists/pikeman.png~RC(magenta>red)" ( _ "Veteran") ( _ "Challenging")}
	"~~;" + {MENU_IMG_TXT2~~ units/human-loyalists/pikeman.png~TC(1,magenta) _"Veteran" _"~~(easy~~)"}

	first_scenario=the_first_scenario		first_scenario=the_first_scenario

Octalot: /* Step 6: The Campaign Difficulties */ Use the new (since 1.13.2) CAMPAIGN_DIFFICULTY macro

2018-12-25T19:52:44Z

Step 6: The Campaign Difficulties: Use the new (since 1.13.2) CAMPAIGN_DIFFICULTY macro

← Older revision		Revision as of 19:52, 25 December 2018
Line 51:		Line 51:
	==Step 6: The Campaign Difficulties==		==Step 6: The Campaign Difficulties==

	''~~difficulties~~'' ~~creates three definitions for three different~~ difficulty ~~levels~~. For more information on difficulty levels and balancing see [[http://catb.org/~esr/wesnoth/campaign-design-howto.html Campaign Design HOWTO]].		Use the ''CAMPAIGN_DIFFICULTY'' and ''DEFAULT_DIFFICULTY'' macros to let the player choose the difficulty. It's usual to have 3 difficulties, and in the WML to refer to them as EASY, NORMAL and HARD. For more information on difficulty levels and balancing see [[http://catb.org/~esr/wesnoth/campaign-design-howto.html Campaign Design HOWTO]].

	~~difficulties=~~EASY~~,NORMAL,HARD~~		{CAMPAIGN_DIFFICULTY EASY "units/human-peasants/peasant.png~RC(magenta>red)" ( _ "Civilian") ( _ "Beginner")}
	~~difficulty_descriptions={MENU_IMG_TXT2 *&~~units/human-~~loyalists~~/peasant.png~TC(1,magenta) _"Civilian" _"~~(trivial~~)"} +		{CAMPAIGN_DIFFICULTY NORMAL "units/human-loyalists/spearman.png~RC(magenta>red)" ( _ "Soldier") ( _ "Normal")} {DEFAULT_DIFFICULTY}
	";" ~~+ {MENU_IMG_TXT2~~ units/human-loyalists/spearman.png~TC(1,magenta) _"Soldier" _"~~(simple~~)"} +		{CAMPAIGN_DIFFICULTY HARD "units/human-loyalists/pikeman.png~RC(magenta>red)" ( _ "Veteran") ( _ "Challenging")}
	"~~;" + {MENU_IMG_TXT2~~ units/human-loyalists/pikeman.png~TC(1,magenta) _"Veteran" _"~~(easy~~)"}

	==Step 7: The Campaign's First Scenario==		==Step 7: The Campaign's First Scenario==

Octalot: /* Next: */ Fix a link that had incorrect capitalization

2018-05-27T12:04:45Z

Next:: Fix a link that had incorrect capitalization

← Older revision		Revision as of 12:04, 27 May 2018
Line 149:		Line 149:

	== Next: ==		== Next: ==
	* [[~~PBLWML~~]]		* [[PblWML]]

	== See Also ==		== See Also ==

Vultraz: /* Next: */

2014-03-13T14:46:49Z

← Older revision		Revision as of 14:46, 13 March 2014
Line 149:		Line 149:

	== Next: ==		== Next: ==
	* [[~~BuildingCampaignsThePBLFile~~]]		* [[PBLWML]]

	== See Also ==		== See Also ==

Vultraz at 08:59, 6 March 2014

2014-03-06T08:59:09Z

← Older revision		Revision as of 08:59, 6 March 2014
Line 3:		Line 3:
	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 more technical information about this file can be found in the [[CampaignWML]] entry. What follows is a beginner-oriented description of each line of the campaign file and an explanation of what it does.		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 more technical information about this file can be found in the [[CampaignWML]] entry. What follows is a beginner-oriented 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~~]].		For our purposes I'll assume we've already created a campaign called simple_campaign with the directory structure outlined in [[AddonStructure]].

	==Step 1: The Text Domain==		==Step 1: The Text Domain==

Vultraz: /* See Also */

2014-03-06T08:57:42Z

Vultraz: /* See Also */

2014-03-06T08:55:03Z

Espreon: /* Step 4: The Campaign id, name, abbrev and define Keys */

2012-06-25T13:36:07Z

Step 4: The Campaign id, name, abbrev and define Keys

← Older revision		Revision as of 13:36, 25 June 2012
Line 37:		Line 37:
	define=CAMPAIGN_SIMPLE_CAMPAIGN		define=CAMPAIGN_SIMPLE_CAMPAIGN

	''id'' is the unique indentifier of the campaign. ''name'' is the name of your campaign that the user will see. The value of ''name'' must be in quotation marks and be preceded by an underscore to facilitate translation into other languages. ''abbrev'' defines a campaign abbreviation that will be used as a prefix for the names of save files from that campaign; it should also be in quotation marks and preceded by an underscore. ''define'' creates a key that lets the game know when a user has selected to play a scenario from your campaign. We'll discuss the ''define'' key in more detail in a bit. Note that if you are missing the ''name'' or ''define'' keys, your campaign will not work correctly. ''abbrev'' is optional but recommended.		''id'' is the unique indentifier of the campaign. ''name'' is the name of your campaign that the user will see. The value of ''name'' must be in quotation marks and be preceded by an underscore to facilitate translation into other languages. ''abbrev'' defines a campaign abbreviation that will be used as a prefix for the names of save files from that campaign; its value should also be in quotation marks and preceded by an underscore. ''define'' creates a key that lets the game know when a user has selected to play a scenario from your campaign. We'll discuss the ''define'' key in more detail in a bit. Note that if you are missing the ''name'' or ''define'' keys, your campaign will not work correctly. ''abbrev'' is optional but recommended.

	==Step 5: The Campaign Icon, Image, and Description==		==Step 5: The Campaign Icon, Image, and Description==

Espreon: Clarifications about textdomain names; abbrev= should be marked as translatable

2012-06-25T13:32:07Z

Clarifications about textdomain names; abbrev= should be marked as translatable

← Older revision		Revision as of 13:32, 25 June 2012
Line 7:		Line 7:
	==Step 1: The Text Domain==		==Step 1: The Text Domain==

	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 is used in 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 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 is used in campaign scenarios to connect the strings with translations. The textdomain should be the campaign's directory's name prefixed with "wesnoth-", to ensure that it does not conflict with other textdomains that might be specified on a given system and is compatible with [[WesCamp]].

	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.		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.
Line 14:		Line 14:
	[textdomain]		[textdomain]
	name="wesnoth-Simple_Campaign"		name="wesnoth-Simple_Campaign"
	path="data/add-ons/~~simple_campaign~~/translations"		path="data/add-ons/Simple_Campaign/translations"
	[/textdomain]		[/textdomain]

Line 34:		Line 34:
	id=CAMPAIGN_ID		id=CAMPAIGN_ID
	name= _ "A Simple Campaign"		name= _ "A Simple Campaign"
	abbrev=ASC		abbrev= _ "ASC"
	define=CAMPAIGN_SIMPLE_CAMPAIGN		define=CAMPAIGN_SIMPLE_CAMPAIGN

	''id'' is the unique indentifier of the campaign. ''name'' is the name of your campaign that the user will see. The value of ''name'' must be in quotation marks and be preceded by an underscore to facilitate translation into other languages. ''abbrev'' defines a campaign abbreviation that will be used as a prefix for the names of save files from that campaign. ''define'' creates a key that lets the game know when a user has selected to play a scenario from your campaign. We'll discuss the ''define'' key in more detail in a bit. Note that if you are missing the ''name'' or ''define'' keys, your campaign will not work correctly. ''abbrev'' is optional but recommended.		''id'' is the unique indentifier of the campaign. ''name'' is the name of your campaign that the user will see. The value of ''name'' must be in quotation marks and be preceded by an underscore to facilitate translation into other languages. ''abbrev'' defines a campaign abbreviation that will be used as a prefix for the names of save files from that campaign; it should also be in quotation marks and preceded by an underscore. ''define'' creates a key that lets the game know when a user has selected to play a scenario from your campaign. We'll discuss the ''define'' key in more detail in a bit. Note that if you are missing the ''name'' or ''define'' keys, your campaign will not work correctly. ''abbrev'' is optional but recommended.

	==Step 5: The Campaign Icon, Image, and Description==		==Step 5: The Campaign Icon, Image, and Description==
Line 87:		Line 87:
	#ifdef CAMPAIGN_SIMPLE_CAMPAIGN		#ifdef CAMPAIGN_SIMPLE_CAMPAIGN

	{~add-ons/~~simple_campaign~~/scenarios}		{~add-ons/Simple_Campaign/scenarios}
	{~add-ons/~~simple_campaign~~/maps}		{~add-ons/Simple_Campaign/maps}

	#endif		#endif
Line 98:		Line 98:

	[+units]		[+units]
	{~add-ons/~~simple_campaign~~/units}		{~add-ons/Simple_Campaign/units}
	[/units]		[/units]

Line 110:		Line 110:
	[textdomain]		[textdomain]
	name="wesnoth-Simple_Campaign"		name="wesnoth-Simple_Campaign"
	path="data/add-ons/~~simple_campaign~~/translations"		path="data/add-ons/Simple_Campaign/translations"
	[/textdomain]		[/textdomain]

Line 118:		Line 118:
	id=CAMPAIGN_ID		id=CAMPAIGN_ID
	name= _ "A Simple Campaign"		name= _ "A Simple Campaign"
	abbrev=ASC		abbrev= _ "ASC"
	define=CAMPAIGN_SIMPLE_CAMPAIGN		define=CAMPAIGN_SIMPLE_CAMPAIGN

Line 136:		Line 136:
	#ifdef CAMPAIGN_SIMPLE_CAMPAIGN		#ifdef CAMPAIGN_SIMPLE_CAMPAIGN

	{~add-ons/~~simple_campaign~~/scenarios}		{~add-ons/Simple_Campaign/scenarios}
	{~add-ons/~~simple_campaign~~/maps}		{~add-ons/Simple_Campaign/maps}

	[+units]		[+units]
	{~add-ons/~~simple_campaign~~/units}		{~add-ons/Simple_Campaign/units}
	[/units]		[/units]

Artisticdude: Formatting, rewording, clarifications

2012-02-01T19:56:10Z

Formatting, rewording, clarifications

← Older revision		Revision as of 19:56, 1 February 2012
Line 1:		Line 1:
	Inside the campaign folder, each campaign must contain a WML file (usually named _main.cfg) 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.		Inside the campaign folder, each campaign must contain a WML file (usually named _main.cfg) 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.		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 more technical information about this file can be found in the [[CampaignWML]] entry. What follows is a beginner-oriented 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]].		For our purposes I'll assume we've already created a campaign called simple_campaign with the directory structure outlined in [[BuildingCampaignsDirectoryStructure]].
Line 7:		Line 7:
	==Step 1: The Text Domain==		==Step 1: The Text Domain==

	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 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 is used in 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.		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.

Line 36:		Line 37:
	define=CAMPAIGN_SIMPLE_CAMPAIGN		define=CAMPAIGN_SIMPLE_CAMPAIGN

	''id'' is the unique indentifier of the campaign.		''id'' is the unique indentifier of the campaign. ''name'' is the name of your campaign that the user will see. The value of ''name'' must be in quotation marks and be preceded by an underscore to facilitate translation into other languages. ''abbrev'' defines a campaign abbreviation that will be used as a prefix for the names of save files from that campaign. ''define'' creates a key that lets the game know when a user has selected to play a scenario from your campaign. We'll discuss the ''define'' key in more detail in a bit. Note that if you are missing the ''name'' or ''define'' keys, your campaign will not work correctly. ''abbrev'' is optional but recommended.
	''name'' is the name of your campaign that the user will see. The value of ''name'' must be in quotation marks and be preceded by an underscore to facilitate translation into other languages.
	''abbrev'' defines a campaign abbreviation that will be used as a prefix for the names of save files from that campaign. ''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 the ''name'' or ''define'' keys ~~of these~~ your campaign will not work correctly; ''abbrev'' is optional but recommended.

	==Step 5: The Campaign Icon, Image, and Description==		==Step 5: The Campaign Icon, Image, and Description==
Line 48:		Line 47:
	description= _ "Some text about my campaign!"		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.		''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.

	==Step 6: The Campaign Difficulties==		==Step 6: The Campaign Difficulties==
Line 145:		Line 144:

	#endif		#endif


			For more information, see the [[CampaignWML]] page.

	== Next: ==		== Next: ==

← Older revision		Revision as of 08:57, 6 March 2014
Line 153:		Line 153:
	== See Also ==		== See Also ==

			* [[AddonStructure]]
	* [[BuildingCampaigns]]		* [[BuildingCampaigns]]

	[[Category:Create]]		[[Category:Create]]

← Older revision		Revision as of 08:55, 6 March 2014
Line 153:		Line 153:
	== See Also ==		== See Also ==

	* [[BuildingCampaignsDirectoryStructure]]
	* [[BuildingCampaigns]]		* [[BuildingCampaigns]]

	[[Category:Create]]		[[Category:Create]]