projects / supertux.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
BonusBlock drawn on same layer as Block again
[supertux.git] / README
diff --git a/README b/README
index a415802..545efc5 100644 (file)
--- a/README
+++ b/README
@@ -1,17 +1,17 @@
+SuperTux
+========
+<http://supertux.lethargik.org/>
 
 
-- An introduction for SuperTux -
-http://super-tux.sf.net/
+Last update: February 26, 2010
 
 
-Last update: April 26, 2004
- 
 DESCRIPTION
 -----------
 DESCRIPTION
 -----------
-  SuperTux is a jump'n run like game, with strong inspiration from the
-  Super Mario Bros games for Nintendo.
+  SuperTux is a jump'n'run game with strong inspiration from the
+  Super Mario Bros. games for the various Nintendo platforms.
 
   Run and jump through multiple worlds, fighting off enemies by jumping
 
   Run and jump through multiple worlds, fighting off enemies by jumping
-  on them or bumping them from below.  Grabbing power-ups and other stuff
-  on the way.
+  on them, bumping them from below or tossing objects at them, grabbing
+  power-ups and other stuff on the way.
 
 
 STORY
 
 
 STORY
@@ -19,24 +19,17 @@ STORY
 
 - Penny gets captured! -
 
 
 - Penny gets captured! -
 
-  Tux and Penny were out having a nice
-  picnic on the ice fields of Antarctica.
-  Suddenly, a creature jumped from
-  behind an ice bush, there was a flash,
-  and Tux fell asleep!
-
-  When Tux wakes up, he finds that Penny
-  is missing. Where she lay before now
-  lies a letter. "Tux, my arch enemy!"
-  says the letter. "I have captured
-  your beautiful Penny and have taken her
-  to my fortress. The path to my fortress
-  is littered with my minions. Give up on
-  the thought of trying to reclaim her,
-  you haven't a chance! -Nolok"
-
-  Tux looks and see Nolok's fortress in
-  the distance. Determined to save his
+  Tux and Penny were out having a nice picnic on the ice fields of Antarctica.
+  Suddenly, a creature jumped from behind an ice bush, there was a flash, and
+  Tux fell asleep!
+
+  When Tux wakes up, he finds that Penny is missing. Where she lay before now
+  lies a letter. "Tux, my arch enemy!" says the letter. "I have captured your
+  beautiful Penny and have taken her to my fortress. The path to my fortress
+  is littered with my minions. Give up on the thought of trying to reclaim
+  her, you haven't a chance! -Nolok"
+
+  Tux looks and sees Nolok's fortress in the distance. Determined to save his
   beloved Penny, he begins his journey.
 
 
   beloved Penny, he begins his journey.
 
 
@@ -45,35 +38,37 @@ DOCUMENTATION
   Important documentation for SuperTux is contained in multiple files.
   Please see them:
 
   Important documentation for SuperTux is contained in multiple files.
   Please see them:
 
-    AUTHORS     - Credits for people that contributed to the creation
-                  of SuperTux.
-    NEWS        - Changes since the previous versions of "SuperTux"
-    COPYING     - The GNU Public License, which "SuperTux" is liscensed
-                  under.
-    INSTALL     - Instructions on requirements, compiling and installing.
-    README      - (This file.)  Game story, usage, rules and controls.
-    TODO        - A wish-list for this version of "SuperTux"
-    LEVELDESIGN - Very useful information for those that want to design
-                  levels for SuperTux.
+    INSTALL              - Requirements, compiling and installing.
+    README               - (This file.)  Game story, usage, rules and controls.
+    WHATSNEW.txt         - Changes since the previous versions of SuperTux.
+    COPYING              - The GNU General Public License, under whose terms
+                          SuperTux is licensed. (Most of the data
+                          subdirectory is also licensed under CC-by-SA)
+    docs/levelguidelines.txt - Very useful information for those that want to design
+                           levels for SuperTux.
+    data/credits.txt     - Credits for people that contributed to the creation
+                           of SuperTux. (You can view these in the game menu
+                           as well.)
+    data/README                 - Licensing information about the data.
 
 
 RUNNING THE GAME
 ----------------
   SuperTux makes use of proc to see where it is. In other words, it does not
   have any need to be installed and can be run from anywhere. This makes
 
 
 RUNNING THE GAME
 ----------------
   SuperTux makes use of proc to see where it is. In other words, it does not
   have any need to be installed and can be run from anywhere. This makes
-  it possible to click in the executable in your filemanager (ie. Konqueror,
-  Nautilus) as oposited to most of Linux games.
+  it possible to click in the executable in your filemanager (i.e. Konqueror or
+  Nautilus) as opposed to many other Linux games.
 
   Options can be reached from the menu, so you don't need to specify arguments,
 
   Options can be reached from the menu, so you don't need to specify arguments,
-  but if you want, type 'supertux --help' to check the ones that are avaible.
-  Also, notice that SuperTux saves the options, so you don't need to be allways
-  specifying them.
+  but if you want, type 'supertux2 --help' to check the ones that are available.
+  Also, notice that SuperTux saves the options, so it's often enough to
+  specify them once. For example, fullscreen mode causes problems on some setups,
+  so just run 'supertux2 --window' and you should be set.
 
 
-  The game has two frontends: SDL and OpenGL. Currently, there isn't any
-  noticiable difference between them. Basically, SDL uses software to draw
-  the game and OpenGL makes use of the videocards CPU (if the videocard has
-  one and the drivers support it). Under linux, nVidia is recommendaded
-  (with the closed drivers), but an ATI video card should work just fine.
+  The game uses OpenGL to render the graphics. You will either need a CPU
+  with about 10 GHz or an accelerated video card with the vendor's drivers.
+  (On Linux, the team recommends using cards from NVidia with the proprietary
+  drivers, but ATI or another vendor should do.)
 
 
 PLAYING THE GAME
 
 
 PLAYING THE GAME
@@ -83,73 +78,43 @@ PLAYING THE GAME
   Both keyboards and joysticks/gamepads are supported. You can change the
   controls via the Options menu. Basically, the only keys you will need to
   use in-game are to do the following actions: jump, duck, right, left, power
   Both keyboards and joysticks/gamepads are supported. You can change the
   controls via the Options menu. Basically, the only keys you will need to
   use in-game are to do the following actions: jump, duck, right, left, power
-  and 'P' to pause/unpause the game. I don't think there is anything to
-  explain about the others, but the power key, also called run, allow you
-  to run and use the power of the powerup you got. For instance, with the
-  fire flower, you can shoot bullets (note that this is the only power
-  currently implemented).
-  
+  and 'P' to pause/unpause the game. There isn't much to tell about the first
+  few, but the "action" key allows you to pick up objects and use any powerup
+  you got. For instance, with the fire flower, you can shoot bullets (note
+  that this is the only power currently implemented).
+
   Other useful keys include the Esc key, which is used to go to the menu or
   to go up a level in the menu. The menu can be navigated using the arrow
   keys or the mouse.
 
   Other useful keys include the Esc key, which is used to go to the menu or
   to go up a level in the menu. The menu can be navigated using the arrow
   keys or the mouse.
 
-  In the worldmap, the arrow keys are used to navigate and Enter enters the
-  current level.
+  In the worldmap, the arrow keys are used to navigate and Enter to enter
+  the current level.
 
 
-  The leveleditor is controled via the mouse, but there are shortcuts that
-  may make your life easier. To see the shortcuts for the buttons, just
-  do a Right-click on them. If you are interested in creating SuperTux
-  levels, we advise you to read LEVELDESIGN to learn more about the editor
-  and creating new levels.
 
 
+DEVELOPMENT STATUS
+------------------
+  This version of SuperTux is still under development, even though the
+  0.3 line of versions is somewhat aged. This means that badguys, features,
+  levels, graphics or anything else may be removed in the future.
 
 
-SCREEN LAYOUT
--------------
-  Status
-  ------
-    The amount of time you have left to complete this level is displayed in
-    the center at the top of the screen.  (Note: Time is NOT in seconds!)
-
-    The number of coins you have collected is displayed at the upper right.
-
-SCORING
--------
-  Enemies
-  -------
-    If you kill more than one enemy at a time without landing on the ground,
-    each enemy is worth more points.  For example, if there are three in a
-    row and you jump on the first, it's worth 50 points.  If you bounce off
-    the first and onto the second, it's worth 100 points.  If you also get
-    the third, it's worth 150 points.
+  Especially the Forest world included in this package may be subject to
+  drastic changes. These changes may go as far as removing the world
+  altogether. Currently (February 2010) there is no consensus within the
+  SuperTux development community regarding the fate of the Forest. Don't get
+  too attached to it ;)
 
 
-    You can also score by shooting at the enemies. Don't forget to get
-    the iceflower in order to get the ability to fire.
-
-
-OPTIONS FILE
-------------
-
-  When SuperTux starts up, it looks for an options file.
-
-  Under Linux, this file is "config" in your directory
-  ($HOME/.supertux/).
-  Under Windows, this file is "supertux.dat" in the SuperTux folder.
-  
-  This file records program's settings. It uses the LISP syntax. There
-  should be no reason to edit this file by hand.
 
 THE END
 -------
   Thanks for trying out SuperTux.
 
 
 THE END
 -------
   Thanks for trying out SuperTux.
 
-  If you like SuperTux, please rate and review it at the
-  Linux Game Tome:
+  If you like SuperTux, please rate and review it at the Linux Game Tome:
 
     http://www.happypenguin.org/
 
   Search for "SuperTux"!
 
 
     http://www.happypenguin.org/
 
   Search for "SuperTux"!
 
-
   Thanks!
 
   The SuperTux development team
   Thanks!
 
   The SuperTux development team
+
SVN import of the official repository.