distributions.
* Linux development tools (your distribution should come with these):
- - gcc compiler version 3.2 or newer (you need the c++ compiler g++)
+ - 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.4.7 or later (if you do not want to use jam)
+* CMake 2.6 or later
Download: http://www.cmake.org/HTML/Download.html
Homepage: http://www.cmake.org/
-* perforce jam 2.5 or later (if you do not want to use CMake)
- Download: ftp://ftp.perforce.com/pub/jam
- Homepage: http://www.perforce.com/jam/jam.html
-
* 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
* SDL 1.2.5 or later (1.2.8 is recommended on Mac OS X)
http://www.libsdl.org
-* SDL_image (any version)
+* SDL_image (any version that includes PNG and JPEG support)
http://www.libsdl.org/projects/SDL_image
-* PhysicsFS (1.0.0, the development branch 1.1.x is buggy and does not work,
- 1.2.0 and later should work when it is released)
+* PhysicsFS (1.0.x or 2.0.x)
http://www.icculus.org/physfs
* OpenAL
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
INSTALLING UNDER LINUX/UNIX USING CMAKE
---------------------------------------
- This section details how to build SuperTux using CMake. If you want to use
- perforce jam to build SuperTux, please skip to the appropriate section.
-
SuperTux uses CMake to generate a set of Makefiles for the build process. To
generate these Makefiles and build SuperTux, perform the following steps:
SuperTux, install those first, then try running CMake again. See below
for instructions on how to change to standard options.
- 2. Type `make' to start the build process.
+ 4. Type `make' to start the build process.
- 3. Type `make install' to install the programs and any data files and
+ 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')
- 4. The game should work now and you can remove the source directory.
+ 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 and option using the
+ 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
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.
- -DDEBUG=ON
- Enables debug mode and compiles extra debug symbols into the SuperTux
- executable. This is useful when sending in bug reports to the
- developers.
-
-Note for SVN users:
- SuperTux does not need to be installed on the system, you can run it from
- its own directory.
-
-INSTALLING UNDER LINUX/UNIX USING JAM
--------------------------------------
-
- SuperTux uses a normal Autoconf configure script. The simplest way to compile
- this package is:
-
- 1. `cd' to the directory containing the package's source code and type
- `./configure' to configure the package for your system. If you're
- using `csh' on an old version of System V, you might need to type
- `sh ./configure' instead to prevent `csh' from trying to execute
- `configure' itself.
-
- 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.
-
- Running `configure' takes awhile. While running, it prints some
- messages telling which features it is checking for.
-
- 2. Type `jam' to compile the package.
-
- 3. Type `jam install' to install the programs and any data files and
- documentation. (You should be root user on Linux systems.
- You can become root user with the `su' command or by using
- `sudo jam install')
-
- 4. The game should work now and you can remove the source directory
-
- You can customize the build process by specifying additional parameters for
- the configure script. Type `./configure --help' for additional informations.
- Some common options are:
-
- --prefix=$HOME/.local
- Installs SuperTux in your HOME directory in the .local folder.
- This avoids the need for system administrator privileges when
- installing the game
- --with-XXX=Prefix
- Manually specify the installation directory of a library
- --enable-debug
+ -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.
-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.
-
SUPPORT
-------
projects / supertux.git / blobdiff