INSTALL

   1 - Install instructions for SuperTux -
   2 http://supertux.berlios.de/
   3
   4 Last update: October 11, 2005 by Ondra Hosek
   5
   6 REQUIREMENTS
   7 ------------
   8
   9   SDL
  10   ---
  11     The Simple DirectMedia Layer, a set of libraries made to simplify
  12     access to multimedia functions of various platforms, is required
  13     to compile this game.
  14
  15     You can download the SDL libraries from:
  16       http://www.libsdl.org/
  17
  18   SDL_image
  19   ---------
  20     SDL_image, an image-loading library based on SDL, is also required.
  21
  22     You can download SDL_image from:
  23       http://www.libsdl.org/projects/SDL_image/
  24
  25   OpenGL
  26   ------
  27     OpenGL is a graphics library that your system should already
  28     have (it is preinstalled on Windows and should be available
  29     in your X11 distribution on Unix systems).
  30
  31     To have the best performance possible, you should have an
  32     accelerated graphics card and use its vendor's drivers. Currently,
  33     only NVidia writes decent drivers for Linux, but since only
  34     accelerated 2D is used, the performance on ATI or other graphics
  35     cards shouldn't be significantly worse.
  36
  37     You will need the OpenGL headers to compile SuperTux, so it is
  38     advisable to first install Mesa (which should be included with your
  39     X11 distribution) on Unix to get the headers and only then replace
  40     the software rendering OpenGL library by installing the driver for
  41     your graphics card.
  42
  43   PhysicsFS
  44   ---------
  45     PhysicsFS provides a Quake 3-like data access method.
  46
  47     You can get PhysicsFS and more information about it from:
  48       http://icculus.org/physfs/
  49
  50   Jam
  51   ---
  52     If you want to build SuperTux, you will need Jam, a build system by
  53     Perforce. Extract the archive on your hard disk, run make and copy
  54     the compiled binary (in the bin.<platform> directory) into your PATH
  55     (e.g. /usr/bin).
  56
  57     You can download Jam from:
  58       ftp://ftp.perforce.com/jam/
  59
  60
  61 INSTALLING UNDER LINUX/UNIX
  62 ---------------------------
  63   -----------------------------------------------------------------
  64   Note: Read this entire section before you start issuing commands!
  65   -----------------------------------------------------------------
  66
  67   SuperTux uses a script that checks for dependencies and disables
  68   features in case the requirements are not met.
  69   The script is named configure and you can specify a few parameters
  70   like the directory to which you want to install SuperTux
  71   (by supplying the argument --prefix=/usr/local). For more
  72   information, type './configure --help'.
  73   (Note: SuperTux does not need to be installed on the system,
  74   you can run it from its own directory.)
  75
  76   If no configure script exists (e.g. in case you've retrieved SuperTux
  77   from SVN), just run the autogen.sh script. You'll need autoconf
  78   for this.
  79
  80   To compile SuperTux, a 'jam' is enough.
  81   Type 'jam install' (as root) to copy it into the system.
  82   (By default, SuperTux installs itself into /usr/local, see above how
  83   to change this behaviour.)
  84
  85   So, in short, just type:
  86   sh autogen.sh (in case there isn't any configure file already)
  87   sh configure
  88   jam
  89
  90   And in case you want to install SuperTux into the system:
  91   jam install (as root)
  92
  93
  94 ICON FILE
  95 ---------
  96   A 32x32, XPM-format icon file is available if you wish to use
  97   an icon for a menu entry for this game.
  98
  99   The file is "supertux.xpm", and can be found in the
 100   data/images/engine/icons/ directory.