Difference between revisions of "PblWML"
From The Battle for Wesnoth Wiki
(→.pbl files) |
|||
| Line 10: | Line 10: | ||
The following keys are recognized for .pbl files: | The following keys are recognized for .pbl files: | ||
| − | * ''icon'' an image, displayed leftmost on the "download campaigns" screen. | + | * ''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]].) |
| − | It must be a standard Wesnoth graphic and not a custom one. | + | * ''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. |
| − | (Note that the icon used to display your campaign for when it is played can be custom; | + | * ''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 |
| − | for more information see [[CampaignWML]].) | + | * ''author'' displayed to the right of the version, it is also text. Put your name or nickname here. |
| − | * ''title'' displayed to the right of the icon, it is just text. | + | * ''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. |
| − | It should usually be the same as the name of your campaign when it is played. | + | * ''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. |
| − | * ''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. | ||
| − | * ''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. | ||
Example: | Example: | ||
| Line 32: | Line 21: | ||
title="My Campaign" | title="My Campaign" | ||
icon="misc/ball.png" | icon="misc/ball.png" | ||
| − | + | verson="0.1.2 (BFW 0.8.11)" | |
author="Me" | author="Me" | ||
passphrase="This is like a password" | passphrase="This is like a password" | ||
| + | description="You get to kill a lot of bad guys. But only the first map is done." | ||
== See Also == | == See Also == | ||
| Line 40: | Line 30: | ||
* [[ReferenceWML]] | * [[ReferenceWML]] | ||
* [[BuildingCampaignsThePBLFile]] | * [[BuildingCampaignsThePBLFile]] | ||
| − | |||
Revision as of 15:26, 18 September 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.
- 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."