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 9, 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 UNDER CONSTRUCTION
  55
  56     --disable-sound     - If sound support was compiled in, this will
  57                           disable it for this session of the game.
  58
  59     --fullscreen        - Run in fullscreen mode.
  60
  61     --help              - Display a help message summarizing command-line
  62                           options, copyright, and game controls.
  63
  64     --usage             - Display a brief message summarizing command-line
  65                           options.
  66
  67     --version           - Display the version of Super Tux you're running.
  68
  69
  70 TITLE SCREEN
  71 ------------
  72   Press [RETURN] or a joystick firebutton to begin a game.
  73
  74   Press [ESCAPE] to quit.
  75
  76   Note: If you're playing Super Tux in a window, you can also use
  77   your window manager's close option (usually an "X" button on the window's
  78   title bar) to quit.  This works at ANY time.
  79
  80
  81 SCREEN LAYOUT
  82 -------------
  83   UNDER CONSTRUCTION
  84
  85     +----------------------------------------+
  86     |SCORE 1230    TIME 128     DISTROS 93   |
  87     |                                        |
  88     |                                        |
  89     |                                        |
  90     |                                        |
  91     |                                        |
  92     |                                        |
  93     |                                        |
  94     |                                        |
  95     |                                        |
  96     |                                        |
  97     +----------------------------------------+
  98
  99
 100   Status
 101   ------
 102     Your score is displayed at the upper left.
 103
 104     The amount of time you have left to complete this level is displayed in
 105     the center at the top of the screen.  (Note: Time is NOT in seconds!)
 106
 107     The number of distros (CDs) you have collected is displayed at the upper
 108     right.
 109
 110
 111 PLAYING THE GAME
 112 ----------------
 113   Controls
 114   --------
 115     Joystick        Keyboard     Purpose
 116     --------        --------     -------
 117       Left            Left         Face/Move Left
 118       Right           Right        Face/Move Right
 119       Button-A        Up           Jump
 120       Button-B        Control      Run/Fire
 121       Down            Down         Duck
 122
 123   Pausing
 124   -------
 125     NOT IMPLEMENTED
 126
 127     To pause the game, you can press either the [TAB] or [P] key.
 128     To unpause, press one of those keys again.
 129
 130   Quitting
 131   --------
 132     To quit the current game, you can press [ESCAPE].  This forfeits your game
 133     (as though you ran out of lives).
 134
 135     To quit Super Tux altogether, you can use your window manager's
 136     close command.  See the note in the "Title Screen" section, above.
 137
 138
 139 SCORING
 140 -------
 141   Enemies
 142   -------
 143     If you get more than one enemy at a time without landing on the ground,
 144     each enemy is worth more points.  For example, if there are three in a
 145     row and you jump on the first, it's worth 50 points.  If you bounce off
 146     the first and onto the second, it's worth 100 points.  If you also get
 147     the third, it's worth 150 points.
 148
 149
 150 GAME OVER SCREEN
 151 ----------------
 152   NOT IMPLEMENTED
 153
 154
 155 OPTIONS FILE
 156 ------------
 157   NOT IMPLEMENTED
 158
 159   When Super Tux starts up, it looks for an options file.
 160
 161   Under Linux, this file is ".supertux" in your home directory ($HOME).
 162   Under Windows, this file is "supertux.dat" in the Super Tux folder.
 163
 164   This file records high score scores and initials, and volume settings.
 165
 166
 167 THE END
 168 -------
 169   Thanks for trying out Super Tux.
 170
 171   If you like Super Tux, please rate and review it at the
 172   Linux Game Tome:
 173
 174     http://www.happypenguin.org/
 175
 176   Search for "Super Tux"!
 177
 178
 179   Thanks!
 180
 181   Bill Kendrick  <bill@newbreedsoftware.com>