Editing Compiling

This page contains help on '''compiling''' NetHack from source.

==On Windows 10 with 64-bit Cygwin==

A simplified approach that requires no source changes is now available to build NetHack under Cygwin (tested on 64-bit version of Cygwin 2.8 w/ NetHack 3.6.2 source):

Download source from https://github.com/tslug/NetHack/tree/cygwin_port

Follow instructions in [https://github.com/tslug/NetHack/blob/cygwin_port/sys/cygwin/README.cygwin sys/cygwin/README.cygwin]

==On Windows 8.1 with Cygwin==

*Make sure the following cygwin packages are installed:
binutils, bison, flex, gcc-g++, libncurses-devel

*Download the NetHack 3.4.3 sources from http://nethack.org/v343/download-src.html
*gunzip and untar the source
*Edit win/tty/termcap.c
Change the following lines

 <nowiki>#include <curses.h></nowiki>

 <nowiki>#ifndef LINUX</nowiki>
 <nowiki>    extern char *tparm();</nowiki>
 <nowiki>#endif</nowiki>

to

 <nowiki>#ifdef __CYGWIN__</nowiki>
 <nowiki>#include <ncurses/curses.h></nowiki>
 <nowiki>#else</nowiki>
 <nowiki>#include <curses.h></nowiki>
 <nowiki>#endif</nowiki>

 <nowiki>#ifndef LINUX</nowiki>
 <nowiki>#ifndef __CYGWIN__</nowiki>
 <nowiki>    extern char *tparm();</nowiki>
 <nowiki>#endif</nowiki>
 <nowiki>#endif</nowiki>

*Edit include/config.h and change to
 COMPRESS "/usr/bin/gzip"
 COMPRESS_EXTENSION ".gz"
*Edit sys/unix/Makefile.utl and change to
 LEX = flex
*Edit sys/unix/Makefile.src and change to
 WINTTYLIB = -lncurses
*Edit sys/unix/Makefile.top and change to
 GAMEUID = (your windows username)
 GAMEGRP = Users

*Once the above changes have been made, run the following commands
 sh sys/unix/setup.sh
 make clean
 make
 make install

==On Windows==

This was tested on:
- Win2k with MinGW-5.0.3,
- WinXP with MinGW-5.1.1,

*Download NetHack's sources from http://nethack.org/v343/download-src.html

*Download MinGW from http://sourceforge.net/project/showfiles.php?group_id=2435 (You want the "Automated MinGW Installer")
NOTE: MinGW version 5.1.1 can be downloaded from: http://download408.mediafire.com/0cnai0w5i85g/ysnyqpdienpjb0z/MinGW-5.1.1.exe

*Install MinGW. If you use the 'minimal' installation, remember to also select the optional 'MinGW make' -component, so it gets installed. Use, say, <tt>C:\mingw\</tt> as the path to install to.

*Unpack the NetHack source package somewhere, say, <tt>c:\nh343\</tt>. After unpacking, that directory should contain several subdirectories, such as <tt>src</tt>, <tt>include</tt>, <tt>win</tt> and <tt>sys</tt>. You will need WinZip or some other utility that can uncompress the package.
*<span style="line-height:21px;">NOTE: Make sure you do NOT have a shell (e.g. 'sh') on your %PATH% for Windows.</span>

*Go to <tt>c:\nh343\sys\winnt\</tt> and run <tt>nhsetup.bat</tt>

*If you want to run the graphical windows GUI, edit <tt>c:\nh343\src\makefile.gcc</tt> and change the line
 #GRAPHICAL=Y
to
 GRAPHICAL=Y

NOTE: The latest MinGW (5.1.3 as of writing) has issues compiling the GUI version of the program. To remedy this, copy rpcndr.h from <tt>c:\MinGW\include\</tt> to <tt>c:\nh343\include\</tt>. Edit <tt>c:\nh343\include\rpcndr.h</tt> by removing or commenting out line 52: "typedef unsigned char boolean;". This should allow the compile to commence with minimal errors.

*Go to <tt>c:\nh343\</tt> and create a new file called <tt>'install.bat'</tt> with the following contents:
 PATH=c:\mingw\bin
 cd src
 mingw32-make -f makefile.gcc install

*Run the <tt>install.bat</tt> you just created. This takes about thirty seconds.

*The NetHack binary should now be in <tt>c:\nh343\binary\</tt>

*If you want to patch your NetHack, you should next see the article on [[patching]].

==On Linux==

===TTY===

The following compiles the TTY-version of NetHack, with all the default settings.

*Download NetHack's sources from http://nethack.org/v343/download-src.html

*Make sure you have the development packages for ncurses installed. On debian these are called libncurses5-dev. You will also need make, gcc, yacc (or something similar, for example bison), and lex (or something similar, such as flex).

*Open a terminal, and <tt>cd</tt> to the directory where you downloaded the source package to.

*Unpack the NetHack sources and move to the NetHack source root directory:
 tar xvzf nethack-343-src.tgz
 cd nethack-3.4.3

*Execute the script that moves the Makefiles to the correct places:
 sh sys/unix/setup.sh x

*Edit <tt>include/unixconf.h</tt> by changing
 /* #define LINUX */
to
 #define LINUX

*Edit <tt>src/Makefile</tt> by commenting the following like so
 #WINTTYLIB = -ltermlib
and uncommenting this line so it looks like
 WINTTYLIB = -lncurses

*If you're using something else than yacc and lex, edit <tt>util/Makefile</tt> so that <tt>YACC</tt> and <tt>LEX</tt> defines are correct.

*If you are using cygiwn, edit <tt>include/config.h</tt> and uncomment the following like so
 #define STRNCMPI        /* compiler/library has the strncmpi function */

*Typing <tt>make</tt> in the NetHack source root dir should compile the binary executable. Typing <tt>make all</tt> will compile everything, including [[special levels]].

*To install NetHack to <tt>/usr/games/</tt>, type <tt>make install</tt> while you're logged in as root. If you want to change the installation directory, you need to edit the top Makefile.

*For more information about compiling NetHack, see the <tt>sys/unix/Install.unx</tt> text file.

*If you want to patch your NetHack, you should next see the article on [[patching]].

===X11===

The following compiles the X11 windowport with default settings. First follow the instructions in the [[#TTY|TTY section]], then continue this.

*Make sure you have the X11 Athena Widget libraries and headers installed. On Debian the packages are <tt>libxaw</tt>, <tt>libxaw-dev</tt> and <tt>libxaw-headers</tt>.

*Edit <tt>include/config.h</tt> by changing
 /* #define X11_GRAPHICS */
to
 #define X11_GRAPHICS

and
 /* # define USE_XPM */
to
 # define USE_XPM

*Edit <tt>src/Makefile</tt>:
**add <tt>$(WINX11SRC)</tt> to <tt>WINSRC</tt>
**add <tt>$(WINX11OBJ)</tt> to <tt>WINOBJ</tt>
**add <tt>$(WINX11LIB)</tt> to <tt>WINLIB</tt>
**Change <tt>WINX11LIB</tt> so that it has <tt>-lXaw -lXmu -lXext -lXt -lXpm -lX11 -lm</tt>
**At least on Debian, <tt>WINX11LIB</tt> also needs <tt>-L/usr/X11R6/lib</tt>

*Edit <tt>Makefile</tt> so that <tt>VARDATND</tt> includes <tt>x11tiles NetHack.ad pet_mark.xbm rip.xpm</tt>

*Type <tt>make</tt> in the NetHack source root dir.

*To install NetHack to <tt>/usr/games/</tt>, type <tt>make install</tt> while you're logged in as root. If you want to change the installation directory, you need to edit the top Makefile.

*For more information about compiling NetHack, see the <tt>sys/unix/Install.unx</tt> text file. For X11 compilation, see <tt>win/X11/Install.X11</tt>

*If you want to patch your NetHack, you should next see the article on [[patching]].

*If you want to use tiles on X11, or change the window colors, see the article on [[X11 configuration]].

==On Mac OS X==

These are the instructions for compiling a TTY port of NetHack with default settings on Mac OS X. You will need to have the Xcode developer tools installed in order to be able to compile NetHack (check the CDs that came with your copy of Mac OS X). A minimal working knowledge of C and Terminal is assumed.

This has worked on at least OSX 10.6.1, 10.6.8, and 10.8.3.
#Download NetHack's sources from [[Pkgsrc#patch-ac_.28system.h.29|http://nethack.org/v343/download-src.html]] and unpack them.
#Open Terminal and <tt>cd</tt> to Nethack's <tt>sys/unix</tt> directory. Run <tt>sh setup.sh</tt> and then return to the root source folder. If you were successful, a new file named <tt>Makefile</tt> will now be present there, as well as in the <tt>src</tt> folder.
#If you are installing "vanilla" Nethack, read about the problems described at [[Pkgsrc#patch-ac_.28system.h.29|this page on the Nethack wiki]] and install patch-ac. (Do not do this step for Snow Leopard)
#Edit the file <tt>include/unixconf.h</tt> to make three changes: (Do not do this for Snow Leopard)
#*Uncomment the BSD <tt> </tt>
#<tt>define</tt> on line 22,
#*Comment out the <tt> </tt>
#<tt>define</tt>s for SYSV on line 28, and
#*Comment out the <tt> </tt>
#<tt>define</tt>s for SVR4 on line 35.
#In the file <tt>win/tty/termcap.c</tt>, change line 838 from <tt> </tt>
#<tt>ifndef LINUX</tt> to<br />
#<tt>if !defined(LINUX) &amp;&amp; !defined(__APPLE__)</tt>
#Make three changes to the file <tt>src/Makefile</tt>, which was created in step 2:
#*Uncomment line 233,
#*Comment out line 234
#*On line 154, change <tt>CFLAGS = -O -I../include</tt> to <tt>CFLAGS = -O2 -I../include</tt>. (This avoids a fatal error (<tt> mkmaze.c:281: error: unable to find a register to spill in class 'Q_REGS'</tt>) compiling <tt>mkmaze.c</tt>.)
#<tt>cd</tt> to the <tt>src</tt> directory and run <tt>make</tt> to compile the bulk of NetHack. This should take no more than a couple of minutes. If you needed to install the [[pkgsrc]] patch at step 3, you will receive an error here about a conflicting definition of <tt>srandom</tt>.
#Edit the <tt>Makefile</tt> in the root source directory to fix the game permissions. Here is one solution:
#* Change '<tt>games</tt>' on line 20 to '<tt>root</tt>',
#* Change 'games' on line 21 to '<tt>staff</tt>',
#* Change the value of <tt>GAMEPERM</tt> on line 25 to <tt>0755</tt>
#In Terminal, at the top source directory, run <tt>make all</tt> to create the auxiliary files, and then run <tt>sudo make install</tt> to install the game.
#To install the manpages, edit <tt>doc/Makefile</tt> by changing the path on line 44 to wherever you wish to install them (create the directory if necessary), and then run <tt>make install</tt> (or 'make manpages' on Snow Leopard, possibly with <tt>sudo</tt>) from the <tt>doc</tt> directory.
#Different versions of Mac OS X may have different issues with file permission settings on various components of <tt>/usr/games/lib/nethackdir</tt>. The following is sufficient for Snow Leopard:
#*$ sudo chmod 775 /usr/games/lib/nethackdir
#*$ sudo chmod 775 /usr/games/lib/nethackdir/save/
#*$ sudo chmod 775 /usr/games/lib/nethackdir/perm
#*$ sudo chmod 775 /usr/games/lib/nethackdir/record
#I then got errors on startup and exiting, "No such file or directory. Exec to compress save/501Tartley failed". I fixed this by editing include/config.h, line 172, change to read:
 #define COMPRESS "/usr/bin/gzip"
: I don't know whether this gzip exists on OSX by default, or whether I had installed it previously (e.g. from some package like "coreutils" in homebrew)

Then play! For example, "ln -s /usr/games/nethack /usr/local/bin" and type "nethack" from a terminal, or type <tt>open src/nethack</tt> from the top source directory in Terminal.

== On iPhone/iPod Touch ==

This is a tricky setup. The iPhone/iPod Touch (as of firmware 2.1), due to distribution terms, terminal sandboxing, and other odds and ends associated with a highly proprietary product, tends make things difficult.


So, we'll assume that you're using a jailbroken iPhone or iPod Touch for this procedure. We'll also assume that you're looking to play the game locally on the device on the go, as anyone can use the free terminal and telnet software to connect to [[NAO]] or equivalent.

We additionally assume that you're compiling for terminal mode; for tiles or native window manager support, far more work will be required in the future.


For compiling on the device itself, you will need:
* MobileTerminal or OpenSSH
* GCC, Make, and/or Toolchain 2.0
* Bison
* Flex


All of which may be found in Cydia's package repositories or, if you do not have Cydia, various places online.


Due to the rapid state of flux associated with commercial offerings, this list shall not be comprehensive. However, it WILL cover the highlights:


* SCP or otherwise download the latest sources onto your device, and perform the necessary <tt>tar -xzf</tt>. We use <tt>/usr/games</tt> as a candidate location, and <tt>/usr/games/nethack-3.4.3</tt> as our top level directory for the remaining steps.


* Browse into the <tt>sys/unix</tt> directory and read the associated documentation, to get a good feel for what you'll be doing with your system.


* (Optional) Alter settings in <tt>include/config.h</tt> such as compression options, wizard mode, etc. No changes need be made in here, though changing compression options will suppress a rather annoying warning.


* Return to <tt>sys/unix</tt>. Open <tt>Makefile.top</tt> and alter <tt>PREFIX, GAME, GAMEUID, GAMEGRP, GAMEDIR, VARDIR, SHELLDIR,</tt> and anything else you feel is necessary.


For convenience, here are tested values:

<pre>
PREFIX   = /usr/games
GAME     = nethack
# GAME     = nethack.prg
GAMEUID  = mobile
GAMEGRP  = wheel
...
GAMEDIR  = /usr/games/lib/$(GAME)dir
VARDIR  = $(GAMEDIR)
SHELLDIR = /bin
</pre>


* For the remaining makefiles in <tt>sys/unix</tt>, add <tt>CC = gcc</tt> or your compiler to the top of the file. In this example, <tt>CC = arm-apple-darwin9-gcc</tt> is used. Only <tt>Makefile.src</tt> and <tt>Makefile.utl</tt> ''should'' be required for this step.

<pre>Note: It is suggested, but not currently required, to also include items like:

CFLAGS = -O -I../include -I/var/include
LFLAGS = -L"/usr/lib" -F"/System/Library/Frameworks" -F"/System/Library/PrivateFrameworks" -bind_at_load

... by the maintainer of Toolchain 2.0. 


However, this does not appear to be necessary; nor does alteration of the code of main().
</pre>


* From the main directory, specific source edits are required for localization in this environment:

** <tt>win/tty/termcap.c:839</tt>: Comment out: <tt>// extern char *tparm();</tt>
** <tt>sys/unix/Makefile.src:234</tt>: Make sure <tt>WINTTYLIB</tt> is defined as <tt>-lncurses</tt> instead of <tt>-ltermlib</tt> or similar.
** <tt>sys/unix/Makefile.utl:108</tt>: Set <tt>YACC</tt> and <tt>LEX</tt> to use bison and flex, respectively. Example lines for these changes are given within this file.
** <tt>sys/unix/Makefile.doc:23</tt>: Set <tt>GUIDECMD = cat Guidebook.txt</tt> instead of the default.

<pre>Note: flex and bison may not work in the current build, stating "Bus error".


If this happens to you, it is advised to make the .c and .h files for this step
on a different system and copy them into /util and /include manually.</pre>


* (2.x firmware) At several steps in the build process, you will need to run <tt>ldid</tt> to ''sign'' each binary file, as unsigned files will be automatically "Killed" by the system with no further information.

To do this, either alter the make files or perform the following incremental steps manually:

<pre>
ldid -S makedefs  (in util)
ldid -S recover   (in util)
ldid -S dgn_comp  (in util)
ldid -S lev_comp  (in util)
ldid -S nethack   (in src or the final install location (we use /bin))

(ldid should be located in /usr/bin)
</pre>


* (Optional) Create your own <tt>.nethackrc</tt> in your system's user directory (usually <tt>/private/var/mobile</tt>) and enjoy! :)


Other steps may be required, but these are the major steps that result in a functional, working build of <tt>nethack</tt>. Of special note, <tt>color</tt> and <tt>lit_corridor</tt> does not work in certain local terminals, but otherwise, all Unix options appear to be supported.

Additionally, <tt>mobile</tt> and <tt>root</tt> seem to conflict if both users are used interchangeably, causing deaths by trickery. Only one user is advised (preferably the unprivileged <tt>mobile</tt>) with this current setup.

This test was performed with vanilla NetHack, though there should be no reason for this procedure to fail with many mods, patches, or [[slashem]].

=== Getting color to work on iPhone/iPod Touch ===
Of special note is the fact that this build supports color, but this does not appear to enable color within MobileTerminal.app (vt100).

However, color support can be verified by ssh in xterm, or in other terminal software for iPhone/iPod Touch.

==Notes==

*If using flex and 'make' fails with 'Broken Pipe', you'll need to downgrade your version of flex. Version [http://prdownloads.sourceforge.net/flex/flex-2.5.4a.tar.bz2?download 2.5.4a] works with NetHack.

*By default, the Guidebook isn't copied to the game's directory. You'll need to copy it manually.



==Cross building reference notes==
May be this can be interesting for developers who want to cross compile this great game:

http://crux-arm.nu/gitweb/?p=ports/games-cross.git;a=blob;f=nethack/Pkgfile;h=4403c9d78cdc20bbc975584e5dd40b52d91f7c4d;hb=c38c624a549d690faef9de02d1a01de4f1267253
[[Category:Development]]