Difference between revisions of "CoreWML"
From The Battle for Wesnoth Wiki
(→The [core] Tag: example for path) |
(Add information where to place [core]s) |
||
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 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== | ==The [core] Tag== |
Revision as of 20:26, 10 November 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.x 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.
- icon: the image displayed in the core selection menu
- name: (translatable) name displayed in the core selection menu
- image: the image shown in the information pane when this core is selected in the core selection menu (typically a transparent, 350×350 pixels portrait)
- 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 campaigns appear earlier, with unranked cores at the end. Currently the mainline cores use multiples of 10 from 0 to 100.
- path: the path to the core's directory or initial config file. E.g. ~add-ons/my_core/load.cfg