Unvanquished - User contributions [en-gb]

Compiling the source

2013-01-30T04:47:50Z

Kynes: changed pak{0...6}.pk3 to pak{0...9}.pk3 . Still missing pakA

==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.
## 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.
# Hit "Generate".
# You may now close XCode.

===Compiling===

====With XCode====

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

====With Unix Makefiles====

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

===Testing the build===

====With XCode 4====

To test the game, select the "client" scheme from the combo box on the toolbar, and click the run button or press ⌘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====

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.

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

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 easiest way to get a build up (at the time of writing) is as follows: 

{{Note|content=Be aware that some of these paths are for the 64 bit versions of libraries; if you are on a 32-bit system, you will need to change some of these paths. The easiest way to locate libraries is to navigate in Windows Explorer to the <code>src/libs</code> directory and search for files matching <code>dll</code>.}}

<ol>

<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/win64/libpng14-14.dll</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/x64/freetype.dll</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/ftbuild.h</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>SourcePath</var></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/x64/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/win64/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>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.
</li>
</ol>

For a more fully-featured build:
* If you would like to use curses, try using [http://sourceforge.net/projects/pdcurses/files/pdcurses PDCurses].

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

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

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

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

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

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

====Gentoo====

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

====openSUSE====

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

The latest version of WebP must be installed manually:

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

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

===Configuring the code with CMake===

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

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

On Debian or Ubuntu:

$ sudo apt-get install cmake-curses-gui

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

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

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

Next, configure the codebase.

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

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

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

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

* Press 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_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 pak{0..9}.pk3; do
wget -O $file "http://sourceforge.net/projects/unvanquished/files/Assets/$file/download"
done

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

$ cd <var>[path to Unvanquished installation or build]</var>/main
$ for file in pak{0..9}.pk3; do
fetch -r -o $file "http://sourceforge.net/projects/unvanquished/files/Assets/$file/download"
done

On Mac OS X:

$ cd ~/Library/Application Support/Unvanquished/main
$ for file in pak{0..9}.pk3; do
curl -L "http://sourceforge.net/projects/unvanquished/files/Assets/$file/download" > $file
done

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

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

====Downloading the map pack====

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

To download the map pack on Linux:

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

To download the map pack on Mac OS X:

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

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

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

Main Page

2012-04-09T01:28:42Z

Kynes: updated git link

__NOTOC__

<h1 style="text-align:center;margin:0px 0px 40px 0px;border-bottom-style:none;">Welcome to the Unvanquished Wiki!</h1>

Unvanquished is a free and open-source team-based first person shooter based on [http://tremulous.net Tremulous] and created by Unvanquished Development. Unvanquished is a split from the [http://tremz.com/ TremZ project], with fundamentally different goals. We aim to provide a transparent development process that is open to the community, with frequent releases. We use the [[Engine features|Daemon engine]] (a fork of the OpenWolf engine) which provides a number of new features over Tremulous' ioQuake3-based engine.

===What is it about?===

Unvanquished is a first-person shooter, but a very unique one. It is team-based, and pits the [[aliens]] against the [[humans]]. While the humans are equipped with weapons that they use to exterminate the alien presence, the aliens have only their pincers and a few special attacks, such as poison gas, and ranged electrical and projectile attacks. Players do not spawn at random points in the map; instead, each map has default spawn points and both teams are capable of moving them wherever they please. Both teams have other buildings that round out their base, such as machinegun turrets for the humans and barricades for the aliens. Either team wins by destroying the opposing team's spawn points and killing any remaining members of that team before they are able to build any more spawn points or the game timer ends.

==Downloading & Installing==

See the [[Downloading & Installing]] page.

==Playing the game==

* [[Creating custom keybinds]]
* [[Troubleshooting]]

==Contributing==

There are a number of ways you can help. If you would like to contribute to the project, contact a team member on the [http://unvanquished.net/forum/ forums] or on [[IRC]]. We have two channels, [irc://freenode.net/#unvanquished #unvanquished] and [irc://freenode.net/#unvanquished-dev #unvanquished-dev] on [http://freenode.net// Freenode]. The former is for general discussion, while the latter is strictly for development-related discussion, so while members of the public are welcome at either, please keep the discussion on #unvanquished-dev on topic.

If you do not have an IRC client, you can use the [http://webchat.freenode.net/?channels=unvanquished web chat] directly in your browser.

<table style="margin:0px auto;">
<tr>
<th style="padding:0px 10px;background:#C9DCF6;border-radius:7px 0px 0px 0px">
Artists
</th>
<th style="padding:0px 10px;background:#C9DCF6;">
Programmers
</th>
<th style="padding:0px 10px;background:#C9DCF6;border-radius:0px 7px 0px 0px">
Everyone
</th>
</tr>
<tr>
<td style="padding:0px 10px;background:#F0F5FC;vertical-align:top;">
* [[Modeling Guide|Modeling]]
* [[Mapping]]
* [[Music and sounds]]
</td>
<td style="padding:0px 10px;background:#F0F5FC;vertical-align:top;">
* [[Getting the source]]
* [[Compiling the source]]
* [[Technical documentation]]
* [[Engine features]]
</td>
<td style="padding:0px 10px;background:#F0F5FC;vertical-align:top;">
* [[Bug reporting]]
* [[Wiki_TODO_List|Wiki documentation]]
</td>
</tr>
</table>

==Links==

* [http://unvanquished.net/ Homepage]
* [http://unvanquished.net/forum/ Forums]
* [http://unvanquished.net/forum/blog.php Development blog]
* [http://sourceforge.net/projects/unvanquished/files/ Downloads]
* [https://github.com/Unvanquished Source code]
* [https://picasaweb.google.com/104009985595164250961 Development screenshots]

Getting the source

2012-04-09T01:27:32Z

Kynes: updated git link to https://github.com/Unvanquished/Unvanquished

==Overview==

==Installing Git==

If you already have Git installed, you can skip this step.

===Windows===

Windows users can acquire git from the [http://code.google.com/p/msysgit/ MSysGit project]. If you would prefer a graphical front-end, there is [http://code.google.com/p/tortoisegit/ TortoiseGit], but regardless MSysGit must be installed.

===Mac OS X===

Apple has included Git with Xcode since version 4. You may download [https://developer.apple.com/xcode/ Xcode] from Apple's developer website.

===Linux===

====Debian & Ubuntu====

Install git using the package manager:

$ sudo apt-get install git

==Downloading the source==

The [https://github.com/Unvanquished/Unvanquished Unvanquished source code] is hosted on GitHub. You can either download a snapshot of the source code using the "ZIP" link, or you can use git to clone the repository.

===Linux===

Use git on the command line:

$ git clone https://github.com/Umvanquished/Unvanquished.git

This will create a directory called <code>Unvanquished</code> in your home folder.

===Mac OS X===

====Command Line====

Acquiring the source code using the command line is the same as on Linux. Just open a Terminal (/Applications/Utilities/Terminal) window and clone the source code like so:

$ git clone https://github.com/Unvanquished/Unvanquished.git

====Xcode 4====

# Start Xcode.
# Open the Organizer window (Window → Organizer or Shift+Command ⌘+2)
# Click the "Repositories" button on the top bar.
# Click the "+" button in the lower-left corner, and choose "Checkout or Clone Repository…".
# In the rollout sheet that appears, enter <code>https://github.com/Unvanquished/Unvanquished.git</code> into the "Location" field, and click "Next".
# Enter "Unvanquished" into the "Name" field, ensure that the "Type" combo box is set to "Git", and click "Clone".
# You will be prompted where to save the repository. Choose a location and click "Clone".

===Windows===

====TortoiseGIT====

# Make and enter a new folder to store the source code in
# Right click the inside of the folder → Git Clone...
# In the Url textbox enter: <code>https://github.com/Unvanquished/Unvanquished.git</code>
# Click ok.

====Command Line====
Open the MsysGit terminal and type:
$ git clone https://github.com/Unvanquished/Unvanquished.git

==Compiling==

After getting the source code, you can [[Compiling the source|compile]] it.

Creating custom keybinds

2012-04-02T21:21:35Z

Kynes: fixed silly table mistake from previous

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

{| class="wikitable"
! Tremulous || Daemon || Used for…
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button7</code> || <code>+activate</code> || Evolving or using
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
|}

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

==New commands==

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

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

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

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

Creating custom keybinds

2012-04-02T21:20:52Z

Kynes: added '+button6 -> +dodge' to list of binding changes

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

{| class="wikitable"
! Tremulous || Daemon || Used for…
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button7</code> || <code>+activate</code> || Evolving or using
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
|}

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

==New commands==

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

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

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

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