X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=INSTALL;h=81b26021ded4626a55ff7e11e0953faf5c6eda58;hb=f8df336d940f3e97dcdecfe5f5201792981b0caf;hp=f75a7287bc3bc0dd1062ce80d4bf26c1a7909ccb;hpb=dde1bc990a28e2c0fc8cb4c7dd22443483fb8e72;p=supertux.git diff --git a/INSTALL b/INSTALL index f75a7287b..81b26021d 100644 --- a/INSTALL +++ b/INSTALL @@ -1,47 +1,61 @@ -INSTALL.txt for Super Tux - -by Bill Kendrick -bill@newbreedsoftware.com -http://www.newbreedsoftware.com/supertux/ - -Version 0.0.6 (in development) - -December 26th, 2003 +- Install instructions for SuperTux - +http://supertux.berlios.de/ +Last update: October 11, 2005 by Ondra Hosek REQUIREMENTS ------------ - CONTROLS - -------- - The game can be played with either a the keyboard or a joystick. - SDL --- - "Super Tux" was programed using the "Simple Direct Media" layer - libraries by Sam Lantinga. This means that the game can - theoretically run under any environment that the SDL libraries support. - - (As of this program's release, this includes: Linux X11/DGA, - Win32 WinDIB/DirectX, BeOS BWindow, and Solaris X11, as well - as unofficually supported: Linux SVGAlib, IRIX 6.x X11, - FreeBSD 3.x X11, and MacOS.) - - The Simple DirectMedia Layer is required to compile this game. + The Simple DirectMedia Layer, a set of libraries made to simplify + access to multimedia functions of various platforms, is required + to compile this game. You can download the SDL libraries from: http://www.libsdl.org/ SDL_image --------- - SDL_image is also required. (It is used to load the PNG format images - that come with Super Tux!) - - SDL_mixer + SDL_image, an image-loading library based on SDL, is also required. + + You can download SDL_image from: + http://www.libsdl.org/projects/SDL_image/ + + OpenGL + ------ + OpenGL is a graphics library that your system should already + have (it is preinstalled on Windows and should be available + in your X11 distribution on Unix systems). + + To have the best performance possible, you should have an + accelerated graphics card and use its vendor's drivers. Currently, + only NVidia writes decent drivers for Linux, but since only + accelerated 2D is used, the performance on ATI or other graphics + cards shouldn't be significantly worse. + + You will need the OpenGL headers to compile SuperTux, so it is + advisable to first install Mesa (which should be included with your + X11 distribution) on Unix to get the headers and only then replace + the software rendering OpenGL library by installing the driver for + your graphics card. + + PhysicsFS --------- - Sound and music are available, but are not required (see below). - You will need the "SDL_mixer" library compiled and installed if - you want sound. + PhysicsFS provides a Quake 3-like data access method. + + You can get PhysicsFS and more information about it from: + http://icculus.org/physfs/ + + Jam + --- + If you want to build SuperTux, you will need Jam, a build system by + Perforce. Extract the archive on your hard disk, run make and copy + the compiled binary (in the bin. directory) into your PATH + (e.g. /usr/bin). + + You can download Jam from: + ftp://ftp.perforce.com/jam/ INSTALLING UNDER LINUX/UNIX @@ -50,79 +64,37 @@ 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.) + SuperTux uses a script that checks for dependencies and disables + features in case the requirements are not met. + The script is named configure and you can specify a few parameters + like the directory to which you want to install SuperTux + (by supplying the argument --prefix=/usr/local). For more + information, type './configure --help'. + (Note: SuperTux does not need to be installed on the system, + you can run it from its own directory.) + If no configure script exists (e.g. in case you've retrieved SuperTux + from SVN), just run the autogen.sh script. You'll need autoconf + for this. - DATA_PREFIX=$(PWD)/data/ + To compile SuperTux, a 'jam' is enough. + Type 'jam install' (as root) to copy it into the system. + (By default, SuperTux installs itself into /usr/local, see above how + to change this behaviour.) - 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. + So, in short, just type: + sh autogen.sh (in case there isn't any configure file already) + sh configure + jam - This variable is useful if you plan on moving the "data/" - directory elsewhere, say a globally-accessible - "/usr/local/games/supertux-data/". - - JOY=YES - - 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". - - DEBUG_FLAG=-DDEBUG - - 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 install SuperTux into the system: + jam 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 "supertux.xpm", and can be found in the + data/images/engine/icons/ directory.