README.txt

   1 README.txt for Super Tux
   2
   3 by Bill Kendrick
   4 bill@newbreedsoftware.com
   5 http://www.newbreedsoftware.com/supertux/
   6
   7 Version 0.0.5
   8
   9 December 17, 2003
  10
  11
  12 NOTICE!  THIS GAME IS UNDER CONSTRUCTION!
  13 Things you'll notice:
  14
  15   Bugs
  16   Documentation is quite incomplete
  17   Only two levels
  18
  19
  20 DESCRIPTION
  21 -----------
  22   "Super Tux" is a game similar to Nintendo's "Super Mario Bros."(tm)
  23   Run and jump through multiple worlds, fighting off enemies by jumping
  24   on them or bumping them from below.  Grab power-ups and Linux distributions
  25   on the way.
  26
  27
  28 STORY
  29 -----
  30   Tux and Gown are having a picnic in Antarctica, when suddenly Gown is
  31   abducted!  Tux must follow the path of clues across the globe to find
  32   his girlfriend and save her!
  33
  34
  35 DOCUMENTATION
  36 -------------
  37   Important documentation for "Super Tux" is contained in multiple files.
  38   Please see them:
  39
  40     AUTHORS.txt    - Credits for who made this game.
  41     CHANGES.txt    - Changes since the previous versions of "Super Tux"
  42     COPYING.txt    - The GNU Public License, which "Super Tux" is under.
  43     INSTALL.txt    - Instructions on requirements, compiling and installing.
  44     README.txt     - (This file.)  Game story, usage, rules and controls.
  45     TODO.txt       - A wish-list for this version of "Super Tux"
  46
  47
  48 RUNNING THE GAME
  49 ----------------
  50   Just type "./supertux" to get started.
  51
  52   The program accepts some options:
  53
  54     --disable-sound     - If sound support was compiled in, this will
  55                           disable it for this session of the game.
  56
  57     --fullscreen        - Run in fullscreen mode.
  58
  59     --help              - Display a help message summarizing command-line
  60                           options, copyright, and game controls.
  61
  62     --usage             - Display a brief message summarizing command-line
  63                           options.
  64
  65     --version           - Display the version of Super Tux you're running.
  66
  67
  68 TITLE SCREEN
  69 ------------
  70   Press [RETURN] or a joystick firebutton to begin a game.
  71
  72   Press [ESCAPE] to quit.
  73
  74   Note: If you're playing Super Tux in a window, you can also use
  75   your window manager's close option (usually an "X" button on the window's
  76   title bar) to quit.  This works at ANY time.
  77
  78
  79 SCREEN LAYOUT
  80 -------------
  81   UNDER CONSTRUCTION
  82
  83     +-------------------------------------------------+
  84     |SCORE 1230    TIME 128     DISTROS 93    |
  85     |HIGH 100                                                 |
  86     |                                                               |
  87     |                                                               |
  88     |                                                               |
  89     |                                                               |
  90     |                                                               |
  91     |                                                               |
  92     |                                                               |
  93     |                                                               |
  94     |                                                               |
  95     +-------------------------------------------------+
  96
  97
  98   Status
  99   ------
 100     Your score is displayed at the upper left.
 101     Under your current score is the last highscore.
 102
 103     The amount of time you have left to complete this level is displayed in
 104     the center at the top of the screen.  (Note: Time is NOT in seconds!)
 105
 106     The number of distros (CDs) you have collected is displayed at the upper
 107     right.
 108
 109
 110 PLAYING THE GAME
 111 ----------------
 112   Controls
 113   --------
 114     Joystick        Keyboard     Purpose
 115     --------        --------     -------
 116       Left            Left         Face/Move Left
 117       Right           Right        Face/Move Right
 118       Button-A        Up           Jump
 119       Button-B        Control      Run/Fire
 120       Down            Down         Duck
 121
 122   Pausing
 123   -------
 124     NOT IMPLEMENTED
 125
 126     To pause the game, you can press either the [TAB] or [P] key.
 127     To unpause, press one of those keys again.
 128
 129   Quitting
 130   --------
 131     To quit the current game, you can press [ESCAPE].  This forfeits your game
 132     (as though you ran out of lives).
 133
 134     To quit Super Tux altogether, you can use your window manager's
 135     close command.  See the note in the "Title Screen" section, above.
 136
 137
 138 SCORING
 139 -------
 140   Enemies
 141   -------
 142     If you get more than one enemy at a time without landing on the ground,
 143     each enemy is worth more points.  For example, if there are three in a
 144     row and you jump on the first, it's worth 50 points.  If you bounce off
 145     the first and onto the second, it's worth 100 points.  If you also get
 146     the third, it's worth 150 points.
 147
 148     You can also score by shooting at the ennemies. Don't forget to drink
 149     the coffee in order to get the ability to fire.
 150
 151 GAME OVER SCREEN
 152 ----------------
 153   NOT IMPLEMENTED
 154
 155
 156 OPTIONS FILE
 157 ------------
 158   NOT IMPLEMENTED
 159
 160   When Super Tux starts up, it looks for an options file.
 161
 162   Under Linux, this file is ".supertux" in your home directory ($HOME).
 163   Under Windows, this file is "supertux.dat" in the Super Tux folder.
 164
 165   This file records high score scores and initials, and volume settings.
 166
 167
 168 THE END
 169 -------
 170   Thanks for trying out Super Tux.
 171
 172   If you like Super Tux, please rate and review it at the
 173   Linux Game Tome:
 174
 175     http://www.happypenguin.org/
 176
 177   Search for "Super Tux"!
 178
 179
 180   Thanks!
 181
 182   Bill Kendrick  <bill@newbreedsoftware.com>