Difference between revisions of "PblWML"

From The Battle for Wesnoth Wiki
m (What goes into a .pbl file?)
(Revised most content, including obsolete file paths and replaced many instances of "campaign" with "add-on")
Line 1: Line 1:
 
{{WML Tags}}
 
{{WML Tags}}
  
To upload a campaign you have made, you need a .pbl file.
+
To upload an add-on you have made, you need a .pbl file.
  
This is a file with name '''data/campaigns/''campaign-name''.pbl'''.  [http://exong.net/wesnoth-attach/files/pblexample_111.png Click here for an example of what we're talking about.]
+
This is a file with name '''data/add-ons/''addon-name''.pbl'''.  [http://exong.net/wesnoth-attach/files/pblexample_111.png Click here for an example of what we're talking about.]
  
When you upload a campaign, the file '''data/campaigns/''campaign-name''.cfg'''
+
When you upload a add-on, the file '''data/add-ons/''addon-name''.cfg'''
and the directory '''data/campaigns/''campaign-name''/''' will be published.
+
and the directory '''data/add-ons/''addon-name''/''' will be published. Alternatively, '''data/add-ons/''addon-name''.cfg''' can be replaced with '''data/add-ons/''addon-name''/_main.cfg.cfg'''. Your add-on must be based entirely on these paths.
Your campaign must be based entirely on these files.
+
 
This may cause your campaign not to upload properly,
+
Be aware that translations in the .pbl-files are '''not''' used, so don't mark these strings as translatable.
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? ==
 
== What goes into a .pbl file? ==
Line 19: Line 17:
  
 
=== icon ===
 
=== icon ===
: 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 but others won't see it!) (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.
+
: An image, displayed leftmost in the add-ons download dialog. It must be a standard Wesnoth file and not a custom one. A custom file will work for users who already have the relevant add-on installed. This is not related to the icon used for entries in the campaigns menu -- see [[CampaignWML]] for more information.
 +
 
 +
: If the icon is a unit with magenta team-color bits, please use [[ImagePathFunctionWML]] to recolor it.
  
 
=== title ===
 
=== 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.
+
: Displayed to the right of the icon, it is just text. It should usually be the same as the name of your add-on when it is played.
  
 
=== version ===
 
=== version ===
: 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. ([[#Version Key Examples|See Examples]])
+
: 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 add-on is complete feature-wise. Trailing non-numeric elements are allowed, but nothing should appear ''before'' the numbers. This is necessary for the ''Update add-ons'' button to work correctly. ([[#Version Key Examples|See Examples]])
  
 
=== author ===
 
=== author ===
: 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.
+
: 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 add-on you may want to all of their names.
  
 
=== passphrase ===
 
=== 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.
+
: Not displayed, it prevents others from modifying the version of your add-on on the server. You do not need to input a passphrase when initially publishing a add-on; if you do not, one will be randomly generated for you and replaced in your local copy of the .pbl file.
  
 
=== description ===
 
=== description ===
: 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.
+
: This can be used to provide a brief description of your add-on, and for pre-1.0 versions, let people know how playable it is. The description can be viewed by users by clicking on the Description button in the built-in client, or by moving their mouse over the add-on's icon in the web interface.
  
 
=== dependencies ===
 
=== dependencies ===
: An optional list of dependencies. ([[#Dependency Key Example|See Example]])
+
: An optional list of dependencies, which should be provided if your add-on relies on other user-made content to work properly. ([[#Dependency Key Example|See Example]])
  
 
=== translate ===
 
=== translate ===
: 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.)
+
: If set to '''true''', the add-on will be sent to and updated with [[WesCamp|WesCamp-i18n]]. (NOTE: this is a new and experimental function, which will automatically update the translations in your add-on. Make sure you make backups of your add-on in case of problems.)
 +
 
 +
: You should make sure your add-on complies with some very specific [[WesCamp#How_to_contribute_to_this_Project|conventions]] required to ease the process for translators.
  
 
=== type ===
 
=== type ===
Line 56: Line 58:
  
 
=== email ===
 
=== email ===
: 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.
+
: 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 add-on.
  
  
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]].
+
The add-on server keeps track of some other information about uploaded content, 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]].
  
 
== Examples ==
 
== Examples ==
Line 65: Line 67:
 
=== Dependency Key Example ===
 
=== 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:
+
The following dependency key could be used when the add-on needs the ''Imperial_Era'' and ''Era_of_Myths'' to be installed before it will work properly:
  
 
  dependencies=Imperial_Era,Era_of_Myths
 
  dependencies=Imperial_Era,Era_of_Myths

Revision as of 21:07, 20 July 2010

[edit]WML Tags

A:

abilities, about, achievement, achievement_group, add_ai_behavior, advanced_preference, advancefrom, advancement, advances, affect_adjacent, ai, allied_with, allow_end_turn, allow_extra_recruit, allow_recruit, allow_undo, and, animate, animate_unit, animation, aspect, attack (replay, weapon), attack_anim, attacks (special, stats), avoid;

B:

base_unit, background_layer, berserk, binary_path, break, brush;

C:

campaign, cancel_action, candidate_action, capture_village, case, chance_to_hit, change_theme, chat, checkbox, choice, choose, clear_global_variable, clear_menu_item, clear_variable, color_adjust, color_palette, color_range, command (action, replay), continue, credits_group, criteria;

D:

damage, death, deaths, default, defend, defends, defense, delay, deprecated_message, destination, difficulty, disable, disallow_end_turn, disallow_extra_recruit, disallow_recruit, do, do_command, drains, draw_weapon_anim;

E:

editor_group, editor_music, editor_times, effect, else (action, animation), elseif, endlevel, end_turn (action, replay), enemy_of, engine, entry (credits, options), era, event, experimental_filter_ability, experimental_filter_ability_active, experimental_filter_specials, extra_anim;

F:

facet, facing, fake_unit, false, feedback, female, filter (concept, event), filter_adjacent, filter_adjacent_location, filter_attack, filter_attacker, filter_base_value, filter_condition, filter_defender, filter_enemy, filter_location, filter_opponent, filter_own, filter_owner, filter_radius, filter_recall, filter_second, filter_second_attack, filter_self, filter_side, filter_student, filter_vision, filter_weapon, filter_wml, find_path, fire_event, firststrike, floating_text, found_item, for, foreach, frame;

G:

game_config, get_global_variable, goal, gold, gold_carryover;

H:

harm_unit, has_ally, has_attack, has_unit, has_achievement, have_location, have_unit, heal_on_hit, heal_unit, healed_anim, healing_anim, heals, hide_help, hide_unit, hides;

I:

idle_anim, if (action, animation, intro), illuminates, image (intro, terrain), init_side, insert_tag, inspect, item, item_group;

J:

jamming_costs, join;

K:

kill, killed;

L:

label, language, leader, leader_goal, leadership, leading_anim, levelin_anim, levelout_anim, lift_fog, limit, literal, load_resource, locale, lock_view, lua;

M:

male, menu_item, message, micro_ai, missile_frame, modification, modifications, modify_ai, modify_side, modify_turns, modify_unit, modify_unit_type, move, move_unit, move_unit_fake, move_units_fake, movement_anim, movement costs, movetype, multiplayer, multiplayer_side, music;

N:

not, note;

O:

object, objective, objectives, on_undo, open_help, option, options, or;

P:

part, petrifies, petrify, place_shroud, plague, poison, post_movement_anim, pre_movement_anim, primary_attack, primary_unit, print, progress_achievement, put_to_recall_list;

R:

race, random_placement, recall (action, replay), recalls, recruit, recruit_anim, recruiting_anim, recruits, redraw, regenerate, remove_event, remove_item, remove_object, remove_shroud, remove_sound_source, remove_time_area, remove_trait, remove_unit_overlay, repeat, replace_map, replace_schedule, replay, replay_start, reset_fog, resistance (ability, unit), resistance_defaults, resource, return, role, rule;

S:

save, scenario, screen_fade, scroll, scroll_to, scroll_to_unit, secondary_attack, secondary_unit, section, select_unit, sequence, set_achievement, set_extra_recruit, set_global_variable, set_menu_item, set_recruit, set_specials, set_variable, set_variables, sheath_weapon_anim, show_if (message, objective, set_menu_item), show_objectives, side, skirmisher, slider, slow, snapshot, sound, sound_source, source (replay, teleport), special_note, specials, split, stage, standing_anim, statistics, status, store_gold, store_items, store_locations, store_map_dimensions, store_reachable_locations, store_relative_direction, store_side, store_starting_location, store_time_of_day, store_turns, store_unit, store_unit_defense, store_unit_defense_on, store_unit_type, store_unit_type_ids, store_villages, story, swarm, sub_achievement, switch, sync_variable;

T:

target, team, teleport (ability, action), teleport_anim, terrain, terrain_defaults, terrain_graphics, terrain_mask, terrain_type, test, test_condition, test_do_attack_by_id, text_input, textdomain, theme, then, tile, time, time_area, topic, toplevel, trait, transform_unit, traveler, true, tunnel;

U:

unhide_unit, unit, unit_overlay, unit_type, unit_worth, units, unlock_view, unpetrify, unstore_unit, unsynced;

V:

value, variable, variables, variant, variation, victory_anim, village, vision_costs, volume;

W:

while, wml_message, wml_schema;

Z:

zoom;

To upload an add-on you have made, you need a .pbl file.

This is a file with name data/add-ons/addon-name.pbl. Click here for an example of what we're talking about.

When you upload a add-on, the file data/add-ons/addon-name.cfg and the directory data/add-ons/addon-name/ will be published. Alternatively, data/add-ons/addon-name.cfg can be replaced with data/add-ons/addon-name/_main.cfg.cfg. Your add-on must be based entirely on these paths.

Be aware that translations in the .pbl-files are not used, so don't mark these strings as translatable.

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:

icon

An image, displayed leftmost in the add-ons download dialog. It must be a standard Wesnoth file and not a custom one. A custom file will work for users who already have the relevant add-on installed. This is not related to the icon used for entries in the campaigns menu -- see CampaignWML for more information.
If the icon is a unit with magenta team-color bits, please use ImagePathFunctionWML to recolor it.

title

Displayed to the right of the icon, it is just text. It should usually be the same as the name of your add-on when it is played.

version

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 add-on is complete feature-wise. Trailing non-numeric elements are allowed, but nothing should appear before the numbers. This is necessary for the Update add-ons button to work correctly. (See Examples)

author

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 add-on you may want to all of their names.

passphrase

Not displayed, it prevents others from modifying the version of your add-on on the server. You do not need to input a passphrase when initially publishing a add-on; if you do not, one will be randomly generated for you and replaced in your local copy of the .pbl file.

description

This can be used to provide a brief description of your add-on, and for pre-1.0 versions, let people know how playable it is. The description can be viewed by users by clicking on the Description button in the built-in client, or by moving their mouse over the add-on's icon in the web interface.

dependencies

An optional list of dependencies, which should be provided if your add-on relies on other user-made content to work properly. (See Example)

translate

If set to true, the add-on will be sent to and updated with WesCamp-i18n. (NOTE: this is a new and experimental function, which will automatically update the translations in your add-on. Make sure you make backups of your add-on in case of problems.)
You should make sure your add-on complies with some very specific conventions required to ease the process for translators.

type

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.
  • other: The type to use when no other type fits.

email

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 add-on.


The add-on server keeps track of some other information about uploaded content, 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.

Examples

Dependency Key Example

The following dependency key could be used when the add-on needs the Imperial_Era and Era_of_Myths to be installed before it will work properly:

dependencies=Imperial_Era,Era_of_Myths

Version Key Examples

The following are examples of good version values:

version="1.5"
version="0.11.4"
version="0.1.4beta"
version="1.5c"


The following are examples of bad version values:

version="Beta1.5"
version="Incomplete (0.3.4)"

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="name@example.com"

See Also