- Copyright (c) NetHack Development Team 1990-2005
+ Copyright (c) NetHack Development Team 1990-2006
NetHack may be freely redistributed. See license for details.
==============================================================
Instructions for compiling and installing
version. In either case you can use one of the following build
environments:
- o A copy of Microsoft Visual C V6.0 SP3 or later. Things may work with
- an earlier version of the compiler, but the current code has not
- been tested with an earlier version.
+ o A copy of Microsoft Visual C V6.0 SP3 or later, which includes
+ Visual C++ 2005 Express Edition plus the MS Platform SDK.
+ The current code has not been tested with earlier versions.
OR
OR
- o A copy of MinGW 2.0. MinGW is a collection of header files and import
- libraries with which native Windows32 programs can be made; the
- MinGW 2.0 distribution contains the GNU Compiler Collection.
- You can download MinGW at
+ o A copy of MinGW 2.0 or later. MinGW is a collection of header
+ files and import libraries with which native Windows32 programs
+ can be built; the MinGW 2.0 distribution contains the GNU Compiler
+ Collection. You can download MinGW at
http://www.mingw.org/
Earlier versions of MinGW will not allow you to build the Windows
Graphical version.
Visual C's IDE (Integrated Development Environment.)
-FIRST STEP
+/-----------------------------------\
+| FIRST STEP - MOVING THINGS AROUND |
+\-----------------------------------/
The first step in building either version of NetHack is to execute
-sys\winnt\nhsetup.bat.
+sys\winnt\nhsetup.bat to move some files to their required locations.
From the command prompt:
cd sys\winnt
If you wish to build from the command line, proceed to "BUILDING FROM
THE COMMAND LINE."
+
If you wish to build using Visual C's IDE, proceed now to "BUILDING
USING VISUAL C'S IDE."
-
-BUILDING FROM THE COMMAND LINE
+/--------------------------------\
+| BUILDING FROM THE COMMAND LINE |
+\--------------------------------/
You can built two different versions of NetHack for Win32 from the
command line:
We have provided a Makefile for each of the following compilers:
- o Microsoft Visual C++ V6.0 SP3 or greater
+ o Microsoft Visual C++ V6.0 SP3, Visual C++ 2005 w/Platform SDK
o Borland C 5.5.1
o MinGW 2.0 (with GCC 3.2)
Setting Up
-1. It almost goes without saying that you should make sure that your
+1. It almost goes without saying that you should make sure that your
tools are set up and running correctly. That includes ensuring that
all the necessary environment variables for the compiler environment
- are set correctly. (Examples: For the Microsoft compiler by
- executing vcvars32.bat, which is probably in the bin directory of
- your compilers directory tree. For the Borland Makefile, you can
- simply invoke the Make utility from the Makefile's directory (For
- the standard Borland compiler installation you can just use the
- explicit path "c:\borland\bcc55\bin\make /f Makefile.bcc". For the
- GCC Makefile, add <mingw>\bin to your path, where <mingw> is your
- MinGW root directory.)
+ are set correctly. For Visual C++ 6.x, you need to execute
+ vcvars32.bat which is probably in the bin directory of your compilers
+ directory tree. If you are using the Visual C++ 2005 Express Edition,
+ you will need to download and install the MS Platform SDK as well.
+ The Platform SDK is required for building native WIN32 applications,
+ such as this. The two must be integrated to work together. At the
+ time of this writing, there were instructions available from the
+ manufacturer at the following URL:
+ http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/
+
+ For the GCC Makefile, add <mingw>\bin to your path, where <mingw>
+ is your MinGW root directory.).
+
+ For the Borland Makefile, you can simply invoke the Make utility
+ from the Makefile's directory (For the standard Borland compiler
+ installation you can just use the explicit path
+ "c:\borland\bcc55\bin\make /f Makefile.bcc". NetHack 3.5.0 has not
+ yet been tested with the Borland compiler.
+
2. Make sure all the NetHack files are in the appropriate directory
structure. You should have a main directory with subdirectories
To run NetHack, proceed to RUNNING NETHACK.
-
-BUILDING USING VISUAL C'S IDE
+/--------------------------------\
+| BUILDING USING VISUAL C's IDE |
+\--------------------------------/
Only the Win32 native port built on the Windows API, or Graphical
NetHack, can be built using the Visual C IDE.
I. Dispelling the Myths:
Compiling NetHack using the Visual C IDE is straightforward, as long
- as you have your compiler and tools correctly installed.
+ as you have your compiler and tools correctly installed.
It is again assumed that you already changed your directory to
sys\winnt and executed:
1. It almost goes without saying that you should make sure that your
tools are set up and running correctly. (For the Microsoft Visual C
IDE it should correctly fire up when you choose it in your Start |
- Programs menus.)
+ Programs menus.)
+
+ If you are using Visual C++ 2005 Express Edition, you must install
+ both the Visual C++ 2005 Express Edition, and the Platform SDK.
+ They are both freely downloadable at the time of this writing, but
+ be warned that they are very large downloads. After installing the
+ Visual C++ 2005 Express Edition, you will then need to install the
+ Platform SDK and integrate it with Visual C++ 2005 Express Edition
+ in order to be able to build native WIN32 applications. At the time
+ of this writing, there was some assistance on how to integrate the
+ two products at the following URL:
+ http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/
2. Make sure all the NetHack files are in the appropriate directory
structure. You should have a main directory with subdirectories
as explained above. However, the IDE build has full game
functionality and is the officially released build.
- Start the Visual C IDE. In the Visual C IDE menus, choose:
+ Start the Visual C IDE.
+ In the Visual C++ V6.0 IDE menus, choose:
File | Open Workspace
+ In the Visual C++ 2005 Express Edition IDE menus, choose:
+ File | Open Project/Solution
+
4. Set up for the build.
- In the Visual C "Open Workspace" dialog box, navigate to the top of
+ In the Visual C dialog box, navigate to the top of
your NetHack source directory.
- In there, highlight "nethack.dsw" and click on Open.
- Once the workspace has been opened, you should see the following
- list in the Visual C selection window:
- + dgncomp files
- + dgnstuff files
- + dlb_main files
- + levcomp files
- + levstuff files
- + makedefs files
- + nethackw files
- + recover files
- + tile2bmp files
- + tilemap files
- + uudecode files
-
- On the Visual C menus, choose:
+ In there, highlight "nethack.dsw" for Visual C++ 6.0, or
+ "nethack.sln" for Visual C++ Express Edition and click on Open.
+ Once the workspace or solution has been opened, you should see
+ the following list in the Visual C selection left pane:
+ + dgncomp
+ + dgnstuff
+ + dlb_main
+ + levcomp
+ + levstuff
+ + makedefs
+ + nethackw
+ + recover
+ + tile2bmp
+ + tilemap
+ + uudecode
+
+ On the Visual C++ 6.0 menus, choose:
Project | Set Active Project | NetHackW
+ or for Visual C++ 2005 Express Edition, highlight 'nethackw' and
+ select:
+ Project | Set as Startup Project
- On the Visual C menus again, choose either:
+ On the Visual C 6.0 menus again, choose either:
Build | Set Active Configuration | NetHackW - Win32 Release
or
Build | Set Active Configuration | NetHackW - Win32 Debug
+ In Visual C++ 2005 Express Edition, you can just choose "Debug" or
+ "Release" right on the menu in the "solutions configuration" box.
- The first will create the Release build of NetHackW which does not
- contain all the debugging information and is smaller, and runs
- quicker. The second will create the Debug build of NetHackW and
- will spend a lot of time writing debug information to the disk as
- the game is played. Unless you are debugging or enhancing NetHack
- for Windows, choose the Release build.
+ The first Release build of NetHackW which does not contain all the
+ debugging information and is smaller, and runs slightly quicker.
+ The Debug build of NetHackW will spend time writing debug information
+ to the disk as the game is played. Unless you are debugging or
+ enhancing NetHack for Windows, you probably will want to choose the
+ Release build.
Building
all the support files that it needs.
-RUNNING NETHACK
+/-----------------\
+| RUNNING NETHACK |
+\-----------------/
I. Checking the installation:
Make sure all of the support files -- Guidebook.txt, license,
projects / nethack / commitdiff