SuperTux source code
Clone or download
Permalink
Failed to load latest commit information.
.github .github: add an issue template Mar 20, 2016
.travis Travis CI: Actually fix AppImage build Jul 25, 2018
.tx Add Transifex configuration Oct 25, 2018
contrib contrib: remove outdated, unofficial KDevelop project Jul 22, 2018
data Add path and text array editor icons Nov 12, 2018
external Use vcpkg for Windows dependencies in AppVeyor (#927) Nov 5, 2018
man/man6 supertux/man/man6/supertux2.6: Fix a syntax error. Mar 4, 2010
mk Use vcpkg for Windows dependencies in AppVeyor (#927) Nov 5, 2018
src Fix ShellExecute wanting a C string instead of an std::string Nov 15, 2018
tests Fix ObjectOption test case Nov 15, 2018
tools Fix include path in wrapper generator Oct 23, 2018
.editorconfig tools: add .editorconfig (#424) Jun 5, 2016
.gitattributes Added .sprite, .stf and .stwm to .gitattributes Aug 11, 2018
.gitignore Add Visual Studio Code project file to .gitignore. Apr 15, 2017
.gitmodules Add SDL_ttf submodule Sep 10, 2018
.travis.yml Use generic automake package Sep 26, 2018
CMakeLists.txt Fix configure error when compiling with -DENABLE_OPENGLES2 Nov 6, 2018
CODINGSTYLE.md Update CODINGSTYLE.md with info about if/for/while/switch Nov 13, 2018
CONTRIBUTING.md README: central Community section for getting in touch Jul 21, 2018
Doxyfile.in doxygen -u Doxyfile.in Jul 29, 2018
INSTALL.md Make freetype required, libraqm optional Oct 21, 2018
LICENSE.txt Fixed Windows builds, also changed version numbering scheme (currentl… Dec 1, 2015
NEWS.md Release SuperTux v0.5.1 (stable, bugfix) Nov 5, 2016
README.md README: Explain how to start SuperTux.app with Gatekeeper enabled Jul 21, 2018
appveyor.yml Use vcpkg for Windows dependencies in AppVeyor (#927) Nov 5, 2018
appveyor64.yml Use vcpkg for Windows dependencies in AppVeyor (#927) Nov 5, 2018
config.h.cmake Improve datadir handling; fixes #394 Jul 10, 2016
configure add autotools-like wrapper configure and Makefile Jan 21, 2012
makedist.sh Use brackets instead of commas for shell commands. Jun 4, 2017
makepot.sh Add plural translation function Jun 4, 2018
supertux2.appdata.xml Rewrote appdata file, included new screenshots, OARS rating, etc. Jul 17, 2018
supertux2.desktop Added SuperTux .svg icon Jul 17, 2018
supertux2.svg Increased SuperTux icon size to 128x128 Jul 19, 2018
version.cmake.in Added support for source tarballs Dec 10, 2015
version.h.in Fix PACKAGE_VERSION being empty, add unit test case for that issue Dec 20, 2015

README.md

SuperTux

Build Status AppVeyor Build Satus Github All Releases

SuperTux is a jump'n'run game with strong inspiration from the Super Mario Bros. games for the various Nintendo platforms.

Run and jump through multiple worlds, fighting off enemies by jumping on them, bumping them from below or tossing objects at them, grabbing power-ups and other stuff on the way.

Screenshot

Story: Penny gets captured!

Tux and Penny were out having a nice picnic on the ice fields of Antarctica. Suddenly, a creature jumped from behind an ice bush, there was a flash, and Tux fell asleep!

When Tux wakes up, he finds that Penny is missing. Where she lay before now lies a letter. "Tux, my arch enemy!" says the letter. "I have captured your beautiful Penny and have taken her to my fortress. The path to my fortress is littered with my minions. Give up on the thought of trying to reclaim her, you haven't got a chance! -Nolok"

Tux looks and sees Nolok's fortress in the distance. Determined to save his beloved Penny, he begins his journey.

Installation

For major platforms, stable releases are built and available for download from supertux.org or alternatively directly from GitHub. You should be able to install these using default tools provided by your platform. On macOS, when Gatekeeper is enabled (default) it will refuse to open SuperTux. This is due to the lack of a signature on the application. If you wish to open SuperTux anyway without disabling the Gatekeeper feature entirely, you can open the application from the context menu (control click on the icon). macOS will then remember your choice the next time.

Documentation

Important documentation for SuperTux is contained in multiple files. Please see them:

  • INSTALL.md - Requirements, compiling and installing.
  • README.md - This file
  • NEWS.md - Changes since the previous versions of SuperTux.
  • LICENSE.txt - The GNU General Public License, under whose terms SuperTux is licensed. (Most of the data subdirectory is also licensed under CC-by-SA)
  • docs/levelguidelines.txt - Very useful information for those that want to design levels for SuperTux.
  • data/credits.stxt - Credits for people that contributed to the creation of SuperTux. (You can view these in the game menu as well.)

Playing the game

Both keyboards and joysticks/gamepads are supported. You can change the controls via the Options menu. Basically, the only keys you will need to use in-game are to do the following actions: jump, duck, right, left, action and 'P' to pause/unpause the game. There isn't much to tell about the first few, but the "action" key allows you to pick up objects and use any powerup you got. For instance, with the fire flower, you can shoot fireballs, or with the ice flower fire ice pellets.

Other useful keys include the Esc key, which is used to go to the menu or to go up a level in the menu. The menu can be navigated using the arrow keys or the mouse.

In the worldmap, the arrow keys are used to navigate and Enter to enter the current level.

Community

In case you need help, feel free to reach out using the following means:

  • IRC: #supertux on freenode hosts most of the discussions between developers. Also, real-time support can be provided here. If you don't know how to use an IRC client, you access the channel using a web-based client. Please stay around after asking questions, otherwise you will be disconnected and might miss potential answers.
  • Matrix: #supertux:matrix.org is bridged to our IRC room.
  • Forum: The SuperTux community is very active on the forum, the discussion ranges from feature proposals to support questions. In particular, most community-contributed add-ons are published there first, so this is worth checking.
  • Mailing Lists: The supertux-devel mailing list is intended for development purposes. However, it is not very active at the moment.
  • Social Media: Mostly on Twitter at the moment.

Development status

With the release of SuperTux 0.4.0 (December 2015), we wanted to provide a fairly stable release. The release of SuperTux 0.5.0 should have fixed some stability issues from 0.4.0 and introduced a new level editor. Development of the game will continue (of course), now working towards more releases. Most notably, development focus will be shifted on providing a better gameplay experience.

The Forest World (you can check it out: Start Game > Contrib Levels > Forest World) is relatively unstable, which is why it resides only in the contrib levels menu. We (SuperTux Team) intend to continue with the development of the Forest World, but decided that in order to allow more access to the most recent version (in repositories etc.) we would have to release Milestone 2 without the Forest World included in the Story Mode. Constructive feedback with regards to the Forest World is welcome.