SuperTux source code

serano01 c1a4284131 Adjust mushroom decals %!s(int64=2) %!d(string=hai) anos
.ci_scripts b8a8d54af6 Fixed name problem for generated AppImages (#1962) %!s(int64=2) %!d(string=hai) anos
.github 8753faccf0 Added JPEG support to WASM builds (#1984) %!s(int64=2) %!d(string=hai) anos
.tx f02a0d603d Remove incubator translation files from transifex config [ci skip] %!s(int64=4) %!d(string=hai) anos
contrib ec0a078502 contrib: remove outdated, unofficial KDevelop project %!s(int64=6) %!d(string=hai) anos
data c1a4284131 Adjust mushroom decals %!s(int64=2) %!d(string=hai) anos
external 100bc052bc Added add-on creator (#1890) %!s(int64=3) %!d(string=hai) anos
man 9324a91826 supertux/man/man6/supertux2.6: Fix a syntax error. %!s(int64=14) %!d(string=hai) anos
mk ced4ff6e1a Fixed broken Ubuntu Touch zlib package %!s(int64=3) %!d(string=hai) anos
src 04d2ff29d3 Fix path node flipping (#1971) %!s(int64=2) %!d(string=hai) anos
tests c9aa1c4c00 Add test for IFileStream %!s(int64=3) %!d(string=hai) anos
tools a6f7b48e2c Add CFBundleShortVersionString property to info.plist %!s(int64=3) %!d(string=hai) anos
.clang-tidy 5cb721bc18 Fix some more clang-tidy warnings %!s(int64=5) %!d(string=hai) anos
.editorconfig ecf879928a tools: add .editorconfig (#424) %!s(int64=8) %!d(string=hai) anos
.gitattributes af36e7a45a Change .gitattributes (#1096) %!s(int64=5) %!d(string=hai) anos
.gitignore 0b0f7d671d Add Nix flake build file %!s(int64=3) %!d(string=hai) anos
.gitmodules e3ec3ef7fa Remove external/googletest leftovers %!s(int64=3) %!d(string=hai) anos
CMakeLists.txt b3671c40d6 Really removed Discord's example programs from the build (#1988) %!s(int64=2) %!d(string=hai) anos
CODINGSTYLE.md 37e465f1c1 Add link to C++ Core Guidelines to CODINGSTYLE.md %!s(int64=5) %!d(string=hai) anos
CONTRIBUTING.md c7c2ddf1ef README: central Community section for getting in touch %!s(int64=6) %!d(string=hai) anos
Doxyfile.in 17820af0e8 doxygen -u Doxyfile.in %!s(int64=6) %!d(string=hai) anos
INSTALL.md 4b073c1ca4 Improvements to INSTALL.md + added WASM/Ubuntu Touch instructions (#1976) %!s(int64=2) %!d(string=hai) anos
LICENSE.txt a9e0d669b9 Revert "Update LICENSE.txt" %!s(int64=6) %!d(string=hai) anos
NEWS.md fdff793548 Release SuperTux 0.6.2 (final; stable release) %!s(int64=4) %!d(string=hai) anos
README.md 5e50a35e67 Add link to maillist archive (found by Vankata453) [ci skip] %!s(int64=2) %!d(string=hai) anos
config.h.cmake a17b8b15e9 Beginning of the WASM port %!s(int64=3) %!d(string=hai) anos
configure d67e254c94 add autotools-like wrapper configure and Makefile %!s(int64=13) %!d(string=hai) anos
flake.lock 0b0f7d671d Add Nix flake build file %!s(int64=3) %!d(string=hai) anos
flake.nix 0b0f7d671d Add Nix flake build file %!s(int64=3) %!d(string=hai) anos
guix.scm 7187e3f6d7 Add glm library dependency %!s(int64=3) %!d(string=hai) anos
makedist.sh 5a9aa5698b Hopefully correct revision information for non-Windows builds %!s(int64=4) %!d(string=hai) anos
makepot.sh 47f4493ed6 Fix makepot.sh to not generate -i files [ci skip] [skip ci] %!s(int64=4) %!d(string=hai) anos
supertux2.appdata.xml 35c3e622f8 Add missing releases to appdata file %!s(int64=4) %!d(string=hai) anos
supertux2.desktop.in b5a86ce8d5 Major improvements to UBports build (#1705) %!s(int64=3) %!d(string=hai) anos
supertux2.svg b50fa77d1c Increased SuperTux icon size to 128x128 %!s(int64=6) %!d(string=hai) anos
version.cmake.in b5a86ce8d5 Major improvements to UBports build (#1705) %!s(int64=3) %!d(string=hai) anos
version.h.in b5a86ce8d5 Major improvements to UBports build (#1705) %!s(int64=3) %!d(string=hai) anos

README.md

SuperTux

Build 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! 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)
  • 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 Libera Chat 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 dead. Here is the archive.
  • Social Media: Mostly on Twitter at the moment.
  • Discord: Also, you can join our Discord server to get in touch with us.

Development status

As of now, with the release of SuperTux 0.6.2 (May 2020), the Forest World is almost finished, since the ghost forest section has been included. However, some levels, especially the Ghostree Level, are considered to be placeholders, because for the next version (0.7.0) a great overhaul is planned with new features like reworked boss fights, graphics, and worlds. If you have some Constructive Feedback, Contributions or ideas to share, don't hestitate to contact us with one of the possibilities given above.