Difference between revisions of "PblWML"
From The Battle for Wesnoth Wiki
(→.pbl files) |
|||
| Line 13: | Line 13: | ||
* ''title'' 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. | * ''title'' 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. | ||
* ''version'' displayed to the right of the title, it is also just text. It should describe how complete your campaign is, and how many times you have released it before. Eventually there may be a convention for versioning; it was discussed at http://www.wesnoth.org/forum/viewtopic.php?t=3346 | * ''version'' displayed to the right of the title, it is also just text. It should describe how complete your campaign is, and how many times you have released it before. Eventually there may be a convention for versioning; it was discussed at http://www.wesnoth.org/forum/viewtopic.php?t=3346 | ||
| − | * ''author'' displayed to the right of the version, it is also text. Put your name or nickname here. | + | * ''author'' displayed to the right of the version, it is also 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. |
* ''passphrase'' 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. | * ''passphrase'' 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. | ||
* ''description'' is not displayed in the client. However it will be visible on the upcoming web interface for downloading cmapaigns. 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. | * ''description'' is not displayed in the client. However it will be visible on the upcoming web interface for downloading cmapaigns. 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. | ||
Revision as of 12:34, 12 October 2005
.pbl files
To upload a campaign you have made, you need a .pbl file. This is a file with name data/campaigns/campaign-name.pbl. 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/.
The following keys are recognized for .pbl files:
- icon an image, displayed leftmost on the "download campaigns" screen. It must be a standard Wesnoth graphic and not a custom one. (Note that the icon used to display your campaign for when it is played can be custom; for more information see CampaignWML.)
- title 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.
- version displayed to the right of the title, it is also just text. It should describe how complete your campaign is, and how many times you have released it before. Eventually there may be a convention for versioning; it was discussed at http://www.wesnoth.org/forum/viewtopic.php?t=3346
- author displayed to the right of the version, it is also 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.
- passphrase 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.
- description is not displayed in the client. However it will be visible on the upcoming web interface for downloading cmapaigns. 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.
Example:
title="My Campaign" icon="misc/ball.png" verson="0.1.2 (BFW 0.8.11)" author="Me" passphrase="This is like a password" description="You get to kill a lot of bad guys. But only the first map is done."
The campaign server keeps track of some other information about uploaded campaigns, included when they were uploaded, 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.