CoreWML - Revision history

Soliton: /* Common Pitfalls */

2021-03-04T17:21:38Z

‎Common Pitfalls

Soliton: /* Common Pitfalls */

2020-10-06T15:56:39Z

‎Common Pitfalls

Celtic Minstrel: /* Common Pitfalls */ Mostly reformatting, also remove the reference to _info.cfg

2019-10-25T01:51:17Z

‎Common Pitfalls: Mostly reformatting, also remove the reference to _info.cfg

Celtic Minstrel: /* Common Pitfalls */ "thatfor" is not a word

2019-10-25T01:47:17Z

‎Common Pitfalls: "thatfor" is not a word

Shiki: /* Common Pitfalls */

2019-10-24T19:21:10Z

‎Common Pitfalls

Shiki: Document common problems

2019-10-24T19:17:38Z

Document common problems

Soliton: mention _main.cfg pitfall

2019-10-22T14:07:25Z

mention _main.cfg pitfall

Shiki: markup

2018-12-02T16:46:51Z

markup

Shiki: update from issue #3728

2018-12-02T16:39:51Z

update from issue #3728

James The Invisible: fixed release where cores were introduced

2018-11-11T18:11:28Z

fixed release where cores were introduced

@@ Line 23: / Line 23: @@
 * In case the core contains translations, use the third method to set up the '''[textdomain]''', so that the translation for the core's description and name are available.
 * Only add-ons designed for this core will be available.
-* Add-ons created for a custom core need to specify the '''id''' of that core in the '''core''' key in the _server.pbl, see [[PblWML]]. Because of this, the _server.pbl must be present if your add-on uses a custom core.
+* Add-ons created for a custom core need to specify the '''id''' of that core in the '''core''' key in the _server.pbl, see [[PblWML]]. Because of this, the _server.pbl or _info.cfg (generated by wesnoth on install) must be present if your add-on uses a custom core.
-* A new core will contain absolutely nothing. The engine may crash in a few cases, when it looks for something which isn't there ([https://github.com/wesnoth/wesnoth/issues/3702 known cases]). Best to include similar things like the file data/_main.cfg in the default core does.
+* A new core will contain absolutely nothing. The engine may crash in a few cases, when it looks for something which isn't there ([https://github.com/wesnoth/wesnoth/issues/3702 known cases]). Report any such case so it can be fixed!
 * One can include files from the default core with the [[PreprocessorRef#Inclusion_directive_.7B.7D|preprocessor's inclusion directive]]. E.g. ''{data/multiplayer/scenarios/}'' to include MP scenarios from the default core. No need to copy everything.

@@ Line 23: / Line 23: @@
 * In case the core contains translations, use the third method to set up the '''[textdomain]''', so that the translation for the core's description and name are available.
 * Only add-ons designed for this core will be available.
-* Add-ons created for a custom core need to specify that they are not to be used with the default core but this one. For that, one specifies the '''core''' in the _server.pbl, see [[PblWML]]. Because of this, the _server.pbl must be present if your add-on uses a custom core.
+* Add-ons created for a custom core need to specify the '''id''' of that core in the '''core''' key in the _server.pbl, see [[PblWML]]. Because of this, the _server.pbl must be present if your add-on uses a custom core.
 * A new core will contain absolutely nothing. The engine may crash in a few cases, when it looks for something which isn't there ([https://github.com/wesnoth/wesnoth/issues/3702 known cases]). Best to include similar things like the file data/_main.cfg in the default core does.
 * One can include files from the default core with the [[PreprocessorRef#Inclusion_directive_.7B.7D|preprocessor's inclusion directive]]. E.g. ''{data/multiplayer/scenarios/}'' to include MP scenarios from the default core. No need to copy everything.

@@ Line 17: / Line 17: @@
 == Common Pitfalls ==
-* Similar to [campaign] tags, [core] tags are read before the core is loaded. Thus, [binary_path]s and translations defined in the file (or directory) set by '''path''' are not yet available. You must make sure that the icon '''image''' is available while another core is in use. Either a) use a image from the default core b) write the path to the image, e.g. ''data/add-ons/my_core/images/icon-for-core-selection-menu.png'' or c) set up the binary paths to be even in use while your core is not, by setting them in _main.cfg (untested). I recommend b). In case the core contains translations, use c) to set up the [textdomain], so that the translation for the core's description and name are available.
+* Similar to [campaign] tags, [core] tags are read before the core is loaded. Thus, [binary_path]s and translations defined in the file (or directory) set by '''path''' are not yet available. You must make sure that the icon '''image''' is available while another core is in use (the second method is recommended):
 * Only add-ons designed for this core will be available.
-* Add-ons created for a custom core need to specify that they are not to be used with the default core but this one. For that, one specifies the '''core''' in the _server.pbl, see [[PblWML]].
+* Add-ons created for a custom core need to specify that they are not to be used with the default core but this one. For that, one specifies the '''core''' in the _server.pbl, see [[PblWML]]. Because of this, the _server.pbl must be present if your add-on uses a custom core.
 * A new core will contain absolutely nothing. The engine may crash in a few cases, when it looks for something which isn't there ([https://github.com/wesnoth/wesnoth/issues/3702 known cases]). Best to include similar things like the file data/_main.cfg in the default core does.
 * One can include files from the default core with the [[PreprocessorRef#Inclusion_directive_.7B.7D|preprocessor's inclusion directive]]. E.g. ''{data/multiplayer/scenarios/}'' to include MP scenarios from the default core. No need to copy everything.

@@ Line 19: / Line 19: @@
 * Similar to [campaign] tags, [core] tags are read before the core is loaded. Thus, [binary_path]s and translations defined in the file (or directory) set by '''path''' are not yet available. You must make sure that the icon '''image''' is available while another core is in use. Either a) use a image from the default core b) write the path to the image, e.g. ''data/add-ons/my_core/images/icon-for-core-selection-menu.png'' or c) set up the binary paths to be even in use while your core is not, by setting them in _main.cfg (untested). I recommend b). In case the core contains translations, use c) to set up the [textdomain], so that the translation for the core's description and name are available.
 * Only add-ons designed for this core will be available.
-* Add-ons created for a custom core need to specify that they are not to be used with the default core but this one. Thatfor one specifies the '''core''' in the _server.pbl, see [[PblWML]].
+* Add-ons created for a custom core need to specify that they are not to be used with the default core but this one. For that, one specifies the '''core''' in the _server.pbl, see [[PblWML]].
 * The game engine will read a file called _info.cfg and determine from it for which core an add-on is designed. This file is created automatically when the add-on is downloaded. If you create a new add-on, this file doesn't exist yet. Copy it from another add-on and add the value ''core=my_core'' to it. (This is only for add-ons using a core, not the add-on which contains the core)
 * A new core will contain absolutely nothing. The engine may crash in a few cases, when it looks for something which isn't there ([https://github.com/wesnoth/wesnoth/issues/3702 known cases]). Best to include similar things like the file data/_main.cfg in the default core does.

@@ Line 21: / Line 21: @@
 * Add-ons created for a custom core need to specify that they are not to be used with the default core but this one. Thatfor one specifies the '''core''' in the _server.pbl, see [[PblWML]].
 * The game engine will read a file called _info.cfg and determine from it for which core an add-on is designed. This file is created automatically when the add-on is downloaded. If you create a new add-on, this file doesn't exist yet. Copy it from another add-on and add the value ''core=my_core'' to it. (This is only for add-ons using a core, not the add-on which contains the core)
-* A new core will contain absolutely nothing. The engine may crash in a few cases, when it looks for something which isn't there ([https://github.com/wesnoth/wesnoth/issues/3702 known cases]). Best to include similar things like the file data/_main.cfg in the default core.
+* A new core will contain absolutely nothing. The engine may crash in a few cases, when it looks for something which isn't there ([https://github.com/wesnoth/wesnoth/issues/3702 known cases]). Best to include similar things like the file data/_main.cfg in the default core does.
-* One can include files of the default core with the [[PreprocessorRef#Inclusion_directive_.7B.7D|preprocessor's inclusion directive]]. E.g. ''{data/multiplayer/scenarios/}'' to include MP scenarios from the default core. No need to copy everything.
+* One can include files from the default core with the [[PreprocessorRef#Inclusion_directive_.7B.7D|preprocessor's inclusion directive]]. E.g. ''{data/multiplayer/scenarios/}'' to include MP scenarios from the default core. No need to copy everything.
 == See Also ==

@@ Line 4: / Line 4: @@
 Cores are to be defined in a file called cores.cfg in your add-ons base directory. An add-on containing only a core does not need a _main.cfg, cores are loaded prior to that by looking for cores.cfg. To publish the add-on from within wesnoth a _main.cfg is needed but it can be an empty one. '''_main.cfg should NOT be the same file as what is defined under [core] path or everything will be loaded twice!'''
 ==The [core] Tag==
@@ Line 11: / Line 10: @@
 The following keys and tags are recognized in '''[core]''' tags:
 * '''id''': the internal core identifier used to load only core specific add-ons.
-* '''image''': the icon displayed in the core selection menu
+* '''image''': the icon displayed in the core selection menu. It should be part of the main game.
 * '''name''': (translatable) name displayed in the core selection menu
 * '''description''': (translatable) text shown in the information pane when this core is selected in the core selection menu
 * '''rank''': a number that determines the order of cores in the core selection menu.  Lower ''rank'' cores appear earlier, with unranked cores at the end. The default core has rank 5.
 * '''path''': the path to the core's directory or initial config file. E.g. ''~add-ons/my_core/load.cfg''. This config file (or the config files in that directory) should load things similar to the file data/_main.cfg in mainline.
 == See Also ==

@@ Line 2: / Line 2: @@
 This page describes how the core is displayed in the "Load Core" menu, and how it works.
-Cores are to be defined in a file called cores.cfg in you add-ons base directory. An add-on containing only a core does not need an _main.cfg, cores are loaded prior to that by looking for cores.cfg.
+Cores are to be defined in a file called cores.cfg in your add-ons base directory. An add-on containing only a core does not need a _main.cfg, cores are loaded prior to that by looking for cores.cfg. To publish the add-on from within wesnoth a _main.cfg is needed but it can be an empty one. '''_main.cfg should NOT be the same file as what is defined under [core] path or everything will be loaded twice!'''
 Other add-ons, which rely on a specifc core, need to have it mentioned in the _server.pbl ''and'' _info.cfg.

@@ Line 7: / Line 7: @@
 ==The [core] Tag==
-{{DevFeature1.13|x}}
+{{DevFeature1.13|0}}
 The following keys and tags are recognized in '''[core]''' tags: