fix cscope instructions
[xonotic/xonotic.wiki.git] / Compiling-on-Windows.md
1 Compiling In Windows
2 ====================
3
4 **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](https://gitlab.com/xonotic/xonotic/wikis/Repository_Access#windows) page.
5
6 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.
7
8 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).
9
10 Step 1: installing the prerequisites
11 ------------------------------------
12
13 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.
14
15 -   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
16 -   [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.
17
18 ### Installing MinGW
19
20 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.
21
22 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.
23
24 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.
25
26 ### Installing msysgit
27
28 Run the installer.
29 At the component selection screen (screenshot), uncheck the “Associate .sh files” option.  
30
31 ![](assets/images/git-1-components.png)
32
33 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.
34 When you get to the PATH adjusting screen (screenshot), you need to select the second option (Run Git from the Windows Command Prompt).  
35
36 ![](assets/images/git-2-path.png)
37
38 This ensures that git can be run from the MinGW shell, as we will not use the shell that comes with msysgit for this.
39 Finally, in the line ending screen (screenshot), keep the first option selected unless you know what you’re doing.  
40
41 ![](assets/images/git-3-crlf.png)
42
43 ### Installing the dependencies in MinGW
44
45 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:
46
47     mingw-get install msys-wget msys-unzip mingw32-libiconv mingw32-libintl msys-libopenssl
48
49 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!
50
51 To close a MinGW Shell, just type
52
53     exit
54
55 But keep this one open, we’re going to use it some more.
56
57 Step 2: downloading the Xonotic source files
58 --------------------------------------------
59
60 In this step, we will clone the Xonotic git repositories inside MinGW’s install directory.
61
62 In your MinGW Shell, type
63
64     git clone git://git.xonotic.org/xonotic/xonotic.git
65
66 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.
67
68 Next, type
69
70     cd xonotic
71     ./all update -l best
72
73 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 download several gigabytes of data, so expect it to take a while.
74
75 Step 3: compiling
76 -----------------
77
78 Compiling the game is quite simple. In your MinGW Shell, just type
79
80     ./all compile
81
82 This will compile gmqcc (which is a compiler for the QuakeC language), then the game code using gmqcc, then the DarkPlaces engine.
83
84 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.
85
86 Step 4: running the game!
87 -------------------------
88
89 To run the game, you have to use `./all` again:
90
91     ./all run
92
93 If you ever need to start the game in windowed mode, you can launch it this way:
94
95     ./all run +vid_fullscreen 0
96
97 By default, `./all` uses the SDL build (called `xonotic.exe` in releases). You can use the WGL build (`xonotic-wgl.exe`) like this:
98
99     ./all run wgl
100
101 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
102
103     cd xonotic
104
105 when you start a MinGW Shell before updating, compiling, or running Xonotic.
106
107 Keeping up to date
108 ------------------
109
110 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:
111
112     cd xonotic
113     ./all update
114     ./all compile
115
116 You can optionally use this as the third line if the compilation does not work:
117
118     ./all compile -c
119
120 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.
121
122 Getting help
123 ------------
124
125 You can always ask for help in the [Xonotic forums](http://forums.xonotic.org), under the Help and Support section.