Getting the source

Note

The recommended way to fetch the sources is to use Git to clone the repository.

The Unvanquished source code is hosted on GitHub.

Downloading a snapshot of the source code in archive form isn't tested.

Installing Git

Git is a distributed source version control system.

Git is free software and is used for everything in the contribution process: code, image, models, sound files, everything is tracked in git repositories. We also do heavy usage of git submodules. Some of our tools expect git to be present and data to actually be stored in repositories to work properly.

See Installing Git.

Downloading the source

Note

In case this happens to become outdated, the up-to-date documentation can be found in the README.md file in source repository.

Command line

The following commands will work on any platform.

git clone --recurse-submodules https://github.com/Unvanquished/Unvanquished.git

This will create a directory called Unvanquished.

If you already cloned but forgot to use the --recurse-submodules option:

cd Unvanquished
git submodule update --init --recursive

If you would like to get the source for a particular version, check out the associated tag, then checkout the submodules:

cd Unvanquished
git checkout v0.55.1
git submodule update --init --recursive

To see the list of tags (versions) available to check out, git tag will produce a list.

Linux

Please see the command line instructions.

macOS

Command Line

Open a Terminal (/Applications/Utilities/Terminal) and follow the command line instructions.

Xcode 4

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

Windows

TortoiseGIT

1. Make and enter a new folder to store the source code in
2. Right click the inside of the folder → Git Clone...
3. In the Url textbox enter: https://github.com/Unvanquished/Unvanquished.git
4. Hit OK.

Command Line

Open the MsysGit terminal and and follow the command line instructions.

Keeping your copy of the source up-to-date

For more information on using git, an excellent resource is the official git book, available to read online for free.

TortoiseGit

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

🚧️ TODO: Finish instructions.

Command-line (All platforms)

Note

If you have checked out a particular commit or tag (e.g., v0.55.1), 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 compile it.