Getting the source

2015-04-08T16:21:49Z

Cajunfiend: /* Gentoo */

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 games-overlay
$ 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==

===Command line===

The following commands will work on any platform.

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

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

If you would like to get the source for a particular version, [http://git-scm.com/docs/git-checkout check out] the associated [http://git-scm.com/book/en/Git-Basics-Tagging tag]:

$ git checkout {{CurrentVersion|Tag}}

To see the list of tags (versions) available to check out,

$ git tag

will produce a list.

===Linux===

Please see the [[#Command_line|command line]] instructions.

===Mac OS X===

====Command Line====

Open a Terminal (<code>/Applications/Utilities/Terminal</code>) and follow the [[#Command_line|command line]] instructions.

====Xcode 4====

# Start Xcode.
# Open the Organizer window (Window → Organizer or {{Hotkey|Shift}}{{Hotkey|MacCommand}}{{Hotkey|2}})
# Hit the "Repositories" button on the top bar.
# Hit 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 hit "Next".
# Enter "Unvanquished" into the "Name" field, ensure that the "Type" combo box is set to "Git", and hit "Clone".
# You will be prompted where to save the repository. Choose a location and hit "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>
# Hit OK.

====Command Line====

Open the MsysGit terminal and and follow the [[#Command_line|command line]] instructions.

==Keeping your copy of the source up-to-date==

For more information on using git, an excellent resource is the official [http://git-scm.com/book git book], available to read online for free.

===TortoiseGit===

# Right-click somewhere in the source directory, and choose "Git Sync". 

===Command-line (All platforms)===

{{Note|content=
If you have checked out a particular commit or tag (e.g., <code>{{CurrentVersion|Tag}}</code>), git will inform you afterwards that you are in what it refers to as a "detached head" state. Before you update your copy of the source, you should check out the master branch first:

$ git checkout master
}}

To pull (i.e., fetch and merge) changes made since you checked out the source—that is, to update your working copy to match the current state of the official repository—you (typically) need only run one command:

$ git pull origin master

==Compiling==

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

Unvanquished - User contributions [en-gb]

Getting the source