Difference between revisions of "Distributing content"

From The Battle for Wesnoth Wiki
m (Content-specific instructions)
(License: Link to Wesnoth:Copyrights, to cover the CC licensing)
(43 intermediate revisions by 23 users not shown)
Line 1: Line 1:
 +
{{Create}}
 +
 +
You've completed your creation. You've tested it, polished it, and tweaked it. You feel confident that your add-on is the greatest achievement since the sandwich was invented. Now what? Make it available to the world! How? You can either share your content via the forums, or via the add-on server. Both methods are discussed below.
 +
 
== The Forum ==
 
== The Forum ==
  
The [http://www.wesnoth.org/forum/ BFW forum] is a good way to distribute small creations, like single multiplayer maps. Larger creations, like unit packs or campaigns, should be compressed before uploading them. Note that you may encounter a size limit on attachments.
+
The [http://www.wesnoth.org/forum/ Wesnoth forums] is a good way to distribute small creations, like single multiplayer maps. Larger creations, like multiplayer eras or campaigns, should be compressed before uploading them. Note that you may encounter a size limit on attachments.
 +
 
 +
Also, there is a [http://www.wesnoth.org/forum/viewtopic.php?t=2014 legal announcement] that you should read before distributing anything on the forum. Basically, by posting you say that you own the license to what you are posting, and that you are giving rights under a Gnu or Creative Commons license as stated on [[Wesnoth:Copyrights]].
 +
 
 +
This option allows for feedback and is pretty easy for the content creators to do. However, it requires extra steps on the part of the downloader and limits the add-on's exposure to players who regularly visit the forum.
  
== The Campaign Server ==
+
== The Add-on Server ==
  
The campaign server is the preferred way to distribute your creations, but it is more suited for larger projects.  It currently lacks advanced organization features such as filtering and reviewing, so adding hundreds of little things makes it harder to find anything.  Basically, the server should not be used to post single maps, units, songs, or artwork, but map packs, campaigns, entire eras, music packs, and unit packs are fine.
+
The add-on server is the preferred way to distribute your creations, but it is more suited for larger projects.  It currently lacks advanced organization features such as reviewing (although it does have a filter text box), so adding hundreds of little things makes it harder to find anything.  Basically, the server should not be used to post single maps, units, songs, or artwork, but map packs, campaigns, entire eras, music packs, and unit packs are fine.
  
Once you are ready to publish, here is how you access the campaign server:
+
In in order to publish and add-on to the server, you need to create a <b>_server.pbl</b> file inside your add-on's directory. Detailed instructions on the syntax of the file are located on the [[PblWML]] page. File <b>_main.cfg</b> is also required, even for resource addons.
# Open Wesnoth
 
# Select "Campaign" from the main menu
 
# Select "Get More Campaigns" (the last entry in the list of campaigns)
 
# Select "Publish Campaign: ''Your Campaign Name''" (the last entry in the list of campaigns)
 
  
Anything you distribute on the server will be upload from and downloaded to the ''userdata''/data/campaigns directory regardless of what it is (units, maps, campaign, etc). For this reason, you need three things in the campaigns directory to distribute via the server:
+
Once you are ready to publish:
# A .cfg file, for example MyCampaign.cfg
+
* Open Wesnoth
# A .pbl file, for example MyCampaign.pbl
+
* Select <b>Add-ons</b> from the main menu
# A folder, for example MyCampaign
+
* Connect to the default <i>add-ons.wesnoth.org</i> add-on server
 +
* In 1.12: Select your add-on, which will be the last entry in the list of add-ons. Then select <b>Publish add-on: <i>Your Add-on Name</i></b>
 +
* In 1.14: In the "State" drop-down above the list, select "Publishable", and the list will show only your add-on. Select your add-on, then click on the shield icon with the upwards arrow.
  
=== Instructions ===
+
<b>Note:</b> If you haven't included a passphrase in the <b>_server.pbl</b> file then Wesnoth will add a randomly-generated password to it. This password can be used to upload updates.
  
==== General ====
+
<b>Note:</b> By default, all files and folders inside the add-on's directory are uploaded, except those that begin with <b>'.'</b> and those that end in <b>'~'</b>. If you want to exclude any others, you may do so by creating a <b>_server.ign</b> file and listing within it the files or folders you wish not to be uploaded (see [[IGNFileFormat]] for more information).
* [[BuildingCampaignsThePBLFile|General information about the .pbl file]] - It has a campaign flavor, but it is adaptable to any content
 
* [[PblWML|Syntax reference for the .pbl file]]
 
  
==== Content-specific instructions ====
+
<b>Note:</b> A command-line interface to publish add-ons exists for those who prefer it. The script is located in a path like "/share/wesnoth/data/tools/wesnoth_addon_manager" (may depend on your OS and wesnoth version).
* Campaign - see the [[BuildingCampaigns|Buidling Campaigns Article]]
+
 
** [[BuildingCampaignsDistribution|About distributing campaigns]]
+
==== License ====
* Multiplayer era - see the [[BuildingFactions#Adding_a_whole_new_era_with_its_own_factions_-_modular|MP Era Article]]
+
 
* Unit pack - see the [[BuildingUnits#Distributing_your_unit|Units Article]]
+
Whenever you upload or update your add-on, you will have to confirm that it is licensed as required by
* Map pack - see the
+
* [[Wesnoth:Copyrights#User_Made_Content_-_Code]] and
* Others?
+
* [[Wesnoth:Copyrights#User_Made_Content_-_Visual_and_Audio_Content]]
 +
 
 +
When a user downloads your add-on, it will include the ART_LICENSE that you included and a COPYING.txt file containing a copy of the GNU GPL version 2, signifying the content is licensed under such.
 +
 
 +
== Version control distribution ==
 +
 
 +
Wesnoth hosts a [[Wesnoth_UMC_Dev| SVN repository]] to allow content creators to collaborate with each other in developing their content. Several high-profile add-ons were developed using it, including a few that ultimately ended up in mainline.
 +
 
 +
Alternatively, you could create your own personal repository on a service such as [https://github.com/ GitHub]. Several UMC authors such as shadowm, vultraz, and bumbadadabum have done this recently.
  
 
== See Also ==
 
== See Also ==
  
 
* [[Create]]
 
* [[Create]]
* [[BuildingCampaignsDistribution]]
 
* [[BuildingCampaignsThePBLFile]]
 
 
* [[PblWML]]
 
* [[PblWML]]
 +
* [[IGNFileFormat]]
 +
* [[Wesnoth:Copyrights]]
 +
* [[Guide_to_UMC_Campaigns|Guide to UMC Campaigns]]
 +
 +
[[Category:Create]]

Revision as of 22:32, 1 June 2019


You've completed your creation. You've tested it, polished it, and tweaked it. You feel confident that your add-on is the greatest achievement since the sandwich was invented. Now what? Make it available to the world! How? You can either share your content via the forums, or via the add-on server. Both methods are discussed below.

The Forum

The Wesnoth forums is a good way to distribute small creations, like single multiplayer maps. Larger creations, like multiplayer eras or campaigns, should be compressed before uploading them. Note that you may encounter a size limit on attachments.

Also, there is a legal announcement that you should read before distributing anything on the forum. Basically, by posting you say that you own the license to what you are posting, and that you are giving rights under a Gnu or Creative Commons license as stated on Wesnoth:Copyrights.

This option allows for feedback and is pretty easy for the content creators to do. However, it requires extra steps on the part of the downloader and limits the add-on's exposure to players who regularly visit the forum.

The Add-on Server

The add-on server is the preferred way to distribute your creations, but it is more suited for larger projects. It currently lacks advanced organization features such as reviewing (although it does have a filter text box), so adding hundreds of little things makes it harder to find anything. Basically, the server should not be used to post single maps, units, songs, or artwork, but map packs, campaigns, entire eras, music packs, and unit packs are fine.

In in order to publish and add-on to the server, you need to create a _server.pbl file inside your add-on's directory. Detailed instructions on the syntax of the file are located on the PblWML page. File _main.cfg is also required, even for resource addons.

Once you are ready to publish:

  • Open Wesnoth
  • Select Add-ons from the main menu
  • Connect to the default add-ons.wesnoth.org add-on server
  • In 1.12: Select your add-on, which will be the last entry in the list of add-ons. Then select Publish add-on: Your Add-on Name
  • In 1.14: In the "State" drop-down above the list, select "Publishable", and the list will show only your add-on. Select your add-on, then click on the shield icon with the upwards arrow.

Note: If you haven't included a passphrase in the _server.pbl file then Wesnoth will add a randomly-generated password to it. This password can be used to upload updates.

Note: By default, all files and folders inside the add-on's directory are uploaded, except those that begin with '.' and those that end in '~'. If you want to exclude any others, you may do so by creating a _server.ign file and listing within it the files or folders you wish not to be uploaded (see IGNFileFormat for more information).

Note: A command-line interface to publish add-ons exists for those who prefer it. The script is located in a path like "/share/wesnoth/data/tools/wesnoth_addon_manager" (may depend on your OS and wesnoth version).

License

Whenever you upload or update your add-on, you will have to confirm that it is licensed as required by

When a user downloads your add-on, it will include the ART_LICENSE that you included and a COPYING.txt file containing a copy of the GNU GPL version 2, signifying the content is licensed under such.

Version control distribution

Wesnoth hosts a SVN repository to allow content creators to collaborate with each other in developing their content. Several high-profile add-ons were developed using it, including a few that ultimately ended up in mainline.

Alternatively, you could create your own personal repository on a service such as GitHub. Several UMC authors such as shadowm, vultraz, and bumbadadabum have done this recently.

See Also