CampaignServerWML - Revision history

Egallager: minor wikification

2023-04-07T15:14:56Z

minor wikification

← Older revision		Revision as of 15:14, 7 April 2023
Line 1:		Line 1:
	<div class="tright"> __TOC__ </div>		<div class="tright"> __TOC__ </div>

	This page describes the WML commands exchanged between the add-ons server (<b>campaignd</b>) and clients.		This page describes the WML commands exchanged between the add-ons server (<b>[[campaignd]]</b>) and clients.

	For historical reasons, both the server software's name and the WML tags which are part of its communication protocol make exclusive reference to "campaigns" instead of "add-ons". However, in practice there is no real difference between any kind of add-ons as far as the server is concerned.		For historical reasons, both the server software's name and the WML tags which are part of its communication protocol make exclusive reference to "campaigns" instead of "add-ons". However, in practice there is no real difference between any kind of add-ons as far as the server is concerned.

Pentarctagon: /* [delete]: Deleting an add-on */

2023-03-13T17:50:52Z

[delete]: Deleting an add-on

← Older revision		Revision as of 17:50, 13 March 2023
Line 137:		Line 137:
	** '''name''': The name of the add-on to delete.		** '''name''': The name of the add-on to delete.
	** '''passphrase''': The passphrase for the add-on. It must match the passphrase on record in order for the operation to succeed.		** '''passphrase''': The passphrase for the add-on. It must match the passphrase on record in order for the operation to succeed.
	** '''~~author~~''': The name of the author who uploaded the add-on. Required only for add-ons using forum_auth.		** '''uploader''': The name of the author who uploaded the add-on. Required only for add-ons using forum_auth.

	=== Response ===		=== Response ===

Pentarctagon: /* [delete]: Deleting an add-on */

2023-03-13T17:37:50Z

[delete]: Deleting an add-on

← Older revision		Revision as of 17:37, 13 March 2023
Line 137:		Line 137:
	** '''name''': The name of the add-on to delete.		** '''name''': The name of the add-on to delete.
	** '''passphrase''': The passphrase for the add-on. It must match the passphrase on record in order for the operation to succeed.		** '''passphrase''': The passphrase for the add-on. It must match the passphrase on record in order for the operation to succeed.
			** '''author''': The name of the author who uploaded the add-on. Required only for add-ons using forum_auth.

	=== Response ===		=== Response ===

Pentarctagon: /* Request */

2023-03-13T17:36:58Z

Request

← Older revision		Revision as of 17:36, 13 March 2023
Line 105:		Line 105:

	* '''[upload]'''		* '''[upload]'''
	** ~~'''author''', '''dependencies''', '''description''', '''email''', '''icon''', '''passphrase''', '''~~tags~~''', '''title''', '''translate''', '''type''', '''[feedback]''', '''[translation]''': See~~ [[PblWML]].		** See tags and attributes listed in [[PblWML]].
	** '''[data]'''		** '''[data]'''
	*** '''[file]''', '''[dir]''': See [[#Archive format\|archive format]].		*** '''[file]''', '''[dir]''': See [[#Archive format\|archive format]].

Kabachuha: Added info about translatable titles and descriptions of addons in 1.15.4 and further releases

2020-07-09T19:03:02Z

Added info about translatable titles and descriptions of addons in 1.15.4 and further releases

← Older revision		Revision as of 19:03, 9 July 2020
Line 74:		Line 74:
	*** '''uploads''': Number of uploads, including the initial upload.		*** '''uploads''': Number of uploads, including the initial upload.
	*** '''[translation]'''		*** '''[translation]'''
	**** '''language''': The name of a locale that this add-on appears to have been at least partially translated into. The following heuristic is used when an add-on is uploaded to extract a list of languages:<br>The list of directories in the uploaded campaign is recursively searched. If a directory named <code>LC_MESSAGES</code> is found then the name of the object containing this '''[dir]''' (normally the parent directory, but could be the add-on name if someone did something silly) is added to the list of translations. Directories named <code>LC_MESSAGES</code> are not searched for further matches.<br>The normal naming convention is to use POSIX locale names. This will usually be a two letter language code (e.g. <code>de</code>) or a two letter language code followed by a two letter region code (e.g. <code>pt_BR</code>). Since <code>en_US</code> is the base language, this language will not be listed as an available translation.		**** '''language''': The name of a locale that this add-on appears to have been at least partially translated into. The following heuristic is used when an add-on is uploaded to extract a list of languages:<br>The list of directories in the uploaded campaign is recursively searched. If a directory named <code>LC_MESSAGES</code> is found then the name of the object containing this '''[dir]''' (normally the parent directory, but could be the add-on name if someone did something silly) is added to the list of translations. Directories named <code>LC_MESSAGES</code> are not searched for further matches.<br>The normal naming convention is to use POSIX locale names. This will usually be a two letter language code (e.g. <code>de</code>) or a two letter language code followed by a two letter region code (e.g. <code>pt_BR</code>). Since <code>en_US</code> is the base language, this language will not be listed as an available translation. {{DevFeature1.15\|4}} If the server finds translation files, but the translation tag is absent, it will be created but without additional data other than a supported=yes attribute.
			**** '''supported''': {{DevFeature1.15\|4}} Is set to ''true'' if the corresponding .po or .mo localization file is found, ''false'' otherwise. Defaults to ''true'' in older addons to ensure backwards-compatibility.
			**** '''title''': {{DevFeature1.15\|4}} The translated title of the addon.
			**** '''description''': {{DevFeature1.15\|4}} The translated description of the addon.

	== [request_campaign]: Downloading an add-on ==		== [request_campaign]: Downloading an add-on ==

Kabachuha: Added info about translation tags in 1.15.4

2020-07-09T18:48:27Z

Added info about translation tags in 1.15.4

← Older revision		Revision as of 18:48, 9 July 2020
Line 102:		Line 102:

	* '''[upload]'''		* '''[upload]'''
	** '''author''', '''dependencies''', '''description''', '''email''', '''icon''', '''passphrase''', '''tags''', '''title''', '''translate''', '''type''', '''[feedback]''': See [[PblWML]].		** '''author''', '''dependencies''', '''description''', '''email''', '''icon''', '''passphrase''', '''tags''', '''title''', '''translate''', '''type''', '''[feedback]''', '''[translation]''': See [[PblWML]].
	** '''[data]'''		** '''[data]'''
	*** '''[file]''', '''[dir]''': See [[#Archive format\|archive format]].		*** '''[file]''', '''[dir]''': See [[#Archive format\|archive format]].

Shadowm at 22:04, 23 November 2019

2019-11-23T22:04:50Z

← Older revision		Revision as of 22:04, 23 November 2019
Line 158:		Line 158:

	[[Category:WML Reference]]		[[Category:WML Reference]]
			[[Category:Server Documentation]]

Jyrkive: The add-on client sets increase_downloads to false when downloading updates

2018-06-24T10:02:51Z

The add-on client sets increase_downloads to false when downloading updates

← Older revision		Revision as of 10:02, 24 June 2018
Line 84:		Line 84:
	* '''[request_campaign]'''		* '''[request_campaign]'''
	** '''name''': The name of the add-on. Note this is not the user-visible title and should not have spaces in it.		** '''name''': The name of the add-on. Note this is not the user-visible title and should not have spaces in it.
	** '''increase_downloads''': A boolean value specifying whether the download counter for the add-on should be increased or not. The game's built-in add-ons client sets this to ''~~true~~'' when downloading updates for already installed add-ons.		** '''increase_downloads''': A boolean value specifying whether the download counter for the add-on should be increased or not. The game's built-in add-ons client sets this to ''false'' when downloading updates for already installed add-ons.

	=== Response ===		=== Response ===

Shadowm: /* [request_terms]: Requesting upload terms */

2018-06-24T02:18:33Z

[request_terms]: Requesting upload terms

← Older revision		Revision as of 02:18, 24 June 2018
Line 141:		Line 141:
	== [request_terms]: Requesting upload terms ==		== [request_terms]: Requesting upload terms ==

	~~Retrieve~~ the upload terms that users must accept before uploading add-ons to the server. Wesnoth requires add-ons be licensed under the GNU GPL v2 or later, with assets allowed to be licensed under the same license or a Creative Commons license. See [[Wesnoth:Copyrights]] for more information.		Retrieves the upload terms that users must accept before uploading add-ons to the server. Wesnoth.org requires add-ons be licensed under the GNU GPL v2 or later, with assets allowed to be licensed under the same license or a Creative Commons license. See [[Wesnoth:Copyrights]] for more information.

			This action never fails.

	=== Request ===		=== Request ===
Line 148:		Line 150:
	=== Response ===		=== Response ===

	See [[#Common responses\|Common responses]]. The <code>[message]</code> response contains the upload terms~~. This action never fails~~.		See [[#Common responses\|Common responses]]. The <code>[message]</code> response contains the upload terms.

	== See Also ==		== See Also ==

Shadowm: /* Request */

2018-06-24T02:17:45Z

Request

← Older revision		Revision as of 02:17, 24 June 2018
Line 102:		Line 102:

	* '''[upload]'''		* '''[upload]'''
	** '''author''', '''dependencies''', '''description''', '''email''', '''icon''', '''passphrase''', '''tags''', '''title''', '''translate''', '''type''': See [[PblWML]].		** '''author''', '''dependencies''', '''description''', '''email''', '''icon''', '''passphrase''', '''tags''', '''title''', '''translate''', '''type''', '''[feedback]''': See [[PblWML]].
	** '''[data]'''		** '''[data]'''
	*** '''[file]''', '''[dir]''': See [[#Archive format\|archive format]].		*** '''[file]''', '''[dir]''': See [[#Archive format\|archive format]].