SuperTux source code

Alzter 698a28e2b3 New Snow Tiles 5 年 前
.github 36105b3807 .github: add an issue template 8 年 前
.travis 2b855e44e5 Fix s3 uploads 6 年 前
.tx 3d251434be Add Transifex configuration 6 年 前
contrib ec0a078502 contrib: remove outdated, unofficial KDevelop project 6 年 前
data 698a28e2b3 New Snow Tiles 5 年 前
external 579bf81041 Fix locale issue in sexp with -DSEXP_USE_LOCALE 5 年 前
man 9324a91826 supertux/man/man6/supertux2.6: Fix a syntax error. 14 年 前
mk 78c19dd0bf Remove local libraqm dependency 5 年 前
src 909e28ae4b Update music_object.cpp 5 年 前
tests 228538691f Add decimals to floatarray test 5 年 前
tools b58c370aa5 Fix sign comparison warning 5 年 前
.clang-tidy 5cb721bc18 Fix some more clang-tidy warnings 5 年 前
.editorconfig ecf879928a tools: add .editorconfig (#424) 8 年 前
.gitattributes af36e7a45a Change .gitattributes (#1096) 5 年 前
.gitignore 88b0c7fafe Add .vscode directory to .gitignore [appveyor skip] 5 年 前
.gitmodules 799645104e Add SDL_ttf submodule 6 年 前
.travis.yml 5da86c3d6c Use GLEW 2.1.0 instead of the outdated version from the repository 6 年 前
CMakeLists.txt 318585490f Link to boost targets (#1138) 5 年 前
CODINGSTYLE.md 37e465f1c1 Add link to C++ Core Guidelines to CODINGSTYLE.md 5 年 前
CONTRIBUTING.md c7c2ddf1ef README: central Community section for getting in touch 6 年 前
Doxyfile.in 17820af0e8 doxygen -u Doxyfile.in 6 年 前
INSTALL.md a86afa1e97 Updated url to building instructions (#1102) 5 年 前
LICENSE.txt a9e0d669b9 Revert "Update LICENSE.txt" 6 年 前
NEWS.md 6dec74e8ca Update NEWS.md to reflect release. 6 年 前
README.md cc61850bfe Update README.md 5 年 前
appveyor.yml d157ff7db3 Invalidate AppVeyor dependency caches 5 年 前
appveyor64.yml d157ff7db3 Invalidate AppVeyor dependency caches 5 年 前
config.h.cmake 757132a36c Improve datadir handling; fixes #394 8 年 前
configure d67e254c94 add autotools-like wrapper configure and Makefile 13 年 前
makedist.sh 6dd9597f83 Use brackets instead of commas for shell commands. 7 年 前
makepot.sh 4781f644b8 Add plural translation function 6 年 前
supertux2.appdata.xml 1d7d3970e1 Update supertux2.appdata.xml for 0.6.0 6 年 前
supertux2.desktop 3e27e15c2f Added SuperTux .svg icon 6 年 前
supertux2.svg b50fa77d1c Increased SuperTux icon size to 128x128 6 年 前
version.cmake.in 93e7715818 Added support for source tarballs 9 年 前
version.h.in 3dc79f987c Fix PACKAGE_VERSION being empty, add unit test case for that issue 9 年 前

README.md

SuperTux

Build Status AppVeyor Build Satus 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)
  • 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.)

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 freenode 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 intended for development purposes. However, it is not very active at the moment.
  • Social Media: Mostly on Twitter at the moment.

Development status

With the release of SuperTux 0.6.0 (December 2018), the Forest World finally found it's way back to the core part of the game. It's now considered stable, but it still misses the second half, which consists of the ghostforest and the boss of the Forest World. The Team will continue with the development of the Forest World, and, as always, constructive feedback and contributions regarding the game is highly welcome.