ReTux

Getting Started

Table of Contents

  1. Pre-Requisites
  2. The Basics

Pre-Requisites

Before you start making levels for ReTux, you will need to download Tiled version 1.0 or later (version 1.0 is necessary so that you can export the Tiled JSON format, which ReTux uses). You can download Tiled from its official website here.

You will also need ReTux. You will be using a copy of ReTux as a level editing environment.

While not entirely necessary, you should import ReTux's object types into Tiled. Do this by going to the Object Types Editor (in the View menu), selecting "Import Object Types" from the File menu of the Object Types Editor, and choosing "objecttypes.xml" from the ReTux data directory. This will cause Tiled to autocomplete object types and also provide a color guide.

The Basics

Levels and worldmaps for ReTux are created using Tiled. This guide will not explain how using Tiled itself works; please see Tiled's documentation for that. Instead, this guide will assume you basically know how to use Tiled and explain only the specifics of using it for ReTux.

In addition to the levels and worldmaps themselves, there are some JSON-formatted text files needed for certain things. These will be explained in detail later. Any text editor can be used to create and modify these files. As with use of Tiled, this guide will not go into depth on the syntax of JSON files, but the format is relatively straightforward and examples are available.

To make creation of levels and worldmaps easier, ReTux comes with template files to build off of. These are data/levels/base.json, and data/worldmaps/base.json. To create a new level, start by opening data/levels/base.json in Tiled and saving it under a different name you wish to use for the level. To create a new worldmap, start by opening data/worldmaps/base.json in Tiled and saving it under a different name you wish to use for the worldmap.

ReTux does not impose any particular requirements for the file names of levels, but two levels or two worldmaps cannot have the same name, so it is highly recommended that you choose a name that someone else is not likely to choose. The file names of the levels and worldmaps are never visible to the player under normal circumstances, so they do not need to be nice-looking or informative. A suggested convention is something like "author-levelset-xx.tmx", where "author" is your name or alias, "levelset" is a shortened version of the name of the corresponding levelset, and "xx" is the level or worldmap number.

It is also highly recommended to never use upper-case letters in any file names. This is recommended to avoid accidentally causing problems for other people related to case-sensitivity of file systems.