stk-code_catmod/INSTALL.md
2016-06-28 18:27:15 -04:00

2.0 KiB

SuperTuxKart Installation Instructions

Note: If you obtained this source code from Github, you also need to download the game assets from Sourceforge using SVN.

svn checkout https://svn.code.sf.net/p/supertuxkart/code/stk-assets stk-assets

Place the stk-assets folder next to the source root stk-code folder. See https://supertuxkart.net/Source_control for more information

Building STK on Linux

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

  • OpenGL (mesa)
  • OpenAL (recommended: openal-soft-devel)
  • Ogg (libogg-dev)
  • Vorbis (libvorbis-dev)
  • Freetype (libfreetype6-dev)
  • libcurl (libcurl-devel)
  • libbluetooth (bluez-devel)
  • libpng (libpng-devel)
  • zlib (zlib-devel)
  • jpeg (libjpeg-turbo-devel)

Ubuntu command:

sudo apt-get install build-essential cmake libbluetooth-dev \
libcurl4-gnutls-dev libfreetype6-dev libfribidi-dev libgl1-mesa-dev \
libjpeg-dev libogg-dev libopenal-dev libpng-dev libvorbis-dev libxrandr-dev \
mesa-common-dev pkg-config zlib1g-dev

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:

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 https://supertuxkart.net/Building_and_packaging_on_OSX

Building STK on Windows

See https://supertuxkart.net/How_to_build_the_Windows_version