Unvanquished - User contributions [en-gb]

Talk:Compiling the source

2012-05-14T10:49:18Z

Xovan:

From xovan May 13th 2012 5:50PM PST

I would like to point out that I am not the greatest wiki editor so please feel free to mercilessly edit my formatting. I tried to put in a few notes on things I ran into. Another thing to maybe include in there is that it is good practice to run,

$make clean

after every change to the build configuration otherwise wierd stuff happens.

From xovan May14th 2012 8:40AM PST

I fixed some errors in the library location I made yesterday and a typo.

Compiling the source

2012-05-14T10:47:35Z

Xovan: /* Can't find newton library */

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

===Can't find newton library===
If it doesn't autodetect you'll need to set it yourself.

It should be in

$~/''Unvanquished_Dir''/src/libs/libnewton/libs/''your_os''/libNewton.so

Be sure to replace ''Unvanquished_Dir'' and ''your_os'' with their proper locations.

Now to tell cmake where it's location is open up ccmake in the Unvanquished base directory

$ccmake ..

scroll down and highlight NEWTON LIBRARY

hit Enter to begin editing and type in the path. Once complete you'll need to hit C to configure and G to generate the new Makefiles when done hit Q to quit.

Afterwards use the make command again and you should be good.

$make

===Can't find menu.txt===

This is actually an error from the underlying engine which tells you that the game files are not properly installed or they are corrupt. If this is the case make sure the pk3s are in the ''~/.Unvanquished/main'' folder and if not run the commands shown above again and pay careful attention to spelling and capitalization. Where as if they are there then remove them and re-run the commands.

Compiling the source

2012-05-14T10:47:13Z

Xovan: /* Can't find newton library */

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

===Can't find newton library===
If it doesn't autodetect you'll need to set it yourself.

It should be in

$~/''Unvanquished_Dir''/src/libs/libnewton/libs/''your_os''/libNewson.so

Be sure to replace ''Unvanquished_Dir'' and ''your_os'' with their proper locations.

Now to tell cmake where it's location is open up ccmake in the Unvanquished base directory

$ccmake ..

scroll down and highlight NEWTON LIBRARY

hit Enter to begin editing and type in the path. Once complete you'll need to hit C to configure and G to generate the new Makefiles when done hit Q to quit.

Afterwards use the make command again and you should be good.

$make

===Can't find menu.txt===

This is actually an error from the underlying engine which tells you that the game files are not properly installed or they are corrupt. If this is the case make sure the pk3s are in the ''~/.Unvanquished/main'' folder and if not run the commands shown above again and pay careful attention to spelling and capitalization. Where as if they are there then remove them and re-run the commands.

Talk:Compiling the source

2012-05-13T20:04:23Z

Xovan: Created page with "From xovan May 13th 2012 5:50PM PST I would like to point out that I am not the greatest wiki editor so please feel free to mercilessly edit my formatting. I tried to put in..."

Compiling the source

2012-05-13T19:56:35Z

Xovan: /* Can't find menu.txt */

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

===Can't find newton library===
If it doesn't autodetect you'll need to set it yourself.

It should be in

$~/''Unvanquished_Dir''/src/libs/libnewton/''your_os''

Be sure to replace ''Unvanquished_Dir'' and ''your_os'' with their proper locations.

Now to tell cmake where it's location is open up ccmake in the Unvanquished base directory

$ccmake ..

scroll down and highlight NEWTON LIBRARY

hit Enter to begin editing and type in the path. Once complete you'll need to hit C to configure and G to generate the new Makefiles when done hit Q to quit.

Afterwards use the make command again and you should be good.

$make

===Can't find menu.txt===

This is actually an error from the underlying engine which tells you that the game files are not properly installed or they are corrupt. If this is the case make sure the pk3s are in the ''~/.Unvanquished/main'' folder and if not run the commands shown above again and pay careful attention to spelling and capitalization. Where as if they are there then remove them and re-run the commands.

Compiling the source

2012-05-13T19:55:07Z

Xovan: /* Can't find menu.txt */

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

=Can't find menu.txt=

This is actually an error from the underlying engine which tells you that the game files are not properly installed or they are corrupt. If this is the case make sure the pk3s are in the ''~/.Unvanquished/main'' folder and if not run the commands shown above again and pay careful attention to spelling and capitalization. Where as if they are there then remove them and re-run the commands.

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

===Can't find newton library===
If it doesn't autodetect you'll need to set it yourself.

It should be in

$~/''Unvanquished_Dir''/src/libs/libnewton/''your_os''

Be sure to replace ''Unvanquished_Dir'' and ''your_os'' with their proper locations.

Now to tell cmake where it's location is open up ccmake in the Unvanquished base directory

$ccmake ..

scroll down and highlight NEWTON LIBRARY

hit Enter to begin editing and type in the path. Once complete you'll need to hit C to configure and G to generate the new Makefiles when done hit Q to quit.

Afterwards use the make command again and you should be good.

$make

Compiling the source

2012-05-13T19:45:04Z

Xovan: /* 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/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]].

==Can't find menu.txt==

This is actually an error from the underlying engine which tells you that the game files are not properly installed or they are corrupt. If this is the case make sure the pk3s are in the ''~/.Unvanquished/main'' folder and if not run the commands shown above again and pay careful attention to spelling and capitalization. Where as if they are there then remove them and re-run the commands.

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

===Can't find newton library===
If it doesn't autodetect you'll need to set it yourself.

It should be in

$~/''Unvanquished_Dir''/src/libs/libnewton/''your_os''

Be sure to replace ''Unvanquished_Dir'' and ''your_os'' with their proper locations.

Now to tell cmake where it's location is open up ccmake in the Unvanquished base directory

$ccmake ..

scroll down and highlight NEWTON LIBRARY

hit Enter to begin editing and type in the path. Once complete you'll need to hit C to configure and G to generate the new Makefiles when done hit Q to quit.

Afterwards use the make command again and you should be good.

$make

Compiling the source

2012-05-13T19:36:43Z

Xovan: /* 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/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==
===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.

===Can't find newton library===
If it doesn't autodetect you'll need to set it yourself.

It should be in

$~/''Unvanquished_Dir''/src/libs/libnewton/''your_os''

Be sure to replace ''Unvanquished_Dir'' and ''your_os'' with their proper locations.

Now to tell cmake where it's location is open up ccmake in the Unvanquished base directory

$ccmake ..

scroll down and highlight NEWTON LIBRARY

hit Enter to begin editing and type in the path. Once complete you'll need to hit C to configure and G to generate the new Makefiles when done hit Q to quit.

Afterwards use the make command again and you should be good.

$make