SuperTux source code

weluvgoatz 61d68e6e8b Re-add backflip rotation (#1796) 20 hours ago
.ci_scripts 40ab22f632 Fixed AppImage exec format error 5 months ago
.github 629bf5a3c8 Fix for WASM builds (#1794) 5 days ago
.tx f02a0d603d Remove incubator translation files from transifex config [ci skip] 1 year ago
contrib ec0a078502 contrib: remove outdated, unofficial KDevelop project 3 years ago
data a1cc6fd033 Cutscene audio fix (#1795) 5 days ago
external b4a1920bf6 Replace external/googletest with external dependency 3 months ago
man 9324a91826 supertux/man/man6/supertux2.6: Fix a syntax error. 11 years ago
mk c483f3a21e Fixed Clickable (Ubuntu Touch) builds 5 days ago
src 61d68e6e8b Re-add backflip rotation (#1796) 20 hours ago
tests c9aa1c4c00 Add test for IFileStream 2 months ago
tools a6f7b48e2c Add CFBundleShortVersionString property to info.plist 2 months ago
.clang-tidy 5cb721bc18 Fix some more clang-tidy warnings 2 years ago
.editorconfig ecf879928a tools: add .editorconfig (#424) 5 years ago
.gitattributes af36e7a45a Change .gitattributes (#1096) 2 years ago
.gitignore 50a03f1888 Added workflow for Ubuntu Touch (UBports) (#1655) 5 months ago
.gitmodules e3ec3ef7fa Remove external/googletest leftovers 3 months ago
CMakeLists.txt 629bf5a3c8 Fix for WASM builds (#1794) 5 days ago
CODINGSTYLE.md 37e465f1c1 Add link to C++ Core Guidelines to CODINGSTYLE.md 2 years ago
CONTRIBUTING.md c7c2ddf1ef README: central Community section for getting in touch 3 years ago
Doxyfile.in 17820af0e8 doxygen -u Doxyfile.in 3 years ago
INSTALL.md 2f6873e874 Add GLM dependency to INSTALL.md (#1780) 3 weeks ago
LICENSE.txt a9e0d669b9 Revert "Update LICENSE.txt" 2 years ago
NEWS.md fdff793548 Release SuperTux 0.6.2 (final; stable release) 1 year ago
README.md cccd576806 SuperTux has moved from Freenode to Libera Chat. (#1765) 1 month ago
config.h.cmake a17b8b15e9 Beginning of the WASM port 4 months ago
configure d67e254c94 add autotools-like wrapper configure and Makefile 9 years ago
guix.scm 7187e3f6d7 Add glm library dependency 2 months ago
makedist.sh 5a9aa5698b Hopefully correct revision information for non-Windows builds 10 months ago
makepot.sh 47f4493ed6 Fix makepot.sh to not generate -i files [ci skip] [skip ci] 1 year ago
supertux2.appdata.xml 35c3e622f8 Add missing releases to appdata file 1 year ago
supertux2.desktop.in b5a86ce8d5 Major improvements to UBports build (#1705) 4 months ago
supertux2.svg b50fa77d1c Increased SuperTux icon size to 128x128 3 years ago
version.cmake.in b5a86ce8d5 Major improvements to UBports build (#1705) 4 months ago
version.h.in b5a86ce8d5 Major improvements to UBports build (#1705) 4 months ago

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 with no backups, unfortunately. If you have archived (most of) the list please upload it somewhere and send us a link.
  • 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.