Unvanquished - User contributions [en-gb]

Compiling the source

2014-05-12T02:17:53Z

Danmal: /* Configuring with CMake */ Options have been removed from CMakeList

==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>.
## 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>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 g++ gcc cmake libcurl4-gnutls-dev libfreetype6-dev \
libglew-dev libgmp-dev nettle-dev zlib1g-dev libncursesw5-dev \
libsdl2-dev libopenal-dev libjpeg8-dev libpng12-dev libwebp-dev \
libogg-dev libvorbis-dev libspeexdsp-dev libtheora-dev libopusfile-dev \
libxvidcore-dev libgeoip-dev

If libsdl2-dev isn't available, you can use libsdl1.2-dev instead.

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 ready-to-use libwebp-dev, libogg-dev libopusfile-dev where needed 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. libgmp3-dev instead of libgmp-dev and libglew1.7-dev instead of libglew-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.

Optionally: to use clang (rather than the default gcc and g++ compilers) export the CC and CXX variables before running cmake:

$ export CC="clang"
$ export CXX="clang++ -stdlib=libc++ -lc++abi"

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/pkg

===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/

Compiling the source

2014-05-12T01:56:59Z

Danmal: /* With Xcode */ Bug has been corrected. Initial step no longer required

==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>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 g++ gcc cmake libcurl4-gnutls-dev libfreetype6-dev \
libglew-dev libgmp-dev nettle-dev zlib1g-dev libncursesw5-dev \
libsdl2-dev libopenal-dev libjpeg8-dev libpng12-dev libwebp-dev \
libogg-dev libvorbis-dev libspeexdsp-dev libtheora-dev libopusfile-dev \
libxvidcore-dev libgeoip-dev

If libsdl2-dev isn't available, you can use libsdl1.2-dev instead.

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 ready-to-use libwebp-dev, libogg-dev libopusfile-dev where needed 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. libgmp3-dev instead of libgmp-dev and libglew1.7-dev instead of libglew-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.

Optionally: to use clang (rather than the default gcc and g++ compilers) export the CC and CXX variables before running cmake:

$ export CC="clang"
$ export CXX="clang++ -stdlib=libc++ -lc++abi"

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/pkg

===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/

Technical Documentation

2012-12-10T07:25:27Z

Danmal: Add info about valgrind + fglrx

Currently, this page isn't of much help, but you can change that by editing it!

==Source code & data structure==

* <code>main/</code> Data associated with the game.
** <code>def/</code> Entity definitions for [[Mapping|Radiant]].
** <code>fonts/</code>
** <code>gfx/</code>
** <code>glsl/</code> OpenGL shader code.
** <code>lights/</code>
** <code>models/</code>
** <code>scripts/</code>
** <code>sound/</code>
** <code>translation/</code>
** <code>ui/</code>
* <code>src/</code>
** <code>engine/</code> Engine source code.
*** <code>asm/</code>
*** <code>client/</code>
*** <code>null/</code>
*** <code>qcommon/</code>
*** <code>renderer/</code> Vanilla (fixed-function pipeline) renderer
*** <code>rendererGL/</code> Modern XReal-based renderer
*** <code>server/</code>
*** <code>sys/</code>
** <code>gamelogic/</code> Code that falls outside the scope of the core engine. These are all run in separate [[virtual machines]].
*** <code>cgame/</code> Client-side game code.
*** <code>game/</code> Server-side game code.
*** <code>ui/</code> User interface code.

==Program entry point==

The <code>main</code> function may be found at around line 591 of {{SourceFile|src/engine/sys/sys_main.c}}. Note that some magic happens on the Mac in {{SourceFile|src/engine/sys/SDLMain.m}}.

==Lag compensation==

Daemon uses Neil "haste" Toronto's [http://www.ra.is/unlagged/ Unlagged mod].

==Game logic==

Buildable information is encapsulated in the <code>cg_buildables</code> array (declared in {{SourceFile|src/gamelogic/cgame/cg_main.c|cg_main.c}})

Constants used to define gamelogic variables are in {{SourceFile|src/gamelogic/game/tremulous.h}}.

Types:
* <code>buildableInfo_t</code> — Encapsulates data associated with buildables (sounds, animations, etc.).
* <code>buildable_t</code> — An enumeration of all buildable types.
* <code>buildableAttributes_t</code> — Encapsulates gameplay information associated with buildables. There is an array of these called <code>bg_buildableList</code>.

==Server-side==

Server game state initialization occurs in <code>G_InitGame()</code> in {{SourceFile|src/gamelogic/game/g_main.c}}.

==Particle & trail system==

For now, please see the [http://tremulous.net/manual/#x1-130003.2 Tremulous documentation].

==GL3 Renderer==

This section is a work-in-progress.

Source code for the OpenGL 3 renderer is located in {{SourceFile|src/engine/rendererGL}}.

Shaders are implemented as subclasses of the <code>GLShader</code> class. All are defined in {{SourceFile|src/engine/rendererGL/gl_shader.h}}.

Compiled GLSL shader files (located in the hard-coded location <code>"glsl/"</code> with the <code>.bin</code> filename extension) are read by <code>GLShader::LoadShaderBinary()</code>.

All possible parameters (what OpenGL calls [http://www.opengl.org/sdk/docs/man4/xhtml/glUniform.xml "uniform variables"]) that may be passed to a shader are enumerated in the <code>shaderProgram_t</code> structure in {{SourceFile|src/engine/rendererGL/tr_local.h}}.

Shaders with duplicate functionality is achieved with multiple inheritance. E.g., <code>gl_genericShader</code> is of type <code>GLShader_generic*</code> which derives from the following classes:

* <code>GLShader</code>
* <code>u_ColorMap</code>
* <code>u_ColorTextureMatrix</code>
* <code>u_ViewOrigin</code>
* <code>u_AlphaTest</code>
* <code>u_ModelMatrix</code>
* <code>u_ModelViewProjectionMatrix</code>
* <code>u_ColorModulate</code>
* <code>u_Color</code>
* <code>u_BoneMatrix</code>
* <code>u_VertexInterpolation</code>
* <code>u_PortalPlane</code>
* <code>GLDeformStage</code>
* <code>GLCompileMacro_USE_PORTAL_CLIPPING</code>
* <code>GLCompileMacro_USE_ALPHA_TESTING</code>
* <code>GLCompileMacro_USE_VERTEX_SKINNING</code>
* <code>GLCompileMacro_USE_VERTEX_ANIMATION</code>
* <code>GLCompileMacro_USE_DEFORM_VERTEXES</code>
* <code>GLCompileMacro_USE_TCGEN_ENVIRONMENT</code>
* <code>GLCompileMacro_USE_TCGEN_LIGHTMAP</code>

GLSL shaders may be found in <code>main/glsl/</code>. Please see the [[GLSL Shaders|full article]] for a complete listing.

===Helper classes===

As mentioned above, shader classes make use of multiple inheritance to give them the relevant methods for controlling their behavior.

====Uniform variables====

Uniform variables are controlled with classes with the <code>u_</code> prefix:

* u_BoneMatrix — Provides the convenience method <code>SetUniform_BoneMatrix</code>.

====Compile macros====

* <code>GLCompileMacro_USE_ALPHA_TESTING</code>
* <code>GLCompileMacro_USE_PORTAL_CLIPPING</code>
* <code>GLCompileMacro_USE_FRUSTUM_CLIPPING</code>
* <code>GLCompileMacro_USE_VERTEX_SKINNING</code>
* <code>GLCompileMacro_USE_VERTEX_ANIMATION</code>
* <code>GLCompileMacro_USE_DEFORM_VERTEXES</code>
* <code>GLCompileMacro_USE_TCGEN_ENVIRONMENT</code>
* <code>GLCompileMacro_USE_TCGEN_LIGHTMAP</code>
* <code>GLCompileMacro_USE_NORMAL_MAPPING</code>
* <code>GLCompileMacro_USE_PARALLAX_MAPPING</code>
* <code>GLCompileMacro_USE_REFLECTIVE_SPECULAR</code>
* <code>GLCompileMacro_TWOSIDED</code>
* <code>GLCompileMacro_EYE_OUTSIDE</code>
* <code>GLCompileMacro_BRIGHTPASS_FILTER</code>
* <code>GLCompileMacro_LIGHT_DIRECTIONAL</code>
* <code>GLCompileMacro_USE_SHADOWING</code>
* <code>GLCompileMacro_USE_GBUFFER</code>

===Resources===

Mac OS X users with XCode installed can access OpenGL man pages via the terminal. 

Alternatively, OpenGL API reference documentation is available online:
* [http://www.opengl.org/sdk/docs/man3/ OpenGL 3.3 Reference Pages]
* [http://www.opengl.org/sdk/docs/manglsl/ OpenGL Shading Language (GLSL) Reference Pages]
* [http://www.khronos.org/files/opengl-quick-reference-card.pdf OpenGL 3.3 & GLSL Quick Reference Card]

==Valgrind and fglrx==

fglrx drivers cause Valgrind to spew out a lot of false errors. You can suppress these by using the --suppressions=/path/to/file.supp flag. You must pass the full path (no use of the tilde symbol). The following [http://www.mediafire.com/?z6ehwrxpw2m469h file] can be used as a template for your suppression file. Keep in mind that the location of the fglrx library may need to be changed.

==Resources==

===General Game Development===

* [http://devmaster.net/ Devmaster.net]

===OpenGL===

* [http://www.opengl.org/ Official OpenGL page]
* [http://www.opengl.org/sdk/docs/man3/ OpenGL 3.3 Reference Pages]
* [http://www.opengl.org/sdk/docs/manglsl/ OpenGL Shading Language Reference Pages]
* [http://arcsynthesis.org/gltut/ Learning Modern 3D Graphics Programming]

===Quake===

* "Looking at the Quake 3 Source"
** [http://element61.blogspot.com/2005/08/looking-at-quake-3-source-part-1.html Part 1]
** [http://element61.blogspot.com/2005/08/looking-at-quake-3-source-part-2.html Part 2]
** [http://element61.blogspot.com/2005/09/looking-at-quake-3-source-part-3.html Part 3]
* [http://www.quakewiki.net/archives/code3arena/ Code3Arena]
* [http://www.modwiki.net/wiki/MD5_(file_format) MD5 file format]
* [http://tfc.duke.free.fr/coding/md5-specs-en.html Another MD5 format article]
* [http://fabiensanglard.net/quake3/index.php Quake 3 Source Code Review]
* [http://www.quake3world.com/forum/index.php Quake3World Discussion Forums]
* [http://wiki.ioquake3.org/ ioquake3 project wiki] — Primarily oriented for users, developers and server administrators.

Compiling the source

2012-11-19T06:48:17Z

Danmal: /* Dependencies */

Compiling the source

2012-07-27T04:19:09Z

Danmal: /* Errors */

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code. Note: Xcode currently does not build QVMs due to [https://github.com/Unvanquished/Unvanquished/issues/101 issue 101].

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

You will also need to build the libraries from source.

Unvanquished requires the following libraries:
* The jpeg library, version 8 or higher. (Version 6 was known to have problems)
* Simple DirectMedia Layer (The binary provided by libsdl.org causes graphical corruptions. Compile from source or use homebrew/macports)
* OpenGL Extension Wrangler Library
* CuRL
* GMP

Optional libraries:
* WebP
* Theora
* Speex
* XVid
* Vorbis

===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.

====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

===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.
# Click "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>.
## You may safely disable <code>USE_WEBP</code> to avoid having to compile the library. (At present, the format is not used by any game assets.)
## Check <code>USE_INTERNAL_CRYPTO</code> to avoid having to compile nettle and hogweed.
## Check <code>USE_INTERNAL_SPEEX</code> to avoid having to compile Speex.
## 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.
# Click "Generate".
# You may now close XCode.

===Compiling===

====With XCode====
# Either start XCode and open the project file (in the build directory you specified) or double-click the project file in Finder.
# Open the project file created by CMake, which should be in the build directory you specified.
# Change the active target to "ALL_BUILD" and click Product→Build.

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Type 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 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====

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 Ctrl+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 however this feature is relatively new and may have some bugs.

Steps:

# Double click on Visual_Studio32.bat
# Open build-32/Daemon.sln 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 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 [https://github.com/Unvanquished/Unvanquished/issues/102 issue 102]
* Due to limitations with cmake neither the startup project nor the working directory can be specified. These must be manually set to the following values for debugging the client under 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 $(TargetPath)\..

===MinGW===
Unvanquished is supported under MinGW. The build process should be fairly similar to the Linux instructions.

==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

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished/build</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak2.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak3.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak4.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

On FreeBSD, use <code>fetch -r</code> instead of <code>wget</code>. You can also get the pak files in this way (requires cURL):

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

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will, by default, download missing files for you.

Now you can proceed to [[running the game]].

==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 Enter to begin editing and input in the path.
# Press C to configure and G to generate the new makefiles.
# Press 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/

Compiling the source

2012-07-27T04:06:38Z

Danmal: /* Mac OS X */

Compiling the source

2012-07-27T02:45:05Z

Danmal: /* Mac OS X */ Remove library download + compile script. Out of date

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code. Note: Xcode currently does not build QVMs due to [https://github.com/Unvanquished/Unvanquished/issues/101 issue 101].

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

You will also need to build the libraries from source.

Unvanquished requires the following libraries:
* The jpeg library, version 8 or higher. (Version 6 was known to have problems)
* Simple DirectMedia Layer (The binary provided by libsdl.org causes graphical corruptions. Compile from source or use homebrew/macports)
* OpenGL Extension Wrangler Library

Optional libraries:
* WebP
* Theora
* Speex
* XVid

===Dependencies===

The following are shell scripts that download, compile, and install various 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

===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.
# Click "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>.
## You may safely disable <code>USE_WEBP</code> to avoid having to compile the library. (At present, the format is not used by any game assets.)
## Check <code>USE_INTERNAL_CRYPTO</code> to avoid having to compile nettle and hogweed.
## Check <code>USE_INTERNAL_SPEEX</code> to avoid having to compile Speex.
## 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.
# Click "Generate".
# You may now close XCode.

===Compiling===

====With XCode====
# Either start XCode and open the project file (in the build directory you specified) or double-click the project file in Finder.
# Open the project file created by CMake, which should be in the build directory you specified.
# Change the active target to "ALL_BUILD" and click Product→Build.

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Type 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 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====

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 Ctrl+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 however this feature is relatively new and may have some bugs.

Steps:

# Double click on Visual_Studio32.bat
# Open build-32/Daemon.sln 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 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 [https://github.com/Unvanquished/Unvanquished/issues/102 issue 102]
* Due to limitations with cmake neither the startup project nor the working directory can be specified. These must be manually set to the following values for debugging the client under 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 $(TargetPath)\..

===MinGW===
Unvanquished is supported under MinGW. The build process should be fairly similar to the Linux instructions.

==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

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished/build</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak2.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak3.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak4.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

On FreeBSD, use <code>fetch -r</code> instead of <code>wget</code>. You can also get the pak files in this way (requires cURL):

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

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will, by default, download missing files for you.

Now you can proceed to [[running the game]].

==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 Enter to begin editing and input in the path.
# Press C to configure and G to generate the new makefiles.
# Press Q to quit.
# Recompile the source:<pre>$ make</pre>

Compiling the source

2012-07-14T07:02:45Z

Danmal: /* Visual Studio */

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code. Note: Xcode currently does not build QVMs due to [https://github.com/Unvanquished/Unvanquished/issues/101 issue 101].

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

You may use this [http://home.comcast.net/~chet102103/compile.sh script] to perform these tasks. If you've downloaded the source to a folder named ''Unvanquished'' in the current directory, a typical invocation would look like this:

$ ./compile.sh --bundle --compile -s Unvanquished --build Unvanquished-build --bundle-dest .

You will also need to build the libraries from source.

Unvanquished requires the following libraries:
* The jpeg library, version 8 or higher. (Version 6 was known to have problems)
* Simple DirectMedia Layer (The binary provided by libsdl.org causes graphical corruptions. Compile from source or use homebrew/macports)
* OpenGL Extension Wrangler Library

Optional libraries:
* WebP
* Theora
* Speex
* XVid

===Dependencies===

The following are shell scripts that download, compile, and install various 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

===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.
# Click "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>.
## You may safely disable <code>USE_WEBP</code> to avoid having to compile the library. (At present, the format is not used by any game assets.)
## Check <code>USE_INTERNAL_CRYPTO</code> to avoid having to compile nettle and hogweed.
## Check <code>USE_INTERNAL_SPEEX</code> to avoid having to compile Speex.
## 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.
# Click "Generate".
# You may now close XCode.

===Compiling===

====With XCode====
# Either start XCode and open the project file (in the build directory you specified) or double-click the project file in Finder.
# Open the project file created by CMake, which should be in the build directory you specified.
# Change the active target to "ALL_BUILD" and click Product→Build.

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Type 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 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====

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 Ctrl+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 however this feature is relatively new and may have some bugs.

Steps:

# Double click on Visual_Studio32.bat
# Open build-32/Daemon.sln 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 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 [https://github.com/Unvanquished/Unvanquished/issues/102 issue 102]
* Due to limitations with cmake neither the startup project nor the working directory can be specified. These must be manually set to the following values for debugging the client under 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 $(TargetPath)\..

===MinGW===
Unvanquished is supported under MinGW. The build process should be fairly similar to the Linux instructions.

==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

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished/build</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak2.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak3.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak4.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

On FreeBSD, use <code>fetch -r</code> instead of <code>wget</code>. You can also get the pak files in this way (requires cURL):

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

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will, by default, download missing files for you.

Now you can proceed to [[running the game]].

==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 Enter to begin editing and input in the path.
# Press C to configure and G to generate the new makefiles.
# Press Q to quit.
# Recompile the source:<pre>$ make</pre>

Compiling the source

2012-07-03T06:10:32Z

Danmal: /* Acquiring the Game Files */ Add new pak3 files

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code. Note: Xcode currently does not build QVMs due to [https://github.com/Unvanquished/Unvanquished/issues/101 issue 101].

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

You may use this [http://home.comcast.net/~chet102103/compile.sh script] to perform these tasks. If you've downloaded the source to a folder named ''Unvanquished'' in the current directory, a typical invocation would look like this:

$ ./compile.sh --bundle --compile -s Unvanquished --build Unvanquished-build --bundle-dest .

You will also need to build the libraries from source.

Unvanquished requires the following libraries:
* The jpeg library, version 8 or higher. (Version 6 was known to have problems)
* Simple DirectMedia Layer (The binary provided by libsdl.org causes graphical corruptions. Compile from source or use homebrew/macports)
* OpenGL Extension Wrangler Library

Optional libraries:
* WebP
* Theora
* Speex
* XVid

===Dependencies===

The following are shell scripts that download, compile, and install various 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 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

===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.
# Click "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>.
## You may safely disable <code>USE_WEBP</code> to avoid having to compile the library. (At present, the format is not used by any game assets.)
## Check <code>USE_INTERNAL_CRYPTO</code> to avoid having to compile nettle and hogweed.
## Check <code>USE_INTERNAL_SPEEX</code> to avoid having to compile Speex.
## 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.
# Click "Generate".
# You may now close XCode.

===Compiling===

====With XCode====
# Either start XCode and open the project file (in the build directory you specified) or double-click the project file in Finder.
# Open the project file created by CMake, which should be in the build directory you specified.
# Change the active target to "ALL_BUILD" and click Product→Build.

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Type 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 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====

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 Ctrl+D on the keyboard.

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

[[File:Bundle_dir_Mac_OS_X.png]]

==Windows==

===Visual Studio===

CMake can generate Visual Studio projects for unvanquished however this feature is relatively new and may have some bugs.

Steps:

# Double click on Visual_Studio32.bat
# Open build-32/Daemon.sln 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 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 [https://github.com/Unvanquished/Unvanquished/issues/102 issue 102]

===MinGW===
Unvanquished is supported under MinGW. The build process should be fairly similar to the Linux instructions.

==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

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished/build</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak2.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak3.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak4.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

On FreeBSD, use <code>fetch -r</code> instead of <code>wget</code>. You can also get the pak files in this way (requires cURL):

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

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will, by default, download missing files for you.

Now you can proceed to [[running the game]].

==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 Enter to begin editing and input in the path.
# Press C to configure and G to generate the new makefiles.
# Press Q to quit.
# Recompile the source:<pre>$ make</pre>

Compiling the source

2012-07-03T06:09:35Z

Danmal: /* Important Notes */

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code. Note: Xcode currently does not build QVMs due to [https://github.com/Unvanquished/Unvanquished/issues/101 issue 101].

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

You may use this [http://home.comcast.net/~chet102103/compile.sh script] to perform these tasks. If you've downloaded the source to a folder named ''Unvanquished'' in the current directory, a typical invocation would look like this:

$ ./compile.sh --bundle --compile -s Unvanquished --build Unvanquished-build --bundle-dest .

You will also need to build the libraries from source.

Unvanquished requires the following libraries:
* The jpeg library, version 8 or higher. (Version 6 was known to have problems)
* Simple DirectMedia Layer (The binary provided by libsdl.org causes graphical corruptions. Compile from source or use homebrew/macports)
* OpenGL Extension Wrangler Library

Optional libraries:
* WebP
* Theora
* Speex
* XVid

===Dependencies===

The following are shell scripts that download, compile, and install various 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 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

===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.
# Click "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>.
## You may safely disable <code>USE_WEBP</code> to avoid having to compile the library. (At present, the format is not used by any game assets.)
## Check <code>USE_INTERNAL_CRYPTO</code> to avoid having to compile nettle and hogweed.
## Check <code>USE_INTERNAL_SPEEX</code> to avoid having to compile Speex.
## 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.
# Click "Generate".
# You may now close XCode.

===Compiling===

====With XCode====
# Either start XCode and open the project file (in the build directory you specified) or double-click the project file in Finder.
# Open the project file created by CMake, which should be in the build directory you specified.
# Change the active target to "ALL_BUILD" and click Product→Build.

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Type 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 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====

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 Ctrl+D on the keyboard.

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

[[File:Bundle_dir_Mac_OS_X.png]]

==Windows==

===Visual Studio===

CMake can generate Visual Studio projects for unvanquished however this feature is relatively new and may have some bugs.

Steps:

# Double click on Visual_Studio32.bat
# Open build-32/Daemon.sln 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 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 [https://github.com/Unvanquished/Unvanquished/issues/102 issue 102]

===MinGW===
Unvanquished is supported under MinGW. The build process should be fairly similar to the Linux instructions.

==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

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished/build</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak2.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

On FreeBSD, use <code>fetch -r</code> instead of <code>wget</code>. You can also get the pak files in this way (requires cURL):

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

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will, by default, download missing files for you.

Now you can proceed to [[running the game]].

==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 Enter to begin editing and input in the path.
# Press C to configure and G to generate the new makefiles.
# Press Q to quit.
# Recompile the source:<pre>$ make</pre>

Compiling the source

2012-07-03T06:04:40Z

Danmal: /* Mac OS X */

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code. Note: Xcode currently does not build QVMs due to [https://github.com/Unvanquished/Unvanquished/issues/101 issue 101].

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

You may use this [http://home.comcast.net/~chet102103/compile.sh script] to perform these tasks. If you've downloaded the source to a folder named ''Unvanquished'' in the current directory, a typical invocation would look like this:

$ ./compile.sh --bundle --compile -s Unvanquished --build Unvanquished-build --bundle-dest .

You will also need to build the libraries from source.

Unvanquished requires the following libraries:
* The jpeg library, version 8 or higher. (Version 6 was known to have problems)
* Simple DirectMedia Layer (The binary provided by libsdl.org causes graphical corruptions. Compile from source or use homebrew/macports)
* OpenGL Extension Wrangler Library

Optional libraries:
* WebP
* Theora
* Speex
* XVid

===Dependencies===

The following are shell scripts that download, compile, and install various 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 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

===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.
# Click "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>.
## You may safely disable <code>USE_WEBP</code> to avoid having to compile the library. (At present, the format is not used by any game assets.)
## Check <code>USE_INTERNAL_CRYPTO</code> to avoid having to compile nettle and hogweed.
## Check <code>USE_INTERNAL_SPEEX</code> to avoid having to compile Speex.
## 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.
# Click "Generate".
# You may now close XCode.

===Compiling===

====With XCode====
# Either start XCode and open the project file (in the build directory you specified) or double-click the project file in Finder.
# Open the project file created by CMake, which should be in the build directory you specified.
# Change the active target to "ALL_BUILD" and click Product→Build.

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Type 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 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====

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 Ctrl+D on the keyboard.

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

[[File:Bundle_dir_Mac_OS_X.png]]

==Windows==

===Visual Studio===

CMake can generate Visual Studio projects for unvanquished however this feature is relatively new and may have some bugs.

Steps:

# Double click on Visual_Studio32.bat
# Open build-32/Daemon.sln 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 F5 to build solution and run application, or just use Build → Build Solution to compile the code.

====Important Notes====

* The CMake script currently only supports 32 bit builds however this will change in the future
* QVM, LLVM and glsl-optimizer are disabled and probably do not work correctly with CMake generated Visual Studio projects.
* ncurses is not supported under Visual Studio.

===MinGW===
Unvanquished is supported under MinGW. The build process should be fairly similar to the Linux instructions.

==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

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished/build</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak2.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

On FreeBSD, use <code>fetch -r</code> instead of <code>wget</code>. You can also get the pak files in this way (requires cURL):

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

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will, by default, download missing files for you.

Now you can proceed to [[running the game]].

==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 Enter to begin editing and input in the path.
# Press C to configure and G to generate the new makefiles.
# Press Q to quit.
# Recompile the source:<pre>$ make</pre>

Compiling the source

2012-07-01T14:36:33Z

Danmal: /* Mac OS X */ Changed SDL instructions to indicate that users should compile from source.

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code.

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

You may use this [http://home.comcast.net/~chet102103/compile.sh script] to perform these tasks. If you've downloaded the source to a folder named ''Unvanquished'' in the current directory, a typical invocation would look like this:

$ ./compile.sh --bundle --compile -s Unvanquished --build Unvanquished-build --bundle-dest .

You will also need to build the libraries from source.

Unvanquished requires the following libraries:
* The jpeg library, version 8 or higher. (Version 6 was known to have problems)
* Simple DirectMedia Layer (The binary provided by libsdl.org causes graphical corruptions. Compile from source or use homebrew/macports)
* OpenGL Extension Wrangler Library

Optional libraries:
* WebP
* Theora
* Speex
* XVid

===Dependencies===

The following are shell scripts that download, compile, and install various 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 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

===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.
# Click "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>.
## You may safely disable <code>USE_WEBP</code> to avoid having to compile the library. (At present, the format is not used by any game assets.)
## Check <code>USE_INTERNAL_CRYPTO</code> to avoid having to compile nettle and hogweed.
## Check <code>USE_INTERNAL_SPEEX</code> to avoid having to compile Speex.
## 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.
# Click "Generate".
# You may now close XCode.

===Compiling===

====With XCode====
# Either start XCode and open the project file (in the build directory you specified) or double-click the project file in Finder.
# Open the project file created by CMake, which should be in the build directory you specified.
# Change the active target to "ALL_BUILD" and click Product→Build.

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Type 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 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====

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 Ctrl+D on the keyboard.

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

[[File:Bundle_dir_Mac_OS_X.png]]

==Windows==

===Visual Studio===

CMake can generate Visual Studio projects for unvanquished however this feature is relatively new and may have some bugs.

Steps:

# Double click on Visual_Studio32.bat
# Open build-32/Daemon.sln 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 F5 to build solution and run application, or just use Build → Build Solution to compile the code.

====Important Notes====

* The CMake script currently only supports 32 bit builds however this will change in the future
* QVM, LLVM and glsl-optimizer are disabled and probably do not work correctly with CMake generated Visual Studio projects.
* ncurses is not supported under Visual Studio.

===MinGW===
Unvanquished is supported under MinGW. The build process should be fairly similar to the Linux instructions.

==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

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished/build</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak2.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

On FreeBSD, use <code>fetch -r</code> instead of <code>wget</code>. You can also get the pak files in this way (requires cURL):

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

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will, by default, download missing files for you.

Now you can proceed to [[running the game]].

==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 Enter to begin editing and input in the path.
# Press C to configure and G to generate the new makefiles.
# Press Q to quit.
# Recompile the source:<pre>$ make</pre>

Compiling the source

2012-07-01T13:48:10Z

Danmal: /* With CPack */

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code.

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

You may use this [http://home.comcast.net/~chet102103/compile.sh script] to perform these tasks. If you've downloaded the source to a folder named ''Unvanquished'' in the current directory, a typical invocation would look like this:

$ ./compile.sh --bundle --compile -s Unvanquished --build Unvanquished-build --bundle-dest .

You will also need to build the libraries from source.

Unvanquished requires the following libraries:
* The jpeg library, version 8 or higher. (Version 6 was known to have problems)
* Simple DirectMedia Layer
* OpenGL Extension Wrangler Library

Optional libraries:
* WebP
* Theora
* Speex
* XVid

===Dependencies===

The following are shell scripts that download, compile, and install various 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)====

At present, there are binaries for SDL.

Intel systems running 10.5 or higher:
$ curl http://www.libsdl.org/release/SDL-1.2.15.dmg > SDL-1.2.15.dmg
$ hdiutil attach SDL-1.2.15.dmg
$ sudo cp -r /Volumes/SDL/SDL.framework /Library/Frameworks
$ hdiutil detach /Volumes/SDL

Intel or PPC systems running 10.4 or higher:
$ curl http://www.libsdl.org/release/SDL-1.2.15-OSX10.4.dmg > SDL-1.2.15-OSX10.4.dmg
$ hdiutil attach SDL-1.2.15-OSX10.4.dmg
$ sudo cp -r /Volumes/SDL/SDL.framework /Library/Frameworks
$ hdiutil detach /Volumes/SDL

====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

===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.
# Click "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>.
## You may safely disable <code>USE_WEBP</code> to avoid having to compile the library. (At present, the format is not used by any game assets.)
## Check <code>USE_INTERNAL_CRYPTO</code> to avoid having to compile nettle and hogweed.
## Check <code>USE_INTERNAL_SPEEX</code> to avoid having to compile Speex.
## 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.
# Click "Generate".
# You may now close XCode.

===Compiling===

====With XCode====
# Either start XCode and open the project file (in the build directory you specified) or double-click the project file in Finder.
# Open the project file created by CMake, which should be in the build directory you specified.
# Change the active target to "ALL_BUILD" and click Product→Build.

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Type 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 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====

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 Ctrl+D on the keyboard.

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

[[File:Bundle_dir_Mac_OS_X.png]]

==Windows==

===Visual Studio===

CMake can generate Visual Studio projects for unvanquished however this feature is relatively new and may have some bugs.

Steps:

# Double click on Visual_Studio32.bat
# Open build-32/Daemon.sln 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 F5 to build solution and run application, or just use Build → Build Solution to compile the code.

====Important Notes====

* The CMake script currently only supports 32 bit builds however this will change in the future
* QVM, LLVM and glsl-optimizer are disabled and probably do not work correctly with CMake generated Visual Studio projects.
* ncurses is not supported under Visual Studio.

===MinGW===
Unvanquished is supported under MinGW. The build process should be fairly similar to the Linux instructions.

==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

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished/build</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak2.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

On FreeBSD, use <code>fetch -r</code> instead of <code>wget</code>. You can also get the pak files in this way (requires cURL):

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

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will, by default, download missing files for you.

Now you can proceed to [[running the game]].

==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 Enter to begin editing and input in the path.
# Press C to configure and G to generate the new makefiles.
# Press Q to quit.
# Recompile the source:<pre>$ make</pre>

Wiki project resources

2012-07-01T11:28:51Z

Danmal:

At present, the wiki needs a lot of work.

At the time of this writing, most article writers need to learn about web design ergonomics.


Various contents, including ToDo lists, screenshots, release data files, large text messages, and other shared files are hosted at foreign websites. They should be moved to unvanquished.net, for which sufficient serving functionality should be installed. The priorities for these are based on the removal of ''web browsing analytics'', the ease of installation.

==Pages in need of work==

Aside from these pages, please also see the [[Special:WantedPages|the list of wanted pages]].

===Technical documentation===

* [[List of cvars]] and their documentation
* [[Creating custom keybinds]]
* [[Mapping]]
* [[Modeling Guide]]
* [[Music and sounds]]

===Gameplay===

* [[Aliens]]
** Buildables:
*** [[Egg]]
*** [[Overmind]]
*** [[Acid Tube]]
*** [[Hive]]
*** [[Trapper]]
*** [[Barricade]]
** Classes:
*** [[Dretch]]
*** [[Granger]]
*** [[Basilisk]]
*** [[Marauder]]
*** [[Dragoon]]
*** [[Tyrant]]
* [[Humans]]
** Upgrades/Armor:
*** [[Jetpack]]
*** [[Helmet]]
*** [[Battery Pack]]
*** [[Battlesuit]]
** Weapons:
*** [[Construction Kit]]
*** [[Blaster]]
*** [[Rifle]]
*** [[Pain Saw]]
*** [[Shotgun]]
*** [[Las Gun]]
*** [[Mass Driver]]
*** [[Chaingun]]
*** [[Plasma Rifle]]
*** [[Lucifer Cannon]]
** Buildables:
*** [[Telenode]]
*** [[Reactor]]
*** [[Machinegun Turret]]
*** [[Armory]]
*** [[Medistation]]
*** [[Defense Computer]]
*** [[Tesla Generator]]

Creating custom keybinds

2012-06-27T15:05:16Z

Danmal: changed Daemon to Unvanquished

{| align="right"
| __TOC__
|}
==Overview==

'''''The information on this page is incomplete.'''''

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==New commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

===LoadTranslations===

===SaveNewTranslations===

===SaveTranslations===

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===animationlist===

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===calc===

===clearaliases===
Clears all command aliases.

===concat===

===cycle===

===delay===

===editbind===
<tt>editbind KEY</tt>

This inserts a <tt>/bind</tt> command into the in-game console, ready for editing. The console is opened if needed.

===fbolist===

===fieldinfo===

===gameCompleteStatus===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example: <pre>/if shift "/echo Hello" "/echo Goodbye"</pre>

===irc_connect===

===irc_quit===

===irc_say===

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===math===

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===modelist===

===openurl===

===pubkey===

===pubkey_identify===

===random===

===reloadhud===

===say_area_team===

===screenshotPNG===
Saves a screenshot.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===setRecommended===

===shaderexp===

===snd_reload===

===spdevmap===
Does nothing.

===speclock===

===specunlock===

===spmap===
Does nothing.

===strcmp===

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

===updatehunkusage===

===updatescreen===

===vbolist===

===wav_record===

===wav_stoprecord===

Compiling the source

2012-06-18T11:24:57Z

Danmal: /* Visual Studio */

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code.

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

You may use [http://home.comcast.net/~chet102103/compile.sh this script] to perform these tasks. If you downloaded the source to a folder named <code>Unvanquished</code> in the current directory, a typical invocation would look like this:

$./compile.sh --bundle --compile -s Unvanquished --build Unvanquished-build --bundle-dest .

You will also need to build the libraries from source.

Unvanquished requires the following:
* The jpeg library from the [http://www.ijg.org/ Independent JPEG Group], version 8 or higher. (Version 6 was known to have problems).
* Simple DirectMedia Layer
* The OpenGL Extension Wrangler Library

Optional libraries:
* WebP
* Theora
* Speex
* XVid

===Dependencies===

====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)====

At present, there are binaries for SDL.

Intel systems running 10.5 or higher:
$ curl http://www.libsdl.org/release/SDL-1.2.15.dmg > SDL-1.2.15.dmg
$ hdiutil attach SDL-1.2.15.dmg
$ sudo cp -r /Volumes/SDL/SDL.framework /Library/Frameworks
$ hdiutil detach /Volumes/SDL

Intel or PPC systems running 10.4 or higher:
$ curl http://www.libsdl.org/release/SDL-1.2.15-OSX10.4.dmg > SDL-1.2.15-OSX10.4.dmg
$ hdiutil attach SDL-1.2.15-OSX10.4.dmg
$ sudo cp -r /Volumes/SDL/SDL.framework /Library/Frameworks
$ hdiutil detach /Volumes/SDL

====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

===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.
# Click "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>.
## You may safely disable <code>USE_WEBP</code> to avoid having to compile the library. (At present, the format is not used by any game assets.)
## Check <code>USE_INTERNAL_CRYPTO</code> to avoid having to compile nettle and hogweed.
## Check <code>USE_INTERNAL_SPEEX</code> to avoid having to compile Speex.
## 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.
# Click "Generate".
# You may now close XCode.

===Compiling===

====With XCode====
# Either start XCode and open the project file (in the build directory you specified) or double-click the project file in Finder.
# Open the project file created by CMake, which should be in the build directory you specified.
# Change the active target to "ALL_BUILD" and click Product→Build.

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Type 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 Unix Makefiles====

After compiling, you'll have to place the data files (<code>[http://sourceforge.net/projects/Unvanquished/files/Assets/pak0.pk3/download pak0.pk3]</code>, <code>[http://sourceforge.net/projects/Unvanquished/files/Assets/pak1.pk3/download pak1.pk3]</code>, and <code>[http://sourceforge.net/projects/Unvanquished/files/Assets/pak2.pk3/download pak2.pk3]</code>) in the <code>main</code> directory in your build directory.

$ cd /path/to/Unvanquished
$ cd main
$ curl -L http://sourceforge.net/projects/Unvanquished/files/Assets/pak1.pk3/download > pak0.pk3
$ curl -L http://sourceforge.net/projects/Unvanquished/files/Assets/pak1.pk3/download > pak1.pk3
$ curl -L http://sourceforge.net/projects/Unvanquished/files/Assets/pak1.pk3/download > pak2.pk3
$ cd ..

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====

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 Ctrl+D on the keyboard.

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

[[File:Bundle_dir_Mac_OS_X.png]]

==Windows==

===Visual Studio===

CMake can generate Visual Studio projects for unvanquished however this feature is relatively new and may have some bugs.

Steps:

# Double click on Visual_Studio32.bat
# Open build-32/Daemon.sln 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 F5 to build solution and run application, or just use Build → Build Solution to compile the code.

====Important Notes====

* The CMake script currently only supports 32 bit builds however this will change in the future
* QVM, LLVM and glsl-optimizer are disabled and probably do not work correctly with CMake generated Visual Studio projects.
* ncurses is not supported under Visual Studio.

===MinGW===
Unvanquished is supported under MinGW. The build process should be fairly similar to the Linux instructions.

==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

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished/build</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak2.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

You can also get the pak files in this way (requires curl):

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

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will normally download it for you.

Now you can proceed to [[running the game]].

==Errors==

===CMake cannot locate Newton===

If CMake cannot find Newton, you'll need to set it 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>os</var> with the proper location.

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

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

Compiling the source

2012-06-18T08:46:16Z

Danmal: /* Mac OS X */

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code.

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

You may use [http://home.comcast.net/~chet102103/compile.sh this script] to perform these tasks. If you downloaded the source to a folder named <code>Unvanquished</code> in the current directory, a typical invocation would look like this:

$./compile.sh --bundle --compile -s Unvanquished --build Unvanquished-build --bundle-dest .

You will also need to build the libraries from source.

Unvanquished requires the following:
* The jpeg library from the [http://www.ijg.org/ Independent JPEG Group], version 8 or higher. (Version 6 was known to have problems).
* Simple DirectMedia Layer
* The OpenGL Extension Wrangler Library

Optional libraries:
* WebP
* Theora
* Speex
* XVid

===Dependencies===

====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)====

At present, there are binaries for SDL.

Intel systems running 10.5 or higher:
$ curl http://www.libsdl.org/release/SDL-1.2.15.dmg > SDL-1.2.15.dmg
$ hdiutil attach SDL-1.2.15.dmg
$ sudo cp -r /Volumes/SDL/SDL.framework /Library/Frameworks
$ hdiutil detach /Volumes/SDL

Intel or PPC systems running 10.4 or higher:
$ curl http://www.libsdl.org/release/SDL-1.2.15-OSX10.4.dmg > SDL-1.2.15-OSX10.4.dmg
$ hdiutil attach SDL-1.2.15-OSX10.4.dmg
$ sudo cp -r /Volumes/SDL/SDL.framework /Library/Frameworks
$ hdiutil detach /Volumes/SDL

====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

===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.
# Click "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>.
## You may safely disable <code>USE_WEBP</code> to avoid having to compile the library. (At present, the format is not used by any game assets.)
## Check <code>USE_INTERNAL_CRYPTO</code> to avoid having to compile nettle and hogweed.
## Check <code>USE_INTERNAL_SPEEX</code> to avoid having to compile Speex.
## 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.
# Click "Generate".
# You may now close XCode.

===Compiling===

====With XCode====
# Either start XCode and open the project file (in the build directory you specified) or double-click the project file in Finder.
# Open the project file created by CMake, which should be in the build directory you specified.
# Change the active target to "ALL_BUILD" and click Product→Build.

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Type 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 Unix Makefiles====

After compiling, you'll have to place the data files (<code>[http://sourceforge.net/projects/Unvanquished/files/Assets/pak0.pk3/download pak0.pk3]</code>, <code>[http://sourceforge.net/projects/Unvanquished/files/Assets/pak1.pk3/download pak1.pk3]</code>, and <code>[http://sourceforge.net/projects/Unvanquished/files/Assets/pak2.pk3/download pak2.pk3]</code>) in the <code>main</code> directory in your build directory.

$ cd /path/to/Unvanquished
$ cd main
$ curl -L http://sourceforge.net/projects/Unvanquished/files/Assets/pak1.pk3/download > pak0.pk3
$ curl -L http://sourceforge.net/projects/Unvanquished/files/Assets/pak1.pk3/download > pak1.pk3
$ curl -L http://sourceforge.net/projects/Unvanquished/files/Assets/pak1.pk3/download > pak2.pk3
$ cd ..

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====

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 Ctrl+D on the keyboard.

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

[[File:Bundle_dir_Mac_OS_X.png]]

==Windows==

===Visual Studio===

The preferred way of building Unvanquished on Windows is to use Microsoft Visual Studio 2010.

The free Express version of the software works fine.

Steps:

# Open src/engine/Daemon.sln in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" in the first one and Win32 or Win64 in the second one
# Press F5 to build solution and run application, or just use Build → Build Solution to compile the code.

CMake can generate Visual Studio projects for unvanquished however this feature is relatively new and may have some bugs.

Steps:

# Double click on Visual_Studio32.bat
# Open build-32/Daemon.sln 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 F5 to build solution and run application, or just use Build → Build Solution to compile the code.

====Important Notes====

* The provided Visual Studio project file is out of date and may not work correctly. The CMake generated solutions will always be up to date however.
* The CMake script currently only supports 32 bit builds however this will change in the future
* QVM, LLVM, glsl-optimizer and OpenAL are disabled and probably do not work correctly with CMake generated Visual Studio projects. OpenAL and glsl-optimizer is supported by the included Visual Studio File (llvm and qvm are not however)
* ncurses is not supported under Visual Studio.

===MinGW===
Unvanquished is supported under MinGW. The build process should be fairly similar to the Linux instructions.

==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

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished/build</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak2.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

You can also get the pak files in this way (requires curl):

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

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will normally download it for you.

Now you can proceed to [[running the game]].

==Errors==

===CMake cannot locate Newton===

If CMake cannot find Newton, you'll need to set it 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>os</var> with the proper location.

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

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

Compiling the source

2012-06-03T12:42:06Z

Danmal: /* Windows */

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code.

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

You may use [http://home.comcast.net/~chet102103/compile.sh this script] to perform these tasks. If you downloaded the source to a folder named <code>Unvanquished</code> in the current directory, a typical invocation would look like this:

$./compile.sh --bundle --compile -s Unvanquished --build Unvanquished-build --bundle-dest .

You will also need to build the libraries from source.

Unvanquished requires the following:
* The jpeg library from the [http://www.ijg.org/ Independent JPEG Group], version 8 or higher. (Version 6 was known to have problems).
* Simple DirectMedia Layer
* The OpenGL Extension Wrangler Library

Optional libraries:
* WebP
* Theora
* Speex
* XVid

===Dependencies===

====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)====

At present, there are binaries for SDL.

Intel systems running 10.5 or higher:
$ curl http://www.libsdl.org/release/SDL-1.2.15.dmg > SDL-1.2.15.dmg
$ hdiutil attach SDL-1.2.15.dmg
$ sudo cp -r /Volumes/SDL/SDL.framework /Library/Frameworks
$ hdiutil detach /Volumes/SDL

Intel or PPC systems running 10.4 or higher:
$ curl http://www.libsdl.org/release/SDL-1.2.15-OSX10.4.dmg > SDL-1.2.15-OSX10.4.dmg
$ hdiutil attach SDL-1.2.15-OSX10.4.dmg
$ sudo cp -r /Volumes/SDL/SDL.framework /Library/Frameworks
$ hdiutil detach /Volumes/SDL

Note that during the configuration process in CMake, you need to set the <code>SDLMAIN_LIBRARY</code> field blank.

====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

===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 may be the same directory.
# Click "Configure". You will be prompted as to which generator you would like to use. If you have Xcode installed, choose that. '''At the moment, the build process for XCode is not 100%. Select "Unix Makefiles" instead.''' 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>.
## You may safely disable <code>USE_WEBP</code> to avoid having to compile the library. (At present, the format is not used by any game assets.)
## Check <code>USE_INTERNAL_CRYPTO</code> to avoid having to compile nettle and hogweed.
## Check <code>USE_INTERNAL_SPEEX</code> to avoid having to compile Speex.
## 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.
# Click "Generate".
# You may now close XCode.

===Compiling===

====With XCode====
# Either start XCode and open the project file (in the build directory you specified) or double-click the project file in Finder.
# Open the project file created by CMake, which should be in the build directory you specified.
# Change the active target to "ALL_BUILD" and click Product→Build.

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Type 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 Unix Makefiles====

After compiling, you'll have to place the data files (<code>[http://sourceforge.net/projects/Unvanquished/files/Assets/pak0.pk3/download pak0.pk3]</code>, <code>[http://sourceforge.net/projects/Unvanquished/files/Assets/pak1.pk3/download pak1.pk3]</code>, and <code>[http://sourceforge.net/projects/Unvanquished/files/Assets/pak2.pk3/download pak2.pk3]</code>) in the <code>main</code> directory in your build directory.

$ cd /path/to/Unvanquished
$ cd main
$ curl -L http://sourceforge.net/projects/Unvanquished/files/Assets/pak1.pk3/download > pak0.pk3
$ curl -L http://sourceforge.net/projects/Unvanquished/files/Assets/pak1.pk3/download > pak1.pk3
$ curl -L http://sourceforge.net/projects/Unvanquished/files/Assets/pak1.pk3/download > pak2.pk3
$ cd ..

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 Unix Makefiles====

You'll find the Mac [http://macdylibbundler.sourceforge.net/ dynamic library bundler] to be quite useful:

$ 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 Ctrl+D on the keyboard.

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

[[File:Bundle_dir_Mac_OS_X.png]]

==Windows==

===Visual Studio===

The preferred way of building Unvanquished on Windows is to use Microsoft Visual Studio 2010.
The free Express version of the software works fine.

Steps:
# Open src/engine/Daemon.sln in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" in the first one and Win32 or Win64 in the second one
# Press F5 to build solution and run application, or just use Build → Build Solution to compile the code.

CMake can generate Visual Studio projects for unvanquished however this feature is relatively new and may have some bugs.

Steps:
# Double click on Visual_Studio32.bat
# Open build-32/Daemon.sln 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 F5 to build solution and run application, or just use Build → Build Solution to compile the code.

====Important Notes====
* The provided Visual Studio project file is out of date and may not work correctly. The CMake generated solutions will always be up to date however.
* The CMake script currently only supports 32 bit builds however this will change in the future
* QVM, LLVM, glsl-optimizer and OpenAL are disabled and probably do not work correctly with CMake generated Visual Studio projects. OpenAL and glsl-optimizer is supported by the included Visual Studio File (llvm and qvm are not however)
* ncurses is not supported under Visual Studio.

===MinGW===
Unvanquished is supported under MinGW. The build process should be fairly similar to the Linux instructions.

==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

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished/build</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak2.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

You can also get the pak files in this way (requires curl):

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

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will normally download it for you.

Now you can proceed to [[running the game]].

==Errors==

===CMake cannot locate Newton===

If CMake cannot find Newton, you'll need to set it 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>os</var> with the proper location.

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

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

Compiling the source

2012-04-15T09:04:39Z

Danmal: /* Crash/Freeze on Death */

==Overview==

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code.

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

Next, perform the following:

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This may be the same directory.
# Click "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.
# '''''TODO: explain which libraries will likely have to be set'''''
# Click "Generate".
# Close CMake and open Xcode.
# Open the project file created by CMake, which should be in the build directory you specified.
# Click the build button.

Unvanquished can also be built from the command line if you're not a fan of Xcode. The build process is the same as under Linux.

==Windows==

The preferred way of building Unvanquished on Windows is to use Microsoft Visual Studio 2010.
The free Express version of the software works fine.

Steps:
# Open src/engine/Daemon.sln in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" in the first one and Win32 or Win64 in the second one
# Press F5 to build solution and run application, or just use Build → Build Solution to compile the code.

==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

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished/build</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

You can also get the pak files in this way (requires curl):

$ cd <var>path/to/Unvanquished</var>
$ ./download-pk3.sh build/main

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will normally download it for you.

Now you can proceed to [[running the game]].

==Errors==
===Crash/Freeze on Death===
Some Linux users may experience a bug where the game freezes whenever you die. The work around until this bug is fixed is to to run <code>ccmake ..</code> and change <code>CMAKE_BUILD_TYPE</code> to <code>Debug</code>. Run <code>make</code> and it should now work.

Compiling the source

2012-04-15T09:04:07Z

Danmal:

Compiling the source

2012-04-15T08:54:11Z

Danmal: /* Acquiring the Game Files */

Compiling the source

2012-04-15T08:24:06Z

Danmal: /* Acquiring the Game Files */

==Overview==

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code.

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

Next, perform the following:

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This may be the same directory.
# Click "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.
# '''''TODO: explain which libraries will likely have to be set'''''
# Click "Generate".
# Close CMake and open Xcode.
# Open the project file created by CMake, which should be in the build directory you specified.
# Click the build button.

Unvanquished can also be built from the command line if you're not a fan of Xcode. The build process is the same as under Linux.

==Windows==

The preferred way of building Unvanquished on Windows is to use Microsoft Visual Studio 2010.
The free Express version of the software works fine.

Steps:
# Open src/engine/Daemon.sln in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" in the first one and Win32 or Win64 in the second one
# Press F5 to build solution and run application, or just use Build → Build Solution to compile the code.

==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

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished/build</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

You can also get the pak files in this way (requires curl):

$ cd <var>path/to/Unvanquished</var>
$ ./download-pk3.sh main

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will normally download it for you.

Now you can proceed to [[running the game]].

Compiling the source

2012-04-15T07:07:31Z

Danmal: /* Compiling */

==Overview==

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code.

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

Next, perform the following:

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This may be the same directory.
# Click "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.
# '''''TODO: explain which libraries will likely have to be set'''''
# Click "Generate".
# Close CMake and open Xcode.
# Open the project file created by CMake, which should be in the build directory you specified.
# Click the build button.

Unvanquished can also be built from the command line if you're not a fan of Xcode. The build process is the same as under Linux.

==Windows==

The preferred way of building Unvanquished on Windows is to use Microsoft Visual Studio 2010.
The free Express version of the software works fine.

Steps:
# Open src/engine/Daemon.sln in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" in the first one and Win32 or Win64 in the second one
# Press F5 to build solution and run application, or just use Build → Build Solution to compile the code.

==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 \
libhogweed2 libwebp-dev libspeex-dev libspeexdsp-dev libtheora-dev

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

You can also get the pak files in this way (requires curl):

$ cd <var>path/to/Unvanquished</var>
$ ./download-pk3.sh main

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will normally download it for you.

Now you can proceed to [[running the game]].

Compiling the source

2012-04-15T06:56:53Z

Danmal: /* Debian/Ubuntu */

==Overview==

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code.

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

Next, perform the following:

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This may be the same directory.
# Click "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.
# '''''TODO: explain which libraries will likely have to be set'''''
# Click "Generate".
# Close CMake and open Xcode.
# Open the project file created by CMake, which should be in the build directory you specified.
# Click the build button.

Unvanquished can also be built from the command line if you're not a fan of Xcode. The build process is the same as under Linux.

==Windows==

The preferred way of building Unvanquished on Windows is to use Microsoft Visual Studio 2010.
The free Express version of the software works fine.

Steps:
# Open src/engine/Daemon.sln in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" in the first one and Win32 or Win64 in the second one
# Press F5 to build solution and run application, or just use Build → Build Solution to compile the code.

==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 \
libhogweed2 libwebp-dev libspeex-dev libspeexdsp-dev libtheora-dev

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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</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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

You can also get the pak files in this way (requires curl):

$ cd <var>path/to/Unvanquished</var>
$ ./download-pk3.sh main

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will normally download it for you.

Now you can proceed to [[running the game]].

Compiling the source

2012-04-15T06:49:05Z

Danmal: /* Debian/Ubuntu */

==Overview==

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code.

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

Next, perform the following:

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This may be the same directory.
# Click "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.
# '''''TODO: explain which libraries will likely have to be set'''''
# Click "Generate".
# Close CMake and open Xcode.
# Open the project file created by CMake, which should be in the build directory you specified.
# Click the build button.

Unvanquished can also be built from the command line if you're not a fan of Xcode. The build process is the same as under Linux.

==Windows==

The preferred way of building Unvanquished on Windows is to use Microsoft Visual Studio 2010.
The free Express version of the software works fine.

Steps:
# Open src/engine/Daemon.sln in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" in the first one and Win32 or Win64 in the second one
# Press F5 to build solution and run application, or just use Build → Build Solution to compile the code.

==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 \
libhogweed2 libwebp-dev

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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</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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

You can also get the pak files in this way (requires curl):

$ cd <var>path/to/Unvanquished</var>
$ ./download-pk3.sh main

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will normally download it for you.

Now you can proceed to [[running the game]].

Compiling the source

2012-04-15T06:46:06Z

Danmal: /* Dependencies */

==Overview==

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code.

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

Next, perform the following:

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This may be the same directory.
# Click "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.
# '''''TODO: explain which libraries will likely have to be set'''''
# Click "Generate".
# Close CMake and open Xcode.
# Open the project file created by CMake, which should be in the build directory you specified.
# Click the build button.

Unvanquished can also be built from the command line if you're not a fan of Xcode. The build process is the same as under Linux.

==Windows==

The preferred way of building Unvanquished on Windows is to use Microsoft Visual Studio 2010.
The free Express version of the software works fine.

Steps:
# Open src/engine/Daemon.sln in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" in the first one and Win32 or Win64 in the second one
# Press F5 to build solution and run application, or just use Build → Build Solution to compile the code.

==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 libhogweed2 libwebp-dev

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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</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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

You can also get the pak files in this way (requires curl):

$ cd <var>path/to/Unvanquished</var>
$ ./download-pk3.sh main

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will normally download it for you.

Now you can proceed to [[running the game]].

Compiling the source

2012-04-15T06:38:43Z

Danmal: /* Unnecessary libraries */

==Overview==

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code.

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

Next, perform the following:

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This may be the same directory.
# Click "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.
# '''''TODO: explain which libraries will likely have to be set'''''
# Click "Generate".
# Close CMake and open Xcode.
# Open the project file created by CMake, which should be in the build directory you specified.
# Click the build button.

Unvanquished can also be built from the command line if you're not a fan of Xcode. The build process is the same as under Linux.

==Windows==

The preferred way of building Unvanquished on Windows is to use Microsoft Visual Studio 2010.
The free Express version of the software works fine.

Steps:
# Open src/engine/Daemon.sln in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" in the first one and Win32 or Win64 in the second one
# Press F5 to build solution and run application, or just use Build → Build Solution to compile the code.

==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 libhogweed2

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

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

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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</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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

You can also get the pak files in this way (requires curl):

$ cd <var>path/to/Unvanquished</var>
$ ./download-pk3.sh main

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will normally download it for you.

Now you can proceed to [[running the game]].

Compiling the source

2012-04-13T13:57:01Z

Danmal: /* Mac OS X */

==Overview==

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code.

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

Next, perform the following:

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This may be the same directory.
# Click "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.
# '''''TODO: explain which libraries will likely have to be set'''''
# Click "Generate".
# Close CMake and open Xcode.
# Open the project file created by CMake, which should be in the build directory you specified.
# Click the build button.

Unvanquished can also be built from the command line if you're not a fan of Xcode. The build process is the same as under Linux.

==Windows==

The preferred way of building Unvanquished on Windows is to use Microsoft Visual Studio 2010.
The free Express version of the software works fine.

Steps:
# Open src/engine/Daemon.sln in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" in the first one and Win32 or Win64 in the second one
# Press F5 to build solution and run application, or just use Build → Build Solution to compile the code.

==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

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

===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 ..

Alternatively, you may want to build the engine in the same directory.

$ cd <var>/path/to/unvanquished</var>
$ 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 c to configure. If an error occurs during this phase, make note of it and press e to dismiss it.
* Use the up and down arrow keys to navigate the compilation options.
* Press Enter to enable or disable boolean options (i.e., on/off) or to edit textual options.
** Press Esc when editing a textual option to cancel the change.

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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.

===Compiling===

$ cd <var>/path/to/unvanquished</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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

You can also get the pak files in this way (requires curl):

$ cd <var>path/to/Unvanquished</var>
$ ./download-pk3.sh main

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will normally download it for you.

Now you can proceed to [[running the game]].

Compiling the source

2012-04-13T13:54:35Z

Danmal: /* Mac OS X */

==Overview==

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code. 

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

Next, perform the following:

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This may be the same directory.
# Click "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.
# '''''TODO: explain which libraries will likely have to be set'''''
# Click "Generate".
# Close CMake and open Xcode.
# Open the project file created by CMake, which should be in the build directory you specified.
# Click the build button.

Unvanquished can also be built from the command line if you're not a fan of Xcode. The build process is the same as under Linux.

==Windows==

The preferred way of building Unvanquished on Windows is to use Microsoft Visual Studio 2010.
The free Express version of the software works fine.

Steps:
# Open src/engine/Daemon.sln in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" in the first one and Win32 or Win64 in the second one
# Press F5 to build solution and run application, or just use Build → Build Solution to compile the code.

==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

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

===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 ..

Alternatively, you may want to build the engine in the same directory.

$ cd <var>/path/to/unvanquished</var>
$ 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 c to configure. If an error occurs during this phase, make note of it and press e to dismiss it.
* Use the up and down arrow keys to navigate the compilation options.
* Press Enter to enable or disable boolean options (i.e., on/off) or to edit textual options.
** Press Esc when editing a textual option to cancel the change.

Once you have finished the configuration process, press C again, then 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_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <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.

===Compiling===

$ cd <var>/path/to/unvanquished</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===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

You can also get the pak files in this way (requires curl):

$ cd <var>path/to/Unvanquished</var>
$ ./download-pk3.sh main

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will normally download it for you.

Now you can proceed to [[running the game]].