X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=README;h=7576d30cfa6164b2e2c172f11c364e0979bbad1a;hb=9ea35748100d9feb67a66f8a6656cc60f41bfa8c;hp=ec797333464d98bd614c1d25c3f123df02d8d877;hpb=dde1bc990a28e2c0fc8cb4c7dd22443483fb8e72;p=supertux.git diff --git a/README b/README index ec7973334..7576d30cf 100644 --- a/README +++ b/README @@ -1,198 +1,112 @@ -README.txt for Super Tux -by Bill Kendrick -bill@newbreedsoftware.com -http://www.newbreedsoftware.com/supertux/ - -Version 0.0.6 (in development) - -December 26th, 2003 - - -NOTICE! THIS GAME IS UNDER CONSTRUCTION! -Things you'll notice: - - Bugs - Documentation is quite incomplete - Only two levels +- An introduction for SuperTux - +http://supertux.lethargik.org/ +Last update: December 20, 2007 DESCRIPTION ----------- - "Super Tux" is a game similar to Nintendo's "Super Mario Bros."(tm) + 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 - on them or bumping them from below. Grab power-ups and Linux distributions - on the way. + on them, bumping them from below or tossing objects at them, grabbing + power-ups and other stuff on the way. STORY ----- - Tux and Gown are having a picnic in Antarctica, when suddenly Gown is - abducted! Tux must follow the path of clues across the globe to find - his girlfriend and save her! - - -DOCUMENTATION -------------- - Important documentation for "Super Tux" is contained in multiple files. - Please see them: - - AUTHORS.txt - Credits for who made this game. - CHANGES.txt - Changes since the previous versions of "Super Tux" - COPYING.txt - The GNU Public License, which "Super Tux" is under. - INSTALL.txt - Instructions on requirements, compiling and installing. - README.txt - (This file.) Game story, usage, rules and controls. - TODO.txt - A wish-list for this version of "Super Tux" - - -RUNNING THE GAME ----------------- - Just type "./supertux" to get started. - - The program accepts some options: - - --disable-sound - If sound support was compiled in, this will - disable it. You can also turn on/off sound - during the game. - - --disable-music - This option disables music. However, you can - still turn it on/off later in the game. - - --fullscreen - Run in fullscreen mode. - --help - Display a help message summarizing command-line - options, copyright, and game controls. +- Penny gets captured! - - --usage - Display a brief message summarizing command-line - options. + 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! - --version - Display the version of Super Tux you're running. + 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. -TITLE SCREEN ------------- - Press [RETURN] or a joystick firebutton to begin a game. - Press [ESCAPE] or choose [Quit] to quit. - - Use arrow keys to move between menu's items. Press [RETURN] or [SPACE] to validate - your choice. - - Note: If you're playing Super Tux in a window, you can also use - your window manager's close option (usually an "X" button on the window's - title bar) to quit. This works at ANY time. - - -SCREEN LAYOUT +DOCUMENTATION ------------- - UNDER CONSTRUCTION + Important documentation for SuperTux is contained in multiple files. + Please see them: - +-------------------------------------------------+ - |SCORE 1230 TIME 128 DISTROS 93 | - |HIGH 100 | - | | - | | - | | - | | - | | - | | - | | - | | - | | - +-------------------------------------------------+ + 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. + levelguidelines.txt - Very useful information for those that want to design + levels for SuperTux. + credits.txt - Credits for people that contributed to the creation + of SuperTux. (You can view these in the game menu + as well.) - Status - ------ - Your score is displayed at the upper left. - Under your current score is the last highscore. +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 (i.e. Konqueror or + Nautilus) as opposed to many other Linux games. - 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!) + Options can be reached from the menu, so you don't need to specify arguments, + 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. - The number of distros (CDs) you have collected is displayed at the upper - right. + 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 ---------------- Controls -------- - Joystick Keyboard Purpose - -------- -------- ------- - Left Left Face/Move Left - Right Right Face/Move Right - Button-A Up Jump - Button-B Control Run/Fire - Down Down Duck - - Pausing - ------- - - To pause the game, you can press the [P] key. - To unpause, press [P] again. - - Quitting - -------- - To quit the current game, you can press [ESCAPE] to open the game's menu - then choose [Quit game]. This forfeits your game (as though you ran - out of lives). - + 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. 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). - To quit Super Tux altogether, you can use your window manager's - close command. See the note in the "Title Screen" section, above. + 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 to enter + the current level. -SCORING -------- - Enemies - ------- - If you get 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. - - You can also score by shooting at the ennemies. Don't forget to drink - the coffee in order to get the ability to fire. - -GAME OVER SCREEN ----------------- - NOT IMPLEMENTED - - -OPTIONS FILE ------------- - - When Super Tux 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 Super Tux folder. - - This file records program's settings. - -HIGHSCORE FILE --------------- - - When Super Tux starts up, it looks for an highscore file. - - Under Linux, this file is "highscore" in your directory - ($HOME/.supertux/). - Under Windows, this file is "st_highscore.dat" in the Super Tux folder. - THE END ------- - Thanks for trying out Super Tux. + Thanks for trying out SuperTux. - If you like Super Tux, please rate and review it at the + If you like SuperTux, please rate and review it at the Linux Game Tome: http://www.happypenguin.org/ - Search for "Super Tux"! - + Search for "SuperTux"! Thanks! - Bill Kendrick + The SuperTux development team +