README

   1
   2 - An introduction for SuperTux -
   3 http://supertux.berlios.de/
   4
   5 Last update: October 13, 2005
   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     AUTHORS              - Credits for people that contributed to the creation
  49                            of SuperTux. (You can view these in the game menu
  50                            as well.)
  51     NEWS                 - Changes since the previous versions of SuperTux.
  52     COPYING              - The GNU General Public License, under whose terms
  53                            SuperTux is licensed.
  54     INSTALL              - Instructions on requirements, compiling and installing.
  55     README               - (This file.)  Game story, usage, rules and controls.
  56
  57   The following documents can be found and read in the docs/ directory:
  58
  59     levelguidelines.txt  - Very useful information for those that want to design
  60                            levels for SuperTux.
  61     fileformats.txt/htm  - Documentation on the various file formats used by the
  62                            game.
  63     scripting.txt/htm    - Reference to the scripting language used by SuperTux.
  64
  65
  66 RUNNING THE GAME
  67 ----------------
  68   SuperTux makes use of proc to see where it is. In other words, it does not
  69   have any need to be installed and can be run from anywhere. This makes
  70   it possible to click in the executable in your filemanager (i.e. Konqueror or
  71   Nautilus) as opposed to many other Linux games.
  72
  73   Options can be reached from the menu, so you don't need to specify arguments,
  74   but if you want, type 'supertux --help' to check the ones that are available.
  75   Also, notice that SuperTux saves the options, so it's often enough to
  76   specify them once.
  77
  78   The game uses OpenGL to render the graphics. You will either need a CPU
  79   with about 10 GHz or an accelerated video card with the vendor's drivers.
  80   (On Linux, the team recommends using cards from NVidia with the proprietary
  81   drivers, but ATI or another verndor should do.)
  82
  83
  84 PLAYING THE GAME
  85 ----------------
  86   Controls
  87   --------
  88   Both keyboards and joysticks/gamepads are supported. You can change the
  89   controls via the Options menu. Basically, the only keys you will need to
  90   use in-game are to do the following actions: jump, duck, right, left, power
  91   and 'P' to pause/unpause the game. There isn't much to tell about the first
  92   few, but the "run" key allows you to run and use the power of the powerup
  93   you got. For instance, with the fire flower, you can shoot bullets (note
  94   that this is the only power currently implemented).
  95
  96   Other useful keys include the Esc key, which is used to go to the menu or
  97   to go up a level in the menu. The menu can be navigated using the arrow
  98   keys or the mouse.
  99
 100   In the worldmap, the arrow keys are used to navigate and Enter to enter
 101   the current level.
 102
 103 SCREEN LAYOUT
 104 -------------
 105   Status
 106   ------
 107     The amount of time you have left to complete this level as well as the
 108     number of coins and lives you have collected is displayed on the right
 109     at the top of the screen. (Note: the time is NOT written in seconds!)
 110
 111 OPTIONS FILE
 112 ------------
 113
 114   When SuperTux starts up, it looks for an options file.
 115
 116   On Linux, this file is "config" in your directory (~/.supertux/). On
 117   Windows, this file is "supertux.dat" in the SuperTux folder.
 118
 119   This file records program's settings using the syntax of Lisp. There
 120   should be no reason to edit this file by hand.
 121
 122 THE END
 123 -------
 124   Thanks for trying out SuperTux.
 125
 126   If you like SuperTux, please rate and review it at the
 127   Linux Game Tome:
 128
 129     http://www.happypenguin.org/
 130
 131   Search for "SuperTux"!
 132
 133   Thanks!
 134
 135   The SuperTux development team