SuperTux source code

Alzter a3303ae63b Fixed leafshot anim loop 6 vuotta sitten
.github 36105b3807 .github: add an issue template 9 vuotta sitten
.travis 2b855e44e5 Fix s3 uploads 6 vuotta sitten
.tx 3d251434be Add Transifex configuration 6 vuotta sitten
contrib ec0a078502 contrib: remove outdated, unofficial KDevelop project 6 vuotta sitten
data a3303ae63b Fixed leafshot anim loop 6 vuotta sitten
external 1318f49926 Update PhysFS to latest version 3.0 branch 6 vuotta sitten
man 9324a91826 supertux/man/man6/supertux2.6: Fix a syntax error. 15 vuotta sitten
mk 10c6d0df7d Use vcpkg for Windows dependencies in AppVeyor (#927) 6 vuotta sitten
src 7a46bc4ad8 Set WeakBlock lightsprite blend mode independent of m_sprite_name 6 vuotta sitten
tests 6ac5bf6728 Fix Rectf::set_p1() not taking size changes into account 6 vuotta sitten
tools 2328c746e7 Convert `build-addon-index.py` and `sexpr.py` to Python3 6 vuotta sitten
.editorconfig ecf879928a tools: add .editorconfig (#424) 8 vuotta sitten
.gitattributes 4538cfd7ae Added .sprite, .stf and .stwm to .gitattributes 6 vuotta sitten
.gitignore b174df431d Add CMakeCache.txt and CMakeFiles/ to .gitignore 6 vuotta sitten
.gitmodules 799645104e Add SDL_ttf submodule 6 vuotta sitten
.travis.yml 741a105686 Fix travis upload to s3 6 vuotta sitten
CMakeLists.txt d0bfa3b4c9 Use -Wunreachable-code and mark unreachable code with an extra () 6 vuotta sitten
CODINGSTYLE.md 5055228298 Add some notes about `auto` to CODINGSTYLE.md 6 vuotta sitten
CONTRIBUTING.md c7c2ddf1ef README: central Community section for getting in touch 6 vuotta sitten
Doxyfile.in 17820af0e8 doxygen -u Doxyfile.in 6 vuotta sitten
INSTALL.md 20ff9d5f5c Make freetype required, libraqm optional 6 vuotta sitten
LICENSE.txt a9e0d669b9 Revert "Update LICENSE.txt" 6 vuotta sitten
NEWS.md 53d478baf3 Relase SuperTux v0.6.0-beta.1 (beta, unstable) 6 vuotta sitten
README.md 0665371362 README: Explain how to start SuperTux.app with Gatekeeper enabled 6 vuotta sitten
appveyor.yml a39f858acf Add skip ci directive for appveyor builds 6 vuotta sitten
appveyor64.yml a39f858acf Add skip ci directive for appveyor builds 6 vuotta sitten
config.h.cmake 757132a36c Improve datadir handling; fixes #394 8 vuotta sitten
configure d67e254c94 add autotools-like wrapper configure and Makefile 13 vuotta sitten
makedist.sh 6dd9597f83 Use brackets instead of commas for shell commands. 7 vuotta sitten
makepot.sh 4781f644b8 Add plural translation function 6 vuotta sitten
supertux2.appdata.xml d49a53deb7 Rewrote appdata file, included new screenshots, OARS rating, etc. 6 vuotta sitten
supertux2.desktop 3e27e15c2f Added SuperTux .svg icon 6 vuotta sitten
supertux2.svg b50fa77d1c Increased SuperTux icon size to 128x128 6 vuotta sitten
version.cmake.in 93e7715818 Added support for source tarballs 9 vuotta sitten
version.h.in 3dc79f987c Fix PACKAGE_VERSION being empty, add unit test case for that issue 9 vuotta sitten

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!" 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.

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