INSTALL

   1 - Install instructions for SuperTux -
   2 http://supertux.berlios.de/
   3
   4 Last update: October 11, 2005 by Ondra Hosek
   5
   6 BINARIES
   7 --------
   8
   9   We try to provide precompiled binaries of supertux for a number of platforms.
  10   You should check
  11
  12     http://supertux.berlios.de/wiki/index.php/Download/Installation
  13
  14   for the packages and instructions on how to install them. If there are no
  15   prebuilt binaries for your platform, then you might still be able to compile
  16   the sourcecode yourself. In this case read the next sections.
  17
  18 REQUIREMENTS
  19 ------------
  20
  21   To build supertux from source, you need to have a number of tools and
  22   libraries installed. Note that most of these things should already be
  23   available prepackaged and optimized for your distribution, it is recommended
  24   that you check your distribution first before downloading from the websites.
  25
  26 * Linux development tools (your distribution should come with these):
  27     - gcc compiler version 3.2 or newer (you need the c++ compiler g++)
  28         http://gcc.gnu.org
  29     - gnu binutils
  30         http://www.gnu.org/software/binutils
  31     - a shell and posix commandline tools
  32
  33 * perforce jam 2.5 or later
  34     Download: ftp://ftp.perforce.com/pub/jam
  35     Homepage: http://www.perforce.com/jam/jam.html
  36
  37 * OpenGL headers and libraries
  38     opengl libraries and headers are specific to your graphics card. Make sure
  39     that you have hardware accelerated opengl drivers installed. Software
  40     renderers like Mesa will make supertux unplayable slow.
  41
  42 * SDL 1.2.5 or later (1.2.8 is recommended on MacOS/X)
  43     http://www.libsdl.org
  44
  45 * SDL_image (any version)
  46     http://www.libsdl.org/projects/SDL_image
  47
  48 * PhysicsFS (1.0.0, the development branch 1.1.x is buggy and does not work,
  49              1.2.0 and later should work when it is released)
  50     http://www.icculus.org/physfs
  51
  52 * OpenAL
  53     There are no official linux releases of OpenAL yet, you should grab the
  54     latest cvs snapshot (any snapshot from 2005 should work, earlier snapshots
  55     tend to have bugs). OpenAL 1.0 or later implementations on other systems
  56     like MacOS/X or windows should work.
  57
  58     http://www.openal.org
  59
  60   Note: We tried to write our code clean, portable and platform neutral, so it
  61   should be possible to compile it on a wide range of platforms and also with
  62   other compilers than gcc. However we have no resources to test other setups
  63   and it is likely that you hit small problems. Reports and binary compiled
  64   packages are of course always welcome. Send them to
  65   supertux-devel@lists.berlios.de
  66
  67 INSTALLING UNDER LINUX/UNIX
  68 ---------------------------
  69
  70   Supertux uses a normal autoconf configure script. The simplest way to compile
  71   this package is:
  72
  73     1. `cd' to the directory containing the package's source code and type
  74        `./configure' to configure the package for your system.  If you're
  75        using `csh' on an old version of System V, you might need to type
  76        `sh ./configure' instead to prevent `csh' from trying to execute
  77        `configure' itself.
  78
  79        If no configure script exists (e.g. in case you've retrieved SuperTux
  80        from SVN), just run the autogen.sh script. You'll need autoconf
  81        for this.
  82
  83        Running `configure' takes awhile.  While running, it prints some
  84        messages telling which features it is checking for.
  85
  86     2. Type `jam' to compile the package.
  87
  88     3. Type `jam install' to install the programs and any data files and
  89        documentation. (You should be root user on linux systems.
  90        You can become root user with the `su' command or by using
  91        `sudo jam install')
  92
  93     4. The game should work now and you can remove the source directory
  94
  95   You can customize the build process by specifying additional parameters for
  96   the configure script. Type `./configure --help' for additional informations.
  97   Some common options are:
  98
  99     --prefix=$HOME/.local
 100         Installs supertux in your HOME directory in the .local folder.
 101         This avoids the need for system administrator privileges when
 102         installing the game
 103     --with-XXX=Prefix
 104         Manually specify the installation directory of a library
 105     --enable-debug
 106         Enables debug mode and compiles extra debug symbols into the supertux
 107         executable. This is usefull when sending in bug reports to the
 108         developers.
 109
 110 Note for SVN users:
 111   SuperTux does not need to be installed on the system, you can run it from
 112   its own directory.
 113
 114
 115 ICON FILE
 116 ---------
 117
 118   A 32x32, XPM-format icon file is available if you wish to use
 119   an icon for a menu entry for this game.
 120
 121   The file is "supertux.xpm", and can be found in the
 122   data/images/engine/icons/ directory.
 123
 124 SUPPORT
 125 -------
 126
 127   You can contact us at supertux-devel@lists.berlios.de and in the #supertux
 128   channel on the irc.freenode.net irc server.
 129