README

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