From cb13240d72026f712481a2e66b9fa2258fae64f1 Mon Sep 17 00:00:00 2001 From: nhmall Date: Sat, 3 Oct 2026 07:33:12 -0400 Subject: [PATCH] reinstate the README.md from this feature branch --- README | 153 ------------------------------------------------------ README.md | 73 ++++++++++++++++++++++++++ 2 files changed, 73 insertions(+), 153 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index e9a661da08..0000000000 --- a/README +++ /dev/null @@ -1,153 +0,0 @@ - NetHack 5.0.1 -- General information - - -NetHack 5.0 is an enhancement to the dungeon exploration game NetHack, -which is a distant descendent of Rogue and Hack, and a direct descendent -of NetHack 3.6. - -NetHack 5.0.1 work-in-progress is not a release of NetHack. It consists -primarily of bug fixes for 5.0.0 for an upcoming 5.0.1 release. - -The file doc/fixes5-0-1.txt in the source distribution is being updated with -a list of fixes as they are committed. - -Because 5.0.1 work-in-progress is not a release, there are likely to still -be bugs. Please don't treat NetHack-5.0.1 work-in-progress as released code. -Use the most recent NetHack 5.0.0 release if stability is paramount. - -We're making the 5.0.1 work-in-progress available ahead of its release so -that you can observe, test out, and contribute to its continuing development. -Constructive suggestions, GitHub pull requests, and bug reports are all -welcome and encouraged. - - -NetHack 5.0 has made some general architectural improvements to the game or -to its building process. Among them, 5.0 has: - - * The source code is compliant with the C99 standard. - - * removes barriers to building NetHack on one platform and operating system, - for later execution on another (possibly quite different) platform and/or - operating system. That capability is generally known as "cross-compiling." - See the file "Cross-compiling" in the top-level folder for more information - on that. - - * The build-time "yacc and lex"-based level compiler, the - "yacc and lex"-based dungeon compiler, and the quest text file processing - previously done by NetHack's "makedefs" utility, have been replaced with - Lua text alternatives that are loaded and processed by the game during play. - - - - - - - - - - - - - - -Please read items (1), (2) and (3) BEFORE doing anything with your new code. - -1. Unpack the code in a dedicated new directory. We will refer to that - directory as the 'Top' directory. It makes no difference what you - call it. - -2. 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 - against this list to make sure that you have a complete set. - - 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 - with the terms of that license, and we are very serious about it. - -4. If you are attempting to build NetHack on one platform/processor, to - produce a game on a different platform/processor it may behoove you to - read the file "Cross-compiling" in your Top directory. - -5. 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 - that the default configuration is SysV/Sun/Solaris2.x (simply because - the code was housed on such a system). - - The files sys/*/Install.*, or sys/*/NewInstall.* were written to guide - you in configuring the program for your operating system. The files - win/*/Install.* are available, where necessary, to help you in - configuring the program for particular windowing environments. - Reading them, and the man pages, should answer most of your questions. - - - At the time of the most recent official release, NetHack 5.0, it had - been tested to run and/or compile on: - - Intel Pentium or better running Linux, BSDI - [compiles, runs] - Intel Pentium or better running Windows 10 or 11 - [compiles, runs] - Intel-based, or Apple M1, M2, M3, M4, M5 Macs running - macOS 10.11 (El Capitan) to macOS 26 (Tahoe) - [compiles, runs] - (follow the instructions in sys/unix/NewInstall.unx) - Intel 80386 or greater running MS-DOS with DPMI - [cross-compiles on Linux, runs on MS-DOS, emulator/dosbox] - built via djgpp compiler (native or Linux-hosted cross-compiler) - AmigaOS 3.0 or later - [cross-compiles on Linux or macOS, runs on Amiga or emulator] - Running requires Kickstart 39+ - 6 MB free RAM minimum (8 MB recommended) - Hard drive with ~5 MB free space - - There has also been some success runing/comiling on: - OpenVMS (aka VMS) V8.4 on Alpha and on Integrity/Itanium/IA64 - OpenVMS (ask VMS) V9.2-3 on x86-64 - - - - - - - - - - - - - - -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: - https://www.nethack.org/common/contact.html -Please include the version information from #version or the command line -option --version in the appropriate field. - -A public repository of the latest NetHack code that we've made -available can be obtained via git here: - https://github.com/NetHack/NetHack - or - https://sourceforge.net/p/nethack/NetHack/ - -When sending correspondence, please observe the following: -o Please be sure to include your machine type, OS, and patchlevel. -o Please avoid sending us binary files (e.g. save files or bones files). - If you have found a bug and think that your save file would aid in solving - the problem, send us a description in words of the problem, your machine - type, your operating system, and the version of NetHack. Tell us that you - have a save file, but do not actually send it. - You may then 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 - time before you receive feedback. This is especially true during the - period immediately after a new release, when we get the most bug reports. -o We don't give hints for playing the game. -o Don't bother to ask when the next version will be out or you can expect - to receive a stock answer. - -If you want to submit a patch for the NetHack source code via email directly, -you can direct it to this address: - nethack-bugs (at) nethack.org - -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. - -All of this amounts to the following: If you decide to apply a free-lanced -patch to your NetHack 5.0 code, you are welcome to do so, of course, but we -won't 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 -- - -# $NHDT-Date: 1779926755 2026/05/28 00:05:55 $ $NHDT-Branch: NetHack-5.0 $:$NHDT-Revision: 1.113 $ -# Copyright (c) 2012 by Michael Allison -# NetHack may be freely redistributed. See license for details. diff --git a/README.md b/README.md new file mode 100644 index 0000000000..9e63e6e488 --- /dev/null +++ b/README.md @@ -0,0 +1,73 @@ +# NetHack 5.0 on m68k — work in progress + +This is a feature branch of [NetHack 5.0](https://www.nethack.org) collecting +revival work for the classic m68k ports (Amiga, Atari ST/TT/Falcon (GEM) and 68k +Macintosh) against the current NetHack-5.0 codebase. The Amiga and Atari ports +were retired in 3.6 and have been catching up to the windowport, save-file, and +Lua level changes that landed since. + +This is where new commits land before being proposed for merge into +`NetHack-5.0`. If you're a player or porter with m68k hardware: I need your +feedback, you can find links to the latest work-in-progress builds below. + +## Ports in this branch + +### Amiga +**Stable** — part of the official NetHack 5.0 tree. This branch carries any +incremental fixes that should be folded back upstream alongside the Atari and +Mac work. + +### Atari ST / TT / Falcon (GEM) +**Feature complete** — cross-compiled from Linux against +[E_GEM 2.2](https://github.com/ingpaschke/EGEM_220), runs under TOS 2.06+, +EmuTOS 1.3.x / 1.4, MagiC 6.2, FreeMiNT (XaAES). Tile mode, ASCII mode, +direct-color graphics at 16/24/32 bpp, resizable map window with tracking +status/message panes. See [`sys/atari/README.tos`](sys/atari/README.tos) and +[`sys/atari/README.Crosscompiling`](sys/atari/README.Crosscompiling). + +### 68k Macintosh (Classic Mac OS) +**Feature complete** — the legacy Macintosh port revived against NetHack 5.0, +cross-compiled from Linux with [Retro68](https://github.com/autc04/Retro68). +Targets the classic Toolbox windowport on System 7 and should run on any +68020-or-later Macintosh with at least 8 MB of RAM -- ASCII on black & white +screens, tile mode in 256/16 colors on color-capable machines. Resizable map +window with in-game tile/ASCII switching, MENUCOLOR, and a bundled +crash-recovery application. See +[`sys/mac68k/ReadMe.txt`](sys/mac68k/ReadMe.txt) for players and +[`sys/mac68k/BUILD.md`](sys/mac68k/BUILD.md) for building. + +## Try it now + +Pre-built binaries can be found in my fork: + +- **Atari (5.0 WIP)**: +- **68k Mac (5.0)**: + +Builds are tagged WIP and refreshed when fixes land. + +## Building from source + +See [`sys/atari/README.Crosscompiling`](sys/atari/README.Crosscompiling) for +the Atari ST port and [`sys/mac68k/BUILD.md`](sys/mac68k/BUILD.md) for the 68k +Macintosh port. + +## Help wanted + +If you have time and m68k hardware (or a configured emulator): + +- **Atari testers on real hardware** — most useful on TT, Falcon, and + Mega ST + accelerator/graphics card setups. Bug reports with reproducer steps and + hardware/emulator details are gold. +- **MagiC and FreeMiNT users** I regularly test on MagiC on Linux and Magic 6.2 + on Macintosh myself. Feedback from running on FreeMint would be welcome. +- **Alternate VDI drivers** — NVDI, fVDI, and unusual direct-color screens are + supported, but of course I couldn't test all combinations out there. +- **Mac testers** + +Open issues on [My NetHack fork](https://github.com/ingpaschke/NetHack/issues) +or send patches against this branch. + +## Maintainer + +Ingo Paschke ([@ingpaschke](https://github.com/ingpaschke), +) — Atari, Amiga, and 68k Macintosh ports.