Update Monk manual entry
[crawl.git] / crawl-ref / INSTALL.txt
1 Install instructions for Dungeon Crawl Stone Soup (DCSS)
2 --------------------------------------------------------
3
4 Getting Crawl to run
5 --------------------
6
7 This file describes how to compile a runtime executable of Crawl from the
8 source code. If you're trying to compile Crawl yourself, skip ahead to the next
9 section, "Building Crawl".
10
11 If, however, you're having trouble getting a precompiled binary to run:
12
13 1) Check whether you've downloaded and extracted the correct version.
14
15     Platform        Tiles?          Download package
16     --------        ------          ----------------
17     Windows         yes             stone_soup-VERSION-tiles-win32.zip
18     Windows         no              stone_soup-VERSION-win32.zip
19     Mac OS X        yes             stone_soup-VERSION-tiles-osx.zip
20                                     or stone_soup-VERSION-tiles-osx-app.dmg
21     Mac OS X        no              stone_soup-VERSION-osx.zip
22                                     or stone_soup-VERSION-osx-app.dmg
23     Source code     yes             stone_soup-VERSION-src.zip
24                                     or stone_soup-VERSION-src.tar.bz2
25
26 2) Try removing/renaming your saves/ directory in case older saves aren't
27    recognized anymore.
28
29
30 If you still can't get Crawl to run, you can ask for further help on IRC:
31 ##crawl-dev on freenode, forums: https://crawl.develz.org/tavern/ or usenet:
32 rec.games.roguelike.misc. Please try to be as detailed as possible about any
33 error messages you're getting.
34
35 The rest of the file deals with compiling from the source.
36
37
38 Building Crawl
39 --------------
40
41 Crawl is known to run on the following platforms:
42
43 - Any Unix with GNU or BSD userland.
44 - Mac OS X.
45 - Android.
46 - Microsoft Windows 2000/XP/Vista/7/8
47
48 The only officially supported compilers are gcc (4.7 or newer) and clang (3.4
49 or newer). On Windows, gcc is usually available as MinGW; compilation with MSVC
50 (Microsoft Visual Studio 2013) is supported.
51
52 There's no reason Crawl shouldn't work on other modern systems, especially
53 Unixy ones, although some porting may be needed.
54
55
56 Source Code Checkout
57 --------------------
58
59 If you don't already have the source code downloaded (in the form of a .zip or
60 .tar.bz2 file), you can obtain the latest source code from Git. MSYS2 users
61 should have Git if they followed the installation instructions in the MSYS2
62 section. Linux users can just install the 'git' or 'git-core' package with
63 whatever package manager they use. Note that there used to be another package
64 called 'git' (now 'gnuit') going around which stands for 'GNU interactive
65 tools'. This is not what you want.
66
67 Once you have Git installed, you just need to do:
68
69     git clone https://github.com/crawl/crawl.git
70
71 And then to get the contributing libraries, enter the newly cloned repository
72 via 'cd crawl' and type:
73
74     git submodule update --init
75
76 This should get you all you need to build Crawl from source.
77
78
79 Optional libraries
80 ------------------
81
82 Crawl can be built with some optional features:
83
84 * Sounds
85 * User Lua scripts
86
87 Crawl also uses a level compiler to compile special level definitions; to make
88 changes to the level compiler, you'll need the flex and bison/byacc tools
89 (Other lex/yaccs may also work). More details are available below.
90
91 Sound can be provided by SDL2_mixer (the default), by WINMM on Windows (defined
92 by WINMM_PLAY_SOUNDS in sound.h), or by an external command on Unix systems
93 (SOUND_PLAY_COMMAND in sound.h). To enable this, append SOUND=y to the make
94 invocation.
95
96 Crawl includes Lua 5.1.4 in its submodules. Crawl uses Lua for dungeon
97 generation. In addition, Crawl has a (rudimentary) Lua interface for users to
98 run scripts which can do things such as conditionalise parts of the
99 .crawlrc/init.txt. Such user Lua scripts are enabled by default, but can be
100 turned off by appending NO_LUA_BINDINGS=y to the make invocation.
101
102
103 Building on Unix (Linux, *BSD, Solaris, etc.)
104 ---------------------------------------------
105
106 To install or not to install:
107
108 If only one user on the system (you) is going to be playing Crawl, you do not
109 need to use "make install". A simple "make" will build Crawl in the source
110 directory, where you can run it as "./crawl".
111
112
113 Prerequisites (Debian):
114
115 On Debian-based systems (Ubuntu, Mint, ...), you can get all dependencies by
116 typing the following as root/sudo:
117 apt-get install build-essential libncursesw5-dev bison flex liblua5.1-0-dev \
118   libsqlite3-dev libz-dev pkg-config libsdl2-image-dev libsdl2-mixer-dev    \
119   libsdl2-dev libfreetype6-dev libpng-dev ttf-dejavu-core
120 (the last five are needed only for tiles builds). This is the complete set,
121 with it you don't have a need for the bundled "contribs".
122
123 If you are going to be rebuilding after doing small changes a lot, it is
124 recommended that you also install and configure ccache and binutils-gold:
125 apt-get install ccache binutils-gold less /usr/share/doc/ccache/README.Debian
126
127
128 Prerequisites (Fedora):
129
130 On Fedora, and possibly other RPM-based systems, you can get the dependencies
131 by running the following as root:
132 dnf install gcc gcc-c++ make bison flex ncurses-devel compat-lua-devel \
133   sqlite-devel zlib-devel pkgconfig SDL-devel SDL_image-devel libpng-devel \
134   freetype-devel dejavu-sans-fonts dejavu-sans-mono-fonts
135 (the last six are needed only for tile builds). As with Debian, this package
136 list avoids the need for the bundled "contribs".
137
138 ccache can be installed with:
139 dnf install ccache
140
141
142 Prerequisites (Void):
143
144 On Void Linux you can get all dependencies by running the following as root:
145 xbps-install make gcc perl flex bison pkg-config ncurses-devel lua51-devel \
146   sqlite-devel zlib-devel pngcrush dejavu-fonts-ttf SDL2-devel \
147   SDL2_mixer-devel SDL2_image-devel freetype-devel
148 (the last six are needed only for tile builds).
149
150 ccache can be installed with:
151 xbps-install ccache
152
153
154 Prerequisites (other systems):
155
156 GNU gcc and g++, GNU make, libncursesw or libcursesw. You need the development
157 headers for ncurses - they may not be installed by default on some Unixes.
158
159 For tile builds, you need FreeDesktop's pkg-config, X11 and opengl headers.
160 The latter are likely to come from mesa sources.
161
162 flex and bison are optional but highly recommended. Recent versions of byacc
163 are also fine (edit your makefile appropriately).
164
165 You need to link with a curses library that understands Unicode characters,
166 usually named libncursesw (the development headers for libncursesw are usually
167 in /usr/include/ncursesw).
168
169
170 Building:
171
172 * cd to the source directory.
173
174 * Most users can simply type 'make' without any extra flags, and get a working
175   build as a result. If just typing 'make' works for you, then you shouldn't
176   need to read any further. BSD and Solaris users may have to use 'gmake'
177   instead of 'make'.
178
179 * For information Makefile settings beyond what is here, see the documentation
180   in comments in the Makefile itself.
181
182 * If you want a graphical (tiled) build, then you should add 'TILES=y' to the
183   'make' command-line, like so:
184
185     make TILES=y
186
187   Note that the graphical build requires that you have development libraries
188   installed for SDL, SDL_image, libpng, zlib, and freetype. If your system
189   doesn't have these installed, you can usually get them via your package
190   manager (apt-get, emerge, yum, etc).
191
192   If you would rather, you can go to the source/contrib directory and type
193   'make', and the required libraries should be built for you.
194
195 * If you want to install Crawl system-wide rather than play from the build
196   directory, you need to specify a directory to hold the save and data files.
197   Specifying a prefix of /usr or /usr/local will default SAVEDIR to "~/.crawl"
198   and DATADIR to share/crawl (relative to the prefix). SAVEDIR must be
199   writeable and owned by the user running crawl, so except for special cases it
200   should be inside "~" (home directory).
201
202 * To be specific, specifying a prefix means adding "prefix=foldername" to your
203   'make' command. Specifying a prefix is not mutually exclusive with specifying
204   a SAVEDIR; you can set them to completely unrelated directories if desired.
205
206 * If you're installing Crawl for multiple users, run 'make install' as root.
207   Crawl will be copied into the directory specified by 'prefix' (see above).
208   The data directory will be created if necessary, and the level layout, tile
209   and help files will be copied there.
210
211 * If you do not want players to be able to script Crawl with Lua, add
212   'NO_LUA_BINDINGS=y' to the 'make' command-line. This removes functionality
213   like autofight, and Lua scripts have been enabled on public servers for many
214   years without any security issues, so there is no real reason to do so.
215
216
217 Building on Mac OS X
218 --------------------
219
220 Before building on Mac OS X, you need a working copy of Xcode and the
221 associated command line tools. For recent versions of OS X, Xcode can be
222 installed through the AppStore as a free download; the associated command line
223 tools can then be installed by opening Xcode, opening the Preferences dialog,
224 and clicking Install on the Command Line Tools line in the Download tab.
225
226 Mac builds then use the Unix build process described above. To build Crawl on
227 a Mac you could use the following example command lines.
228
229 For the console version:
230   make
231 For the graphical version:
232   make TILES=y
233
234
235 Building on Windows (MSYS2)
236 ---------------------------
237
238 MSYS2 which is a Cygwin-derived software distro for Windows that can build
239 native applications. We recommend Windows users try this method first for
240 compiling crawl, since it is tested by our active Windows developers. You can
241 download the MSYS2 installer from the following website:
242
243 https://msys2.github.io/
244
245 You generally want to install the 64-bit version of MSYS2 unless you have a
246 specific reason to build a 32-bit version of crawl. Follow all of the steps you
247 see on that page to install MSYS2, but please read the additional notes below.
248 In particular, when starting the MSYS2 Shell, be sure to run the 64-bit MinGW
249 version of MSYS2 and *not* the version labeled 'MSYS2 MSYS'.
250
251 * The installer will put all MSYS2/MinGW files into a folder of your choice,
252   which defaults to 'C:\msys64'. If you have crawl-related work files from
253   other directories that you'd like to carry over, you can copy them into
254   'C:\msys64\home\<Username>', where <Username> is your Windows username. This
255   is the path to your home directory in this new MSYS2 installation.
256
257 * After the installer finishes, you'll want to start the MSYS2 Shell to follow
258   steps 5-7 in order to update your installation. Be sure to use the menu entry
259   that's labeled MSYS2 MinGW 64-bit and *not* the one labeled 'MSYS2 MSYS'.
260   After each update step, restart the MSYS2 shell before the next step.
261
262 After MSYS2 is fully installed and updated, follow steps below to install
263 development packages and compile Crawl. The commands shown below should be run
264 from within the MSYS2 Shell.
265
266 * To install git and the base development packages, run:
267
268   pacman -S base-devel git
269
270   Accept the default action to install all packages in base-devel, and say yes
271   to any questions about installing packages or removing packages due to
272   conflicts.
273
274 * To install the mingw-w64 GCC toolchain for your system, run:
275
276   pacman -S mingw-w64-x86_64-toolchain
277
278   After the packages install, you're ready to build crawl!
279
280 * To get the Crawl source, you can follow the steps in the Source Code Checkout
281   section above to clone Crawl into your MSYS2 home directory. If you've
282   downloaded the source elsewhere, first 'cd' to that Crawl source directory.
283   For example, if you have the Crawl sources in c:\crawl\source, you would run:
284
285   cd /c/crawl/source
286
287 * Build the console version of Crawl by simply running:
288
289   make
290
291   If you want a graphical build, you will need to run add 'TILES=y':
292
293   make TILES=y
294
295 * When the build process finishes, you can run crawl.exe directly from the
296   source directory in the MSYS2 shell. For Tiles, type './crawl', and for
297   console, type 'start crawl', which will open Crawl in a new console window
298   (necessary for it to run properly). Both versions can also be started by
299   double-clicking crawl.exe using the graphical file explorer.
300
301 Building on Windows (Cygwin)
302 ----------------------------
303
304 * Get Cygwin from http://www.cygwin.com/. When installing, ensure that the
305   following packages are selected: gcc, g++, make, flex, bison,
306   libncurses-devel. If you'd like to build from git, install the git-core
307   package. You may also want to install diff, patch, and other such tools.
308
309 * Once Cygwin is installed, open a Cygwin bash shell (use the Start menu or
310   desktop icon, do not double-click bash.exe in Explorer).
311
312 * cd to the the Crawl source directory. For instance, if you have the Crawl
313   sources in c:\crawl\source, you would type 'cd /cygdrive/c/crawl/source'.
314
315 * Follow the Linux build instructions to build Crawl.
316
317 Building on Windows (MSVC)
318 --------------------------
319
320 * If you do not have Visual Studio 2012 you can get the free Express edition
321   (for Desktop) from http://www.microsoft.com/visualstudio/eng/downloads (look
322   for Visual Studio Express 2012 for Windows Desktop).
323
324 * You'll need a perl environment, there are links to several Windows binaries
325   you can choose from at http://www.perl.org/get.html
326
327 * In the Crawl source, run gen-all.cmd which is in source/util/. This step must
328   be executed any time you update to a new version of the source (or if you
329   have modified tile data or unrandarts).
330
331 * The first time you compile, you need to build the Contribs solution. This
332   compiles various libraries which Crawl itself needs to build. This only needs
333   to be performed the first time you build, or if the contribs are ever updated
334   (extremely rare). To do this open and compile Contribs.sln in source/contrib.
335
336 * Open crawl-ref.sln in Visual Studio, this is in source/MSVC/.
337
338 * You can now select Debug or Release from the drop-down build configurations
339   menu on the main toolbar (it should be next to "Local Windows Debugger");
340   crawl.exe can them be compiled by selecting "Build Solution" in the BUILD
341   menu. You can quickly run it by selecting "Start without Debugging" in the
342   debug menu (or debug with "Start Debugging" but the game will run extremely
343   slowly). Note: the Release build can still be debugged using the Visual
344   Studio debugger.
345
346 * Better support for Python (for the webserver project) and Lua (for the dat
347   project) can be installed with these extensions:
348
349   Python Tools for Visual Studio
350   http://pytools.codeplex.com/releases
351
352   Ports of VsLua to Visual Studio 2012
353   http://www.dbfinteractive.com/forum/index.php?topic=5873.0
354   http://pouet.net/topic.php?which=9087
355
356   Try at your own risk, but the first one has been tested and found to be
357   effective.
358
359 *****************************************************************************
360
361 Data files
362 ----------
363
364 Crawl looks for several data files when starting up. They include:
365
366 * Special level and vault layout (dat/*.des) files.
367 * Core Lua code (dat/dlua/*.lua).
368 * Descriptions for monsters and game features (dat/descript/*.txt).
369 * Definitions for monster dialogue and randart names (dat/database/*.txt).
370
371 All these files are in the source tree under source/dat.
372
373 Crawl will also look for documentation files when players invoke the help
374 system. These files are available under the docs directory.
375
376 Your built Crawl binary must be able to find these files, or it will not start.
377
378 If Crawl is built without an explicit DATA_DIR_PATH (this is the most common
379 setup), it will search for its data files under the current directory, and if
380 it can't find them there, one level above the current directory. In short, it
381 uses these search paths: ., ./dat, ./docs, .., ../dat, ../docs.
382
383 The level compiler
384 ------------------
385
386 Crawl uses a level compiler to read the level design (.des) files in the
387 source/dat directory.
388
389 If you're using one of standard makefile, the steps described in this section
390 are performed automatically:
391
392 The level compiler source is in the source/util directory (levcomp.lpp and
393 levcomp.ypp). The steps involved in building the level compiler are:
394
395 * Run flex on levcomp.lpp to produce the levcomp.lex.cc lexer.
396 * Run bison on levcomp.ypp to produce the levcomp.tab.cc parser and
397   levcomp.tab.h
398 * Compile the resulting C++ source files and levcomp.cc and link the object
399   files into the Crawl executable.
400
401 For convenience on systems that don't have flex/bison, pre-generated
402 intermediate files are provided under source/prebuilt. The makefiles provided
403 with the Crawl source distribution will use these pre-generated files
404 automatically if flex/bison is not available.
405
406 Lua
407 ---
408
409 The Lua source is included with Crawl. It will be used if you don't have Lua
410 headers installed. Note that we don't provide security support for Lua, and
411 thus if you run a public server or a kiosk, it is strongly recommended to use
412 system Lua which does receive security updates from whatever distribution you
413 use.
414
415 PCRE
416 ----
417
418 PCRE 8.12, with a custom build system but otherwise unchanged, is included with
419 Crawl. It is enabled by default on Windows; otherwise, unless you build with
420 BUILD_PCRE (to use the contrib) or USE_PCRE (to use a development package from
421 your manager), the system POSIX regex will be used.
422
423 Unicode
424 -------
425
426 On Unix, you want an UTF-8 locale. All modern distributions install one by
427 default, but you might have somehow dropped required settings. To check this,
428 run "locale charmap", which should say "UTF-8". If it's not, please ensure
429 either LANG, LC_ALL or LC_CTYPE is set. A typical line would be "export
430 LC_ALL=en_US.UTF-8".
431
432 On Windows, the console behaves differently for TrueType and legacy (bitmap)
433 fonts. The latter (mostly) work only on certain language editions of Windows,
434 such as English, and even there, they work adequately only for Crawl's default
435 settings. For anything more, please select one of TrueType fonts. If, like one
436 of our players, you are deeply attached to the looks of bitmap fonts, you can
437 download a corrected version of the Terminal font from
438 http://www.yohng.com/software/terminalvector.html