INSTALL

   1 INSTALL.txt for Super Tux
   2
   3 by Bill Kendrick
   4 bill@newbreedsoftware.com
   5 http://www.newbreedsoftware.com/supertux/
   6
   7 Version 0.0.6 (in development)
   8
   9 December 26th, 2003
  10
  11
  12 REQUIREMENTS
  13 ------------
  14
  15   CONTROLS
  16   --------
  17     The game can be played with either a the keyboard or a joystick.
  18
  19   SDL
  20   ---
  21     "Super Tux" was programed using the "Simple Direct Media" layer
  22     libraries by Sam Lantinga.  This means that the game can
  23     theoretically run under any environment that the SDL libraries support.
  24
  25     (As of this program's release, this includes: Linux X11/DGA,
  26     Win32 WinDIB/DirectX, BeOS BWindow, and Solaris X11, as well
  27     as unofficually supported: Linux SVGAlib, IRIX 6.x X11,
  28     FreeBSD 3.x X11, and MacOS.)
  29
  30     The Simple DirectMedia Layer is required to compile this game.
  31
  32     You can download the SDL libraries from:
  33       http://www.libsdl.org/
  34
  35   SDL_image
  36   ---------
  37     SDL_image is also required.  (It is used to load the PNG format images
  38     that come with Super Tux!)
  39
  40   SDL_mixer
  41   ---------
  42     Sound and music are available, but are not required (see below).
  43     You will need the "SDL_mixer" library compiled and installed if
  44     you want sound.
  45
  46
  47 INSTALLING UNDER LINUX/UNIX
  48 ---------------------------
  49   -----------------------------------------------------------------
  50   Note: Read this entire section before you start issuing commands!
  51   -----------------------------------------------------------------
  52
  53   First make sure SDL, SDL_image and, optionally, SDL_mixer, are
  54   installed on your system.
  55
  56   The "Makefile" that comes with "Super Tux" assumes a number
  57   of defaults about your system.  You can edit their values in
  58   the "Makefile" itself, or specify their values when you run
  59   the "make" command (ie, "make VARIABLE=value").
  60
  61   The things you will wish to edit are:
  62
  63     SDL_PREFIX=/usr/local
  64
  65       This defines the base location where the "include/SDL/"
  66       and "lib/SDL/" directories will be found.  (They contain
  67       the C header files and compiled object files for SDL,
  68       respectively.)
  69
  70
  71     DATA_PREFIX=$(PWD)/data/
  72
  73       This defines where "Super Tux"'s "data/" directory is
  74       to be found.  The default assumes that you wish to leave
  75       it where it is right now ("$(PWD)" expands to become the
  76       current direcotry.
  77
  78       This variable is useful if you plan on moving the "data/"
  79       directory elsewhere, say a globally-accessible
  80       "/usr/local/games/supertux-data/".
  81
  82     JOY=YES
  83
  84       This causes "Super Tux" to be compiled with joystick
  85       support.  If you don't have a version of SDL that supports
  86       joystick, or just don't want joystick support, set this to "NO".
  87
  88     DEBUG_FLAG=-DDEBUG
  89
  90       This tells the compiler to generate an executable file with
  91       internal debugging messages. If you don't want to see those
  92       annoying texts, just edit it as below:
  93
  94     DEBUG_FLAG=
  95
  96   To compile the game, type the command:
  97
  98     make           [ with whatever variable changes you want, if any ]
  99
 100   If you decided that you wanted the data somewhere else, make sure
 101   to move it there.  If you wanted it to be accessible to others
 102   (ie, you're an administrator installing a new game for your users),
 103   make sure to set the permissions for the files!  (You'll also want
 104   to move the "supertux" binary to somewhere globally accessible,
 105   and set its permissions, as well, of course!)
 106
 107   Note: If you do not have the SDL_mixer library, or wish to not
 108   compile sound support into the game, you can compile it like this:
 109
 110     make nosound   [ with whatever variable changes you want, if any ]
 111
 112   If you wish to return the directory to its distribution state,
 113   (remove the ".o" object files, and the "supertux" executable program
 114   file), you can run:
 115
 116     make clean
 117
 118
 119 ICON FILE
 120 ---------
 121   A 32x32, XPM-format icon file (using the standard 23-color "cmap.xpm"
 122   color palette) is available if you wish to use an icon for this game.
 123
 124   The file is "supertux-icon.xpm", and installed in Super Tux's
 125   "data/images/" directory.
 126
 127
 128 The End!