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. (Most of the data subdiretory is also
  53                            licensed under CC-by-SA)
  54     docs/levelguidelines.txt - Very useful information for those that want to design
  55                            levels for SuperTux.
  56     data/credits.txt     - Credits for people that contributed to the creation
  57                            of SuperTux. (You can view these in the game menu
  58                            as well.)
  59     data/README          - Licensing information about the data.
  60
  61
  62 RUNNING THE GAME
  63 ----------------
  64   SuperTux makes use of proc to see where it is. In other words, it does not
  65   have any need to be installed and can be run from anywhere. This makes
  66   it possible to click in the executable in your filemanager (i.e. Konqueror or
  67   Nautilus) as opposed to many other Linux games.
  68
  69   Options can be reached from the menu, so you don't need to specify arguments,
  70   but if you want, type 'supertux2 --help' to check the ones that are available.
  71   Also, notice that SuperTux saves the options, so it's often enough to
  72   specify them once. For example, fullscreen mode causes problems on some setups,
  73   so just run 'supertux2 --window' and you should be set.
  74
  75   The game uses OpenGL to render the graphics. You will either need a CPU
  76   with about 10 GHz or an accelerated video card with the vendor's drivers.
  77   (On Linux, the team recommends using cards from NVidia with the proprietary
  78   drivers, but ATI or another vendor should do.)
  79
  80
  81 PLAYING THE GAME
  82 ----------------
  83   Controls
  84   --------
  85   Both keyboards and joysticks/gamepads are supported. You can change the
  86   controls via the Options menu. Basically, the only keys you will need to
  87   use in-game are to do the following actions: jump, duck, right, left, power
  88   and 'P' to pause/unpause the game. There isn't much to tell about the first
  89   few, but the "action" key allows you to pick up objects and use any powerup
  90   you got. For instance, with the fire flower, you can shoot bullets (note
  91   that this is the only power currently implemented).
  92
  93   Other useful keys include the Esc key, which is used to go to the menu or
  94   to go up a level in the menu. The menu can be navigated using the arrow
  95   keys or the mouse.
  96
  97   In the worldmap, the arrow keys are used to navigate and Enter to enter
  98   the current level.
  99
 100
 101 THE END
 102 -------
 103   Thanks for trying out SuperTux.
 104
 105   If you like SuperTux, please rate and review it at the
 106   Linux Game Tome:
 107
 108     http://www.happypenguin.org/
 109
 110   Search for "SuperTux"!
 111
 112   Thanks!
 113
 114   The SuperTux development team
 115