Updated README
On 3/1/2015 10:37 AM, coppro wrote: > >> Sun SPARC based machine running SunOS 4.x, Solaris 2.x, or > Solaris 7 > > By release time, I should have access to a BSD flavour installed on a SPARC > machine. Would out be helpful for me to do cursory tests? On 3/1/2015 10:41 AM, lorimer wrote: > I have access to a Borland environment too, so I'll be > borrowing that at some point. [Just not soon.] I didn't include the above, just in case they don't happen. The README can, of course, be updated again once they have been tried.
This commit is contained in:
162
README
162
README
@@ -1,18 +1,27 @@
|
|||||||
NetHack 3.5.0 -- General information
|
NetHack 3.6.0 -- General information
|
||||||
|
|
||||||
NetHack 3.5 is an enhancement to the dungeon exploration game NetHack.
|
NetHack 3.6 is an enhancement to the dungeon exploration game NetHack.
|
||||||
It is a distant descendent of Rogue and Hack, and a direct descendent of
|
It is a distant descendent of Rogue and Hack, and a direct descendent of
|
||||||
NetHack 3.4.
|
NetHack 3.4. In order to avoid confusion with interim development code
|
||||||
|
that was posted online in 2014 by others, there is no NetHack 3.5 release.
|
||||||
|
|
||||||
NetHack 3.5.0 has many new features.
|
NetHack 3.6.0 contains some code reorganization, new features, and bugfixes.
|
||||||
* List new features here
|
|
||||||
|
|
||||||
A fuller list of changes for this release can be found in the file
|
The file doc/fixes36.0 in the source disribution has a full list of each.
|
||||||
doc/fixes35.0 in the source distribution. The text in there was written
|
The text in there was written for the development team's own use and is
|
||||||
for the development team's own use and is provided "as is", so please do
|
provided "as is", so please do not ask us to further explain the entries
|
||||||
not ask us to further explain the entries in that file.
|
in that file. Some entries might be considered "spoilers", particularly
|
||||||
|
in the "new features" section.
|
||||||
|
|
||||||
|
Here are some additional general notes that are not considered spoilers:
|
||||||
|
* Some code paths and long-established game features have been made
|
||||||
|
part of the base build and no longer conditional on compile settings.
|
||||||
|
* Save files and bones files should be compatible across platforms and
|
||||||
|
machine architectures.
|
||||||
|
* The following treasured NetHack community patches, or a variation of
|
||||||
|
them, have been rolled in to the base NetHack source tree: menucolors,
|
||||||
|
pickup thrown, statue glyphs, <FIXME>.
|
||||||
|
|
||||||
If you are a developer, please see the file DEVEL/Developer.txt.
|
|
||||||
- - - - - - - - - - -
|
- - - - - - - - - - -
|
||||||
|
|
||||||
Please read items (1), (2) and (3) BEFORE doing anything with your new code.
|
Please read items (1), (2) and (3) BEFORE doing anything with your new code.
|
||||||
@@ -21,64 +30,28 @@ Please read items (1), (2) and (3) BEFORE doing anything with your new code.
|
|||||||
directory as the 'Top' directory. It makes no difference what you
|
directory as the 'Top' directory. It makes no difference what you
|
||||||
call it.
|
call it.
|
||||||
|
|
||||||
2. If there is no flaw in the packaging, many sub-directories will be
|
2. Having unpacked, you should have a file called 'Files' in your Top
|
||||||
automatically created, and files will be deposited in them:
|
directory.
|
||||||
|
|
||||||
a. A 'dat' directory, which contains a variety of data files.
|
This file contains the list of all the files you now SHOULD
|
||||||
b. A 'doc' directory, which contains various documentation.
|
|
||||||
c. An 'include' directory, which contains *.h files.
|
|
||||||
d. A 'src' directory, which contains game *.c files used by all versions.
|
|
||||||
e. A 'util' directory, which contains files for utility programs.
|
|
||||||
f. A 'sys' directory, which contains subdirectories for files that
|
|
||||||
are operating-system specific.
|
|
||||||
g. A 'sys/share' subdirectory, which contains files shared by some OSs.
|
|
||||||
h. A 'sys/share/sounds' subsubdirectory, which contains sound files
|
|
||||||
shared by some OSs.
|
|
||||||
i. A 'sys/amiga' subdirectory, which contains files specific to AmigaDOS.
|
|
||||||
j. A 'sys/atari' subdirectory, which contains files specific to TOS.
|
|
||||||
k. A 'sys/be' subdirectory, which contains files specific to Be OS.
|
|
||||||
l. A 'sys/mac' subdirectory, which contains files specific to MacOS.
|
|
||||||
m. A 'sys/msdos' subdirectory, which contains files specific to MS-DOS.
|
|
||||||
n. A 'sys/os2' subdirectory, which contains files specific to OS/2.
|
|
||||||
o. A 'sys/unix' subdirectory, which contains files specific to UNIX.
|
|
||||||
p. A 'sys/vms' subdirectory, which contains files specific to VMS.
|
|
||||||
q. A 'sys/wince' subdirectory, which contains files specific to Windows CE.
|
|
||||||
r. A 'sys/wince/ceinc' subdirectory; header files for Windows CE
|
|
||||||
s. A 'sys/wince/ceinc/sys' subdirectory; ditto
|
|
||||||
t. A 'sys/winnt' subdirectory, which contains files specific to Windows NT.
|
|
||||||
u. A 'win' directory, which contains subdirectories for files that
|
|
||||||
are windowing-system specific (but not operating-system specific).
|
|
||||||
v. A 'win/share' subdirectory, which contains files shared by some
|
|
||||||
windowing systems.
|
|
||||||
w. A 'win/Qt' subdirectory, which contains files specific to Qt.
|
|
||||||
x. A 'win/X11' subdirectory, which contains files specific to X11.
|
|
||||||
y. A 'win/gem' subdirectory, which contains files specific to GEM.
|
|
||||||
z. A 'win/gnome' subdirectory, which contains files specific to GNOME.
|
|
||||||
A. A 'win/tty' subdirectory, which contains files specific to ttys.
|
|
||||||
B. A 'win/win32' subdirectory, which contains files specific to the
|
|
||||||
Windows Win32 API.
|
|
||||||
C. A 'DEVEL' directory, which contains files for NetHack developers.
|
|
||||||
|
|
||||||
The names of these directories should not be changed unless you are
|
|
||||||
ready to go through the makefiles and the makedefs program and change
|
|
||||||
all the directory references in them.
|
|
||||||
|
|
||||||
3. Having unpacked, you should have a file called 'Files' in your Top
|
|
||||||
directory. This file contains the list of all the files you now SHOULD
|
|
||||||
have in each directory. Please check the files in each directory
|
have in each directory. Please check the files in each directory
|
||||||
against this list to make sure that you have a complete set.
|
against this list to make sure that you have a complete set.
|
||||||
|
|
||||||
4. Before you do anything else, please read carefully the file called
|
This file also contains a list of what files are created during
|
||||||
|
the build process.
|
||||||
|
|
||||||
|
The names of the directories listed should not be changed unless you
|
||||||
|
are ready to go through the makefiles and the makedefs program and change
|
||||||
|
all the directory references in them.
|
||||||
|
|
||||||
|
3. Before you do anything else, please read carefully the file called
|
||||||
"license" in the 'dat' subdirectory. It is expected that you comply
|
"license" in the 'dat' subdirectory. It is expected that you comply
|
||||||
with the terms of that license, and we are very serious about it.
|
with the terms of that license, and we are very serious about it.
|
||||||
|
|
||||||
5. If everything is in order, you can now turn to trying to get the program
|
4. If everything is in order, you can now turn to trying to get the program
|
||||||
to compile and run on your particular system. It is worth mentioning
|
to compile and run on your particular system. It is worth mentioning
|
||||||
that the default configuration is SysV/Sun/Solaris2.x (simply because
|
that the default configuration is SysV/Sun/Solaris2.x (simply because
|
||||||
the code was housed on such a system). It is also worth mentioning
|
the code was housed on such a system).
|
||||||
here that NetHack 3.5 is a huge program. If you intend to run it on a
|
|
||||||
small machine, you'll have to make hard choices among the options
|
|
||||||
available in config.h.
|
|
||||||
|
|
||||||
The files sys/*/Install.* were written to guide you in configuring the
|
The files sys/*/Install.* were written to guide you in configuring the
|
||||||
program for your operating system. The files win/*/Install.* are
|
program for your operating system. The files win/*/Install.* are
|
||||||
@@ -86,21 +59,21 @@ Please read items (1), (2) and (3) BEFORE doing anything with your new code.
|
|||||||
for particular windowing environments. Reading them, and the man pages,
|
for particular windowing environments. Reading them, and the man pages,
|
||||||
should answer most of your questions.
|
should answer most of your questions.
|
||||||
|
|
||||||
At the time of this release, NetHack 3.5 is known to run/compile on:
|
At the time of this release, NetHack 3.6 has been tested to run/compile on:
|
||||||
|
|
||||||
Intel 80386 or greater (or clone) boxes running Linux, BSDI, or
|
Intel Pentium or better (or clone) running Linux, BSDI, or
|
||||||
Windows NT/XP/2000/2003/2008
|
Windows (XP through 8.1)
|
||||||
Intel Pentium or better (or clone) running BeOS 4.5
|
Intel 80386 or greater (or clone) boxes running Linux, or BSDI
|
||||||
Sun SPARC based machine running SunOS 4.x, Solaris 2.x, or Solaris 7
|
Sun SPARC based machine running SunOS 4.x, Solaris 2.x, or Solaris 7
|
||||||
|
Mac OS X 10.9 should be added to the list.
|
||||||
|
|
||||||
|
Previous versions of NetHack were tested and known to run on the
|
||||||
Previous versions of NetHack were tested on the following systems,
|
following systems, but it is unknown if they can still build and
|
||||||
and with a little work we expect that NetHack 3.5 will work on them
|
execute NetHack 3.6:
|
||||||
as well:
|
|
||||||
|
|
||||||
Apple Macintosh running MacOS 7.5 or higher, LinuxPPC, BeOS 4.0
|
Apple Macintosh running MacOS 7.5 or higher, LinuxPPC, BeOS 4.0
|
||||||
Atari ST/TT/Falcon running TOS (or MultiTOS) with GCC
|
Atari ST/TT/Falcon running TOS (or MultiTOS) with GCC
|
||||||
AT&T 3B1 running System V (3.51)
|
AT&T 3B1 running System V (3.61)
|
||||||
AT&T 3B2/600 & 3B2/622 running System V R3.2.1
|
AT&T 3B2/600 & 3B2/622 running System V R3.2.1
|
||||||
AT&T 3B2/1000 Model 80 running System V R3.2.2
|
AT&T 3B2/1000 Model 80 running System V R3.2.2
|
||||||
AT&T 3B4000 running System V
|
AT&T 3B4000 running System V
|
||||||
@@ -116,14 +89,18 @@ Please read items (1), (2) and (3) BEFORE doing anything with your new code.
|
|||||||
Gould NP1 running UTX 3/2
|
Gould NP1 running UTX 3/2
|
||||||
HP 9000s300 running HP-UX
|
HP 9000s300 running HP-UX
|
||||||
HP 9000s700 running HP-UX 9.x, 10.x, 11.x
|
HP 9000s700 running HP-UX 9.x, 10.x, 11.x
|
||||||
|
H/PC Pro devices running Windows CE 2.11 and higher.
|
||||||
IBM PC/RT and RS/6000 running AIX 3.x
|
IBM PC/RT and RS/6000 running AIX 3.x
|
||||||
IBM PS/2 and AT compatibles running OS/2 - 2.0 and up with GCC emx
|
IBM PS/2 and AT compatibles running OS/2 - 2.0 and up with GCC emx
|
||||||
IBM PS/2 and AT compatibles running OS/2 1.1 - 2.0 (and probably
|
IBM PS/2 and AT compatibles running OS/2 1.1 - 2.0 (and probably
|
||||||
Warp) with Microsoft 6.0, and OS/2 2.0 and up with IBM CSet++ 2.0.
|
Warp) with Microsoft 6.0, and OS/2 2.0 and up with IBM CSet++ 2.0.
|
||||||
Intel 80386 or greater (or clone) running 386BSD
|
Intel 80386 or greater (or clone) running 386BSD
|
||||||
Intel 80386 or greater (or clone) boxes running MS-DOS with DPMI.
|
Intel 80386 or greater (or clone) boxes running MS-DOS with DPMI.
|
||||||
|
Intel x86 running version of Windows prior to XP.
|
||||||
Mips M2000 running RiscOS 4.1
|
Mips M2000 running RiscOS 4.1
|
||||||
NeXT running Mach (using BSD configuration)
|
NeXT running Mach (using BSD configuration)
|
||||||
|
Palm Size PC 1.1 devices running Windows CE 2.11
|
||||||
|
Pocket PC devices running Windows CE 3.0 and higher
|
||||||
Pyramid 9820x running OSx 4.4c
|
Pyramid 9820x running OSx 4.4c
|
||||||
SGI Iris running IRIX
|
SGI Iris running IRIX
|
||||||
Stardent Vistra 800 running SysV R4.0
|
Stardent Vistra 800 running SysV R4.0
|
||||||
@@ -135,54 +112,43 @@ Please read items (1), (2) and (3) BEFORE doing anything with your new code.
|
|||||||
Unless otherwise mentioned, the compiler used was the OS-vendor's
|
Unless otherwise mentioned, the compiler used was the OS-vendor's
|
||||||
C compiler.
|
C compiler.
|
||||||
|
|
||||||
NetHack 3.5 may also run on the following, but a cross-compiler hosted
|
|
||||||
on another platform, such as win32, would be required to build from
|
|
||||||
source.
|
|
||||||
|
|
||||||
Pocket PC devices running Windows CE 3.0 and higher
|
|
||||||
H/PC Pro devices running Windows CE 2.11 and higher.
|
|
||||||
Palm Size PC 1.1 devices running Windows CE 2.11
|
|
||||||
|
|
||||||
The sources necessary to build an 80286 DOS "real mode" overlaid version
|
|
||||||
are still included in the source distribution, so if someone has access
|
|
||||||
to a real-mode compiler and lots of spare time on their hands, you may
|
|
||||||
be able to get things working. Of course you do so at your own risk.
|
|
||||||
|
|
||||||
- - - - - - - - - - -
|
- - - - - - - - - - -
|
||||||
|
|
||||||
If you have problems building the game, or you find bugs in it, we recommend
|
If you have problems building the game, or you find bugs in it, we recommend
|
||||||
filing a bug report from our "Contact Us" web page at:
|
filing a bug report from our "Contact Us" web page at:
|
||||||
http://www.nethack.org/
|
http://www.nethack.org/
|
||||||
|
|
||||||
|
A public repository of the latest NetHack code that we've made
|
||||||
|
available can be obtained via git here:
|
||||||
|
<FIXME>
|
||||||
|
|
||||||
When sending correspondence, please observe the following:
|
When sending correspondence, please observe the following:
|
||||||
o Please be sure to include your machine type, OS, and patchlevel.
|
o Please be sure to include your machine type, OS, and patchlevel.
|
||||||
o Never send us binary files (e.g. save files or bones files). Whichever
|
o Please avoid sending us binary files (e.g. save files or bones files).
|
||||||
platform you are using, only a small minority of the development team has
|
If you have found a bug and think that your save file would aid in solving
|
||||||
access to it, and you will rapidly annoy the others. If you have found
|
the problem, send us a description in words of the problem, your machine
|
||||||
a bug and think that your save file would aid in solving the problem,
|
type, your operating system, and the version of NetHack. Tell us that you
|
||||||
send us a description in words of the problem, your machine type, your
|
have a save file, but do not actually send it.
|
||||||
operating system, and the version of NetHack. Tell us that you have a
|
You may then be contacted by a member of the development team with the
|
||||||
save file, but do not actually send it.
|
address of a specific person to send the save file to.
|
||||||
In the rare case that we think your save file would be helpful, you will
|
|
||||||
be contacted by a member of the development team with the address of a
|
|
||||||
specific person to send the save file to.
|
|
||||||
o Though we make an effort to reply to each bug report, it may take some
|
o Though we make an effort to reply to each bug report, it may take some
|
||||||
time before you receive feedback. This is especially true during the
|
time before you receive feedback. This is especially true during the
|
||||||
period immediately after a new release, when we get the most bug reports.
|
period immediately after a new release, when we get the most bug reports.
|
||||||
o We don't give hints for playing the game.
|
o We don't give hints for playing the game.
|
||||||
o Don't bother to ask when the next version will be out. You will not get
|
o Don't bother to ask when the next version will be out, or expect a
|
||||||
a reply.
|
stock answer.
|
||||||
|
|
||||||
If you don't have access to the world wide web, or if you want to submit
|
If you want to submit a patch for the NetHack source code via email directly,
|
||||||
a patch for the NetHack source code via email directly, you can direct it
|
you can direct it to this address:
|
||||||
to this address:
|
|
||||||
nethack-bugs (at) nethack.org
|
nethack-bugs (at) nethack.org
|
||||||
|
|
||||||
If a feature is not accepted you are free, of course, to post the patches
|
If a feature is not accepted you are free, of course, to post the patches
|
||||||
to the net yourself and let the marketplace decide their worth.
|
to the net yourself and let the marketplace decide their worth.
|
||||||
|
|
||||||
All of this amounts to the following: If you decide to apply a free-lanced
|
All of this amounts to the following: If you decide to apply a free-lanced
|
||||||
patch to your 3.5 code, you are on your own. In our own patches, we will
|
patch to your 3.6 code, you are welcome to do so, of course, but we won't
|
||||||
assume that your code is synchronized with ours.
|
be able to provide support or receive bug reports for it.
|
||||||
|
|
||||||
|
In our own patches, we will assume that your code is synchronized with ours.
|
||||||
|
|
||||||
-- Good luck, and happy Hacking --
|
-- Good luck, and happy Hacking --
|
||||||
|
|||||||
Reference in New Issue
Block a user