Contributing

If you would like to contribute to SuperTux, you should follow a series of instructions to make the process as hassle-free as possible for you and the developers.

Generic instructions

These instructions apply to every function you may want to adopt.

1. Join the SuperTux mailing list to stay up to date with recent developments.
2. Check out the latest SuperTux development version and compile it by following the instructions in the INSTALL file.
3. Modify or add something that is either listed in the TODO or seems useful to you.
4. Send your modified work to the mailing list.

The developers will review your work and, if they share your opinion about its usefulness, check it into the repository.

Artists

Please keep the size of the attachments to the mailing list as small as possible. The best way is to convert smaller graphics to PNG and larger ones into the JPEG format.

Hints:

• Little Guide for drawing tiles that tile properly
• Little Guide on the how to get the graphic style that is used in the game

Level designers

Your level should comply with the level guidelines set by the SuperTux team. See the Editor FAQ for some help on using the Supertux-sharp editor.

Programmers

You can knock down file sizes by only sending differences between the files. Subversion provides you with a useful feature to generate such files. If you e.g. want to post the changes you made to src/main.cpp, use the following command:

svn diff src/main.cpp > fix-year.patch

Now, you can attach fix-year.patch to an e-mail to the mailing list. If you want to apply a patch generated using svn diff, use the following command:

patch -p0 < fix-year.patch

See CreatingPatches for a detailed how-to.