From 4761d45debc99325896f72851b7b7cd160009329 Mon Sep 17 00:00:00 2001 From: nhmall Date: Sat, 4 Jul 2026 23:43:41 -0400 Subject: [PATCH] Guidebook.txt update - July 4, 2026 --- doc/Guidebook.txt | 1360 ++++++++++++++++++++++----------------------- 1 file changed, 680 insertions(+), 680 deletions(-) diff --git a/doc/Guidebook.txt b/doc/Guidebook.txt index 96803add8..618fdac8f 100644 --- a/doc/Guidebook.txt +++ b/doc/Guidebook.txt @@ -15,7 +15,7 @@ Original version - Eric S. Raymond (Edited and expanded for NetHack 5.0.0 by Mike Stephenson and others) - June 23, 2026 + July 4, 2026 @@ -126,7 +126,7 @@ employ to great advantage. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -192,7 +192,7 @@ NetHack continues this fine tradition. Unlike text adventure games - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -258,7 +258,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -324,7 +324,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -390,7 +390,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -456,7 +456,7 @@ The number of turns elapsed so far, displayed if you have the - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -522,7 +522,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -588,7 +588,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -654,7 +654,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -720,7 +720,7 @@ instead. Only these one-step movement commands cause you to - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -786,7 +786,7 @@ ing . ^ is used as shorthand elsewhere in the - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -852,7 +852,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -918,7 +918,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -984,7 +984,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -1050,7 +1050,7 @@ at an adjacent "remembered, unseen monster" marker. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -1116,7 +1116,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -1182,7 +1182,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -1248,7 +1248,7 @@ (R)UNIX is a registered trademark of The Open Group. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -1314,7 +1314,7 @@ inventory slot. If it has a name assigned, other stacks with the - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -1380,7 +1380,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -1446,7 +1446,7 @@ fight there. Default key is `F', or `-' with number_pad - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -1512,7 +1512,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -1578,7 +1578,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -1644,7 +1644,7 @@ Pick up things at the current location. Default key is `,'. The - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -1710,7 +1710,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -1776,7 +1776,7 @@ worn. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -1842,7 +1842,7 @@ Suspend the game, switching from NetHack to the terminal it was - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -1908,7 +1908,7 @@ pick one from inventory, except for the special case of - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -1974,7 +1974,7 @@ menu of sorting orders available (provided that the vanquished - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -2040,7 +2040,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -2106,7 +2106,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -2172,7 +2172,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -2238,7 +2238,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -2304,7 +2304,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -2370,7 +2370,7 @@ them). Some monsters who can open doors can also use unlocking tools. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -2436,7 +2436,7 @@ been nullified, giving access to whatever is beyond them. In the - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -2502,7 +2502,7 @@ play. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -2568,7 +2568,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -2634,7 +2634,7 @@ attack, when guessing where an unseen monster is or when deliberately - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -2700,7 +2700,7 @@ noid_confirmation:attack option to require a response of "yes" - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -2766,7 +2766,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -2832,7 +2832,7 @@ are encumbered, one of the conditions Burdened, Stressed, Strained, - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -2898,7 +2898,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -2964,7 +2964,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -3030,7 +3030,7 @@ aklys, lucern hammer, and bec-de-corbin) are defined in an appendix to - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -3096,7 +3096,7 @@ shots by using a numeric prefix before the `t' or `f' command. For - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -3162,7 +3162,7 @@ first you need to have a weapon in each hand. (Note that your two - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -3228,7 +3228,7 @@ even further. Most of these provide a one or two point improvement to - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -3294,7 +3294,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -3360,7 +3360,7 @@ yourself (just give a `.' or `s' for the direction). Be warned, how- - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -3426,7 +3426,7 @@ your ken can be harmful to your health! - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -3492,7 +3492,7 @@ play the entire game without being able to see (a self-imposed chal- - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -3558,7 +3558,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -3624,7 +3624,7 @@ set the goldX option if you prefer to have gold pieces be treated as - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -3690,7 +3690,7 @@ eating such items still counts against foodless conduct. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -3756,7 +3756,7 @@ monster (i.e. if you would get experience for the death). This is a - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -3822,7 +3822,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -3888,7 +3888,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -3954,7 +3954,7 @@ ning NetHack for the first time, you should find a default template - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4020,7 +4020,7 @@ [not available on Unix] - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4086,7 +4086,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4152,7 +4152,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4218,7 +4218,7 @@ be set to the full name of a configuration file you want to use. If - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4284,7 +4284,7 @@ Automatically dig if you are wielding a digging tool and moving into - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4350,7 +4350,7 @@ nearby monsters. Successfully forcing a container open will break - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4416,7 +4416,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4482,7 +4482,7 @@ extended command, it controls whether the menu shows all available - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4548,7 +4548,7 @@ might miss some interesting and/or important information. Persis- - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4614,7 +4614,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4680,7 +4680,7 @@ class(es). Combination starts with a prompt for object class(es) of - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4746,7 +4746,7 @@ 5 - One-or-other - show symbols on headers, or on entries if no - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4812,7 +4812,7 @@ port is the same as specifying 0. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4849,12 +4849,13 @@ On some systems, the default is the player's user name; on others, there is no default and the player will be prompted. The former can - made to behave like the latter by specifying a generic name such as - ``player''. Cannot be set with the `O' command. + be made to behave like the latter by specifying a generic name such + as ``player''. The GENERICUSERS= setting in sysconf controls which + names are considered generic. Cannot be set with the `O' command. news Read the NetHack news file, if present (default on). Since the news - is shown at the beginning of the game, there's no point in setting + is shown at the beginning of the game, there's no point in setting this with the `O' command. nudist @@ -4875,10 +4876,9 @@ -1 - by letters but use `z' to go northwest, `y' to zap wands For backward compatibility, omitting a value is the same as specify- - ing 1 and negating number_pad is the same as specifying 0. (Set- - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4888,63 +4888,63 @@ - tings 2 and 4 are for compatibility with MS-DOS or old PC Hack; in - addition to the different behavior for `5', `Alt-5' acts as `G' and - `Alt-0' acts as `I'. Setting -1 is to accommodate some QWERTZ key- - boards which have the location of the `y' and `z' keys swapped.) - When moving by numbers, to enter a count prefix for those commands - which accept one (such as "12s" to search twelve times), precede it + ing 1 and negating number_pad is the same as specifying 0. (Set- + tings 2 and 4 are for compatibility with MS-DOS or old PC Hack; in + addition to the different behavior for `5', `Alt-5' acts as `G' and + `Alt-0' acts as `I'. Setting -1 is to accommodate some QWERTZ key- + boards which have the location of the `y' and `z' keys swapped.) + When moving by numbers, to enter a count prefix for those commands + which accept one (such as "12s" to search twelve times), precede it with the letter `n' ("n12s"). packorder - Specify the order to list object types in (default + Specify the order to list object types in (default "")[%?+!=/(*`0_"). The value of this option should be a string con- taining the symbols for the various object types. Any omitted types are filled in at the end from the previous order. paranoid_confirmation - A space separated list of specific situations where alternate - prompting is desired. The default is "paranoid_confirmation:pray + A space separated list of specific situations where alternate + prompting is desired. The default is "paranoid_confirmation:pray swim trap". - Confirm - for any prompts which are set to require "yes" rather - than `y', also require "no" to reject instead of + Confirm - for any prompts which are set to require "yes" rather + than `y', also require "no" to reject instead of accepting any non-yes response as no; changes pray and AutoAll to require "yes" or `no' too; - quit - require "yes" rather than `y' to confirm quitting the + quit - require "yes" rather than `y' to confirm quitting the game or switching into non-scoring explore mode; - die - require "yes" rather than `y' to confirm dying (not + die - require "yes" rather than `y' to confirm dying (not useful in normal play; applies to explore mode); - bones - require "yes" rather than `y' to confirm saving bones + bones - require "yes" rather than `y' to confirm saving bones data when dying in debug mode; - attack - require "yes" rather than `y' to confirm attacking a + attack - require "yes" rather than `y' to confirm attacking a peaceful monster; - wand-break - require "yes" rather than `y' to confirm breaking a + wand-break - require "yes" rather than `y' to confirm breaking a wand with the apply command; - eating - require "yes" rather than `y' to confirm whether to + eating - require "yes" rather than `y' to confirm whether to continue eating; Were-change - require "yes" rather than `y' to confirm changing form due to lycanthropy when hero has polymorph control; - pray - require `y' to confirm an attempt to pray rather than - immediately praying; on by default; (to require "yes" + pray - require `y' to confirm an attempt to pray rather than + immediately praying; on by default; (to require "yes" rather than just `y', set Confirm too); trap - require `y' to confirm an attempt to move into or onto - a known trap, unless doing so is considered to be + a known trap, unless doing so is considered to be harmless; when enabled, this confirmation is also used for moving into visible gas cloud regions; (to require - "yes" rather than just `y', set Confirm too); confir- - mation can be skipped by using the `m' movement pre- + "yes" rather than just `y', set Confirm too); confir- + mation can be skipped by using the `m' movement pre- fix; swim - prevent walking into water or lava; on by default; (to - deliberately step onto/into such terrain when this is + deliberately step onto/into such terrain when this is set, use the `m' movement prefix when adjacent); - AutoAll - require confirmation when the `A' (Autoselect-All) + AutoAll - require confirmation when the `A' (Autoselect-All) choice is selected in object class filtering menus for - menustyle:Full; (to require "yes" rather than just - `y', set Confirm too); + menustyle:Full; (to require "yes" rather than just - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -4954,39 +4954,40 @@ - Remove - require selection from inventory for `R' and `T' com- + `y', set Confirm too); + Remove - require selection from inventory for `R' and `T' com- mands even when wearing just one applicable item; all - turn on all of the above. By default, the pray, swim, and trap choices are enabled, the others disabled. To disable them without setting any of the other choices, - use paranoid_confirmation:none. To keep them enabled while setting - any of the others, you can include them in the new list, such as + use paranoid_confirmation:none. To keep them enabled while setting + any of the others, you can include them in the new list, such as paranoid_confirmation:attack pray swim Remove or you can precede the - first entry in the list with a plus sign, paranoid_confirma- - tion:+attack Remove. To remove an entry that has been previously - set without removing others, precede the first entry in the list - with a minus sign, paranoid_confirmation:-swim. To both add some - new entries and remove some old ones, you can use multiple para- - noid_confirmation option settings, or you can use the `+' form and - list entries to be added by their name and entries to be removed by + first entry in the list with a plus sign, paranoid_confirma- + tion:+attack Remove. To remove an entry that has been previously + set without removing others, precede the first entry in the list + with a minus sign, paranoid_confirmation:-swim. To both add some + new entries and remove some old ones, you can use multiple para- + noid_confirmation option settings, or you can use the `+' form and + list entries to be added by their name and entries to be removed by `!' and name. The positive (no `!') and negative (with `!') entries can be intermixed. pauper - Start the character with no possessions (default false). Persis- + Start the character with no possessions (default false). Persis- tent. - Also start with no spells or skills, which are tied to starting - equipment. Does not inhibit acquiring and using items, spells, and + Also start with no spells or skills, which are tied to starting + equipment. Does not inhibit acquiring and using items, spells, and skills once play has started. perm_invent - If true, always display your current inventory in a window (default + If true, always display your current inventory in a window (default false). This only makes sense for windowing system interfaces that implement - this feature. For those that do, the perminv_mode option can be + this feature. For those that do, the perminv_mode option can be used to refine what gets displayed for perm_invent. Setting that to a value other than none while perm_invent is false will change it to true. @@ -5007,10 +5008,9 @@ petattr Specifies one or more text highlighting attributes to use when show- - ing pets on the map. Effectively a superset of the hilite_pet bool- - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -5020,63 +5020,63 @@ - ean option. Curses or tty interface only; value is one of none, - bold, dim, underline, italic, blink, and inverse. Some of those + ing pets on the map. Effectively a superset of the hilite_pet bool- + ean option. Curses or tty interface only; value is one of none, + bold, dim, underline, italic, blink, and inverse. Some of those choices might not work, depending upon terminal hardware or terminal emulation software. 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 + 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. + Specify the object types to be picked up when autopickup is on. Default 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. - - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -5087,28 +5087,28 @@ playmode - Values are "normal", "explore", or "debug". Allows selection of - explore mode (also known as discovery mode) or debug mode (also + Values are "normal", "explore", or "debug". Allows selection of + explore 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 + 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. price_quotes Whenever the game mentions the name of an object you haven't identi- fied yet, it also mentions the range of buy and sell prices you have - seen for that item (to help narrow down what it could be). The - price shown is the unit price for one item (even when you are look- - ing at a stack of multiple items). Many players may want to turn - this on while identifying objects, and then turn it back off again + seen for that item (to help narrow down what it could be). The + price shown is the unit price for one item (even when you are look- + ing at a stack of multiple items). Many players may want to turn + this on while identifying objects, and then turn it back off again for general play. Default is off. 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. query_menu @@ -5116,33 +5116,33 @@ 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, + 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 + human races are allowed. See role for a description of how to use negation to exclude choices. - If race is not specified, there is no default value; player will be - prompted unless role forces a choice for race. Cannot be set with + If race is not specified, there is no default value; player will be + prompted unless role forces a choice for race. Cannot be set with the `O' command. Persistent. reroll - Allows rerolling your character's starting inventory and attributes + Allows rerolling your character's starting inventory and attributes (default false). Persistent. - Note that rerolling your character is not a recommended way to play - if aiming merely to win (a lucky start has a much smaller influence - on whether or not you win the game than your actions later in the - game). This option exists partly as an acknowledgement that some + Note that rerolling your character is not a recommended way to play + if aiming merely to win (a lucky start has a much smaller influence + on whether or not you win the game than your actions later in the + game). This option exists partly as an acknowledgement that some - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -5156,17 +5156,17 @@ may be necessary for certain types of challenge games. 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: @@ -5174,10 +5174,10 @@ 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. - If role is not specified, there is no default value; player will be + If role is not specified, there is no default value; player will be prompted. Cannot be set with the `O' command. Persistent. roguesymset @@ -5186,14 +5186,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 - engaged 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 + engaged 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; @@ -5201,14 +5201,14 @@ 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 - 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- + 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 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -5223,48 +5223,48 @@ 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. showdamage - Whenever your character takes damage, show a message of the damage + Whenever your character takes damage, show a message of the damage taken, and the amount of hit points left. 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). By default, this feature is suppressed when building the pro- gram. Persistent. showvers Include the game's version number on the status lines (default off). Potentially useful if you switch between different versions or vari- - ants, or you are making screenshots or streaming video. Using the - statuslines:3 option is recommended so that there will be more room - available for status information, unless you're using NetHack's Qt - interface or your terminal emulator window displays fewer than 25 + ants, or you are making screenshots or streaming video. Using the + statuslines:3 option is recommended so that there will be more room + available for status information, unless you're using NetHack's Qt + interface or your terminal emulator window displays fewer than 25 lines. Persistent. - The versinfo option provides limited control over what information + The versinfo option provides limited control over what information showvers displays. silent @@ -5274,7 +5274,7 @@ Controls the sorting behavior for the output of the `\' and ``' com- - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -5288,32 +5288,32 @@ 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 - object 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 + object 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' + 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 @@ -5324,23 +5324,23 @@ t - traditional--order by monster level; ties are broken by internal monster index; default; - d - order by monster difficulty rating; ties broken by internal + d - order by monster difficulty rating; ties broken by internal index; - 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. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -5355,7 +5355,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 @@ -5370,32 +5370,32 @@ ing Status Hilites" for further information. status_updates - Allow updates to the status lines at the bottom of the screen + Allow updates to the status lines at the bottom of the screen (default 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. terrainstatus - Display an extra status condition describing the spot beneath the + Display an extra status condition describing the spot beneath the hero's feet (default off, not supported by all interfaces). 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 @@ -5406,7 +5406,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -5417,8 +5417,8 @@ toptenwin - Put the ending display in a NetHack window instead of on stdout - (default off). Setting this option makes the score list visible + Put the ending display in a NetHack window instead of on stdout + (default off). Setting this option makes the score list visible when a windowing version of NetHack is started without a parent win- dow, but it no longer leaves the score list around after game end on a terminal or emulating window. @@ -5426,7 +5426,7 @@ 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 + you make inadvertent mouse clicks on the map window. Does not affect traveling via the `_' ("#travel") command. Persistent. tutorial @@ -5440,7 +5440,7 @@ Controls what the showvers option displays on the status lines. weaponstatus - Display an extra status condition which describes currently wielded + Display an extra status condition which describes currently wielded weapon (default off, not supported by all interfaces). Some possible displayed values are: @@ -5450,8 +5450,8 @@ dual-weps - wielding two weapons. whatis_coord - When using the `/' or `;' commands to look around on the map with - autodescribe on, display coordinates after the description. Also + 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: @@ -5462,17 +5462,17 @@ 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. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -5486,8 +5486,8 @@ 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- @@ -5495,50 +5495,50 @@ 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, - select 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, + select 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 + 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 - contents. Not all ports support zero-comp compression. It has no + When writing out a save file, perform zero-comp compression of the + contents. Not all ports support zero-comp compression. It has no effect 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. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -5552,19 +5552,19 @@ `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 @@ -5573,15 +5573,15 @@ 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 + 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 + If NetHack can, it should use a font by the chosen name for menu windows. font_message @@ -5593,7 +5593,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 @@ -5604,7 +5604,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -5628,8 +5628,8 @@ 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 @@ -5639,17 +5639,17 @@ 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, + 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 @@ -5666,11 +5666,11 @@ 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. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -5681,7 +5681,7 @@ 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 @@ -5689,37 +5689,37 @@ Acceptable 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 + 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 + Specify the name of an alternative tile file to override the default. - Note: the X11 interface uses X resources rather than NetHack's - options to select an alternate tile file. See NetHack.ad, the sam- + Note: the X11 interface uses X resources rather than NetHack's + options to select an alternate tile file. See NetHack.ad, the sam- ple X "application defaults" file. tile_height @@ -5729,14 +5729,14 @@ 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. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -5750,16 +5750,16 @@ 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 Whether to draw boxes around the map, status area, message area, and - persistent inventory window if enabled. Curses interface only. + persistent inventory window if enabled. Curses interface only. Acceptable values are 0 - off, never show borders @@ -5768,11 +5768,11 @@ 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 col- + (The 26x82 size threshold for `2' refers to number of rows and col- umns 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 + 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 @@ -5781,28 +5781,28 @@ umns. windowcolors - If NetHack can, it should display all windows of a particular style - with the specified foreground and background colors. Windows GUI + If NetHack can, it should display all windows of a particular style + with the specified foreground and background colors. Windows GUI and curses windowport only. The format is OPTION=windowcolors:style foreground/background - where style is one of "menu", "message", "status", or "text", and + where style is one of "menu", "message", "status", or "text", and foreground and background are colors, either numeric (hash sign fol- - lowed by three pairs of hexadecimal digits, #rrggbb), one of the + lowed by three pairs of hexadecimal digits, #rrggbb), one of the named colors (black, red, green, brown, blue, magenta, cyan, orange, - bright-green, yellow, bright-blue, bright-magenta, bright-cyan, - white, gray, purple, silver, maroon, fuchsia, lime, olive, navy, - teal, aqua), or (for Windows only) one of Windows UI colors (true- - black, activeborder, activecaption, appworkspace, background, btn- - face, btnshadow, btntext, captiontext, graytext, greytext, high- - light, highlighttext, inactiveborder, inactivecaption, menu, menu- + bright-green, yellow, bright-blue, bright-magenta, bright-cyan, + white, gray, purple, silver, maroon, fuchsia, lime, olive, navy, + teal, aqua), or (for Windows only) one of Windows UI colors (true- + black, activeborder, activecaption, appworkspace, background, btn- + face, btnshadow, btntext, captiontext, graytext, greytext, high- + light, highlighttext, inactiveborder, inactivecaption, menu, menu- text, scrollbar, window, windowframe, windowtext). - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -5813,62 +5813,62 @@ 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. Crash Report Options - Please note that NetHack does not send any information off your + Please note that NetHack does not send any information off your computer unless you manually click submit on a form. OPTION=crash_email:email_address OPTION=crash_name:your_name - These options are used only to save you some typing on the + These options are used only to save you some typing on the crash report and #bugreport forms. OPTION=crash_urlmax:bytes - This option is used to limit the length of the URLs generated - and is only needed if your browser cannot handle arbitrarily + This option is used to limit the length of the URLs generated + and is only needed if your browser cannot handle arbitrarily long URLs. 9.7. 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 - keyboard (allowing the use of arrow keys to move) on machines with + 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 + 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. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -5879,21 +5879,21 @@ 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 - returned. You can use multiple subkeyvalue assignments in the con- + sate for international keyboard issues. OPTIONS=subkeyvalue:171/92 + will return 92 to NetHack, if 171 was originally going to be + returned. You can use multiple subkeyvalue assignments in the con- figuration 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" - attempts "vesa", then "vga", and finally sets "default" if neither + 16 colors, a mode that is compatible with all VGA hardware. Third + party tilesets will probably not work. Setting "autodetect" + attempts "vesa", then "vga", and finally sets "default" if neither of those modes works. Cannot be set with the `O' command. video_height @@ -5903,38 +5903,38 @@ 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.8. 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; regardless, this - document refers to both as `regular expressions.' 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; regardless, this + document refers to both as `regular expressions.' This applies to Autopickup exceptions, Message types, Menu colors, and User sounds. 9.9. Configuring Autopickup Exceptions - You can further refine the behavior of the autopickup option + You can further refine the behavior of the autopickup option beyond what is available through the pickup_types option. By placing autopickup_exception lines in your configuration file, - you can define patterns to be checked when the game is about to + you can define patterns to be checked when the game is about to - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -5949,21 +5949,21 @@ 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. @@ -5973,18 +5973,18 @@ 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.10. 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: @@ -5994,13 +5994,13 @@ 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 + 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. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -6012,46 +6012,46 @@ 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 @@ -6059,14 +6059,14 @@ thing. Default is `a'. getpos.all.prev - When asked for a location, the key to go to previous closest inter- + 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 - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -6086,15 +6086,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 @@ -6102,37 +6102,37 @@ 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. + When asked for a location, and using one of the next or previous + keys to cycle through targets, toggle showing a menu instead. Default 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 - between no filtering, in view only, and in the same area only. + 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 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 + 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 + 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 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -6144,27 +6144,27 @@ 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 @@ -6172,15 +6172,15 @@ 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.11. 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; @@ -6193,12 +6193,12 @@ 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 + norep - show the message once, but not again if no other message is shown in between. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -6208,14 +6208,14 @@ - 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- @@ -6224,47 +6224,47 @@ 9.12. 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 - specifies that any menu line with " blessed " contained in it will + 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 + 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- - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -6276,19 +6276,19 @@ COLOR line that matches a menu line will be used for the line. - Note that if you intend to have one or more color specifications + Note that if you intend to have one or more color specifications match " uncursed ", you will probably want to turn the - implicit_uncursed option off so that all items known to be uncursed + implicit_uncursed option off so that all items known to be uncursed are actually displayed with the "uncursed" description. 9.13. Configuring User Sounds - Some platforms allow you to define sound files to be played when + Some platforms allow you to define sound files to be played when a message that matches a user-defined pattern is delivered to the mes- - sage window. At this time the Qt port and the win32tty and win32gui + sage 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 + The following configuration file entries are relevant to mapping user sounds to messages: SOUNDDIR @@ -6298,9 +6298,9 @@ An entry that maps a sound file to a user-specified message pattern. Each SOUND entry is broken down into the following parts: - MESG - message window mapping (the only one supported in + MESG - message window mapping (the only one supported in 5.0.0); - msgtype - optional; message type to use, see "Configuring Mes- + msgtype - optional; message type to use, see "Configuring Mes- sage Types" pattern - the pattern to match; sound file - the sound file to play; @@ -6319,9 +6319,9 @@ 9.14. Configuring Status Hilites - Your copy of NetHack may have been compiled with support for - "Status Hilites". If so, you can customize your game display by set- - ting thresholds to change the color or appearance of fields in the + Your copy of NetHack may have been compiled with support for + "Status Hilites". If so, you can customize your game display by set- + ting thresholds to change the color or appearance of fields in the status display. The format for defining status colors is: @@ -6330,7 +6330,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -6340,42 +6340,42 @@ - For example, the following line in your configuration file will - cause the hitpoints field to display in the color red if your hit- + 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%: OPTION=hilite_status:hitpoints/<=30%/red/normal - (That example is actually specifying red&normal for <=30% and no- + (That example is actually specifying red&normal for <=30% and no- color&normal for >30%.) - For another example, the following line in your configuration + For another example, the following line in your configuration file will cause wisdom to be displayed red if it drops and green if it rises: 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-magenta, light- - cyan, and white. And "no-color", the default foreground color on the + gray, orange, light-green, yellow, light-blue, light-magenta, light- + cyan, and white. And "no-color", the default foreground 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, italic, blink, - and inverse. "Normal" is a synonym for "none"; they should not be + 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 + 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". Note that the display may substitute or ignore particular - attributes depending upon its capabilities, and in general may inter- - pret the attributes any way it wants. For example, on some display - systems a request for bold might yield blink or vice versa. On oth- + attributes depending upon its capabilities, and in general may inter- + pret the attributes any way it wants. For example, on some display + systems a request for bold might yield blink or vice versa. On oth- ers, issuing an attribute request while another is already set up will - replace the earlier attribute rather than combine with it. Since - NetHack issues attribute requests sequentially (at least with the tty + replace the earlier attribute rather than combine with it. Since + NetHack issues attribute requests sequentially (at least with the tty interface) rather than all at once, the only way a situation like that can be controlled is to specify just one attribute. @@ -6389,14 +6389,14 @@ charisma armor-class condition alignment score - The pseudo-field "characteristics" can be used to set all six of - Str, Dex, Con, Int, Wis, and Cha at once. "HD" is "hit dice", an - approximation of experience level displayed when polymorphed. - "experience", "time", and "score" are conditionally displayed + The pseudo-field "characteristics" can be used to set all six of + Str, Dex, Con, Int, Wis, and Cha at once. "HD" is "hit dice", an + approximation of experience level displayed when polymorphed. + "experience", "time", and "score" are conditionally displayed depending upon your other option settings. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -6406,63 +6406,63 @@ - Instead of a behavior, "condition" takes the following condition - flags: stone, slime, strngl, foodpois, termill, blind, deaf, stun, + 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 - alias for stone through termill, "minor_troubles" for blind through + alias for stone through termill, "minor_troubles" for blind through hallu, "movement" for lev, fly, and ride, and "all" for every condi- tion. - Allowed behaviors are "always", "up", "down", "changed", a percent- + Allowed behaviors are "always", "up", "down", "changed", a percent- age or absolute number threshold, or text to match against. For the - hitpoints field, the additional behavior "criticalhp" is available. - It overrides other behavior rules if hit points are at or below the - major problem threshold (which varies depending upon maximum hit + hitpoints field, the additional behavior "criticalhp" is available. + It overrides other behavior rules if hit points are at or below the + major problem threshold (which varies depending upon maximum hit points and experience level). * "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 + * "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 value - 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 value, the "up" or + * "changed" sets the field attribute for when the field value + 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 value, 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 between 0 - and 100, followed by `%' (percent sign). If the percentage is + * percentage sets the field attribute when the field value + matches the percentage. It is specified as a number between 0 + and 100, followed by `%' (percent sign). If the percentage is prefixed with `<=' or `>=', it also matches when value is below - or above the percentage. Use prefix `<' or `>' to match when + or above the percentage. Use prefix `<' or `>' to match when strictly below or above. (The numeric limit is relaxed - slightly for those: >-1% and <101% are allowed.) Only four - fields support percentage rules. Percentages for "hitpoints" - and "power" are straightforward; they're based on the corre- - sponding maximum field. Percentage highlight rules are also - allowed for "experience level" and "experience points" (valid + slightly for those: >-1% and <101% are allowed.) Only four + fields support percentage rules. Percentages for "hitpoints" + and "power" are straightforward; they're based on the corre- + sponding maximum field. Percentage highlight rules are also + allowed for "experience level" and "experience points" (valid when the showexp option is enabled). For those, the percentage - is based on the progress from the start of the current 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 - 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 + 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 + 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 allowed and matches the special case of being exactly 1 experi- ence point short of the next level. - * absolute value sets the attribute when the field value matches - that number. The number must be 0 or higher, except for - "armor-class' which allows negative values, and may optionally - be preceded by `='. If the number is preceded by `<=' or `>=' - instead, it also matches when value is below or above. If the + * absolute value sets the attribute when the field value matches + that number. The number must be 0 or higher, except for + "armor-class' which allows negative values, and may optionally + be preceded by `='. If the number is preceded by `<=' or `>=' + instead, it also matches when value is below or above. If the prefix is `<' or `>', only match when strictly above or below. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -6472,19 +6472,19 @@ - * criticalhp only applies to the hitpoints field and only when + * 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 - met, a criticalhp rule takes precedence over all other hit- + mum hit points and experience level). When the threshold is + met, a criticalhp rule takes precedence over all other hit- points rules. - * text match sets the attribute when the field value matches the - text. Text matches can only be used for "alignment", "carry- - ing-capacity", "hunger", "dungeon-level", and "title". For - title, only the role's rank title is tested; the character's + * text match sets the attribute when the field value matches the + text. Text matches can only be used for "alignment", "carry- + ing-capacity", "hunger", "dungeon-level", and "title". For + title, only the role's rank title is tested; the character's name is ignored. - The in-game options menu can help you determine the correct syn- + The in-game options menu can help you determine the correct syn- tax for a configuration file. The whole feature can be disabled by setting option statushilites @@ -6509,26 +6509,26 @@ NetHack can load entire symbol sets from the symbol file. - The options that are used to select a particular symbol set from + The options that are used to select a particular symbol set from the symbol file are: symset Set the name of the symbol set that you want to load. roguesymset - Set the name of the symbol set that you want to load for display on + Set the name of the symbol set that you want to load for display on the rogue level. - You can also override one or more symbols using the SYMBOLS and - ROGUESYMBOLS configuration file options. Symbols are specified as + You can also override one or more symbols using the SYMBOLS and + ROGUESYMBOLS configuration file options. Symbols are specified as name:value pairs. Note that NetHack escape-processes the value string - in conventional C fashion. This means that \ is a prefix to take the - 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 + in conventional C fashion. This means that \ is a prefix to take the + 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 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -6594,7 +6594,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -6660,7 +6660,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -6726,7 +6726,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -6769,30 +6769,30 @@ Notes: - * Several symbols in this table appear to be blank. They are the + * Several symbols in this table appear to be blank. They are the space character, except for S_pet_override and S_hero_override which - don't have any default value and can only be used if enabled in the + don't have any default value and can only be used if enabled in the "sysconf" file. - * S_rock is misleadingly named; rocks and stones use S_gem. Statues - 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 + * S_rock is misleadingly named; rocks and stones use S_gem. Statues + 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 more specific S_boulder. 9.16. Customizing Map Glyph Representations Using Unicode - If your platform or terminal supports the display of UTF-8 char- + If your platform or terminal supports the display of UTF-8 char- acter sequences, you can customize your game display by assigning Uni- - code codepoint values and red-green-blue colors to glyph representa- - tions. The customizations can be specified for use with a symset that - has a UTF8 handler within the symbols file such as the enhanced1 set, + code codepoint values and red-green-blue colors to glyph representa- + tions. The customizations can be specified for use with a symset that + has a UTF8 handler within the symbols file such as the enhanced1 set, or individually within your nethack.rc file. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -6806,51 +6806,51 @@ OPTIONS=glyph:glyphname/U+nnnn/R-G-B - The window port that is active needs to provide support for dis- - playing UTF-8 character sequences and explicit red-green-blue colors + 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 - following line in your configuration file will cause the glyph repre- + following line in your configuration file will cause the glyph repre- sentation for glyphname G_pool to use Unicode codepoint U+224B and the color represented by R-G-B value 0-0-160: OPTIONS=glyph:G_pool/U+224B/0-0-160 - The list of acceptable glyphnames can be produced by nethack --dumpg- - lyphnames. Individual NetHack glyphs can be specified using the G_ + The list of acceptable glyphnames can be produced by nethack --dumpg- + lyphnames. Individual NetHack glyphs can be specified using the G_ prefix, or you can use an S_ symbol for a glyphname and store the cus- - tom representation for all NetHack glyphs that would map to that par- + tom representation for all NetHack glyphs that would map to that par- ticular symbol. - You will need to select a symset with a UTF8 handler to enable + You will need to select a symset with a UTF8 handler to enable the display of the customizations, such as the Enhanced symset. 9.17. Configuring NetHack for Play by the Blind - NetHack can be set up to use only standard ASCII characters for - making maps of the dungeons. This makes even the MS-DOS versions of - NetHack (which use special line-drawing characters by default) com- - pletely accessible to the blind who use speech and/or Braille access - technologies. Players will require a good working knowledge of their + NetHack can be set up to use only standard ASCII characters for + making maps of the dungeons. This makes even the MS-DOS versions of + NetHack (which use special line-drawing characters by default) com- + pletely accessible to the blind who use speech and/or Braille access + technologies. Players will require a good working knowledge of their screen-reader's review features, and will have to know how to navigate - horizontally and vertically character by character. They will also + horizontally and vertically character by character. They will also find the search capabilities of their screen-readers to be quite valu- - able. Be certain to examine this Guidebook before playing so you have + able. Be certain to examine this Guidebook before playing so you have an idea what the screen layout is like. You'll also need to be able to - locate the PC cursor. It is always where your character is located. - Merely searching for an @-sign will not always find your character - since there are other humanoids represented by the same sign. Your - screen-reader should also have a function which gives you the row and - column of your review cursor and the PC cursor. These co-ordinates + locate the PC cursor. It is always where your character is located. + Merely searching for an @-sign will not always find your character + since there are other humanoids represented by the same sign. Your + screen-reader should also have a function which gives you the row and + column of your review cursor and the PC cursor. These co-ordinates are often useful in giving players a better sense of the overall loca- tion of items on the screen. - NetHack can also be compiled with support for sending the game + 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- - sage handler", your NetHack has been compiled with the capability. - When compiling NetHack from source on Linux and other POSIX systems, - define MSGHANDLER to enable it. To use the capability, set the envi- - ronment variable NETHACK_MSGHANDLER to an executable, which will be + If the "#version" extended command shows "external program as a mes- + sage handler", your NetHack has been compiled with the capability. + When compiling NetHack from source on Linux and other POSIX systems, + define MSGHANDLER to enable it. To use the capability, set the envi- + ronment variable NETHACK_MSGHANDLER to an executable, which will be executed with the game message as the program's only parameter. The most crucial settings to make the game more accessible are: @@ -6858,7 +6858,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -6878,8 +6878,8 @@ Show menus on a cleared screen and aligned to the left edge. number_pad - A lot of speech access programs use the number-pad to review the - screen. If this is the case, disable the number_pad option and use + A lot of speech access programs use the number-pad to review the + screen. If this is the case, disable the number_pad option and use the traditional Rogue-like commands. paranoid_confirmation:swim @@ -6889,11 +6889,11 @@ Adds direction or location information to messages. spot_monsters - Shows a message when hero notices a monster; combine with accessi- + Shows a message when hero notices a monster; combine with accessi- blemsg. mon_movement - Shows a message when hero notices a monster movement; combine with + Shows a message when hero notices a monster movement; combine with spot_monsters and accessiblemsg. autodescribe @@ -6903,15 +6903,15 @@ Give feedback messages when interesting map locations change. mention_walls - Give feedback messages when walking towards a wall or when travel + Give feedback messages when walking towards a wall or when travel command was interrupted. whatis_coord:compass - When targeting with cursor, describe the cursor position with coor- + When targeting with cursor, describe the cursor position with coor- dinates relative to your character. whatis_filter:area - When targeting with cursor, filter possible locations so only those + When targeting with cursor, filter possible locations so only those in the same area (eg. same room, or same corridor) are considered. whatis_moveskip @@ -6919,12 +6919,12 @@ instead of moving 8 units at a time. 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 + Prevent updates to the status lines at the bottom of the screen, if + your screen-reader reads those lines. The same information can be seen via the "#attributes" command. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -6939,25 +6939,28 @@ 9.18. Global Configuration for System Administrators - If NetHack is compiled with the SYSCF option, a system adminis- - trator should set up a global configuration; this is a file in the - same format as the traditional per-user configuration file (see - above). This file should be named sysconf and placed in the same - directory as the other NetHack support files. The options recognized - in this file are listed below. Any option not set uses a compiled-in + If NetHack is compiled with the SYSCF option, a system adminis- + trator should set up a global configuration; this is a file in the + same format as the traditional per-user configuration file (see + above). This file should be named sysconf and placed in the same + directory as the other NetHack support files. The options recognized + in this file are listed below. Any option not set uses a compiled-in default (which may not be appropriate for your system). - WIZARDS = A space-separated list of user names who are allowed to - play in debug mode (commonly referred to as wizard mode). A value - of a single asterisk (*) allows anyone to start a game in debug + WIZARDS = A space-separated list of user names who are allowed to + play in debug mode (commonly referred to as wizard mode). A value + of a single asterisk (*) allows anyone to start a game in debug mode. - SHELLERS = A list of users who are allowed to use the shell escape + SHELLERS = A list of users who are allowed to use the shell escape command (!). The syntax is the same as WIZARDS. EXPLORERS = A list of users who are allowed to use the explore mode. The syntax is the same as WIZARDS. + GENERICUSERS = A list of user names that should prompt ``Who are + you?'' rather than become a character's name. + MSGHANDLER = A path and filename of executable. Whenever a message- window message is shown, NetHack runs this program. The program will get the message as the only parameter. @@ -6984,13 +6987,10 @@ The following four options affect the score file: - PERSMAX = Maximum number of entries for one person. - - ENTRYMAX = Maximum number of entries in the score file. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -7000,6 +7000,10 @@ + PERSMAX = Maximum number of entries for one person. + + ENTRYMAX = Maximum number of entries in the score file. + POINTSMIN = Minimum number of points to get an entry in the score file. @@ -7050,13 +7054,9 @@ https://www.nethack.org/links/cr-5.0.0.html and support is compiled in, brings up a browser window pre-populated with the information needed to report a problem if the game panics or ends up in an - internally inconsistent state, or if the #bugreport command is - invoked. - - - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -7066,6 +7066,9 @@ + internally inconsistent state, or if the #bugreport command is + invoked. + 10. Scoring NetHack maintains a list of the top scores or scorers on your @@ -7116,13 +7119,10 @@ the game with the -D command-line switch or with the playmode:debug option. - For some systems, the player must be logged in under a particular - user name to be allowed to use debug mode; for others, the hero must - be given a particular character name (but may be any role; there's no - connection between "wizard mode" and the Wizard role). Attempting to - NetHack 5.0.0 June 23, 2026 + + NetHack 5.0.0 July 4, 2026 @@ -7132,6 +7132,10 @@ + For some systems, the player must be logged in under a particular + user name to be allowed to use debug mode; for others, the hero must + be given a particular character name (but may be any role; there's no + connection between "wizard mode" and the Wizard role). Attempting to start a game in debug mode when not allowed or not available will result in falling back to explore mode instead. @@ -7181,14 +7185,10 @@ Eric Hendrickson, Izchak Miller, Eric S. Raymond, John Rupley, Mike Threepoint, and Janet Walz, to produce NetHack 3.0c. - NetHack 3.0 was ported to the Atari by Eric R. Smith, to OS/2 by - Timo Hakulinen, and to VMS by David Gentzel. The three of them and - Kevin Darcy later joined the main NetHack Development Team to produce - subsequent revisions of 3.0. - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -7198,6 +7198,11 @@ + NetHack 3.0 was ported to the Atari by Eric R. Smith, to OS/2 by + Timo Hakulinen, and to VMS by David Gentzel. The three of them and + Kevin Darcy later joined the main NetHack Development Team to produce + subsequent revisions of 3.0. + Olaf Seibert ported NetHack 2.3 and 3.0 to the Amiga. Norm Meluch, Stephen Spackman and Pierre Martineau designed overlay code for PC NetHack 3.0. Johnny Lee ported NetHack 3.0 to the Macintosh. @@ -7247,14 +7252,9 @@ don't extend to individual monster and object types, just replacements for monster and object classes (so one custom image for all "a" insects and another for all "[" armor and so forth, not separate - images for beetles and ants or for cloaks and boots). - - Warwick Allison wrote a graphically displayed version of NetHack - for the Atari where the tiny pictures were described as "icons" and - were distinct for specific types of monsters and objects rather than - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -7264,6 +7264,11 @@ + images for beetles and ants or for cloaks and boots). + + Warwick Allison wrote a graphically displayed version of NetHack + for the Atari where the tiny pictures were described as "icons" and + were distinct for specific types of monsters and objects rather than just their classes. He contributed them to the NetHack Development Team which rechristened them "tiles", original usage which has subse- quently been picked up by various other games. NetHack's tiles sup- @@ -7312,15 +7317,10 @@ source code patch only, without any ready-to-play distribution for systems that usually had such. - (To anyone considering resurrecting an old version: all versions - before 3.2.3 had a Y2K bug. The high scores file and the log file - contained dates which were formatted using a two-digit year, and - 1999's year 99 was followed by 2000's year 100. That got written out - successfully but it unintentionally introduced an extra column in the - file layout which prevented score entries from being read back in cor- - NetHack 5.0.0 June 23, 2026 + + NetHack 5.0.0 July 4, 2026 @@ -7330,6 +7330,12 @@ + (To anyone considering resurrecting an old version: all versions + before 3.2.3 had a Y2K bug. The high scores file and the log file + contained dates which were formatted using a two-digit year, and + 1999's year 99 was followed by 2000's year 100. That got written out + successfully but it unintentionally introduced an extra column in the + file layout which prevented score entries from being read back in cor- rectly, interfering with insertion of new high scores and with retrieval of old character names to use for random ghost and statue names in the current game.) @@ -7378,15 +7384,9 @@ Ron Van Iwaarden was the sole maintainer of NetHack for OS/2 the past several releases. Unfortunately Ron's last OS/2 machine stopped - working in early 2006. A great many thanks to Ron for keeping NetHack - alive on OS/2 all these years. - - Janne Salmijarvi and Teemu Suikki maintained and enhanced the - Amiga port of 3.4 after Janne Salmijarvi resurrected it for 3.3.1. - - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -7396,6 +7396,12 @@ + working in early 2006. A great many thanks to Ron for keeping NetHack + alive on OS/2 all these years. + + Janne Salmijarvi and Teemu Suikki maintained and enhanced the + Amiga port of 3.4 after Janne Salmijarvi resurrected it for 3.3.1. + Christian "Marvin" Bressler maintained 3.4 for the Atari after he resurrected it for 3.3.1. @@ -7444,15 +7450,9 @@ 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. - - Ken Lorber, Haoyang Wang, Pat Rankin, and Dean Luick maintained - the port of NetHack 3.6 for MacOS. - - - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -7462,6 +7462,11 @@ + various UNIX flavors and maintained the X11 interface. + + Ken Lorber, Haoyang Wang, Pat Rankin, and Dean Luick maintained + the port of NetHack 3.6 for MacOS. + Michael Allison, David Cohrs, Bart House, Pasi Kallinen, Alex Kompel, Dion Nicolaas, Derek S. Ray and Yitzhak Sapir maintained the port of NetHack 3.6 for Microsoft Windows. @@ -7511,14 +7516,9 @@ end of April 2026. For the first time, that development was shared publicly on GitHub and SourceForge as it occurred. It was done under the label NetHack-3.7 work-in-progress (WIP), although the version - number for the next release had not yet been solidified. - - Exposure of the development to the public brought many good - things, and some challenges. People were able to observe and criticize - changes and new features almost immediately, and they often did. The - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -7528,6 +7528,11 @@ + number for the next release had not yet been solidified. + + Exposure of the development to the public brought many good + things, and some challenges. People were able to observe and criticize + changes and new features almost immediately, and they often did. The GitHub pull request system made it straightforward for people to con- tribute directly to development. Contributions resolved many, many bugs in the game and we thank all the contributors. @@ -7577,14 +7582,9 @@ Michael Allison, David Cohrs, Bart House, Pasi Kallinen, Alex Kompel, Dion Nicolaas, Derek S. Ray and Yitzhak Sapir. - With sadness, the devteam would like to acknowledge and remember - the past contributions from the late Ron Van Iwaarden, who was the - sole maintainer of NetHack for OS/2 for several past NetHack releases. - Ron will be missed. - - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -7594,6 +7594,11 @@ + With sadness, the devteam would like to acknowledge and remember + the past contributions from the late Ron Van Iwaarden, who was the + sole maintainer of NetHack for OS/2 for several past NetHack releases. + Ron will be missed. + The official NetHack web site is maintained by Ken Lorber at https://www.nethack.org/. @@ -7643,6 +7648,18 @@ again to M. Drew Streib and Pasi Kallinen for providing a public NetHack server at nethack.alt.org. Thanks to Keith Simpson and Andy Thomson for hardfought.org. Thanks to all those unnamed dungeoneers + + + NetHack 5.0.0 July 4, 2026 + + + + + + NetHack Guidebook 117 + + + who invest their time and effort into annual NetHack tournaments such as Junethack, The November NetHack Tournament, and in days past, devnull.net (gone for now, but not forgotten). @@ -7650,13 +7667,40 @@ - NetHack 5.0.0 June 23, 2026 - NetHack Guidebook 117 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -7672,37 +7716,13 @@ + NetHack 5.0.0 July 4, 2026 - - - - - - - - - - - - - - - - - - - - - - - - - - + NetHack Guidebook 118 @@ -7713,19 +7733,6 @@ Andy Church Janne Salmijarvi Nathan Eady Andy Swanson Jean-Christophe Collet Norm Meluch Andy Thomson Jeff Bailey Olaf Seibert - - - - NetHack 5.0.0 June 23, 2026 - - - - - - NetHack Guidebook 118 - - - Ari Huttunen Jochen Erwied Pasi Kallinen Bart House John Kallen Pat Rankin Benson I. Margulies John Rupley Patric Mueller @@ -7775,14 +7782,7 @@ - - - - - - - - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026 @@ -7848,7 +7848,7 @@ - NetHack 5.0.0 June 23, 2026 + NetHack 5.0.0 July 4, 2026