Difference between revisions of "Distributing content"

From The Battle for Wesnoth Wiki
(License: removed wrong statement)
(The Add-on Server)
 
(28 intermediate revisions by 10 users not shown)
Line 1: Line 1:
== The Forum ==
+
{{Create}}
  
The [http://www.wesnoth.org/forum/ BFW forum] 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.
+
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!
 
 
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 licensing it under the [http://www.gnu.org/copyleft/gpl.html General Public License].
 
  
 
== The Add-on Server ==
 
== 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.
+
The add-on server is the preferred way to distribute your creations, whether it's a single map or a large campaign. The rules for publishing to the add-ons server are [https://forums.wesnoth.org/viewtopic.php?f=15&t=24320 here].
  
Once you are ready to publish, here is how you access the add-on server:
+
In in order to publish an 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. The <b>_main.cfg</b> file is also required, even for resource add-ons.
# Open Wesnoth
 
# Select "Add-ons" from the main menu
 
# Connect to the default ''add-ons.wesnoth.org'' add-on server
 
# Select "Publish add-on: ''Your Add-on Name''" (the last entry in the list of add-ons)
 
  
Anything you distribute on the server will be uploaded from and downloaded to the ''userdata''/data/add-ons directory regardless of what it is (units, maps, campaign, etc). For this reason, you need three things in the add-ons directory to distribute via the server:
+
Once you are ready to publish:
# A folder, for example MyCampaign
+
* Open Wesnoth
# A .cfg file MyCampaign/_main.cfg
+
* Select <b>Add-ons</b> from the main menu
# A .pbl file MyCampaign/_server.pbl
+
* Connect to the default <i>add-ons.wesnoth.org</i> add-on server
Note that only the contents of your add-on directory (in this case, MyCampaign) will get uploaded, nothing else, so you need to have all the necessary files inside that directory.
+
* 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.
  
The following files and directories will not be uploaded: those that begin with '.' and those that end in '~'. Also, the GNU GPL version 2 will be added in the file COPYING.txt.
+
<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 Reading ====
+
<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).
* Maps - see [[BuildingMaps|Building Maps]]
 
** [[BuildingMapsDistribution|About distributing map-packs]]
 
* Campaign - see [[BuildingCampaigns|Building Campaigns]]
 
** [[BuildingCampaignsDistribution|About distributing campaigns]]
 
* Multiplayer era - see [[BuildingFactions#Adding_a_whole_new_era_with_its_own_factions_-_modular|Building MP Era]]
 
* Unit pack - see [[BuildingUnits#Distributing_your_unit|Building Units]]
 
  
 
==== License ====
 
==== License ====
Whenever you upload or update your content pack, you will have to say "OK" to this statement: "All add-ons uploaded to this server must be licensed under the terms of the GNU General Public License (GPL). By uploading content to this server, you certify that you have the right to place the content under the conditions of the GPL, and choose to do so."
+
 
 +
Whenever you upload or update your add-on, you will have to confirm that it is licensed as required by
 +
* [[Wesnoth:Copyrights#User_Made_Content_-_Code]] and
 +
* [[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.
 +
 
 +
== The Forum ==
 +
 
 +
Creating a thread on the [http://www.wesnoth.org/forum/ Wesnoth forums] is a good way to receive feedback for your add-on.  Making use of the [feedback] tag in your <b>_server.pbl</b> is also highly recommended.
 +
 
 +
While it is possible to upload your add-on directly to the forums, that is not recommended since it requires extra steps on the part of the downloader and limits the add-on's exposure to players who regularly visit the forum.
 +
 
 +
== Version control distribution ==
 +
 
 +
It is recommended that you create your own personal repository on a service such as [https://github.com/ GitHub]. This will allow tracking changes you make to your content, as well as make it easier for others to collaborate with you.
  
 
== See Also ==
 
== See Also ==
  
 
* [[Create]]
 
* [[Create]]
* [[BuildingMapsDistribution]]
 
* [[BuildingCampaignsDistribution]]
 
* [[BuildingCampaignsThePBLFile]]
 
 
* [[PblWML]]
 
* [[PblWML]]
 
* [[IGNFileFormat]]
 
* [[IGNFileFormat]]
 
* [[Wesnoth:Copyrights]]
 
* [[Wesnoth:Copyrights]]
 +
* [[Guide_to_UMC_Campaigns|Guide to UMC Campaigns]]
  
 
[[Category:Create]]
 
[[Category:Create]]

Latest revision as of 02:50, 11 May 2020


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!

The Add-on Server

The add-on server is the preferred way to distribute your creations, whether it's a single map or a large campaign. The rules for publishing to the add-ons server are here.

In in order to publish an 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. The _main.cfg file is also required, even for resource add-ons.

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.

The Forum

Creating a thread on the Wesnoth forums is a good way to receive feedback for your add-on. Making use of the [feedback] tag in your _server.pbl is also highly recommended.

While it is possible to upload your add-on directly to the forums, that is not recommended since it requires extra steps on the part of the downloader and limits the add-on's exposure to players who regularly visit the forum.

Version control distribution

It is recommended that you create your own personal repository on a service such as GitHub. This will allow tracking changes you make to your content, as well as make it easier for others to collaborate with you.

See Also

This page was last edited on 11 May 2020, at 02:50.