- Copyright (c) NetHack Development Team 1990-2018
+ Copyright (c) NetHack Development Team 1990-2023
NetHack may be freely redistributed. See license for details.
==============================================================
Instructions for compiling and installing
NetHack 3.6 on a Windows system
- (Windows 7/8.x/10 or later only. XP may work but is untested)
+ (Windows 10/11 or later)
==============================================================
- Last revision: $NHDT-Date: 1524317622 2018/04/21 13:33:42 $
+ Last revision: $NHDT-Date: 1575245156 2019/12/02 00:05:56 $
-Credit for the porting of NetHack to the Win32 Console Subsystem goes to
+Credit for the porting of NetHack to the Win32 Console Subsystem goes to
the NT Porting Team started by Michael Allison.
Credit for the Win32 Graphical version of NetHack (aka "NetHack for
Alex Kompel, Dion Nicolaas, Yitzhak Sapir, Derek S. Ray, Michael Allison,
Pasi Kallinen, Bart House, and Janet Walz contributed to the maintainance
-of the tty and graphical windows versions of NetHack 3.6.1.
+of the tty and graphical windows versions of NetHack 3.6.7.
-You can build a TTY version of NetHack and a Windows Graphical
+You can build a TTY version of NetHack and a Windows Graphical
version. You can use one of the following build environments:
- o A copy of Microsoft Visual Studio 2017 Community Edition
- OR Microsoft Visual Studio 2015 Express
+ o A copy of Microsoft Visual Studio 2017 Community Edition or
+ a copy of Microsoft Visual Studio 2019 Community Edition
OR
- o (Untested for 3.6) A copy of MinGW. MinGW is a collection of header
- files and import libraries with which native Windows32 programs
- can be built; the MinGW distribution contains the GNU Compiler
+ o (Untested for 3.6) A copy of MinGW. MinGW is a collection of header
+ files and import libraries with which native Windows32 programs
+ can be built; the MinGW distribution contains the GNU Compiler
Collection. You can download MinGW at
http://www.mingw.org/
Earlier versions of MinGW will not allow you to build the Windows
Graphical version.
+/---------------------------------------------\
+| Directories for a Win32 NetHack build |
+\---------------------------------------------/
+
+
+ (NetHack-top) ----------------------(optional-pdcurses-top)
+ | |
+ ---------------------------------------------- --------------
+ | | | | | | | | |
+ util dat doc include src sys win pdcurses wincon
+ | |
+ ------ --------
+ | | | |
+ share winnt tty win32
+ |
+ vs2017
+
+
/--------------------------------------------------------\
-| Building And Running Using Visual Studio 2015 or |
-| Visual Studio 2017 |
+| Building And Running Using Visual Studio |
\--------------------------------------------------------/
-If you are NOT using Visual Studio 2015 or Visual Studio 2017 IDE, or
-you prefer to build using a Make utility and a Makefile proceed
-to "Building Using Make".
-
-When using either Visual Studio 2015 or Visual Studio 2017, you simply
-need to load the solution file within the IDE, build the solution and
-run the version of NetHack you wish to run.
+If you are NOT using Visual Studio 2017 IDE, or you prefer to build
+using a Make utility and a Makefile proceed to "Building Using Make".
-The Visual Studio 2015 NetHack solution file can be found here:
- win\win32\vs2015\NetHack.sln
+When using either Visual Studio 2017, you simply need to load the
+solution file within the IDE, build the solution and run the version
+of NetHack you wish to run.
The Visual Studio 2017 NetHack solution file can be found here:
win\win32\vs2017\NetHack.sln
+You can use that same win\win32\vs2017\NetHack.sln with Visual Studio 2019,
+but you likely have to retarget the projects. The same would apply if you are
+trying to build using an even more recent version of Visual Studio as well.
+Note: If you already built NetHack previously with an older version of
+Visual Studio, manually delete the following subfolders of win\win32\vs2017:
+ <DIR> obj
+ <DIR> symbols
+
+ Windows SDK Version: 10.0.22000.0 [ There have been some reports of
+ difficulties if you choose
+ "10.0 (latest installed version)"
+ instead ]
+ Platform Toolset: Upgrade to v142
+
+
+Before executing the steps to build listed in the next paragraph,
+decide if you want to include optional curses window-port. See
+the note just below entitled "Optional curses window-port support."
+
So the steps are:
1. Launch the IDE.
2. Open the appropriate solution file.
using a "build.bat" batch file found in the same directory as the solution.
Open a developer command prompt for the version of Visual Studio you are
-using. Change to the appropriate directory (i.e. win\win32\vs2015 for
-VS2015 builds, win\win32\vs2017 for VS2017 builds) and run "build.bat".
+using. Change to the directory win\win32\vs2017 and run "build.bat".
+
+ * Optional curses window-port support *
+
+Since 3.6.2, the community patch for a window-port that uses curses has been
+incorporated into the NetHack source code tree. That window-port, which
+evolved from work originally done by Karl Garrison, has been used in several
+NetHack variants and on nethack.alt.org and on www.hardfought.org/nethack/.
+
+If you want to include the curses window-port support in your Visual Studio
+build, you will have to first obtain the PDCurses sources from
+https://github.com/wmcbrine/PDCurses
+and have them available prior to building NetHack. There are two ways to
+enable curses window-port support during the VS build: Either set the
+environment variable PDCURSES to a folder containing a PDCurses
+repository/source-tree
+ OR
+Place the PDCurses folder alongside the NetHack source repository prior
+to proceeding with steps 1 through 5 above.
+
-/-----------------------------------\
-| Building Using Make |
-\-----------------------------------/
+/-------------------------------------------\
+| Building From the Command Line Using Make |
+\-------------------------------------------/
-The first step in building either version of NetHack via Makefile is to
-execute sys\winnt\nhsetup.bat to move some files to their required locations.
+--------------------------------------------------------------------------
+-- Beginning of prerequisite step --
+
+The first step in building either version of NetHack via Makefile is to
+execute sys\winnt\nhsetup.bat to move some files to their required locations.
From the command prompt:
cd sys\winnt
If you wish to build from the command line, proceed to "BUILDING FROM
THE COMMAND LINE."
-/--------------------------------\
-| BUILDING FROM THE COMMAND LINE |
-\--------------------------------/
+-- end of prerequisite step --
+--------------------------------------------------------------------------
Two different versions of NetHack will be built for Windows from the
command line using the Makefile approach:
NetHackW.
The executable for Console NetHack will be named NetHack.exe. The
-executable for Graphical NetHack will be named NetHackW.exe. The
+executable for Graphical NetHack will be named NetHackW.exe. The
Makefile configuration will build both; NetHackW.exe and NetHack.exe
will be able to use the same datafiles, save files and bones files.
-Since the last official release of NetHack, compilers and computer
+Since the last official release of NetHack, compilers and computer
architectures have evolved and you can now choose whether to build
a 32-bit x86 version, or a 64-bit x64 version. The default Makefile
-is set up for a 32-bit x86 version, but that's only because it will
+is set up for a 32-bit x86 version, but that's only because it will
run on the most number of existing Windows environments.
-NetHack's save files and bones files in the 3.6.1 release have not
-evolved enough to allow them to interchange between the 32-bit version
+NetHack's save files and bones files in the 3.6.7 release have not yet
+evolved enough to allow them to interchange between the 32-bit version
and the 64-bit version (or between different platforms). Hopefully
that will change in an upcoming release.
I. Dispelling the Myths:
Compiling NetHack for Windows is not as easy as it sounds, nor as hard
- as it looks, however it will behoove you to read this entire section
+ as it looks, however it will behoove you to read this entire section
through before beginning the task.
We have provided a Makefile for each of the following compilers:
- o Microsoft Visual Studio 2015 or 2017 C++ Compiler
+ o Microsoft Visual Studio 2017 or 2019 C++ Compiler
The Community Editions are fine and available at no cost
o MinGW 2.0 (with GCC 3.2)
- The Microsoft Visual Studio makefile was created for use
- with MS NMAKE which is provided with the Microsoft compiler.
+ The Microsoft Visual Studio makefile was created for use
+ with MS NMAKE which is provided with the Microsoft compiler.
The supplied Makefile may work with earlier versions of the Microsoft
- compiler, but that has not been tested.
+ compiler, but that has not been tested.
The GCC Makefile was created for use with GNU Make version 3.79.1,
which comes with the MinGW package.
Setting Up
-1. It almost goes without saying that you should make sure that your
+1. It almost goes without saying that you should make sure that your
tools are set up and running correctly. That includes ensuring that
all the necessary environment variables for the compiler environment
- are set correctly.
+ are set correctly.
- Change your current directory to the src subfolder of the nethack
+ Change your current directory to the src subfolder of the nethack
source tree.
cd src
- GCC
+ GCC
- For the GCC Makefile, add <mingw>\bin to your path, where <mingw>
+ For the GCC Makefile, add <mingw>\bin to your path, where <mingw>
is your MinGW root directory.).
- Change your current directory to src subfolder of the nethack
+ Change your current directory to src subfolder of the nethack
source tree.
cd src
-2. Make sure all the NetHack files are in the appropriate directory
- structure. You should have a main directory with subdirectories
- dat, doc, include, src, sys\share, sys\winnt, util, and binary (The
- "binary" directory was created by nhsetup.bat earlier if you
- followed the steps appropriately).
-
- For Console NetHack you need win\tty in addition to these; for
- Graphical NetHack you need win\win32 in addition to these.
-
- Other subdirectories may also be included in your distribution, but
- they are not necessary for building the TTY version for the Win32
- console subsystem. You can delete them to save space.
-
- Required Directories for a Win32 Console NetHack:
-
- top
- |
- ----------------------------------------------------/ /-----
- | | | | | | | |
- util dat doc include src sys win binary
- | |
- ------ -----
- | | |
- share winnt tty
-
-
- Required Directories for a Win32 Graphical NetHack:
-
- top
- |
- ----------------------------------------------------/ /-----
- | | | | | | | |
- util dat doc include src sys win binary
- | |
- ------ -----
- | | |
- share winnt win32
-
- Check the file "Files" in your top level directory for a more
- complete listing of what file is in which directory. In order for
- the Makefiles to work, all the source files must be in the proper
- locations.
+2. Since 3.6.2, the community patch for an optional curses window-port
+ has been incorporated into the NetHack source code tree. That
+ window-port, which evolved from work originally done by Karl Garrison,
+ has been used in several NetHack variants and on nethack.alt.org and
+ on www.hardfought.org/nethack/. The optional curses window-port is
+ available for Windows, Mac OS X, and Unix (and also DOS).
+
+ If you want to include the optional curses window-port support in your
+ command line Makefile build, you will have to first obtain the
+ PDCurses sources from https://github.com/wmcbrine/PDCurses
+ and have that source code tree available prior to building NetHack.
+ Edit your Makefile and in Question 4 of the four decisions you can
+ make in there, uncomment these two lines:
+ ADD_CURSES=Y
+ PDCURSES_TOP=..\..\pdcurses
+
+ Adjust the PDCURSES_TOP macro so that it points to the correct
+ location for the top of the PDCurses source tree if it differs from
+ the path shown.
+
+3. Make sure all the necessary files are in the appropriate directory
+ structure. You should have a main NetHack top directory with
+ subdirectories dat, doc, include, src, sys\share, sys\winnt,
+ win\tty, util.
+
+ If you are including the optional Curses window port into your
+ build,then you will need the top of the PDCurses sources in a
+ folder parallel to the top of the NetHack folder (or you will need
+ to change the value of the PDCURSES_TOP macro in the Makefile to
+ specify the appropriate location.
+
+ (You can check the file "Files" in your top level directory for a
+ more complete listing of what file is in which directory.)
If you downloaded or ftp'd the sources from a UNIX system, the lines
will probably end in UNIX-style newlines, instead of the carriage
trouble with them, so you may need to convert them. The compiler
should not have any problems with them however.
-3. Now go to the include subdirectory to check a couple of the header
- files there. Things *should* work as they are, but since you have
- probably set up your system in some sort of custom configuration it
- doesn't hurt to check out the following:
-
- First check config.h according to the comments to match your system
- and desired set of features. Mostly you need to check section 4 and
- 5.
-
- You may include all or as few of the special game features as you
- wish (they are located last in the file).
-
4. Edit your Makefile if you wish, but it is not required unless
you are altering the build options.
5. Now that everything is set up...
For the Visual Studio compiler, as mentioned above, you should now be
- at the command prompt to carry out the build and your current
+ at the command prompt to carry out the build and your current
directory should be the src subdirectory in the NetHack source tree.
In the src subdirectory, issue this command:
particular machine of course, but you should be able to go for lunch
and return to find everything finished. The less memory, and slower
your machine, the longer the lunch you may take. :-)
-
+
In any case, it is likely that the command prompt window where you
are doing the compiling will be occupied for a while. If all goes
well, you will get an NetHack executable.
your current directory to src and issue the appropriate command for
your compiler:
- For Microsoft compiler:
+ For Microsoft compiler:
nmake
For GCC:
have to delete dgn_flex.c, dgn_yacc.c, lev_flex.c, and lev_yacc.c
from the util directory to ensure that they are remade.
-2. Depending on the build and compiler and tools used above, the
+2. Depending on the build and compiler and tools used above, the
executable produced by the TTY build is either:
- - a 32-bit (x86), flat-address space, non-overlayed .exe file,
+ - a 32-bit (x86), flat-address space, non-overlayed .exe file,
which should run on any recent Win32 environment.
or
- - a 64-bit (x64) .exe file,
+ - a 64-bit (x64) .exe file,
which should run on any 64-bit Windows O/S.
+ Note that saved games are NOT compatible between the 32-bit and the
+ 64-bit versions at this time.
+
NetHack.exe is the tty version. NetHackW.exe is the graphical version.
-Play NetHack.
+Play NetHack.
PROBLEMS
OSDN Git Service
