diff --git a/doc/Guidebook.mn b/doc/Guidebook.mn index 9efe7ef12..d27c4281a 100644 --- a/doc/Guidebook.mn +++ b/doc/Guidebook.mn @@ -46,7 +46,7 @@ .ds f0 \*(vr .ds f1 \" empty .\"DO NOT REMOVE NH_DATESUB .ds f2 DATE(%B %-d, %Y) -.ds f2 January 29, 2024 +.ds f2 February 06, 2024 . .\" A note on some special characters: .\" \(lq = left double quote diff --git a/doc/Guidebook.tex b/doc/Guidebook.tex index f82fc01a8..89c2874f0 100644 --- a/doc/Guidebook.tex +++ b/doc/Guidebook.tex @@ -46,7 +46,7 @@ \author{Original version - Eric S. Raymond\\ (Edited and expanded for 3.7.0 by Mike Stephenson and others)} %DO NOT REMOVE NH_DATESUB \date{DATE(%B %-d, %Y)} -\date{January 29, 2024} +\date{February 06, 2024} \maketitle diff --git a/doc/Guidebook.txt b/doc/Guidebook.txt index 480eecf6b..e38c29136 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) - January 29, 2024 + February 06, 2024 @@ -126,7 +126,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -192,7 +192,7 @@ NetHack continues this fine tradition. Unlike text adventure games - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -258,7 +258,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -324,7 +324,7 @@ dealing with magic). It affects your magical energy. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -390,7 +390,7 @@ The number of turns elapsed so far, displayed if you have the - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -456,7 +456,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -522,7 +522,7 @@ vicious. Sometimes, however, they can be helpful. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -588,7 +588,7 @@ another location; `,' will explain the symbol but skip any - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -654,7 +654,7 @@ one class of objects present (where there won't be any "what - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -720,7 +720,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -786,7 +786,7 @@ and novelty (`P', recently picked up items; controlled by picking - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -852,7 +852,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -918,7 +918,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -984,7 +984,7 @@ not wielding a bow, you are throwing it by hand and it will - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -1050,7 +1050,7 @@ switch from normal play to "explore mode", also known as - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -1116,7 +1116,7 @@ (R)UNIX is a registered trademark of The Open Group. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -1182,7 +1182,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -1248,7 +1248,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -1314,7 +1314,7 @@ Engrave writing on the floor. Default key is `E'. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -1380,7 +1380,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -1446,7 +1446,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -1512,7 +1512,7 @@ tion:quit option to require a response of yes instead. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -1578,7 +1578,7 @@ Read a scroll, a spellbook, or something else. Default key is - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -1644,7 +1644,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -1710,7 +1710,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -1776,7 +1776,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -1842,7 +1842,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -1908,7 +1908,7 @@ bug mode only. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -1974,7 +1974,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -2040,7 +2040,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -2106,7 +2106,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -2172,7 +2172,7 @@ will eliminate the trap but failure will set off the trap's explosion. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -2238,7 +2238,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -2304,7 +2304,7 @@ tures will displace you during the climb. When that occurs, the pet - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -2370,7 +2370,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -2436,7 +2436,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -2502,7 +2502,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -2568,7 +2568,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -2634,7 +2634,7 @@ you'll either have to discard some of what you're carrying or collapse - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -2700,7 +2700,7 @@ avoid cursed objects than other character roles. Dropping objects - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -2766,7 +2766,7 @@ changes your primary (the one being wielded) and alternate weapons. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -2832,7 +2832,7 @@ quiver. The fire command also has extra assistance, if fireassist is - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -2898,7 +2898,7 @@ the next skill level (unless you've already reached the limit for this - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -2964,7 +2964,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -3030,7 +3030,7 @@ "food." Many, but not all, of these are edible; some also give you - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -3096,7 +3096,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -3162,7 +3162,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -3228,7 +3228,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -3294,7 +3294,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -3360,7 +3360,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -3426,7 +3426,7 @@ either. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -3492,7 +3492,7 @@ with your hands and feet. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -3558,7 +3558,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -3624,7 +3624,7 @@ Big Room level is not always present. Unlike with the Novel, there's - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -3690,7 +3690,7 @@ file, NetHack will create one for you using the default template file. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -3756,7 +3756,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -3822,7 +3822,7 @@ Highlight menu lines with different colors. See the "Configuring - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -3888,7 +3888,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -3954,7 +3954,7 @@ If it does start with `/', the at-sign is optional. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -4020,7 +4020,7 @@ the blessed/cursed status, enchantment, damage, or quality of the - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -4086,7 +4086,7 @@ Synonym for "role" to pick the type of your character (for example - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -4152,7 +4152,7 @@ Asking refers to picking one of the orderings from a menu. The `+' - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -4218,7 +4218,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -4284,7 +4284,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -4350,7 +4350,7 @@ Controls the method used when you need to choose various objects (in - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -4416,7 +4416,7 @@ Key to go to the previous menu page. Default `<'. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -4482,7 +4482,7 @@ defaults to "full"), or it can be negated (which defaults to - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -4548,7 +4548,7 @@ Confirm - for any prompts which are set to require "yes" rather - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -4614,7 +4614,7 @@ - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -4652,35 +4652,35 @@ choices might not work, depending upon terminal hardware or terminal emulation software. - Currently multiple highlight-style letters can be combined by simply - stringing them together (for example, "bk"), but in the future they - might require being separated by plus signs (such as "b+k", which - works already). When using the `n' choice, it 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". + 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 hon- ored when playing a knight. Cannot be set with the `O' command. pickup_burden - When you pick up an item that would exceed this encumbrance level - (Unencumbered, Burdened, streSsed, straiNed, overTaxed, or over- - Loaded), you will be asked if you want to continue. (Default `S'). + When you pick up an item that would exceed this encumbrance level + (Unencumbered, Burdened, streSsed, straiNed, overTaxed, or over- + Loaded), you will be asked if you want to continue. (Default `S'). Persistent. pickup_stolen - If this option is on and autopickup is also on, try to pick up - things that a monster stole from you, even if they aren't in + If this option is on and autopickup is also on, try to pick up + things that a monster stole from you, even if they aren't in pickup_types or match an autopickup exception. Default is on. Per- sistent. + pickup_thrown + If this option is on and autopickup is also on, try to pick up + things that you threw, even if they aren't in pickup_types or match + an autopickup exception. Default is on. Persistent. - NetHack 3.7.0 January 29, 2024 + + + NetHack 3.7.0 February 06, 2024 @@ -4690,63 +4690,63 @@ - pickup_thrown - If this option is on and autopickup is also on, try to pick up - things that you threw, even if they aren't in pickup_types or match - an autopickup exception. Default is on. Persistent. - pickup_types Specify the object types to be picked up when autopickup is on. De- fault is all types. Persistent. - The value is a list of object symbols, such as pickup_types:$?! to - pick up gold, scrolls, and potions. You can use autopickup_excep- + The value is a list of object symbols, such as pickup_types:$?! to + pick up gold, scrolls, and potions. You can use autopickup_excep- tion configuration file lines to further refine autopickup behavior. - There is no way to set pickup_types to "none". (Setting it to an - empty value reverts to "all".) If you want to avoid automatically - picking up any types of items but do want to have autopickup on in - order to have autopickup_exception settings control what you do and - don't pick up, you can set pickup_types to `.'. That is the type - symbol for venom and you won't come across any venom items so won't + There is no way to set pickup_types to "none". (Setting it to an + empty value reverts to "all".) If you want to avoid automatically + picking up any types of items but do want to have autopickup on in + order to have autopickup_exception settings control what you do and + don't pick up, you can set pickup_types to `.'. That is the type + symbol for venom and you won't come across any venom items so won't unintentionally pick such up. pile_limit - When walking across a pile of objects on the floor, threshold at + When walking across a pile of objects on the floor, threshold at which the message "there are few/several/many objects here" is given - instead of showing a popup list of those objects. A value of 0 + instead of showing a popup list of those objects. A value of 0 means "no limit" (always list the objects); a value of 1 effectively means "never show the objects" since the pile size will always be at least that big; default value is 5. Persistent. playmode Values are "normal", "explore", or "debug". Allows selection of ex- - plore mode (also known as discovery mode) or debug mode (also known - as wizard mode) instead of normal play. Debug mode 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 + plore mode (also known as discovery mode) or debug mode (also known + as wizard mode) instead of normal play. Debug mode 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 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). Like- - wise for the `a' (apply) command if it causes the applied item to + the old item into your alternate weapon slot (default off). Like- + wise 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 whenever clairvoy- - ance randomly activates. Some situations, such as being underwater - or engulfed, ignore this option. It does not affect the clairvoy- - ance spell where pausing to examine revealed objects or monsters is + where play pauses to allow you to browse the map whenever clairvoy- + ance randomly activates. Some situations, such as being underwater + or engulfed, ignore this option. It does not affect the clairvoy- + ance spell where pausing to examine revealed objects or monsters is less intrusive. Default is off. Persistent. + race + Selects your race (for example, race:human). Choices are human, + dwarf, elf, gnome, and orc but most roles restrict which of the non- + human races are allowed. See role for a description of how to use + negation to exclude choices. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -4756,26 +4756,20 @@ - race - Selects your race (for example, race:human). Choices are human, - dwarf, elf, gnome, and orc but most roles restrict which of the non- - human races are allowed. See role for a description of how to use - negation to exclude choices. - Default is random. Cannot be set with the `O' command. Persistent. rest_on_space - Make the space bar a synonym for the `.' (#wait) command (default + Make the space bar a synonym for the `.' (#wait) command (default off). Persistent. role Pick your type of character (for example, role:Samurai); synonym for - character. See name for an alternate method of specifying your + character. See name for an alternate method of specifying your role. - This option can also be used to limit selection when role is chosen - randomly. Use a space-separated list of roles and either negate - each one or negate the option itself instead. Negation is accom- + This option can also be used to limit selection when role is chosen + randomly. Use a space-separated list of roles and either negate + each one or negate the option itself instead. Negation is accom- plished in the same manner as with boolean options, by prefixing the option or its value(s) with `!' or "no". Examples: @@ -4783,7 +4777,7 @@ OPTIONS=role:!arc !bar !kni OPTIONS=!role:arc bar kni - There can be multiple instances of the role option if they're all + There can be multiple instances of the role option if they're all negations. Default is random. Cannot be set with the `O' command. Persistent. @@ -4794,14 +4788,14 @@ rogue level. rlecomp - When writing out a save file, perform run length compression of the + 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. runmode - Controls the amount of screen updating for the map window when en- - gaged in multi-turn movement (running via shift+direction or con- - trol+direction and so forth, or via the travel command or mouse + Controls the amount of screen updating for the map window when en- + gaged in multi-turn movement (running via shift+direction or con- + trol+direction and so forth, or via the travel command or mouse click). The possible values are: teleport - update the map after movement has finished; @@ -4809,10 +4803,16 @@ walk - update the map after each step; crawl - like walk, but pause briefly after each step. - This option only affects the game's screen display, not the actual + This option only affects the game's screen display, not the actual + results of moving. The default is "run"; versions prior to 3.4.1 + used "teleport" only. Whether or not the effect is noticeable will + depend upon the window port used or on the type of terminal. Per- + sistent. - NetHack 3.7.0 January 29, 2024 + + + NetHack 3.7.0 February 06, 2024 @@ -4822,41 +4822,36 @@ - results of moving. The default is "run"; versions prior to 3.4.1 - used "teleport" only. Whether or not the effect is noticeable will - depend upon the window port used or on the type of terminal. Per- - sistent. - safe_pet Prevent you from (knowingly) attacking your pets (default on). Per- sistent. safe_wait - Prevents you from waiting or searching when next to a hostile mon- + Prevents you from waiting or searching when next to a hostile mon- ster (default on). Persistent. sanity_check - Evaluate monsters, objects, and map prior to each turn (default + Evaluate monsters, objects, and map prior to each turn (default off). Debug mode only. scores - Control what parts of the score list you are shown at the end (for - example "scores:5 top scores/4 around my score/own scores"). Only - the first letter of each category (`t', `a', or `o') is necessary. + Control what parts of the score list you are shown at the end (for + example "scores:5 top scores/4 around my score/own scores"). Only + the first letter of each category (`t', `a', or `o') is necessary. Persistent. showexp - Show your accumulated experience points on bottom line (default + 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 affects only - the appearance of the display, not the way the game treats you. + Display yourself as the glyph for your race, rather than the glyph + for your role (default off). Note that this setting affects only + the appearance of the display, not the way the game treats you. Persistent. showscore - Show your approximate accumulated score on bottom line (default + Show your approximate accumulated score on bottom line (default off). Persistent. silent @@ -4868,17 +4863,22 @@ The possible values are: - o - list object types by class, in discovery order within each + o - list object types by class, in discovery order within each class; default; - s - list object types by sortloot classification: by class, by sub- - class within class for classes which have substantial groupings - (like helmets, boots, gloves, and so forth for armor), with ob- - ject types partly-discovered via assigned name coming before + s - list object types by sortloot classification: by class, by sub- + class within class for classes which have substantial groupings + (like helmets, boots, gloves, and so forth for armor), with ob- + ject types partly-discovered via assigned name coming before fully identified types; c - list by class, alphabetically within each class; + a - list alphabetically across all classes. + + Can be interactively set via the `O' command or via using the `m' + prefix before the `\' or ``' command. - NetHack 3.7.0 January 29, 2024 + + NetHack 3.7.0 February 06, 2024 @@ -4888,24 +4888,19 @@ - a - list alphabetically across all classes. - - Can be interactively set via the `O' command or via using the `m' - prefix before the `\' or ``' command. - sortloot - Controls the sorting behavior of the pickup lists for inventory and + Controls the sorting behavior of the pickup lists for inventory and #loot commands and some others. Persistent. The possible values are: full - always sort the lists; - loot - only sort the lists that don't use inventory letters, like + loot - only sort the lists that don't use inventory letters, like with the #loot and pickup commands; none - show lists the traditional way without sorting; default. sortpack - Sort the pack contents by type when displaying inventory (default + Sort the pack contents by type when displaying inventory (default on). Persistent. sortvanquished @@ -4916,17 +4911,17 @@ t - traditional--order by monster level; ties are broken by internal monster index; default; - d - order by monster difficulty rating; ties broken by internal in- + d - order by monster difficulty rating; ties broken by internal in- dex; - a - order alphabetically, first any unique monsters then all the + 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 #genocided com- + Can be interactively set via the `m O' command or via using the `m' + prefix before either the #vanquished command or the #genocided com- mand. sounds @@ -4934,7 +4929,7 @@ on). sparkle - Display a sparkly effect when a monster (including yourself) is hit + Display a sparkly effect when a monster (including yourself) is hit by an attack to which it is resistant (default on). Persistent. spot_monsters @@ -4943,8 +4938,13 @@ standout Boldface monsters and "--More--" (default off). Persistent. + statushilites + Controls how many turns status hilite behaviors highlight the field. + If negated or set to zero, disables status hiliting. See "Configur- + ing Status Hilites" for further information. - NetHack 3.7.0 January 29, 2024 + + NetHack 3.7.0 February 06, 2024 @@ -4954,34 +4954,29 @@ - statushilites - Controls how many turns status hilite behaviors highlight the field. - If negated or set to zero, disables status hiliting. See "Configur- - ing Status Hilites" for further information. - status_updates - Allow updates to the status lines at the bottom of the screen (de- + Allow updates to the status lines at the bottom of the screen (de- fault true). suppress_alert - This option may be set to a NetHack version level to suppress alert - notification messages about feature changes for that and prior ver- + This option may be set to a NetHack version level to suppress alert + notification messages about feature changes for that and prior ver- sions (for example "suppress_alert:3.3.1"). symset This option may be used to select one of the named symbol sets found - within "symbols" to alter the symbols displayed on the screen. Use + within "symbols" to alter the symbols displayed on the screen. Use "symset:default" to explicitly select the default symbols. time - Show the elapsed game time in turns on bottom line (default off). + Show the elapsed game time in turns on bottom line (default off). Persistent. timed_delay When pausing momentarily for display effect, such as with explosions and moving objects, use a timer rather than sending extra characters - to the screen. (Applies to "tty" and "curses" interfaces only; - "X11" interface always uses a timer-based delay. The default is on + to the screen. (Applies to "tty" and "curses" interfaces only; + "X11" interface always uses a timer-based delay. The default is on if configured into the program.) Persistent. tips @@ -5000,17 +4995,22 @@ travel Allow the travel command via mouse click (default on). Turning this option off will prevent the game from attempting unintended moves if - you make inadvertent mouse clicks on the map window. Does not af- + you make inadvertent mouse clicks on the map window. Does not af- fect traveling via the `_' ("#travel") command. Persistent. tutorial Play a tutorial level at the start of the game. Setting this option on or off in the config file will skip the query. + verbose + Provide more commentary during the game (default on). Persistent. + + whatis_coord + When using the `/' or `;' commands to look around on the map with + autodescribe on, display coordinates after the description. Also - - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -5020,12 +5020,6 @@ - verbose - Provide more commentary during the game (default on). Persistent. - - whatis_coord - When using the `/' or `;' commands to look around on the map with - autodescribe on, display coordinates after the description. Also works in other situations where you are asked to pick a location. The possible settings are: @@ -5036,21 +5030,21 @@ s - screen [row,column] (row is offset to match tty usage); n - none (no coordinates shown) [default]. - The whatis_coord option is also used with the "/m", "/M", "/o", and - "/O" sub-commands of `/', where the "none" setting is overridden + The whatis_coord option is also used with the "/m", "/M", "/o", and + "/O" sub-commands of `/', where the "none" setting is overridden with "map". whatis_filter - When getting a location on the map, and using the keys to cycle - through next and previous targets, allows filtering the possible + When getting a location on the map, and using the keys to cycle + through next and previous targets, allows filtering the possible 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 + 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 "get- @@ -5058,25 +5052,31 @@ whatis_menu When getting a location on the map, and using a key to cycle through - next and previous targets, use a menu instead to pick a target. + next and previous targets, use a menu instead to pick a target. (default off) whatis_moveskip - When getting a location on the map, and using shifted movement keys - or meta-digit keys to fast-move, instead of moving 8 units at a + When getting a location on the map, and using shifted movement keys + or meta-digit keys to fast-move, instead of moving 8 units at a time, move by skipping the same glyphs. (default off) windowtype - When the program has been built to support multiple interfaces, se- - lect which one to use, such as "tty" or "X11" (default depends on - build-time settings; use "#version" to check). Cannot be set with + When the program has been built to support multiple interfaces, se- + lect which one to use, such as "tty" or "X11" (default depends on + build-time settings; use "#version" to check). Cannot be set with the `O' command. - When used, it should be the first option set since its value might - enable or disable the availability of various other options. For + When used, it should be the first option set since its value might + enable or disable the availability of various other options. For + multiple lines in a configuration file, that would be the first non- + comment line. For a comma-separated list in NETHACKOPTIONS or an + OPTIONS line in a configuration file, that would be the rightmost + option in the list. - NetHack 3.7.0 January 29, 2024 + + + NetHack 3.7.0 February 06, 2024 @@ -5086,48 +5086,43 @@ - multiple lines in a configuration file, that would be the first non- - comment line. For a comma-separated list in NETHACKOPTIONS or an - OPTIONS line in a configuration file, that would be the rightmost - option in the list. - wizweight - Augment object descriptions with their objects' weight (default + Augment object descriptions with their objects' weight (default off). Debug mode only. zerocomp - When writing out a save file, perform zero-comp compression of the + When writing out a save file, perform zero-comp compression of the contents. Not all ports support zero-comp compression. It has no ef- fect on reading an existing save file. 9.5. Window Port Customization options - Here are explanations of the various options that are used to - customize and change the characteristics of the windowtype that you - have chosen. Character strings that are too long may be truncated. - Not all window ports will adjust for all settings listed here. You + Here are explanations of the various options that are used to + customize and change the characteristics of the windowtype that you + have chosen. Character strings that are too long may be truncated. + Not all window ports will adjust for all settings listed here. You can safely add any of these options to your configuration file, and if - the window port is capable of adjusting to suit your preferences, it - will attempt to do so. If it can't it will silently ignore it. You + the window port is capable of adjusting 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 + 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 + Where to align or place the status window (top, bottom, left, or right). ascii_map - If NetHack can, it should display the map using simple characters - (letters and punctuation) rather than tiles graphics. In some - cases, characters can be augmented with line-drawing symbols; use - the symset option to select a symbol set such as DECgraphics or - IBMgraphics if your display supports them. Setting ascii_map to + If NetHack can, it should display the map using simple characters + (letters and punctuation) rather than tiles graphics. In some + cases, characters can be augmented with line-drawing symbols; use + the symset option to select a symbol set such as DECgraphics or + IBMgraphics if your display supports them. Setting ascii_map to True forces tiled_map to be False. color @@ -5136,13 +5131,18 @@ eight_bit_tty If NetHack can, it should pass eight-bit character values (for exam- - ple, specified with the traps option) straight through to your ter- + ple, specified with the traps option) straight through to your ter- minal (default off). + font_map + if NetHack can, it should use a font by the chosen name for the map + window. + + font_menu + If NetHack can, it should use a font by the chosen name for menu - - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -5152,12 +5152,6 @@ - font_map - if NetHack can, it should use a font by the chosen name for the map - window. - - font_menu - If NetHack can, it should use a font by the chosen name for menu windows. font_message @@ -5169,7 +5163,7 @@ tus window. font_text - If NetHack can, it should use a font by the chosen name for text + If NetHack can, it should use a font by the chosen name for text windows. font_size_map @@ -5188,12 +5182,12 @@ 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 + If NetHack can, it should try and display on the entire screen rather than in a window. guicolor - Use color text and/or highlighting attributes when displaying some - non-map data (such as menu selector letters). Curses interface + Use color text and/or highlighting attributes when displaying some + non-map data (such as menu selector letters). Curses interface only; default is on. large_font @@ -5203,12 +5197,18 @@ If NetHack can, it should display the map in the manner specified. player_selection - If NetHack can, it should pop up dialog boxes, or use prompts for + If NetHack can, it should pop up dialog boxes, or use prompts for character selection. + popup_dialog + If NetHack can, it should pop up dialog boxes for input. + + preload_tiles + If NetHack can, it should preload tiles into memory. For example, + in the protected mode MS-DOS version, control whether tiles get pre- - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -5218,14 +5218,8 @@ - popup_dialog - If NetHack can, it should pop up dialog boxes for input. - - preload_tiles - If NetHack can, it should preload tiles into memory. For example, - in the protected mode MS-DOS version, control whether tiles get pre- loaded into RAM at the start of the game. Doing so enhances perfor- - mance of the tile graphics, but uses more memory. (default on). + mance of the tile graphics, but uses more memory. (default on). Cannot be set with the `O' command. scroll_amount @@ -5242,39 +5236,45 @@ support this option. softkeyboard - Display an onscreen keyboard. Handhelds are most likely to support + 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 + 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. Ac- + Number of lines for traditional below-the-map status display. Ac- ceptable values are 2 and 3 (default is 2). When set to 3, the tty interface moves some fields around and mainly - shows status conditions on their own line. A display capable of - showing at least 25 lines is recommended. The value can be toggled + shows status conditions on their own line. A display capable of + showing at least 25 lines is recommended. The value can be toggled back and forth during the game with the `O' command. The curses interface does likewise if the align_status option is set to top or bottom but ignores statuslines when set to left or right. - The Qt interface already displays more than 3 lines for status so + The Qt interface already displays more than 3 lines for status so uses the statuslines value differently. A value of 3 renders status in the Qt interface's original format, with the status window spread - out vertically. A value of 2 makes status be slightly condensed, - moving some fields to different lines to eliminate one whole line, + out vertically. A value of 2 makes status be slightly condensed, + moving some fields to different lines to eliminate one whole line, reducing the height needed. (If NetHack has been built using a ver- - sion of Qt older than qt-5.9, statuslines can only be set in the - run-time configuration file or via NETHACKOPTIONS, not during play + sion of Qt older than qt-5.9, statuslines can only be set in the + run-time configuration file or via NETHACKOPTIONS, not during play with the `O' command.) + term_cols and + + term_rows + Curses interface only. Number of columns and rows to use for the + display. Curses will attempt to resize to the values specified but + will settle for smaller sizes if they are too big. Default is the + current window size. - - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -5284,20 +5284,12 @@ - term_cols and - - term_rows - Curses interface only. Number of columns and rows to use for the - display. Curses will attempt to resize to the values specified but - will settle for smaller sizes if they are too big. Default is the - current window size. - tile_file - Specify the name of an alternative tile file to override the de- + Specify the name of an alternative tile file to override the de- fault. - Note: the X11 interface uses X resources rather than NetHack's op- - tions to select an alternate tile file. See NetHack.ad, the sample + Note: the X11 interface uses X resources rather than NetHack's op- + tions to select an alternate tile file. See NetHack.ad, the sample X "application defaults" file. tile_height @@ -5307,20 +5299,20 @@ 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, possibly - augmented by line-drawing symbols). Setting tiled_map to True + If NetHack can, it should display the map using tiles graphics + rather than simple characters (letters and punctuation, possibly + 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). use_inverse - If NetHack can, it should display inverse when the game specifies + If NetHack can, it should display inverse when the game specifies it. vary_msgcount - If NetHack can, it should display this number of messages at a time + If NetHack can, it should display this number of messages at a time in the message window. windowborders @@ -5334,13 +5326,21 @@ 3 - on, except forced off for perm_invent 4 - auto, except forced off for perm_invent - (The 26x82 size threshold for `2' refers to number of rows and + (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 to show borders if align_status is set to left or right.) + The persistent inventory window, when enabled, can grow until it is + too big to fit on most displays, resulting in truncation of its con- + tents. If borders are forced on (1) or the display is big enough to + show them (2), setting the value to 3 or 4 instead will keep borders + for the map, message, and status windows but have room for two addi- + tional lines of inventory plus widen each inventory line by two + columns. - NetHack 3.7.0 January 29, 2024 + + NetHack 3.7.0 February 06, 2024 @@ -5350,63 +5350,63 @@ - The persistent inventory window, when enabled, can grow until it is - too big to fit on most displays, resulting in truncation of its con- - tents. If borders are forced on (1) or the display is big enough to - show them (2), setting the value to 3 or 4 instead will keep borders - for the map, message, and status windows but have room for two addi- - tional lines of inventory plus widen each inventory line by two - columns. - windowcolors - If NetHack can, it should display windows with the specified fore- + If NetHack can, it should display windows with the specified fore- ground/background colors. Windows GUI only. The format is OPTION=windowcolors:wintype foreground/background - where wintype is one of "menu", "message", "status", or "text", + where wintype is one of "menu", "message", "status", or "text", and foreground and background are colors, either a hexadecimal - \'#rrggbb', one of the named colors (black, red, green, brown, blue, + \'#rrggbb', one of the named colors (black, red, green, brown, blue, magenta, cyan, orange, brightgreen, yellow, brightblue, brightmagenta, - brightcyan, white, trueblack, gray, purple, silver, maroon, fuchsia, - lime, olive, navy, teal, aqua), or one of Windows UI colors (active- - border, activecaption, appworkspace, background, btnface, btnshadow, - btntext, captiontext, graytext, greytext, highlight, highlighttext, - inactiveborder, inactivecaption, menu, menutext, scrollbar, window, + brightcyan, white, trueblack, gray, purple, silver, maroon, fuchsia, + lime, olive, navy, teal, aqua), or one of Windows UI colors (active- + border, activecaption, appworkspace, background, btnface, btnshadow, + btntext, captiontext, graytext, greytext, highlight, highlighttext, + inactiveborder, inactivecaption, menu, menutext, scrollbar, window, windowframe, windowtext). wraptext - If NetHack can, it should wrap long lines of text if they don't fit + If NetHack can, it should wrap long lines of text if they don't fit in the visible area of the window. 9.6. Platform-specific Customization options - Here are explanations of options that are used by specific plat- + Here are explanations of options that are used by specific plat- forms or ports to customize and change the port behavior. altkeyhandling - Select an alternate way to handle keystrokes (Win32 tty NetHack - only). The name of the handling type is one of "default", "ray", + Select an alternate way to handle keystrokes (Win32 tty NetHack + only). The name of the handling type is one of "default", "ray", "340". altmeta - On systems where this option is available, it can be set to tell - NetHack to convert a two character sequence beginning with ESC into + On systems where this option is available, it can be set to tell + NetHack to convert a two character sequence beginning with ESC into a meta-shifted version of the second character (default off). - This conversion is only done for commands, not for other input - prompts. Note that typing one or more digits as a count prefix - prior to a command--preceded by n if the number_pad option is set-- + This conversion is only done for commands, not for other input + prompts. Note that typing one or more digits as a count prefix + prior to a command--preceded by n if the number_pad option is set-- is also subject to this conversion, so attempting to 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 + 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 + Use BIOS calls to update the screen display quickly and to read the + keyboard (allowing the use of arrow keys to move) on machines with + an IBM PC compatible BIOS ROM (default off, OS/2, PC, and ST NetHack + only). + + rawio + Force raw (non-cbreak) mode for faster output and more bulletproof + input (MS-DOS sometimes treats `^P' as a printer toggle without it) + (default off, OS/2, PC, and ST NetHack only). Note: DEC Rainbows - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -5416,32 +5416,24 @@ - keyboard (allowing the use of arrow keys to move) on machines with - an IBM PC compatible BIOS ROM (default off, OS/2, PC, and ST NetHack - only). - - rawio - Force raw (non-cbreak) mode for faster output and more bulletproof - input (MS-DOS sometimes treats `^P' as a printer toggle without it) - (default off, OS/2, PC, and ST NetHack only). 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 key- + (Win32 tty NetHack only). May be used to alter the value of key- strokes that the operating system returns to NetHack to help compen- - sate for international keyboard issues. OPTIONS=subkeyvalue:171/92 - will return 92 to NetHack, if 171 was originally going to be re- + sate for international keyboard issues. OPTIONS=subkeyvalue:171/92 + will return 92 to NetHack, if 171 was originally going to be re- turned. You can use multiple subkeyvalue assignments in the config- uration file if needed. Cannot be set with the `O' command. video Set the video mode used (PC NetHack only). Values are "autodetect", - "default", "vga", or "vesa". Setting "vesa" will cause the game to - display tiles, using the full capability of the VGA hardware. Set- + "default", "vga", or "vesa". Setting "vesa" will cause the game to + display tiles, using the full capability of the VGA hardware. Set- ting "vga" will cause the game to display tiles, fixed at 640x480 in - 16 colors, a mode that is compatible with all VGA hardware. Third - party tilesets will probably not work. Setting "autodetect" at- - tempts "vesa", then "vga", and finally sets "default" if neither of + 16 colors, a mode that is compatible with all VGA hardware. Third + party tilesets will probably not work. Setting "autodetect" at- + tempts "vesa", then "vga", and finally sets "default" if neither of those modes works. Cannot be set with the `O' command. video_height @@ -5451,28 +5443,36 @@ Set the VGA mode resolution width (MS-DOS only, with video:vesa) videocolors - Set the color palette for PC systems using NO_TERMS (default - 4-2-6-1-5-3-15-12-10-14-9-13-11, (PC NetHack only). The order of - colors is red, green, brown, blue, magenta, cyan, bright.white, - bright.red, bright.green, yellow, bright.blue, bright.magenta, and + Set the color palette for PC systems using NO_TERMS (default + 4-2-6-1-5-3-15-12-10-14-9-13-11, (PC NetHack only). The order of + colors is red, green, brown, blue, magenta, cyan, bright.white, + bright.red, bright.green, yellow, bright.blue, bright.magenta, and bright.cyan. Cannot be set with the `O' command. videoshades - Set the intensity level of the three gray scales available (default - dark normal light, PC NetHack only). If the game display is diffi- - cult to read, try adjusting these scales; if this does not correct + Set the intensity level of the three gray scales available (default + dark normal light, PC NetHack only). If the game display is diffi- + cult to read, try adjusting these scales; if this does not correct the problem, try !color. Cannot be set with the `O' command. 9.7. Regular Expressions - Regular expressions are normally POSIX extended regular expres- - sions. It is possible to compile NetHack without regular expression - support on a platform where there is no regular expression library. - While this is not true of any modern platform, if your NetHack was - built this way, patterns are instead glob patterns. This applies to + Regular expressions are normally POSIX extended regular expres- + sions. It is possible to compile NetHack without regular expression + support on a platform where there is no regular expression library. + While this is not true of any modern platform, if your NetHack was + built this way, patterns are instead glob patterns. 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 be- + yond what is available through the pickup_types option. - NetHack 3.7.0 January 29, 2024 + + + NetHack 3.7.0 February 06, 2024 @@ -5482,35 +5482,28 @@ - Autopickup exceptions, Message types, Menu colors, and User sounds. - - 9.8. Configuring Autopickup Exceptions - - You can further refine the behavior of the autopickup option be- - yond 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 au- + you can define patterns to be checked when the game is about to au- topickup something. autopickup_exception Sets an exception to the pickup_types option. The autopickup_excep- tion option should be followed by a regular expression to be used as - a pattern to match against the singular form of the description of + a pattern to match against the singular form of the description of an object at your location. - In addition, some characters are treated specially if they occur as + In addition, some characters are treated specially if they occur as the first character in the pattern, specifically: < - always pickup an object that matches rest of pattern; > - never pickup an object that matches rest of pattern. - The autopickup_exception rules are processed in the order in which - they appear in your configuration file, thus allowing a later rule + The autopickup_exception rules are processed in the order in which + they appear in your configuration file, thus allowing a later rule to override an earlier rule. Exceptions can be set with the `O' command, but because they are not - included in your configuration file, they won't be in effect if you + included in your configuration file, they won't be in effect if you save and then restore your game. autopickup_exception rules and not saved with the game. @@ -5520,25 +5513,32 @@ autopickup_exception=">*corpse" autopickup_exception=">* cursed*" - The first example above will result in autopickup of any type of + The first example above will result in autopickup of any type of arrow. The second example results in the exclusion of any corpse from - autopickup. The last example results in the exclusion of items known + autopickup. The last example results in the exclusion 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"), a + 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"), a mouse button, or a three-digit decimal ASCII code. For example: + BIND=^X:getpos.autodescribe + BIND=\:menu_first_page + BIND=v:loot + + Extended command keys + You can bind multiple keys to the same extended command. Unbind a + key by using "nothing" as the extended command to bind to. You can - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -5548,63 +5548,63 @@ - BIND=^X:getpos.autodescribe - BIND=\:menu_first_page - BIND=v:loot - - Extended command keys - You can bind multiple keys to the same extended command. Unbind a - key by using "nothing" as the extended command to bind to. You can also bind the "", "", and "" keys. Menu accelerator keys The menu control or accelerator keys can also be rebound via OPTIONS - lines in the configuration file. You cannot bind object symbols or + lines in the configuration file. You cannot bind object symbols or selection letters into menu accelerators. Some interfaces only sup- port some of the menu accelerators. Mouse buttons - You can bind "mouse1" or "mouse2" to "nothing", "therecmdmenu", + You can bind "mouse1" or "mouse2" to "nothing", "therecmdmenu", "clicklook", or "mouseaction". Special command keys - Below are the special commands you can rebind. Some of them can be - bound to same keys with no problems, others are in the same "con- + Below are the special commands you can rebind. Some of them can be + bound to same keys with no problems, others are in the same "con- text", and if bound to same keys, only one of those commands will be available. Special command can only be bound to a single key. count - Prefix key to start a count, to repeat a command this many times. + Prefix key to start a count, to repeat a command this many times. With number_pad only. Default is `n'. getdir.help - When asked for a direction, the key to show the help. Default is + When asked for a direction, the key to show the help. Default is `?'. getdir.mouse - When asked for a direction, the key to initiate a simulated mouse - click. You will be asked to pick a location. Use movement key- - strokes to move the cursor around the map, then type the get- + When asked for a direction, the key to initiate a simulated mouse + click. You will be asked to pick a location. Use movement key- + strokes to move the cursor around the map, then type the get- pos.pick.once key (default `,') or the getpos.pick key (default `.') - to finish as if performing a left or right click. Only useful when + to finish as if performing a left or right click. Only useful when using the #therecmdmenu command. Default is `_'. getdir.self - When asked for a direction, the key to target yourself. Default is + When asked for a direction, the key to target yourself. Default is `.'. getdir.self2 - When asked for a direction, an alternate key to target yourself. + When asked for a direction, an alternate key to target yourself. Default is `s'. getpos.autodescribe - When asked for a location, the key to toggle autodescribe. Default + When asked for a location, the key to toggle autodescribe. Default is `#'. + getpos.all.next + When asked for a location, the key to go to next closest interesting + thing. Default is `a'. + + getpos.all.prev + When asked for a location, the key to go to previous closest inter- + esting thing. Default is `A'. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -5614,16 +5614,8 @@ - getpos.all.next - When asked for a location, the key to go to next closest interesting - thing. Default is `a'. - - getpos.all.prev - When asked for a location, the key to go to previous closest inter- - esting thing. Default is `A'. - getpos.door.next - When asked for a location, the key to go to next closest door or + When asked for a location, the key to go to next closest door or doorway. Default is `d'. getpos.door.prev @@ -5634,15 +5626,15 @@ When asked for a location, the key to show help. Default is `?'. getpos.mon.next - When asked for a location, the key to go to next closest monster. + When asked for a location, the key to go to next closest monster. Default is `m'. getpos.mon.prev - When asked for a location, the key to go to previous closest mon- + When asked for a location, the key to go to previous closest mon- ster. Default is `M'. getpos.obj.next - When asked for a location, the key to go to next closest object. + When asked for a location, the key to go to next closest object. Default is `o'. getpos.obj.prev @@ -5650,27 +5642,35 @@ Default is `O'. getpos.menu - When asked for a location, and using one of the next or previous - keys to cycle through targets, toggle showing a menu instead. De- + When asked for a location, and using one of the next or previous + keys to cycle through targets, toggle showing a menu instead. De- fault is `!'. getpos.moveskip - When asked for a location, and using the shifted movement keys or - meta-digit keys to fast-move around, move by skipping the same + When asked for a location, and using the shifted movement keys 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 be- - tween no filtering, in view only, and in the same area only. De- + When asked for a location, change the filtering mode when using one + of the next or previous keys to cycle through targets. Toggles be- + tween no filtering, in view only, and in the same area only. De- fault is `"'. getpos.pick - When asked for a location, the key to choose the location, and pos- - sibly ask for more info. When simulating a mouse click after being + When asked for a location, the key to choose the location, and pos- + sibly ask for more info. When simulating a mouse click after being + asked for a direction (see getdir.mouse above), the key to use to + respond as right click. Default is `.'. + + getpos.pick.once + 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. Default is + `,'. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -5680,38 +5680,29 @@ - asked for a direction (see getdir.mouse above), the key to use to - respond as right click. Default is `.'. - - getpos.pick.once - 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. Default is - `,'. - getpos.pick.quick When asked for a location, the key to choose the location, skip ask- - ing for more info, and exit the location asking loop. Default is + ing for more info, and exit the location asking loop. Default is `;'. getpos.pick.verbose - When asked for a location, the key to choose the location, and show + When asked for a location, the key to choose the location, and show more info without asking. Default is `:'. getpos.self - When asked for a location, the key to go to your location. Default + When asked for a location, the key to go to your location. Default is `@'. getpos.unexplored.next - When asked for a location, the key to go to next closest unexplored + When asked for a location, the key to go to next closest unexplored location. Default is `x'. getpos.unexplored.prev - When asked for a location, the key to go to previous closest unex- + When asked for a location, the key to go to previous closest unex- plored location. Default is `X'. getpos.valid - When asked for a location, the key to go to show valid target loca- + When asked for a location, the key to go to show valid target loca- tions. Default is `$'. getpos.valid.next @@ -5719,24 +5710,33 @@ tion. Default is `z'. getpos.valid.prev - When asked for a location, the key to go to previous closest valid + When asked for a location, the key to go to previous closest valid location. Default is `Z'. 9.10. Configuring Message Types - You can change the way the messages are shown in the message + You can change the way the messages are shown in the message area, when the message matches a user-defined pattern. - In general, the configuration file entries to describe the mes- + In general, the configuration file entries to describe the mes- sage 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 message is + shown in between. - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024 @@ -5746,24 +5746,14 @@ - 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 message is - shown in between. - - Here's an example of message types using NetHack's internal pattern + Here's an example of message types using NetHack's internal pattern matching facility: MSGTYPE=stop "You feel hungry." MSGTYPE=hide "You displaced *." - specifies that whenever a message "You feel hungry" is shown, the - user is prompted with more-prompt, and a message matching "You dis- + specifies that whenever a message "You feel hungry" is shown, the + user is prompted with more-prompt, and a message matching "You dis- placed ." is not shown at all. The order of the defined MSGTYPE lines is important; the last match- @@ -5772,37 +5762,47 @@ 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, + 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 + In general, the configuration file entries to describe the menu color mappings look like this: MENUCOLOR="pattern"=color&attribute pattern - the pattern to match; color - the color to use for lines matching the pattern; - attribute - the attribute to use for lines matching the pat- - tern. The attribute is optional, and if left out, - you must also leave out the preceding ampersand. + attribute - the attribute to use for lines matching the pat- + tern. The attribute is optional, and if left out, + you must also leave out the preceding ampersand. If no attribute is defined, no attribute is used. The pattern should be a regular expression. - Allowed colors are black, red, green, brown, blue, magenta, cyan, + Allowed colors are black, red, green, brown, blue, magenta, cyan, gray, orange, light-green, yellow, light-blue, light-magenta, light- - cyan, and white. And no-color, the default foreground color, which + cyan, and white. And no-color, the default foreground color, which isn't necessarily the same as any of the other colors. - Allowed attributes are none, bold, dim, italic, underline, blink, + Allowed attributes are none, bold, dim, italic, underline, blink, and inverse. "Normal" is a synonym for "none". Note that the plat- form used may interpret the attributes any way it wants. - Here's an example of menu colors using NetHack's internal pattern + Here's an example of menu colors using NetHack's internal pattern matching facility: + MENUCOLOR="* blessed *"=green + MENUCOLOR="* cursed *"=red + MENUCOLOR="* cursed *(being worn)"=red&underline - NetHack 3.7.0 January 29, 2024 + specifies that any menu line with " blessed " contained in it will + be shown in green color, lines with " cursed " will be shown in red, + and lines with " cursed " followed by "(being worn)" on the same + line will be shown in red color and underlined. You can have multi- + ple MENUCOLOR entries in your configuration file, and the last + + + NetHack 3.7.0 February 06, 2024 @@ -5812,16 +5812,7 @@ - MENUCOLOR="* blessed *"=green - MENUCOLOR="* cursed *"=red - MENUCOLOR="* cursed *(being worn)"=red&underline - - specifies that any menu line with " blessed " contained in it will - be shown in green color, lines with " cursed " will be shown in red, - and lines with " cursed " followed by "(being worn)" on the same - line will be shown in red color and underlined. You can have multi- - ple MENUCOLOR entries in your configuration file, and the last MENU- - COLOR line that matches a menu line will be used for the line. + MENUCOLOR line that matches a menu line will be used for the line. Note that if you intend to have one or more color specifications match " uncursed ", you will probably want to turn the implicit_un- @@ -5864,20 +5855,6 @@ - - - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 90 - - - 9.13. Configuring Status Hilites Your copy of NetHack may have been compiled with support for @@ -5889,6 +5866,18 @@ OPTION=hilite_status:field-name/behavior/color&attributes + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 90 + + + For example, the following line in your configuration file will cause the hitpoints field to display in the color red if your hit- points drop to or below a threshold of 30%: @@ -5931,19 +5920,6 @@ You can adjust the appearance of the following status fields: title dungeon-level experience-level strength gold experience - - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 91 - - - dexterity hitpoints HD constitution hitpoints-max time intelligence power hunger @@ -5957,6 +5933,17 @@ perience", "time", and "score" are conditionally displayed depending upon your other option settings. + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 91 + + + Instead of a behavior, "condition" takes the following condition flags: stone, slime, strngl, foodpois, termill, blind, deaf, stun, conf, hallu, lev, fly, and ride. You can use "major_troubles" as an @@ -5998,18 +5985,6 @@ is based on the progress from the start of the current experi- ence level to the start of the next level. So if level 2 starts at 20 points and level 3 starts at 40 points, having 30 - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 92 - - - points is 50% and 35 points is 75%. 100% is unattainable for experience because you'll gain a level and the calculations will be reset for that new level, but a rule for =100% is al- @@ -6023,6 +5998,18 @@ stead, it also matches when value is below or above. If the prefix is `<' or `>', only match when strictly above or below. + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 92 + + + * criticalhp only applies to the hitpoints field and only when current hit points are below a threshold (which varies by maxi- mum hit points and experience level). When the threshold is @@ -6063,19 +6050,6 @@ The options that are used to select a particular symbol set from the symbol file are: - - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 93 - - - symset Set the name of the symbol set that you want to load. @@ -6090,6 +6064,18 @@ following character literally. Thus \ needs to be represented as \\. The special prefix form \m switches on the meta bit in the symbol value, and the ^ prefix causes the following character to be treated + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 93 + + + as a control character. NetHack Symbols @@ -6129,19 +6115,6 @@ # S_darkroom (dark room) ^ S_dart_trap (dart trap) & S_demon (major demon) - - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 94 - - - * S_digbeam (dig beam) > S_dnladder (ladder down) > S_dnstair (staircase down) @@ -6156,6 +6129,19 @@ S_expl_mc (explosion middle center) | S_expl_mr (explosion middle right) \ S_expl_bl (explosion bottom left) + + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 94 + + + - S_expl_bc (explosion bottom center) / S_expl_br (explosion bottom right) e S_eye (eye or sphere) @@ -6195,19 +6181,6 @@ l S_leprechaun (leprechaun) ^ S_level_teleporter (level teleporter) L S_lich (lich) - - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 95 - - - y S_light (light) # S_litcorr (lit corridor) : S_lizard (lizard) @@ -6222,6 +6195,19 @@ n S_nymph (nymph) O S_ogre (ogre) o S_orc (orc) + + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 95 + + + p S_piercer (piercer) ^ S_pit (pit) # S_poisoncloud (poison cloud) @@ -6261,19 +6247,6 @@ - S_sw_tc (swallow top center) / S_sw_tl (swallow top left) \ S_sw_tr (swallow top right) - - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 96 - - - - S_tdwall (wall) ^ S_teleportation_trap (teleportation trap) \ S_throne (opulent throne) @@ -6288,6 +6261,19 @@ | S_trwall (wall) - S_tuwall (wall) U S_umber (umber hulk) + + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 96 + + + S_unexplored (unexplored terrain) u S_unicorn (unicorn or horse) < S_upladder (ladder up) @@ -6328,18 +6314,6 @@ and boulders are the rock being referred to, but since version 3.6.0, statues are displayed as the monster they depict. So S_rock is only used for boulders and not used at all if overridden by the - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 97 - - - more specific S_boulder. 9.15. Customizing Map Glyph Representations Using Unicode @@ -6355,6 +6329,17 @@ OPTIONS=glyph:glyphid/U+nnnn/R-G-B + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 97 + + + The window port that is active needs to provide support for dis- playing UTF-8 character sequences and explicit red-green-blue colors in order for the glyph representation to be visible. For example, the @@ -6393,19 +6378,6 @@ are often useful in giving players a better sense of the overall loca- tion of items on the screen. - - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 98 - - - NetHack can also be compiled with support for sending the game messages to an external program, such as a text-to-speech synthesizer. If the "#version" extended command shows "external program as a mes- @@ -6423,6 +6395,17 @@ menustyle:traditional This will assist in the interface to speech synthesizers. + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 98 + + + nomenu_overlay Show menus on a cleared screen and aligned to the left edge. @@ -6460,18 +6443,6 @@ When targeting with cursor and using fast-move, skip the same glyphs instead of moving 8 units at a time. - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 99 - - - nostatus_updates Prevent updates to the status lines at the bottom of the screen, if your screen-reader reads those lines. The same information can be @@ -6489,6 +6460,18 @@ WIZARDS = A space-separated list of user names who are allowed to play in debug mode (commonly referred to as wizard mode). A value + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 99 + + + of a single asterisk (*) allows anyone to start a game in debug mode. @@ -6526,18 +6509,6 @@ SEDUCE = 0 or 1 to disable or enable, respectively, the SEDUCE op- tion. When disabled, incubi and succubi behave like nymphs. - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 100 - - - CHECK_PLNAME = Setting this to 1 will make the EXPLORERS, WIZARDS, and SHELLERS check for the player name instead of the user's login name. @@ -6555,6 +6526,18 @@ POINTSMIN = Minimum number of points to get an entry in the score file. + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 100 + + + PERS_IS_UID = 0 or 1 to use user names or numeric userids, respec- tively, to identify unique people for the score file. @@ -6592,18 +6575,6 @@ panying the program contains a comment which lists the meaning of the various bits used. Intended for server systems supporting si- multaneous play by multiple players (to be clear, each one running a - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 101 - - - separate single player game), for displaying their game progress to observers. Only relevant if the program was built with LIVELOG en- abled. When available, it should be left commented out on single @@ -6621,6 +6592,18 @@ chine, depending on how it is set up. In the latter case, each ac- count on the machine can post only one non-winning score on this list. If you score higher than someone else on this list, or better your + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 101 + + + previous score, you will be inserted in the proper place under your current name. How many scores are kept can also be set up when NetHack is compiled. @@ -6658,18 +6641,6 @@ Debug mode, also known as wizard mode, is undocumented aside from this brief description and the various "debug mode only" commands - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 102 - - - listed among the command descriptions. It is intended for tracking down problems within the program rather than to provide god-like pow- ers to your character, and players who attempt debugging are expected @@ -6684,6 +6655,21 @@ start a game in debug mode when not allowed or not available will re- sult in falling back to explore mode instead. + + + + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 102 + + + 12. Credits The original hack game was modeled on the Berkeley UNIX rogue @@ -6724,18 +6710,6 @@ they remained available in various archives accessible via ftp and uucp after expiring from the newsgroup. - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 103 - - - Later, Mike coordinated a major re-write of the game, heading a team which included Ken Arromdee, Jean-Christophe Collet, Steve Creps, Eric Hendrickson, Izchak Miller, Eric S. Raymond, John Rupley, Mike @@ -6750,6 +6724,18 @@ Meluch, Stephen Spackman and Pierre Martineau designed overlay code for PC NetHack 3.0. Johnny Lee ported NetHack 3.0 to the Macintosh. Along with various other Dungeoneers, they continued to enhance the + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 103 + + + PC, Macintosh, and Amiga ports through the later revisions of 3.0. Version 3.0 went through ten relatively rapidly released "patch- @@ -6790,18 +6776,6 @@ Dean Luick, with help from David Cohrs, developed NetHack 3.1 for X11. It drew the map as text rather than graphically but included - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 104 - - - nh10.bdf, an optionally used custom X11 font which has tiny images in place of letters and punctuation, a precursor of tiles. Those images don't extend to individual monster and object types, just replacements @@ -6816,6 +6790,18 @@ Team which rechristened them "tiles", original usage which has subse- quently been picked up by various other games. NetHack's tiles sup- port was then implemented on other platforms (initially MS-DOS but + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 104 + + + eventually Windows, Qt, and X11 too). The 3.2 NetHack Development Team, comprised of Michael Allison, @@ -6856,18 +6842,6 @@ The final update to 3.2 was the bug fix release 3.2.3, which was released simultaneously with 3.3.0 in December 1999 just in time for - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 105 - - - the Year 2000. Because of the newer version, 3.2.3 was released as a source code patch only, without any ready-to-play distribution for systems that usually had such. @@ -6882,6 +6856,18 @@ trieval of old character names to use for random ghost and statue names in the current game.) + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 105 + + + The 3.3 NetHack Development Team, consisting of Michael Allison, Ken Arromdee, David Cohrs, Jessie Collet, Steve Creps, Kevin Darcy, Timo Hakulinen, Kevin Hugo, Steve Linhart, Ken Lorber, Dean Luick, Pat @@ -6922,18 +6908,6 @@ Yitzhak Sapir maintained and enhanced 3.4 for the Microsoft Windows platform. Alex Kompel contributed a new graphical interface for the Windows port. Alex Kompel also contributed a Windows CE port for - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 106 - - - 3.4.1. Ron Van Iwaarden was the sole maintainer of NetHack for OS/2 the @@ -6947,6 +6921,19 @@ Christian "Marvin" Bressler maintained 3.4 for the Atari after he resurrected it for 3.3.1. + + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 106 + + + The release of NetHack 3.4.3 in December 2003 marked the begin- ning of a long release hiatus. 3.4.3 proved to be a remarkably stable version that provided continued enjoyment by the community for more @@ -6989,17 +6976,6 @@ community patches. Many bugs were fixed and some code was restruc- tured. - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 107 - - - The NetHack Development Team, as well as Steve VanDevender and Kevin Smolkowski, ensured that NetHack 3.6 continued to operate on various UNIX flavors and maintained the X11 interface. @@ -7011,6 +6987,19 @@ Kompel, Dion Nicolaas, Derek S. Ray and Yitzhak Sapir maintained the port of NetHack 3.6 for Microsoft Windows. + + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 107 + + + Pat Rankin attempted to keep the VMS port running for NetHack 3.6, hindered by limited access. Kevin Smolkowski has updated and tested it for the most recent version of OpenVMS (V8.4 as of this @@ -7053,19 +7042,6 @@ https://www.nethack.org/. - - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 108 - - - 12.1. Special Thanks On behalf of the NetHack community, thank you very much once @@ -7077,6 +7053,19 @@ vnull.net (gone for now, but not forgotten). + + + + NetHack 3.7.0 February 06, 2024 + + + + + + NetHack Guidebook 108 + + + 12.2. Dungeoneers From time to time, some depraved individual out there in netland @@ -7119,19 +7108,6 @@ Fredrik Ljungdahl Matthew Day Teemu Suikki Frederick Roeber Merlyn LeRoy Tim Lennan Gil Neiger Michael Allison Timo Hakulinen - - - - NetHack 3.7.0 January 29, 2024 - - - - - - NetHack Guidebook 109 - - - Greg Laskin Michael Feir Tom Almy Greg Olson Michael Hamel Tom West Gregg Wonderly Michael Sokolov Warren Cheung @@ -7146,49 +7122,7 @@ of their respective holders. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - NetHack 3.7.0 January 29, 2024 + NetHack 3.7.0 February 06, 2024