Getting Started

Avatar

By ShadowApex 15 Sep 2014 20:40

Lead Developer · 374 comments

In Tuxemon, you can choose to contribute to the official campaign which has its own detailed and established universe, or you can choose to contribute your own custom community created campaign that others can download and enjoy. Maps and campaigns of either variety can be created using the free and open source Tiled map editor.

To get started, take a look at some of the tutorials detailed on the Tuxemon wiki:

Tutorials


How to I contribute maps & campaigns?


You can contribute your map or campaign by posting in the Map & Campaign Development forum with a link to your map files and custom tilesets or by opening a pull request on GitHub. If you want to contribute maps to be included with the official Tuxemon campaign, let us know and we can review the map for potential inclusion in the main campaign.

If you're not contributing through GitHub, when you create a new map, be sure to zip up your map and tilesets in the following folder format:

map-folder-structure.png

Important Note

When adding your tileset images to maps in Tiled, make sure when you put your images in the correct folder structure before adding them in Tiled. This will make sure that the image paths are set up correctly in the map file. If you don't do this, you'll need to manually edit the .tmx file using a text editor (such as notepad) and change the tileset image source to a relative path, so they will work correctly in Tuxemon. Since the absolute path won't exist on most people's computers, Tuxemon (and Tiled) will fail to load these tileset images if you don't use the correct relative path.

Here is an example of using the correct and incorrect paths to a tileset if you open the map using a text editor like notepad:

Correct

...
<tileset firstgid="1" name="setPiecesTSR_LUKE83" tilewidth="16" tileheight="16">
  <image source="../gfx/tilesets/setPiecesTSR_LUKE83.png" width="671" height="512"/>
</tileset>
...

Incorrect
...
<tileset firstgid="1" name="setPiecesTSR_LUKE83" tilewidth="16" tileheight="16">
  <image source="/home/paul/Downloads/tuxemon-current/tuxemon/resources/gfx/tilesets/setPiecesTSR_LUKE83.png" width="671" height="512"/>
</tileset>
...