SuperTux source code

der-hahn 6697d02af7 Fixing (#3335) 4 dagar sedan
.ci_scripts 2a26a5ea38 CMake Refactor (#3093) 1 månad sedan
.github 2a26a5ea38 CMake Refactor (#3093) 1 månad sedan
.tx 149a2ce160 Remove translation files for removed bonus islands 6 månader sedan
data 7e6cf8d2bf Update translations 5 dagar sedan
external 2a26a5ea38 CMake Refactor (#3093) 1 månad sedan
man 678df3cece Updated the manual pages (#1989) 3 år sedan
mk 2f7d44a9f1 Rename output windows msi (#3330) 2 veckor sedan
src 6697d02af7 Fixing (#3335) 4 dagar sedan
tests 2a26a5ea38 CMake Refactor (#3093) 1 månad sedan
tools 9ee7976cb5 Scripting reference: Format both "Summary" and "Instances" 8 månader sedan
.clang-tidy 5cb721bc18 Fix some more clang-tidy warnings 6 år sedan
.editorconfig ecf879928a tools: add .editorconfig (#424) 9 år sedan
.gitattributes af36e7a45a Change .gitattributes (#1096) 6 år sedan
.gitignore 2a26a5ea38 CMake Refactor (#3093) 1 månad sedan
.gitmodules 2a26a5ea38 CMake Refactor (#3093) 1 månad sedan
CMakeLists.txt 2a26a5ea38 CMake Refactor (#3093) 1 månad sedan
CODINGSTYLE.md b219059e70 Removed EOF naming convention at end of file every file and replaced #ifdef include guards with #pragma once. (#3300) 1 månad sedan
CONTRIBUTING.md b6c970d021 Improve CONTRIBUTING.md 1 år sedan
INSTALL.md 2a26a5ea38 CMake Refactor (#3093) 1 månad sedan
LICENSE.txt a9e0d669b9 Revert "Update LICENSE.txt" 6 år sedan
NEWS.md c1ddb4f28c Release SuperTux 0.6.3 (stable, bugfix) 3 år sedan
README.md 0fe57d4c98 Update README.md 1 månad sedan
clickable.yaml 2a26a5ea38 CMake Refactor (#3093) 1 månad sedan
config.h.in 2a26a5ea38 CMake Refactor (#3093) 1 månad sedan
configure d67e254c94 add autotools-like wrapper configure and Makefile 13 år sedan
flake.lock 29541ae3e5 Update Nix flake to use packages.${system}.default 3 år sedan
flake.nix 2014263b34 Remove boost references in some files (#2703) 1 år sedan
guix.scm 2014263b34 Remove boost references in some files (#2703) 1 år sedan
makedist.sh 835386b0c5 Update Freedesktop Metainfo (#2684) 1 år sedan
makepot.sh 7a46298160 makepot.sh: Specify source character encoding as UTF-8 1 månad sedan
org.supertuxproject.SuperTux.metainfo.xml 835386b0c5 Update Freedesktop Metainfo (#2684) 1 år sedan
supertux2.desktop.in 9d53e3d7eb Add `StartupWMClass` to desktop file (#3253) 3 månader sedan
supertux2.svg b50fa77d1c Increased SuperTux icon size to 128x128 7 år sedan
vcpkg.json 2a26a5ea38 CMake Refactor (#3093) 1 månad sedan
version.h.in 2a26a5ea38 CMake Refactor (#3093) 1 månad sedan

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 also active on the forum, the discussions range from feature proposals to support questions. In particular, most community-contributed add-ons are published there, 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.