CampaignServerWML

Campaign Server WML

This page describes the WML commands exchanged between campaign download clients and a campaign server. Note that this WML is not used in the game engine.

Listing Available Campaigns

This request is used to retrieve a list of campaigns available on the server and some overview information about them.

• Request
  • [request_campaign_list]
• Response
  • [campaigns]
    • [campaign]
      • author - author(s) of the campaign.
      • description - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
      • downloads - how many times the campaign (including previous versions) has been downloaded directly from the campaign server.
      • filename - filename campaign is stored in (currently the same as name).
      • icon - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
      • size - the size of the campaign in bytes on the campaign server.
      • timestamp - when this version of the campaign was uploaded.
      • title - campaign title.
      • version - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.

Deleting a Campaign

This command is used to delete an existing campaign from the campaign server.

• Request
  • [delete]
    • name - The name of the cmpaign to delete.
    • passphrase - This must match the passphrase on record for the campaign in order for the campaign to be deleted.
• Response
  • A message indicating that the campaign was erased.

Request License Information

Retrieve the terms of the license used for any uploaded campaigns. You may not upload a campaign if you don't (or can't) aggree to the license. Wesnoth requires campaigns (including images and sound) to be licensed under the GPL.

• Request
  • [request_terms]
• Response
  • A message containing the license.

See Also

• UserScenarios#Campaign_Server_Web_Access
• PblWML
• BuildingCampaignsThePBLFile