-INSTALL.txt for Super Tux
+- Install instructions for SuperTux -
+http://supertux.berlios.de/
-by Bill Kendrick
-bill@newbreedsoftware.com
-http://www.newbreedsoftware.com/supertux/
+Last update: October 11, 2005 by Ondra Hosek
-Version 0.0.6
-
-December 15, 2004
+BINARIES
+--------
+
+ We try to provide precompiled binaries of supertux for a number of platforms.
+ You should check
+ http://supertux.berlios.de/wiki/index.php/Download/Installation
+
+ for the packages and instructions on how to install them. If there are no
+ prebuilt binaries for your platform, then you might still be able to compile
+ the sourcecode yourself. In this case read the next sections.
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.
-
- 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
- ---------
- 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.
-
+ To build supertux from source, you need to have a number of tools and
+ libraries installed. Note that most of these things should already be
+ available prepackaged and optimized for your distribution, it is recommended
+ that you check your distribution first before downloading from the websites.
+
+* Linux development tools (your distribution should come with these):
+ - gcc compiler version 3.2 or newer (you need the c++ compiler g++)
+ http://gcc.gnu.org
+ - gnu binutils
+ http://www.gnu.org/software/binutils
+ - a shell and posix commandline tools
+
+* perforce jam 2.5 or later
+ Download: ftp://ftp.perforce.com/pub/jam
+ Homepage: http://www.perforce.com/jam/jam.html
+
+* OpenGL headers and libraries
+ opengl libraries and headers are specific to your graphics card. Make sure
+ that you have hardware accelerated opengl drivers installed. Software
+ renderers like Mesa will make supertux unplayable slow.
+
+* SDL 1.2.5 or later (1.2.8 is recommended on MacOS/X)
+ http://www.libsdl.org
+
+* SDL_image (any version)
+ http://www.libsdl.org/projects/SDL_image
+
+* PhysicsFS (1.0.0, the development branch 1.1.x is buggy and does not work,
+ 1.2.0 and later should work when it is released)
+ http://www.icculus.org/physfs
+
+* OpenAL
+ There are no official linux releases of OpenAL yet, you should grab the
+ latest cvs snapshot (any snapshot from 2005 should work, earlier snapshots
+ tend to have bugs). OpenAL 1.0 or later implementations on other systems
+ like MacOS/X or windows should work.
+
+ http://www.openal.org
+
+ Note: We tried to write our code clean, portable and platform neutral, so it
+ should be possible to compile it on a wide range of platforms and also with
+ other compilers than gcc. However we have no resources to test other setups
+ and it is likely that you hit small problems. Reports and binary compiled
+ packages are of course always welcome. Send them to
+ supertux-devel@lists.berlios.de
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:
+ Supertux uses a normal autoconf configure script. The simplest way to compile
+ this package is:
- SDL_PREFIX=/usr/local
+ 1. `cd' to the directory containing the package's source code and type
+ `./configure' to configure the package for your system. If you're
+ using `csh' on an old version of System V, you might need to type
+ `sh ./configure' instead to prevent `csh' from trying to execute
+ `configure' itself.
- 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.)
+ 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.
+ Running `configure' takes awhile. While running, it prints some
+ messages telling which features it is checking for.
- DATA_PREFIX=$(PWD)/data/
+ 2. Type `jam' to compile the package.
- 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.
+ 3. Type `jam install' to install the programs and any data files and
+ documentation. (You should be root user on linux systems.
+ You can become root user with the `su' command or by using
+ `sudo jam install')
- This variable is useful if you plan on moving the "data/"
- directory elsewhere, say a globally-accessible
- "/usr/local/games/supertux-data/".
+ 4. The game should work now and you can remove the source directory
- JOY=YES
+ You can customize the build process by specifying additional parameters for
+ the configure script. Type `./configure --help' for additional informations.
+ Some common options are:
- 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".
+ --prefix=$HOME/.local
+ Installs supertux in your HOME directory in the .local folder.
+ This avoids the need for system administrator privileges when
+ installing the game
+ --with-XXX=Prefix
+ Manually specify the installation directory of a library
+ --enable-debug
+ Enables debug mode and compiles extra debug symbols into the supertux
+ executable. This is usefull when sending in bug reports to the
+ developers.
- 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
+Note for SVN users:
+ SuperTux does not need to be installed on the system, you can run it from
+ its own directory.
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 file is "supertux.xpm", and can be found in the
+ data/images/engine/icons/ directory.
+SUPPORT
+-------
-The End!
+ You can contact us at supertux-devel@lists.berlios.de and in the #supertux
+ channel on the irc.freenode.net irc server.
+
projects / supertux.git / blobdiff