From 62ea71bd6b7f5c71d7fde8ddd91782de25ed9515 Mon Sep 17 00:00:00 2001 From: nhw_cron Date: Mon, 6 Nov 2023 04:24:09 -0500 Subject: [PATCH] This is cron-daily v1-May-8-2022. 005guidebook updated: doc/Guidebook.txt --- doc/Guidebook.txt | 1086 ++++++++++++++++++++++++--------------------- 1 file changed, 576 insertions(+), 510 deletions(-) diff --git a/doc/Guidebook.txt b/doc/Guidebook.txt index 6755d37b9..f128d8cf1 100644 --- a/doc/Guidebook.txt +++ b/doc/Guidebook.txt @@ -15,7 +15,7 @@ Original version - Eric S. Raymond (Edited and expanded for NetHack 3.7.0 by Mike Stephenson and others) - November 4, 2023 + November 6, 2023 @@ -126,7 +126,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -192,7 +192,7 @@ you have seen on the current dungeon level; as you explore more - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -258,7 +258,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -324,7 +324,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -390,7 +390,7 @@ you have available for spell casting. Again, resting will - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -456,7 +456,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -522,7 +522,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -588,7 +588,7 @@ ing a `*' lists your entire inventory, so you can see the - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -654,7 +654,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -720,7 +720,7 @@ there). - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -786,7 +786,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -852,7 +852,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -918,7 +918,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -984,7 +984,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -1050,7 +1050,7 @@ for which one to take off. (Note that this treats a cloak - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -1116,7 +1116,7 @@ that redundant, such as Caveman or Priestess), and - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -1182,7 +1182,7 @@ (R)UNIX is a registered trademark of The Open Group. - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -1248,7 +1248,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -1314,7 +1314,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -1380,7 +1380,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -1446,7 +1446,7 @@ Show a menu of possible actions directed at your current - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -1512,7 +1512,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -1578,7 +1578,7 @@ that level. This will also force all visited levels to be - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -1644,7 +1644,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -1710,7 +1710,7 @@ Prefix key to rush towards a direction. Default is `g' when - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -1776,7 +1776,7 @@ objects and monsters temporarily removed, making it possible - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -1842,7 +1842,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -1908,7 +1908,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -1974,7 +1974,7 @@ Show monster birth, death, genocide, and extinct statistics. - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -2040,7 +2040,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -2106,7 +2106,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -2172,7 +2172,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -2238,7 +2238,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -2304,7 +2304,7 @@ always below the current level. Usually that will be the next - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -2370,7 +2370,7 @@ previously visited level, it will be loaded from its file on disk - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -2436,7 +2436,7 @@ ventory-like display of any unpaid items which have been used up, - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -2502,7 +2502,7 @@ fountain or an altar or various other things doesn't elicit - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -2568,7 +2568,7 @@ Beware! You may suddenly come upon one in a dark place. Some - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -2634,7 +2634,7 @@ Initially, your pet may even be better at killing things than - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -2700,7 +2700,7 @@ sense--perhaps it is invisible and has just tapped you on the - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -2766,7 +2766,7 @@ the "#name" command, for the same purpose at any time, to name - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -2832,7 +2832,7 @@ (killing them first). Without a weapon, you do only 1-2 hit - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -2898,7 +2898,7 @@ "#enhance" (see below). - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -2964,7 +2964,7 @@ spot. - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -3030,7 +3030,7 @@ ondary is just an item in your inventory that's been designated - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -3096,7 +3096,7 @@ eventually negative) but can also be enchanted. Shirts are an - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -3162,7 +3162,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -3228,7 +3228,7 @@ mana points from an otherwise spent wand, destroying it in the - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -3294,7 +3294,7 @@ you can end up wasting both the energy and the time required in - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -3360,7 +3360,7 @@ challenge which is very difficult to accomplish). - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -3426,7 +3426,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -3492,7 +3492,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -3558,7 +3558,7 @@ brains while polymorphed into a mind flayer, is considered eating - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -3624,7 +3624,7 @@ can't be bypassed, such as being unable to push a boulder - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -3690,7 +3690,7 @@ Soko-Prize - Explored to the top of Sokoban - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -3756,7 +3756,7 @@ NETHACKOPTIONS or run-time configuration file prior to game - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -3822,7 +3822,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -3888,7 +3888,7 @@ extended command. Prefix the command with "!" to disable the - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -3954,7 +3954,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -4020,7 +4020,7 @@ initial values for the various options. Some can only be turned - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -4086,7 +4086,7 @@ lowed. See role for a description of how to use negation to - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -4152,7 +4152,7 @@ key or you decline to use the key; has no effect on - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -4218,7 +4218,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -4284,7 +4284,7 @@ - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -4350,7 +4350,7 @@ exclude choices. - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -4416,7 +4416,7 @@ Ignore interrupt signals, including breaks (default off). - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -4482,7 +4482,7 @@ the selected object class(es). Combination starts with a - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -4548,7 +4548,7 @@ Key to select all items in a menu. Default `.'. - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -4614,7 +4614,7 @@ can also set your character's role by appending a dash and one - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -4680,7 +4680,7 @@ too; - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -4746,7 +4746,7 @@ mixed. - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -4778,6 +4778,10 @@ Default is none but if perm_invent gets set to true while it is none it will be changed to all. + Note: if gold has been equipped in quiver/ammo-pouch then it + will be included for all despite that mode normally omitting + gold. + petattr Specifies one or more text highlighting attributes to use when showing pets on the map. Effectively a superset of the @@ -4805,14 +4809,10 @@ should be specified on its own, not in combination with any of the other letters. - pettype - Specify the type of your initial pet, if you are playing a - character class that uses multiple types of pets; or choose to - have no initial pet at all. Possible values are "cat", "dog", - "horse", and "none". If the choice is not allowed for the role - NetHack 3.7.0 November 4, 2023 + + NetHack 3.7.0 November 6, 2023 @@ -4822,6 +4822,11 @@ + pettype + Specify the type of your initial pet, if you are playing a + character class that uses multiple types of pets; or choose to + have no initial pet at all. Possible values are "cat", "dog", + "horse", and "none". If the choice is not allowed for the role you are currently playing, it will be silently ignored. For example, "horse" will only be honored when playing a knight. Cannot be set with the `O' command. @@ -4870,15 +4875,10 @@ might only be allowed for someone logged in under a particular user name (on multi-user systems) or specifying a particular character name (on single-user systems) or it might be disabled - entirely. Requesting it when not allowed or not possible re- - sults in explore mode instead. Default is normal play. - - pushweapon - Using the `w' (wield) command when already wielding something - pushes the old item into your alternate weapon slot (default + entirely. Requesting it when not allowed or not possible - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -4888,6 +4888,11 @@ + results in explore mode instead. Default is normal play. + + pushweapon + Using the `w' (wield) command when already wielding something + pushes the old item into your alternate weapon slot (default off). Likewise for the `a' (apply) command if it causes the applied item to become wielded. Persistent. @@ -4937,14 +4942,9 @@ roguesymset This option may be used to select one of the named symbol sets - found within "symbols" to alter the symbols displayed on the - screen on the rogue level. - - rlecomp - When writing out a save file, perform run length compression of - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -4954,6 +4954,11 @@ + found within "symbols" to alter the symbols displayed on the + screen on the rogue level. + + rlecomp + When writing out a save file, perform run length compression of the map. Not all ports support run length compression. It has no effect on reading an existing save file. @@ -5002,15 +5007,10 @@ fects only the appearance of the display, not the way the game treats you. Persistent. - showscore - Show your approximate accumulated score on bottom line (default - off). Persistent. - - silent - Suppress terminal beeps (default on). Persistent. - NetHack 3.7.0 November 4, 2023 + + NetHack 3.7.0 November 6, 2023 @@ -5020,6 +5020,13 @@ + showscore + Show your approximate accumulated score on bottom line (default + off). Persistent. + + silent + Suppress terminal beeps (default on). Persistent. + sortdiscoveries Controls the sorting behavior for the output of the `\' and ``' commands. Persistent. @@ -5067,16 +5074,9 @@ a - order alphabetically, first any unique monsters then all the others; c - order by monster class, by low to high level within each - class; - n - order by count, high to low; ties are broken by internal - monster index; - z - order by count, low to high; ties broken by internal index. - - Can be interactively set via the `m O' command or via using the - `m' prefix before either the #vanquished command or the - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -5086,7 +5086,14 @@ - #genocided command. + class; + n - order by count, high to low; ties are broken by internal + monster index; + z - order by count, low to high; ties broken by internal index. + + Can be interactively set via the `m O' command or via using the + `m' prefix before either the #vanquished command or the #geno- + cided command. sounds Allow sounds to be emitted from an integrated sound library @@ -5132,17 +5139,10 @@ lay. The default is on if configured into the program.) Per- sistent. - tips - Show some helpful tips during gameplay (default on). Persis- - tent. - - tombstone - Draw a tombstone graphic upon your death (default on). Persis- - tent. - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -5152,6 +5152,14 @@ + tips + Show some helpful tips during gameplay (default on). Persis- + tent. + + tombstone + Draw a tombstone graphic upon your death (default on). Persis- + tent. + toptenwin Put the ending display in a NetHack window instead of on stdout (default off). Setting this option makes the score list visi- @@ -5197,18 +5205,10 @@ through next and previous targets, allows filtering the possi- ble targets. - n - no filtering [default] - v - in view only - a - in same area only - - The area-filter tries to be slightly predictive--if you're - standing on a doorway, it will consider the area on the side of - the door you were last moving towards. - - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -5218,6 +5218,14 @@ + n - no filtering [default] + v - in view only + a - in same area only + + The area-filter tries to be slightly predictive--if you're + standing on a doorway, it will consider the area on the side of + the door you were last moving towards. + Filtering can also be changed when getting a location with the "getpos.filter" key. @@ -5264,17 +5272,9 @@ ing to suit your preferences, it will attempt to do so. If it can't it will silently ignore it. You can find out if an option is supported by the window port that you are currently using by - checking to see if it shows up in the Options list. Some options - are dynamic and can be specified during the game with the `O' - command. - - align_message - Where to align or place the message window (top, bottom, left, - or right) - - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -5284,6 +5284,14 @@ + checking to see if it shows up in the Options list. Some options + are dynamic and can be specified during the game with the `O' + command. + + align_message + Where to align or place the message window (top, bottom, left, + or right) + align_status Where to align or place the status window (top, bottom, left, or right). @@ -5329,18 +5337,10 @@ If NetHack can, it should use this size font for the map win- dow. - font_size_menu - If NetHack can, it should use this size font for menu windows. - - font_size_message - If NetHack can, it should use this size font for the message - window. - - font_size_status - If NetHack can, it should use this size font for the status - NetHack 3.7.0 November 4, 2023 + + NetHack 3.7.0 November 6, 2023 @@ -5350,6 +5350,15 @@ + font_size_menu + If NetHack can, it should use this size font for menu windows. + + font_size_message + If NetHack can, it should use this size font for the message + window. + + font_size_status + If NetHack can, it should use this size font for the status window. font_size_text @@ -5394,19 +5403,10 @@ cursor is this number of cells away from the edge of the win- dow. - selectsaved - If NetHack can, it should display a menu of existing saved - games for the player to choose from at game startup, if it can. - Not all ports support this option. - - softkeyboard - Display an onscreen keyboard. Handhelds are most likely to - support this option. - - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -5416,6 +5416,15 @@ + selectsaved + If NetHack can, it should display a menu of existing saved + games for the player to choose from at game startup, if it can. + Not all ports support this option. + + softkeyboard + Display an onscreen keyboard. Handhelds are most likely to + support this option. + splash_screen If NetHack can, it should display an opening splash screen when it starts up (default yes). @@ -5460,19 +5469,10 @@ options to select an alternate tile file. See NetHack.ad, the sample X "application defaults" file. - tile_height - Specify the preferred height of each tile in a tile capable - port. - - tile_width - Specify the preferred width of each tile in a tile capable port - - tiled_map - If NetHack can, it should display the map using tiles graphics - rather than simple characters (letters and punctuation, - NetHack 3.7.0 November 4, 2023 + + NetHack 3.7.0 November 6, 2023 @@ -5482,8 +5482,18 @@ - possibly augmented by line-drawing symbols). Setting tiled_map - to True forces ascii_map to be False. + tile_height + Specify the preferred height of each tile in a tile capable + port. + + tile_width + Specify the preferred width of each tile in a tile capable port + + tiled_map + If NetHack can, it should display the map using tiles graphics + rather than simple characters (letters and punctuation, possi- + bly augmented by line-drawing symbols). Setting tiled_map to + True forces ascii_map to be False. use_darkgray Use bold black instead of blue for black glyphs (TTY only). @@ -5526,19 +5536,9 @@ OPTION=windowcolors:wintype foreground/background - where wintype is one of "menu", "message", "status", or - "text", and foreground and background are colors, either a hexa- - decimal \'#rrggbb', one of the named colors (black, red, green, - brown, blue, magenta, cyan, orange, brightgreen, yellow, bright- - blue, brightmagenta, brightcyan, white, trueblack, gray, purple, - silver, maroon, fuchsia, lime, olive, navy, teal, aqua), or one - of Windows UI colors (activeborder, activecaption, appworkspace, - background, btnface, btnshadow, btntext, captiontext, graytext, - greytext, highlight, highlighttext, inactiveborder, inactivecap- - tion, menu, menutext, scrollbar, window, windowframe, - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -5548,7 +5548,17 @@ - windowtext). + where wintype is one of "menu", "message", "status", or + "text", and foreground and background are colors, either a hexa- + decimal \'#rrggbb', one of the named colors (black, red, green, + brown, blue, magenta, cyan, orange, brightgreen, yellow, bright- + blue, brightmagenta, brightcyan, white, trueblack, gray, purple, + silver, maroon, fuchsia, lime, olive, navy, teal, aqua), or one + of Windows UI colors (activeborder, activecaption, appworkspace, + background, btnface, btnshadow, btntext, captiontext, graytext, + greytext, highlight, highlighttext, inactiveborder, inactivecap- + tion, menu, menutext, scrollbar, window, windowframe, window- + text). wraptext If NetHack can, it should wrap long lines of text if they don't @@ -5592,19 +5602,9 @@ Note: DEC Rainbows hang if this is turned on. Cannot be set with the `O' command. - subkeyvalue - (Win32 tty NetHack only). May be used to alter the value of - keystrokes that the operating system returns to NetHack to help - compensate for international keyboard issues. OPTIONS=subkey- - value:171/92 will return 92 to NetHack, if 171 was originally - going to be returned. You can use multiple subkeyvalue assign- - ments in the configuration file if needed. Cannot be set with - the `O' command. - - - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -5614,6 +5614,15 @@ + subkeyvalue + (Win32 tty NetHack only). May be used to alter the value of + keystrokes that the operating system returns to NetHack to help + compensate for international keyboard issues. OPTIONS=subkey- + value:171/92 will return 92 to NetHack, if 171 was originally + going to be returned. You can use multiple subkeyvalue assign- + ments in the configuration file if needed. Cannot be set with + the `O' command. + video Set the video mode used (PC NetHack only). Values are "autode- tect", "default", "vga", or "vesa". Setting "vesa" will cause @@ -5658,19 +5667,10 @@ terns. This applies to Autopickup exceptions, Message types, Menu colors, and User sounds. - 9.8. Configuring Autopickup Exceptions - - You can further refine the behavior of the autopickup option - beyond what is available through the pickup_types option. - - By placing autopickup_exception lines in your configuration - file, you can define patterns to be checked when the game is - about to autopickup something. - - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -5680,6 +5680,15 @@ + 9.8. Configuring Autopickup Exceptions + + You can further refine the behavior of the autopickup option + beyond what is available through the pickup_types option. + + By placing autopickup_exception lines in your configuration + file, you can define patterns to be checked when the game is + about to autopickup something. + autopickup_exception Sets an exception to the pickup_types option. The au- topickup_exception option should be followed by a regular ex- @@ -5724,6 +5733,19 @@ For example: + + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 88 + + + BIND=^X:getpos.autodescribe BIND=\:menu_first_page BIND=v:loot @@ -5734,18 +5756,6 @@ to. You can also bind the "", "", and "" keys. - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 88 - - - Menu accelerator keys The menu control or accelerator keys can also be rebound via OPTIONS lines in the configuration file. You cannot bind ob- @@ -5789,20 +5799,10 @@ self. Default is `s'. getpos.autodescribe - When asked for a location, the key to toggle autodescribe. De- - fault is `#'. - - getpos.all.next - When asked for a location, the key to go to next closest inter- - esting thing. Default is `a'. - - getpos.all.prev - When asked for a location, the key to go to previous closest - interesting thing. Default is `A'. + When asked for a location, the key to toggle autodescribe. - - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -5812,6 +5812,16 @@ + Default is `#'. + + getpos.all.next + When asked for a location, the key to go to next closest inter- + esting thing. Default is `a'. + + getpos.all.prev + When asked for a location, the key to go to previous closest + interesting thing. Default is `A'. + getpos.door.next When asked for a location, the key to go to next closest door or doorway. Default is `d'. @@ -5856,6 +5866,18 @@ Toggles between no filtering, in view only, and in the same area only. Default is `"'. + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 90 + + + getpos.pick When asked for a location, the key to choose the location, and possibly ask for more info. When simulating a mouse click af- @@ -5866,18 +5888,6 @@ When asked for a location, the key to choose the location, and skip asking for more info. When simulating a mouse click after being asked for a direction, the key to respond as left click. - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 90 - - - Default is `,'. getpos.pick.quick @@ -5922,19 +5932,9 @@ message types look like this: MSGTYPE=type "pattern" type - how the message should be shown; - pattern - the pattern to match. - - The pattern should be a regular expression. - - Allowed types are: - - show - show message normally; - hide - never show the message; - stop - wait for user with more-prompt; - norep - show the message once, but not again if no other - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -5944,7 +5944,17 @@ - message is shown in between. + pattern - the pattern to match. + + The pattern should be a regular expression. + + Allowed types are: + + show - show message normally; + hide - never show the message; + stop - wait for user with more-prompt; + norep - show the message once, but not again if no other mes- + sage is shown in between. Here's an example of message types using NetHack's internal pattern matching facility: @@ -5988,19 +5998,9 @@ ground color, which isn't necessarily the same as any of the other colors. - Allowed attributes are none, bold, dim, italic, underline, - blink, and inverse. "Normal" is a synonym for "none". Note - that the platform used may interpret the attributes any way it - wants. - - Here's an example of menu colors using NetHack's internal pat- - tern matching facility: - - - - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -6010,6 +6010,14 @@ + Allowed attributes are none, bold, dim, italic, underline, + blink, and inverse. "Normal" is a synonym for "none". Note + that the platform used may interpret the attributes any way it + wants. + + Here's an example of menu colors using NetHack's internal pat- + tern matching facility: + MENUCOLOR="* blessed *"=green MENUCOLOR="* cursed *"=red MENUCOLOR="* cursed *(being worn)"=red&underline @@ -6056,17 +6064,9 @@ sound index - optional; the index corresponding to a sound file. - The pattern should be a POSIX extended regular expression. - - For example: - - SOUNDDIR=C:\nethack\sounds - SOUND=MESG "This door is locked" "lock.wav" 100 - SOUND=MESG hide "^You miss the " "swing.wav" 75 - - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -6076,6 +6076,14 @@ + The pattern should be a POSIX extended regular expression. + + For example: + + SOUNDDIR=C:\nethack\sounds + SOUND=MESG "This door is locked" "lock.wav" 100 + SOUND=MESG hide "^You miss the " "swing.wav" 75 + 9.13. Configuring Status Hilites @@ -6122,17 +6130,9 @@ attributes depending upon its capabilities, and in general may interpret the attributes any way it wants. For example, on some display systems a request for bold might yield blink or vice - versa. On others, issuing an attribute request while another is - already set up will replace the earlier attribute rather than - combine with it. Since NetHack issues attribute requests sequen- - tially (at least with the tty interface) rather than all at once, - the only way a situation like that can be controlled is to spec- - ify just one attribute. - - - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -6142,6 +6142,13 @@ + versa. On others, issuing an attribute request while another is + already set up will replace the earlier attribute rather than + combine with it. Since NetHack issues attribute requests sequen- + tially (at least with the tty interface) rather than all at once, + the only way a situation like that can be controlled is to spec- + ify just one attribute. + You can adjust the appearance of the following status fields: title dungeon-level experience-level @@ -6189,16 +6196,9 @@ matches the percentage. It is specified as a number be- tween 0 and 100, followed by `%' (percent sign). If the percentage is prefixed with `<=' or `>=', it also matches - when value is below or above the percentage. Use prefix - `<' or `>' to match when strictly below or above. (The - numeric limit is relaxed slightly for those: >-1% and - <101% are allowed.) Only four fields support percentage - rules. Percentages for "hitpoints" and "power" are - straightforward; they're based on the corresponding maxi- - mum field. Percentage highlight rules are also allowed - NetHack 3.7.0 November 4, 2023 + NetHack 3.7.0 November 6, 2023 @@ -6208,6 +6208,13 @@ + when value is below or above the percentage. Use prefix + `<' or `>' to match when strictly below or above. (The + numeric limit is relaxed slightly for those: >-1% and + <101% are allowed.) Only four fields support percentage + rules. Percentages for "hitpoints" and "power" are + straightforward; they're based on the corresponding maxi- + mum field. Percentage highlight rules are also allowed for "experience level" and "experience points" (valid when the showexp option is enabled). For those, the percentage is based on the progress from the start of the current ex- @@ -6248,6 +6255,25 @@ Example hilites: + + + + + + + + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 96 + + + OPTION=hilite_status: gold/up/yellow/down/brown OPTION=hilite_status: characteristics/up/green/down/red OPTION=hilite_status: hitpoints/100%/gray&normal @@ -6261,19 +6287,6 @@ - - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 96 - - - 9.14. Modifying NetHack Symbols NetHack can load entire symbol sets from the symbol file. @@ -6314,6 +6327,19 @@ B S_bat (bat or bird) ^ S_bear_trap (bear trap) - S_blcorn (bottom left corner) + + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 97 + + + b S_blob (blob) + S_book (spellbook) ) S_boomleft (boomerang open left) @@ -6327,19 +6353,6 @@ C S_centaur (centaur) _ S_chain (iron chain) # S_cloud (cloud) - - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 97 - - - c S_cockatrice (cockatrice) $ S_coin (pile of coins) # S_corr (corridor) @@ -6380,6 +6393,19 @@ g S_gremlin (gremlin) - S_hbeam (horizontal beam [zap animation]) # S_hcdbridge (horizontal raised drawbridge) + + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 98 + + + + S_hcdoor (closed door in horizontal wall) . S_hodbridge (horizontal lowered drawbridge) | S_hodoor (open door in horizontal wall) @@ -6393,19 +6419,6 @@ J S_jabberwock (jabberwock) j S_jelly (jelly) k S_kobold (kobold) - - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 98 - - - K S_kop (Keystone Kop) ^ S_land_mine (land mine) } S_lava (molten lava) @@ -6446,6 +6459,19 @@ R S_rustmonst (rust monster or disenchanter) ? S_scroll (scroll) # S_sink (sink) + + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 99 + + + ^ S_sleeping_gas_trap (sleeping gas trap) S S_snake (snake) s S_spider (arachnid or centipede) @@ -6459,19 +6485,6 @@ S_stone (solid rock) ] S_strange_obj (strange object) - S_sw_bc (swallow bottom center) - - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 99 - - - \ S_sw_bl (swallow bottom left) / S_sw_br (swallow bottom right) | S_sw_ml (swallow middle left) @@ -6512,6 +6525,19 @@ ) S_weapon (weapon) " S_web (web) w S_worm (worm) + + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 100 + + + ~ S_worm_tail (long worm tail) W S_wraith (wraith) x S_xan (xan or other extraordinary insect) @@ -6526,18 +6552,6 @@ * Several symbols in this table appear to be blank. They are the space character, except for S_pet_override and S_hero_override - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 100 - - - which don't have any default value and can only be used if en- abled in the "sysconf" file. @@ -6577,8 +6591,20 @@ map to that particular symbol. You will need to select a symset with a UTF8 handler to en- - able the display of the customizations, such as the Enhanced sym- - set. + able the display of the customizations, such as the Enhanced + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 101 + + + + symset. 9.16. Configuring NetHack for Play by the Blind @@ -6591,27 +6617,15 @@ to know how to navigate horizontally and vertically character by character. They will also find the search capabilities of their screen-readers to be quite valuable. Be certain to examine this - Guidebook before playing so you have an idea what the screen - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 101 - - - - layout is like. You'll also need to be able to locate the PC cur- - sor. It is always where your character is located. Merely search- - ing for an @-sign will not always find your character since there - are other humanoids represented by the same sign. Your screen- - reader should also have a function which gives you the row and - column of your review cursor and the PC cursor. These co-ordi- - nates are often useful in giving players a better sense of the - overall location of items on the screen. + Guidebook before playing so you have an idea what the screen lay- + out is like. You'll also need to be able to locate the PC cursor. + It is always where your character is located. Merely searching + for an @-sign will not always find your character since there are + other humanoids represented by the same sign. Your screen-reader + should also have a function which gives you the row and column of + your review cursor and the PC cursor. These co-ordinates are of- + ten useful in giving players a better sense of the overall loca- + tion of items on the screen. NetHack can also be compiled with support for sending the game messages to an external program, such as a text-to-speech @@ -6643,6 +6657,19 @@ paranoid_confirmation:swim Prevent walking into water or lava. + + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 102 + + + autodescribe Automatically describe the terrain under the cursor when tar- geting. @@ -6658,18 +6685,6 @@ whatis_filter:area When targeting with cursor, filter possible locations so only those in the same area (eg. same room, or same corridor) are - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 102 - - - considered. whatis_moveskip @@ -6709,6 +6724,18 @@ SAVEFORMAT = A list of up to two save file formats separated by space. The first format in the list will written as well as read. The second format will be read only if no save file in + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 103 + + + the first format exists. Valid choices are "historical" for binary writing of entire structs, "lendian" for binary writing of each field in little-endian order, "ascii" for writing the @@ -6725,17 +6752,6 @@ SUPPORT = A string explaining how to get local support (no de- fault value). - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 103 - - - RECOVER = A string explaining how to recover a game on this system (no default value). @@ -6773,6 +6789,19 @@ ability for players to set S_pet_override and S_hero_override symbols in their configuration file. + + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 104 + + + PORTABLE_DEVICE_PATHS = 0 or 1 Windows OS only, the game will look for all of its external files, and write to all of its output files in one place rather than at the standard loca- @@ -6790,18 +6819,6 @@ %T - current time, UNIX timestamp format %d - game start time, YYYYMMDDhhmmss format %D - current time, YYYYMMDDhhmmss format - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 104 - - - %n - player name %N - first character of player name @@ -6839,6 +6856,18 @@ your gold intact. If, however, you get killed in the Mazes of Menace, the guild will only hear about 90% of your gold when your corpse is discovered (adventurers have been known to collect + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 105 + + + finder's fees). So, consider whether you want to take one last hit at that monster and possibly live, or quit and stop with whatever you have. If you quit, you keep all your gold, but if @@ -6856,18 +6885,6 @@ cheat death, at the paltry cost of not getting on the high score list. - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 105 - - - There are two ways of enabling explore mode. One is to start the game with the -X command-line switch or with the play- mode:explore option. The other is to issue the "#exploremode" @@ -6904,6 +6921,19 @@ and Kenneth C. R. C. Arnold. Small portions were adapted from Further Exploration of the Dungeons of Doom, by Ken Arromdee. + + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 106 + + + NetHack is the product of literally scores of people's work. Main events in the course of the game development are described below: @@ -6921,19 +6951,6 @@ (later renamed rec.games.hack, eventually replaced by rec.games.roguelike.nethack) was created for discussing it. - - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 106 - - - Don G. Kneller ported Hack 1.0.3 to Microsoft C and MS-DOS, producing PC HACK 1.01e, added support for DEC Rainbow graphics in version 1.03g, and went on to produce at least four more ver- @@ -6970,6 +6987,19 @@ to enhance the PC, Macintosh, and Amiga ports through the later revisions of 3.0. + + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 107 + + + Version 3.0 went through ten relatively rapidly released "patch-level" revisions. Versions at the time were known as 3.0 for the base release and variously as "3.0a" through "3.0j", @@ -6988,18 +7018,6 @@ features, and produced NetHack 3.1. Version 3.1.0 was released in January of 1993. - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 107 - - - Ken Lorber, Gregg Wonderly and Greg Olson, with help from Richard Addison, Mike Passaretti, and Olaf Seibert, developed NetHack 3.1 for the Amiga. @@ -7036,6 +7054,18 @@ NetHack Development Team which rechristened them "tiles", origi- nal usage which has subsequently been picked up by various other games. NetHack's tiles support was then implemented on other + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 108 + + + platforms (initially MS-DOS but eventually Windows, Qt, and X11 too). @@ -7055,17 +7085,6 @@ release of the game was dedicated to him by the development and porting teams. - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 108 - - - Version 3.2 proved to be more stable than previous versions. Many bugs were fixed, abuses eliminated, and game features tuned for better game play. @@ -7100,8 +7119,20 @@ digit year, and 1999's year 99 was followed by 2000's year 100. That got written out successfully but it unintentionally intro- duced an extra column in the file layout which prevented score - entries from being read back in correctly, interfering with in- - sertion of new high scores and with retrieval of old character + entries from being read back in correctly, interfering with + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 109 + + + + insertion of new high scores and with retrieval of old character names to use for random ghost and statue names in the current game.) @@ -7120,18 +7151,6 @@ ians, Cavemen, Healers, Knights, Priests, Rogues, Samurai, Tourists, Valkyries and of course, Wizards. It was also the first version to allow you to ride a steed, and was the first - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 109 - - - version to have a publicly available web-site listing all the bugs that had been discovered. Despite that constantly growing bug list, 3.3 proved stable enough to last for more than a year @@ -7166,6 +7185,19 @@ stopped working in early 2006. A great many thanks to Ron for keeping NetHack alive on OS/2 all these years. + + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 110 + + + Janne Salmijarvi and Teemu Suikki maintained and enhanced the Amiga port of 3.4 after Janne Salmijarvi resurrected it for 3.3.1. @@ -7186,18 +7218,6 @@ tinue to be developed, maintained, and enjoyed by the community to this day. - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 110 - - - In September 2014, an interim snapshot of the code under de- velopment was released publicly by other parties. Since that code was a work-in-progress and had not gone through the process @@ -7233,6 +7253,17 @@ and Kevin Smolkowski, ensured that NetHack 3.6 continued to oper- ate on various UNIX flavors and maintained the X11 interface. + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 111 + + + Ken Lorber, Haoyang Wang, Pat Rankin, and Dean Luick main- tained the port of NetHack 3.6 for MacOS. @@ -7251,22 +7282,10 @@ In late April 2018, several hundred bug fixes for 3.6.0 and some new features were assembled and released as NetHack 3.6.1. - The NetHack Development Team at the time of release of 3.6.1 - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 111 - - - - consisted of Warwick Allison, Michael Allison, Ken Arromdee, - David Cohrs, Jessie Collet, Pasi Kallinen, Ken Lorber, Dean - Luick, Patric Mueller, Pat Rankin, Derek S. Ray, Alex Smith, Mike + The NetHack Development Team at the time of release of 3.6.1 con- + sisted of Warwick Allison, Michael Allison, Ken Arromdee, David + Cohrs, Jessie Collet, Pasi Kallinen, Ken Lorber, Dean Luick, + Patric Mueller, Pat Rankin, Derek S. Ray, Alex Smith, Mike Stephenson, Janet Walz, and Paul Winner. In early May 2019, another 320 bug fixes along with some en- @@ -7296,6 +7315,21 @@ https://www.nethack.org/. + + + + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 112 + + + 12.1. Special Thanks On behalf of the NetHack community, thank you very much once @@ -7317,19 +7351,6 @@ of Dungeoneers: Adam Aronow J. Ali Harlow Mikko Juola - - - - NetHack 3.7.0 November 4, 2023 - - - - - - NetHack Guidebook 112 - - - Alex Kompel Janet Walz Nathan Eady Alex Smith Janne Salmijarvi Norm Meluch Andreas Dorn Jean-Christophe Collet Olaf Seibert @@ -7362,6 +7383,19 @@ Eric S. Raymond Mark Modrall Steve Linhart Erik Andersen Marvin Bressler Steve VanDevender Fredrik Ljungdahl Matthew Day Teemu Suikki + + + + NetHack 3.7.0 November 6, 2023 + + + + + + NetHack Guidebook 113 + + + Frederick Roeber Merlyn LeRoy Tim Lennan Gil Neiger Michael Allison Timo Hakulinen Greg Laskin Michael Feir Tom Almy @@ -7386,7 +7420,39 @@ - NetHack 3.7.0 November 4, 2023 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + NetHack 3.7.0 November 6, 2023