nethack-gwaa-kiwi/nethack
1
0
Fork 0
Code Pull Requests Activity

strip some outdated info from sys/windows/porthelp

Browse Source
This commit is contained in:
nhmall
2025-08-19 20:37:43 -04:00
parent 16c723f0be
commit ab26a2e851
1 changed files with 75 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files
sys/windows/porthelp
+75 -106
View File
@@ -1,38 +1,35 @@
Microsoft Windows specific help file for NetHack 3.7 Microsoft Windows specific help file for NetHack 3.7
Copyright (c) NetHack PC Development Team 1993-2020. Copyright (c) NetHack PC Development Team 1993-2025.
NetHack may be freely distributed. See license for details. NetHack may be freely distributed. See license for details.
(Last Revision: August 8, 2020) (Last Revision: August 19, 2025)
This file details specifics for NetHack built for Windows 95, 98, NT, This file details some specifics for NetHack built for Windows.
Me, 2000, and XP. Users of really early 16-bit Windows versions should
use the MSDOS NetHack.
Please note that "NetHack for Windows - Graphical Interface" requires New players should be sure to read GuideBook.txt which contains
an installation of Internet Explorer 4 or an installation of
version 4.71 of the common controls. See the following internet page:
http://www.nethack.org/v340/ports/download-win.html#cc
for more information. If the game runs for you, you are not affected.
New players should be sure to read GuideBook.txt which contains
essential information about playing NetHack. It can be found in the essential information about playing NetHack. It can be found in the
same directory as your NetHack executable. same directory as your NetHack executable.
The NetHack for Windows port supports some additional or enhanced The NetHack for Windows port supports some additional or enhanced
commands as well as some defaults.nh file options specific to commands as well as some NetHack config file options.
configuration choices used during the building of NetHack for
Windows. Listed below are those commands and defaults.nh file
options.
Some options are applicable only to the "Graphical Interface." The active NetHack config file is stored in the nethack subfolder of the
These are discussed separately in their own section. user's User Profile Folder. The config file can be referenced
in the legacy CMD command prompt as:
%USERPROFILE%\nethack\.nethackrc
Under powershell, the User's config file can be referenced
as:
$env:USERPROFILE\nethack\.nethackrc
Some options are applicable only to the "Graphical Interface."
These are discussed separately in their own section.
Contents Contents
1. ALT Key Combinations 1. ALT Key Combinations
2. Boolean options - Option that you can toggle on or off 2. Graphical Interface - Options you can assign a value to
3. Graphical Interface - Options you can assign a value to 3. Graphical Interface - Additional/Enhanced Commands
4. Graphical Interface - Additional/Enhanced Commands 4. Graphical Interface - Menus
5. Graphical Interface - Menus 5. Numeric Keypad (for number_pad mode)
6. Numeric Keypad (for number_pad mode)
1. ALT Key Combinations 1. ALT Key Combinations
@@ -42,7 +39,7 @@ while the "NetHack for Windows - Graphical Interface" lets you
toggle the mode. In non-NetHack mode, all ALT-key combinations toggle the mode. In non-NetHack mode, all ALT-key combinations
are sent to the Windows itself, rather than to NetHack. are sent to the Windows itself, rather than to NetHack.
While playing in NetHack mode you can press the ALT key in While playing in NetHack mode you can press the ALT key in
combination with another key to execute an extended command combination with another key to execute an extended command
as an alternative method to pressing a # key sequence. as an alternative method to pressing a # key sequence.
The available commands are: The available commands are:
@@ -57,7 +54,7 @@ The available commands are:
Alt-i #invoke - invoke an object's powers. Alt-i #invoke - invoke an object's powers.
Alt-j #jump - jump to a location. Alt-j #jump - jump to a location.
Alt-l #loot - loot a box on the floor. Alt-l #loot - loot a box on the floor.
Alt-m #monster - use a monster's special ability. Alt-m #monster - use a monster's special ability.
Alt-n #name - name an item or type of object. Alt-n #name - name an item or type of object.
Alt-o #offer - offer a sacrifice to the gods. Alt-o #offer - offer a sacrifice to the gods.
Alt-p #pray - pray to the gods for help. Alt-p #pray - pray to the gods for help.
@@ -71,41 +68,14 @@ The available commands are:
Alt-w #wipe - wipe off your face. Alt-w #wipe - wipe off your face.
Alt-? #? - display list of extended menu commands Alt-? #? - display list of extended menu commands
2. Boolean Options (Options that can be toggled on or off) 2. Options that you assign a value to (Graphical Interface only)
----------------------------------------------------------
Listed here are any options not discussed in the main help, options
which may be slightly different from the main help file, and options
which may need a slightly more explanatory note:
color Use color when displaying non-tiled maps. Tiled
maps (available in the graphical port) are always
rendered in color. Default: [TRUE]
hilite_pet Using tiled graphics, displays a small heart symbol
next to your pet. Using ascii graphics, the pet is
hilited in a white background.
Default: [TRUE]
IBMgraphics Use IBM extended characters for the dungeon
Default: [TRUE]
msg_window When ^P is pressed, it shows menu in a full window.
Available only in the non-graphical (tty) version.
Default: [FALSE]
toptenwin Write top ten list to a window, as opposed to stdout.
Default in tty interface: [FALSE]
Default in graphical interface: [TRUE] (and cannot be changed)
3. Options that you assign a value to (Graphical Interface only)
---------------------------------------------------------------- ----------------------------------------------------------------
"NetHack for Windows - Graphical Interface" recognizes the following "NetHack for Windows - Graphical Interface" recognizes the following
additional options, which the non-graphical (tty) version will additional options, which the non-graphical (tty) version will
silently ignore. These are options that specify attributes of various silently ignore. These are options that specify attributes of various
windows. The windows that you can tailor include menu windows (such windows. The windows that you can tailor include menu windows (such
as the inventory list), text windows (such as "It is written in the as the inventory list), text windows (such as "It is written in the
book of ..." screens), the message window (where events of the game are book of ..." screens), the message window (where events of the game are
displayed), the status window (where your character name displayed), the status window (where your character name
and attributes are displayed), and the map window (where the map and attributes are displayed), and the map window (where the map
@@ -113,47 +83,47 @@ is drawn).
Window Alignment options: Window Alignment options:
align_message Specifies at which side of the NetHack screen the align_message Specifies at which side of the NetHack screen the
message window is aligned. This option can be used message window is aligned. This option can be used
to align the window to "top" or "bottom". to align the window to "top" or "bottom".
Default: [TOP] Default: [TOP]
align_status Specifies at which side of the NetHack screen the align_status Specifies at which side of the NetHack screen the
status window is aligned. This option can be used status window is aligned. This option can be used
to align the window to "top" or "bottom". to align the window to "top" or "bottom".
Default: [BOTTOM] Default: [BOTTOM]
Map Window options: Map Window options:
map_mode Specifies which map mode to use. map_mode Specifies which map mode to use.
The following map modes are available: The following map modes are available:
tiles (display things on the map with colored tiles), tiles (display things on the map with colored tiles),
ascii4x6, ascii6x8, ascii8x8, ascii16x8, ascii7x12, ascii4x6, ascii6x8, ascii8x8, ascii16x8, ascii7x12,
ascii8x12, ascii16x12, ascii12x16, ascii10x18 ascii8x12, ascii16x12, ascii12x16, ascii10x18
(which use that size font to display things on (which use that size font to display things on
the map), or fit_to_screen (an ascii mode which the map), or fit_to_screen (an ascii mode which
forces things to fit on a single screen). forces things to fit on a single screen).
Default: [tiles] Default: [tiles]
scroll_margin Specifies the number of map cells from the edge scroll_margin Specifies the number of map cells from the edge
of the map window where scrolling will take place. of the map window where scrolling will take place.
Default: [5] Default: [5]
tile_file An alternative file containing bitmap to use for tile_file An alternative file containing bitmap to use for
tiles. This file should be a .bmp file and should tiles. This file should be a .bmp file and should
be organized as 40 rectangular tiles wide. It is be organized as 40 rectangular tiles wide. It is
beyond the scope of this document to describe the beyond the scope of this document to describe the
exact contents of each tile in the .bmp, which must exact contents of each tile in the .bmp, which must
match the object lists used when building NetHack. match the object lists used when building NetHack.
tile_height Used with tile_file to specify the height of each tile_height Used with tile_file to specify the height of each
tile in pixels. This option may only be specified tile in pixels. This option may only be specified
in the defaults.nh config file. in the defaults.nh config file.
Default: [16] Default: [16]
tile_width Used with tile_file to specify the width of each tile_width Used with tile_file to specify the width of each
tile in pixels. This option may only be specified tile in pixels. This option may only be specified
in the defaults.nh config file. in the defaults.nh config file.
Default: [16] Default: [16]
Other Window options: Other Window options:
@@ -177,12 +147,12 @@ Other Window options:
cyan, gray (or grey), orange, brightgreen, cyan, gray (or grey), orange, brightgreen,
yellow, brightblue, brightmagenta, brightcyan, yellow, brightblue, brightmagenta, brightcyan,
white, trueblack, purple, silver, maroon, fuchsia, white, trueblack, purple, silver, maroon, fuchsia,
lime, olive, navy, teal, aqua. In addition, you lime, olive, navy, teal, aqua. In addition, you
can use the following names to refer to default can use the following names to refer to default
Windows settings: activeborder, activecaption, Windows settings: activeborder, activecaption, \
appworkspace, background, btnface, btnshadow, btntext, appworkspace, background, btnface, btnshadow, btntext,
captiontext, graytext, highlight, highlighttext, captiontext, graytext, highlight, highlighttext,
inactiveborder, inactivecaption, menu, menutext, inactiveborder, inactivecaption, menu, menutext,
scrollbar, window, windowframe, windowtext. scrollbar, window, windowframe, windowtext.
Example: Example:
@@ -203,56 +173,56 @@ Other Window options:
font_size_text Specifies the size of the text font. font_size_text Specifies the size of the text font.
Miscellaneous options: Miscellaneous options:
vary_msgcount Number of lines to display in message window. vary_msgcount Number of lines to display in message window.
4. NetHack for Windows - Graphical Interface, Additional/Enhanced Commands 3. NetHack for Windows - Graphical Interface, Additional/Enhanced Commands
------------------------------------------------------------------------- -------------------------------------------------------------------------
The following function keys are active in The following function keys are active in
the "NetHack for Windows - Graphical Interface": the "NetHack for Windows - Graphical Interface":
F4 Toggle level overview mode on/off F4 Toggle level overview mode on/off
This key will toggle the map between a view that This key will toggle the map between a view that
is mapped to fit exactly to the window, and the is mapped to fit exactly to the window, and the
view that shows the various symbols in their view that shows the various symbols in their
normal size. This is useful for getting an idea normal size. This is useful for getting an idea
of where you are in a level. of where you are in a level.
F5 Toggle tiled display on/off. F5 Toggle tiled display on/off.
This key switches between the tiled and the This key switches between the tiled and the
traditional ASCII display. This is equivalent to traditional ASCII display. This is equivalent to
using the "map_mode" option. using the "map_mode" option.
F10 Activate menu bar. F10 Activate menu bar.
This key will activate the menu bar, allowing you This key will activate the menu bar, allowing you
to select between the menus: File, Map, to select between the menus: File, Map,
Window Settings, and Help. Window Settings, and Help.
5. Graphical Port Menus 4. Graphical Port Menus
----------------------- -----------------------
File File
Save - Allows you to save and exit the game Save - Allows you to save and exit the game
Quit - Allows you to quit the game Quit - Allows you to quit the game
Map - Provides for selection of map mode. Equivalent to using Map - Provides for selection of map mode. Equivalent to using
the map_mode option. the map_mode option.
Window Settings - Changes your logged-on user's settings for NetHack. Window Settings - Changes your logged-on user's settings for NetHack.
In 3.5.0, only one setting is available: NetHack mode, which can be Only one setting is available: NetHack mode, which can be
checked or unchecked. NetHack mode allows you to use the ALT key for checked or unchecked. NetHack mode allows you to use the ALT key for
game key commands [see list above]. You can use F10 to access the game key commands [see list above]. You can use F10 to access the
menu bar while in NetHack mode. You can also clear your logged-on menu bar while in NetHack mode. You can also clear your logged-on
user's settings for NetHack. Settings in this window are saved in user's settings for NetHack. Settings in this window are saved in
your logged-on user's registry. your logged-on user's registry.
Help - Provides help about various portions of NetHack. Help - Provides help about various portions of NetHack.
6. Numeric Keypad (for "OPTION=number_pad" mode) 5. Numeric Keypad (for "OPTION=number_pad" mode)
------------------------------------------------ ------------------------------------------------
The numeric keypad and surrounding characters act as macros for different The numeric keypad and surrounding characters act as macros for different
@@ -297,4 +267,3 @@ most of these keys:
Ctrl-Shift-PgDn (3) Scroll (Pan) map left to lowermost corner Ctrl-Shift-PgDn (3) Scroll (Pan) map left to lowermost corner