Difference between revisions of "CoreWML"
From The Battle for Wesnoth Wiki
m (markup) |
(mention _main.cfg pitfall) |
||
Line 2: | Line 2: | ||
This page describes how the core is displayed in the "Load Core" menu, and how it works. | 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 | + | 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. | Other add-ons, which rely on a specifc core, need to have it mentioned in the _server.pbl ''and'' _info.cfg. |
Revision as of 14:07, 22 October 2019
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 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.
The [core] Tag
(Version 1.13.0 and later only)
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
- 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.