AddonsWML - Revision history

Celtic Minstrel: /* Common Tags and Keys */ Make documentation comprehensible

2025-02-22T14:12:57Z

Common Tags and Keys: Make documentation comprehensible

← Older revision		Revision as of 14:12, 22 February 2025
Line 49:		Line 49:
	** '''remove_advancement''' : removes a (list of comma separated) unit type(s) from the possible advancements of this unit type.		** '''remove_advancement''' : removes a (list of comma separated) unit type(s) from the possible advancements of this unit type.
	** '''[advancement]''' : {{DevFeature1.19\|5}} If a list of [advancement] is here, replace all [advancement] in unit type(s).		** '''[advancement]''' : {{DevFeature1.19\|5}} If a list of [advancement] is here, replace all [advancement] in unit type(s).
	** '''[male]''' : {{DevFeature1.19\|5}} ~~If exist and unit type use this tag, key~~ and tags ~~previously listed contained in this tag~~ will apply to male unit type(s) only.		** '''[male]''' : {{DevFeature1.19\|5}} Supports all the above keys and tags but will apply to male unit type(s) only.
	** '''[female]''' : {{DevFeature1.19\|5}} Same ~~what~~ [male] but for [female] sub_tags in unit type(s).		** '''[female]''' : {{DevFeature1.19\|5}} Same as [male] but for [female] sub_tags in unit type(s).
	** '''[variation]''' : {{DevFeature1.19\|5}} If '''variation_id''' matches ~~with~~ '''variation_id''' of a [variation] in unit type(s), same ~~what~~ [male] or [female] tags.		** '''[variation]''' : {{DevFeature1.19\|5}} If '''variation_id''' matches the '''variation_id''' of a [variation] in unit type(s), same as [male] or [female] tags.

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

Newfrenchy83: /* Common Tags and Keys */

2024-11-03T17:33:24Z

Common Tags and Keys

← Older revision		Revision as of 17:33, 3 November 2024
Line 48:		Line 48:
	** '''add_advancement''' : adds a (list of comma separated) unit type(s) to the possible advancements of this unit type.		** '''add_advancement''' : adds a (list of comma separated) unit type(s) to the possible advancements of this unit type.
	** '''remove_advancement''' : removes a (list of comma separated) unit type(s) from the possible advancements of this unit type.		** '''remove_advancement''' : removes a (list of comma separated) unit type(s) from the possible advancements of this unit type.
			** '''[advancement]''' : {{DevFeature1.19\|5}} If a list of [advancement] is here, replace all [advancement] in unit type(s).
			** '''[male]''' : {{DevFeature1.19\|5}} If exist and unit type use this tag, key and tags previously listed contained in this tag will apply to male unit type(s) only.
			** '''[female]''' : {{DevFeature1.19\|5}} Same what [male] but for [female] sub_tags in unit type(s).
			** '''[variation]''' : {{DevFeature1.19\|5}} If '''variation_id''' matches with '''variation_id''' of a [variation] in unit type(s), same what [male] or [female] tags.

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

Celtic Minstrel: /* Common Tags and Keys */ Add some anchors that can be linked to

2024-02-27T05:26:44Z

Common Tags and Keys: Add some anchors that can be linked to

← Older revision		Revision as of 05:26, 27 February 2024
Line 35:		Line 35:
	* '''[event]''' - An event handler that will be registered when the addon module is active. See [[EventWML]].		* '''[event]''' - An event handler that will be registered when the addon module is active. See [[EventWML]].
	* '''[lua]''' - Lua code that will be run when the addon module is loaded, before the '''preload''' event is fired. See [[LuaWML]].		* '''[lua]''' - Lua code that will be run when the addon module is loaded, before the '''preload''' event is fired. See [[LuaWML]].
	* '''[ai]''': Defines an AI algorithm that can be selected by players at the join game screen. See [[Wesnoth_AI_Framework#The_.5Bai.5D_Tag_.E2.80.94_Top-level_Elements\|here]] for details. This is not used in single-player.		* {{anchor\|ai\|'''[ai]'''}}: Defines an AI algorithm that can be selected by players at the join game screen. See [[Wesnoth_AI_Framework#The_.5Bai.5D_Tag_.E2.80.94_Top-level_Elements\|here]] for details. This is not used in single-player.
	** Note: This is not the place to define faction-specific AI parameters in an era. For that, place the '''[ai]''' tag in '''[multiplayer_side]'''.		** Note: This is not the place to define faction-specific AI parameters in an era. For that, place the '''[ai]''' tag in '''[multiplayer_side]'''.
	** Note: This tag may not be supported in '''[resource]''', '''[scenario]''', or '''[test]'''.		** Note: This tag may not be supported in '''[resource]''', '''[scenario]''', or '''[test]'''.
	* '''[options]''': Custom options. See [[OptionWML]] for details. Note: This may not be supported in '''[resource]''', '''[scenario]''', or '''[test]'''.		* '''[options]''': Custom options. See [[OptionWML]] for details. Note: This may not be supported in '''[resource]''', '''[scenario]''', or '''[test]'''.
	* '''[load_resource]''': Indicates a resource to load when this addon module is loaded.		* {{anchor\|load_resource\|'''[load_resource]'''}}: Indicates a resource to load when this addon module is loaded.
	** '''id''': The ID of the resource.		** '''id''': The ID of the resource.
	* '''[modify_unit_type]''' {{DevFeature1.15\|2}}: Changes a unit type while this modification is active. The supported attributes are:		* {{anchor\|modify_unit_type\|'''[modify_unit_type]'''}} {{DevFeature1.15\|2}}: Changes a unit type while this modification is active. The supported attributes are:
	** '''type''' : the id of the unit type to change.		** '''type''' : the id of the unit type to change.
	** '''set_experience''' : changes the unit type's max experience.		** '''set_experience''' : changes the unit type's max experience.

Celtic Minstrel: /* Which add-ons are active during gameplay */ More direct links

2024-02-25T00:45:55Z

Which add-ons are active during gameplay: More direct links

← Older revision		Revision as of 00:45, 25 February 2024
Line 16:		Line 16:
	* [[EraWML\|'''[era]''']] - A multiplayer era		* [[EraWML\|'''[era]''']] - A multiplayer era
	* [[CampaignWML\|'''[campaign]''']] - A campaign, either single-player or multiplayer		* [[CampaignWML\|'''[campaign]''']] - A campaign, either single-player or multiplayer
	* [[ScenarioWML\|'''[scenario]''']] - A campaign scenario		* [[ScenarioWML#The .5Bscenario.5D tag\|'''[scenario]''']] - A campaign scenario
	* [[ScenarioWML\|'''[multiplayer]''']] - A multiplayer scenario		* [[ScenarioWML#The .5Bmultiplayer.5D tag\|'''[multiplayer]''']] - A multiplayer scenario
	* [[ScenarioWML\|'''[test]''']] - A test or demo scenario		* [[ScenarioWML#The .5Btest.5D tag\|'''[test]''']] - A test or demo scenario
	* [[ModificationWML\|'''[modification]''']] - A modification that can be selected in the campaign or multiplayer menu		* [[ModificationWML#The .5Bmodification.5D toplevel tag\|'''[modification]''']] - A modification that can be selected in the campaign or multiplayer menu
	* [[ModificationWML\|'''[resource]''']] - A resource that can be requested by any other add-on module		* [[ModificationWML#The .5Bresource.5D toplevel tag\|'''[resource]''']] - A resource that can be requested by any other add-on module

	Notably, that list doesn't contain the [[UnitsWML\|'''[units]''']] tag. For example, a multiplayer scenario which allows the player to choose any era but has scripted events that spawn Ageless Era units needs to activate those units' add-on by loading a resource from it.		Notably, that list doesn't contain the [[UnitsWML\|'''[units]''']] tag. For example, a multiplayer scenario which allows the player to choose any era but has scripted events that spawn Ageless Era units needs to activate those units' add-on by loading a resource from it.

Octalot: /* Which add-ons are active during gameplay */ Note that [units] isn't an add-on module

2024-01-23T13:02:51Z

Which add-ons are active during gameplay: Note that [units] isn't an add-on module

← Older revision		Revision as of 13:02, 23 January 2024
Line 20:		Line 20:
	* [[ScenarioWML\|'''[test]''']] - A test or demo scenario		* [[ScenarioWML\|'''[test]''']] - A test or demo scenario
	* [[ModificationWML\|'''[modification]''']] - A modification that can be selected in the campaign or multiplayer menu		* [[ModificationWML\|'''[modification]''']] - A modification that can be selected in the campaign or multiplayer menu
	* [[ModificationWML\|'''[resource]''']] - A resource that can be requested by any other ~~addon~~ module		* [[ModificationWML\|'''[resource]''']] - A resource that can be requested by any other add-on module

			Notably, that list doesn't contain the [[UnitsWML\|'''[units]''']] tag. For example, a multiplayer scenario which allows the player to choose any era but has scripted events that spawn Ageless Era units needs to activate those units' add-on by loading a resource from it.

	== Common Tags and Keys ==		== Common Tags and Keys ==

Octalot: /* Creating add-ons in WML */ Correct file extension for .pbl files

2024-01-23T12:25:18Z

Creating add-ons in WML: Correct file extension for .pbl files

← Older revision		Revision as of 12:25, 23 January 2024
Line 3:		Line 3:

	An add-on is defined by a directory structure, there is no tag called '''[addon]'''. The directory must contain a '''_main.cfg''', and the name of the directory is treated as its '''id'''. There are different rules for add-ons that define a custom core, which are described in [[CoreWML]] and ignored for the purposes of this page.		An add-on is defined by a directory structure, there is no tag called '''[addon]'''. The directory must contain a '''_main.cfg''', and the name of the directory is treated as its '''id'''. There are different rules for add-ons that define a custom core, which are described in [[CoreWML]] and ignored for the purposes of this page.

			The description of a downloaded add-on is found in '''_info.cfg''', the data for a locally authored add-on is in '''_server.pbl''' (see [[PblWML]]).

	An add-on typically contains other files, see for example [[AddonStructure]] or [[BuildingCampaignsTheCampaignFile]].		An add-on typically contains other files, see for example [[AddonStructure]] or [[BuildingCampaignsTheCampaignFile]].

	~~The description of a downloaded add-on is found in '''_info.cfg''', the data for a locally authored add-on is in '''_server.cfg''' (see [[PblWML]]).~~

	== Which add-ons are active during gameplay ==		== Which add-ons are active during gameplay ==

Octalot: /* Creating add-ons in WML */ Fixed some links

2024-01-23T12:15:33Z

Creating add-ons in WML: Fixed some links

← Older revision		Revision as of 12:15, 23 January 2024
Line 4:		Line 4:
	An add-on is defined by a directory structure, there is no tag called '''[addon]'''. The directory must contain a '''_main.cfg''', and the name of the directory is treated as its '''id'''. There are different rules for add-ons that define a custom core, which are described in [[CoreWML]] and ignored for the purposes of this page.		An add-on is defined by a directory structure, there is no tag called '''[addon]'''. The directory must contain a '''_main.cfg''', and the name of the directory is treated as its '''id'''. There are different rules for add-ons that define a custom core, which are described in [[CoreWML]] and ignored for the purposes of this page.

	An add-on typically contains other files, see for example AddonStructure or BuildingCampaignsTheCampaignFile.		An add-on typically contains other files, see for example [[AddonStructure]] or [[BuildingCampaignsTheCampaignFile]].

	The description of a downloaded add-on is found in '''_info.cfg''', the data for a locally authored add-on is in '''_server.cfg''' (see [[PblWML]]).		The description of a downloaded add-on is found in '''_info.cfg''', the data for a locally authored add-on is in '''_server.cfg''' (see [[PblWML]]).

Octalot: How directory structure fills the role of an [addon] tag

2024-01-23T12:07:41Z

How directory structure fills the role of an [addon] tag

← Older revision		Revision as of 12:07, 23 January 2024
Line 1:		Line 1:
	{{WML Tags}}		{{WML Tags}}
			== Creating add-ons in WML ==

	~~Several toplevel tags are used to define an "addon module", which is a piece of an~~ add-on ~~that the game loads as needed. There are several different types of~~ addon ~~modules, but they all share some common keys~~. If a ~~game does not use any addon module from your addon, then your addon won~~'~~t be parsed at all~~. On the ~~other hand, if~~ the ~~game uses~~ ''~~any~~'' ~~addon module from your addon~~, ~~then your entire addon will be parsed, relying on preprocessor defines to exclude parts that aren't relevant to~~ the ~~addon module that is to be loaded~~.		An add-on is defined by a directory structure, there is no tag called '''[addon]'''. The directory must contain a '''_main.cfg''', and the name of the directory is treated as its '''id'''. There are different rules for add-ons that define a custom core, which are described in [[CoreWML]] and ignored for the purposes of this page.

	~~All~~ of the ~~following~~ toplevel tags define an ~~addon~~ module:		An add-on typically contains other files, see for example AddonStructure or BuildingCampaignsTheCampaignFile.

			The description of a downloaded add-on is found in '''_info.cfg''', the data for a locally authored add-on is in '''_server.cfg''' (see [[PblWML]]).

			== Which add-ons are active during gameplay ==

			To help prevent clashes between add-ons, when starting a scenario the engine only loads the active add-ons. An add-on is active if one or more "add-on modules" is used by the game. If a game does not use any add-on module from your add-on, then your add-on won't be parsed at all. On the other hand, if the game uses any add-on module from your add-on, then your entire add-on will be parsed, relying on preprocessor defines to exclude parts that aren't relevant to the add-on module that is to be loaded.

			Several toplevel tags are used to define an "add-on module":

	* [[EraWML\|'''[era]''']] - A multiplayer era		* [[EraWML\|'''[era]''']] - A multiplayer era

Celtic Minstrel: /* Common Tags and Keys */ typo

2024-01-19T14:52:38Z

Common Tags and Keys: typo

← Older revision		Revision as of 14:52, 19 January 2024
Line 21:		Line 21:
	* '''name''': (translatable) The visible name for the addon module, shown in the campaign selection or multiplayer game creation menu. (Not supported for '''[resource]''' since it is never visible anywhere.)		* '''name''': (translatable) The visible name for the addon module, shown in the campaign selection or multiplayer game creation menu. (Not supported for '''[resource]''' since it is never visible anywhere.)
	* '''description''': (translatable) The detailed description for the addon module, shown in the campaign selection or multiplayer game creation menu. (Also not supported for '''[resource]''', nor for '''[scenario]''' or '''[test]'''.)		* '''description''': (translatable) The detailed description for the addon module, shown in the campaign selection or multiplayer game creation menu. (Also not supported for '''[resource]''', nor for '''[scenario]''' or '''[test]'''.)
	* '''define'''='''''SYMBOL''''' When this addon module is active, the preprocessor symbol '''''SYMBOL''''' will be defined. See [[PreprocessorRef#.23ifdef_and_.23ifndef\|ifdef]] for how this can be used to isolate parts of the file from other addon modules. Besides the addon ~~moduel~~ tag, only the tags '''[textdomain]''' and '''[binary_path]''' (see [[BinaryPathWML]]) should go outside of '''#ifdef ''SYMBOL'''''. This symbol will be defined ''before'' any .cfg is preprocessed. Note: If for some reason you don't want to place your '''[binary_path]''' outside your '''#ifdef ''SYMBOL''''' (perhaps it's causing conflicts with other addon modules), you can use binary-path-independent paths for the textdomain and any assets that are used in the addon module tag. This looks like '''icon=data/add-ons/whatever/something.png''' – essentially, any path beginning with '''data/'''.		* '''define'''='''''SYMBOL''''' When this addon module is active, the preprocessor symbol '''''SYMBOL''''' will be defined. See [[PreprocessorRef#.23ifdef_and_.23ifndef\|ifdef]] for how this can be used to isolate parts of the file from other addon modules. Besides the addon module tag, only the tags '''[textdomain]''' and '''[binary_path]''' (see [[BinaryPathWML]]) should go outside of '''#ifdef ''SYMBOL'''''. This symbol will be defined ''before'' any .cfg is preprocessed. Note: If for some reason you don't want to place your '''[binary_path]''' outside your '''#ifdef ''SYMBOL''''' (perhaps it's causing conflicts with other addon modules), you can use binary-path-independent paths for the textdomain and any assets that are used in the addon module tag. This looks like '''icon=data/add-ons/whatever/something.png''' – essentially, any path beginning with '''data/'''.
	* '''[event]''' - An event handler that will be registered when the addon module is active. See [[EventWML]].		* '''[event]''' - An event handler that will be registered when the addon module is active. See [[EventWML]].
	* '''[lua]''' - Lua code that will be run when the addon module is loaded, before the '''preload''' event is fired. See [[LuaWML]].		* '''[lua]''' - Lua code that will be run when the addon module is loaded, before the '''preload''' event is fired. See [[LuaWML]].

Celtic Minstrel: Fix formatting

2023-03-28T03:25:23Z

Fix formatting

← Older revision		Revision as of 03:25, 28 March 2023
Line 1:		Line 1:
	{{WML Tags}}		{{WML Tags}}

	Several toplevel tags are used to define an "addon module", which is a piece of an add-on that the game loads as needed. There are several different types of addon modules, but they all share some common keys. If a game does not use any addon module from your addon, then your addon won't be parsed at all. On the other hand, if the game uses ~~_any_~~ addon module from your addon, then your entire addon will be parsed, relying on preprocessor defines to exclude parts that aren't relevant to the addon module that is to be loaded.		Several toplevel tags are used to define an "addon module", which is a piece of an add-on that the game loads as needed. There are several different types of addon modules, but they all share some common keys. If a game does not use any addon module from your addon, then your addon won't be parsed at all. On the other hand, if the game uses ''any'' addon module from your addon, then your entire addon will be parsed, relying on preprocessor defines to exclude parts that aren't relevant to the addon module that is to be loaded.

	All of the following toplevel tags define an addon module:		All of the following toplevel tags define an addon module:

← Older revision		Revision as of 00:45, 25 February 2024
Line 16:		Line 16:
	* [[EraWML\|'''[era]''']] - A multiplayer era		* [[EraWML\|'''[era]''']] - A multiplayer era
	* [[CampaignWML\|'''[campaign]''']] - A campaign, either single-player or multiplayer		* [[CampaignWML\|'''[campaign]''']] - A campaign, either single-player or multiplayer
	* [[ScenarioWML\|'''[scenario]''']] - A campaign scenario		* [[ScenarioWML#The .5Bscenario.5D tag\|'''[scenario]''']] - A campaign scenario
	* [[ScenarioWML\|'''[multiplayer]''']] - A multiplayer scenario		* [[ScenarioWML#The .5Bmultiplayer.5D tag\|'''[multiplayer]''']] - A multiplayer scenario
	* [[ScenarioWML\|'''[test]''']] - A test or demo scenario		* [[ScenarioWML#The .5Btest.5D tag\|'''[test]''']] - A test or demo scenario
	* [[ModificationWML\|'''[modification]''']] - A modification that can be selected in the campaign or multiplayer menu		* [[ModificationWML#The .5Bmodification.5D toplevel tag\|'''[modification]''']] - A modification that can be selected in the campaign or multiplayer menu
	* [[ModificationWML\|'''[resource]''']] - A resource that can be requested by any other add-on module		* [[ModificationWML#The .5Bresource.5D toplevel tag\|'''[resource]''']] - A resource that can be requested by any other add-on module

	Notably, that list doesn't contain the [[UnitsWML\|'''[units]''']] tag. For example, a multiplayer scenario which allows the player to choose any era but has scripted events that spawn Ageless Era units needs to activate those units' add-on by loading a resource from it.		Notably, that list doesn't contain the [[UnitsWML\|'''[units]''']] tag. For example, a multiplayer scenario which allows the player to choose any era but has scripted events that spawn Ageless Era units needs to activate those units' add-on by loading a resource from it.

← Older revision		Revision as of 13:02, 23 January 2024
Line 20:		Line 20:
	* [[ScenarioWML\|'''[test]''']] - A test or demo scenario		* [[ScenarioWML\|'''[test]''']] - A test or demo scenario
	* [[ModificationWML\|'''[modification]''']] - A modification that can be selected in the campaign or multiplayer menu		* [[ModificationWML\|'''[modification]''']] - A modification that can be selected in the campaign or multiplayer menu
	* [[ModificationWML\|'''[resource]''']] - A resource that can be requested by any other ~~addon~~ module		* [[ModificationWML\|'''[resource]''']] - A resource that can be requested by any other add-on module

			Notably, that list doesn't contain the [[UnitsWML\|'''[units]''']] tag. For example, a multiplayer scenario which allows the player to choose any era but has scripted events that spawn Ageless Era units needs to activate those units' add-on by loading a resource from it.

	== Common Tags and Keys ==		== Common Tags and Keys ==