1 INSTALL.txt for Super Tux
4 bill@newbreedsoftware.com
5 http://www.newbreedsoftware.com/supertux/
17 The game can be played with either a the keyboard or a joystick.
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.
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.)
30 The Simple DirectMedia Layer is required to compile this game.
32 You can download the SDL libraries from:
33 http://www.libsdl.org/
37 SDL_image is also required. (It is used to load the PNG format images
38 that come with Super Tux!)
42 Sound and music are available, but are not required (see below).
43 You will need the "SDL_mixer" library compiled and installed if
47 INSTALLING UNDER LINUX/UNIX
48 ---------------------------
49 -----------------------------------------------------------------
50 Note: Read this entire section before you start issuing commands!
51 -----------------------------------------------------------------
53 First make sure SDL, SDL_image and, optionally, SDL_mixer, are
54 installed on your system.
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").
61 The things you will wish to edit are:
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,
71 DATA_PREFIX=$(PWD)/data/
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
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/".
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".
89 To compile the game, type the command:
91 make [ with whatever variable changes you want, if any ]
93 If you decided that you wanted the data somewhere else, make sure
94 to move it there. If you wanted it to be accessible to others
95 (ie, you're an administrator installing a new game for your users),
96 make sure to set the permissions for the files! (You'll also want
97 to move the "supertux" binary to somewhere globally accessible,
98 and set its permissions, as well, of course!)
100 Note: If you do not have the SDL_mixer library, or wish to not
101 compile sound support into the game, you can compile it like this:
103 make nosound [ with whatever variable changes you want, if any ]
105 If you wish to return the directory to its distribution state,
106 (remove the ".o" object files, and the "supertux" executable program
114 A 32x32, XPM-format icon file (using the standard 23-color "cmap.xpm"
115 color palette) is available if you wish to use an icon for this game.
117 The file is "supertux-icon.xpm", and installed in Super Tux's
118 "data/images/" directory.