sys/winnt/porthelp

   1         Microsoft Windows specific help file for NetHack 3.6
   2         Copyright (c) NetHack PC Development Team 1993-2002.
   3         NetHack may be freely distributed.  See license for details.
   4                    (Last Revision: March 16, 2003)
   5
   6 This file details specifics for NetHack built for Windows 95, 98, NT,
   7 Me, 2000, and XP. Users of really early 16-bit Windows versions should
   8 use the MSDOS NetHack.
   9
  10 Please note that "NetHack for Windows - Graphical Interface" requires
  11 an installation of Internet Explorer 4 or an installation of
  12 version 4.71 of the common controls. See the following internet page:
  13     http://www.nethack.org/v340/ports/download-win.html#cc
  14 for more information. If the game runs for you, you are not affected.
  15
  16 New players should be sure to read GuideBook.txt which contains
  17 essential information about playing NetHack. It can be found in the
  18 same directory as your NetHack executable.
  19
  20 The NetHack for Windows port supports some additional or enhanced
  21 commands as well as some defaults.nh file options specific to
  22 configuration choices used during the building of NetHack for
  23 Windows. Listed below are those commands and defaults.nh file
  24 options.
  25
  26 Some options are applicable only to the "Graphical Interface."
  27 These are discussed separately in their own section.
  28
  29 Contents
  30 1. ALT Key Combinations
  31 2. Boolean options - Option that you can toggle on or off
  32 3. Graphical Interface - Options you can assign a value to
  33 4. Graphical Interface - Additional/Enhanced Commands
  34 5. Graphical Interface - Menus
  35 6. Numeric Keypad (for number_pad mode)
  36
  37
  38 1. ALT Key Combinations
  39 ----------------------------------------------
  40 The non-graphical (tty) interface always operates in "NetHack mode",
  41 while the "NetHack for Windows - Graphical Interface" lets you
  42 toggle the mode.  In non-NetHack mode, all ALT-key combinations
  43 are sent to the Windows itself, rather than to NetHack.
  44
  45 While playing in NetHack mode you can press the ALT key in
  46 combination with another key to execute an extended command
  47 as an alternative method to pressing a # key sequence.
  48 The available commands are:
  49
  50     Alt-2    #twoweapon      - toggle two-weapon combat (unavailable
  51                                if number_pad mode is set)
  52     Alt-a    #adjust         - adjust inventory letters.
  53     Alt-c    #chat           - talk to someone or something.
  54     Alt-d    #dip            - dip an object into something.
  55     Alt-e    #enhance        - enhance your skill with a weapon.
  56     Alt-f    #force          - force a lock.
  57     Alt-i    #invoke         - invoke an object's powers.
  58     Alt-j    #jump           - jump to a location.
  59     Alt-l    #loot           - loot a box on the floor.
  60     Alt-m    #monster        - use a monster's special ability.
  61     Alt-n    #name           - name an item or type of object.
  62     Alt-o    #offer          - offer a sacrifice to the gods.
  63     Alt-p    #pray           - pray to the gods for help.
  64     Alt-q    #quit           - quit the game. (Same as #quit)
  65     Alt-r    #rub            - rub a lamp.
  66     Alt-s    #sit            - sit down.
  67     Alt-t    #turn           - turn undead.
  68     Alt-u    #untrap         - untrap something.
  69     Alt-v    #version        - list compile time options for this version of
  70                                NetHack.
  71     Alt-w    #wipe           - wipe off your face.
  72     Alt-?    #?              - display list of extended menu commands
  73
  74 2. Boolean Options (Options that can be toggled on or off)
  75 ----------------------------------------------------------
  76
  77 Listed here are any options not discussed in the main help, options
  78 which may be slightly different from the main help file, and options
  79 which may need a slightly more explanatory note:
  80
  81     color          Use color when displaying non-tiled maps. Tiled
  82                    maps (available in the graphical port) are always
  83                    rendered in color. Default: [TRUE]
  84
  85     hilite_pet     Using tiled graphics, displays a small heart symbol
  86                    next to your pet.  Using ascii graphics, the pet is
  87                    hilited in a white background.
  88                    Default: [TRUE]
  89
  90     IBMgraphics    Use IBM extended characters for the dungeon
  91                    Default: [TRUE]
  92
  93     msg_window     When ^P is pressed, it shows menu in a full window.
  94                    Available only in the non-graphical (tty) version.
  95                    Default: [FALSE]
  96
  97     toptenwin      Write top ten list to a window, as opposed to stdout.
  98                    Default in tty interface: [FALSE]
  99                    Default in graphical interface: [TRUE] (and cannot be changed)
 100
 101 3. Options that you assign a value to (Graphical Interface only)
 102 ----------------------------------------------------------------
 103
 104 "NetHack for Windows - Graphical Interface" recognizes the following
 105 additional options, which the non-graphical (tty) version will
 106 silently ignore.  These are options that specify attributes of various
 107 windows.  The windows that you can tailor include menu windows (such
 108 as the inventory list), text windows (such as "It is written in the
 109 book of ..." screens), the message window (where events of the game are
 110 displayed), the status window (where your character name
 111 and attributes are displayed), and the map window (where the map
 112 is drawn).
 113
 114 Window Alignment options:
 115
 116     align_message  Specifies at which side of the NetHack screen the
 117                    message window is aligned. This option can be used
 118                    to align the window to "top" or "bottom".
 119                    Default: [TOP]
 120
 121     align_status   Specifies at which side of the NetHack screen the
 122                    status window is aligned. This option can be used
 123                    to align the window to "top" or "bottom".
 124                    Default: [BOTTOM]
 125
 126 Map Window options:
 127
 128     map_mode       Specifies which map mode to use.
 129                    The following map modes are available:
 130                    tiles (display things on the map with colored tiles),
 131                    ascii4x6, ascii6x8, ascii8x8, ascii16x8, ascii7x12,
 132                    ascii8x12, ascii16x12, ascii12x16, ascii10x18
 133                    (which use that size font to display things on
 134                    the map), or fit_to_screen (an ascii mode which
 135                    forces things to fit on a single screen).
 136                    Default: [tiles]
 137
 138     scroll_margin  Specifies the number of map cells from the edge
 139                    of the map window where scrolling will take place.
 140                    Default: [5]
 141
 142     tile_file      An alternative file containing bitmap to use for
 143                    tiles. This file should be a .bmp file and should
 144                    be organized as 40 rectangular tiles wide. It is
 145                    beyond the scope of this document to describe the
 146                    exact contents of each tile in the .bmp, which must
 147                    match the object lists used when building NetHack.
 148
 149     tile_height    Used with tile_file to specify the height of each
 150                    tile in pixels. This option may only be specified
 151                    in the defaults.nh config file.
 152                    Default: [16]
 153
 154     tile_width     Used with tile_file to specify the width of each
 155                    tile in pixels. This option may only be specified
 156                    in the defaults.nh config file.
 157                    Default: [16]
 158
 159 Other Window options:
 160
 161     windowcolors   Specifies the colors for various windows
 162                    This option may only be specified in the
 163                    defaults.nh config file and has the following
 164                    format:
 165                        window-type foreground/background
 166                    Notes:
 167                       - Both foreground and background colors are
 168                         required, and a slash must separate them.
 169                       - "window-type" is either "message" or "status"
 170                         (Short forms are: "msg" or "sts").
 171                       - "foreground" and "background" may be specified as
 172                         a color name (such as "blue"), or by a six
 173                         digit hexadecimal RGB color value (such as
 174                         "#8F8F8F")
 175                       - The following color names are available:
 176                         black, red, green, brown, blue, magenta,
 177                         cyan, gray (or grey), orange, brightgreen,
 178                         yellow, brightblue, brightmagenta, brightcyan,
 179                         white, trueblack, purple, silver, maroon, fuchsia,
 180                         lime, olive, navy, teal, aqua. In addition, you
 181                         can use the following names to refer to default
 182                         Windows settings: activeborder, activecaption,
 183                         appworkspace, background, btnface, btnshadow, btntext,
 184                         captiontext, graytext, highlight, highlighttext,
 185                         inactiveborder, inactivecaption, menu, menutext,
 186                         scrollbar, window, windowframe, windowtext.
 187
 188                         Example:
 189                         OPTIONS=windowcolors:sts #00FF80/blue msg menutext/menu
 190
 191     font_menu      Specifies the name of the menu font.
 192     font_message   Specifies the name of the message font.
 193     font_status    Specifies the name of the status font.
 194     font_text      Specifies the name of the text font.
 195
 196     font_size_menu Specifies the size of the menu font.
 197
 198     font_size_message
 199                    Specifies the size of the message font.
 200
 201     font_size_status
 202                    Specifies the size of the status font.
 203
 204     font_size_text Specifies the size of the text font.
 205
 206 Miscellaneous options:
 207
 208     vary_msgcount  Number of lines to display in message window.
 209
 210
 211 4. NetHack for Windows - Graphical Interface, Additional/Enhanced Commands
 212 -------------------------------------------------------------------------
 213
 214 The following function keys are active in
 215 the "NetHack for Windows - Graphical Interface":
 216
 217     F4             Toggle level overview mode on/off
 218                    This key will toggle the map between a view that
 219                    is mapped to fit exactly to the window, and the
 220                    view that shows the various symbols in their
 221                    normal size. This is useful for getting an idea
 222                    of where you are in a level.
 223
 224     F5             Toggle tiled display on/off.
 225                    This key switches between the tiled and the
 226                    traditional ASCII display. This is equivalent to
 227                    using the "map_mode" option.
 228
 229     F10            Activate menu bar.
 230                    This key will activate the menu bar, allowing you
 231                    to select between the menus: File, Map,
 232                    Window Settings, and Help.
 233
 234 5. Graphical Port Menus
 235 -----------------------
 236
 237 File
 238   Save - Allows you to save and exit the game
 239   Quit - Allows you to quit the game
 240
 241 Map - Provides for selection of map mode. Equivalent to using
 242 the map_mode option.
 243
 244 Window Settings - Changes your logged-on user's settings for NetHack.
 245 In 3.5.0, only one setting is available: NetHack mode, which can be
 246 checked or unchecked. NetHack mode allows you to use the ALT key for
 247 game key commands [see list above]. You can use F10 to access the
 248 menu bar while in NetHack mode. You can also clear your logged-on
 249 user's settings for NetHack. Settings in this window are saved in
 250 your logged-on user's registry.
 251
 252 Help - Provides help about various portions of NetHack.
 253
 254
 255 6. Numeric Keypad (for "OPTION=number_pad" mode)
 256 ------------------------------------------------
 257
 258 The numeric keypad and surrounding characters act as macros for different
 259 commands in NetHack.  The Num Lock should be toggled to "on" to make the
 260 most of these keys:
 261
 262           Key         Normal       Shift-Key
 263        ----------   ----------    -------------
 264        1, 2, 3, 4   Move In       Run In
 265        6, 7, 8, 9   Direction     Direction
 266
 267         0 (Ins)     Inventory     Categorized
 268                                   Inventory
 269
 270         . (Del)     Wait Turn     : - Look Here
 271
 272         +           Spell List    P - Put on an
 273                                   accessory
 274
 275         -           m - Move      Previous
 276                     Only          Message
 277
 278     NetHack for Windows - tty Interface Specific Behavior:
 279     ------------------------------------------------------
 280
 281       In the non-graphical (tty) interface, when you use the Ctrl key with a
 282       directional key (1, 2, 3, 4, 6, 7, 8, 9) it means "go in specified
 283       direction until you hit a wall or run into something interesting."
 284
 285     NetHack for Windows - Graphical Interface Specific Behavior:
 286     ------------------------------------------------------------
 287
 288       It is possible to scroll or pan the map in a specific direction:
 289
 290         Ctrl-Shift-Left  (4)     Scroll (Pan) map left
 291         Ctrl-Shift-Right (6)     Scroll (Pan) map right
 292         Ctrl-Shift-Up    (8)     Scroll (Pan) map up
 293         Ctrl-Shift-Down  (2)     Scroll (Pan) map down
 294         Ctrl-Shift-Home  (7)     Scroll (Pan) map left to leftmost corner
 295         Ctrl-Shift-End   (1)     Scroll (Pan) map left to rightmost corner
 296         Ctrl-Shift-PgUp  (9)     Scroll (Pan) map left to uppermost corner
 297         Ctrl-Shift-PgDn  (3)     Scroll (Pan) map left to lowermost corner
 298
 299
 300