Add an ignore
[supertux.git] / README
1 SuperTux
2 ========
3 <http://supertux.lethargik.org/>
4
5 Last update: February 26, 2010
6
7 DESCRIPTION
8 -----------
9   SuperTux is a jump'n'run game with strong inspiration from the
10   Super Mario Bros. games for the various Nintendo platforms.
11
12   Run and jump through multiple worlds, fighting off enemies by jumping
13   on them, bumping them from below or tossing objects at them, grabbing
14   power-ups and other stuff on the way.
15
16
17 STORY
18 -----
19
20 - Penny gets captured! -
21
22   Tux and Penny were out having a nice picnic on the ice fields of Antarctica.
23   Suddenly, a creature jumped from behind an ice bush, there was a flash, and
24   Tux fell asleep!
25
26   When Tux wakes up, he finds that Penny is missing. Where she lay before now
27   lies a letter. "Tux, my arch enemy!" says the letter. "I have captured your
28   beautiful Penny and have taken her to my fortress. The path to my fortress
29   is littered with my minions. Give up on the thought of trying to reclaim
30   her, you haven't a chance! -Nolok"
31
32   Tux looks and sees Nolok's fortress in the distance. Determined to save his
33   beloved Penny, he begins his journey.
34
35
36 DOCUMENTATION
37 -------------
38   Important documentation for SuperTux is contained in multiple files.
39   Please see them:
40
41     INSTALL              - Requirements, compiling and installing.
42     README               - (This file.)  Game story, usage, rules and controls.
43     WHATSNEW.txt         - Changes since the previous versions of SuperTux.
44     COPYING              - The GNU General Public License, under whose terms
45                            SuperTux is licensed. (Most of the data
46                            subdirectory is also licensed under CC-by-SA)
47     docs/levelguidelines.txt - Very useful information for those that want to design
48                            levels for SuperTux.
49     data/credits.txt     - Credits for people that contributed to the creation
50                            of SuperTux. (You can view these in the game menu
51                            as well.)
52     data/README          - Licensing information about the data.
53
54
55 RUNNING THE GAME
56 ----------------
57   SuperTux makes use of proc to see where it is. In other words, it does not
58   have any need to be installed and can be run from anywhere. This makes
59   it possible to click in the executable in your filemanager (i.e. Konqueror or
60   Nautilus) as opposed to many other Linux games.
61
62   Options can be reached from the menu, so you don't need to specify arguments,
63   but if you want, type 'supertux2 --help' to check the ones that are available.
64   Also, notice that SuperTux saves the options, so it's often enough to
65   specify them once. For example, fullscreen mode causes problems on some setups,
66   so just run 'supertux2 --window' and you should be set.
67
68   The game uses OpenGL to render the graphics. You will either need a CPU
69   with about 10 GHz or an accelerated video card with the vendor's drivers.
70   (On Linux, the team recommends using cards from NVidia with the proprietary
71   drivers, but ATI or another vendor should do.)
72
73
74 PLAYING THE GAME
75 ----------------
76   Controls
77   --------
78   Both keyboards and joysticks/gamepads are supported. You can change the
79   controls via the Options menu. Basically, the only keys you will need to
80   use in-game are to do the following actions: jump, duck, right, left, power
81   and 'P' to pause/unpause the game. There isn't much to tell about the first
82   few, but the "action" key allows you to pick up objects and use any powerup
83   you got. For instance, with the fire flower, you can shoot bullets (note
84   that this is the only power currently implemented).
85
86   Other useful keys include the Esc key, which is used to go to the menu or
87   to go up a level in the menu. The menu can be navigated using the arrow
88   keys or the mouse.
89
90   In the worldmap, the arrow keys are used to navigate and Enter to enter
91   the current level.
92
93
94 DEVELOPMENT STATUS
95 ------------------
96   This version of SuperTux is still under development, even though the
97   0.3 line of versions is somewhat aged. This means that badguys, features,
98   levels, graphics or anything else may be removed in the future.
99
100   Especially the Forest world included in this package may be subject to
101   drastic changes. These changes may go as far as removing the world
102   altogether. Currently (February 2010) there is no consensus within the
103   SuperTux development community regarding the fate of the Forest. Don't get
104   too attached to it ;)
105
106
107 THE END
108 -------
109   Thanks for trying out SuperTux.
110
111   If you like SuperTux, please rate and review it at the Linux Game Tome:
112
113     http://www.happypenguin.org/
114
115   Search for "SuperTux"!
116
117   Thanks!
118
119   The SuperTux development team
120