porthelp modifications

- keep boolean and valued option sections together
- be more consistent in use of terms "graphical port"
  and "graphical interface" in the document (use the
  latter where noticed)
- don't mention options available in other ports so
  much since this document is not a general
  document.
- move the numeric keypad stuff to the end. It seems
  to assume number_pad on. So I stated that it does.
  (Many players never play with number_pad on, and
   I'm one of them. I'm not sure of the merit in having
   the section in here at all, since it exists in the
   Guidebook doesn't it?)  How accurate is the text
   that is there if you aren't in number_pad mode?
This commit is contained in:
nethack.allison
2002-03-16 14:41:36 +00:00
parent 16cdae3bd2
commit 006e11f2c1

View File

@@ -1,7 +1,7 @@
Microsoft Windows specific help file for NetHack 3.4.0 Microsoft Windows specific help file for NetHack 3.4.0
Copyright (c) NetHack PC Development Team 1993-2002. Copyright (c) NetHack PC Development Team 1993-2002.
NetHack may be freely distributed. See license for details. NetHack may be freely distributed. See license for details.
(Last Revision: March 10, 2002) (Last Revision: March 16, 2002)
This file details specifics for NetHack built for Windows 95, 98, NT, This file details specifics for NetHack built for Windows 95, 98, NT,
Me, 2000, and XP. Users of really early 16-bit Windows versions should Me, 2000, and XP. Users of really early 16-bit Windows versions should
@@ -17,29 +17,35 @@ 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 Windows port of NetHack 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 defaults.nh file options specific to
configuration choices used during the building of NetHack for configuration choices used during the building of NetHack for
Windows. Listed below are those commands and defaults.nh file Windows. Listed below are those commands and defaults.nh file
options. options.
Some options are applicable only to the graphical port. Some options are applicable only to the "Graphical Interface."
These are discussed separately in their own section. These are discussed separately in their own section.
Contents Contents
1. Available NetHack Mode ALT Key Combinations 1. ALT Key Combinations
2. Boolean options 2. Boolean options - Option that you can toggle on or off
3. Graphical Port Complex options 3. Graphical Interface - Options you can assign a value to
4. Graphical Port Additional/Enhanced Commands 4. Graphical Interface - Additional/Enhanced Commands
5. Graphical Port Menus 5. Graphical Interface - Menus
6. Numeric Keypad (for number_pad mode)
1. Available NetHack Mode ALT Key Combinations
1. ALT Key Combinations
---------------------------------------------- ----------------------------------------------
While playing NetHack under Windows in NetHack mode you can press the The non-graphical (tty) interface always operates in "NetHack mode",
ALT key in combination with another key to execute an extended command while the "NetHack for Windows - Graphical Interface" lets you
as an alternative method to pressing a # key sequence. The non-graphical toggle the mode. In non-NetHack mode, all ALT-key combinations
(tty) version is always running in NetHack mode, but are sent to the Windows itself, rather than to NetHack.
"NetHack for Windows - Graphical Interface" can be toggled:
While playing in NetHack mode you can press the ALT key in
combination with another key to execute an extended command
as an alternative method to pressing a # key sequence.
The available commands are:
Alt-2 #twoweapon - toggle two-weapon combat (unavailable Alt-2 #twoweapon - toggle two-weapon combat (unavailable
if number_pad mode is set) if number_pad mode is set)
@@ -63,9 +69,10 @@ as an alternative method to pressing a # key sequence. The non-graphical
Alt-v #version - list compile time options for this version of Alt-v #version - list compile time options for this version of
NetHack. NetHack.
Alt-w #wipe - wipe off your face. Alt-w #wipe - wipe off your face.
Alt-? #? - display list of extended menu commands
2. Boolean Options 2. Boolean Options (Options that can be toggled on or off)
------------------ ----------------------------------------------------------
Listed here are any options not discussed in the main help, options 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 be slightly different from the main help file, and options
@@ -75,74 +82,69 @@ which may need a slightly more explanatory note:
maps (available in the graphical port) are always maps (available in the graphical port) are always
rendered in color. Default: [TRUE] rendered in color. Default: [TRUE]
IBMgraphics Use IBM extended characters for the dungeon 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] Default: [TRUE]
use_inverse Use inverse color for detection (similar to hilite_pet). IBMgraphics Use IBM extended characters for the dungeon
Default: [FALSE] Default: [TRUE]
msg_window When ^P is pressed, it shows menu in a full window. msg_window When ^P is pressed, it shows menu in a full window.
Available only in the non-graphical (tty) version. Available only in the non-graphical (tty) version.
Default: [FALSE] 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. Graphical Port Complex Options 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. These include the menu windows (such as the inventory list), windows. The windows that you can tailor include menu windows (such
the text windows (such as "It is written in the book of ..." as the inventory list), text windows (such as "It is written in the
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 dungeon and attributes are displayed), and the map window (where the map
is drawn). 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". "left" to align the window to "top" or "bottom".
or "right" are possible, but not properly supported Default: [TOP]
in the Microsoft Windows port. 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". "left" to align the window to "top" or "bottom".
or "right" are possible, but not properly supported Default: [BOTTOM]
in the Microsoft Windows port. 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 (uses tiles to display things on the map), tiles (display things on the map with colored tiles),
ascii4x6ascii6x8, 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 (which forces things the map), or fit_to_screen (an ascii mode which
to fit on a single screen). Default: [tiles] forces things to fit on a single screen).
Default: [tiles]
scroll_margin Specifies the margin of scrolling the map. scroll_margin Specifies the number of map cells from the edge
Recommended to be set to 1 or greater. If set to of the map window where scrolling will take place.
80, this will keep your character centered on the map.
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 may exact contents of each tile in the .bmp, which must
even be dependent on the options with which your match the object lists used when building NetHack.
version of NetHack was built.
If you are interested in creating a tile file of
your own, create a regular build of NetHack using
the graphical version and examine the file tiles.bmp
in the src or build directory. This option may
only be specified in the defaults.nh config file.
Default: [default]
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
@@ -154,6 +156,8 @@ Map Window options:
in the defaults.nh config file. in the defaults.nh config file.
Default: [16] Default: [16]
Other Window options:
windowcolors Specifies the colors for various windows windowcolors Specifies the colors for various windows
This option may only be specified in the This option may only be specified in the
defaults.nh config file and has the following defaults.nh config file and has the following
@@ -184,28 +188,28 @@ Map Window options:
Example: Example:
OPTIONS=windowcolors:sts #00FF80/blue msg menutext/menu OPTIONS=windowcolors:sts #00FF80/blue msg menutext/menu
Other Window options:
font_menu Specifies the name of the menu font. font_menu Specifies the name of the menu font.
font_message Specifies the name of the message font. font_message Specifies the name of the message font.
font_status Specifies the name of the status font. font_status Specifies the name of the status font.
font_text Specifies the name of the text font. font_text Specifies the name of the text font.
font_size_menu Specifies the size of the menu font. font_size_menu Specifies the size of the menu font.
font_size_message font_size_message
Specifies the size of the message font. Specifies the size of the message font.
font_size_status font_size_status
Specifies the size of the status font. Specifies the size of the status font.
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. Graphical Port Additional/Enhanced Commands 4. 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":
@@ -237,14 +241,60 @@ File
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 Window Settings - Changes your logged-on user's settings for NetHack.
NetHack. In 3.4.0, only one setting is available: NetHack In 3.4.0, only one setting is available: NetHack mode, which can be
mode, which can be checked or unchecked. NetHack mode allows checked or unchecked. NetHack mode allows you to use the ALT key for
you to use ALT-f, ALT-m, and ALT-s for game key commands game key commands [see list above]. You can use F10 to access the
[see list above]. You can use F10 to access the menu bar while menu bar while in NetHack mode. You can also clear your logged-on
in NetHack mode. You can also clear your logged-on user's user's settings for NetHack. Settings in this window are saved in
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)
------------------------------------------------
The numeric keypad and surrounding characters act as macros for different
commands in NetHack. The Num Lock should be toggled to "on" to make the
most of these keys:
Key Normal Shift-Key
---------- ---------- -------------
1, 2, 3, 4 Move In Run In
6, 7, 8, 9 Direction Direction
0 (Ins) Inventory Categorized
Inventory
. (Del) Wait Turn : - Look Here
+ Spell List P - Put on an
accessory
- m - Move Previous
Only Message
NetHack for Windows - tty Interface Specific Behavior:
------------------------------------------------------
In the non-graphical (tty) interface, when you use the Ctrl key with a
directional key (1, 2, 3, 4, 6, 7, 8, 9) it means "go in specified
direction until you hit a wall or run into something interesting."
NetHack for Windows - Graphical Interface Specific Behavior:
------------------------------------------------------------
It is possible to scroll or pan the map in a specific direction:
Ctrl-Shift-Left (4) Scroll (Pan) map left
Ctrl-Shift-Right (6) Scroll (Pan) map right
Ctrl-Shift-Up (8) Scroll (Pan) map up
Ctrl-Shift-Down (2) Scroll (Pan) map down
Ctrl-Shift-Home (7) Scroll (Pan) map left to leftmost corner
Ctrl-Shift-End (1) Scroll (Pan) map left to rightmost corner
Ctrl-Shift-PgUp (9) Scroll (Pan) map left to uppermost corner
Ctrl-Shift-PgDn (3) Scroll (Pan) map left to lowermost corner