Compiling - Revision history

Furey: http -> https for nethack.org. nethack.org emits red-letter warning for http.

2024-06-20T23:44:26Z

http -> https for nethack.org. nethack.org emits red-letter warning for http.

LarryFluke: I updated the instructions for building 3.7 on Windows.

2023-12-19T02:37:40Z

I updated the instructions for building 3.7 on Windows.

LarryFluckiger: /* Windows */

2022-06-10T21:02:03Z

‎Windows

LarryFluckiger: /* Windows */

2022-06-10T20:58:16Z

‎Windows

LarryFluke: /* Windows */

2022-05-30T18:17:42Z

‎Windows

Testbutt: secret instructions, secret no longer!

2021-03-15T19:05:09Z

secret instructions, secret no longer!

Testbutt: tips to get it to compile

2020-12-15T21:45:19Z

tips to get it to compile

Ardub23: Section headers are not Proper Nouns

2019-11-04T05:12:50Z

Section headers are not Proper Nouns

POGtastic: /* Windows */ Fixing stupid typos.

2019-08-27T00:19:58Z

‎Windows: Fixing stupid typos.

POGtastic: /* Windows */

2019-08-27T00:19:12Z

‎Windows

@@ Line 6: / Line 6: @@
 The official released NetHack source can be found here:
-http://nethack.org/v360/download-src.html
+https://nethack.org/v360/download-src.html
 Once you have obtained the tarball, you will need to extract it, either using standard tools (<tt>tar -xvf nethack-360-src.tgz</tt>) or some other archive extractor that can handle the tar and gzip formats.

@@ Line 81: / Line 81: @@
 * Make with your <tt>make</tt> program. For me, the invocation was <tt>mingw32-make -f Makefile.gcc install</tt>. Note that if you don't specify the <tt>-f Makefile.gcc</tt> option, you'll get an error, as the standard <tt>Makefile</tt> is for Visual Studio's <tt>nmake</tt> program.
-{{upcoming|NetHack 3.7.0|Nethack 3.7 has good support for building, running, and debugging in Visual Studio 2017, 2019, and 2022, including a working solution file. Tools such as MinGW and GnuWin32 are not required. See <tt>sys\windows\Install.windows</tt> for instructions. After building the project, you may need to rename the "symbols.template" file in the target director to "symbols".}}
+{{upcoming|NetHack 3.7.0|Nethack 3.7 has good support for building, running, and debugging in Visual Studio 2017, 2019, and 2022, including a working solution file. Tools such as MinGW and GnuWin32 are not required. See <tt>sys\windows\Install.windows</tt> for instructions.}}
 ==Compiling==

@@ Line 81: / Line 81: @@
 * Make with your <tt>make</tt> program. For me, the invocation was <tt>mingw32-make -f Makefile.gcc install</tt>. Note that if you don't specify the <tt>-f Makefile.gcc</tt> option, you'll get an error, as the standard <tt>Makefile</tt> is for Visual Studio's <tt>nmake</tt> program.
-{{upcoming|NetHack 3.7.0|Nethack 3.7 has good support for building, running, and debugging in Visual Studio 2017, 2019, and 2022, including a working solution file. Tools such as MinGW and GnuWin32 are not required. See <tt>sys\windows\Install.windows</tt> for instructions.}}
+{{upcoming|NetHack 3.7.0|Nethack 3.7 has good support for building, running, and debugging in Visual Studio 2017, 2019, and 2022, including a working solution file. Tools such as MinGW and GnuWin32 are not required. See <tt>sys\windows\Install.windows</tt> for instructions. After building the project, you may need to rename the "symbols.template" file in the target director to "symbols".}}
 ==Compiling==

@@ Line 81: / Line 81: @@
 * Make with your <tt>make</tt> program. For me, the invocation was <tt>mingw32-make -f Makefile.gcc install</tt>. Note that if you don't specify the <tt>-f Makefile.gcc</tt> option, you'll get an error, as the standard <tt>Makefile</tt> is for Visual Studio's <tt>nmake</tt> program.
+{{upcoming|NetHack 3.7.0|Nethack 3.7 has good support for building, running, and debugging in Visual Studio 2017, 2019, and 2022, including a working solution file. Tools such as MinGW and GnuWin32 are not required. See <tt>sys\windows\Install.windows</tt> for instructions.}}
 ==Compiling==

@@ Line 67: / Line 67: @@
 ===Windows===
-For Windows, it's a good idea to follow the instructions inside <tt>sys\winnt\Install.nt</tt>. The following assumes that you have your compiler and coreutils from projects such as MinGW and GnuWin32.
+For Nethack 3.6 on Windows, it's a good idea to follow the instructions inside <tt>sys\winnt\Install.nt</tt>. The following assumes that you have your compiler and coreutils from projects such as MinGW and GnuWin32.
 * Navigate to <tt>sys\winnt</tt> and run <tt>nhsetup.bat</tt>.
@@ Line 81: / Line 81: @@
 * Make with your <tt>make</tt> program. For me, the invocation was <tt>mingw32-make -f Makefile.gcc install</tt>. Note that if you don't specify the <tt>-f Makefile.gcc</tt> option, you'll get an error, as the standard <tt>Makefile</tt> is for Visual Studio's <tt>nmake</tt> program.
 ==Compiling==

@@ Line 58: / Line 58: @@
 ==Running the build setup script==
-Once you have selected and possibly modified a hints file, you are ready to run the setup script.  On most platforms, this is done with the following command:
+Once you have selected and possibly modified a hints file, you are almost ready to run the setup script.  Run "make fetch-lua".
 <tt>sys/unix/setup.sh sys/unix/hints/whichever_hints_file_you_are_using</tt>

@@ Line 54: / Line 54: @@
 * The CHOWN and CHGRP variables should contain the commands used to change ownership and group-ownership of files, respectively.  Setting it to a command that doesn't do anything (such as 'yes' or 'true', as the stock 'linux' hints file does) will result in permissions not being changed, which is typically not what you want except possibly for a single-user install.  If you are modifying the 'linux' hints file to build on a Linux system, you will probably want to change these lines.
 * The WINSRC, WINOBJ, and WINLIB lines control which window port you will build.  If this is your first time compiling NetHack, it is recommended to start with the TTY port, which is easiest to build successfully.
 ==Running the build setup script==

@@ Line 3: / Line 3: @@
 Information about compiling NetHack 3.4.3 can still be found in [https://nethackwiki.com/mediawiki/index.php?title=Compiling&oldid=99565 an old version of this article, q.v.].
-==Obtaining the Officially Released Sources==
+==Obtaining the officially released sources==
 The official released NetHack source can be found here:
@@ Line 12: / Line 12: @@
 Note that if you use a graphical archive extractor like 7zip, you may have to extract twice: once to decompress the gzip and obtain the plain tar file, and a second time to extract the actual contents.
-==Obtaining the Development Sources==
+==Obtaining the development sources==
 The development source repository is available at http://git.code.sf.net/p/nethack/NetHack
@@ Line 28: / Line 28: @@
 This will create a subdirectory (a.k.a., a "folder") called 'NetHack', in the current directory, and the new subdirectory, 'NetHack', will be a git repository, containing a working copy of the latest public development source for what will eventually become NetHack 3.6.1.
-==Preparing to Compile==
+==Preparing to compile==
-===Gathering Build Tools===
+===Gathering build tools===
 In order to build NetHack, you will neet at minimum the following tools:
@@ Line 41: / Line 41: @@
 Note that you will need copies of all these on the platform for which you are building NetHack.  Cross-compiling NetHack, if even possible, is much more complicated and far beyond the scope of this article.
-===Selecting a Hints File===
+===Selecting a hints file===
 The new build system introduced in NetHack 3.6.0 is based on "hints files", which inform the rest of the build system about various things which might differ from one system to another, and which you might wish to customize when building, even if you are making no changes to the actual game.  Things like which directory to install the game's binaries into, which directory to use for storing the game data, which flags to pass to the compiler, and even basic facts like what the compiler on your system is called, are all specified in the hints file.  A hints file is simply a plain text file, formatted like a shell script, that contains hints for the NetHack build system, in the form of setting variables.
@@ Line 47: / Line 47: @@
 You can find a collection of existing hints files in the sys/unix/hints/ directory.  You may find that one of them is closer to what you want than others.  For example, the 'linux' hints file is designed for a single-user install in ~/nh/install; whereas, the 'unix' hints file is designed for a traditional system-wide install in /usr.  Look through the existing hints files and see if you can find one that is a close fit for your needs.
-===Modifying a Hints File===
+===Modifying a hints file===
 If you need to combine or modify a hints file, here are some useful things to know:
@@ Line 55: / Line 55: @@
 * The WINSRC, WINOBJ, and WINLIB lines control which window port you will build.  If this is your first time compiling NetHack, it is recommended to start with the TTY port, which is easiest to build successfully.
-==Running the Build Setup Script==
+==Running the build setup script==
 Once you have selected and possibly modified a hints file, you are ready to run the setup script.  On most platforms, this is done with the following command:
@@ Line 87: / Line 87: @@
 If the build goes well, you can (as root/superuser if necessary, or with sudo) use the 'make install' command to install your newly compiled NetHack.
-==Creating the System Config File==
+==Creating the system config file==
 When you try to run your new build, it will complain that there is no syscf file and refuse to do anything until you create that file.  The syscf file is allowed to be empty; it just has to exist.  Simply create an empty file named sysconf in your HACKDIR and nethack will run normally.

@@ Line 75: / Line 75: @@
 ** Do you want Curses window port support? If so, uncomment <tt>ADD_CURSES=Y</tt> and make sure that you've cloned the PDCurses repository from https://github.com/wmcbrine/PDCurses.
 ** TODO: (Test this, I only wanted the terminal interface) Do you want Qt support? You're going to want to change this option and specify the location of the Qt directory.
-** On Line 484, are the compiler macros set up correctly? Mine were not, as Chocolatey links the compilers to standard <tt>gcc</tt> filenames instead of <tt>mingw32-gcc.exe</tt>. Comment out the <tt>#ifndef<tt> directive and specify the compilers.
+** On Line 484, are the compiler macros set up correctly? Mine were not, as Chocolatey links the compilers to standard <tt>gcc</tt> filenames instead of <tt>mingw32-gcc.exe</tt>. Comment out the <tt>#ifndef</tt> directive and specify the compilers.
 * Make with your <tt>make</tt> program. For me, the invocation was <tt>mingw32-make -f Makefile.gcc install</tt>. Note that if you don't specify the <tt>-f Makefile.gcc</tt> option, you'll get an error, as the standard <tt>Makefile</tt> is for Visual Studio's <tt>nmake</tt> program.

@@ Line 66: / Line 66: @@
 For Windows, it's a good idea to follow the instructions inside <tt>sys\winnt\Install.nt</tt>. The following assumes that you have your compiler and coreutils from projects such as MinGW and GnuWin32.
-* Navigate to <tt>sys/winnt</tt> and run <tt>nhsetup.bat</tt>.
+* Navigate to <tt>sys\winnt</tt> and run <tt>nhsetup.bat</tt>.
 * Navigate to <tt>src</tt> and edit <tt>Makefile.gcc</tt>.
 * Inside the Makefile, you're going to want to edit or check the following things:
-** Do you want the outputted binary to belong in <tt>../binary</tt>, or somewhere else?
+** Do you want the outputted binary to belong in <tt>..\binary</tt>, or somewhere else?
 ** Are you compiling for a specific architecture (x86 or x64)? If so, edit <tt>TARGET_CPU</tt>.
 ** Do you want Curses window port support? If so, uncomment <tt>ADD_CURSES=Y</tt> and make sure that you've cloned the PDCurses repository from https://github.com/wmcbrine/PDCurses.