SuperTux source code

Tobias Markus 44a95324ba Retain alpha value making backgrounds darker 1 day ago
.ci_scripts 7ee1f6b4de Run macOS CI on `macos-12` 1 month ago
.github 176f8bc08b Fix scripting and wiki workflows [ci skip] 1 month ago
.tx cbb20d9cc9 Update transifex config to latest version 7 months ago
contrib ec0a078502 contrib: remove outdated, unofficial KDevelop project 5 years ago
data 490bfaf6ba ST OST - Yet more songs for the Icy Island (#2823) 1 week ago
external 3e405fe0a6 update sdl_ttf 1 month ago
man 678df3cece Updated the manual pages (#1989) 2 years ago
mk 59f210b124 Ignore reserved indentifier warnings (#2826) 1 week ago
src 44a95324ba Retain alpha value making backgrounds darker 1 day ago
tests 97c59b4104 Rename `Rectf::contains(const Rectf&)` to `Rectf::overlaps(const Rectf&)` to reflect what this method actually does (#2734) 2 months ago
tools fcfb3220f3 Use Miniswig from external submodule (#2440) 11 months ago
.clang-tidy 5cb721bc18 Fix some more clang-tidy warnings 5 years ago
.editorconfig ecf879928a tools: add .editorconfig (#424) 7 years ago
.gitattributes af36e7a45a Change .gitattributes (#1096) 4 years ago
.gitignore 276fde3d12 Auto-generate scripting reference (#2434) 11 months ago
.gitmodules 0dc40254b5 Fix WASM builds 9 months ago
CMakeLists.txt f0695244df Fix building on MSYS2 (CLANG64) (#2822) 1 week ago
CODINGSTYLE.md 5ddc70c658 typo 1 month ago
CONTRIBUTING.md c7c2ddf1ef README: central Community section for getting in touch 5 years ago
Doxyfile.in 17820af0e8 doxygen -u Doxyfile.in 5 years ago
INSTALL.md 0dc40254b5 Fix WASM builds 9 months ago
LICENSE.txt a9e0d669b9 Revert "Update LICENSE.txt" 5 years ago
NEWS.md c1ddb4f28c Release SuperTux 0.6.3 (stable, bugfix) 2 years ago
README.md 2e08c1b7fa hestitate -> hesitate in README.md [ci skip] (#2809) 3 weeks ago
clickable.yaml a4d0d323de Fixes and updates for Ubuntu Touch port (#2510) 8 months ago
config.h.cmake d6265b08e4 Remove redundant _SQ64 define 2 years ago
configure d67e254c94 add autotools-like wrapper configure and Makefile 12 years ago
flake.lock 29541ae3e5 Update Nix flake to use packages.${system}.default 1 year ago
flake.nix 2014263b34 Remove boost references in some files (#2703) 3 months ago
guix.scm 2014263b34 Remove boost references in some files (#2703) 3 months ago
makedist.sh 835386b0c5 Update Freedesktop Metainfo (#2684) 4 months ago
makepot.sh 47f4493ed6 Fix makepot.sh to not generate -i files [ci skip] [skip ci] 3 years ago
org.supertuxproject.SuperTux.metainfo.xml 835386b0c5 Update Freedesktop Metainfo (#2684) 4 months ago
supertux2.desktop.in b5a86ce8d5 Major improvements to UBports build (#1705) 3 years ago
supertux2.svg b50fa77d1c Increased SuperTux icon size to 128x128 5 years ago
version.cmake.in b5a86ce8d5 Major improvements to UBports build (#1705) 3 years ago
version.h.in 41356f078a World-specific custom title screen levels (#2667) 3 months ago

README.md

SuperTux

Windows MacOS GNU/Linux Android WebAssembly Ubuntu Touch 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.3 (December 2021), 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 hesitate to contact us with one of the possibilities given above.