CampaignWML

From Wesnoth



This page describes how the campaign is displayed in the "Campaign" menu, and how it starts.

The [campaign] Tag

The following keys and tags are recognized in [campaign] tags:

  • id: the internal campaign identifier used to classify saved games
  • icon: the image displayed in the campaign selection menu
  • name: (translatable) name displayed in the campaign selection menu
  • abbrev: (translatable) abbreviation used as a prefix for savefile names made from this campaign
  • image: the image shown in the information pane when this campaign is selected in the campaign selection menu (typically a transparent, 350×350 pixels portrait)
  • description: (translatable) text shown in the information pane when this campaign is selected in the campaign selection menu
  • description_alignment: (Version 1.13.3 and later only) The text alignment of the description. Choose between "left" (default), "center", or "right".
  • type: campaign's type to specify if it should be visible in singleplayer, multiplayer or both. Possible values are "sp", "mp" and "hybrid". Defaults to "sp".
  • define=CAMPAIGN_SYMBOL when this campaign is started, the preprocessor symbol CAMPAIGN_SYMBOL will be defined. See #ifdef in PreprocessorRef for how this can be used to isolate parts of the campaign file from other campaigns. Only the tags [campaign] and [binary_path] (see BinaryPathWML) should go outside of #ifdef CAMPAIGN_SYMBOL. This symbol will be defined before any .cfg is preprocessed. Important note: starting with 1.7.13, [binary_path] does no longer need to be outside of the #ifdef CAMPAIGN_SYMBOL block to make custom binary data available, which could easily cause overwrites. E.g. icon=data/add-ons/whatever/something.png is supposed to work. This seems to have been a bug since at least BfW 1.0 which means that practically all available examples of user made add-ons are wrong in this aspect.
  • extra_defines: a comma(,) separated list of preprocessor symbols. Those symbols will be defined before any .cfg is preprocessed. Currently supported extra_defines are:
    ENABLE_ARMAGEDDON_DRAKE
    allows the advancement Inferno Drake -> Armageddon Drake
    ENABLE_DWARVISH_ARCANISTER
    allows the advancement Dwarvish Runemaster -> Dwarvish Arcanister
    ENABLE_DWARVISH_RUNESMITH
    allows the advancement Dwarvish Fighter -> Dwarvish Runesmith
    DISABLE_GRAND_MARSHAL
    disallows the advancement General -> Grand Marshal
    ENABLE_ANCIENT_LICH
    allows the advancement Lich -> Ancient Lich
    ENABLE_DEATH_KNIGHT
    allows the advancement Revenant -> Death Knight'
    ENABLE_TROLL_SHAMAN
    allows the advancement Troll Whelp -> Troll Shaman
    ENABLE_WOLF_ADVANCEMENT
    allows the advancements Wolf -> Great Wolf -> Direwolf
    ENABLE_NIGHTBLADE (Version 1.13.0 and later only)
    allows the advancement Orcish Slayer -> Orcish Nightblade
    ENABLE_KHALID (Version 1.13.0 and later only)
    allows the advancement Shuja -> Khalid
  • difficulties: a comma(,) separated list of preprocessor symbols, exactly one of which will be stored depending on the difficulty setting chosen when the campaign is started. The symbols EASY, NORMAL, and HARD are usually used, and there are several macros in utils.cfg (see Macro Reference) which check for these values to set WML keys to different values depending on difficulty. If you use different difficulty symbols, you may need to define your own versions of these macros. (Version 1.13.2 and later only) This key has been deprecated in favor of [difficulty] define=.
  • difficulty_descriptions: the menu of difficulties; this is a list of descriptions (see DescriptionWML) that correspond to different difficulty levels. Since each description is a menu option for a difficulty level, this must provide the same number of descriptions as there are levels in the difficulties list. (Version 1.13.2 and later only) This key has been deprecated in favor of [difficulty] define=
  • [difficulty]: (Version 1.13.2 and later only) specifies a single campaign difficulty. The following keys are accepted:
    • define: the preprocessor symbol defined when this difficulty is selected. Uses the same format as an entry in the old difficulties list.
    • image: the image to display for this difficulty in the selection menu
    • label: a flavor label describing this difficulty. Displayed second after the image
    • description: a description of the difficulty, usually along the lines of "Beginner" or "Challenging". Displayed third after the image.
    • default: whether this is the difficulty which will be selected by default when the difficulty selection menu is displayed.
  • allow_difficulty_change: Allows difficulty switching during an ongoing campaign. Default:yes
  • first_scenario: the ID of the first scenario in the campaign; see id in ScenarioWML
  • [options]: (Version 1.13.1 and later only) Allows configuration options to be displayed to the user, see OptionWML
  • rank: a number that determines the order of campaigns in the campaign selection menu. Lower rank campaigns appear earlier, with unranked campaigns at the end. Currently the mainline campaigns use multiples of 10 from 0 to 399, with 0-99 for Novice campaigns, 100-199 for Intermediate campaigns, and 200-399 for Expert campaigns; if you specify this, it should not be less than 400. (Note: This replaces an older convention that topped out at 50.)
  • [about]: inserts your own credits into the game's list of credits. See below for syntax.
  • end_credits: Whether to display the credits screen at the end of the campaign. Defaults to yes.
  • end_text: (translatable) Text that is shown centered in a black screen at the end of a campaign. Defaults to "The End".
  • end_text_duration: Delay, in milliseconds, before displaying the game credits at the end of a campaign. In other words, for how much time end_text is displayed on screen. Defaults to 3500.
  • [event]: (Version 1.13.2 and later only) events placed here will be automatically inserted into all scenarios of the campaign.

The following keys are additionally recognized in multiplayer:

  • min_players: Minimum number of players campaign supports. Defaults to 2.
  • max_players: Maximum number of players campaign supports. Defaults to min_players or 2, whichever is higher.
  • allow_era_choice: Whether to hide era selection and use a default one when creating a game. Defaults to yes.
  • require_campaign: Whether clients are required to have this campaign installed beforehand to be allowed join a game using this campaign. Possible values 'yes' (the default) and 'no'.

Campaign credits

The campaign's name automatically is inserted at the top of the rolling credits followed by title/text key pairs. There can be any number of [about] tags inside a [campaign] tag, but none of them will display credits if there is no "id" key present inside [campaign] (see above). The [about] tag has the following keys:

  • title: (translatable) large text used to start a new subsection (writers, artists, units, balancing) in the rolling credits
  • text: (translatable, but you probably won't want to make it such) smaller text which is displayed before the contributor names
  • [entry]: Contains information about a single contributor. Only the name key will be used in-game, the other three keys are for display on the Credits page (note: the values of these keys will only display on the Credits page for mainline campaigns; they will not display for UMC campaigns)
    • name: The name of the contributor
    • comment: Optional short note about what that person did
    • email: Optional email address
    • wikiuser: Optional, the user name on the wiki

See Also

This page was last modified on 4 December 2016, at 15:50.