diff --git a/sys/windows/Install.windows b/sys/windows/Install.windows index aa2dad9d9..78fa0bcc3 100644 --- a/sys/windows/Install.windows +++ b/sys/windows/Install.windows @@ -23,7 +23,7 @@ We provide documentation for the follow three different approaches and tool suites that may be used to compile and package NetHack for Windows: - 1. With the Visusal Studio Integrated Development Environment (IDE). + 1. With the Visual Studio Integrated Development Environment (IDE). The steps are documented in sys/windows/build-vs.txt. 2. At the Windows command line, using Visual Studio's nmake.exe. diff --git a/sys/windows/build-msys2.txt b/sys/windows/build-msys2.txt index 419e55cb8..3676b2679 100644 --- a/sys/windows/build-msys2.txt +++ b/sys/windows/build-msys2.txt @@ -1,26 +1,33 @@ -Building NetHack using the Visual Studio IDE +Building NetHack using MSYS2 Prerequisite Requirements: - MSYS2 + o MSYS2 - https://www.msys2.org/ - Download the installer, and start the UCRT64 shell. - then - pacman -S mingw-w64-ucrt-x86_64-gcc - pacman -S git - pacman -S vim (or your editor of choice) - pacman -S man (otherwise "git help foo" will not work) + then + pacman -S mingw-w64-ucrt-x86_64-gcc + pacman -S git + pacman -S vim (or your editor of choice) + pacman -S man (otherwise "git help foo" will not work) + o Lua + NetHack 3.7 for Windows requires 3rd party Lua source that is not part + of the NetHack distribution or repository. - OR + A windows cmd command procedure for fetching prerequisite sources + is available, and can be run as follows from the top of the + NetHack source tree to obtain lua: + sys\windows\fetch.cmd lua + o pdcursesmod (Only required if curses interface support is desired) + If you want to include curses interface support in NetHack 3.7 for + 3rd part pdcursesmod source code is required and is not part of the + NetHack distribution or repository. + + A windows cmd command procedure for fetching prerequisite + sources is available, and can be run as follows from the top of + the NetHack source tree to obtain pdcursesmod: + sys\windows\fetch.cmd pdcursesmod - [the follow is untested] - MinGW-w64 - winlibs standalone build - - https://github.com/brechtsanders/winlibs_mingw - - Download one of the releases from - https://github.com/brechtsanders/winlibs_mingw/releases - and extract the contents into a folder (ideally in a folder - without spaces in the path), and add the location of the - subfolder containing gcc.exe to your PATH. /---------------------------------------------\ | Directories for a Windows NetHack build | @@ -143,5 +150,14 @@ Notes: For Microsoft compiler: make -f Makefile.mingw32 +2. An alternative to MSYS2 may be MinGW-w64 - winlibs standalone build. + That has not been tested by us at time of writing. + MinGW-w64 - winlibs standalone build + - https://github.com/brechtsanders/winlibs_mingw + - Download one of the releases from + https://github.com/brechtsanders/winlibs_mingw/releases + and extract the contents into a folder (ideally in a folder + without spaces in the path), and add the location of the + subfolder containing gcc.exe to your PATH. diff --git a/sys/windows/build-nmake.txt b/sys/windows/build-nmake.txt index b897af33e..507a2ec2f 100644 --- a/sys/windows/build-nmake.txt +++ b/sys/windows/build-nmake.txt @@ -1,7 +1,30 @@ -Building NetHack using the Visual Studio IDE +Building NetHack using the Visual Studio nmake from the command line Prerequisite Requirements: + o Visual Studio Community Edition + A copy of Microsoft Visual Studio Community Edition needs to + be installed on your machine. See: + https://visualstudio.microsoft.com/vs/community/ + o Lua + NetHack 3.7 for Windows requires 3rd party Lua source that is not part + of the NetHack distribution or repository. + + A windows cmd command procedure for fetching prerequisite sources + is available, and can be run as follows from the top of the + NetHack source tree to obtain lua: + sys\windows\fetch.cmd lua + o pdcursesmod (Only required if curses interface support is desired) + If you want to include curses interface support in NetHack 3.7 for + 3rd part pdcursesmod source code is required and is not part of the + NetHack distribution or repository. + + A windows cmd command procedure for fetching prerequisite + sources is available, and can be run as follows from the top of + the NetHack source tree to obtain pdcursesmod: + sys\windows\fetch.cmd pdcursesmod + + A copy of Microsoft Visual Studio Community Edition needs to be installed on your machine, and the Lua prerequisite source files are required as outlined in sys/windows/Install.windows. @@ -39,28 +62,6 @@ You can use one of the following build environments: | Visual Studio Community Editions | \-----------------------------------------------------------/ -Required components that are not bundled in the NetHack repository, but -are required to build NetHack yourself. - -Lua - NetHack 3.7 for Windows requires 3rd party Lua source that is not part - of the NetHack distribution or repository. - - A windows cmd command procedure for fetching prerequisite - sources is available, and can be run as follows from the top of - the NetHack source tree to obtain lua: - sys\windows\fetch.cmd lua - -Curses - If you want to include curses interface support in NetHack 3.7 for - 3rd part pdcursesmod source code is required and is not part of the - NetHack distribution or repository. - - A windows cmd command procedure for fetching prerequisite - sources is available, and can be run as follows from the top of - the NetHack source tree to obtain pdcursesmod: - sys\windows\fetch.cmd pdcursesmod - Building Two different versions of NetHack will be built for Windows from the diff --git a/sys/windows/build-vs.txt b/sys/windows/build-vs.txt index 1d7ee0872..bd87cfc6a 100644 --- a/sys/windows/build-vs.txt +++ b/sys/windows/build-vs.txt @@ -2,16 +2,35 @@ Building NetHack using the Visual Studio IDE Prerequisite Requirements: -A copy of Microsoft Visual Studio Community Edition needs to -be installed on your machine, and the Lua prerequisite source -files are required as outlined in sys/windows/Install.windows. + o Visual Studio Community Edition + A copy of Microsoft Visual Studio Community Edition needs to + be installed on your machine. See: + https://visualstudio.microsoft.com/vs/community/ + o Lua + NetHack 3.7 for Windows requires 3rd party Lua source that is not part + of the NetHack distribution or repository. -The nmake build Makefiles and procedures produce two executable + A windows cmd command procedure for fetching prerequisite sources + is available, and can be run as follows from the top of the + NetHack source tree to obtain lua: + sys\windows\fetch.cmd lua + o pdcursesmod (Only required if curses interface support is desired) + If you want to include curses interface support in NetHack 3.7 for + 3rd part pdcursesmod source code is required and is not part of the + NetHack distribution or repository. + + A windows cmd command procedure for fetching prerequisite + sources is available, and can be run as follows from the top of + the NetHack source tree to obtain pdcursesmod: + sys\windows\fetch.cmd pdcursesmod + +This processes produces a zip file containing two executable versions: a. A TTY and curses version of NetHack in nethack.exe b. A Windows and curses graphical version in nethackw.exe. + /---------------------------------------------\ | Directories for a Windows NetHack build | \---------------------------------------------/