X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=INSTALL;h=9dac7063552e4283ec1fb726b7d360f324636b84;hb=4da8aac2302304aca707d1e494571e6a219ec861;hp=81b26021ded4626a55ff7e11e0953faf5c6eda58;hpb=44eca39a2f8e6be8b5dece224872fe5222feefa7;p=supertux.git diff --git a/INSTALL b/INSTALL index 81b26021d..9dac70635 100644 --- a/INSTALL +++ b/INSTALL @@ -1,100 +1,137 @@ - Install instructions for SuperTux - -http://supertux.berlios.de/ +http://supertux.lethargik.org/ -Last update: October 11, 2005 by Ondra Hosek +Last update: December 20, 2007 by Christoph Sommer + +BINARIES +-------- + + We try to provide precompiled binaries of SuperTux for a number of platforms. + You should check + + http://supertux.lethargik.org/wiki/Download + + for the packages and instructions on how to install them. If there are no + prebuilt binaries for your platform, then you might still be able to compile + the source code yourself. In this case read the next sections. REQUIREMENTS ------------ - SDL - --- - The Simple DirectMedia Layer, a set of libraries made to simplify - access to multimedia functions of various platforms, is required - to compile this game. - - You can download the SDL libraries from: - http://www.libsdl.org/ - - SDL_image - --------- - SDL_image, an image-loading library based on SDL, is also required. - - You can download SDL_image from: - http://www.libsdl.org/projects/SDL_image/ - - OpenGL - ------ - OpenGL is a graphics library that your system should already - have (it is preinstalled on Windows and should be available - in your X11 distribution on Unix systems). - - To have the best performance possible, you should have an - accelerated graphics card and use its vendor's drivers. Currently, - only NVidia writes decent drivers for Linux, but since only - accelerated 2D is used, the performance on ATI or other graphics - cards shouldn't be significantly worse. - - You will need the OpenGL headers to compile SuperTux, so it is - advisable to first install Mesa (which should be included with your - X11 distribution) on Unix to get the headers and only then replace - the software rendering OpenGL library by installing the driver for - your graphics card. - - PhysicsFS - --------- - PhysicsFS provides a Quake 3-like data access method. - - You can get PhysicsFS and more information about it from: - http://icculus.org/physfs/ - - Jam - --- - If you want to build SuperTux, you will need Jam, a build system by - Perforce. Extract the archive on your hard disk, run make and copy - the compiled binary (in the bin. directory) into your PATH - (e.g. /usr/bin). - - You can download Jam from: - ftp://ftp.perforce.com/jam/ - - -INSTALLING UNDER LINUX/UNIX ---------------------------- - ----------------------------------------------------------------- - Note: Read this entire section before you start issuing commands! - ----------------------------------------------------------------- - - SuperTux uses a script that checks for dependencies and disables - features in case the requirements are not met. - The script is named configure and you can specify a few parameters - like the directory to which you want to install SuperTux - (by supplying the argument --prefix=/usr/local). For more - information, type './configure --help'. - (Note: SuperTux does not need to be installed on the system, - you can run it from its own directory.) - - If no configure script exists (e.g. in case you've retrieved SuperTux - from SVN), just run the autogen.sh script. You'll need autoconf - for this. - - To compile SuperTux, a 'jam' is enough. - Type 'jam install' (as root) to copy it into the system. - (By default, SuperTux installs itself into /usr/local, see above how - to change this behaviour.) - - So, in short, just type: - sh autogen.sh (in case there isn't any configure file already) - sh configure - jam - - And in case you want to install SuperTux into the system: - jam install (as root) - - -ICON FILE ---------- - A 32x32, XPM-format icon file is available if you wish to use - an icon for a menu entry for this game. - - The file is "supertux.xpm", and can be found in the - data/images/engine/icons/ directory. + To build SuperTux from source, you need to have a number of tools and + libraries installed. Note that most of these things should already be + available prepackaged and optimized for your distribution, it is recommended + that you check your distribution first before downloading from the websites. + You can also check + + http://supertux.lethargik.org/wiki/Building_SuperTux + + for up-to-date build instructions for a variety of different platforms and + distributions. + +* Linux development tools (your distribution should come with these): + - gcc compiler suite version 3.2 or newer (you need the c++ compiler g++) + http://gcc.gnu.org + - gnu binutils + http://www.gnu.org/software/binutils + - a shell and POSIX commandline tools + +* CMake 2.6 or later + Download: http://www.cmake.org/HTML/Download.html + Homepage: http://www.cmake.org/ + +* OpenGL headers and libraries + OpenGL libraries and headers are specific to your graphics card. Make sure + that you have hardware accelerated OpenGL drivers installed. Software + renderers like Mesa will make SuperTux unplayable slow. + +* SDL 1.2.5 or later (1.2.8 is recommended on Mac OS X) + http://www.libsdl.org + +* SDL_image (any version that includes PNG and JPEG support) + http://www.libsdl.org/projects/SDL_image + +* PhysicsFS (1.0.x or 2.0.x) + http://www.icculus.org/physfs + +* OpenAL + There are no official Linux releases of OpenAL yet, you should grab the + latest CVS snapshot (any snapshot from 2005 should work, earlier snapshots + tend to have bugs). OpenAL 1.0 or later implementations on other systems + like Mac OS X or windows should work. + + http://www.openal.org +* GLEW + http://glew.sourceforge.net/ + +* Boost's smart_ptr and format headers + http://www.boost.org/ + + Note: We tried to write our code clean, portable and platform neutral, so it + should be possible to compile it on a wide range of platforms and also with + other compilers than gcc. However we have no resources to test other setups + and it is likely that you hit small problems. Reports and binary compiled + packages are of course always welcome. Send them to + supertux-devel@lists.lethargik.org + +INSTALLING UNDER LINUX/UNIX USING CMAKE +--------------------------------------- + + SuperTux uses CMake to generate a set of Makefiles for the build process. To + generate these Makefiles and build SuperTux, perform the following steps: + + 1. `cd' to the directory where you unpacked the SuperTux source + archive, i.e. to the directory containing `src' and `data'. + + 2. Create and change to a new, empty build directory by running + `mkdir build', `cd build'. + + 3. Run `cmake ..' to create the Makefiles needed to build SuperTux with + standard options. If you are missing any libraries needed to build + SuperTux, install those first, then try running CMake again. See below + for instructions on how to change to standard options. + + 4. Type `make' to start the build process. + + 5. Type `make install' to install the programs and any data files and + documentation. (You should be a root user on Linux systems. + You can become a root user with the `su' command or by using + `sudo make install') + + Note that there is no uninstall target, so you might wish to create a + package or other system-specific installation instead. + + 6. The game should work now and you can remove the source directory. + + You can customize the build process by setting additional options for CMake. + The easiest way to do this is to use run `ccmake ..' instead of `cmake ..' + to bring up the curses-based user interface of CMake. Select an option using the + arrow keys, change the selected option by pressing the Enter key, then + hit the `c' (repeatedly, if necessary) to apply your changes and bring + up new options resulting from your newly set ones. When you are done, press + the `g' key to generate a new set of Makefiles and exit. + + Alternatively, you can pass options to `cmake ..' via the command line. + Some common command line switches are: + + -DCMAKE_VERBOSE_MAKEFILE=ON + Generates Makefiles that print all commands prior to executing them. + -Dxxx_LIBRARY=/path/to/library.so -Dxxx_INCLUDE_DIR=/path/to/headerfiles + Manually specify the installation directory of a library. + -DCMAKE_BUILD_TYPE=DEBUG + Enables debug mode and compiles extra debug symbols into the SuperTux + executable. This is useful when sending in bug reports to the + developers. + -DCMAKE_BUILD_TYPE=RELEASE + Enables release mode and compiles some sanity checks out of the build. + +Note for SVN users: + SuperTux does not need to be installed on the system, you can run it from + its own directory. + +SUPPORT +------- + + You can contact us at supertux-devel@lists.lethargik.org and in the #supertux + channel on the irc.freenode.net IRC server. +