Difference between revisions of "CoreWML"
From The Battle for Wesnoth Wiki
m (fixed release where cores were introduced) |
(update from issue #3728) |
||
Line 11: | Line 11: | ||
The following keys and tags are recognized in '''[core]''' tags: | The following keys and tags are recognized in '''[core]''' tags: | ||
* '''id''': the internal core identifier used to load only core specific add-ons. | * '''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 | * '''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 | * '''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. | * '''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. |
Revision as of 16:39, 2 December 2018
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.
Other add-ons, which rely on a specifc core, need to have it mentioned in the _server.pbl / _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.