Repository_Access.md

   1 Compiling and Contributing
   2 ==========================
   3
   4 Xonotic uses [several Git repositories](Git). The `all` script in the main repo manages them, builds Xonotic and runs it. Each repo can also contain feature branches next to the stable `master` branch, check them out for WIP features.
   5
   6 Build Requirements
   7 ------------------
   8
   9 Make sure you have at least 2GB memory to compile.  This is enough to run a git dedicated server, but 6GB is required to play using a git client (it uses more memory than regular release and auto builds).
  10
  11 The git client will perform poorly (compared to regular release or auto builds) on GPUs with limited VRAM, such as integrated GPUs.
  12
  13 [About 12GB of disk space is required for the git repositories.](Git)
  14
  15 ### Linux
  16
  17 Note: `curl` isn't required but it's strongly recommended for downloading maps when playing online, `wget` is not supported for this.
  18
  19 Note: The `all` script requires either `wget` or `curl`.
  20
  21
  22 **Ubuntu** dependencies:
  23
  24     sudo apt-get install autoconf automake build-essential curl git libtool libgmp-dev libjpeg-turbo8-dev libsdl2-dev libxpm-dev xserver-xorg-dev zlib1g-dev unzip zip
  25
  26 Note: On Debian, use `libjpeg62-turbo-dev` if `libjpeg-turbo8-dev` isn’t available in the package repositories.
  27
  28 Note: `libasound2-dev libxext-dev libxxf86vm-dev p7zip-full unzip wget x11proto-xf86vidmode-dev` might be needed but are probably already installed. `libclalsadrv-dev libsdl2-image-dev libxcb-xf86dri0-dev libxxf86dga-dev x11proto-xf86dga-dev x11proto-xf86dri-dev` should no longer be needed.
  29
  30 **Fedora** and other **RPM based** distro dependencies:
  31
  32     autoconf automake gcc-c++ gmp-devel libjpeg-turbo-devel libtool SDL2-devel curl
  33
  34 Note: `x11-proto-devel` or `xorg-x11-proto-devel` might be needed but might be already installed.
  35
  36 **Archlinux** dependencies:
  37
  38     sudo pacman -S alsa-lib curl git libjpeg-turbo libmodplug libpng libvorbis libxpm xorgproto libxxf86vm sdl2 unzip zip
  39
  40 ### Windows
  41
  42 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 [MSYS2](http://www.msys2.org) to allow us to have a similar environment as on Linux. Download 64 bit version of MSYS2 (msys2-x86_64-xxxxxx.exe) and follow installation instructions.
  43
  44 Once you have completed the installation, close the current MSYS2 shell and launch a MSYS2 MINGW64 shell by running mingw64.exe (instead of the default msys2.exe) located at C:\msys64 and install the needed dependencies with this command:
  45
  46     pacman --needed -S git curl zip unzip p7zip make automake autoconf libtool gcc gmp-devel mingw-w64-x86_64-{toolchain,gmp,SDL2,libjpeg-turbo,libpng,libogg}
  47
  48 It is recommended that you make a shortcut to MSYS2 MINGW64 shell (simply right click mingw64.exe and hit “Create Shortcut”) for easier access on your desktop or in your start menu.
  49
  50 You can now use this shell to continue on with the guide and clone the Xonotic repositories.
  51
  52 ### macOS
  53
  54 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/)
  55
  56 Cloning the Repository and Compiling
  57 ------------------------------------
  58
  59 To begin downloading:
  60
  61     git clone https://gitlab.com/xonotic/xonotic.git  # download main repo
  62     cd xonotic
  63     ./all update -l best  # download all other repos (data + game logic, maps, etc.)
  64
  65 Now the game can be compiled and run with the following commands:
  66
  67     ./all compile -r
  68     ./all run
  69
  70 **Note:** if you encounter en error similar to darkplaces#111, try `./all clean && ./all compile -r -0`.
  71
  72 You can use `./all compile -d` to create a slower unoptimized build with debug symbols but usually you want `-r` (which is also the new default).
  73
  74 The `./all run` or `./all compile` line can be followed by `dedicated` to build or run the executable for server hosting. E.g. `./all compile -r dedicated`.
  75
  76 The `run` command can also be followed by standard DarkPlaces commandline arguments:
  77
  78     ./all run +vid_fullscreen 0
  79
  80 To update your Git clone:
  81
  82     cd xonotic
  83     ./all checkout  # switch to main branch on all repos (usually master)
  84     ./all update  # pull and prune
  85     ./all compile -r  # recompile what changed
  86
  87 **Note:** If you intend to play on public servers, you should probably also enable the nexcompat repo to download additional textures that are used on some older unofficial maps. Use `touch data/xonotic-nexcompat.pk3dir.yes` and `./all update`. For mappers: these textures should NOT be used on new maps.
  88
  89 ***
  90
  91 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.pk3dir` and then `git checkout <some older commit>`. After that go back `cd -` and `./all compile` (with the optional `-r` flag).
  92
  93 Contributing and Getting Write Access
  94 -------------------------------------
  95
  96 It's recommended to [request access](https://docs.gitlab.com/ee/user/group/index.html#request-access-to-a-group) to the [Xonotic project group](https://gitlab.com/xonotic).  Cloning our repositories and submitting merge requests from there will work but you won't be able to use our CI setup for the xonotic-data.pk3dir repo (which seems to need a custom runner).
  97
  98 A condition for write (push) access and submission of merge requests is that **you agree that any code or data you push will be licensed under the [GNU General Public License, version 2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html), with and/or without the “or any later version” clause.**
  99
 100 If the directory or repository your changes apply to contains a LICENSE or COPYING file indicating another license or a dual license, then **you agree that your pushed code will be licensed as specified in that file.**  Subdirectories and repositories with a dual license or a different license:
 101 * [xonotic-data.pk3dir/qcsrc/lib/warpzone](https://gitlab.com/xonotic/xonotic-data.pk3dir/-/tree/master/qcsrc/lib/warpzone) - dual licensed with GNU GPLv2 (or any later version), or MIT license.
 102 * [xonstat-go](https://gitlab.com/xonotic/xonstat-go/) - licensed with [GNU AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html)
 103
 104 In case the code you pushed was not written by you, it is your responsibility to ensure proper licensing.
 105
 106 To apply for write access, please add your SSH key to your GitLab account and [request access](https://docs.gitlab.com/ce/user/group/index.html#request-access-to-a-group) to the [Xonotic project group](https://gitlab.com/xonotic) using the GitLab interface.  You can also request access on Matrix chat in [#dev:xonotic.org](https://matrix.to/#/#dev:xonotic.org) (remember to tell us your GitLab username!) but the admins might not see your request amongst the other messages.
 107
 108 Please read [General Contributor Guidelines](https://gitlab.com/xonotic/xonotic/-/wikis/Repository_Access#general-contributor-guidelines) before pushing.
 109
 110 ### Windows/Linux/macOS
 111
 112 Get a checkout (see above), and do:
 113
 114     ./all keygen
 115
 116 and follow the instructions that are shown. Be sure that you've done:
 117
 118     ./all update -p
 119
 120 After that, you can write to the repositories using the usual git commands (commit, push, ...).
 121
 122 Alternatively, you can use the helper script `all`.
 123 It supports the following commands:
 124
 125     ./all update
 126
 127 This command updates all the Xonotic repositories.
 128
 129     ./all branch
 130
 131 Lists the branches you are currently on, in the respective repositories.
 132
 133     ./all branches
 134
 135 Lists all the branches known for all the respective repositories.
 136
 137     ./all compile
 138
 139 Compiles the game, assuming that you have the required libs installed.
 140
 141     ./all checkout BRANCH
 142
 143 Switch to that branch in all repositories where its available.
 144
 145     ./all commit
 146
 147 This command commits and pushes your local changes.
 148
 149     ./all run
 150
 151 Starts the Xonotic client
 152
 153     ./all run dedicated
 154
 155 Starts a Xonotic dedicated server
 156
 157 General Contributor Guidelines
 158 ------------------------------
 159
 160 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).
 161 2.  **You should name 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.
 162
 163 Git guides
 164 -----------------------
 165
 166 Git basics on [this wiki page](Git).
 167
 168 About tracking remote branches:
 169 http://git-scm.com/book/en/v2/Git-Branching-Remote-Branches
 170
 171 A tutorial to Git for SVN users:
 172 https://git.wiki.kernel.org/index.php/GitSvnCrashCourse