Compiling the source

2013-09-23T15:08:16Z

DevilishFreak: Added libxvidcore-dev to the dependencies

==Mac OS X==

First, you need to [[Getting_the_source|acquire the source code]].

Regardless of what interface you may use to compile the source, you will need [http://www.cmake.org/cmake/resources/software.html CMake] to generate makefiles. You will also need to install [https://developer.apple.com/xcode/ Xcode] (making sure to choose to install the command-line utilities when prompted by the installer).

Then, you will need to acquire (and in some cases, manually compile) at a minimum the [[#Dependencies|necessary libraries]].

Once you have the source code and the libraries installed, you may actually proceed to compile the source. You have several options:
* '''Compile the source at the command line'''. This is the easiest if you would just like to compile the game to use yourself and you do not intend to work on the code.
* '''Compile the source using an IDE'''. This is preferred if you intend on developing the source.
** Xcode is Apple's flagship IDE and you should have installed to compile the source regardless of which method you use.
** [http://qt-project.org/downloads QtCreator] is cross-platform and provides real-time feedback of syntax errors, a Vim mode, as well as other features.
** [http://www.codeblocks.org/ Code::Blcoks] is also cross-platform but lacks some of the features of Xcode and QtCreator.

===Dependencies===

You only need to use one of the following methods (HomeBrew or compiling by hand). Please try and avoid mixing methods as this may produce unexpected results.

Unvanquished requires the following libraries:
* [[#JPEG|JPEG]], version 8 or higher. (Version 6 was known to have problems)
* [[#Simple_DirectMedia_Layer_.28SDL.29|Simple DirectMedia Layer]] (The binary provided by libsdl.org causes graphical corruptions. Compile from source or use homebrew/macports)
* [[#The_OpenGL_Extension_Wrangler_Library_.28GLEW.29|The OpenGL Extension Wrangler Library]]
* CuRL
* [[#The_GNU_MP_Bignum_Library_.28libgmp.29|GMP]]
* [[#WebP|WebP]] (v0.2.0 or newer)

The following libraries are optional:
* Theora
* Speex
* [[#Ogg|Ogg]]
* [[#Vorbis|Vorbis]]

====HomeBrew====
Install [http://mxcl.github.com/homebrew/ HomeBrew] and then run the following command

$ brew install nettle libjpeg curl sdl webp xvid gmp glew speex libvorbis theora

All the necessary libraries should now have been installed.

====Compiling by hand====
The following are shell scripts that download, compile, and install various libraries. This is more time consuming then other methods but might be useful if you need more control over your libraries

=====JPEG=====

$ curl http://www.ijg.org/files/jpegsrc.v8d.tar.gz > jpegsrc.v8d.tar.gz
$ tar xvzf jpegsrc.v8d.tar.gz
$ cd jpeg-8d
$ ./configure
$ make
$ sudo make install

=====The OpenGL Extension Wrangler Library (GLEW)=====

$ curl -L https://sourceforge.net/projects/glew/files/glew/1.7.0/glew-1.7.0.tgz/download > glew-1.7.0.tgz
$ tar xvzf glew-1.7.0.tgz
$ cd glew-1.7.0
$ make
$ sudo make install

=====Simple DirectMedia Layer (SDL)=====

Do not use the binaries provided by libsdl.org, as these are known to cause issues with gamma and color display. Instead, compile your own:

$ curl http://www.libsdl.org/release/SDL-1.2.15.tar.gz > SDL-1.2.15.tar.gz
$ tar xvzf SDL-1.2.15.tar.gz
$ cd SDL-1.2.15
$ ./configure
$ make
$ sudo make install

=====The GNU MP Bignum Library (libgmp)=====

$ curl ftp://ftp.gmplib.org/pub/gmp-5.0.5/gmp-5.0.5.tar.bz2 > gmp-5.0.5.tar.bz2
$ tar xvjf gmp-5.0.5.tar.bz2
$ cd gmp-5.0.5
$ ./configure
$ make
$ sudo make install

=====Ogg=====

$ curl http://downloads.xiph.org/releases/ogg/libogg-1.3.0.tar.gz > libogg-1.3.0.tar.gz
$ tar xvzf libogg-1.3.0.tar.gz
$ cd libogg-1.3.0
$ ./configure
$ make
$ sudo make install

=====Vorbis=====

$ curl http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.3.tar.gz > libvorbis-1.3.3.tar.gz
$ tar xvzf libvorbis-1.3.3.tar.gz
$ cd libvorbis-1.3.3
$ ./configure
$ make
$ sudo make install

=====WebP=====

You do not need to compile WebP by hand; Google provides binaries for Mac OS X available from their [https://code.google.com/p/webp/downloads/detail?name=libwebp-0.2.0-mac-10.5.tar.gz project page]. You will need version 0.2.0 or newer.

Once downloaded, you must still install the header files and the binary:

$ curl https://webp.googlecode.com/files/libwebp-0.2.0-mac-10.5.tar.gz > libwebp-0.2.0-mac-10.5.tar.gz
$ tar xvzf libwebp-0.2.0-mac-10.5.tar.gz
$ cd libwebp-0.2.0-mac-10.5
$ sudo cp include/webp /usr/local/include
$ sudo cp lib/libwebp.a /usr/local/lib

===Configuring with CMake===

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This should be a different directory.
# Hit "Configure". You will be prompted as to which generator you would like to use. If you have Xcode installed, choose that. Wait while the configuration process runs. You may have to set the following:
## If CMake did not find your jpeg headers for some reason, set <code>JPEG_INCLUDE_DIR</code> to <code>/path/to/Unvanquished/src/libs/jpeg</code>.
## Check <code>USE_INTERNAL_CRYPTO</code> to avoid having to compile nettle and hogweed yourself.
## Check <code>USE_INTERNAL_SPEEX</code> to avoid having to compile Speex yourself.
## Uncheck <code>USE_CIN_THEORA</code> and <code>USE_CIN_XVID</code> to avoid having to compile Theora or Xvid. (At present, there are not cutscenes or any such that require it.)
## '''You will probably not be able to compile with the GLSL optimizer enabled; uncheck <code>USE_GLSL_OPTIMIZER</code>'''
## If you have selected to generate Xcode project files, make the <code>SDLMAIN_LIBRARY</code> field blank. This option is not available if you have the generator set to Unix makefiles.
# Hit "Generate".
# You may now close CMake.

===Compiling===

====With Xcode====

<ol>
<li>Compilation will fail unless you manually create certain directories needed by the build scripts:
<pre>
$ cd /path/to/build/dir/CMakeFiles
$ mkdir gpp{game,trem,ui}-qvm.dir
</pre>
This is a workaround to {{Issue|101}}.
</li>
<li>Either start Xcode and open the project file (in the build directory you specified) or double-click the project file in Finder.</li>
<li>Open the project file created by CMake, which should be in the build directory you specified.</li>
<li>Change the active target to "ALL_BUILD" and click Product→Build.</li>
</ol>

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Input the following commands:
<pre>
$ cd /path/to/Unvanquished-build
$ make
</pre>
If you are on a multi-core or multi-processor machine, you may speed up the process by passing the <code>-j</code> argument followed by the number of available cores to <code>make</code>; e.g., <code>make -j4</code>. Note that doing so makes reading error messages more difficult, as multiple instances of the compiler will print to the screen at once, causing information to appear out of order.
</li>
</ul>

===Testing the build===

====With Xcode 4====

To test the game, select the "client" scheme from the combo box on the toolbar, and click the run button or press {{Hotkey|MacCommand}}{{Hotkey|R}}.

====With Unix Makefiles====

After compiling, you'll have to place the data files in the <code>main</code> directory in your build directory. [[#Acquiring the Game Files|For download instructions, see below.]]

Your file structure should look as follows:

[[File:Build_dir_Mac_OS_X.png]]

You may now start the application as such:

$ ./daemon.i386

Note that older machines will not support the new OpenGL 3 renderer, and must be started specifying the "vanilla" (aka "GL") renderer:

$ ./daemon.i386 +set cl_renderer GL

===Bundling the Application===

====With CPack====

CPack is able to create standalone bundles (as well as many other types of installers). However you must generate the files using Unix Makefiles instead of Xcode.

$ cd /path/to/Unvanquished-build
$ cpack -G Bundle

Some warnings will be printed however these can be safely ignored. There should be a file called Unvanquished.dmg in the Unvanquished-build folder.

====Manually====

{{Note|header=Important|content=
Please be aware that these instructions are very much out of date, and may not work. Also note that the dynamic library bundler does '''not''' work as intended and although you will be able to run your build on your machine, it will most likely not work on other machines. It is strongly suggested that you compile the source using Xcode.
}}

You'll find the Mac [http://macdylibbundler.sourceforge.net/ dynamic library bundler] to be quite useful (you must generate the files using Unix Makefiles instead of Xcode):

$ curl -L http://sourceforge.net/projects/macdylibbundler/files/macdylibbundler/0.4.1/dylibbundler0.4.1.zip/download > \
dylibbundler0.4.1.zip
$ unzip dylibbundler0.4.1.zip
$ cd dylibbundler
$ make
$ sudo make install

Once you've done that, you can proceed to create the application bundle. Note that these steps assume that you have downloaded the data files to <code>main/</code> as shown above:

<pre>
$ git=/path/to/Unvanquished-git-repo
$ build=/path/to/Unvanquished-build-dir
$ mkdir -pv Unvanquished.app/Contents/{libs,MacOS,Resources,Frameworks}
$ cp -r $build/main Unvanquished.app/Contents/MacOS
$ sips -s format tiff $git/debian/unvanquished.png --out temp.tiff
$ tiff2icns temp.tiff Unvanquished.app/Contents/Resources/Unvanquished.icns
$ rm temp.tiff
$ cp $build/daemon{,ded}.i386 $build/*.dylib Unvanquished.app/Contents/MacOS
$ cp -r /Library/Frameworks/SDL.framework Unvanquished.app/Contents/Frameworks
$ install_name_tool -id \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/Frameworks/SDL.framework/Versions/A/SDL
$ install_name_tool -change @rpath/SDL.framework/Versions/A/SDL \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/MacOS/daemon.i386
$ install_name_tool -change @rpath/SDL.framework/Versions/A/SDL \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/MacOS/librendererGLi386.dylib
$ install_name_tool -change @rpath/SDL.framework/Versions/A/SDL \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/MacOS/librendererGL3i386.dylib
$ for binary in Unvanquished.app/Contents/MacOS/*.{i386,dylib}; do
dylibbundler -b -x $binary -d $dest/Unvanquished.app/Contents/libs/; done
$ cp /usr/lib/libGLEW.1.7.0.dylib ./Unvanquished.app/Contents/libs/libGLEW.1.7.0.dylib
$ chmod +w ./Unvanquished.app/Contents/libs/libGLEW.1.7.0.dylib
$ install_name_tool -id @executable_path/../libs/libGLEW.1.7.0.dylib \
./Unvanquished.app/Contents/libs/libGLEW.1.7.0.dylib
$ install_name_tool -change /usr/lib/libGLEW.1.7.0.dylib \
@executable_path/../libs/libGLEW.1.7.0.dylib \
./Unvanquished.app/Contents/MacOS/daemon.i386
$ cat > Unvanquished.app/Contents/Info.plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleName</key>
<string>Unvanquished</string>
<key>CFBundleDisplayName</key>
<string>Unvanquished</string>
<key>CFBundleExecutable</key>
<string>daemon.i386</string>
<key>CFBundleIconFile</key>
<string>Unvanquished.icns</string>
<key>CFBundleIdentifier</key>
<string>net.Unvanquished</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleShortVersionString</key>
<string>0.4.0</string>
<key>CFBundleVersion</key>
<string>0.4.0</string>
</dict>
</plist>
^d
</pre>

Note: <code>^d</code> indicates pressing {{Hotkey|Ctrl}}{{Hotkey|D}} on the keyboard.

The contents of the completed application bundle should look like this:

[[File:Bundle_dir_Mac_OS_X.png]]

'''Note''': If you compiled SDL from source, you will not see a directory titled <code>SDL.framework</code>.

==Windows==

===Visual Studio===

CMake can generate Visual Studio projects for Unvanquished.

# Run the <code>Visual_Studio32.bat</code> batch script in your source directory by double-clicking it. Alternatively, you may use the <code>Visual_Studio64.bat</code> shell script if you have the [http://www.microsoft.com/en-us/download/details.aspx?id=8279 Windows 7 SDK] installed and a 64-bit system.
# Open <code>build-32/Daemon.sln</code> in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" or "Debug" in the first one and Win32 in the second one
# Press {{Hotkey|F5}} to build solution and run application, or just use Build → Build Solution to compile the code.

====Important Notes====

* LLVM is disabled and does not work correctly with CMake generated Visual Studio projects.
* ncurses is not supported under Visual Studio.
* The path to the build folder must not have any spaces otherwise generation of QVMs will fail. See {{Issue|102}}.
* Due to limitations with CMake, neither the startup project nor the working directory can be specified. These must be set manually to debug the client with Visual Studio:
** Right click on client and select "Set as StartUp project".
** Right click on client, select properties, select Debugging and set "Working Directory" to <code>$(TargetPath)\..</code>.

====Troubleshooting====

If installing the Windows 7 SDK [http://support.microsoft.com/kb/2717426?ppud=4&wa=wsignin1.0 fails with error code 5100] (when the installation fails, click "View Log", and search for "5100"), remove any installed copies of the Microsoft Visual C++ 2010 x86 Redistributable and Microsoft Visual C++ 2010 x64 Redistributable via the control panel (Control Panel → Programs and Features), then run the installer again.

===MinGW===

It is possible to build Unvanquished with MinGW, although the process is rather arduous compared to Visual Studio or compiling for other platforms. Currently, you will also need [http://cygwin.com/setup.exe Cygwin] to build the GMP library as well.

====Notes====

* The easiest way to acquire and install MinGW is with the graphical [http://sourceforge.net/projects/mingw/files/Installer/mingw-get-inst/ mingw-get-inst installer]. At a minimum, you will need to install the C and C++ compilers. 
* When configuring the build with CMake, you will find that you will have to set a number of libraries manually. You can find precompiled DLLs for most of the dependencies; those that are not pre-compiled can be built with the corresponding <code>USE_INTERNAL_</code> setting.
* '''The build will fail during QVM compilation if your source or build directories contain spaces.''' This is due to a bug with lcc. If your home directory contains a space, you may want to create source and build directories at the root of one of your drives (e.g., <code>C:\Unvanquished\Source</code> and <code>C:\Unvanquished\Build</code>.)

====Instructions====

The easiest way to get a build up (at the time of writing) is as follows:

{{Note|content=Although there are 64-bit binaries of most of the libraries required to build the game, these do not work with MinGW at present, so the following instructions all use the 32-bit binaries.}}

<ol>
<li>You will need to download and install some version of the DirectX SDK to compile the source. You may download the June 2010 release from [http://www.microsoft.com/en-us/download/details.aspx?id=6812 Microsoft].</li>
<li>Although there are binaries of gmp distributed with the source, they have are dependent on Visual Studio's implementations of <code>_ftol2_sse</code> and <code>_alloca_probe_16</code>. A fix may be found on [http://stackoverflow.com/questions/6753111/static-linking-with-openssl Stack Exchange], but requires that Visual Studio be installed, which defeats the purpose of attempting to use MinGW to compile the source. You can build gmp yourself:
<ol>
<li>Download and extract the latest version of the [http://gmplib.org/ GNU MP Bignum Library (GMP)]. (You will need either cygwin with tar and bz2 installed or 7-zip to extract the archive.)</li>
<li>Install the following Cygwin packages if you have not already:
* binutils
* gcc
* gcc-g++
* m4
* make
</li>
<li>As part of the GMP compilation process, a file called <code>gen-fib.c</code> generates a table of numbers in the Fibonacci sequence. The generated file does not play nicely with Cygwin or MinGW, so you must fix it. Edit <code>gen-fib.c</code>, and at around line 100, change these lines
<pre>
for (i = 0; i < fnum; i++)
{
printf (" CNST_LIMB (0x");
mpz_out_str (stdout, 16, f[i]);
printf ("), /* %d */\n", i-1);
}
printf ("};\n");
</pre>
to look like this:
<pre>
for (i = 0; i < fnum; i++)
{
printf (" CNST_LIMB (0x");
mpz_out_str (stdout, 16, f[i]);
printf (")%c /* %d */\n", (i == (fnum-1)) ? ' ' : ',', i-1);
}
printf ("};\n");
</pre>
The patch file looks like this:
<pre>
@@ -100,7 +100,7 @@
{
printf (" CNST_LIMB (0x");
mpz_out_str (stdout, 16, f[i]);
- printf ("), /* %d */\n", i-1);
+ printf (")%c /* %d */\n", (i == (fnum-1)) ? ' ' : ',', i-1);
}
printf ("};\n");
}
</pre>
</li>
<li>Compiling with MinGW does not work, so you will need to compile with Cygwin. At the prompt:
<pre>
$ ./configure --disable-static --enable-shared
$ make
</pre>
The <code>--disable-static</code> and <code>--enable-shared</code> flags configure GMP to build a DLL instead of a static library. You may optionally perform <code>make install</code>. Additional compilation instructions [http://www.cs.nyu.edu/exact/core/gmp/ are available].
If you experience difficulties with compilation and it appears that MinGW gcc is being detected by <code>configure</code> and not Cygwin gcc, you can try editing your <code>PATH</code> variable:
<pre>
$ export PATH=`echo $PATH | sed "s|/cygdrive/c/MinGW/bin:||"`
</pre>
Re-run <code>configure</code> and <code>make</code> afterwards.
</ol>
</li>
<li>Download the [http://www.libsdl.org/release/SDL-1.2.15-win32.zip latest stable version] of SDL for Windows. Extract the archive and copy <code>SDL.dll</code> from it to the root of your build directory.</li>
<li>Set the following CMake flags:
{| class="wikitable"
! Setting
! Description
! Type
! Value
|-
| <code>USE_INTERNAL_CRYPTO</code>
| Use the provided copies of crypto libraries. 
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_INTERNAL_GLEW</code>
| Use the provided copy of GLEW.
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_INTERNAL_JPEG</code>
| Use the provided copy of JPEG.
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_INTERNAL_SDL</code>
| Use the provided copy of SDL.
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_INTERNAL_SPEEX</code>
| Use the provided copy of Speex.
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_INTERNAL_WEBP</code>
| Use the provided copy of WebP.
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_CURSES</code>
| Enables/disables curses.
| <code>BOOL</code>
| <code>false</code>
|-
| <code>PNG_LIBRARY</code>
| Path to the PNG library DLL.
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/libpng/libs/win32/libpng.lib</code>
|-
| <code>PNG_PNG_INCLUDE_DIR</code>
| Path to the PNG library header files.
| <code>PATH</code>
| <code><var>SourcePath</var>/src/libs/libpng</code>
|-
| <code>FREETYPE_LIBRARY</code>
| Path to the compiled FreeType library.
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/freetype/lib/freetype.lib</code>
|-
| <code>FREETYPE_INCLUDE_DIR_freetype2</code>
| Path to the FreeType library header files.
| <code>PATH</code>
| <code><var>SourcePath</var>/src/libs/freetype/include/freetype2</code>
|-
| <code>FREETYPE_INCLUDE_DIR_ft2build</code>
| Path to the FreeType library file "ftbuild.h".
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/freetype/include/</code>
|-
| <code>GMP_INCLUDE_DIR</code>
| Path to the GMP library header files.
| <code>PATH</code>
| <code><var>SourcePath</var>/src/libs/gmp/include</code>
|-
| <code>GMP_LIBRARY</code>
| Path to the GMP library.
| <code>FILEPATH</code>
| <code><var>path/to/compiled/gmp/</var>.libs/cyggmp-10.dll</code>
|-
| <code>ZLIB_INCLUDE_DIR</code>
| Path to the zlib library header files.
| <code>PATH</code>
| <code><var>SourcePath</var>/src/libs/zlibwapi/include</code>
|-
| <code>ZLIB_LIBRARY</code>
| Path to the zlib library.
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/zlibwapi/lib/x32/zlib1.dll</code>
|-
| <code>CURL_LIBRARY</code>
| Path to the CURL library.
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/curl-7.21.6/lib/win32/release/libcurl.dll</code>
|-
| <code>CURL_INCLUDE_DIR</code>
| Path to the zlib library.
| <code>PATH</code>
| <code><var>SourcePath</var>/src/libs/curl-7.21.6/include/curl</code>
|-
| <code>USE_OPENAL</code>
| Enables/disables OpenAL support.
| <code>BOOL</code>
| <code>false</code>
|-
| <code>USE_CIN_THEORA</code>
| Enables/disables Theora support.
| <code>BOOL</code>
| <code>false</code>
|-
| <code>USE_CIN_XVID</code>
| Enables/disables Xvid support.
| <code>BOOL</code>
| <code>false</code>
|-
| <code>USE_CODEC_THEORA</code>
| Enables/disables Ogg support.
| <code>BOOL</code>
| <code>false</code>
|-
| <code>SDL_LIBRARY</code>
| The path to the SDL DLL.
| <code>FILEPATH</code>
| <code><var>BuildPath</var>/SDL.dll</code>
|-
| <code>SDLMAIN_LIBRARY</code>
| Enables/disables Ogg support.
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/libsdl/src/main/win32/SDL_win32_main.c</code>
|-
|}
Do note that CMake is slash-direction–agnostic; it can handle both forward- and backslashes on Windows.
If you would like to compile a debug build, change <code>CMAKE_RELEASE_TYPE</code> from <code>Release</code> to <code>Debug</code>.
</li>
<li>Open <code><var>SourcePath</var>/CMakeLists.txt</code> and edit the line
<pre>
set( OS_LIBRARIES m winmm ws2_32 psapi z )
</pre>
(around line 1040) to look like this:
<pre>
set( OS_LIBRARIES m winmm ws2_32 psapi )
</pre>
Also edit around line 1700:
<pre>
###########################
#Configure Download Script#
###########################

if( NOT MSVC )
</pre>
to look like this:
<pre>
###########################
#Configure Download Script#
###########################

if( NOT WIN32 )
</pre>
</li>
<li>Open <code><var>SourcePath</var>/src/libs/libsdl/src/main/win32/SDL_win32_main.c</code> and edit the lines:
<pre>
/* Include the SDL main definition header */
#include "SDL.h"
#include "SDL_main.h"
</pre>
to look like:
<pre>
/* Include the SDL main definition header */
#include "../../../include/SDL.h"
#include "../../../include/SDL_main.h"
</pre>
<li>Open a command prompt and <code>cd</code> to your source directory.</li>
<li>Run <code>make</code>:
<pre>
> mingw32-make
</pre>
If you would like verbose output, set the <code>VERBOSE</code> environment variable before running <code>make</code>.
<pre>
> set VERBOSE=1
</pre>
To make it easier to build the source, you can create a batch file (call it something like <code>compile.bat</code>) and place it in your build directory:
<pre>
@echo off

set RETURN=compile

:get_time
:: Thank you, Rob van der Woude:
:: (http://www.robvanderwoude.com/datetimentparse.php)
FOR /F "tokens=1,2,3 delims=:." %%A IN ("%Time%") DO (
SET /A HOURS = 100%%A %% 100
SET /A MINUTES = 100%%B %% 100
SET /A SECONDS = 100%%C %% 100
)
SET /A TICKS=( %HOURS% * 3600 ) + ( %MINUTES% * 60 ) + %SECONDS%
GOTO %RETURN%

:compile
SET START_TICKS=%TICKS%

SET VERBOSE=1
:: mingw32-make clean
mingw32-make -j4

set RETURN=finish
GOTO get_time

:finish
SET /A COMPILE_TIME=%TICKS% - %START_TICKS%
SET /A MINUTES=%COMPILE_TIME% / 60
SET /A SECONDS=%COMPILE_TIME% %% 60
ECHO.
ECHO Compilation took %MINUTES%m %SECONDS%s.
PAUSE
</pre>
</li>
<li>Once compilation finishes, you will find that the game will fail to run due to DLL dependencies. To resolve these:
<ul>
<li>You will need to move <code>INTERNAL_GLEW</code> from the <code>Release/</code> folder of the build directory to the root of the build directory.</li>
<li>You will need to place the following other DLLs in your build directory:
* freetype6.dll
* libcurl.dll
* libpng14-14.dll
* zlib1.dll
If the renderer's DLL dependencies are not met, you will be informed that the game failed to load a renderer. If you receive an error stating that the application failed to start at all, then you are likely missing some version of the Microsoft Visual C runtime redistributable.
You may find that you also need these DLLs (if you configured your build differently):
* libbz2.dll
* libogg.dll
* libtheora.dll
* libvorbis.dll
* libvorbisfile.dll
* msvcr100.dll
* msvcr100d.dll
* zlibwapi.dll
The easiest way to obtain these DLLs is by copying them from the installation directory of an [http://sourceforge.net/projects/unvanquished/files/latest/download official release] of Unvanquished.
</li>
<li>You will need to copy your compiled DLL of GMP to your build directory. It may be found in <code><var>path/to/compiled/gmp/</var>.libs/cyggmp-10.dll</code>.</li>
<li>As you compiled GMP with Cygwin, it in turn depends on <code>cygwin1.dll</code>, which may typically be found in <code>C:\cygwin\bin\</code>. Copy and paste it into your build directory.</li>
</ul>
Once you have completed these steps, you should never have to do them again.
</li>
</ol>

====Notes====

* If you would like to use curses, try using [http://sourceforge.net/projects/pdcurses/files/pdcurses PDCurses].

===QtCreator===

# Install MinGW and follow the above instructions, except select Code::Blocks as the generator.
# Start QtCreator, and select "Open File or Project…" from the File menu.
# Navigate to your source directory and open CMakeLists.txt.
# At the CMake Wizard, select the same build directory you already configured using CMake. (If you did not chose Code::Blocks as the generator, you will have to start over again, as QtCreator requires a Code::Blocks project file in order to compile the source.)
# Ensure that a generator is selected in the combo box, and click "Run CMake". If there is no generator listed, see the [[#Troubleshooting|troubleshooting]] section below.
# Click "Finish" to close the wizard.

You should now be able to compile, run, and debug the code using QtCreator.

====Troubleshooting====

If at the "Run CMake" prompt of the the CMake Wizard, select "Run CMake" and are warned that no generator was selected, and notice that there are no generators in the combo box, you will likely have to [http://doc.qt.digia.com/qtcreator-2.4/creator-tool-chains.html manually configure your toolchain]. Select "Options…" from the "Tools" menu, then navigate to "Build & Run".

At the options window,
* Go to the "Kits" tab, and mouse over the "Desktop (default)" kit under "Manual". If there were any errors in configuring this kit, they will be displayed in the tool tip. If there are problems, select the kit. You may need to manually specify the location of the MinGW debugger, for example, which is typically <code>C:\MinGW\bin\gdb.exe</code>.
* Go to the "Compilers" tab, and ensure that MinGW is present. If not, you will need to add it manually.

==Linux==

===Dependencies===


====Debian/Ubuntu====

$ sudo apt-get install libcurl4-gnutls-dev libfreetype6-dev libglew1.5-dev \
libgmp3-dev libjpeg8-dev libncurses5-dev libogg-dev libopenal-dev \
libpng12-dev libsdl1.2-dev libvorbis-dev zlib1g-dev nettle-dev \
libwebp-dev libspeexdsp-dev libtheora-dev libxvidcore-dev

If the version of WebP supplied by your version of Debian or Ubuntu is older than v0.2.0, you will need to [https://code.google.com/p/webp/downloads/detail?name=libwebp-0.2.0.tar.gz download] and [https://developers.google.com/speed/webp/docs/compiling#unix compile it from source]. After compiling and installing with <code>sudo make install</code>, in CMake, you'll need to set <code>WEBP_INCLUDE_DIR</code> to <code>/usr/local/include/webp</code> and <code>WEBP_LIBRARY</code> to <code>/usr/local/lib/libwebp.so</code>.

'''We currently provide a ready-to-use libwebp-dev in our [http://{{SERVERNAME}}/index.php/Download#ubuntu Debian and Ubuntu repositories], alongside .debs of the game and server.'''

Actual dev package names may vary, e.g. libgmp-dev instead of libgmp3-dev and libglew-dev or libglew1.7-dev instead of libglew1.5-dev.

Since we have a debian directory in the source, you can also to check what's needed then install the listed packages (choosing from alternatives as needed):

$ cd <var>/path/to/unvanquished</var>
$ dpkg-checkbuilddeps
…
$ sudo apt-get install <var>package(s)</var>

If dpkg-checkbuilddeps produces no output, you have all necessary build dependencies. Also, debhelper's only needed if you're building .debs.

====Gentoo====

$ emerge curl freetype glew gmp jpeg ncurses libogg openal libpng libsdl libvorbis zlib

====openSUSE====

$ sudo install zypper gcc gcc-c++ Mesa-libGL-devel SDL-devel libjpeg8-devel \
libpng12-devel glew-devel webp-devel ncurses-devel gmp-devel libcurl-devel \
libnettle-devel openal-soft-devel speex-devel libvorbis-devel \
libtheora-devel

The latest version of WebP must be installed manually:

$ wget https://webp.googlecode.com/files/libwebp-0.2.1.tar.gz
$ tar xvzf libwebp-0.2.1.tar.gz
$ cd libwebp-0.2.1
$ ./configure && make
$ sudo make install

You must disable curses (set <code>USE_CURSES</code> appropriately in CMake) as failing to do so will cause Unvanquished to crash on startup.

===Configuring the code with CMake===

After you have [[Getting the source|acquired the source code]], you can proceed to compile. Unvanquished uses CMake, so you must have that installed.

====Using ccmake (curses-based front-end)====

On Debian or Ubuntu:

$ sudo apt-get install cmake-curses-gui

On Gentoo you should set the '''ncurses''' USE flag either globally or individually, just for cmake.
To add the USE flag globally, edit the USE array in /etc/make.conf for it to include '''ncurses'''.
To only install cmake with ncurses functionality, you could do the following:

$ echo 'dev-util/cmake ncurses' >> /etc/portage/package.use && emerge cmake

Note that in Ubuntu, <code>cmake-curses-gui</code> is in Universe, which you may have to enable with <code>software-properties-gtk</code>. Make sure to reload the software sources with <code>sudo apt-get update</code> afterwards.

Next, configure the codebase.

$ cd <var>/path/to/unvanquished</var>
$ mkdir build
$ cd build
$ ccmake ..

Or, in Debian or Ubuntu, you can build a package (but you'll need to have devscripts and fakeroot installed):

$ cd <var>/path/to/unvanquished</var>
$ fakeroot dpkg-buildpackage -b -uc
$ sudo dpkg -i <var>../unvanquished_*.deb</var>

Once in <code>ccmake</code>, use the following keys:

* Press {{Hotkey|c}} to configure. If an error occurs during this phase, make note of it and press {{Hotkey|e}} to dismiss it.
* Use the up and down arrow keys to navigate the compilation options.
* Press {{Hotkey|Enter}} to enable or disable boolean options (i.e., on/off) or to edit textual options.
** Press {{Hotkey|Esc}} when editing a textual option to cancel the change.

Once you have finished the configuration process, press {{Hotkey|C}} again, then {{Hotkey|G}} to generate the makefile.

====Using cmake-qt-gui (graphical front-end)====

This graphical front end for cmake has its own package you must install:

=====Debian/Ubuntu=====

$ sudo apt-get install cmake-qt-gui

=====Gentoo=====

With the '''qt4''' USE flag enabled:

$ emerge cmake

Once installed, run with <code>cmake-gui</code>.

[[Image:Cmake-qt-gui.png|thumb]]

# Set the path where you have the source code downloaded.
# Set the path where you would like to build the engine. This may be the same directory if you wish.
# Click 'Configure'.
# Click 'Generate'.

====Unnecessary libraries====

Regardless of which front-end to cmake you use, you may want to disable some libraries that are not strictly necessary:

* <code>USE_OPENAL</code> — If this is disabled, SDL is used instead for sound.
* <code>USE_CODEC_VORBIS</code> — Disabling this will cause certain sound effects (those using the <code>.ogg</code> format) not to play. At present, this has only a minor impact on gameplay, but more and more sounds will likely use the format in the future.
* <code>USE_CURSES</code> — Disabling this will cause the external (not in-game) console to not use curses; it will not be scrollable and will be similar to the console in the original Tremulous. This does in no way affect gameplay.
* <code>USE_CIN_THEORA</code> — Disabling this prevents videos from being recorded in Theora.
* <code>USE_CIN_XVID</code> — Disabling this prevents videos from being recorded in Xvid.
* <code>USE_VOIP</code> — Disabling this removes VOIP support. Alternatively enabling <code>USE_INTERNAL_SPEEX</code> will use the libraries distributed with Unvanquished for VoIP
* <code>USE_INTERNAL_CRYPTO</code> — Enable this to use the crypto libraries provided by Unvanquished.

===Compiling===

$ cd <var>path/to/unvanquished/build</var>
$ make -j4

The <code>-j</code> switch to make allows you to speed up the compilation process by running it in multiple threads; set the number following this to the number of cores your processor(s) have.

==Acquiring the Game Files==

===Acquiring mandatory game files===

The game files are not in the Git repository, and must be downloaded separately. This may be done on the command line or from your web browser. The downloads may be found on [http://sourceforge.net/projects/unvanquished/files/Assets SourceForge.net]. If you download the files from your browser, just download the files named "pak*.pk3", and save them to the [[Running_the_game#Data_locations|data location]] for your system.

On Linux, this may be done as follows:

$ cd <var>[path to Unvanquished installation or build]</var>/main
$ for file in {{CurrentVersion|PakFiles}}; do
if [ ! -e $file ]; then
wget -O $file "http://sourceforge.net/projects/unvanquished/files/Assets/$file/download"
fi
done

On FreeBSD, using the <code>sh</code> shell:

$ cd <var>[path to Unvanquished installation or build]</var>/main
$ for file in {{CurrentVersion|PakFiles}}; do
if [ ! -e $file ]; then
fetch -r -o $file "http://sourceforge.net/projects/unvanquished/files/Assets/$file/download"
fi
done

On Mac OS X:

$ cd ~/Library/Application\ Support/Unvanquished/main
$ for file in {{CurrentVersion|PakFiles}}; do
if [ ! -e $file ]; then
curl -L "http://sourceforge.net/projects/unvanquished/files/Assets/$file/download" > $file
fi
done

Linux users may also use the <code>download-pk3.sh</code> script that is distributed with the source code, which requires that curl be installed:

$ cd <var>[path to Unvanquished source code]</var>
$ mkdir -p ~/.Unvanquished/main
$ ./download-pk3.sh ~/.Unvanquished/main

===Downloading the map pack===

The map pack exists only for convenience; if you do not download the map pack, Unvanquished will automatically download maps as needed when you attempt to play online.

To download the map pack on Linux:

$ wget -O maps.7z "http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z"; done

To download the map pack on Mac OS X:

$ curl -L "http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z" > maps.7z; done

Note that you will need to unzip the map pack on either system as it is compressed with LZMA. Mac users can use the [http://wakaba.c3.cx/s/apps/unarchiver.html Unarchiver]. Uncompressing the archive on Linux is highly dependent on your distribution.

===Verifying the Files===

Download the latest [http://sourceforge.net/projects/unvanquished/files/Assets/{{CurrentVersion|MD5HashFile}} MD5 hash file] and save it to your system's [[Running_the_game#Data_directory|data location]].

On systems with the <code>md5</code> command (Mac OS X):

$ cd ~/Library/Application\ Support/Unvanquished/main
$ cat {{CurrentVersion|MD5HashFile}} | while read line; do
file="`echo "$line" | sed -E "s/^[a-fA-F0-9]+ +\*?//"`"
if [ -e "$file" ]; then
if [ `md5 -r "$file" | cut -d\ -f1` = "`echo "$line" | cut -d\ -f1`" ]
then echo "File \"$file\" appears okay."
else echo "File \"$file\" is corrupt"'!' >&2
fi; fi; done

On systems with the <code>md5sum</code> command (most Linux distributions):

$ cd <var>[[Running_the_game#Data_directory|/path/to/data/files]]</var>
$ md5sum -c {{CurrentVersion|MD5HashFile}} 2>&1 | grep -v "open or read\|file or directory"

The <code>grep</code> invocation is used to strip output complaining about missing files.

Any files that are found to be corrupt should be replaced; just download a [http://sourceforge.net/projects/unvanquished/files/Assets new copy] of the affected file(s).

==Errors==

===CMake cannot locate Newton===

If CMake cannot find Newton, you'll need to set it up yourself.

It should be in <code><var>/path/to/Unvanquished</var>/src/libs/libnewton/libs/<var>your_os</var>/libNewton.so</code>.
Be sure to replace <var>your_os</var> with the proper directory name.

Use CMake as before to change the <code>NEWTON_LIBRARY</code> build setting to the said path:

# Start the CMake configurator:<pre>$ ccmake ..</pre>
# Scroll down and highlight <code>NEWTON_LIBRARY</code>.
# Press {{Hotkey|Enter}} to begin editing and input in the path.
# Press {{Hotkey|C}} to configure and {{Hotkey|G}} to generate the new makefiles.
# Press {{Hotkey|Q}} to quit.
# Recompile the source:<pre>$ make</pre>

===The C Compiler is not able to compile a simple test program===

When attempting to generate a solution for Xcode CMake fails with the following error
-- Check for working C compiler using: Xcode -- broken
CMake Error at /Applications/CMake 2.8-8.app/Contents/share/cmake-2.8/Modules/CMakeTestCCompiler.cmake:52 (MESSAGE):
The C compiler "/usr/bin/gcc" is not able to compile a simple test program.

It fails with the following output:

Change Dir: /Users/danielmaloney/Documents/Unvanquished/build-xcode/CMakeFiles/CMakeTmp

Run Build Command:/Applications/CMake\ 2.8-8.app/Contents/bin/cmakexbuild
-project CMAKE_TRY_COMPILE.xcodeproj build -target
cmTryCompileExec1400153232 -configuration Debug

Error: No developer directory found at /Developer. Run
/usr/bin/xcode-select to update the developer directory path.

CMake will not be able to correctly generate this project.
Call Stack (most recent call first):
CMakeLists.txt:19 (project)

This is due to Xcode 4.3 having a different directory structure to previous versions. Simply running the following command will correct this error:
sudo /usr/bin/xcode-select -switch /Applications/Xcode.app/Contents/Developer/

Unvanquished - User contributions [en-gb]

Compiling the source