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 a strongly inspiration on
  10   Nintendo's Super Mario Bros games.
  11   Run and jump through multiple worlds, fighting off enemies by jumping
  12   on them or bumping them from below.  Grabbing power-ups and other stuff
  13   on the way.
  14
  15
  16 STORY
  17 -----
  18
  19 - Gwen gets captured! -
  20
  21   Tux and Gwen were out having a nice
  22   picnic on the ice fields of Antarctica.
  23   Suddenly, a creature jumped from
  24   behind an ice bush, there was a flash,
  25   and Tux fell asleep!
  26
  27   When Tux wakes up, he finds that Gwen
  28   is missing. Where she lay before now
  29   lies a letter. "Tux, my arch enemy!"
  30   says the letter. "I have captured
  31   your beautiful Gwen and have taken her
  32   to my fortress. The path to my fortress
  33   is littered with my minions. Give up on
  34   the thought of trying to reclaim her,
  35   you haven't a chance! -Nolok"
  36
  37   Tux looks and see Nolok's fortress in
  38   the distance. Determined to save his
  39   beloved Gwen, he begins his journey.
  40
  41
  42 DOCUMENTATION
  43 -------------
  44   Important documentation for SuperTux is contained in multiple files.
  45   Please see them:
  46
  47     AUTHORS    - Credits for who made this game.
  48     CHANGES    - Changes since the previous versions of "Super Tux"
  49     COPYING    - The GNU Public License, which "Super Tux" is under.
  50     INSTALL    - Instructions on requirements, compiling and installing.
  51     README     - (This file.)  Game story, usage, rules and controls.
  52     TODO       - A wish-list for this version of "Super Tux"
  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 (ie. Konqueror,
  60   Nautilus) as oposited to most of 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 'supertux --help' to check the ones that are avaible.
  64   Also, notice that SuperTux saves the options, so you don't need to be allways
  65   specifying them.
  66
  67   The game has two frontends: SDL and OpenGL. Currently, there isn't any
  68   noticiable difference between them.
  69   Basically, SDL uses software to draw the game and OpenGL makes use of
  70   the videocards cpu (in case the videocard has one and the drivers support
  71   it). Under linux, nvidia is recommendaded (with the closed drivers), but
  72   an ATI should work just fine.
  73
  74
  75 PLAYING THE GAME
  76 ----------------
  77   Controls
  78   --------
  79   Both keyboards and joysticks/gamepads are supported. You can change the
  80   controls via the Options menu.
  81   Basically, the only keys you will have to use is for the following actions:
  82   jump, duck, right and left. Also press Esc to go to the menu and use the
  83   key cursors and Enter under it. Oh, press P to pause the game.
  84   In the worldmap, the arrow keys and Enter are enough.
  85
  86   The leveleditor is controled via the mouse, but there are shortcuts that
  87   may make your life easier. To see the shortcuts for the buttons, just
  88   do a Right-click on them.
  89   In any case, we advise you to read LEVELDESIGN to have the best productivity
  90   with the leveleditor.
  91
  92
  93 SCREEN LAYOUT
  94 -------------
  95   Status
  96   ------
  97     The amount of time you have left to complete this level is displayed in
  98     the center at the top of the screen.  (Note: Time is NOT in seconds!)
  99
 100     The number of coins you have collected is displayed at the upper right.
 101
 102 SCORING
 103 -------
 104   Enemies
 105   -------
 106     If you get more than one enemy at a time without landing on the ground,
 107     each enemy is worth more points.  For example, if there are three in a
 108     row and you jump on the first, it's worth 50 points.  If you bounce off
 109     the first and onto the second, it's worth 100 points.  If you also get
 110     the third, it's worth 150 points.
 111
 112     You can also score by shooting at the ennemies. Don't forget to get
 113     the flower in order to get the ability to fire.
 114
 115
 116 OPTIONS FILE
 117 ------------
 118
 119   When Super Tux starts up, it looks for an options file.
 120
 121   Under Linux, this file is "config" in your directory
 122   ($HOME/.supertux/).
 123   Under Windows, this file is "supertux.dat" in the Super Tux folder.
 124
 125   This file records program's settings. It uses the LISP syntax, anyway
 126   there shouldn't be any reasons for you to hand edit it.
 127
 128 THE END
 129 -------
 130   Thanks for trying out Super Tux.
 131
 132   If you like Super Tux, please rate and review it at the
 133   Linux Game Tome:
 134
 135     http://www.happypenguin.org/
 136
 137   Search for "Super Tux"!
 138
 139
 140   Thanks!
 141
 142   The SuperTux development team