Merge branch 'master' into martin-t/cleanup
[xonotic/xonotic.wiki.git] / Repository_Access.md
1 Repository Access and Compiling
2 ===============================
3
4 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.
5 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.
6 For information on how to obtain write access, skip down to the “[Getting write access](Repository_Access#contributing-and-getting-write-access)” section.
7
8 For more information about the project's structure, see [git](Git).
9
10 ***
11
12 Setting up the development environment
13 --------------------------------------
14
15 The first thing you must do in order to begin with development is to set up your system to be able to download and compile the Xonotic game data. Make sure you have enough memory to compile. 1GB is likely to fail. Consider setup the environment to have at least 2G free memory for the job.
16
17 ### Linux
18
19 Linux already has an adequate base for development, all we really need to do here is to install the **dependencies** for the download/compilation process and then we can move right along to cloning the data.
20
21 **Ubuntu Dependencies** (independent package `x11-proto-devel` dependencies fill the rest of the Debian package dependencies):
22
23     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 libsdl2-dev libsdl2-image-dev libclalsadrv-dev libasound2-dev libxext-dev libjpeg-turbo8-dev git-core unzip wget zlib1g-dev
24
25 Note: If using **i386** architecture, you can replace `libdsl1.2debian` with `libsdl1.2debian:i386` in the list above. On Debian, use `libjpeg8-dev` if `libjpeg-turbo8-dev` isn’t available in the package repositories. To be able to download maps from game servers when using Xonotic for online gaming, you will also need `curl` installed on your system.
26
27 For **Fedora** and other **RPM based** distro’s, compiling dependencies are as follows:
28
29     x11-proto-devel libalsa2-static-devel libjpeg62-devel libjpeg62-static-devel libSDL2-devel
30
31 For **Archlinux** the dependencies can be installed via the following command:
32
33     sudo pacman -S alsa-lib curl libjpeg-turbo libmodplug libpng libvorbis libxpm libxxf86dga libxxf86vm sdl2 unzip
34
35 ### Windows
36
37 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://github.com/msysgit/msysgit/releases) 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 core required dependencies), which at the time of writing this is called `msysGit-netinstall-1.9.5-preview20150319.exe`. Simply follow the instructions on screen at this point. **NOTE: Unless you know what you’re doing, install with default settings/directories.**
38
39 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:`, 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.
40
41 ### Mac OSX
42
43 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: [XCode installer](http://sourceforge.net/projects/git-osx-installer/files/)
44
45 After your development environment is all set up, you can continue on to cloning the git repository and compiling Xonotic.
46
47 ***
48
49 Cloning the repository and compiling
50 ------------------------------------
51
52 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):
53
54     git clone git://git.xonotic.org/xonotic/xonotic.git
55     cd xonotic
56     ./all update -l best
57
58 Take care to do these steps as a **normal user** on Linux (not as superuser(aka root)), otherwise you’ll have to take care about the file permissions later on.
59
60 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 http://git.xonotic.org/xonotic/xonotic.git (however, using the git protocol directly is preferred for performance reasons).
61
62 After that, you have a working checkout of the repository. The game can be compiled and run with the following commands:
63
64     ./all compile -r
65     ./all run
66
67 **Note:** if you encounter en error similar to darkplaces#111, try `./all clean && ./all compile -r -0`.
68
69 You can use just `./all compile` to create a slower build with debug symbols but usually you want `-r`.
70
71 The `./all 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:
72
73     ./all compile -r dedicated
74     ./all run wgl
75     ./all run sdl
76
77 The `run` command can also be followed by standard DarkPlaces commandline arguments:
78
79     ./all run +vid_fullscreen 0
80
81 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:
82
83     cd xonotic
84     ./all checkout
85     ./all update
86     ./all compile -r
87
88 **Note:** The compiled binary will have a faint watermark with the git revision. To remove it completely put `set menu_watermark ""` into your `autoexec.cfg`.
89
90 ***
91
92 If you run into issues with the latest version you can easily revert to an older one. Since most bugs are caused by the game code rather that the engine, you just need to downgrade that repository. Inside the main xonotic repository, use `cd data/xonotic-data` and then `git checkout <some older commit>`. After that go back `cd -` and `./all compile` (with the optional `-r` flag).
93
94 ***
95
96 Contributing and getting write access
97 -------------------------------------
98
99 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:
100 \* data/qcsrc/warpzonelib - dual licensed as “GPLv2 or later” or MIT license.
101 In case the code you pushed was not written by you, it is your responsibility to ensure proper licensing.
102
103 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)
104
105 ### Windows/Linux/OS X
106
107 Get a checkout (see above), and do:
108
109     ./all keygen
110
111 and follow the instructions that are shown. Be sure that you've done:
112
113     ./all update -p
114
115 After that, you can write to the repository using the usual git commands (commit, push).
116
117 Alternatively, you can use the helper script `all`.
118 It supports the following commands:
119
120     ./all update
121
122 This command updates all the Xonotic repositories.
123
124     ./all branch
125
126 Lists the branches you are currently on, in the respective repositories.
127
128     ./all branches
129
130 Lists all the branches known for all the respective repositories.
131
132     ./all compile
133
134 Compiles the game, assuming that you have the required libs installed. Don't forget `-r` if you wanna actually play the game with decent fps.
135
136     ./all checkout BRANCH
137
138 Switch to that branch in all repositories where its available.
139
140     ./all commit
141
142 This command commits and pushes your local changes.
143
144     ./all run xonotic
145
146 Starts the Xonotic client
147
148     ./all run dedicated xonotic
149
150 Starts a Xonotic dedicated server
151
152 General contributor guidelines
153 ------------------------------
154
155 1.  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).
156 2.  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.
157
158 Further git information
159 -----------------------
160
161 About tracking remote branches:
162 http://git-scm.com/book/en/v2/Git-Branching-Remote-Branches
163
164 This wiki’s [Git](Git) page.
165
166 A tutorial to Git for SVN users:
167 http://git-scm.org/course/svn.html