-Repository Access and Compiling
-===============================
+Compiling and Contributing
+==========================
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.
-***
+Build Requirements
+------------------
+
+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).
-Setting up the development environment
---------------------------------------
+The git client will perform poorly (compared to regular release or auto builds) on GPUs with limited VRAM, such as integrated GPUs.
-Make sure you have at least 2 GB memory to compile.
+[About 12GB of disk space is required for the git repositories.](Git)
### Linux
-**Ubuntu Dependencies**:
+Note: `curl` isn't required but it's strongly recommended for downloading maps when playing online, `wget` is not supported for this.
+
+Note: The `all` script requires either `wget` or `curl`.
- sudo apt-get install autoconf build-essential curl git-core libtool libgmp-dev libjpeg-turbo8-dev libsdl2-dev libxpm-dev xserver-xorg-dev zlib1g-dev
-Note: On Debian, use `libjpeg8-dev` if `libjpeg-turbo8-dev` isn’t available in the package repositories.
+**Ubuntu** dependencies:
-Note: `curl` isn't required but it's strongly recommended for downloading maps when playing online.
+ 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
+
+Note: On Debian, use `libjpeg62-turbo-dev` if `libjpeg-turbo8-dev` isn’t available in the package repositories.
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.
**Fedora** and other **RPM based** distro dependencies:
- autoconf automake gcc-c++ gmp-devel libjpeg-turbo-devel libtool SDL2-devel
+ autoconf automake gcc-c++ gmp-devel libjpeg-turbo-devel libtool SDL2-devel curl libXext-devel alsa-lib-devel libXxf86vm-devel
Note: `x11-proto-devel` or `xorg-x11-proto-devel` might be needed but might be already installed.
**Archlinux** dependencies:
- sudo pacman -S alsa-lib curl libjpeg-turbo libmodplug libpng libvorbis libxpm libxxf86dga libxxf86vm sdl2 unzip wget
+ sudo pacman -S alsa-lib curl git libjpeg-turbo libmodplug libpng libvorbis libxpm xorgproto libxxf86vm sdl2 unzip zip
### Windows
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.
-Once you have completed the installation, launch the MSYS2 shell by running `mingw64.exe` (instead of the default msys2.exe) by default located at `C:\msys64` and install the needed **dependencies** with this command:
+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:
- 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}
+ 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,libvorbis}
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.
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/)
-***
-
-Cloning the repository and compiling
+Cloning the Repository and Compiling
------------------------------------
To begin downloading:
- git clone git://git.xonotic.org/xonotic/xonotic.git # download main repo
+ git clone https://gitlab.com/xonotic/xonotic.git # download main repo
cd xonotic
./all update -l best # download all other repos (data + game logic, maps, etc.)
-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).
-
-For Windows users: once finished cloning move to the main repository (`cd xonotic`) and checkout the branch Mario/Win64 with the command:
-
- git checkout -b Mario/win64 origin/Mario/win64
-
Now the game can be compiled and run with the following commands:
- ./all compile -r
+ ./all compile
./all run
-**Note:** if you encounter en error similar to darkplaces#111, try `./all clean && ./all compile -r -0`.
+**Note:** if you encounter en error similar to darkplaces#111, try `./all clean && ./all compile -0`.
-You can use just `./all compile` to create a slower unoptimized build with debug symbols but usually you want `-r`.
+You can use `./all compile -d` to create a slower unoptimized build with debug symbols.
-The `./all run` or `./all compile` line can be followed by one of `glx` (Linux native), `sdl` (input/sound managed by SDL), `agl` (macOS native), `wgl` (Windows native), or `dedicated` (for server hosting) to choose which executable to run or compile. E.g. `./all compile -r dedicated`.
+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 dedicated`.
The `run` command can also be followed by standard DarkPlaces commandline arguments:
cd xonotic
./all checkout # switch to main branch on all repos (usually master)
./all update # pull and prune
- ./all compile -r # recompile what changed
-
-**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`.
+ ./all compile # recompile what changed
**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.
***
-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).
-
-***
+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`.
-Contributing and getting write access
+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.
+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).
+
+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.**
+
+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:
+* [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.
+* [xonstat-go](https://gitlab.com/xonotic/xonstat-go/) - licensed with [GNU AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html)
+
In case the code you pushed was not written by you, it is your responsibility to ensure proper licensing.
-To apply for write access, add your SSH key to your GitLab account and ask for access in #xonotic on the FreeNode IRC network or [request access](https://docs.gitlab.com/ce/user/group/index.html#request-access-to-a-group) using the GitLab interface.
+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.
+
+Please read [General Contributor Guidelines](https://gitlab.com/xonotic/xonotic/-/wikis/Repository_Access#general-contributor-guidelines) before pushing.
### Windows/Linux/macOS
./all compile
-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.
+Compiles the game, assuming that you have the required libs installed.
./all checkout BRANCH
This command commits and pushes your local changes.
- ./all run xonotic
+ ./all run
Starts the Xonotic client
- ./all run dedicated xonotic
+ ./all run dedicated
Starts a Xonotic dedicated server
-General contributor guidelines
+General Contributor Guidelines
------------------------------
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).
-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.
+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.
-Further git information
+Git guides
-----------------------
+Git basics on [this wiki page](Git).
+
About tracking remote branches:
http://git-scm.com/book/en/v2/Git-Branching-Remote-Branches
-This wiki’s [Git](Git) page.
-
A tutorial to Git for SVN users:
-http://git-scm.org/course/svn.html
+https://git.wiki.kernel.org/index.php/GitSvnCrashCourse
\ No newline at end of file
projects / xonotic / xonotic.wiki.git / blobdiff