rename before merge
[xonotic/xonotic.wiki.git] / Compiling_In_Windows.md
1 Compiling In Windows
2 ====================
3
4 {{\>toc}}
5
6 **This guide has been replaced by a shorter alternative.** This guide should still work, and get you a standalone MinGW/MSYS environment with access to msysgit. The new method only makes use of msysgit and is therefore easier and faster to set up. See the [Repository Access\#Windows](Repository Access\#Windows) page.
7
8 This is an unofficial updated version of the outdated [Compiling in Windows](Outdated_Compiling_In_Windows) page. There are no more automated tools in this version of the guide.
9
10 You will need about 10 gigabytes of disk space to keep the sources (the uncompressed texture files are quite large and git keeps a backup copy, doubling the actual size of the sources).
11
12 Step 1: installing the prerequisites
13 ------------------------------------
14
15 To compile and run Xonotic in Windows, you will need to download the following. Do not install anything yet, this is covered in the next section.
16 \* The latest version of [MinGW](http://sourceforge.net/projects/mingw/files/). At the time of writing this guide, mingw provides an installer (mingw-get-inst). More up-to-date information on how to get MinGW can be found on http://mingw.org
17 \* [msysgit](https://code.google.com/p/msysgit/downloads/list). Make sure you get the latest **full installer for official Git** (not the self-contained packages). At the time of writing this, the latest installer is called Git-1.7.11-preview20120710.exe.
18
19 ### Installing MinGW
20
21 These instructions apply to mingw-get-inst. Run the installer. When setting up the path, if you do not pick the default, make at least sure that the installation path you choose contains no space in it. Thus, Program Files is out of question.
22
23 When you reach the "select components" section, you need to check "MSYS Basic System" (**not** "MinGW Developer Toolkit"). You will also need the C compiler, which should be selected by default.
24
25 When the setup is complete, you will get a "MinGW Shell" in your start menu. This is a Unix-like shell that you will soon use to manage and compile the Xonotic source files. It will also be used to launch the game.
26
27 ### Installing msysgit
28
29 Run the installer. At the component selection screen (screenhsot: attachment:"git-1-components.png"), uncheck the "Associate .sh files" option. Windows Explorer Integration can also optionnally be unselected - it is only useful if you plan on contributing and do not like using git purely from the command line to do so. When you get to the PATH adjusting screen (screenshot: attachment:git-2-path.png), you need to select the second option (Run Git from the Windows Command Prompt). This ensures that git can be run from the MinGW shell, as we will not use the shell that comes with msysgit for this. Finally, in the line ending screen (screenshot: attachment:git-3-crlf.png), keep the first option selected unless you know what you're doing.
30
31 ### Installing the dependencies in MinGW
32
33 Xonotic requires a few more packages in MinGW that are not provided by default. Installing them is quite simple, just open a MinGW Shell and type the following line:
34
35     mingw-get install msys-wget msys-unzip mingw32-libiconv mingw32-libintl msys-libopenssl
36
37 You can paste text in the shell by right-clicking the title bar and selecting *Edit* \> *Paste*. But be careful with this, mistakes can happen!
38
39 To close a MinGW Shell, just type
40
41     exit
42
43 But keep this one open, we're going to use it some more.
44
45 To close a MinGW Shell, just type
46
47     exit
48
49 But keep this one open, we're going to use it some more.
50
51 Step 2: downloading the Xonotic source files
52 --------------------------------------------
53
54 In this step, we will clone the Xonotic git repositories inside MinGW's install directory.
55
56 In your MinGW Shell, type
57
58     git clone git://git.xonotic.org/xonotic/xonotic.git
59
60 This will clone the base repository, which contains a script called "`all`" that will manage the subrepositories. I will call this script `./all` to avoid confusion, as this is how we will be using it in the terminal.
61
62 Next, type
63
64     cd xonotic
65     ./all update -l best
66
67 The `cd` line tells the Shell to go inside the `xonotic` directory, where `./all` is located. In the second line, the `-l best` part asks `./all` to pick the best available mirror. This step will dowload several gigabytes of data, so expect it to take a while.
68
69 Step 3: compiling
70 -----------------
71
72 Compiling the game is quite simple. In your MinGW Shell, just type
73
74     ./all compile
75
76 This will compile fteqcc (which is a compiler for the QuakeC language), then the game code using fteqcc, then the DarkPlaces engine.
77
78 This step can take a few minutes, so be patient! When it's over, check the last few lines to see if it reports any errors.
79
80 Step 4: running the game!
81 -------------------------
82
83 To run the game, you have to use `./all` again:
84
85     ./all run
86
87 If you ever need to start the game in windowed mode, you can launch it this way:
88
89     ./all run +vid_fullscreen 0
90
91 By default, `./all` uses the SDL build (called `xonotic-sdl.exe` in releases). You can use the WGL build (`xonotic.exe`) like this:
92
93     ./all run wgl
94
95 You will always need to use `./all` to launch the game. Do not forget that you need to be in the `xonotic` directory when you use the `./all` command. That means you have to type
96
97     cd xonotic
98
99 when you start a MinGW Shell before updating, compiling, or running Xonotic.
100
101 Keeping up to date
102 ------------------
103
104 To keep up to date, all you need to do is repeat some of the steps above. More precisely, here is what you will usually type in a new MinGW Shell to update Xonotic to the latest git revision:
105
106     cd xonotic
107     ./all update
108     ./all compile
109
110 You can optionally use this as the third line if the compilation does not work:
111
112     ./all compile -c
113
114 This will remove the partially compiled files from the previous compiles. It has been known to resolve some errors before, but it can take a little longer to recompile everything.
115
116 Getting help
117 ------------
118
119 You can always ask for help in the [Xonotic forums](http://forums.xonotic.org), under the Help and Support section.