It would be usefull to have an English-speaker reading these, since my English sux a bit (being modest ;) ).
SVN-Revision: 771
-CREDITS for Super Tux
- Version 0.0.6 (in development)
- January 1st, 2004
+- Those behind SuperTux -
+http://super-tux.sf.net/
-by Bill Kendrick
- <bill(at)newbreedsoftware.com>
- http://www.newbreedsoftware.com/supertux/
-& Tobias Glaesser
- <tobi.web(at)gmx.d>
+Last update: April 26, 2004
-CREDITS
--------
+- Project leader:
-Game Software:
---------------
-
-Bill Kendrick
- <bill(at)newbreedsoftware.com>
- http://www.newbreedsoftware.com/bill/
- Maintainer.
-
Tobias Glaesser
- <tobi.web(at)gmx.de>
- Maintainer.
+tobi.web@gmx.de
-Duong-Khang NGUYEN
- <neoneurone(at)users.sf.net>
+- Original author:
-Ricardo Cruz
- <rick2(at)aeiou.pt>
-
-Graphics:
----------
Bill Kendrick
- using The GIMP http://www.gimp.org/
+nbs@sonic.net
+http://www.newbreedsoftware.com/
-Original Tux created by Larry Ewing
- <lewing(at)isc.tamu.edu>
- http://www.isc.tamu.edu/~lewing/linux/
+- Programmers:
-Most Tux images for Super Tux
-created by Wesley Poole
- <kokido(at)postmark.net>
- http://members.xoom.com/kokido
+- Ricardo Cruz
+rick2@aeiou.pt
+http://rpmcruz.planetaclix.pt/
-Titlescreen Composed by Eric Windisch
- <raptor(at)bwbohh.net>
+- Ingo Ruhnke
+grumbel@gmx.de
+http://pingus.seul.org/~grumbel/
-Images for the darkstone theme &
-a icons for the level-editor.
-Tobias Glaesser
- <tobi.web(at)gmx.de>
-
-Improved images for the shared folder
-Duong-Khang NGUYEN
- <neoneurone(at)users.sf.net>
-
-Concept:
---------
-Gown (Tux's Girlfriend) from
-"Tux: A Quest For Herring"
- by Steve Baker <sjbaker1(at)airmail.net>
- http://tuxaqfh.sourceforge.net/
-
-Originally from "xTux"
-by Dave Lawrence & James Andrews
- http://xtux.sourceforge.net/
-
-Idea to play as Gown also
-from Steve Baker.
-
-"Mints" upgrade based
-on Penguin Mints.
- http://powermint.safeshopper.com/1/3.htm?63
-
-Sound Effects:
---------------
- Royalty free sound effects CDROMs and FTP sites.
-
-Miscellaneous:
- See CHANGES.txt for bug fixers, etc.
- Also, comments, suggestions and praise from:
-
-James Harr
- <jharr(at)mad.scientist.com>
-Robert S Dubinski
- <dubinski(at)mscs.mu.edu>
-Brian Stentzel
- <brian.stentzel(at)operamail.com>
+- Duong-Khang NGUYEN
+neoneurone@users.sourceforge.net
+
+- Matze Braun
+matze@braunis.de
+
+- Code contributors:
+
+Ryan Flegel
+xxdigitalhellxx@hotmail.com
+http://digitalhell.cjb.net/~ryan/
+
+- Graphics:
+
+Ingo Ruhnke
+grumbel@gmx.de
+http://pingus.seul.org/~grumbel/
+
+Christopher A. Webber
+creat0r@lingocomic.com
+
+- Level Design:
+
+Marek Moeckel
+wansti@gmx.de
+
+Ingo Ruhnke
+grumbel@gmx.de
+http://pingus.seul.org/~grumbel/
+
+- Musics:
+
+Marek Moeckel
+wansti@gmx.de
+
+- Sounds:
+
+Royalty free CDROMs and FTP sites sounds
+
+- More information and contacts:
+
+Visit our webpage at: http://super-tux.sf.net/
+
+Or chat with us directly on IRC:
+#supertux at irc.freenode.net
+
+Send your comments, ideas and suggestions
+to our mailing list at:
+super-tux-devel@lists.sourceforge.net
+
+You can also register yourself to know what's happening.
+A daily digest mailing is avaible.
+http://sourceforge.net/mail/?group_id=69183
+super-tux-devel is where we talk about SuperTux.
+super-tux-commit is where all changes in cvs are notifying for (only
+usefull for developers)
+
+
+Thank you for caring enough for our project to even read this
+file to the end :)
+- The SuperTux team
-CHANGES.txt for Super Tux
-by Bill Kendrick & Tobias Glaesser
-bill@newbreedsoftware.com
-http://www.newbreedsoftware.com/supertux/
+- SuperTux changes -
+http://super-tux.sf.net/
+Last update: April 26, 2004
+
+0.1
+
+ FIXME: paste mesages from the sourceforge cvs mailing list
+to here
0.0.6 - March 15th, 2004
---------------------------
-INSTALL.txt for Super Tux
-by Bill Kendrick
-bill@newbreedsoftware.com
-http://www.newbreedsoftware.com/supertux/
-
-Version 0.0.6
-
-December 15, 2004
+- Install instructions for SuperTux -
+http://super-tux.sf.net/
+Last update: April 26, 2004
REQUIREMENTS
------------
You will need the "SDL_mixer" library compiled and installed if
you want sound.
+ OpenGL implementation (optional)
+ ---------------------
+ Mesa should be installed in order to compile, but it is painly
+ slow when running, so we advise you to install your videocard
+ drivers (of course, it has to be an accelerated videocard).
+ For linux, nvidia vendor is the only one that makes decent drivers.
+ But the ATI drivers should run with the same performance, since
+ it only uses accelerated 2d, not 3d.
+ Anyway, you can use the SDL frontend and you most likely won't
+ notice any difference.
+
INSTALLING UNDER LINUX/UNIX
---------------------------
Note: Read this entire section before you start issuing commands!
-----------------------------------------------------------------
- First make sure SDL, SDL_image and, optionally, SDL_mixer, are
- installed on your system.
-
- The "Makefile" that comes with "Super Tux" assumes a number
- of defaults about your system. You can edit their values in
- the "Makefile" itself, or specify their values when you run
- the "make" command (ie, "make VARIABLE=value").
-
- The things you will wish to edit are:
-
- SDL_PREFIX=/usr/local
-
- This defines the base location where the "include/SDL/"
- and "lib/SDL/" directories will be found. (They contain
- the C header files and compiled object files for SDL,
- respectively.)
-
-
- DATA_PREFIX=$(PWD)/data/
-
- This defines where "Super Tux"'s "data/" directory is
- to be found. The default assumes that you wish to leave
- it where it is right now ("$(PWD)" expands to become the
- current direcotry.
-
- This variable is useful if you plan on moving the "data/"
- directory elsewhere, say a globally-accessible
- "/usr/local/games/supertux-data/".
+ SuperTux uses a script that checks for dependency and disables
+ features, in case they are not found.
+ The script is the configure and you can specify a few stuff
+ like the directory to which you want to install SuperTux,
+ by giving the argument --prefix=/usr/local (ie). For more
+ informations, type './configure --help'.
+ (Note: SuperTux does not need to be installed in the system,
+ you can run it from its own directory.)
- JOY=YES
+ If there isn't any configure script (ie. in case, you got it
+ via cvs), just run the autogen.sh script.
- This causes "Super Tux" to be compiled with joystick
- support. If you don't have a version of SDL that supports
- joystick, or just don't want joystick support, set this to "NO".
+ To compile it, a 'make' is enough.
+ Type 'make install' (as root) to copy it into the system.
+ (default directory is /usr/local, see above how to change
+ this.)
- DEBUG_FLAG=-DDEBUG
+ So, in short, just type:
+ sh autogen.sh (in case there isn't any configure file already)
+ sh configure
+ make
- This tells the compiler to generate an executable file with
- internal debugging messages. If you don't want to see those
- annoying texts, just edit it as below:
-
- DEBUG_FLAG=
-
- To compile the game, type the command:
-
- make [ with whatever variable changes you want, if any ]
-
- If you decided that you wanted the data somewhere else, make sure
- to move it there. If you wanted it to be accessible to others
- (ie, you're an administrator installing a new game for your users),
- make sure to set the permissions for the files! (You'll also want
- to move the "supertux" binary to somewhere globally accessible,
- and set its permissions, as well, of course!)
-
- Note: If you do not have the SDL_mixer library, or wish to not
- compile sound support into the game, you can compile it like this:
-
- make nosound [ with whatever variable changes you want, if any ]
-
- If you wish to return the directory to its distribution state,
- (remove the ".o" object files, and the "supertux" executable program
- file), you can run:
-
- make clean
+ And in case you want to copy SuperTux to the system:
+ make install (as root)
ICON FILE
---------
- A 32x32, XPM-format icon file (using the standard 23-color "cmap.xpm"
- color palette) is available if you wish to use an icon for this game.
-
- The file is "supertux-icon.xpm", and installed in Super Tux's
- "data/images/" directory.
-
+ A 32x32, XPM-format icon file is available if you wish to use
+ an icon for a menu entry for this game.
-The End!
+ The file is "icon.xpm", and can be found at the data/images/
+ directory.
+- Level editing for SuperTux -
+http://super-tux.sf.net/
+
+Last update: April 26, 2004
+
This document describes both the level format and
the level editor.
= LEVEL FORMAT =
-
-HEAD:
---------
-
-1. Name of the level.
-2. The theme of the level. The game will look in "supertuxdir/data/images/theme"
-3. The time you have to finish the level.
-4. Defines the music file, which should be played.
-5,6,7. RGB values for the background of the level.
-8. Defines the level's length.
-
-Example:
-----------
-Antarctica
-antarctica
-240
-ji_turn.it
-128
-192
-255
-375
-
-MAIN:
--------
-
-Levels are created with the following characters:
-(15 lines and as many columns as defined in the seventh line of the levelfile)
-
-X/x <- Brick0
-Y/y <- Brick1
-A/B/! <- Box full
-a <- Box empty
-C-F <- Cloud0
-c-f <- Cloud1
-G-J <- Bkgd0
-g-j <- Bkgd1
-# <- Solid0
-[ <- Solid1
-= <- Solid2
-] <- Solid3
-$ <- Distro
-^ <- Waves
-* <- Poletop
-| <- Pole
-\ <- Flag
-& <- Water
-
-Bad guys:
-
-0 <- BluescreenOfDeath
-1 <- Laptop
-2 <- Money
-
-= BUILT-IN LEVEL EDITOR =
-
+The level format used to be pretty easy to understand, but it
+is now more complex.
+Anyway, should be pretty usefull to know a bit of it, when you
+want to do stuff just as to just change the author's name or
+something small.
+
+It uses the Lisp syntax and is pretty intuitive. Here have a
+look at a quotation:
+(Comments can be made using ';')
+
+; This is a comment!
+(supertux-level
+; a few level's info: version, author and level's name
+ (version 1)
+ (author "Ingo Ruhnke")
+ (name "Night Chill")
+; number of tiles used (currently the height has to be 15)
+ (width 515)
+ (height 15)
+; Tux starts position
+ (start_pos_x 100)
+ (start_pos_y 170)
+; Background image, if any is specified, the color below will be used
+ (background "")
+; Music file
+ (music "Mortimers_chipdisko.mod")
+; Colors, as you can see you can have different colors in the top
+; and in the bottom, thus creating a gradient
+ (bkgd_red_top 0)
+ (bkgd_green_top 0)
+ (bkgd_blue_top 0)
+ (bkgd_red_bottom 120)
+ (bkgd_green_bottom 120)
+ (bkgd_blue_bottom 0)
+; Time (it is not in seconds!)
+ (time 300)
+; Gravity to be used (you should let it stay in 10 for ordinary levels)
+ (gravity 10)
+; The particle system allows that images can be displaying simulating weather
+; In the writing of this text, both "snow" and "clouds" are supported
+ (particle_system "snow")
+; Theme is the tiles look that are used
+ (theme "antarctica")
+ (interactive-tm
+; here goes a lot of numbers that are the tiles places
+ )
+; Reset points, there can be more than one
+; Reset points are positions where the player passes through and
+; if he dies, he will be back to there. They are invisible
+ (reset-points
+ (point (x 6988) (y 222))
+ )
+; Objects include enemies, may include more stuff in the future
+; just as moving plataforms...
+ (objects
+ (mriceblock (x 13919) (y 384))
+ (mriceblock (x 14258) (y 366))
+ (mriceblock (x 12996) (y 248))
+ (mriceblock (x 13058) (y 250))
+ (mriceblock (x 12933) (y 245))
+ )
+ )
+
+
+= LEVEL EDITORS =
USING THE BUILT-IN LEVEL EDITOR:
--------------------------------
To go back to the menu, just press Esc.
-Now, do lots of levels and HAVE FUN!!
+The levels are saved under a .supertux/levels directory in
+your home directory.
+
+FIXME: this description of the built-in level editor are
+out dated. Anyway, it is yet being developed.
+
+USING FLEXLAY:
+--------------
+
+FlexLay is an external project (it even uses different libraries)
+that is developed by Ingo Ruhnke and supports a lot of different
+games, including SuperTux (or else we wouldn't mention it :) ).
+
+Anyway, it is pretty easy to use and a lot more advanced than
+the internal one. So, if you are considering in doing a few levels
+for us, it may be a good idea to check this out.
+
+There isn't currently any webpage for it, just go to our webpage and
+you should find a download of this program.
+
+The only cons it has is that you have to have an accelerated
+videocard (with the drivers working, obviously). Anyway shouldn't
+be a problem nowadays.
+For linux, we advise nvidia videocards with the use of nvidia's closed
+drivers. ATI drivers should be enough to run this game though.
+
+
+= CONCLUSION =
+
+To sum up, go and do lots of levels and HAVE FUN!!
Please, send your levels or any art you created to the SuperTux's
-mailinglist or to the maintainer (look at AUTHORS.txt).
+mailinglist or to the maintainer (look at AUTHORS).
-SuperTux developers
+- SuperTux developers
-README.txt for Super Tux
-by Bill Kendrick
-bill@newbreedsoftware.com
-http://www.newbreedsoftware.com/supertux/
+- An introduction for SuperTux -
+http://super-tux.sf.net/
-Version 0.0.6
-
-March 15, 2004
+Last update: April 26, 2004
-
-NOTICE! THIS GAME IS UNDER CONSTRUCTION!
-Things you'll notice:
-
- Bugs
- Documentation is quite incomplete
- Only two levels
-
-
DESCRIPTION
-----------
- "Super Tux" is a game similar to Nintendo's "Super Mario Bros."(tm)
+ SuperTux is a jump'n run like game, with a strongly inspiration on
+ Nintendo's Super Mario Bros games.
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 them or bumping them from below. 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!
+
+- Gwen gets captured! -
+
+ Tux and Gwen 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 Gwen
+ is missing. Where she lay before now
+ lies a letter. "Tux, my arch enemy!"
+ says the letter. "I have captured
+ your beautiful Gwen 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
+ beloved Gwen, he begins his journey.
DOCUMENTATION
-------------
- Important documentation for "Super Tux" is contained in multiple files.
+ Important documentation for SuperTux 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"
+ AUTHORS - Credits for who made this game.
+ CHANGES - Changes since the previous versions of "Super Tux"
+ COPYING - The GNU Public License, which "Super Tux" is 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 "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.
+ 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.
- --disable-music - This option disables music. However, you can
- still turn it on/off later in the game.
+ 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.
- --fullscreen - Run in fullscreen mode.
+ 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 (in case the videocard has one and the drivers support
+ it). Under linux, nvidia is recommendaded (with the closed drivers), but
+ an ATI should work just fine.
- --help - Display a help message summarizing command-line
- options, copyright, and game controls.
- --usage - Display a brief message summarizing command-line
- options.
-
- --version - Display the version of Super Tux you're running.
-
-
-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.
+PLAYING THE GAME
+----------------
+ Controls
+ --------
+ Both keyboards and joysticks/gamepads are supported. You can change the
+ controls via the Options menu.
+ Basically, the only keys you will have to use is for the following actions:
+ jump, duck, right and left. Also press Esc to go to the menu and use the
+ key cursors and Enter under it. Oh, press P to pause the game.
+ In the worldmap, the arrow keys and Enter are enough.
- 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.
+ 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.
+ In any case, we advise you to read LEVELDESIGN to have the best productivity
+ with the leveleditor.
SCREEN LAYOUT
-------------
- UNDER CONSTRUCTION
-
- +-------------------------------------------------+
- |SCORE 1230 TIME 128 DISTROS 93 |
- |HIGH 100 |
- | |
- | |
- | |
- | |
- | |
- | |
- | |
- | |
- | |
- +-------------------------------------------------+
-
-
Status
------
- Your score is displayed at the upper left.
- Under your current score is the last highscore.
-
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 distros (CDs) you have collected is displayed at the upper
- right.
-
-
-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).
-
-
- To quit Super Tux altogether, you can use your window manager's
- close command. See the note in the "Title Screen" section, above.
-
+ The number of coins you have collected is displayed at the upper right.
SCORING
-------
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
+ You can also score by shooting at the ennemies. Don't forget to get
+ the flower in order to get the ability to fire.
OPTIONS FILE
($HOME/.supertux/).
Under Windows, this file is "supertux.dat" in the Super Tux folder.
- This file records program's settings.
-
-HIGHSCORE FILE
---------------
+ This file records program's settings. It uses the LISP syntax, anyway
+ there shouldn't be any reasons for you to hand edit it.
- 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!
- Bill Kendrick <bill@newbreedsoftware.com>
+ The SuperTux development team
projects / supertux.git / commitdiff