README.md

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