README.md
1# SuperTux
2
3[](https://github.com/SuperTux/supertux/actions?query=workflow%3Amain)
4[](https://github.com/SuperTux/supertux)
5
6SuperTux is a jump'n'run game with strong inspiration from the
7Super Mario Bros. games for the various Nintendo platforms.
8
9Run and jump through multiple worlds, fighting off enemies by jumping
10on them, bumping them from below or tossing objects at them, grabbing
11power-ups and other stuff on the way.
12
13
14
15
16## Story: Penny gets captured!
17
18Tux and Penny were out having a nice picnic on the ice fields of
19Antarctica. Suddenly, a creature jumped from behind an ice bush, there
20was a flash, and Tux fell asleep!
21
22When Tux wakes up, he finds that Penny is missing. Where she lay
23before now lies a letter:
24>Tux, my arch enemy! I have captured your beautiful Penny and have
25>taken her to my fortress. The path to my fortress is littered with my
26>minions. Give up on the thought of trying to reclaim her, you haven't
27>got a chance!
28>
29>-Nolok
30
31Tux looks and sees Nolok's fortress in the distance. Determined to
32save his beloved Penny, he begins his journey.
33
34## Installation
35
36For major platforms, stable releases are built and available for download from
37[supertux.org](https://www.supertux.org/download.html) or alternatively directly
38from [GitHub](https://github.com/SuperTux/supertux/releases). You should be able
39to install these using default tools provided by your platform. On macOS, when
40Gatekeeper is enabled (default) it will refuse to open SuperTux. This is due to
41the lack of a signature on the application. If you wish to open SuperTux anyway
42without disabling the Gatekeeper feature entirely, you can open the application
43from the context menu (control click on the icon). macOS will then remember your
44choice the next time.
45
46## Documentation
47
48Important documentation for SuperTux is contained in multiple files.
49Please see them:
50
51* `INSTALL.md` - Requirements, compiling and installing.
52* `README.md` - This file
53* `NEWS.md` - Changes since the previous versions of SuperTux.
54* `LICENSE.txt` - The GNU General Public License, under whose terms SuperTux is
55licensed. (Most of the data subdirectory is also licensed under
56CC-by-SA)
57* `data/credits.stxt` - Credits for people that contributed to the creation of
58SuperTux. (You can view these in the game menu as well.)
59
60
61## Playing the game
62
63Both keyboards and joysticks/gamepads are supported. You can change
64the controls via the Options menu. Basically, the only keys you will
65need to use in-game are to do the following actions: jump, duck,
66right, left, action and 'P' to pause/unpause the game. There isn't much
67to tell about the first few, but the "action" key allows you to pick
68up objects and use any powerup you got. For instance, with the fire
69flower, you can shoot fireballs, or with the ice flower fire ice pellets.
70
71Other useful keys include the Esc key, which is used to go to the menu
72or to go up a level in the menu. The menu can be navigated using the
73arrow keys or the mouse.
74
75In the worldmap, the arrow keys are used to navigate and Enter to
76enter the current level.
77
78## Community
79
80In case you need help, feel free to reach out using the following means:
81
82* **IRC:** [#supertux](ircs://irc.libera.chat/#supertux) on
83 [Libera Chat](https://libera.chat) hosts most of the discussions between
84 developers. Also, real-time support can be provided here. If you don't know
85 how to use an IRC client, you access the channel using a web-based
86 [client](https://kiwiirc.com/nextclient/irc.libera.chat:+6697/?nick=Guest?#supertux).
87 Please stay around after asking questions, otherwise you will be disconnected
88 and might miss potential answers.
89* **Matrix:** [#supertux:matrix.org](https://matrix.to/#/#supertux:matrix.org)
90 is bridged to our IRC room.
91* **[Forum](https://forum.freegamedev.net/viewforum.php?f=66):** The SuperTux
92 community is very active on the forum, the discussion ranges from feature
93 proposals to support questions. In particular, most community-contributed
94 add-ons are published there first, so this is worth checking.
95* **Mailing Lists:** The
96 [supertux-devel](http://lists.lethargik.org/listinfo.cgi/supertux-devel-lethargik.org)
97 mailing list is dead. Here is the [archive](https://github.com/supertux-community/supertux-devel-maillist).
98* **Social Media:** Mostly on [Twitter](https://twitter.com/supertux_team) at
99 the moment.
100* **Discord:** Also, you can join our [Discord server](https://discord.com/invite/AcvtHWz) to get in touch with us.
101
102## Development status
103
104As of now, with the release of SuperTux 0.6.3 (December 2021), the Forest World is almost
105finished, since the ghost forest section has been included. However, some levels, especially
106the Ghostree Level, are considered to be placeholders, because for the next version (0.7.0) a
107great overhaul is planned with new features like reworked boss fights, graphics, and worlds.
108If you have some Constructive Feedback, Contributions or ideas to share, don't hestitate
109to contact us with one of the possibilities given above.
110
){kind=link}
){kind=link}
){kind=link}