SuperTux source code

christ2go e11cdd3676 Add license headers 6 lat temu
.github 36105b3807 .github: add an issue template 8 lat temu
.travis 0ea5406835 Record upload urls (appveyor and travis) 7 lat temu
contrib 280d663a2f contrib: Archive Schroedinger's boxes (#390) patch 8 lat temu
data 3caac45c86 makepot.sh: merge credits.pot into messages.pot 6 lat temu
docs 8234d9c14f Icecrusher: Do not stop rising when there's an obstacle 8 lat temu
external 49f2dcd397 Update PhysFS to version 3.0.1 which fixes several security issues 7 lat temu
man 9324a91826 supertux/man/man6/supertux2.6: Fix a syntax error. 14 lat temu
mk 82f2979ef0 Cleanup windows build files 8 lat temu
src e11cdd3676 Add license headers 6 lat temu
tests 6c0eec1840 Add test for collision.cpp 8 lat temu
tools 6e8c948ff0 Set correct chmod flags on extract_strings.py 6 lat temu
.editorconfig ecf879928a tools: add .editorconfig (#424) 8 lat temu
.gitattributes 719d035065 Add gitattributes file 9 lat temu
.gitignore 6980bdccff Add Visual Studio Code project file to .gitignore. 7 lat temu
.gitmodules fa20949d26 data: remove submodule 8 lat temu
.mention-bot 7c09a68f43 .mention-bot: add configuration file 8 lat temu
.travis.yml 0ea5406835 Record upload urls (appveyor and travis) 7 lat temu
CMakeLists.txt 8c1d03f9d2 Make ds_store, icons, etc actually work! 7 lat temu
CODINGSTYLE b4c35c26ee Fix typo. 6 lat temu
CONTRIBUTING.md 57010ce4fb Update urls to use https 7 lat temu
Doxyfile.in 286a4f3b43 Integrate cmake and doxygen 8 lat temu
INSTALL.md 57010ce4fb Update urls to use https 7 lat temu
LICENSE.txt 1e5b57e303 Fixed Windows builds, also changed version numbering scheme (currently cannot handle archives) 9 lat temu
NEWS.md e2ecf3cba7 Release SuperTux v0.5.1 (stable, bugfix) 8 lat temu
README.md b62cd9603c Add Codacy badge 7 lat temu
appveyor.yml 57010ce4fb Update urls to use https 7 lat temu
appveyor64.yml 57010ce4fb Update urls to use https 7 lat temu
config.h.cmake 757132a36c Improve datadir handling; fixes #394 8 lat temu
configure d67e254c94 add autotools-like wrapper configure and Makefile 13 lat temu
makedist.sh 6dd9597f83 Use brackets instead of commas for shell commands. 7 lat temu
makepot.sh 3caac45c86 makepot.sh: merge credits.pot into messages.pot 6 lat temu
supertux2.appdata.xml a8b6943dce Add changelog for 0.3.5a 9 lat temu
supertux2.desktop 91225e285e Remove extension from icon name in desktop file (#743) 7 lat temu
version.cmake.in 93e7715818 Added support for source tarballs 9 lat temu
version.h.in 3dc79f987c Fix PACKAGE_VERSION being empty, add unit test case for that issue 9 lat temu

README.md

SuperTux

Codacy Badge Build Status AppVeyor Build Satus Coverity Scan Build Status Github All Releases

Description

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.

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.

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.)

Running the game

SuperTux makes use of proc to see where it is. In other words, it does not have any need to be installed and can be run from anywhere. This makes it possible to click in the executable in your filemanager (i.e. Konqueror or Nautilus) as opposed to many other Linux games.

Options can be reached from the menu, so you don't need to specify arguments, but if you want, type supertux2 --help to check the ones that are available. Also, notice that SuperTux saves the options, so it's often enough to specify them once. For example, fullscreen mode causes problems on some setups, so just run supertux2 --window and you should be set.

The game uses OpenGL to render the graphics. You will either need a CPU with about 1 GHz or an accelerated video card with recent graphics drivers.

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.

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.

Don't forget that you can get involved with the development at https://github.com/supertux/supertux, or get notified about the recent changes on Twitter @supertux_team

The End

Thanks for playing SuperTux.

The SuperTux Team