Prerequisites
The required build tools include:
- g++ - The GNU C++ compiler
- SCons - A replacement for Make
The required libraries include:
- Bullet - Open Source Physics Library (minimum version 2.83). Only the following libraries are required:
- BulletCollision
- BulletDynamics
- LinearMath
- libcurl - Multiprotocol file transfer library (minimum version 7.21.6)
- libvorbis - The Vorbis General Audio Compression Codec Library (minimum version 1.2.0)
- SDL - Simple DirectMedia Layer Library (minimum version 2.0.0)
- SDL_image - Image file loading library (minimum version 2.0.0)
Make sure you have all the required libraries and build tools. Make sure you also have the development files for each of the libraries. Your Linux distribution may have different package names and/or bundled differently. The list above should give enough information to search for applicable packages within your distribution's package manager.
Fedora
All required packages can be installed using this command:
sudo yum install bullet-devel gcc-c++ libvorbis-devel scons SDL2-devel SDL2_image-devel curl-devel
Ubuntu
Ubuntu 12.04 does not include libbullet and SDL2 packages. They are available in following ppas though:
sudo add-apt-repository ppa:roblib/ppa
sudo add-apt-repository ppa:zoogie/sdl2-snapshots
All required packages can be installed using this command:
sudo apt-get install g++ scons libsdl2-dev libsdl2-image-dev libbullet-dev libvorbis-dev libcurl4-gnutls-dev
Compiling
To compile VDrift just run SCons in the root directory of the sources.
scons
Optional: Compile Options
You can use one or more compile options. To compile with optimization for a certain platform, you can use the arch flag:
scons arch=a64
Compiling VDrift in release mode will turn off debugging options, and enable more compiler optimizations. VDrift runs much more quickly in release mode:
scons release=1
To enable force feedback, use this flag:
scons force_feedback=1
You can get a list of all compile time options with:
scons --help
These options are probably best left off the first time you compile. If you have problems compiling or running VDrift, it is easier to debug with them off. Once you verify that VDrift is compiling, then recompile with these optimizations to improve performance.
Installing
VDrift does not need to be installed to work and you can run it from the folder where you compiled it. If you do want to install, use the SCons build target install.
sudo scons install
Optional: Installation Location
There are also some install options - to change where VDrift is installed, use the prefix flag:
scons install prefix=/usr/local
Cleaning
Building the project creates several artefacts that do not need to be stored, because they can be regenerated on demand. Cleaning them up can be done with SCons, too:
scons --clean
To remove all additional temporary files run:
rm -rf .sconf_temp/ .sconsign.dblite config.log vdrift.conf
