fix #H3907 - wrinkled spellbook tile
[aNetHack.git] / README
blob5c4117f46f0b0cb0ac033af098bfbf304c8505e3
1                 NetHack 3.6.1 -- General information
3 NetHack 3.6 is an enhancement to the dungeon exploration game NetHack.
4 It is a distant descendent of Rogue and Hack, and a direct descendent of
5 NetHack 3.4. In order to avoid confusion with interim development code 
6 that was posted online in 2014 by others, there is no NetHack 3.5 release.
8 NetHack 3.6.1 contains several dozen bugfixes.
10 The file doc/fixes36.1 in the source distribution has a full list of each. 
11 The text in there was written for the development team's own use and is 
12 provided "as is", so please do not ask us to further explain the entries 
13 in that file. Some entries might be considered "spoilers", particularly
14 in the "new features" section.
16 Here are some additional general notes that are not considered spoilers:
17  * Some code paths and long-established game features have been made 
18    part of the base build and no longer conditional on compile settings.
19  * Several treasured NetHack community patches, or a variation of 
20    them, have been rolled in to the base NetHack source tree, incuding: 
21    menucolors, pickup thrown, statue glyphs, dungeon overview, sortloot.
23                         - - - - - - - - - - -
25 Please read items (1), (2) and (3) BEFORE doing anything with your new code.
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.
31 2.  Having unpacked, you should have a file called 'Files' in your Top
32     directory.  
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.
38     This file also contains a list of what files are created during 
39     the build process.
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.
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.
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).
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.
60     At the time of this release, NetHack 3.6 has been tested to run/compile
61     on:
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.9
67         OpenVMS (aka VMS) V8.4 on Alpha and on Integrity/Itanium/IA64
69     Previous versions of NetHack were tested and known to run on the 
70     following systems, but it is unknown if they can still build and 
71     execute NetHack 3.6:
73         Apple Macintosh running MacOS 7.5 or higher, LinuxPPC, BeOS 4.0
74         Atari ST/TT/Falcon running TOS (or MultiTOS) with GCC
75         AT&T 3B1 running System V (3.51)
76         AT&T 3B2/600 & 3B2/622 running System V R3.2.1
77         AT&T 3B2/1000 Model 80 running System V R3.2.2
78         AT&T 3B4000 running System V
79         AT&T 6386 running System V R3.2
80         Commodore Amiga running AmigaDOS 3.0 or higher with SAS/C 6.x
81                 (but see Makefile.ami about DICE and Manx)
82         Data General AViiON systems running DG/UX
83         DEC Alpha/VMS (aka OpenVMS AXP), running V1.x through V7.1
84         DEC VAX/VMS, running V4.6 through V7.1
85         DEC vaxen running BSD, Ultrix
86         Decstations running Ultrix 3.1, 4.x
87         Encore Multimax running UMAX 4.2
88         Gould NP1 running UTX 3/2
89         HP 9000s300 running HP-UX
90         HP 9000s700 running HP-UX 9.x, 10.x, 11.x
91         H/PC Pro devices running Windows CE 2.11 and higher.
92         IBM PC/RT and RS/6000 running AIX 3.x
93         IBM PS/2 and AT compatibles running OS/2 - 2.0 and up with GCC emx
94         IBM PS/2 and AT compatibles running OS/2 1.1 - 2.0 (and probably
95            Warp) with Microsoft 6.0, and OS/2 2.0 and up with IBM CSet++ 2.0.
96         Intel 80386 or greater (or clone) running 386BSD
97         Intel 80386 or greater (or clone) boxes running MS-DOS with DPMI.
98         Intel x86 running a version of Windows prior to XP.
99         Mips M2000 running RiscOS 4.1
100         NeXT running Mach (using BSD configuration)
101         Palm Size PC 1.1 devices running Windows CE 2.11
102         Pocket PC devices running Windows CE 3.0 and higher
103         Pyramid 9820x running OSx 4.4c
104         SGI Iris running IRIX
105         Stardent Vistra 800 running SysV R4.0
106         Stride 460 running UniStride 2.1
107         Sun-3s, -4s, and -386is running SunOS 3.x
108         Sun-3s and -386is running SunOS 4.x
109         Sun SPARC based machine running SunOS 4.x, Solaris 2.x, or Solaris 7
110         Valid Logic Systems SCALD-System
112     Previous versions, using a cross-compiler hosted on another platform,
113     such as  win32, could also build the following from source:
114         Pocket PC devices running Windows CE 3.0 and higher
115         H/PC Pro devices running Windows CE 2.11 and higher
116         Palm Size PC 1.1 devices running Windows CE 2.11
118     Unless otherwise mentioned, the compiler used was the OS-vendor's
119     C compiler.
121                         - - - - - - - - - - -
123 If you have problems building the game, or you find bugs in it, we recommend 
124 filing a bug report from our "Contact Us" web page at:
125     http://www.nethack.org/ 
127 A public repository of the latest NetHack code that we've made
128 available can be obtained via git here:
129     https://github.com/NetHack/NetHack
130       or
131     https://sourceforge.net/p/nethack/NetHack/
133 When sending correspondence, please observe the following:
134 o Please be sure to include your machine type, OS, and patchlevel.
135 o Please avoid sending us binary files (e.g. save files or bones files). 
136   If you have found a bug and think that your save file would aid in solving
137   the problem, send us a description in words of the problem, your machine 
138   type, your operating system, and the version of NetHack.  Tell us that you 
139   have a save file, but do not actually send it.
140   You may then be contacted by a member of the development team with the 
141   address of a specific person to send the save file to.
142 o Though we make an effort to reply to each bug report, it may take some
143   time before you receive feedback.  This is especially true during the
144   period immediately after a new release, when we get the most bug reports.
145 o We don't give hints for playing the game.
146 o Don't bother to ask when the next version will be out or you can expect
147   to receive a stock answer.
149 If you want to submit a patch for the NetHack source code via email directly, 
150 you can direct it to this address:
151     nethack-bugs (at) nethack.org
153 If a feature is not accepted you are free, of course, to post the patches 
154 to the net yourself and let the marketplace decide their worth.
156 All of this amounts to the following:  If you decide to apply a free-lanced
157 patch to your 3.6 code, you are welcome to do so, of course, but we won't
158 be able to provide support or receive bug reports for it.  
160 In our own patches, we will assume that your code is synchronized with ours.
162                   -- Good luck, and happy Hacking --