README

   1                 NetHack 3.6.1 -- General information
   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.1 contains over 470 bug fixes to NetHack 3.6.0. The
   8 file doc/fixes36.1 in the source distribution has a full list of them.
   9 The text in there was written for the development team's own use and is
  10 provided "as is", so please do not ask us to further explain the entries
  11 in that file. Some entries might be considered "spoilers", particularly
  12 in the "new features" section.
  13
  14 Below you will find some other general notes that were not considered
  15 spoilers:
  16 * additional Terry Pratchett tribute passages
  17 * enhanced map position picking
  18 * new status line conditions Stone Strngl Deaf Lev Fly Ride
  19 * updated status hilites and several interface enhancements
  20 * new paranoid_confirm settings
  21 * a new extended command #kick
  22 * the vanquished monsters list can be sorted during end of game disclosure
  23 * fountains are bright blue
  24 * travel accepts 'm' (request menu) prefix
  25 * pressing a or A when cursor positioning shows menu of "interesting" features
  26 * pressing z or Z when cursor positioning can cycle through valid locations
  27 * add option herecmd_menu to make a mouse click on your character pop up a menu
  28 * #adjust's behavior altered when collecting compatible stacks
  29 * Some community patches that were included:
  30     - Malcolm Ryan's improved tin opener
  31     - Ray Chason's MSDOS port support for some VESA modes
  32     - Ray Chason's Qt4 windowport
  33     - Darshan Shaligram's pet ranged attack
  34     - Jason Dorje Short's key rebinding
  35     - Maxime Bacoux's new DUMPLOG
  36 * updated database entries for several things
  37
  38                         - - - - - - - - - - -
  39
  40 Please read items (1), (2) and (3) BEFORE doing anything with your new code.
  41
  42 1.  Unpack the code in a dedicated new directory.  We will refer to that
  43     directory as the 'Top' directory.  It makes no difference what you
  44     call it.
  45
  46 2.  Having unpacked, you should have a file called 'Files' in your Top
  47     directory.
  48
  49     This file contains the list of all the files you now SHOULD
  50     have in each directory.  Please check the files in each directory
  51     against this list to make sure that you have a complete set.
  52
  53     This file also contains a list of what files are created during
  54     the build process.
  55
  56     The names of the directories listed should not be changed unless you
  57     are ready to go through the makefiles and the makedefs program and change
  58     all the directory references in them.
  59
  60 3.  Before you do anything else, please read carefully the file called
  61     "license" in the 'dat' subdirectory.  It is expected that you comply
  62     with the terms of that license, and we are very serious about it.
  63
  64 4.  If everything is in order, you can now turn to trying to get the program
  65     to compile and run on your particular system.  It is worth mentioning
  66     that the default configuration is SysV/Sun/Solaris2.x (simply because
  67     the code was housed on such a system).
  68
  69     The files sys/*/Install.* were written to guide you in configuring the
  70     program for your operating system.  The files win/*/Install.* are
  71     available, where necessary, to help you in configuring the program
  72     for particular windowing environments.  Reading them, and the man pages,
  73     should answer most of your questions.
  74
  75     At the time of this release, NetHack 3.6 has been tested to run/compile
  76     on:
  77
  78         Intel Pentium or better (or clone) running Linux, BSDI, or
  79                 Windows (7 through 10)
  80         Intel 80386 or greater (or clone) boxes running Linux, or BSDI
  81         Mac OS X 10.9
  82         OpenVMS (aka VMS) V8.4 on Alpha and on Integrity/Itanium/IA64
  83
  84     Instructions have been provided by way of community contribution on:
  85         msdos protected mode using djgpp
  86
  87     Previous versions of NetHack were tested and known to run on the
  88     following systems, but it is unknown if they can still build and
  89     execute NetHack 3.6:
  90
  91         Apple Macintosh running MacOS 7.5 or higher, LinuxPPC, BeOS 4.0
  92         Atari ST/TT/Falcon running TOS (or MultiTOS) with GCC
  93         AT&T 3B1 running System V (3.51)
  94         AT&T 3B2/600 & 3B2/622 running System V R3.2.1
  95         AT&T 3B2/1000 Model 80 running System V R3.2.2
  96         AT&T 3B4000 running System V
  97         AT&T 6386 running System V R3.2
  98         Commodore Amiga running AmigaDOS 3.0 or higher with SAS/C 6.x
  99                 (but see Makefile.ami about DICE and Manx)
 100         Data General AViiON systems running DG/UX
 101         DEC Alpha/VMS (aka OpenVMS AXP), running V1.x through V7.1
 102         DEC VAX/VMS, running V4.6 through V7.1
 103         DEC vaxen running BSD, Ultrix
 104         Decstations running Ultrix 3.1, 4.x
 105         Encore Multimax running UMAX 4.2
 106         Gould NP1 running UTX 3/2
 107         HP 9000s300 running HP-UX
 108         HP 9000s700 running HP-UX 9.x, 10.x, 11.x
 109         H/PC Pro devices running Windows CE 2.11 and higher.
 110         IBM PC/RT and RS/6000 running AIX 3.x
 111         IBM PS/2 and AT compatibles running OS/2 - 2.0 and up with GCC emx
 112         IBM PS/2 and AT compatibles running OS/2 1.1 - 2.0 (and probably
 113            Warp) with Microsoft 6.0, and OS/2 2.0 and up with IBM CSet++ 2.0.
 114         Intel 80386 or greater (or clone) running 386BSD
 115         Intel 80386 or greater (or clone) boxes running MS-DOS with DPMI.
 116         Intel x86 running a version of Windows prior to XP.
 117         Mips M2000 running RiscOS 4.1
 118         NeXT running Mach (using BSD configuration)
 119         Palm Size PC 1.1 devices running Windows CE 2.11
 120         Pocket PC devices running Windows CE 3.0 and higher
 121         Pyramid 9820x running OSx 4.4c
 122         SGI Iris running IRIX
 123         Stardent Vistra 800 running SysV R4.0
 124         Stride 460 running UniStride 2.1
 125         Sun-3s, -4s, and -386is running SunOS 3.x
 126         Sun-3s and -386is running SunOS 4.x
 127         Sun SPARC based machine running SunOS 4.x, Solaris 2.x, or Solaris 7
 128         Valid Logic Systems SCALD-System
 129
 130     Previous versions, using a cross-compiler hosted on another platform,
 131     such as  win32, could also build the following from source:
 132         Pocket PC devices running Windows CE 3.0 and higher
 133         H/PC Pro devices running Windows CE 2.11 and higher
 134         Palm Size PC 1.1 devices running Windows CE 2.11
 135
 136     Unless otherwise mentioned, the compiler used was the OS-vendor's
 137     C compiler.
 138
 139                         - - - - - - - - - - -
 140
 141 If you have problems building the game, or you find bugs in it, we recommend
 142 filing a bug report from our "Contact Us" web page at:
 143     https://www.nethack.org/common/contact.html or
 144     http://www.nethack.org/common/contact.html
 145 Please include the version information from #version or the command line
 146 option --version in the apropriate field.
 147
 148 A public repository of the latest NetHack code that we've made
 149 available can be obtained via git here:
 150     https://github.com/NetHack/NetHack
 151       or
 152     https://sourceforge.net/p/nethack/NetHack/
 153
 154 When sending correspondence, please observe the following:
 155 o Please be sure to include your machine type, OS, and patchlevel.
 156 o Please avoid sending us binary files (e.g. save files or bones files).
 157   If you have found a bug and think that your save file would aid in solving
 158   the problem, send us a description in words of the problem, your machine
 159   type, your operating system, and the version of NetHack.  Tell us that you
 160   have a save file, but do not actually send it.
 161   You may then be contacted by a member of the development team with the
 162   address of a specific person to send the save file to.
 163 o Though we make an effort to reply to each bug report, it may take some
 164   time before you receive feedback.  This is especially true during the
 165   period immediately after a new release, when we get the most bug reports.
 166 o We don't give hints for playing the game.
 167 o Don't bother to ask when the next version will be out or you can expect
 168   to receive a stock answer.
 169
 170 If you want to submit a patch for the NetHack source code via email directly,
 171 you can direct it to this address:
 172     nethack-bugs (at) nethack.org
 173
 174 If a feature is not accepted you are free, of course, to post the patches
 175 to the net yourself and let the marketplace decide their worth.
 176
 177 All of this amounts to the following:  If you decide to apply a free-lanced
 178 patch to your 3.6 code, you are welcome to do so, of course, but we won't
 179 be able to provide support or receive bug reports for it.
 180
 181 In our own patches, we will assume that your code is synchronized with ours.
 182
 183                   -- Good luck, and happy Hacking --
 184
 185 # $NHDT-Date: 1524689604 2018/04/25 20:53:24 $ $NHDT-Branch: NetHack-3.6.0 $:$NHDT-Revision: 1.42 $
 186 # Copyright (c) 2012 by Michael Allison
 187 # NetHack may be freely redistributed.  See license for details.