Difference between revisions of "CampaignServerWML"
From The Battle for Wesnoth Wiki
(→Listing Available Campaigns) |
|||
| Line 4: | Line 4: | ||
== Listing Available Campaigns == | == Listing Available Campaigns == | ||
| + | |||
| + | * Request | ||
| + | ** '''[request_campaign_list]''' | ||
| + | * Response | ||
| + | ** '''[campaigns]''' | ||
| + | *** '''[campaigns]''' | ||
| + | **** ''title'' - campaign title. | ||
| + | **** ''filename'' - filename campaign is stored in (currently the same as ''name''). | ||
| + | **** ''author'' - author(s) of the campaign. | ||
| + | **** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability. | ||
| + | **** ''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 complete. | ||
| + | **** ''timestamp'' - when this version of the campaign was uploaded. | ||
| + | **** ''downloads'' - how many times the campaign (including previous versions) has been downloaded directly from the campaign server. | ||
| + | **** ''size'' - the size of the campaign in bytes on the campaign server. | ||
| + | **** ''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. | ||
== Downloading a Campaign == | == Downloading a Campaign == | ||
Revision as of 17:59, 7 October 2005
Contents
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
- Request
- [request_campaign_list]
- Response
- [campaigns]
- [campaigns]
- title - campaign title.
- filename - filename campaign is stored in (currently the same as name).
- author - author(s) of the campaign.
- description - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
- 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 complete.
- timestamp - when this version of the campaign was uploaded.
- downloads - how many times the campaign (including previous versions) has been downloaded directly from the campaign server.
- size - the size of the campaign in bytes on the campaign server.
- 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.
- [campaigns]
- [campaigns]