README

   1
   2 - An introduction for SuperTux -
   3 http://super-tux.sf.net/
   4
   5 Last update: April 26, 2004
   6
   7 DESCRIPTION
   8 -----------
   9   SuperTux is a jump'n run like game, with strong inspiration from the
  10   Super Mario Bros games for Nintendo.
  11
  12   Run and jump through multiple worlds, fighting off enemies by jumping
  13   on them or bumping them from below.  Grabbing power-ups and other stuff
  14   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 see 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.
  50     CHANGES     - Changes since the previous versions of "SuperTux"
  51     COPYING     - The GNU Public License, which "SuperTux" is liscensed
  52                   under.
  53     INSTALL     - Instructions on requirements, compiling and installing.
  54     README      - (This file.)  Game story, usage, rules and controls.
  55     TODO        - A wish-list for this version of "SuperTux"
  56     LEVELDESIGN - Very useful information for those that want to design
  57                   levels for SuperTux.
  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 (ie. Konqueror,
  65   Nautilus) as oposited to most of 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 'supertux --help' to check the ones that are avaible.
  69   Also, notice that SuperTux saves the options, so you don't need to be allways
  70   specifying them.
  71
  72   The game has two frontends: SDL and OpenGL. Currently, there isn't any
  73   noticiable difference between them. Basically, SDL uses software to draw
  74   the game and OpenGL makes use of the videocards CPU (if the videocard has
  75   one and the drivers support it). Under linux, nVidia is recommendaded
  76   (with the closed drivers), but an ATI video card should work just fine.
  77
  78
  79 PLAYING THE GAME
  80 ----------------
  81   Controls
  82   --------
  83   Both keyboards and joysticks/gamepads are supported. You can change the
  84   controls via the Options menu. Basically, the only keys you will need to
  85   use in-game are to do the following actions: jump, duck, right left and
  86   'P' to pause/unpause the game.
  87
  88   Other useful keys include the Esc key, which is used to go to the menu or
  89   to go up a level in the menu. The menu can be navigated using the arrow
  90   keys or the mouse.
  91
  92   In the worldmap, the arrow keys are used to navigate and Enter enters the
  93   current level.
  94
  95   The leveleditor is controled via the mouse, but there are shortcuts that
  96   may make your life easier. To see the shortcuts for the buttons, just
  97   do a Right-click on them. If you are interested in creating SuperTux
  98   levels, we advise you to read LEVELDESIGN to learn more about the editor
  99   and creating new levels.
 100
 101
 102 SCREEN LAYOUT
 103 -------------
 104   Status
 105   ------
 106     The amount of time you have left to complete this level is displayed in
 107     the center at the top of the screen.  (Note: Time is NOT in seconds!)
 108
 109     The number of coins you have collected is displayed at the upper right.
 110
 111 SCORING
 112 -------
 113   Enemies
 114   -------
 115     If you kill more than one enemy at a time without landing on the ground,
 116     each enemy is worth more points.  For example, if there are three in a
 117     row and you jump on the first, it's worth 50 points.  If you bounce off
 118     the first and onto the second, it's worth 100 points.  If you also get
 119     the third, it's worth 150 points.
 120
 121     You can also score by shooting at the enemies. Don't forget to get
 122     the iceflower in order to get the ability to fire.
 123
 124
 125 OPTIONS FILE
 126 ------------
 127
 128   When SuperTux starts up, it looks for an options file.
 129
 130   Under Linux, this file is "config" in your directory
 131   ($HOME/.supertux/).
 132   Under Windows, this file is "supertux.dat" in the SuperTux folder.
 133
 134   This file records program's settings. It uses the LISP syntax. There
 135   should be no reason to edit this file by hand.
 136
 137 THE END
 138 -------
 139   Thanks for trying out SuperTux.
 140
 141   If you like SuperTux, please rate and review it at the
 142   Linux Game Tome:
 143
 144     http://www.happypenguin.org/
 145
 146   Search for "SuperTux"!
 147
 148
 149   Thanks!
 150
 151   The SuperTux development team