SuperTux source code

Jacob Burroughs 4cbadb6719 Reduce excessive output verbosity 7 years ago
.github 36105b3807 .github: add an issue template 8 years ago
.travis 8119fb711c Improve travis deployment 7 years ago
contrib 280d663a2f contrib: Archive Schroedinger's boxes (#390) patch 8 years ago
data @ f80454aa5f fb381ec7ad Update data submodule 7 years ago
docs 8234d9c14f Icecrusher: Do not stop rising when there's an obstacle 7 years ago
external de93cc819a Add addons with precedence to the tinygettext search path. 7 years ago
man 9324a91826 supertux/man/man6/supertux2.6: Fix a syntax error. 14 years ago
mk 82f2979ef0 Cleanup windows build files 7 years ago
src 2654a985c7 Prevent statistics text from overlapping 7 years ago
tests 3cbea51800 Add tests for aatriangle.cpp 7 years ago
tools 82f2979ef0 Cleanup windows build files 7 years ago
translations @ 0f7233f805 c68ce07c05 Update data and translations submodules 7 years ago
.editorconfig ecf879928a tools: add .editorconfig (#424) 8 years ago
.gitattributes 719d035065 Add gitattributes file 8 years ago
.gitignore 1f0a44d235 CMakeLists.txt: generate Doxyfile from Doxyfile.in with correct version number 7 years ago
.gitmodules c0b3af6d78 Use to external physfs if necessary 8 years ago
.mention-bot 7c09a68f43 .mention-bot: add configuration file 7 years ago
.travis.yml 4a1a1a53d0 Disable setting release as draft 7 years ago
CMakeLists.txt 4cbadb6719 Reduce excessive output verbosity 7 years ago
CODINGSTYLE 6442318bc6 CODINGSTYLE: document translator comments 7 years ago
CONTRIBUTING.md 4e1a4511f6 CONTRIBUTING: inform users of the ability to edit issues 8 years ago
Doxyfile.in 286a4f3b43 Integrate cmake and doxygen 7 years ago
INSTALL.md 0151fd08bc Add changes from PR-586 7 years ago
LICENSE.txt 1e5b57e303 Fixed Windows builds, also changed version numbering scheme (currently cannot handle archives) 8 years ago
NEWS.md 2f1692e48f Release SuperTux v0.5.0-rc.4 (release candidate, unstable) 7 years ago
README.md 37f603bf9c Fix URL 7 years ago
appveyor.yml 5aea837a76 Temporary appveyor fix to allow releases to be pushed to github; better fix TODO 7 years ago
appveyor64.yml 5aea837a76 Temporary appveyor fix to allow releases to be pushed to github; better fix TODO 7 years ago
config.h.cmake 757132a36c Improve datadir handling; fixes #394 7 years ago
configure d67e254c94 add autotools-like wrapper configure and Makefile 12 years ago
extract_strings.py c1f284e8d7 Replace custom iterator with enumerate, thanks, leyyin [ci skip] 8 years ago
makedist.sh da28455afb makedist.sh: don't strip off too much of the version string 7 years ago
makepot.sh 9dcaa48733 makepot.sh: remove unnecessary code 7 years ago
supertux2.appdata.xml a8b6943dce Add changelog for 0.3.5a 9 years ago
supertux2.desktop b85a897dab Update desktop menu entry file to conform to XDG specs 9 years ago
version.cmake.in 93e7715818 Added support for source tarballs 8 years ago
version.h.in 3dc79f987c Fix PACKAGE_VERSION being empty, add unit test case for that issue 8 years ago

README.md

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

SuperTux - http://supertuxproject.org/

Last update: December 20, 2015

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.txt - 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 Milestone 2 (December 2015), we hope to provide a fairly stable release. Development of the game will continue (of course), now working towards a Milestone 3 release.

The Forest World (you can check it out: Start Game > Contrib Levels > Forest World) is notably 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.

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

The End

Thanks for playing SuperTux.

The SuperTux development team