For more information about Git we have a [[Git]] page on the wiki [[Git|here]].
-h2. Cloning the repository and compiling
+h2. Setting up the development environment
+
+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.
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):
+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.
+
+Ubuntu Dependencies (independent package x11-proto-devel dependencies fill the rest of the Debian package dependencies):
+<pre>
+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 git-core unzip wget
+</pre>
+Note: If using i386 architecture, you can replace libdsl1.2debian by ibsdl1.2debian:i386 in the list above.
+
+For Fedora and other RPM based distro's, compiling dependencies are as follows:
+<pre>
+x11-proto-devel, libalsa2-static-devel libjpeg62-devel libjpeg62-static-devel libSDL-devel
+</pre>
+
+
+h3. 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 "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.
+
+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.
+
+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/
+
+After your development environment is all set up, you can continue on to cloning the git repository and compiling Xonotic.
+
+h2. Cloning the repository and compiling
+
+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):
<pre>
git clone git://git.xonotic.org/xonotic/xonotic.git
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.
After that, you have a working checkout of the repository. The game can be compiled and run with the following commands:
-
<pre>
./all compile
./all run
</pre>
-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 update your Git clone, you can repeat the commands above without the first "git clone" line. Don't forget to compile after you update.
-
-Ubuntu Dependencies:
-
+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:
<pre>
-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 git-core unzip wget
+./all compile dedicated
+./all run wgl
+./all run sdl
</pre>
-Note: If using i386 architecture, you can replace libdsl1.2debian by ibsdl1.2debian:i386 in the list above.
-
-For Fedora and other RPM based distro's, compiling dependencies are
+The run command can also be followed by standard DarkPlaces commandline arguments:
<pre>
-x11-proto-devel, libalsa2-static-devel libjpeg62-devel libjpeg62-static-devel libSDL-devel
+./all run +vid_fullscreen 0
</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.
+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:
+<pre>
+cd xonotic
+./all update
+./all compile
+</pre>
h2. Contributing and getting write access
projects / xonotic / xonotic.wiki.git / commitdiff