README

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