Before you create or contribute anything for SuperTuxKart, you should read the official documentation available for your type of contribution. For your convenience, the guideline articles along with a brief summary of some of the content within are listed below. However, reading all the relevant documentation is strongly recommended!
General
ToDo
Milestones
Long term ideas
Artwork/3D Modeling/Audio
Licensing Information
Not very exciting, but if you don't consider this information, anything you make we will be unable to use for STK. This is a must-read if you don't want to waste time making art we will be unable to use legally
Visual Art Style Guidelines
The SuperTuxKart environment is generally meant to be light and/or colorful and/or comic-like. Avoid using textures where you can easily see the tiling/repetitions and easy-to-spot repeating patterns. Try to keep an appropriate balance between high-poly and low-poly (see Making kart tutorial for details about karts). Also avoid very (and even moderately) steep slopes, as physics will have trouble with them.
For the main-package: karts should relate to a certain open-source mascot. Keep roughly the same size as the Tux kart (to be friendly with the physics engine; especially avoid making it thin and tall). We cannot accept tracks with unclear licensing terms (or textures not clearly licensed). Our license of choice is Creative-Commons-By-SA 3+. Please don't request us to add your track in the main package; first of all this is impolite, and second we will come to you when there is high-quality work But let not the main package be your only goal, sharing with the community is great too!
Music should be in ogg/vorbis (.ogg) format, and try to keep the music file size under 2-3 megabytes. We want most music to be light-hearted, but it is required that the music isn't 'aggressive'. Sound effects should be provided in some lossless format (e.g. wave) - we will convert them to ogg[/list]
Artwork/3D Modeling/Audio
Making tracks (for STK 0.7.3)
Making karts (for STK 0.7)
Programming
Source control
- Subscribe to the stk-development list (see Community).
- Do your best to write portable code.
- Commit frequently.
- Test your commits.
- 4 spaces, no tabs for layout.
- Both the opening and the closing braces should be on a line of their own.
- In header files try to align declaration and definitions in columns.
- Start with private declarations, then the public ones.
- Use Doxygen comments.
Translating
Translating STK
This overview does not contain every section, and should therefore not be used as sole reference. It can work as an introduction to the documentation at the SuperTuxKart wiki, but may not be sufficient in any other way. Please read more at the wiki before making contributions.