1 NetHack 3.3.1 -- General information
2
3NetHack 3.3.1 is an enhancement to the dungeon exploration game NetHack.
4It is a distant descendent of Rogue and Hack, and a direct descendent of
5NetHack 3.2 and 3.3.0. This version is primarily a bug fix release.
6
7Here is a brief overview of new additions and changes in the game.
8To give more would be cheating, wouldn't it?
9
10o Many, many bug fixes and minor tweaks
11o New warning system that is more pleasant than the old one
12o The Amiga and Atari ports are resurrected
13o The Gnome toolkit interface is now offered as an experimental option
14
15 Falcon's Eye 1.9.3 -- General information
16
17Falcon's Eye 1.9.3 is an enhanced, highly graphical window port (user
18interface) for NetHack. Falcon's Eye does not change the content or
19gameplay of NetHack, but adds a lot of 'eye candy' to the game.
20Here's a brief list of features:
21
22o High-res, 256-color isometric graphics with real-time lighting
23o Customizable digitized sound effects
24o Symphonic MIDI soundtrack
25o Mouse-driven interface (keyboard play also works)
26o Interface aids (including autopilot and mouseover identification)
27o Customizable command keys
28o HTML manual
29
30Falcon's Eye is available for DOS, Windows, Linux/Unix and BeOS
31systems. The current release adds BeOS support, fixes some bugs,
32and adds new graphics and features. Please see the Falcon's Eye
33web site at http://www.hut.fi/~jtpelto2/nethack.html for the
34latest news about Falcon's Eye.
35
36-----------------------------------------------------------------------
37NOTICE:
38All the files in this source distribution whose modification dates are
39later than August 10, 2000 have been changed by Jaakko Peltonen. The
40latest changes are on July 3, 2001. Please see the modification dates
41of the individual files for the dates of their latest changes.
42-----------------------------------------------------------------------
43
44 - - - - - - - - - - -
45
46Please read items (1), (2) and (3) BEFORE doing anything with your new code.
47
481. Unpack the code in a dedicated new directory. We will refer to that
49 directory as the 'Top' directory. It makes no difference what you
50 call it.
51
522. If there is no flaw in the packaging, many sub-directories will be
53 automatically created, and files will be deposited in them:
54
55 a. A 'dat' directory, which contains a variety of data files.
56 b. A 'doc' directory, which contains various documentation.
57 c. An 'include' directory, which contains *.h files.
58 d. A 'src' directory, which contains game *.c files used by all versions.
59 e. A 'util' directory, which contains files for utility programs.
60 f. A 'sys' directory, which contains subdirectories for files that
61 are operating-system specific.
62 g. A 'sys/share' subdirectory, which contains files shared by some OSs.
63 h. A 'sys/share/sounds' subsubdirectory, which contains sound files
64 shared by some OSs.
65 i. A 'sys/amiga' subdirectory, which contains files specific to AmigaDOS.
66 j. A 'sys/amiga/splitter' subsubdirectory, which contains files
67 for the Amiga splitter program.
68 k. A 'sys/atari' subdirectory, which contains files specific to TOS.
69 l. A 'sys/be' subdirectory, which contains files specific to Be OS.
70 m. A 'sys/mac' subdirectory, which contains files specific to MacOS.
71 n. A 'sys/mac/old' subdirectory which contains files used by
72 compilers that haven't been tested/used in a while.
73 o. A 'sys/msdos' subdirectory, which contains files specific to MS-DOS.
74 p. A 'sys/msdos/old' subsubdirectory, which contains files for old
75 MS-DOS compilers (no longer officially supported).
76 q. A 'sys/os2' subdirectory, which contains files specific to OS/2.
77 r. A 'sys/unix' subdirectory, which contains files specific to UNIX.
78 s. A 'sys/vms' subdirectory, which contains files specific to VMS.
79 t. A 'sys/winnt' subdirectory, which contains files specific to Windows NT.
80 u. A 'win' directory, which contains subdirectories for files that
81 are windowing-system specific (but not operating-system specific).
82 v. A 'win/share' subdirectory, which contains files shared by some
83 windowing systems.
84 w. A 'win/Qt' subdirectory, which contains files specific to Qt.
85 x. A 'win/X11' subdirectory, which contains files specific to X11.
86 y. A 'win/gem' subdirectory, which contains files specific to GEM.
87 z. A 'win/gnome' subdirectory, which contains files specific to GNOME.
88 A. A 'win/jtp' subdirectory, which contains files specific to Falcon's Eye.
89 B. A 'win/jtp/gamedata' subdirectory, which contains data files specific
90 to Falcon's Eye.
91 C. A 'win/jtp/gamedata/config' subdirectory, which contains config files
92 specific to Falcon's Eye.
93 D. A 'win/jtp/gamedata/graphics' subdirectory, which contains graphics
94 files for Falcon's Eye.
95 E. A 'win/jtp/gamedata/sound' subdirectory, which contains sound and
96 music files for Falcon's Eye.
97 F. A 'win/jtp/gamedata/manual' subdirectory, which contains the game
98 manual files for Falcon's Eye.
99 G. A 'win/tty' subdirectory, which contains files specific to ttys.
100 H. A 'win/win32' subdirectory, which contains files specific to the
101 Windows NT Win32 API.
102
103 The names of these directories should not be changed unless you are
104 ready to go through the makefiles and the makedefs program and change
105 all the directory references in them.
106
1073. Having unpacked, you should have a file called 'Files' in your Top
108 directory. This file contains the list of all the files you now SHOULD
109 have in each directory. Please check the files in each directory
110 against this list to make sure that you have a complete set.
111
1124. Before you do anything else, please read carefully the file called
113 "license" in the 'dat' subdirectory. It is expected that you comply
114 with the terms of that license, and we are very serious about it.
115
1165. If everything is in order, you can now turn to trying to get the program
117 to compile and run on your particular system. It is worth mentioning
118 that the default configuration is SysV/Sun/Solaris2.x (simply because
119 the code was housed on such a system). It is also worth mentioning
120 here that NetHack 3.3 is a huge program. If you intend to run it on a
121 small machine, you'll have to make hard choices among the options
122 available in config.h.
123
124 The files sys/*/Install.* were written to guide you in configuring the
125 program for your operating system. The files win/*/Install.* are
126 available, where necessary, to help you in configuring the program
127 for particular windowing environments. Reading them, and the man pages,
128 should answer most of your questions.
129
130 At the time of this release, NetHack 3.3 is known to run/compile on:
131
132 Apple Macintosh running MacOS 7.5 or higher, LinuxPPC, BeOS 4.0
133 Atari ST/TT/Falcon running TOS (or MultiTOS) with GCC
134 Commodore Amiga running AmigaDOS 3.0 or higher with SAS/C 6.x
135 (but see Makefile.ami about DICE and Manx)
136 DEC Alpha/VMS (aka OpenVMS AXP), running V1.x through V7.0
137 DEC VAX/VMS, running V4.6 through V7.0
138 HP 9000s700 running HP-UX 10.x, 11.x
139 IBM PC compatibles running MS-DOS with Microsoft C, Borland C++ 3.1, or
140 DJGPP. It is recommended to have at least an 80386 processor.
141 IBM PS/2 and AT compatibles running OS/2 - 2.0 and up with GCC emx
142 Intel 80386 or greater (or clone) and DEC Alpha desktop machines
143 running Windows NT
144 Intel 80386 or greater (or clone) boxes running Linux, BSDI, or
145 Windows 95,98,2000
146 Intel Pentium or better (or clone) running BeOS 4.5
147 Sun SPARC based machine running SunOS 4.x, Solaris 2.x, or Solaris 7
148
149 Previous versions of NetHack were tested on the following systems,
150 and we expect that NetHack 3.3 will work on them as well:
151
152 AT&T 3B1 running System V (3.51)
153 AT&T 3B2/600 & 3B2/622 running System V R3.2.1
154 AT&T 3B2/1000 Model 80 running System V R3.2.2
155 AT&T 3B4000 running System V
156 AT&T 6386 running System V R3.2
157 Data General AViiON systems running DG/UX
158 DEC vaxen running BSD, Ultrix
159 Decstations running Ultrix 3.1, 4.x
160 Encore Multimax running UMAX 4.2
161 Gould NP1 running UTX 3/2
162 HP 9000s300 running HP-UX
163 HP 9000s700 running HP-UX 9.x
164 IBM PC/RT and RS/6000 running AIX 3.x
165 IBM PS/2 and AT compatibles running OS/2 1.1 - 2.0 (and probably
166 Warp) with Microsoft 6.0, and OS/2 2.0 and up with IBM CSet++ 2.0.
167 Intel 80386 or greater (or clone) running 386BSD
168 Mips M2000 running RiscOS 4.1
169 NeXT running Mach (using BSD configuration)
170 Pyramid 9820x running OSx 4.4c
171 SGI Iris running IRIX
172 Stardent Vistra 800 running SysV R4.0
173 Stride 460 running UniStride 2.1
174 Sun-3s, -4s, and -386is running SunOS 3.x
175 Sun-3s and -386is running SunOS 4.x
176 Valid Logic Systems SCALD-System
177
178 Unless otherwise mentioned, the compiler used was the OS-vendor's
179 C compiler.
180
181 The Atari and Amiga ports are struggling to stay supported due to a
182 lack of people with machines and time.
183
184 With the demise of Windows NT on the DEC Alpha, no attempt has been
185 made to build NetHack 3.3.1 on that platform.
186
187 A build for Intel 80286 machines and DOS "real mode" overlaid versions
188 has been produced for 3.3.1, with a marginal attempt at tuning it for
189 suitable performance. If someone has access to real-mode compiler and
190 lots of spare time on their hands, you may be able to enhance the
191 performance even further. We don't know how well it runs on a real
192 80286 since we no longer have access to one.
193
194 - - - - - - - - - - -
195
196If you have problems building a version of NetHack with the Falcon's Eye
197window port, or you find bugs in the window port, its developer
198(Jaakko Peltonen) may be reached at
199
200 jaakko.peltonen@hut.fi
201
202In your correspondence, try to include as much information about the
203problem as you can find: for example, your system configuration,
204where and how exactly the problem occurred, what the game's log files
205contain, etc. The more I know about the problem, the more likely I am
206to find a solution. However, please do not send binary files unless
207requested (they fill up a mailbox very quickly).
208
209I also welcome suggestions, critique and questions about the window
210port: if you have ideas, send them in.
211
212If you still have problems building the game, or you find bugs in the
213actual game (instead of Falcon's Eye), the NetHack development team may
214be reached at
215
216 nethack-bugs@nethack.org
217
218When sending correspondence to the NetHack development team, please
219observe the following:
220o Please be sure to include your machine type, OS, and patchlevel.
221o Never send binary files (e.g. save files or bones files) to the
222 nethack-bugs address. Whichever platform you are using, only a small
223 minority of the development team has access to it, and you will rapidly
224 annoy the others. If you have found a bug and think that your save file
225 would aid in solving the problem, send us a description in words of the
226 problem, your machine type, your operating system, and the version of
227 NetHack. Tell us that you have a save file, but do not actually send it.
228 In the rare case that we think your save file would be helpful, you will
229 be contacted by a member of the development team with the address of a
230 specific person to send the save file to.
231o Though we make an effort to reply to each bug report, it may take some
232 time before you receive feedback. This is especially true during the
233 period immediately after a new release, when we get the most bug reports.
234o We don't give hints for playing the game.
235o Don't bother to ask when the next version will be out. You will not get
236 a reply.
237Alternatively, you may fill out the bug report form on our web
238page at www.nethack.org.
239
240Patches especially should be directed to this address. If you've changed
241something to get NetHack to run on your system, it's likely that others have
242done it by making slightly different modifications. By routing your patches
243through the development team, we should be able to avoid making everyone else
244choose among variant patches claiming to do the same thing, to keep most of
245the copies of 3.3 synchronized by means of official patches, and to maintain
246the painfully-created file organization. (This process has been working since
247the time when everyone just posted their own patches to 2.3. At that time,
248there were no archived bug-fixes to give to people who got 2.3 after its initial
249release, so the same bugs kept being discovered by new batches of people.)
250We have been successful in preventing this from happening since the 3.0
251release. Please cooperate to keep this from happening to 3.3.
252
253It is inevitable that we will reject some proposed additions of new features
254either because they do not fit our conception of the game, or because they
255require more code than we consider they're worth. If we reject your feature,
256you are free, of course, to post the patches to the net yourself and let the
257marketplace decide their worth.
258
259All of this amounts to the following: If you decide to apply a free-lanced
260patch to your 3.3 code, you are on your own. In our own patches, we will
261assume that your code is synchronized with ours.
262
263 -- Good luck, and happy Hacking --
264