Replaced Gnome.AppBar with a dialog (stored in .glade file)
[supertux.git] / README
1
2 - An introduction for SuperTux -
3 http://supertux.lethargik.org/
4
5 Last update: December 20, 2007
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
23   picnic on the ice fields of Antarctica.
24   Suddenly, a creature jumped from
25   behind an ice bush, there was a flash,
26   and Tux fell asleep!
27
28   When Tux wakes up, he finds that Penny
29   is missing. Where she lay before now
30   lies a letter. "Tux, my arch enemy!"
31   says the letter. "I have captured
32   your beautiful Penny and have taken her
33   to my fortress. The path to my fortress
34   is littered with my minions. Give up on
35   the thought of trying to reclaim her,
36   you haven't a chance! -Nolok"
37
38   Tux looks and sees Nolok's fortress in
39   the distance. Determined to save his
40   beloved Penny, he begins his journey.
41
42
43 DOCUMENTATION
44 -------------
45   Important documentation for SuperTux is contained in multiple files.
46   Please see them:
47
48     INSTALL              - Requirements, compiling and installing.
49     README               - (This file.)  Game story, usage, rules and controls.
50     WHATSNEW.txt         - Changes since the previous versions of SuperTux.
51     COPYING              - The GNU General Public License, under whose terms
52                            SuperTux is licensed.
53     levelguidelines.txt  - Very useful information for those that want to design
54                            levels for SuperTux.
55     credits.txt          - Credits for people that contributed to the creation
56                            of SuperTux. (You can view these in the game menu
57                            as well.)
58
59
60 RUNNING THE GAME
61 ----------------
62   SuperTux makes use of proc to see where it is. In other words, it does not
63   have any need to be installed and can be run from anywhere. This makes
64   it possible to click in the executable in your filemanager (i.e. Konqueror or
65   Nautilus) as opposed to many other Linux games.
66
67   Options can be reached from the menu, so you don't need to specify arguments,
68   but if you want, type 'supertux2 --help' to check the ones that are available.
69   Also, notice that SuperTux saves the options, so it's often enough to
70   specify them once.
71
72   The game uses OpenGL to render the graphics. You will either need a CPU
73   with about 10 GHz or an accelerated video card with the vendor's drivers.
74   (On Linux, the team recommends using cards from NVidia with the proprietary
75   drivers, but ATI or another vendor should do.)
76
77
78 PLAYING THE GAME
79 ----------------
80   Controls
81   --------
82   Both keyboards and joysticks/gamepads are supported. You can change the
83   controls via the Options menu. Basically, the only keys you will need to
84   use in-game are to do the following actions: jump, duck, right, left, power
85   and 'P' to pause/unpause the game. There isn't much to tell about the first
86   few, but the "action" key allows you to pick up objects and use any powerup
87   you got. For instance, with the fire flower, you can shoot bullets (note
88   that this is the only power currently implemented).
89
90   Other useful keys include the Esc key, which is used to go to the menu or
91   to go up a level in the menu. The menu can be navigated using the arrow
92   keys or the mouse.
93
94   In the worldmap, the arrow keys are used to navigate and Enter to enter
95   the current level.
96
97
98 THE END
99 -------
100   Thanks for trying out SuperTux.
101
102   If you like SuperTux, please rate and review it at the
103   Linux Game Tome:
104
105     http://www.happypenguin.org/
106
107   Search for "SuperTux"!
108
109   Thanks!
110
111   The SuperTux development team
112