diff --git a/doc/Guidebook.txt b/doc/Guidebook.txt index 9abbba24b..4720b5317 100644 --- a/doc/Guidebook.txt +++ b/doc/Guidebook.txt @@ -3934,6 +3934,15 @@ off). Likewise for the `a' (apply) command if it causes the applied item to become wielded. Persistent. + quick_farsight + When set, usually prevents the "you sense your surroundings" + message where play pauses to allow you to browse the map when- + ever clairvoyance randomly activates. Some situations, such as + being underwater or engulfed, ignore this option. It does not + affect the clairvoyance spell where pausing to examine revealed + objects or monsters is less intrusive. Default is off. Per- + sistent. + race Selects your race (for example, "race:human"). Default is ran- dom. If you prefix the value with `!' or "no", you will ex- @@ -3944,15 +3953,6 @@ Make the space bar a synonym for the `.' (#wait) command (de- fault off). Persistent. - role - Pick your type of character (for example "role:Samurai"); syn- - onym for "character". See "name" for an alternate method of - specifying your role. Normally only the first letter of the - value is examined; `r' is an exception with "Rogue", "Ranger", - and "random" values. If you prefix the value with `!' or "no", - you will exclude that role from being picked randomly. Cannot - be set with the `O' command. Persistent. - NetHack 3.7 December 18, 2019 @@ -3964,6 +3964,15 @@ + role + Pick your type of character (for example "role:Samurai"); syn- + onym for "character". See "name" for an alternate method of + specifying your role. Normally only the first letter of the + value is examined; `r' is an exception with "Rogue", "Ranger", + and "random" values. If you prefix the value with `!' or "no", + you will exclude that role from being picked randomly. Cannot + be set with the `O' command. Persistent. + roguesymset This option may be used to select one of the named symbol sets found within "symbols" to alter the symbols displayed on the @@ -4009,15 +4018,6 @@ Show your accumulated experience points on bottom line (default off). Persistent. - showrace - Display yourself as the glyph for your race, rather than the - glyph for your role (default off). Note that this setting af- - 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. NetHack 3.7 December 18, 2019 @@ -4030,6 +4030,16 @@ + showrace + Display yourself as the glyph for your race, rather than the + glyph for your role (default off). Note that this setting af- + 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. @@ -4075,16 +4085,6 @@ screen. Use "symset:default" to explicitly select the default symbols. - time - Show the elapsed game time in turns on bottom line (default - off). Persistent. - - timed_delay - When pausing momentarily for display effect, such as with ex- - plosions and moving objects, use a timer rather than sending - extra characters to the screen. (Applies to "tty" interface - only; "X11" interface always uses a timer based delay. The - NetHack 3.7 December 18, 2019 @@ -4096,7 +4096,16 @@ - default is on if configured into the program.) Persistent. + time + Show the elapsed game time in turns on bottom line (default + off). Persistent. + + timed_delay + When pausing momentarily for display effect, such as with ex- + plosions and moving objects, use a timer rather than sending + extra characters to the screen. (Applies to "tty" interface + only; "X11" interface always uses a timer based delay. The de- + fault is on if configured into the program.) Persistent. tombstone Draw a tombstone graphic upon your death (default on). Persis- @@ -4141,15 +4150,6 @@ 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 December 18, 2019 @@ -4162,6 +4162,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. @@ -4208,14 +4216,6 @@ 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 December 18, 2019 @@ -4228,6 +4228,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). @@ -4274,14 +4282,6 @@ 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 - If NetHack can, it should use this size font for text windows. NetHack 3.7 December 18, 2019 @@ -4294,6 +4294,15 @@ + window. + + font_size_status + If NetHack can, it should use this size font for the status + window. + + font_size_text + If NetHack can, it should use this size font for text windows. + fullscreen If NetHack can, it should try and display on the entire screen rather than in a window. @@ -4338,16 +4347,7 @@ 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). - - statuslines - Number of lines for traditional below-the-map status display. NetHack 3.7 December 18, 2019 @@ -4360,6 +4360,16 @@ + 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). + + statuslines + Number of lines for traditional below-the-map status display. Acceptable values are 2 and 3 (default is 2). Curses and tty interfaces only. @@ -4405,16 +4415,6 @@ 1 - on, always show borders 2 - auto, on if display is at least (24+2)x(80+2) (default) - (The 26x82 size threshold for `2' refers to number of rows and - columns of the display. A width of at least 110 columns - (80+2+26+2) is needed for align_status set to left or right.) - - windowcolors - If NetHack can, it should display windows with the specified - foreground/background colors. Windows GUI only. The format is - - - NetHack 3.7 December 18, 2019 @@ -4426,6 +4426,14 @@ + (The 26x82 size threshold for `2' refers to number of rows and + columns of the display. A width of at least 110 columns + (80+2+26+2) is needed for align_status set to left or right.) + + windowcolors + If NetHack can, it should display windows with the specified + foreground/background colors. Windows GUI only. The format is + OPTION=windowcolors:wintype foreground/background where wintype is one of "menu", "message", "status", or @@ -4472,14 +4480,6 @@ abort the count by typing ESC will leave NetHack waiting for another character to complete the two character sequence. Type a second ESC to finish cancelling such a count. At other - prompts a single ESC suffices. - - BIOS - Use BIOS calls to update the screen display quickly and to read - the keyboard (allowing the use of arrow keys to move) on ma- - chines with an IBM PC compatible BIOS ROM (default off, OS/2, - PC, and ST NetHack only). - NetHack 3.7 December 18, 2019 @@ -4492,6 +4492,14 @@ + prompts a single ESC suffices. + + BIOS + Use BIOS calls to update the screen display quickly and to read + the keyboard (allowing the use of arrow keys to move) on ma- + chines with an IBM PC compatible BIOS ROM (default off, OS/2, + PC, and ST NetHack only). + flush (default off, Amiga NetHack only). @@ -4538,14 +4546,6 @@ not correct the problem, try !color. Cannot be set with the `O' command. - 9.7. Regular Expressions - - Regular expressions are normally POSIX extended regular ex- - pressions. It is possible to compile NetHack without regular ex- - pression support on a platform where there is no regular expres- - sion library. While this is not true of any modern platform, if - your NetHack was built this way, patterns are instead glob pat- - terns. This applies to Autopickup exceptions, Message types, Menu NetHack 3.7 December 18, 2019 @@ -4558,6 +4558,14 @@ + 9.7. Regular Expressions + + Regular expressions are normally POSIX extended regular ex- + pressions. It is possible to compile NetHack without regular ex- + pression support on a platform where there is no regular expres- + sion library. While this is not true of any modern platform, if + your NetHack was built this way, patterns are instead glob pat- + terns. This applies to Autopickup exceptions, Message types, Menu colors, and User sounds. 9.8. Configuring Autopickup Exceptions @@ -4601,16 +4609,8 @@ any corpse from autopickup. The last example results in the ex- clusion of items known to be cursed from autopickup. - 9.9. Changing Key Bindings - It is possible to change the default key bindings of some - special commands, menu accelerator keys, and extended commands, - by using BIND stanzas in the configuration file. Format is key, - followed by the command to bind to, separated by a colon. The - key can be a single character ("x"), a control key ("^X", "C-x"), - a meta key ("M-x"), or a three-digit decimal ASCII code. - For example: @@ -4624,6 +4624,17 @@ + 9.9. Changing Key Bindings + + It is possible to change the default key bindings of some + special commands, menu accelerator keys, and extended commands, + by using BIND stanzas in the configuration file. Format is key, + followed by the command to bind to, separated by a colon. The + key can be a single character ("x"), a control key ("^X", "C-x"), + a meta key ("M-x"), or a three-digit decimal ASCII code. + + For example: + BIND=^X:getpos.autodescribe BIND={:menu_first_page BIND=v:loot @@ -4668,17 +4679,6 @@ When asked for a direction, the key to target yourself. De- fault is `.'. - getdir.self2 - When asked for a direction, the key to target yourself. De- - fault 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 - NetHack 3.7 December 18, 2019 @@ -4690,7 +4690,17 @@ - interesting thing. Default is `a'. + getdir.self2 + When asked for a direction, the key to target yourself. De- + fault 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 @@ -4734,16 +4744,6 @@ or meta-digit keys to fast-move around, move by skipping the same glyphs instead of by 8 units. Default is `*'. - getpos.filter - When asked for a location, change the filtering mode when using - one of the next or previous keys to cycle through targets. - Toggles between no filtering, in view only, and in the same - area only. Default is `"'. - - getpos.pick - When asked for a location, the key to choose the location, and - possibly ask for more info. Default is `.'. - NetHack 3.7 December 18, 2019 @@ -4756,6 +4756,16 @@ + getpos.filter + When asked for a location, change the filtering mode when using + one of the next or previous keys to cycle through targets. + Toggles between no filtering, in view only, and in the same + area only. Default is `"'. + + getpos.pick + When asked for a location, the key to choose the location, and + possibly ask for more info. Default is `.'. + getpos.pick.once When asked for a location, the key to choose the location, and skip asking for more info. Default is `,'. @@ -4799,16 +4809,6 @@ redraw Key to redraw the screen. Default is `^R'. - redraw.numpad - Key to redraw the screen. With number_pad only. Default is - `^L'. - - repeat - Key to repeat previous command. Default is `^A'. - - reqmenu - Prefix key to request menu from some commands. Default is `m'. - @@ -4822,6 +4822,16 @@ + redraw.numpad + Key to redraw the screen. With number_pad only. Default is + `^L'. + + repeat + Key to repeat previous command. Default is `^A'. + + reqmenu + Prefix key to request menu from some commands. Default is `m'. + run Prefix key to run towards a direction. Default is `G'. @@ -4867,16 +4877,6 @@ the user is prompted with more-prompt, and a message matching "You displaced ." is not shown at all. - The order of the defined MSGTYPE lines is important; the last - matching rule is used. Put the general case first, exceptions - below them. - - 9.11. Configuring Menu Colors - - Some platforms allow you to define colors used in menu lines - when the line matches a user-defined pattern. At this time the - tty, curses, win32tty and win32gui interfaces support this. - NetHack 3.7 December 18, 2019 @@ -4888,6 +4888,16 @@ + The order of the defined MSGTYPE lines is important; the last + matching rule is used. Put the general case first, exceptions + below them. + + 9.11. Configuring Menu Colors + + Some platforms allow you to define colors used in menu lines + when the line matches a user-defined pattern. At this time the + tty, curses, win32tty and win32gui interfaces support this. + In general, the configuration file entries to describe the menu color mappings look like this: @@ -4932,16 +4942,6 @@ Note that if you intend to have one or more color specifica- tions match " uncursed ", you will probably want to turn the im- plicit_uncursed option off so that all items known to be uncursed - are actually displayed with the "uncursed" description. - - 9.12. Configuring User Sounds - - Some platforms allow you to define sound files to be played - when a message that matches a user-defined pattern is delivered - to the message window. At this time the Qt port and the win32tty - and win32gui ports support the use of user sounds. - - NetHack 3.7 December 18, 2019 @@ -4954,6 +4954,15 @@ + are actually displayed with the "uncursed" description. + + 9.12. Configuring User Sounds + + Some platforms allow you to define sound files to be played + when a message that matches a user-defined pattern is delivered + to the message window. At this time the Qt port and the win32tty + and win32gui ports support the use of user sounds. + The following configuration file entries are relevant to mapping user sounds to messages: @@ -4999,15 +5008,6 @@ OPTION=hilite_status:wisdom/down/red/up/green - Allowed colors are black, red, green, brown, blue, magenta, - cyan, gray, orange, light-green, yellow, light-blue, light-magen- - ta, light-cyan, and white. And "no-color", the default fore- - ground color on the display, which is not necessarily the same as - black or white or any of the other colors. - - Allowed attributes are none, bold, dim, underline, blink, - and inverse. "Normal" is a synonym for "none"; they should not - be used in combination with any of the other attributes. NetHack 3.7 December 18, 2019 @@ -5020,6 +5020,16 @@ + Allowed colors are black, red, green, brown, blue, magenta, + cyan, gray, orange, light-green, yellow, light-blue, light-magen- + ta, light-cyan, and white. And "no-color", the default fore- + ground color on the display, which is not necessarily the same as + black or white or any of the other colors. + + Allowed attributes are none, bold, dim, underline, blink, + and inverse. "Normal" is a synonym for "none"; they should not + be used in combination with any of the other attributes. + To specify both a color and an attribute, use `&' to combine them. To specify multiple attributes, use `+' to combine those. For example: "magenta&inverse+dim". @@ -5064,16 +5074,6 @@ * "always" will set the default attributes for that field. - * "up", "down" set the field attributes for when the field - value changes upwards or downwards. This attribute times - out after statushilites turns. - - * "changed" sets the field attribute for when the field val- - ue changes. This attribute times out after statushilites - turns. (If a field has both a "changed" rule and an "up" - or "down" rule which matches a change in the field's val- - ue, the "up" or "down" one takes precedence.) - NetHack 3.7 December 18, 2019 @@ -5086,6 +5086,16 @@ + * "up", "down" set the field attributes for when the field + value changes upwards or downwards. This attribute times + out after statushilites turns. + + * "changed" sets the field attribute for when the field val- + ue changes. This attribute times out after statushilites + turns. (If a field has both a "changed" rule and an "up" + or "down" rule which matches a change in the field's val- + ue, the "up" or "down" one takes precedence.) + * percentage sets the field attribute when the field value matches the percentage. It is specified as a number be- tween 0 and 100, followed by `%' (percent sign). If the @@ -5129,16 +5139,6 @@ The whole feature can be disabled by setting option sta- tushilites to 0. - Example hilites: - - - - - - - - - @@ -5152,6 +5152,8 @@ + Example hilites: + OPTION=hilite_status: gold/up/yellow/down/brown OPTION=hilite_status: characteristics/up/green/down/red OPTION=hilite_status: hitpoints/100%/gray&normal @@ -5203,8 +5205,6 @@ B S_bat (bat or bird) ^ S_bear_trap (bear trap) - S_blcorn (bottom left corner) - b S_blob (blob) - + S_book (spellbook) @@ -5218,6 +5218,8 @@ + b S_blob (blob) + + S_book (spellbook) ) S_boomleft (boomerang open left) ( S_boomright (boomerang open right) ` S_boulder (boulder) @@ -5269,8 +5271,6 @@ . S_hodbridge (horizontal lowered drawbridge) | S_hodoor (open door in horizontal wall) ^ S_hole (hole) - @ S_human (human or elf) - h S_humanoid (humanoid) @@ -5284,6 +5284,8 @@ + @ S_human (human or elf) + h S_humanoid (humanoid) - S_hwall (horizontal wall) . S_ice (ice) i S_imp (imp or minor demon) @@ -5335,8 +5337,6 @@ s S_spider (arachnid or centipede) ^ S_spiked_pit (spiked pit) ^ S_squeaky_board (squeaky board) - 0 S_ss1 (magic shield 1 of 4) - # S_ss2 (magic shield 2 of 4) @@ -5350,6 +5350,8 @@ + 0 S_ss1 (magic shield 1 of 4) + # S_ss2 (magic shield 2 of 4) @ S_ss3 (magic shield 3 of 4) * S_ss4 (magic shield 4 of 4) ^ S_statue_trap (statue trap) @@ -5401,8 +5403,6 @@ x S_xan (xan or other extraordinary insect) X S_xorn (xorn) Y S_yeti (apelike creature) - Z S_zombie (zombie) - z S_zruty (zruty) @@ -5416,6 +5416,8 @@ + Z S_zombie (zombie) + z S_zruty (zruty) S_pet_override (any pet if ACCESSIBILITY=1 is set) S_hero_override (hero if ACCESSIBILITY=1 is set) @@ -5468,8 +5470,6 @@ ficial distributions of NetHack is a symset called NHAccess. Se- lecting that symset in your configuration file will cause the game to run in a manner accessible to the blind. After you have - gained some experience with the game and with editing files, you - may want to alter settings via SYMBOLS= and ROGUESYMBOLS= in your NetHack 3.7 December 18, 2019 @@ -5482,6 +5482,8 @@ + gained some experience with the game and with editing files, you + may want to alter settings via SYMBOLS= and ROGUESYMBOLS= in your configuration file to better suit your preferences. See the pre- vious section for the special symbols S_pet_override to force a consistent symbol for all pets and S_hero_override to force a @@ -5536,8 +5538,6 @@ formation can be seen via the "#attributes" command. - - NetHack 3.7 December 18, 2019