From 7ee4fa3c3ff67fbb99cef0fc905c8561db7e08e1 Mon Sep 17 00:00:00 2001 From: nhmall Date: Mon, 19 Nov 2018 10:40:51 -0500 Subject: [PATCH] some curses window-port doc bits --- doc/fixes36.2 | 13 ++++++ sys/winnt/Install.nt | 107 ++++++++++++++++++------------------------- 2 files changed, 58 insertions(+), 62 deletions(-) diff --git a/doc/fixes36.2 b/doc/fixes36.2 index f4cfd00a1..a808ba08d 100644 --- a/doc/fixes36.2 +++ b/doc/fixes36.2 @@ -314,6 +314,19 @@ for ^X and enlightenment, display the information in a menu rather than a end of game disclosure of attributes remains single-forward-pass +NetHack Community Patches (or Variation) Included +------------------------------------------------- +curses: the community patch for an optional curses window-port was + incorporated into the NetHack source code tree. The curses + window-port evolved from work originally done by Karl Garrison, + and has been in use in several NetHack variants and on + nethack.alt.org and on www.hardfought.org/nethack/ for a while. + It is available and tested for 3.6.2 for Windows with PDCurses + layered underneath, and for Mac OSX and Unix (using ncurses as + the layer underneath). It may also work for DOS with PDCurses + layered underneath, but that has not been tested. + + Code Cleanup and Reorganization ------------------------------- generated source file monstr.c is no longer used diff --git a/sys/winnt/Install.nt b/sys/winnt/Install.nt index 91446103e..f3fe944fc 100644 --- a/sys/winnt/Install.nt +++ b/sys/winnt/Install.nt @@ -33,6 +33,24 @@ version. You can use one of the following build environments: 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 2017 | \--------------------------------------------------------/ @@ -64,7 +82,7 @@ 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 directory win\win32\vs2017 and run "build.bat". - + * Optional curses window-port support * Starting with 3.6.2, the community patch for a window-port that uses curses was incorporated into the NetHack source code tree. That window-port, @@ -84,9 +102,12 @@ 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 | +\-------------------------------------------/ + +-------------------------------------------------------------------------- +-- 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. @@ -101,9 +122,8 @@ From a Windows explorer window: 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: @@ -175,11 +195,12 @@ Setting Up source tree. cd src -2. Starting with 3.6.2, the community patch for a window-port that uses - curses was incorporated into the NetHack source code tree. That +2. Starting with 3.6.2, the community patch for an optional curses + window-port was 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/. + 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 @@ -194,48 +215,19 @@ Setting Up location for the top of the PDCurses source tree if it differs from the path shown. -3. 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). +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. - For Console NetHack you need win\tty in addition to these; for - Graphical NetHack you need win\win32 in addition to these. + 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. - 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 build: - - top -------------(optional) ---------------- - | | - ------------------------------------------------- pdcurses-top - | | | | | | | | | - util dat doc include src sys win pdcurses wincon - | | - ------ ----- - | | | - share winnt tty - - - Required Directories for a Win32 Graphical NetHack: - - top - | - ------------------------------------------------- - | | | | | | | - util dat doc include src sys win - | | - ------ ----- - | | | - 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. + (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 @@ -243,18 +235,6 @@ Setting Up trouble with them, so you may need to convert them. The compiler should not have any problems with them however. -4. 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. @@ -319,6 +299,9 @@ Notes: - 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.