Repository_Access.textile

   1 h1. Repository Access
   2
   3 {{>toc}}
   4
   5 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.
   6 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.
   7 For information on how to obtain write access, skip down to the "[[Repository Access#Contributing-and-getting-write-access|Getting write access]]" section.
   8
   9 For more information about Git we have a [[Git]] page on the wiki [[Git|here]].
  10
  11 h2. Setting up the development environment
  12
  13 The first thing you must do in order to begin development is set up your system to be able to download and compile the Xonotic game data.
  14
  15 h3. Linux
  16
  17 Linux already has an adequate base for development, all we really need to do here is install the dependencies for the download/compilation process and then we can move right along to cloning the data.
  18
  19 Ubuntu Dependencies (independent package x11-proto-devel dependencies fill the rest of the Debian package dependencies):
  20 <pre>
  21 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 libjpeg-turbo8-dev git-core unzip wget
  22 </pre>
  23 Note: If using i386 architecture, you can replace libdsl1.2debian by ibsdl1.2debian:i386 in the list above.
  24
  25 For Fedora and other RPM based distro's, compiling dependencies are as follows:
  26 <pre>
  27 x11-proto-devel, libalsa2-static-devel libjpeg62-devel libjpeg62-static-devel libSDL-devel
  28 </pre>
  29
  30
  31 h3. Windows
  32
  33 By default, Windows has no real environment to handle the necessary scripting and compiling tools for building Xonotic... So, what we have to do is install something called "msysgit":https://code.google.com/p/msysgit/downloads/list to allow us to have a similar environment as on Linux. In this case, we want the download which is entirely self contained (including build-essentials and other corely required dependencies), which at the time of writing this is called "msysGit-fullinstall-1.8.0-preview20121022.exe." Simply follow the instructions on screen at this point. NOTE: Unless you know what you're doing, install with default settings/directories.
  34
  35 Once you have completed the installation, you should be able to launch the msysgit shell by simply finding "msys.bat"- by default, it is located at: C:\msysgit\msysgit\msys.bat, and you can use this shell to continue on with the guide and clone and compile the Xonotic repositories. It is recommended that you make a shortcut to msysgit (simply right click the shell and hit "Create Shortcut") for easier access on your desktop or in your start menu.
  36
  37 h3. Mac OSX
  38
  39 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/
  40
  41 After your development environment is all set up, you can continue on to cloning the git repository and compiling Xonotic.
  42
  43 h2. Cloning the repository and compiling
  44
  45 Making sure that your environment is set up properly, you can do the following to begin downloading and compilation (execute the first line only to download):
  46
  47 <pre>
  48 git clone git://git.xonotic.org/xonotic/xonotic.git
  49 cd xonotic
  50 ./all update -l best
  51 </pre>
  52
  53 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.
  54
  55 After that, you have a working checkout of the repository. The game can be compiled and run with the following commands:
  56 <pre>
  57 ./all compile
  58 ./all run
  59 </pre>
  60
  61 The run line can be followed by one of "glx" (Linux native), "sdl" (input/sound managed by SDL), agl (OSX native), wgl (Windows native), or dedicated (for server hosting) to choose which executable to run or compile... Seen as follows:
  62 <pre>
  63 ./all compile dedicated
  64 ./all run wgl
  65 ./all run sdl
  66 </pre>
  67
  68 The run command can also be followed by standard DarkPlaces commandline arguments:
  69 <pre>
  70 ./all run +vid_fullscreen 0
  71 </pre>
  72
  73 To update your Git clone, you can repeat the commands above without the first "git clone" line- And don't forget to compile after you update- Like this:
  74 <pre>
  75 cd xonotic
  76 ./all update
  77 ./all compile
  78 </pre>
  79
  80 h2. Contributing and getting write access
  81
  82 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:
  83 * data/qcsrc/warpzonelib - dual licensed as "GPLv2 or later" or MIT license.
  84 In case the code you pushed was not written by you, it is your responsibility to ensure proper licensing.
  85
  86 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)
  87
  88 h3. Linux/OS X
  89
  90 Get a checkout (see above), and do:
  91
  92 <pre>
  93 ./all keygen
  94 </pre>
  95
  96 and follow the instructions that are shown.
  97
  98 After that, you can write to the repository using the usual git commands (commit, push).
  99
 100 Alternatively, you can use the helper script "all".
 101 It supports the following commands:
 102
 103 <pre>
 104 ./all update
 105 </pre>
 106
 107 This command updates all the Xonotic repositories.
 108
 109 <pre>
 110 ./all branch
 111 </pre>
 112
 113 Lists the branches you are currently on, in the respective repositories.
 114
 115 <pre>
 116 ./all branches
 117 </pre>
 118
 119 Lists all the branches known for all the respective repositories.
 120
 121 <pre>
 122 ./all compile
 123 </pre>
 124
 125 Compiles the game, assuming that you have the required libs installed.
 126
 127 <pre>
 128 ./all checkout BRANCH
 129 </pre>
 130
 131 Switch to that branch in all repositories where its available.
 132
 133 <pre>
 134 ./all commit
 135 </pre>
 136
 137 This command commits and pushes your local changes.
 138
 139 <pre>
 140 ./all run xonotic
 141 </pre>
 142
 143 Starts the Xonotic client
 144
 145 <pre>
 146 ./all run dedicated xonotic
 147 </pre>
 148
 149 Starts a Xonotic dedicated server
 150
 151
 152 h3. Windows
 153
 154 To write your own changes to the Xonotic Git, do the following:
 155 * 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.
 156 * 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".
 157 * 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@push.git.xonotic.org/xonotic-data.pk3dir.git" as pushing 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.
 158 * 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.
 159
 160
 161 h2. General contributor guidelines
 162
 163 # 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).
 164 # 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.
 165
 166 h2. Further git information
 167
 168 About tracking remote branches:
 169 http://www.gitready.com/beginner/2009/03/09/remote-tracking-branches.html
 170
 171 This wiki's [[Git]] page.
 172
 173 A tutorial for SVN users:
 174 http://git-scm.org/course/svn.html