To upload a campaign you have made, you need a .pbl file.
This is a file with name data/campaigns/campaign-name.pbl. Click here for an example of what we're talking about.
When you upload a campaign, the file data/campaigns/campaign-name.cfg and the directory data/campaigns/campaign-name/ will be published. Your campaign must be based entirely on these files. This may cause your campaign not to upload properly, for example, if you have custom campaign units in data/units/. Be aware that translations in the .pbl-files are not working, so don't mark these strings translateable.
What goes into a .pbl file?
Note: You should not use special formatting or coloring in any of these keys when uploading to the official server.
The following keys are recognized for .pbl files:
- An image, displayed leftmost on the "download campaigns" screen. It must be a standard Wesnoth graphic and not a custom one. (Well, a custom graphic will work if the user already has the campaign installed, or if it is a custom graphic from a different campaign that the user has installed.) (Note that the icon used to display your campaign for when it is played can be custom; for more information see CampaignWML.) If the icon is a unit with magenta color, please use ImagePathFunctionWML to team-color it.
- Displayed to the right of the icon, it is just text. It should usually be the same as the name of your campaign when it is played.
- Displayed to the right of the title, it is just text. However, starting with Wesnoth 1.6, the required format is x.y.z where x, y and z are numbers and a value for x greater than 0 implies the campaign is complete and balanced. Trailing non-numeric elements are ok, but nothing should appear before the numbers. This is necessary for the Update add-ons button to work correctly. (See Examples)
- Displayed to the right of the version, it is just text. Put your name or nickname here. If several people have contributed significantly to the campaign you should list all of their names and perhaps describe what each person was responsible for.
- Not displayed, it prevents others from modifying the version of your campaign on the campaign server. You do not need to input a passphrase when initially publishind a campaign; if you do not, one will be randomly generated for you.
- Is not displayed in the client but it is visible on the web interface to the campaign server. It can be used to give a brief description of your campaign and, for pre 1.0 versions, let people know how playable it is.
- An optional list of dependencies. (See Example)
- If set to true, the campaign will be sent to and updated with Wescamp (NOTE: this is a new and experimental function, which will automatically update the translations in your campaign. Make sure you make backups of your campaign in case of problems.)
- Indicates the type of the add-on, used for the downloads manager dialog. Possible values are:
- campaign: single player campaign.
- scenario: single player scenario.
- era: multiplayer era.
- faction: multiplayer stand-alone faction, or add-on for other available era.
- map_pack: multiplayer map-pack.
- campaign_mp: multiplayer campaign.
- scenario_mp: multiplayer scenario.
- media: miscellaneous resources for UMC authors/users, for example, music packs, packages of general-purpose WML, etc.
- Hidden e-mail address used by the server administrators to contact content authors in case of major issues. Again, this will only be seen by the server administrators and it is highly recommended that you provide one in case you need to be contacted about your addon.
The campaign server keeps track of some other information about uploaded campaigns, including when they were uploaded, what languages they have been at least partly translated into, how large they are on the server and the number of times they have been downloaded. For more information about this you can read CampaignServerWML.
Dependency Key Example
The following dependency key could be used when the addon needs the Imperial_Era and Era_of_Myths to be installed before it will work properly:
Version Key Examples
The following are examples of good version values:
The following are examples of bad version values:
In both of the above examples the version number as read by the server will be 0.0.0Beta1.5 and 0.0.0Incomplete (0.3.4). You can clearly see why this will not be a good thing with the Update add-ons feature.
Finally, here are some example version numbers and how they will be interpreted by the Update add-ons button. The number on the left will be considered an earlier number than the number on the right in each example.
0.5 < 1.0
1.5 < 1.5c
1.0 < 1.0.1
1.0c < 1.0.1a
1.0.1a < 1.0.1c
1.0 Final < 1.0.1 Beta
Example .pbl File
title="My Campaign" type="campaign" icon="misc/ball.png" version="0.1.2" author="Me, artwork by myself" passphrase="This is like a password" description="You get to kill a lot of bad guys. But only the first map is done." email="email@example.com"