INSTALL

   1 - Install instructions for SuperTux -
   2 http://supertux.lethargik.org/
   3
   4 Last update: December 20, 2007 by Christoph Sommer
   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.lethargik.org/wiki/Download
  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 source code 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   You can also check
  26
  27     http://supertux.lethargik.org/wiki/Building_SuperTux
  28
  29   for up-to-date build instructions for a variety of different platforms and
  30   distributions.
  31
  32 * Linux development tools (your distribution should come with these):
  33     - gcc compiler suite version 3.2 or newer (you need the c++ compiler g++)
  34         http://gcc.gnu.org
  35     - gnu binutils
  36         http://www.gnu.org/software/binutils
  37     - a shell and POSIX commandline tools
  38
  39 * CMake 2.6 or later
  40     Download: http://www.cmake.org/HTML/Download.html
  41     Homepage: http://www.cmake.org/
  42
  43 * OpenGL headers and libraries
  44     OpenGL libraries and headers are specific to your graphics card. Make sure
  45     that you have hardware accelerated OpenGL drivers installed. Software
  46     renderers like Mesa will make SuperTux unplayable slow.
  47
  48 * SDL 1.2.5 or later (1.2.8 is recommended on Mac OS X)
  49     http://www.libsdl.org
  50
  51 * SDL_image (any version that includes PNG and JPEG support)
  52     http://www.libsdl.org/projects/SDL_image
  53
  54 * PhysicsFS (1.0.x or 2.0.x)
  55     http://www.icculus.org/physfs
  56
  57 * OpenAL
  58     There are no official Linux releases of OpenAL yet, you should grab the
  59     latest CVS snapshot (any snapshot from 2005 should work, earlier snapshots
  60     tend to have bugs). OpenAL 1.0 or later implementations on other systems
  61     like Mac OS X or windows should work.
  62
  63     http://www.openal.org
  64 * GLEW
  65     http://glew.sourceforge.net/
  66
  67 * Boost's smart_ptr headers
  68     http://www.boost.org/
  69
  70   Note: We tried to write our code clean, portable and platform neutral, so it
  71   should be possible to compile it on a wide range of platforms and also with
  72   other compilers than gcc. However we have no resources to test other setups
  73   and it is likely that you hit small problems. Reports and binary compiled
  74   packages are of course always welcome. Send them to
  75   supertux-devel@lists.lethargik.org
  76
  77 INSTALLING UNDER LINUX/UNIX USING CMAKE
  78 ---------------------------------------
  79
  80   SuperTux uses CMake to generate a set of Makefiles for the build process. To
  81   generate these Makefiles and build SuperTux, perform the following steps:
  82
  83     1. `cd' to the directory where you unpacked the SuperTux source
  84        archive, i.e. to the directory containing `src' and `data'.
  85
  86     2. Create and change to a new, empty build directory by running
  87        `mkdir build', `cd build'.
  88
  89     3. Run `cmake ..' to create the Makefiles needed to build SuperTux with
  90        standard options. If you are missing any libraries needed to build
  91        SuperTux, install those first, then try running CMake again. See below
  92        for instructions on how to change to standard options.
  93
  94     4. Type `make' to start the build process.
  95
  96     5. Type `make install' to install the programs and any data files and
  97        documentation. (You should be a root user on Linux systems.
  98        You can become a root user with the `su' command or by using
  99        `sudo make install')
 100
 101        Note that there is no uninstall target, so you might wish to create a
 102        package or other system-specific installation instead.
 103
 104     6. The game should work now and you can remove the source directory.
 105
 106   You can customize the build process by setting additional options for CMake.
 107   The easiest way to do this is to use run `ccmake ..' instead of `cmake ..'
 108   to bring up the curses-based user interface of CMake. Select an option using the
 109   arrow keys, change the selected option by pressing the Enter key, then
 110   hit the `c' (repeatedly, if necessary) to apply your changes and bring
 111   up new options resulting from your newly set ones. When you are done, press
 112   the `g' key to generate a new set of Makefiles and exit.
 113
 114   Alternatively, you can pass options to `cmake ..' via the command line.
 115   Some common command line switches are:
 116
 117     -DCMAKE_VERBOSE_MAKEFILE=ON
 118         Generates Makefiles that print all commands prior to executing them.
 119     -Dxxx_LIBRARY=/path/to/library.so -Dxxx_INCLUDE_DIR=/path/to/headerfiles
 120         Manually specify the installation directory of a library.
 121     -DCMAKE_BUILD_TYPE=DEBUG
 122         Enables debug mode and compiles extra debug symbols into the SuperTux
 123         executable. This is useful when sending in bug reports to the
 124         developers.
 125     -DCMAKE_BUILD_TYPE=RELEASE
 126         Enables release mode and compiles some sanity checks out of the build.
 127
 128 Note for SVN users:
 129   SuperTux does not need to be installed on the system, you can run it from
 130   its own directory.
 131
 132 SUPPORT
 133 -------
 134
 135   You can contact us at supertux-devel@lists.lethargik.org and in the #supertux
 136   channel on the irc.freenode.net IRC server.
 137