README

   1          NetHack 3.6.6 -- General information March 2020
   2
   3 NetHack 3.6 is an enhancement to the dungeon exploration game NetHack,
   4 which is a distant descendent of Rogue and Hack, and a direct descendent of
   5 NetHack 3.4 as there was no NetHack 3.5 release.
   6
   7 NetHack 3.6.6 is the official release of NetHack that follows NetHack 3.6.5
   8 and contains bug fixes since 3.6.5, including a security fix that affected
   9 versions 3.6.1, 3.6.2, 3.6.3, 3.6.4 and 3.6.5.
  10
  11 The file doc/fixes36.6 in the source distribution has a full list of fixes.
  12 The text in there was written for the development team's own use and is
  13 provided "as is", so please do not ask us to further explain the entries in
  14 that file.  Some entries might be considered "spoilers", particularly in the
  15 "new features" section.
  16
  17 Below you will find some other general notes that were not considered
  18 spoilers:
  19
  20  *  invalid status highlight color could be maliciously used to corrupt memory
  21  *  formatting corpse names used internal buffers differently from formatting
  22  *      other objects and could potentially clobber memory
  23  *  avoid divide by 0 crash if 'bogusmon' (file of bogus monster types) is empty
  24  *  avoid #wizrumorcheck crash if either 'rumors.tru' or 'rumors.fal' or both
  25  *      were empty when makedefs built 'rumors'
  26
  27                         - - - - - - - - - - -
  28
  29 Please read items (1), (2) and (3) BEFORE doing anything with your new code.
  30
  31 1.  Unpack the code in a dedicated new directory.  We will refer to that
  32     directory as the 'Top' directory.  It makes no difference what you
  33     call it.
  34
  35 2.  Having unpacked, you should have a file called 'Files' in your Top
  36     directory.
  37
  38     This file contains the list of all the files you now SHOULD
  39     have in each directory.  Please check the files in each directory
  40     against this list to make sure that you have a complete set.
  41
  42     This file also contains a list of what files are created during
  43     the build process.
  44
  45     The names of the directories listed should not be changed unless you
  46     are ready to go through the makefiles and the makedefs program and change
  47     all the directory references in them.
  48
  49 3.  Before you do anything else, please read carefully the file called
  50     "license" in the 'dat' subdirectory.  It is expected that you comply
  51     with the terms of that license, and we are very serious about it.
  52
  53 4.  If everything is in order, you can now turn to trying to get the program
  54     to compile and run on your particular system.  It is worth mentioning
  55     that the default configuration is SysV/Sun/Solaris2.x (simply because
  56     the code was housed on such a system).
  57
  58     The files sys/*/Install.* were written to guide you in configuring the
  59     program for your operating system.  The files win/*/Install.* are
  60     available, where necessary, to help you in configuring the program
  61     for particular windowing environments.  Reading them, and the man pages,
  62     should answer most of your questions.
  63
  64     At the time of this release, NetHack 3.6 has been tested to run/compile
  65     on:
  66
  67         Intel Pentium or better (or clone) running Linux, BSDI, or
  68                 Windows (7 through 10)
  69         Intel 80386 or greater (or clone) boxes running Linux, or BSDI
  70         Mac OS X 10.11 (follow the instructions in sys/unix, not sys/mac)
  71         OpenVMS (aka VMS) V8.4 on Alpha and on Integrity/Itanium/IA64
  72
  73     Instructions have been provided by way of community contribution on:
  74         msdos protected mode using djgpp
  75
  76     Previous versions of NetHack were tested and known to run on the
  77     following systems, but it is unknown if they can still build and
  78     execute NetHack 3.6:
  79
  80         Apple Macintosh running MacOS 7.5 or higher, LinuxPPC, BeOS 4.0
  81         Atari ST/TT/Falcon running TOS (or MultiTOS) with GCC
  82         AT&T 3B1 running System V (3.51)
  83         AT&T 3B2/600 & 3B2/622 running System V R3.2.1
  84         AT&T 3B2/1000 Model 80 running System V R3.2.2
  85         AT&T 3B4000 running System V
  86         AT&T 6386 running System V R3.2
  87         Commodore Amiga running AmigaDOS 3.0 or higher with SAS/C 6.x
  88                 (but see Makefile.ami about DICE and Manx)
  89         Data General AViiON systems running DG/UX
  90         DEC Alpha/VMS (aka OpenVMS AXP), running V1.x through V7.1
  91         DEC VAX/VMS, running V4.6 through V7.1
  92         DEC vaxen running BSD, Ultrix
  93         Decstations running Ultrix 3.1, 4.x
  94         Encore Multimax running UMAX 4.2
  95         Gould NP1 running UTX 3/2
  96         HP 9000s300 running HP-UX
  97         HP 9000s700 running HP-UX 9.x, 10.x, 11.x
  98         H/PC Pro devices running Windows CE 2.11 and higher.
  99         IBM PC/RT and RS/6000 running AIX 3.x
 100         IBM PS/2 and AT compatibles running OS/2 - 2.0 and up with GCC emx
 101         IBM PS/2 and AT compatibles running OS/2 1.1 - 2.0 (and probably
 102            Warp) with Microsoft 6.0, and OS/2 2.0 and up with IBM CSet++ 2.0.
 103         Intel 80386 or greater (or clone) running 386BSD
 104         Intel 80386 or greater (or clone) boxes running MS-DOS with DPMI.
 105         Intel x86 running a version of Windows prior to XP.
 106         Mips M2000 running RiscOS 4.1
 107         NeXT running Mach (using BSD configuration)
 108         Palm Size PC 1.1 devices running Windows CE 2.11
 109         Pocket PC devices running Windows CE 3.0 and higher
 110         Pyramid 9820x running OSx 4.4c
 111         SGI Iris running IRIX
 112         Stardent Vistra 800 running SysV R4.0
 113         Stride 460 running UniStride 2.1
 114         Sun-3s, -4s, and -386is running SunOS 3.x
 115         Sun-3s and -386is running SunOS 4.x
 116         Sun SPARC based machine running SunOS 4.x, Solaris 2.x, or Solaris 7
 117         Valid Logic Systems SCALD-System
 118
 119     Previous versions, using a cross-compiler hosted on another platform,
 120     such as  win32, could also build the following from source:
 121         Pocket PC devices running Windows CE 3.0 and higher
 122         H/PC Pro devices running Windows CE 2.11 and higher
 123         Palm Size PC 1.1 devices running Windows CE 2.11
 124
 125     Unless otherwise mentioned, the compiler used was the OS-vendor's
 126     C compiler.
 127
 128                         - - - - - - - - - - -
 129
 130 If you have problems building the game, or you find bugs in it, we recommend
 131 filing a bug report from our "Contact Us" web page at:
 132     https://www.nethack.org/common/contact.html
 133 Please include the version information from #version or the command line
 134 option --version in the appropriate field.
 135
 136 A public repository of the latest NetHack code that we've made
 137 available can be obtained via git here:
 138     https://github.com/NetHack/NetHack
 139       or
 140     https://sourceforge.net/p/nethack/NetHack/
 141
 142 When sending correspondence, please observe the following:
 143 o Please be sure to include your machine type, OS, and patchlevel.
 144 o Please avoid sending us binary files (e.g. save files or bones files).
 145   If you have found a bug and think that your save file would aid in solving
 146   the problem, send us a description in words of the problem, your machine
 147   type, your operating system, and the version of NetHack.  Tell us that you
 148   have a save file, but do not actually send it.
 149   You may then be contacted by a member of the development team with the
 150   address of a specific person to send the save file to.
 151 o Though we make an effort to reply to each bug report, it may take some
 152   time before you receive feedback.  This is especially true during the
 153   period immediately after a new release, when we get the most bug reports.
 154 o We don't give hints for playing the game.
 155 o Don't bother to ask when the next version will be out or you can expect
 156   to receive a stock answer.
 157
 158 If you want to submit a patch for the NetHack source code via email directly,
 159 you can direct it to this address:
 160     nethack-bugs (at) nethack.org
 161
 162 If a feature is not accepted you are free, of course, to post the patches
 163 to the net yourself and let the marketplace decide their worth.
 164
 165 All of this amounts to the following:  If you decide to apply a free-lanced
 166 patch to your 3.6 code, you are welcome to do so, of course, but we won't
 167 be able to provide support or receive bug reports for it.
 168
 169 In our own patches, we will assume that your code is synchronized with ours.
 170
 171                   -- Good luck, and happy Hacking --
 172
 173 # $NHDT-Date: 1583508658 2020/03/06 15:30:58 $ $NHDT-Branch: NetHack-3.6-Mar2020 $:$NHDT-Revision: 1.80 $
 174 # Copyright (c) 2012 by Michael Allison
 175 # NetHack may be freely redistributed.  See license for details.