Difference between revisions of "Distributing content"

From The Battle for Wesnoth Wiki
Line 1: Line 1:
 +
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 multiplayer eras 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 licensing it under the [http://www.gnu.org/copyleft/gpl.html General Public License].
 
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].
 +
 +
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 ==
Line 9: Line 13:
 
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, 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 add-on 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 as well as [[BuildingCampaignsThePBLFile]].
# 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 ''[[EditingWesnoth#Where_is_my_user_data_directory.3F|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.pbl ''or'' 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.
+
* Select <b>Publish add-on: <i>Your Add-on Name</i></b> (the last entry in the list of add-ons)
  
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> 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 folder you wish not to be uploaded (see [[IGNFileFormat]] for more information).  
  
==== General Reading ====
+
==== License ====
* [[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 ====
+
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."
* Maps - see [[BuildingMaps|Building Maps]]
 
* 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 ====
+
When a user downloads your add-on, it will include a COPYING.txt file containing a copy of the GNU GPL version 2, signifying the content is licensed under such.
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."
 
  
 
== See Also ==
 
== See Also ==

Revision as of 21:40, 11 March 2014

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 licensing it under the General Public License.

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 as well as BuildingCampaignsThePBLFile.

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
  • Select Publish add-on: Your Add-on Name (the last entry in the list of add-ons)

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 folder you wish not to be uploaded (see IGNFileFormat for more information).

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."

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

See Also