README.md

   1 SuperTux - <http://supertux.lethargik.org/>
   2 ===========================================
   3 Last update: February 26, 2010
   4
   5 Description
   6 -----------
   7
   8 SuperTux is a jump'n'run game with strong inspiration from the
   9 Super Mario Bros. games for the various Nintendo platforms.
  10
  11 Run and jump through multiple worlds, fighting off enemies by jumping
  12 on them, bumping them from below or tossing objects at them, grabbing
  13 power-ups and other stuff on the way.
  14
  15
  16 Story: Penny gets captured!
  17 ---------------------------
  18
  19 Tux and Penny were out having a nice picnic on the ice fields of
  20 Antarctica. Suddenly, a creature jumped from behind an ice bush, there
  21 was a flash, and Tux fell asleep!
  22
  23 When Tux wakes up, he finds that Penny is missing. Where she lay
  24 before now lies a letter. "Tux, my arch enemy!" says the letter. "I
  25 have captured your beautiful Penny and have taken her to my fortress.
  26 The path to my fortress is littered with my minions. Give up on the
  27 thought of trying to reclaim her, you haven't a chance! -Nolok"
  28
  29 Tux looks and sees Nolok's fortress in the distance. Determined to
  30 save his beloved Penny, he begins his journey.
  31
  32
  33 Documentation
  34 -------------
  35 Important documentation for SuperTux is contained in multiple files.
  36 Please see them:
  37
  38 `INSTALL.md`
  39 : Requirements, compiling and installing.
  40
  41 `README.md`
  42 : This file
  43
  44 `WHATSNEW.txt`
  45 : Changes since the previous versions of SuperTux.
  46
  47 `COPYING`
  48 : The GNU General Public License, under whose terms SuperTux is
  49 licensed. (Most of the data subdirectory is also licensed under
  50 CC-by-SA)
  51
  52 `docs/levelguidelines.txt`
  53 : Very useful information for those that want to design levels for
  54 SuperTux.
  55
  56 `data/credits.txt`
  57 : Credits for people that contributed to the creationof SuperTux. (You
  58 can view these in the game menuas well.)
  59
  60 `data/README`
  61 : Licensing information about the data.
  62
  63
  64 Running the game
  65 ----------------
  66
  67 SuperTux makes use of proc to see where it is. In other words, it does
  68 not have any need to be installed and can be run from anywhere. This
  69 makes it possible to click in the executable in your filemanager (i.e.
  70 Konqueror or Nautilus) as opposed to many other Linux games.
  71
  72 Options can be reached from the menu, so you don't need to specify
  73 arguments, but if you want, type 'supertux2 --help' to check the ones
  74 that are available. Also, notice that SuperTux saves the options, so
  75 it's often enough to specify them once. For example, fullscreen mode
  76 causes problems on some setups, so just run 'supertux2 --window' and
  77 you should be set.
  78
  79 The game uses OpenGL to render the graphics. You will either need a
  80 CPU with about 10 GHz or an accelerated video card with the vendor's
  81 drivers. (On Linux, the team recommends using cards from NVidia with
  82 the proprietary drivers, but ATI or another vendor should do.)
  83
  84
  85 Playing the game
  86 ----------------
  87
  88 Both keyboards and joysticks/gamepads are supported. You can change
  89 the controls via the Options menu. Basically, the only keys you will
  90 need to use in-game are to do the following actions: jump, duck,
  91 right, left, power and 'P' to pause/unpause the game. There isn't much
  92 to tell about the first few, but the "action" key allows you to pick
  93 up objects and use any powerup you got. For instance, with the fire
  94 flower, you can shoot bullets (note that this is the only power
  95 currently implemented).
  96
  97 Other useful keys include the Esc key, which is used to go to the menu
  98 or to go up a level in the menu. The menu can be navigated using the
  99 arrow keys or the mouse.
 100
 101 In the worldmap, the arrow keys are used to navigate and Enter to
 102 enter the current level.
 103
 104
 105 Development status
 106 ------------------
 107
 108 This version of SuperTux is still under development, even though the
 109 0.3 line of versions is somewhat aged. This means that badguys,
 110 features, levels, graphics or anything else may be removed in the
 111 future.
 112
 113 Especially the Forest world included in this package may be subject to
 114 drastic changes. These changes may go as far as removing the world
 115 altogether. Currently (February 2010) there is no consensus within the
 116 SuperTux development community regarding the fate of the Forest. Don't
 117 get too attached to it ;)
 118
 119
 120 The End
 121 -------
 122
 123 Thanks for trying out SuperTux.
 124
 125 If you like SuperTux, please rate and review it at the Linux Game Tome:
 126
 127 <http://www.happypenguin.org/>
 128
 129 Search for "SuperTux"!
 130
 131 Thanks!
 132
 133 The SuperTux development team