SuperTux source code

Hume2 8e265f9f25 New level data/levels/world2/ghosts_wasteland.stl 8 years ago
.github 36105b3807 .github: add an issue template 8 years ago
.travis 17bc5a00ea Correct source build to only build on one system at once 8 years ago
contrib 764b8411d0 update supertux-coop.diff 14 years ago
data 8e265f9f25 New level data/levels/world2/ghosts_wasteland.stl 8 years ago
docs 77521ae95d Change email address in SuperTux.appdata.xml file 10 years ago
external 75b06ed66b Update tinygettext to latest supertux-changes branch HEAD 8 years ago
man 9324a91826 supertux/man/man6/supertux2.6: Fix a syntax error. 14 years ago
mk 32c300d4cd Add UCRT to Windows installer 8 years ago
src 417a8e7a8c Use alSourceRewindv instead of alSourceStop 8 years ago
tests fb71a00edf Merge branch 'master' into develop 8 years ago
tools 510d6debcb Add null check to miniswig wrapper, should fix #327 8 years ago
translations @ e5f80ded97 05f4ec0a9d Add more gradient functionalities to test level 8 years ago
.gitattributes 719d035065 Add gitattributes file 8 years ago
.gitignore 93e7715818 Added support for source tarballs 8 years ago
.gitmodules 59ede11d10 Revert "Replace data directory with a reference to the data submodule" 8 years ago
.travis.yml b4c372c318 Fix silly syntax error 8 years ago
CMakeLists.txt 9621bcc658 Merge pull request #359 from const86/master 8 years ago
CODINGSTYLE dc2aba2805 Added another note about comments to CODINGSTYLE 9 years ago
CONTRIBUTING.md 4e1a4511f6 CONTRIBUTING: inform users of the ability to edit issues 8 years ago
Doxyfile 85b7f642ad Release SuperTux 0.4.0 (stable) 8 years ago
INSTALL.md 82591e1d92 Revert "INSTALL.md Mentions Nightly Builds by maths22" 8 years ago
LICENSE.txt 1e5b57e303 Fixed Windows builds, also changed version numbering scheme (currently cannot handle archives) 8 years ago
NEWS.md ad6df7e2d8 Small syntax fix in NEWS.md 8 years ago
README.md 2dc472183f Remove recommendation of proprietary drivers in README 8 years ago
appveyor.yml 32c300d4cd Add UCRT to Windows installer 8 years ago
config.h.cmake aeb197db9c Tweak CMakeLists and physfs initialization a bit to eliminate redundant APPDATADIR setting 14 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 74baa6081b makedist: leftover from previous version of the script 8 years ago
makepot.sh 2ab69c7fb0 Replace \r\n with \n in source strings 8 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

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