1 INSTALL.txt for Super Tux
4 bill@newbreedsoftware.com
5 http://www.newbreedsoftware.com/supertux/
17 The game is controlled using a mouse. It can be played with either
18 a mouse or a joystick.
22 "Super Tux" was programed using the "Simple Direct Media" layer
23 libraries by Sam Lantinga. This means that the game can
24 theoretically run under any environment that the SDL libraries support.
26 (As of this program's release, this includes: Linux X11/DGA,
27 Win32 WinDIB/DirectX, BeOS BWindow, and Solaris X11, as well
28 as unofficually supported: Linux SVGAlib, IRIX 6.x X11,
29 FreeBSD 3.x X11, and MacOS.)
31 The Simple DirectMedia Layer is required to compile this game.
33 You can download the SDL libraries from:
34 http://www.libsdl.org/
38 SDL_image is also required. (It is used to load the PNG format images
39 that come with Super Tux!)
43 Sound and music are available, but are not required (see below).
44 You will need the "SDL_mixer" library compiled and installed if
48 INSTALLING UNDER LINUX/UNIX
49 ---------------------------
50 -----------------------------------------------------------------
51 Note: Read this entire section before you start issuing commands!
52 -----------------------------------------------------------------
54 First make sure SDL, SDL_image and, optionally, SDL_mixer, are
55 installed on your system.
57 The "Makefile" that comes with "Super Tux" assumes a number
58 of defaults about your system. You can edit their values in
59 the "Makefile" itself, or specify their values when you run
60 the "make" command (ie, "make VARIABLE=value").
62 The things you will wish to edit are:
66 This defines the base location where the "include/SDL/"
67 and "lib/SDL/" directories will be found. (They contain
68 the C header files and compiled object files for SDL,
72 DATA_PREFIX=$(PWD)/data/
74 This defines where "Super Tux"'s "data/" directory is
75 to be found. The default assumes that you wish to leave
76 it where it is right now ("$(PWD)" expands to become the
79 This variable is useful if you plan on moving the "data/"
80 directory elsewhere, say a globally-accessible
81 "/usr/local/games/supertux-data/".
85 This causes "Super Tux" to be compiled with joystick
86 support. If you don't have a version of SDL that supports
87 joystick, or just don't want joystick support, set this to "NO".
90 To compile the game, type the command:
92 make [ with whatever variable changes you want, if any ]
94 If you decided that you wanted the data somewhere else, make sure
95 to move it there. If you wanted it to be accessible to others
96 (ie, you're an administrator installing a new game for your users),
97 make sure to set the permissions for the files! (You'll also want
98 to move the "supertux" binary to somewhere globally accessible,
99 and set its permissions, as well, of course!)
101 Note: If you do not have the SDL_mixer library, or wish to not
102 compile sound support into the game, you can compile it like this:
104 make nosound [ with whatever variable changes you want, if any ]
106 If you wish to return the directory to its distribution state,
107 (remove the ".o" object files, and the "supertux" executable program
115 A 32x32, XPM-format icon file (using the standard 23-color "cmap.xpm"
116 color palette) is available if you wish to use an icon for this game.
118 The file is "supertux-icon.xpm", and installed in Super Tux's
119 "data/images/" directory.