README.md

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