h1. Repository Access
-The repository is accessed using git.
+{{>toc}}
-h2. Linux/OS X:
+Xonotic uses several Git repositories. There's a helper script in the main repository to aid in checking out all relevant repositories and help you with building and running Xonotic.
+The repository also contains several branches next to the stable "master" branch. So if you're interested in the progress of a certain feature, or want to help or create a new one, you can checkout the appropriate branch.
+For information on how to obtain write access, skip down to the "[[Repository Access#Contributing-and-getting-write-access|Getting write access]]" section.
-First, you install git using your favorite package manager. Then:
+For more information about Git we have a [[Git]] page on the wiki [[Git|here]].
+
+h2. Cloning the repository and compiling
+
+h3. Linux
+
+First, you install Git using your favorite package manager. Then, do the following to download and compile (execute the first line only to download):
<pre>
git clone git://git.xonotic.org/xonotic/xonotic.git
cd xonotic
-./all update
+./all update -l best
</pre>
-After that, you have a working checkout of the repository.
+The git:// protocol uses port 9418, which may be a problem if you're behind a strict firewall. You may instead use the clone url <pre>http://git.xonotic.org/xonotic/xonotic.git</pre>however using the git protocol directly is preferred for performance reasons.
-h3. Getting write access
+After that, you have a working checkout of the repository. The game can be compiled and run with the following commands:
-A condition for write (push) access is that you agree that any code or data you push will be licensed under the General Public License, version 2, with or without the "or any later version" clause. In case the directory the changes apply to contains a LICENSE or COPYING file indicating another license, your pushed code has to be dual licensed appropriately. Subdirectories currently having a dual license:
-* data/qcsrc/warpzonelib - dual licensed as "GPLv2 or later" or MIT license.
+<pre>
+./all compile
+./all run
+</pre>
-In case code you pushed was not written by you, it is your responsibility to ensure proper licensing.
+The run line can be followed by one of glx,sdl,agl,dedicated to choose which executable to run. It can also be followed by standard DarkPlaces commandline arguments.
-To apply for write access, make an issue of type "Support" in the category "Repository" and attach your public SSH key to it.
+To update your Git clone, you can repeat the commands above without the first "git clone" line. Don't forget to compile after you update.
-To cleanly check out then, you would do:
+Ubuntu Dependencies:
<pre>
-git clone ssh://xonotic@git.xonotic.org/xonotic.git
-cd xonotic
-./all update
+sudo apt-get install build-essential xserver-xorg-dev x11proto-xf86dri-dev x11proto-xf86dga-dev x11proto-xf86vidmode-dev libxxf86dga-dev libxcb-xf86dri0-dev libxpm-dev libxxf86vm-dev libsdl1.2-dev libsdl-image1.2-dev libclalsadrv-dev libasound2-dev libxext-dev libsdl1.2debian-pulseaudio git-core unzip wget
</pre>
-If you already have a checkout, you would do:
+For Fedora and other RPM based distro's, compiling dependencies are
<pre>
-git config remote.origin.url ssh://xonotic@git.xonotic.org/xonotic.git
-./all update
+x11-proto-devel, libalsa2-static-devel libjpeg62-devel libjpeg62-static-devel libSDL-devel
+</pre>
+
+The independant package x11-proto-devel dependencies fill the rest of the debian package dependencies listed above.
+
+h3. Windows
+
+See [[Compiling in Windows]]
+
+h3. Mac OSX
+
+You must first install XCode which comes on your installation DVD or can be downloaded from the Apple website. This package provides tools like Git and GCC, which are needed for successful checkout and compilation of Xonotic. Some versions of XCode come with Git and others don't - if you don't have Git after installing XCode get it here: http://code.google.com/p/git-osx-installer/
+
+When you have done this, you can follow the Linux instructions above.
+
+h2. Contributing and getting write access
+
+A condition for write (push) access is that you agree that any code or data you push will be licensed under the General Public License, version 2, with or without the "or any later version" clause. In case the directory the changes apply to contains a LICENSE or COPYING file indicating another license, then your pushed code has to be dual licensed appropriately. Subdirectories currently having a dual license:
+* data/qcsrc/warpzonelib - dual licensed as "GPLv2 or later" or MIT license.
+In case the code you pushed was not written by you, it is your responsibility to ensure proper licensing.
+
+To apply for write access, make an issue of type "Support" in the category "Repository" and attach your public SSH key to it. (Windows users: see the Windows section below for more on SSH keys)
+
+h3. Linux/OS X
+
+Get a checkout (see above), and do:
+
+<pre>
+./all keygen
</pre>
-After that, you can write to the reposiotry using the usual git commands (commit, push).
+and follow the instructions that are shown.
-h3. Working with the helper script "all"
+After that, you can write to the repository using the usual git commands (commit, push).
-To make working with the repo a little easier there's a little helper script (it's called all, as mentioned in above clone commands). It supports the following commands:
+Alternatively, you can use the helper script "all".
+It supports the following commands:
<pre>
./all update
+</pre>
+
+This command updates all the Xonotic repositories.
+
+<pre>
./all branch
-./all push
-./all checkout
</pre>
-The normal workflow for working on a contribution is the following:
+Lists the branches you are currently on, in the respective repositories.
+
+<pre>
+./all branches
+</pre>
-n4. 1. Get up to date
+Lists all the branches known for all the respective repositories.
-<pre>./all update</pre>
+<pre>
+./all compile
+</pre>
+
+Compiles the game, assuming that you have the required libs installed.
+
+<pre>
+./all checkout BRANCH
+</pre>
+
+Switch to that branch in all repositories where its available.
+
+<pre>
+./all commit
+</pre>
+
+This command commits and pushes your local changes.
+
+<pre>
+./all run xonotic
+</pre>
+
+Starts the Xonotic client
+
+<pre>
+./all run dedicated xonotic
+</pre>
-This makes sure you are up to date. And should lessen the merging horror that might ensue when you try to push..
+Starts a Xonotic dedicated server
-h4. 2. Create a branch
-<pre>./all branch <your branch name here></pre>
+h3. Windows
-Then work on your changes, commit locally, etc, until you are happy..
+To write your own changes to the Xonotic Git, do the following:
+* You must first have a putty SSH key, containing your private key. To generate one use "puttygen" : http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html which creates a ppk file. Choose SSH-2 RSA format and once the key has been generated save it as a private key.
+* Make sure the public key is accepted on the Git server. To find it, open the generated key in a text editor and read the "public-lines".
+* Open the Settings menu of Tortoise Git (right click anywhere in the folder you are setting this for) and go to Git -> Remote. Select "origin" for remote, "ssh://xonotic@git.xonotic.org/xonotic-data.pk3dir.git" for URL (data.pk3dir is the example for the "data" branch, each pk3dir is separate!) and for Putty Key browse and select the key file previously mentioned.
+* In order to make a new branch, right click somewhere and choose Create Branch from the Tortoise Git context menu. This will create a local branch you can do anything with. Once you locally committed your changes to your branch, select Push to upload or update the branch on the Git server. From the Push window, choose your local branch for Local, leave Remote empty, and select origin for Destination.
-h4. 3. Push changes to the main repo
-<pre>./all push</pre>
+h2. General contributor guidelines
-This asks you what to push, etc.. This might fail, if in the meantime someone else has worked on the same branch. You will need to use git merge manually for the time being to resolve possible conflicts..
+# Before creating your local branch and committing to it, make sure you've configured your user settings such as your name which will display in the logs (in TortoiseGit: Settings -> Git - > Config).
+# Try naming your branch myname/mychange for each patch. For instance, if your name is Alex and the change you are committing is a menu fix, use something like alex/menufix.
-h4. 4. Go back to 1.
+h2. Further git information
+About tracking remote branches:
+http://www.gitready.com/beginner/2009/03/09/remote-tracking-branches.html
-h2. Windows
+This wiki's [[Git]] page.
-TODO info for TortoiseGit
+A tutorial for SVN users:
+http://git-scm.org/course/svn.html
projects / xonotic / xonotic.wiki.git / blobdiff