Unvanquished - User contributions [en-gb]

User:Qrntz

2012-08-06T14:26:24Z

Qrntz: Created page with "File:Vigilant.png"

[[File:Vigilant.png]]

File:Vigilant.png

2012-08-06T14:25:19Z

Qrntz: A token of vigilance.

A token of vigilance.

Getting the source

2012-07-01T13:55:10Z

Qrntz: added the section on Gentoo, preferably should be transfered to a separate page for distro-specific packages later

==Overview==

The [https://github.com/Unvanquished/Unvanquished Unvanquished source code] is hosted on GitHub. You can either download a snapshot of the source code in [https://github.com/Unvanquished/Unvanquished/zipball/master ZIP archive form], or you can use Git to clone the repository.

==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 MSysGit must be installed regardless.

===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. Please note that while XCode 4 was available for a very brief time for 32-bit and Snow Leopard users for a small price ($5 from the Mac App Store), this is no longer the case; it is now free, but available only to 64-bit Lion users. Snow Leopard (10.6) users and prior may now only use XCode 3, which does not include Git. If you are one of these users, you may [http://git-scm.com/download/mac acquire a copy of Git] from its site. A [http://git-scm.com/download/gui/mac selection of GUIs for Git] is also available.

===Linux===

====Debian & Ubuntu====

Install Git using the package manager:

$ sudo apt-get install git

====Gentoo====

The ebuilds for Unvanquished (games-fps/unvanquished) and the assets (games-fps/unvanquished-data) are available from the [https://github.com/hasufell/hasufell-overlay ''hasufell''] overlay.
If you don't have layman installed, you can install it with

$ emerge layman

Then, adding the overlay and installing should be trivial.

$ layman -a hasufell
$ emerge unvanquished

See [https://bugs.gentoo.org/show_bug.cgi?id=419421 the entry on bugs.gentoo.org] for additional comments about the ebuilds.

==Downloading the source==

===Linux===

Use the following command line:

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

This will create a directory called ''Unvanquished''.

===Mac OS X===

====Command Line====

Acquiring the source code using the command line is the same as on Linux. 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.

Compiling the source

2012-04-15T06:59:52Z

Qrntz: /* Compiling */

==Overview==

==Mac OS X==

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

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

Next, perform the following:

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This may be the same directory.
# Click "Configure". You will be prompted as to which generator you would like to use. If you have Xcode installed, choose that.
# Wait while the configuration process runs.
# '''''TODO: explain which libraries will likely have to be set'''''
# Click "Generate".
# Close CMake and open Xcode.
# Open the project file created by CMake, which should be in the build directory you specified.
# Click the build button.

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

==Windows==

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

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

==Linux==

===Dependencies===


====Debian/Ubuntu====

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

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

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

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

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

====Gentoo====

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

===Configuring the code with CMake===

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

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

On Debian or Ubuntu:

$ sudo apt-get install cmake-curses-gui

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

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

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

Next, configure the codebase.

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

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

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

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

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

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

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

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

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

$ sudo apt-get install cmake-qt-gui

=====Gentoo=====

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

$ emerge cmake

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

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

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

====Unnecessary libraries====

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

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

===Compiling===

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

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

===Acquiring the Game Files===

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

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

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

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

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

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

Compiling the source

2012-03-18T06:09:37Z

Qrntz: /* Linux */ Merging all Linux instructions into a generic one with distro-specific variants when needed

==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.
The free Express version of the software works fine.

Steps:
# Open src/engine/Daemon.sln in Visual Studio
# In the two text boxes in the toolbar, select "Release" in the first one and Win32 or Win64 in the second one
# 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]].

Getting the source

2012-03-18T05:06:20Z

Qrntz: a spelling error has been corrected

==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 Xcode from [https://developer.apple.com/xcode/ Apple's developer website].

===Linux===

====Debian & Ubuntu====

Install git using the package manager:

$ sudo apt-get install git

==Downloading the source==

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

===Linux===

Use git on the command line:

$ git clone https://github.com/TremZ/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/TremZ/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/TremZ/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/TremZ/Unvanquished.git</code>
# Click ok.

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

==Compiling==

Please see [[Compiling the source|this page]] for more information.