stk-code/INSTALL

SUPERTUXKART INSTALLATION INSTRUCTIONS
======================================

General
-------

First, make sure that you have the following packages installed:

  * OpenGL (or Mesa 3.0 or later)
  * OpenAL (recommended: openal-soft-devel)
  * Ogg    (libogg-dev)
  * Vorbis (libvorbis-dev)
  * fribidi (fribidi-devel) - optional for right-to-left text

Unpack the files from the tarball like this:

  tar xzf supertuxkart-*.tar.gz
  cd supertuxkart-*

where '*' is the version of SuperTuxkart you downloaded - eg 0.8.0. Then:

* Build irrlicht (atm, this will be included in cmake soonish)
  cd lib/irrlicht/source/Irrlicht
  NDEBUG=1 make

* Compile SuperTuxKart:
    mkdir cmake_build 
    cd cmake_build 
    cmake .. 
    make VERBOSE=1 -j2
  To create a debug version of STK, use:
    cmake .. -DCMAKE_BUILD_TYPE=Debug

To test the compilation, supertuxkart can be run from the build
directory by ./bin/supertuxkart 

To install the file, as root execute:

  make install

The default install location is /usr/local, i.e. the data files will
be written to /usr/local/share/games/supertuxkart, the executable
will be copied to /usr/local/bin. To change the default installation
location, specify CMAKE_INSTALL_PREFIX when running cmake, e.g.:
  cmake .. -DCMAKE_INSTALL_PREFIX=/opt/stk

Building STK on OS X
--------------------
See http://supertuxkart.sourceforge.net/Building_and_packaging_on_OSX


Building STK on Windows
-----------------------
See http://supertuxkart.sourceforge.net/How_to_build_the_Windows_version