Compiling the source

2012-03-27T21:00:46Z

Gfx0: /* Windows */

==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, follow the instructions on [[Getting_the_source##Mac_OS_X_2|this page]] to 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.

==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 \
libgmp-dev libjpeg8-dev libncurses5-dev libogg-dev libopenal-dev \
libpng12-dev libsdl1.2-dev libvorbis-dev zlib1g-dev

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

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

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

Unvanquished - User contributions [en-gb]

Compiling the source