README.md

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