diff --git a/doc/Guidebook.txt b/doc/Guidebook.txt index 73e12bdb0..e36569992 100644 --- a/doc/Guidebook.txt +++ b/doc/Guidebook.txt @@ -15,7 +15,7 @@ Original version - Eric S. Raymond (Edited and expanded for NetHack 3.7.0 by Mike Stephenson and others) - December 25, 2024 + May 1, 2025 @@ -126,7 +126,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -192,7 +192,7 @@ NetHack continues this fine tradition. Unlike text adventure games - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -258,7 +258,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -324,7 +324,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -390,7 +390,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -456,7 +456,7 @@ The number of turns elapsed so far, displayed if you have the - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -522,7 +522,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -588,7 +588,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -654,7 +654,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -720,7 +720,7 @@ instead. Only these one-step movement commands cause you to - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -786,7 +786,7 @@ ing . ^ is used as shorthand elsewhere in the - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -852,7 +852,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -918,7 +918,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -984,7 +984,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -1050,7 +1050,7 @@ at an adjacent "remembered, unseen monster" marker. - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -1116,7 +1116,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -1182,7 +1182,7 @@ (R)UNIX is a registered trademark of The Open Group. - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -1248,7 +1248,7 @@ menu_next_page, and menu_last_page keys (`^', `<', `>', `|' by - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -1314,7 +1314,7 @@ doesn't and give that name to the result, while splitting (count - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -1380,7 +1380,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -1446,7 +1446,7 @@ extinct. - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -1512,7 +1512,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -1578,7 +1578,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -1644,7 +1644,7 @@ right away.) Since using this command by accident can cause - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -1710,7 +1710,7 @@ Default key is `M-R'. - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -1776,7 +1776,7 @@ (worn blindfold or towel or lenses, lit lamp(s) and/or candle(s), - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -1842,7 +1842,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -1908,7 +1908,7 @@ line will show "(no travel path)" if your character does not know - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -1974,7 +1974,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -2040,7 +2040,7 @@ Set one or more intrinsic attributes. Autocompletes. Debug mode - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -2106,7 +2106,7 @@ "high"] bit), you can invoke many extended commands by meta-ing the - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -2172,7 +2172,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -2238,7 +2238,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -2304,7 +2304,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -2370,7 +2370,7 @@ them). Some monsters who can open doors can also use unlocking tools. - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -2436,7 +2436,7 @@ been nullified, giving access to whatever is beyond them. In the - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -2502,7 +2502,7 @@ play. - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -2568,7 +2568,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -2634,7 +2634,7 @@ attack, when guessing where an unseen monster is or when deliberately - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -2700,7 +2700,7 @@ noid_confirmation:attack option to require a response of "yes" - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -2766,7 +2766,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -2832,7 +2832,7 @@ are encumbered, one of the conditions Burdened, Stressed, Strained, - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -2898,7 +2898,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -2964,7 +2964,7 @@ `X' command to engage or disengage that. Only some types of charac- - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -3030,7 +3030,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -3096,7 +3096,7 @@ you'll be told that you feel more confident in your skills. At that - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -3162,7 +3162,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -3228,7 +3228,7 @@ what you eat." - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -3259,6 +3259,14 @@ or blessed, and how many uses it has left. Some objects of subtle enchantment are difficult to identify without these. + A scroll whose label is known can be read even when the hero is + blind. If a scroll has been discovered, it will be listed in inven- + tory by type rather than by label, but the label is known in that + situtaion even though it isn't shown. + + Many scrolls produce a different effect from usual if they are + blessed or cursed, or read while the hero is confused. + A mail daemon may run up and deliver mail to you as a scroll of mail (on versions compiled with this feature). To use this feature on versions where NetHack mail delivery is triggered by electronic mail @@ -3284,17 +3292,9 @@ at them. It is also sometimes very useful to dip ("#dip") an object into a potion. - The command to drink a potion is `q' (quaff). - - 7.7. Wands (`/') - - Wands usually have multiple magical charges. Some types of wands - require a direction in which to zap them. You can also zap them at - yourself (just give a `.' or `s' for the direction). Be warned, how- - ever, for this is often unwise. Other types of wands don't require a - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -3304,6 +3304,14 @@ + The command to drink a potion is `q' (quaff). + + 7.7. Wands (`/') + + Wands usually have multiple magical charges. Some types of wands + require a direction in which to zap them. You can also zap them at + yourself (just give a `.' or `s' for the direction). Be warned, how- + ever, for this is often unwise. Other types of wands don't require a direction. The number of charges in a wand is random and decreases by one whenever you use it. @@ -3350,17 +3358,9 @@ The commands to use rings are `P' (put on) and `R' (remove). `A', `W', and `T' can also be used; see Amulets. - 7.9. Spellbooks (`+') - - Spellbooks are tomes of mighty magic. When studied with the `r' - (read) command, they transfer to the reader the knowledge of a spell - (and therefore eventually become unreadable)--unless the attempt back- - fires. Reading a cursed spellbook or one with mystic runes beyond - your ken can be harmful to your health! - - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -3370,6 +3370,14 @@ + 7.9. Spellbooks (`+') + + Spellbooks are tomes of mighty magic. When studied with the `r' + (read) command, they transfer to the reader the knowledge of a spell + (and therefore eventually become unreadable)--unless the attempt back- + fires. Reading a cursed spellbook or one with mystic runes beyond + your ken can be harmful to your health! + A spell (even when learned) can also backfire when you cast it. If you attempt to cast a spell well above your experience level, or if you have little skill with the appropriate spell type, or cast it at a @@ -3416,17 +3424,9 @@ ple, lamps burn out after a while. Other tools are containers, which objects can be placed into or taken out of. - Some tools (such as a blindfold) can be worn and can be put on - and removed like other accessories (rings, amulets); see Amulets. - Other tools (such as pick-axe) can be wielded as weapons in addition - to being applied for their usual purpose, and in some cases (again, - pick-axe) become wielded as a weapon even when applied. - - The blind option can be set (prior to game start) to attempt to - play the entire game without being able to see (a self-imposed chal- - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -3436,6 +3436,14 @@ + Some tools (such as a blindfold) can be worn and can be put on + and removed like other accessories (rings, amulets); see Amulets. + Other tools (such as pick-axe) can be wielded as weapons in addition + to being applied for their usual purpose, and in some cases (again, + pick-axe) become wielded as a weapon even when applied. + + The blind option can be set (prior to game start) to attempt to + play the entire game without being able to see (a self-imposed chal- lenge which is very difficult to accomplish). The command to use a tool is `a' (apply). @@ -3479,6 +3487,21 @@ tents into another container. (As of this writing, the other con- tainer must be carried rather than on the floor.) + + + + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 54 + + + 7.11. Amulets (`"') Amulets are very similar to rings, and often more powerful. Like @@ -3489,19 +3512,6 @@ wearing rings, wearing an amulet affects your metabolism, causing you to grow hungry more rapidly. - - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 54 - - - The commands to use amulets are the same as for rings, `P' (put on) and `R' (remove). `A' can be used to remove various worn items including amulets. Also, `W' (wear) and `T' (take off) which are nor- @@ -3546,6 +3556,18 @@ shown as ``' but by the letter representing the monster they depict instead. + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 55 + + + 7.14. Gold (`$') Gold adds to your score, and you can buy things in shops with it. @@ -3556,18 +3578,6 @@ does not apply. They're always uncursed but never described as uncursed even if you turn off the implicit_uncursed option. You can set the goldX option if you prefer to have gold pieces be treated as - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 55 - - - bless/curse state unknown rather than as known to be uncursed. Only matters when you're using an object selection prompt that can filter by "BUCX" state. @@ -3613,6 +3623,17 @@ your god for help with starvation does not violate any food challenges either. + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 56 + + + A strict vegan diet is one which avoids any food derived from animals. The primary source of nutrition is fruits and vegetables. The corpses and tins of blobs (`b'), jellies (`j'), and fungi (`F') @@ -3623,17 +3644,6 @@ that can digest it is also considered vegan food. Note however that eating such items still counts against foodless conduct. - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 56 - - - Vegetarians do not eat animals; however, they are less selective about eating animal byproducts than vegans. In addition to the vegan items listed above, they may eat any kind of pudding (`P') other than @@ -3679,18 +3689,8 @@ and kick weapons; use a wand, spell, or other type of item; or fight with your hands and feet. - In NetHack, a pacifist refuses to cause the death of any other - monster (i.e. if you would get experience for the death). This is a - particularly difficult challenge, although it is still possible to - gain experience by other means. - An illiterate character does not read or write. This includes - reading a scroll, spellbook, fortune cookie message, or t-shirt; writ- - ing a scroll; or making an engraving of anything other than a single - "X" (the traditional signature of an illiterate person). Reading an - - - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -3700,6 +3700,15 @@ + In NetHack, a pacifist refuses to cause the death of any other + monster (i.e. if you would get experience for the death). This is a + particularly difficult challenge, although it is still possible to + gain experience by other means. + + An illiterate character does not read or write. This includes + reading a scroll, spellbook, fortune cookie message, or t-shirt; writ- + ing a scroll; or making an engraving of anything other than a single + "X" (the traditional signature of an illiterate person). Reading an engraving, or any item that is absolutely necessary to win the game, is not counted against this conduct. The identity of scrolls and spellbooks (and knowledge of spells) in your starting inventory is @@ -3744,6 +3753,19 @@ to make a wish for an item, you may choose "nothing" if you want to decline. + + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 58 + + + 8.1. Achievements End of game disclosure will also display various achievements @@ -3754,18 +3776,6 @@ roughly in order of difficulty and not necessarily in the order in which you might accomplish them. - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 58 - - - Rank - Attained rank title Rank. Shop - Entered a shop. Temple - Entered a temple. @@ -3810,6 +3820,18 @@ to revert to lower rank(s) does not discard the corresponding achieve- ment(s). + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 59 + + + There's no guaranteed Novel so the achievement to read one might not always be attainable (except perhaps by wishing). Similarly, the Big Room level is not always present. Unlike with the Novel, there's @@ -3821,17 +3843,6 @@ other instances of the same objects doesn't record the corresponding achievement. - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 59 - - - The Medusa achievement is recorded if she dies for any reason, even if you are not directly responsible, and only if she dies. @@ -3875,6 +3886,18 @@ "%USERPROFILE%\NetHack\". The file may not exist, but it is a normal ASCII text file can can be created with any text editor. After run- ning NetHack for the first time, you should find a default template + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 60 + + + for the configuration file named ".nethackrc.template" in "%USERPROFILE%\NetHack\". If you have not created the configuration file, NetHack will create one for you using the default template file. @@ -3886,18 +3909,6 @@ Any line beginning with `[' and ending in `]' is a section marker (the closing `]' can be followed by whitespace and then an arbitrary - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 60 - - - comment beginning with `#'). The text between the square brackets is the section name. Section markers are only valid after a CHOOSE directive and their names are case insensitive. Lines after a section @@ -3941,6 +3952,18 @@ The location where saved games are kept. Defaults to HACKDIR, must be writable. + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 61 + + + BONESDIR The location that bones files are kept. Defaults to HACKDIR, must be writable. @@ -3953,17 +3976,6 @@ The location that a record of game aborts and self-diagnosed game problems is kept. Defaults to HACKDIR, must be writable. - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 61 - - - AUTOCOMPLETE Enable or disable an extended command autocompletion. Autocomple- tion has no effect for the X11 windowport. You can specify multiple @@ -4006,6 +4018,18 @@ If [] is present, the preceding section is closed and no new section begins; whatever follows will be common to all sections. Otherwise + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 62 + + + the last section extends to the end of the options file. MENUCOLOR @@ -4019,17 +4043,6 @@ ROGUESYMBOLS Custom symbols for the rogue level's symbol set. See SYMBOLS below. - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 62 - - - SOUND Define a sound mapping. See the "Configuring User Sounds" section. @@ -4061,6 +4074,28 @@ Here is an example of configuration file contents: + + + + + + + + + + + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 63 + + + # Set your character's role, race, gender, and alignment. OPTIONS=role:Valkyrie, race:Human, gender:female, align:lawful # @@ -4084,18 +4119,6 @@ The NETHACKOPTIONS variable is a comma-separated list of initial values for the various options. Some can only be turned on or off. You turn one of these on by adding the name of the option to the list, - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 63 - - - and turn it off by typing a `!' or "no" before the name. Others take a character string as a value. You can set string options by typing the option name, a colon or equals sign, and then the value of the @@ -4128,6 +4151,17 @@ sign) to let NetHack know that the rest is intended as a file name. If it does start with `/', the at-sign is optional. + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 64 + + + 9.4. Customization options Here are explanations of what the various options do. Character @@ -4150,21 +4184,11 @@ Your starting alignment (align:lawful, align:neutral, or align:chaotic). You may specify just the first letter. Many roles and the non-human races restrict which alignments are allowed. See - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 64 - - - role for a description of how to use negation to exclude choices. - Default is random. Cannot be set with the `O' command. Persistent. + If align is not specified, there is no default value; player will be + prompted unless role and/or race forces a choice for alignment. + Cannot be set with the `O' command. Persistent. autodescribe Automatically describe the terrain under cursor when asked to get a @@ -4192,6 +4216,18 @@ This option controls what happens when you attempt the `f' (fire) command when nothing is quivered or readied (default false). When true, the computer will fill your quiver or quiver sack or make + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 65 + + + ready some suitable weapon. Note that it will not take into account the blessed/cursed status, enchantment, damage, or quality of the weapon; you are free to manually fill your quiver or quiver sack or @@ -4216,18 +4252,6 @@ decline to use the key; has no effect on containers); Force - try to force a container's lid with your currently wielded weapon (if you omit untrap or decline to attempt - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 65 - - - untrap and you omit apply-key or you lack a key or you decline to use the key; has no effect on doors); None - none of the above; can't be combined with the other @@ -4258,6 +4282,18 @@ Name your starting cat (for example "catname:Morris"). Cannot be set with the `O' command. + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 66 + + + character Synonym for "role" to pick the type of your character (for example "character:Monk"). See role for more details. @@ -4282,18 +4318,6 @@ dropped_nopick If this option is on, items you dropped will not be automatically - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 66 - - - picked up, even if autopickup is also on and they are in pickup_types or match a positive autopickup exception (default on). Persistent. @@ -4325,10 +4349,21 @@ ? - prompt you and default to ask on the prompt; # - disclose it without prompting, ask for sort order. - Asking refers to picking one of the orderings from a menu. The `+' - disclose without prompting choice, or being prompted and answering - `y' rather than `a', will default to showing monsters in the order - specified by the sortvanquished option. + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 67 + + + + Asking refers to picking one of the orderings from a menu. The + `+' disclose without prompting choice, or being prompted and + answering `y' rather than `a', will default to showing monsters + in the order specified by the sortvanquished option. Omitted categories are implicitly added with `n' prefix. Specified categories with omitted prefix implicitly use `+' prefix. Order of @@ -4348,18 +4383,6 @@ dogname Name your starting dog (for example "dogname:Fang"). Cannot be set - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 67 - - - with the `O' command. extmenu @@ -4392,6 +4415,17 @@ Commands asking for an inventory item show a menu instead of a text query with possible menu letters. Default is off. + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 68 + + + fruit Name a fruit after something you enjoy eating (for example "fruit:mango") (default "slime mold"). Basically a nostalgic whimsy @@ -4407,25 +4441,15 @@ gender option is also present it will take precedence. See role for a description of how to use negation to exclude choices. - Default is random. Cannot be set with the `O' command. Persistent. + If gender is not specified, there is no default value; player will + be prompted unless role and/or race forces a choice for gender. + Cannot be set with the `O' command. Persistent. goldX When filtering objects based on bless/curse state (BUCX), whether to treat gold pieces as X (unknown bless/curse state, when "on") or U (known to be uncursed, when "off", the default). Gold is never blessed or cursed, but it is not described as "uncursed" even when - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 68 - - - the implicit_uncursed option is "off". help @@ -4456,6 +4480,18 @@ (default off). The behavior of this option depends on the type of windowing you use. In text windowing, text highlighting or inverse video is often used; with tiles, generally displays a small plus- + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 69 + + + symbol beside the object on the top of the pile. hitpointbar @@ -4480,18 +4516,6 @@ to toggle the hitpointbar option off, perform the resize while it's off, then use the same command to toggle it back on.) - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 69 - - - horsename Name your starting horse (for example "horsename:Trigger"). Cannot be set with the `O' command. @@ -4522,6 +4546,18 @@ mail Enable mail delivery during the game (default on). Persistent. + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 70 + + + male An obsolete synonym for "gender:male". Cannot be set with the `O' command. @@ -4546,18 +4582,6 @@ menustyle Controls the method used when you need to choose various objects (in response to the Drop (aka droptype) command, for instance). The - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 70 - - - value specified should be the first letter of one of the following: traditional, combination, full, or partial. Default is full. Per- sistent. @@ -4589,6 +4613,17 @@ allowed attributes and colors, see "Configuring Menu Colors". Not all ports can actually display all types. + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 71 + + + menu_invert_all Key to invert all items in a menu. Default `@'. @@ -4602,8 +4637,29 @@ Key to go to the next menu page. Default `>'. menu_objsyms - Show object symbols in menu headings in menus where the object sym- - bols act as menu accelerators (default off). + Inventory and other object menus are normally separated by object + class (weapons, armor, and so forth), with a menu header line at the + beginning of each group. You can have menus add the display symbol + for the class of objects for each header line. You can also add the + display symbol for the individual item in each menu entry. For a + tiles map, that would be a small rendition of an object's tile. For + a text map, it is the same character as is used for the object's + class, which would be most useful when there are no headers separat- + ing objects among classes. Possible values are + + 0 - None - no symbols for either header lines or menu + entries; + 1 - Headers - show symbols on header lines but not entries; + 2 - Entries - show symbols on menu entry lines but not headers; + 3 - Both - show symbols on headers and entries; + 4 - Conditional - only show symbols for entries if there are no + headers; + 5 - One-or-other - show symbols on headers, or on entries if no + headers. + + Supported by tty and curses. When setting the value, it can be + specified by digit or keyword. The default value is Conditional + (4). menu_overlay Do not clear the screen before drawing menus, and align menus to the @@ -4612,18 +4668,6 @@ menu_previous_page Key to go to the previous menu page. Default `<'. - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 71 - - - menu_search Key to search for some text and toggle selection state of matching menu items. Default `:'. @@ -4634,6 +4678,18 @@ menu_select_page Key to select all items on this page of a menu. Default `,'. + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 72 + + + menu_shift_left Key to scroll a menu--one which has been scrolled right--back to the left. Implemented for perm_invent only by curses and X11. Default @@ -4675,21 +4731,6 @@ rently it is only supported for tty (all four choices) and for curses (`f' and `r' choices, default `r'). The possible values are: - - - - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 72 - - - s - single message (default; only choice prior to 3.4.0); c - combination, two messages as "single", then as "full"; f - full window, oldest message first; @@ -4703,9 +4744,25 @@ Set your character's name (defaults to your user name). You can also set your character's role by appending a dash and one or more letters of the role (that is, by suffixing one of -A -B -C -H -K -M + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 73 + + + -P -Ra -Ro -S -T -V -W). If -@ is used for the role, then a random - one will be automatically chosen. Cannot be set with the `O' com- - mand. + one will be automatically chosen. + + 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. news Read the NetHack news file, if present (default on). Since the news @@ -4745,17 +4802,6 @@ taining the symbols for the various object types. Any omitted types are filled in at the end from the previous order. - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 73 - - - paranoid_confirmation A space separated list of specific situations where alternate prompting is desired. The default is "paranoid_confirmation:pray @@ -4764,6 +4810,18 @@ 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 + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 74 + + + AutoAll to require "yes" or `no' too; quit - require "yes" rather than `y' to confirm quitting the game or switching into non-scoring explore mode; @@ -4810,18 +4868,6 @@ 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- - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 74 - - - 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 @@ -4831,6 +4877,17 @@ Start the character with no possessions (default false). Persis- tent. + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 75 + + + perm_invent If true, always display your current inventory in a window (default false). @@ -4877,17 +4934,6 @@ Loaded), you will be asked if you want to continue. (Default `S'). Persistent. - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 75 - - - 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 @@ -4896,6 +4942,18 @@ pickup_thrown If this option is on and autopickup is also on, try to pick up + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 76 + + + things that you threw, even if they aren't in pickup_types or match an autopickup exception. Default is on. Persistent. @@ -4942,18 +5000,6 @@ query_menu Use a menu when asked specific yes/no queries, instead of a prompt. - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 76 - - - quick_farsight When set, usually prevents the "you sense your surroundings" message where play pauses to allow you to browse the map whenever clairvoy- @@ -4962,13 +5008,27 @@ ance spell where pausing to examine revealed objects or monsters is less intrusive. Default is off. Persistent. + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 77 + + + race Selects your race (for example, race:human). Choices are human, dwarf, elf, gnome, and orc but most roles restrict which of the non- human races are allowed. See role for a description of how to use negation to exclude choices. - Default is random. Cannot be set with the `O' command. Persistent. + 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. rest_on_space Make the space bar a synonym for the `.' (#wait) command (default @@ -4992,7 +5052,8 @@ There can be multiple instances of the role option if they're all negations. - Default is random. Cannot be set with the `O' command. Persistent. + If role is not specified, there is no default value; player will be + prompted. Cannot be set with the `O' command. Persistent. roguesymset This option may be used to select one of the named symbol sets found @@ -5000,83 +5061,22 @@ 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 - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 77 - - - + 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; run - update the map after every seven or so steps; 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- - sistent. - - safe_pet - Prevent you from (knowingly) attacking your pets (default on). Per- - sistent. - - safe_wait - Prevents you from waiting or searching when next to a hostile mon- - ster (default on). Persistent. - - sanity_check - 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. - Persistent. - - showdamage - 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 - 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. - Persistent. - - showscore - 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 - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -5086,11 +5086,72 @@ - 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 + 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- + sistent. + + safe_pet + Prevent you from (knowingly) attacking your pets (default on). Per- + sistent. + + safe_wait + Prevents you from waiting or searching when next to a hostile mon- + ster (default on). Persistent. + + sanity_check + 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. + Persistent. + + showdamage + 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 + 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. + Persistent. + + showscore + 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 lines. Persistent. + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 79 + + + silent Suppress terminal beeps (default on). Persistent. @@ -5100,32 +5161,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 @@ -5136,29 +5197,29 @@ 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; - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 79 - - - 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- + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 80 + + + + Can be interactively set via the `m O' command or via using the `m' + prefix before either the #vanquished command or the #genocided com- mand. sounds @@ -5166,7 +5227,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 @@ -5181,52 +5242,51 @@ 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. 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. - - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 80 - - - tips Show some helpful tips during gameplay (default on). Persistent. tombstone Draw a tombstone graphic upon your death (default on). Persistent. + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 81 + + + 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. @@ -5234,7 +5294,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 @@ -5245,8 +5305,8 @@ Provide more commentary during the game (default on). Persistent. whatis_coord - When using the `/' or `;' commands to look around on the map with - autodescribe on, display coordinates after the description. Also + 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: @@ -5257,90 +5317,30 @@ s - screen [row,column] (row is offset to match tty usage); n - none (no coordinates shown) [default]. - The whatis_coord option is also used with the "/m", "/M", "/o", and - "/O" sub-commands of `/', where the "none" setting is overridden + The whatis_coord option is also used with the "/m", "/M", "/o", and + "/O" sub-commands of `/', where the "none" setting is overridden with "map". whatis_filter - When getting a location on the map, and using the keys to cycle - through next and previous targets, allows filtering the possible + When getting a location on the map, and using the keys to cycle + through next and previous targets, allows filtering the possible targets. n - no filtering [default] v - in view only a - in same area only - The area-filter tries to be slightly predictive--if you're standing - on a doorway, it will consider the area on the side of the door you - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 81 - - - + 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- pos.filter" key. - 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. - (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 - 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 - 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 - multiple lines in a configuration file, that would be the first non- - comment line. For a comma-separated list in NETHACKOPTIONS or an - OPTIONS line in a configuration file, that would be the rightmost - option in the list. - - wizweight - Augment object descriptions with their objects' weight (default - 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 - 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 - 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 - can find out if an option is supported by the window port that you are - currently using by checking to see if it shows up in the Options list. - Some options are dynamic and can be specified during the game with the - `O' command. - - align_message - Where to align or place the message window (top, bottom, left, or - right) - NetHack 3.7.0 December 25, 2024 + + NetHack 3.7.0 May 1, 2025 @@ -5350,16 +5350,78 @@ + 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. + (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 + 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 + 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 + multiple lines in a configuration file, that would be the first non- + comment line. For a comma-separated list in NETHACKOPTIONS or an + OPTIONS line in a configuration file, that would be the rightmost + option in the list. + + wizweight + Augment object descriptions with their objects' weight (default + 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 + 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 + 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 + can find out if an option is supported by the window port that you are + currently using by checking to see if it shows up in the Options list. + Some options are dynamic and can be specified during the game with the + `O' command. + + align_message + Where to align or place the message window (top, bottom, left, or + right) + 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). + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 83 + + + 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 @@ -5368,15 +5430,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 @@ -5388,7 +5450,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 @@ -5403,29 +5465,28 @@ font_size_status If NetHack can, it should use this size font for the status window. - - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 83 - - - font_size_text If NetHack can, it should use this size font for text windows. fullscreen If NetHack can, it should try to display on the entire screen rather + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 84 + + + 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 @@ -5435,17 +5496,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 @@ -5462,83 +5523,22 @@ support this option. softkeyboard - Display an onscreen keyboard. Handhelds are most likely to support + Display an onscreen keyboard. Handhelds are most likely to support this option. splash_screen - If NetHack can, it should display an opening splash screen when it + If NetHack can, it should display an opening splash screen when it starts up (default yes). - - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 84 - - - statuslines Number of lines for traditional below-the-map status display. 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 - 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 - 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, - 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 - with the `O' command.) - - term_cols and - - term_rows - Curses interface only. Number of columns and rows to use for the - display. Curses will attempt to resize to the values specified but - will settle for smaller sizes if they are too big. Default is the - current window size. - - tile_file - 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- - ple X "application defaults" file. - - tile_height - Specify the preferred height of each tile in a tile capable port. - - tile_width - Specify the preferred width of each tile in a tile capable port - - tiled_map - If NetHack can, it should display the map using tiles graphics - rather than simple characters (letters and punctuation, possibly - augmented by line-drawing symbols). Setting tiled_map to True - forces ascii_map to be False. - - use_darkgray - Use bold black instead of blue for black glyphs (TTY only). + shows status conditions on their own line. A display capable of - - - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -5548,63 +5548,63 @@ + 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 + 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, + 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 + with the `O' command.) + + term_cols and + + term_rows + Curses interface only. Number of columns and rows to use for the + display. Curses will attempt to resize to the values specified but + will settle for smaller sizes if they are too big. Default is the + current window size. + + tile_file + 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- + ple X "application defaults" file. + + tile_height + Specify the preferred height of each tile in a tile capable port. + + tile_width + Specify the preferred width of each tile in a tile capable port + + tiled_map + If NetHack can, it should display the map using tiles graphics + rather than simple characters (letters and punctuation, possibly + augmented by line-drawing symbols). Setting tiled_map to True + forces ascii_map to be False. + + use_darkgray + Use bold black instead of blue for black glyphs (TTY only). + use_inverse - If NetHack can, it should display inverse when the game specifies + If NetHack can, it should display inverse when the game specifies it. vary_msgcount - If NetHack can, it should display this number of messages at a time + If NetHack can, it should display this number of messages at a time in the message window. - windowborders - Whether to draw boxes around the map, status area, message area, and - persistent inventory window if enabled. Curses interface only. - Acceptable values are - 0 - off, never show borders - 1 - on, always show borders - 2 - auto, on if display is at least (24+2)x(80+2) [default] - 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- - 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 - too big to fit on most displays, resulting in truncation of its con- - tents. If borders are forced on (1) or the display is big enough to - show them (2), setting the value to 3 or 4 instead will keep borders - for the map, message, and status windows but have room for two addi- - tional lines of inventory plus widen each inventory line by two col- - umns. - - windowcolors - 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 - foreground and background are colors, either numeric (hash sign fol- - 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- - text, scrollbar, window, windowframe, windowtext). - - wraptext - If NetHack can, it should wrap long lines of text if they don't fit - in the visible area of the window. - - - - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -5614,63 +5614,63 @@ + windowborders + Whether to draw boxes around the map, status area, message area, and + persistent inventory window if enabled. Curses interface only. + Acceptable values are + + 0 - off, never show borders + 1 - on, always show borders + 2 - auto, on if display is at least (24+2)x(80+2) [default] + 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- + 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 + too big to fit on most displays, resulting in truncation of its con- + tents. If borders are forced on (1) or the display is big enough to + show them (2), setting the value to 3 or 4 instead will keep borders + for the map, message, and status windows but have room for two addi- + tional lines of inventory plus widen each inventory line by two col- + umns. + + windowcolors + 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 + foreground and background are colors, either numeric (hash sign fol- + 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- + text, scrollbar, window, windowframe, windowtext). + + wraptext + 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 - 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 - long URLs. - - 9.7. Platform-specific Customization options - - 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", - "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 - 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-- - 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 - 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 - an IBM PC compatible BIOS ROM (default off, OS/2, PC, and ST NetHack - only). - - rawio - Force raw (non-cbreak) mode for faster output and more bulletproof - input (MS-DOS sometimes treats `^P' as a printer toggle without it) - (default off, OS/2, PC, and ST NetHack only). Note: DEC Rainbows - hang if this is turned on. Cannot be set with the `O' command. - - subkeyvalue - (Win32 tty NetHack only). May be used to alter the value of key- - strokes that the operating system returns to NetHack to help compen- - NetHack 3.7.0 December 25, 2024 + + NetHack 3.7.0 May 1, 2025 @@ -5680,63 +5680,63 @@ - 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- + OPTION=crash_name:your_name + 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 + long URLs. + + 9.7. Platform-specific Customization options + + 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", + "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 + 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-- + 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 + 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 + an IBM PC compatible BIOS ROM (default off, OS/2, PC, and ST NetHack + only). + + rawio + Force raw (non-cbreak) mode for faster output and more bulletproof + input (MS-DOS sometimes treats `^P' as a printer toggle without it) + (default off, OS/2, PC, and ST NetHack only). Note: DEC Rainbows + hang if this is turned on. Cannot be set with the `O' command. + + subkeyvalue + (Win32 tty NetHack only). May be used to alter the value of key- + 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- 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- - 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 - of those modes works. Cannot be set with the `O' command. - - video_height - Set the VGA mode resolution height (MS-DOS only, with video:vesa) - - video_width - 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 - 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 - 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 - Autopickup exceptions, Message types, Menu colors, and User sounds. - - 9.9. Configuring Autopickup Exceptions - - You can further refine the behavior of the autopickup option - beyond what is available through the pickup_types option. - - By placing autopickup_exception lines in your configuration file, - you can define patterns to be checked when the game is about to - autopickup something. - - - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -5746,63 +5746,63 @@ + "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 + of those modes works. Cannot be set with the `O' command. + + video_height + Set the VGA mode resolution height (MS-DOS only, with video:vesa) + + video_width + 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 + 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 + 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 + Autopickup exceptions, Message types, Menu colors, and User sounds. + + 9.9. Configuring Autopickup Exceptions + + You can further refine the behavior of the autopickup option + beyond what is available through the pickup_types option. + + By placing autopickup_exception lines in your configuration file, + you can define patterns to be checked when the game is about to + autopickup something. + autopickup_exception Sets an exception to the pickup_types option. The 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 - 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 - save and then restore your game. autopickup_exception rules and not - saved with the game. - - Here are some examples: - - autopickup_exception="<*arrow" - autopickup_exception=">*corpse" - autopickup_exception=">* cursed*" - - 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 - 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 - mouse button, or a three-digit decimal ASCII code. - - For example: - - BIND=^X:getpos.autodescribe - BIND=\:menu_first_page - BIND=v:loot - - Extended command keys - You can bind multiple keys to the same extended command. Unbind a - key by using "nothing" as the extended command to bind to. You can - also bind the "", "", and "" keys. - - Menu accelerator keys - The menu control or accelerator keys can also be rebound via OPTIONS - - - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -5812,63 +5812,63 @@ - lines in the configuration file. You cannot bind object symbols or + < - 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 + 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 + save and then restore your game. autopickup_exception rules and not + saved with the game. + + Here are some examples: + + autopickup_exception="<*arrow" + autopickup_exception=">*corpse" + autopickup_exception=">* cursed*" + + 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 + 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 + mouse button, or a three-digit decimal ASCII code. + + For example: + + BIND=^X:getpos.autodescribe + BIND=\:menu_first_page + BIND=v:loot + + Extended command keys + You can bind multiple keys to the same extended command. Unbind a + key by using "nothing" as the extended command to bind to. You can + also bind the "", "", and "" keys. + + Menu accelerator keys + The menu control or accelerator keys can also be rebound via OPTIONS + lines in the configuration file. You cannot bind object symbols or 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- - 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. - With number_pad only. Default is `n'. - - getdir.help - 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- - pos.pick.once key (default `,') or the getpos.pick key (default `.') - 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 - `.'. - - getdir.self2 - 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 - is `#'. - - getpos.all.next - When asked for a location, the key to go to next closest interesting - thing. Default is `a'. - - getpos.all.prev - When asked for a location, the key to go to previous closest inter- - esting thing. Default is `A'. - - getpos.door.next - When asked for a location, the key to go to next closest door or - doorway. Default is `d'. - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -5878,6 +5878,52 @@ + 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- + 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. + With number_pad only. Default is `n'. + + getdir.help + 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- + pos.pick.once key (default `,') or the getpos.pick key (default `.') + 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 + `.'. + + getdir.self2 + 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 + is `#'. + + getpos.all.next + When asked for a location, the key to go to next closest interesting + thing. Default is `a'. + + getpos.all.prev + When asked for a location, the key to go to previous closest inter- + esting thing. Default is `A'. + + getpos.door.next + When asked for a location, the key to go to next closest door or + doorway. Default is `d'. + getpos.door.prev When asked for a location, the key to go to previous closest door or doorway. Default is `D'. @@ -5885,56 +5931,10 @@ getpos.help 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. - Default is `m'. - - getpos.mon.prev - 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. - Default is `o'. - - getpos.obj.prev - When asked for a location, the key to go to previous closest object. - 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. - 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 - glyphs instead of by 8 units. Default is `*'. - - getpos.filter - When asked for a location, change the filtering mode when using one - of the next or previous keys to cycle through targets. Toggles - between no filtering, in view only, and in the same area only. - Default is `"'. - - getpos.pick - When asked for a location, the key to choose the location, and pos- - sibly ask for more info. When simulating a mouse click after being - asked for a direction (see getdir.mouse above), the key to use to - respond as right click. Default is `.'. - - getpos.pick.once - When asked for a location, the key to choose the location, and skip - asking for more info. When simulating a mouse click after being - asked for a direction, the key to respond as left click. Default is - `,'. - - 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 - NetHack 3.7.0 December 25, 2024 + + NetHack 3.7.0 May 1, 2025 @@ -5944,26 +5944,86 @@ + getpos.mon.next + 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- + ster. Default is `M'. + + getpos.obj.next + When asked for a location, the key to go to next closest object. + Default is `o'. + + getpos.obj.prev + When asked for a location, the key to go to previous closest object. + 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. + 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 + glyphs instead of by 8 units. Default is `*'. + + getpos.filter + When asked for a location, change the filtering mode when using one + of the next or previous keys to cycle through targets. Toggles + between no filtering, in view only, and in the same area only. + Default is `"'. + + getpos.pick + When asked for a location, the key to choose the location, and pos- + sibly ask for more info. When simulating a mouse click after being + asked for a direction (see getdir.mouse above), the key to use to + respond as right click. Default is `.'. + + getpos.pick.once + When asked for a location, the key to choose the location, and skip + asking for more info. When simulating a mouse click after being + asked for a direction, the key to respond as left click. Default is + `,'. + + 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 `;'. 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 `:'. + + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 92 + + + 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 @@ -5971,15 +6031,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; @@ -5992,81 +6052,21 @@ 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. - 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: - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 92 - - - 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- - ing rule is used. Put the general case first, exceptions below them. - 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, - curses, win32tty and win32gui interfaces support this. - - 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. - 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, - gray, orange, light-green, yellow, light-blue, light-magenta, light- - 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, - 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 - 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 - be shown in green color, lines with " cursed " will be shown in red, - and lines with " cursed " followed by "(being worn)" on the same - line will be shown in red color and underlined. You can have multi- - ple MENUCOLOR entries in your configuration file, and the last MENU- - COLOR line that matches a menu line will be used for the line. - - - - - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -6076,19 +6076,80 @@ - Note that if you intend to have one or more color specifications + The order of the defined MSGTYPE lines is important; the last match- + ing rule is used. Put the general case first, exceptions below them. + + 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, + curses, win32tty and win32gui interfaces support this. + + 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. + 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, + gray, orange, light-green, yellow, light-blue, light-magenta, light- + 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, + 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 + 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 + be shown in green color, lines with " cursed " will be shown in red, + and lines with " cursed " followed by "(being worn)" on the same + line will be shown in red color and underlined. You can have multi- + ple MENUCOLOR entries in your configuration file, and the last MENU- + COLOR line that matches a menu line will be used for the line. + + 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. + + + + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 94 + + + 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 @@ -6098,9 +6159,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 3.7.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; @@ -6119,63 +6180,63 @@ 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: OPTION=hilite_status:field-name/behavior/color&attributes - For example, the following line in your configuration file will - cause the hitpoints field to display in the color red if your hit- - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 94 - - - + 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- + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 95 + + + 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. @@ -6189,82 +6250,21 @@ 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 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 95 - - - - 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- - 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 - 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 - 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 - "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 - prefixed with `<=' or `>=', it also matches when value is below - or above the percentage. Use prefix `<' or `>' to match when - strictly below or above. (The numeric limit is relaxed - slightly for those: >-1% and <101% are allowed.) Only four - fields support percentage rules. Percentages for "hitpoints" - and "power" are straightforward; they're based on the 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 - 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 - prefix is `<' or `>', only match when strictly above or below. - - - - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -6274,19 +6274,79 @@ - * criticalhp only applies to the hitpoints field and only when + 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 + 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 + 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 + "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 + prefixed with `<=' or `>=', it also matches when value is below + or above the percentage. Use prefix `<' or `>' to match when + strictly below or above. (The numeric limit is relaxed + slightly for those: >-1% and <101% are allowed.) Only four + fields support percentage rules. Percentages for "hitpoints" + and "power" are straightforward; they're based on the 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 + 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 + prefix is `<' or `>', only match when strictly above or below. + + * 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 + + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 97 + + + + * 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 @@ -6311,40 +6371,41 @@ 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 - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 97 - - - + 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 as a control character. NetHack Symbols Symbol Name Description ----------------------------------------------------------------- + + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 98 + + + S_air (air) _ S_altar (altar) " S_amulet (amulet) @@ -6393,24 +6454,24 @@ \ S_expl_tr (explosion top right) | S_expl_ml (explosion middle left) S_expl_mc (explosion middle center) - - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 98 - - - | S_expl_mr (explosion middle right) \ S_expl_bl (explosion bottom left) - S_expl_bc (explosion bottom center) / S_expl_br (explosion bottom right) e S_eye (eye or sphere) + + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 99 + + + ^ S_falling_rock_trap (falling rock trap) f S_feline (cat or other feline) ^ S_fire_trap (fire trap) @@ -6459,24 +6520,24 @@ N S_naga (naga) . S_ndoor (doorway without door) n S_nymph (nymph) - - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 99 - - - O S_ogre (ogre) o S_orc (orc) p S_piercer (piercer) ^ S_pit (pit) # S_poisoncloud (poison cloud) + + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 100 + + + ^ S_polymorph_trap (polymorph trap) } S_pool (water) ! S_potion (potion) @@ -6525,24 +6586,24 @@ # S_tree (tree) T S_troll (troll) | S_trwall (wall) - - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 100 - - - - S_tuwall (wall) U S_umber (umber hulk) S_unexplored (unexplored terrain) u S_unicorn (unicorn or horse) < S_upladder (ladder up) + + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 101 + + + < S_upstair (staircase up) V S_vampire (vampire) | S_vbeam (vertical beam [zap animation]) @@ -6571,96 +6632,35 @@ 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 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 101 - - - The format for defining a glyph representation is: OPTIONS=glyph:glyphid/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 - in order for the glyph representation to be visible. For example, the - following line in your configuration file will cause the glyph repre- - sentation for glyphid 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 glyphid's can be produced by nethack --dumpg- - lyphids. Individual NetHack glyphs can be specified using the G_ pre- - fix, or you can use an S_ symbol for a glyphid and store the custom - representation for all NetHack glyphs that would map to that particu- - lar symbol. - - 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 - screen-reader's review features, and will have to know how to navigate - horizontally and vertically character by character. They will also - find the search capabilities of their screen-readers to be quite valu- - 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 - 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 - 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 - executed with the game message as the program's only parameter. - - The most crucial settings to make the game more accessible are: + The window port that is active needs to provide support for dis- + playing UTF-8 character sequences and explicit red-green-blue colors - - - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -6670,63 +6670,63 @@ + in order for the glyph representation to be visible. For example, the + following line in your configuration file will cause the glyph repre- + sentation for glyphid 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 glyphid's can be produced by nethack --dumpg- + lyphids. Individual NetHack glyphs can be specified using the G_ pre- + fix, or you can use an S_ symbol for a glyphid and store the custom + representation for all NetHack glyphs that would map to that particu- + lar symbol. + + 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 + screen-reader's review features, and will have to know how to navigate + horizontally and vertically character by character. They will also + find the search capabilities of their screen-readers to be quite valu- + 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 + 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 + 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 + executed with the game message as the program's only parameter. + + The most crucial settings to make the game more accessible are: + symset:plain Load a symbol set appropriate for use by blind players. menustyle:traditional This will assist in the interface to speech synthesizers. - nomenu_overlay - 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 - the traditional Rogue-like commands. - - paranoid_confirmation:swim - Prevent walking into water or lava. - - accessiblemsg - Adds direction or location information to messages. - - spot_monsters - 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 - spot_monsters and accessiblemsg. - - autodescribe - Automatically describe the terrain under the cursor when targeting. - - mention_map - Give feedback messages when interesting map locations change. - - mention_walls - 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- - dinates relative to your character. - - whatis_filter:area - When targeting with cursor, filter possible locations so only those - in the same area (eg. same room, or same corridor) are considered. - - whatis_moveskip - When targeting with cursor and using fast-move, skip the same glyphs - 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 - seen via the "#attributes" command. - NetHack 3.7.0 December 25, 2024 + + NetHack 3.7.0 May 1, 2025 @@ -6736,63 +6736,63 @@ + nomenu_overlay + 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 + the traditional Rogue-like commands. + + paranoid_confirmation:swim + Prevent walking into water or lava. + + accessiblemsg + Adds direction or location information to messages. + + spot_monsters + 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 + spot_monsters and accessiblemsg. + + autodescribe + Automatically describe the terrain under the cursor when targeting. + + mention_map + Give feedback messages when interesting map locations change. + + mention_walls + 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- + dinates relative to your character. + + whatis_filter:area + When targeting with cursor, filter possible locations so only those + in the same area (eg. same room, or same corridor) are considered. + + whatis_moveskip + When targeting with cursor and using fast-move, skip the same glyphs + 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 + seen via the "#attributes" command. + showdamage Give a message of damage taken and how many hit points are left. - 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 - 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 - mode. - - 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. - - 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. - - MAXPLAYERS = Limit the maximum number of games that can be running - at the same time. - - SAVEFORMAT = A list of up to two save file formats separated by - space. The first format in the list will written as well as read. - The second format will be read only if no save file in the first - format exists. Valid choices are "historical" for binary writing of - entire structs, "lendian" for binary writing of each field in lit- - tle-endian order, "ascii" for writing the save file content in ascii - text. - - BONESFORMAT = A list of up to two bones file formats separated by - space. The first format in the list will written as well as read. - The second format will be read only if no bones files in the first - format exist. Valid choices are "historical" for binary writing of - entire structs, "lendian" for binary writing of each field in lit- - tle-endian order, "ascii" for writing the bones file content in - ascii text. - - SUPPORT = A string explaining how to get local support (no default - value). - - RECOVER = A string explaining how to recover a game on this system - (no default value). - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -6802,14 +6802,48 @@ - SEDUCE = 0 or 1 to disable or enable, respectively, the SEDUCE + 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 + 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 + mode. + + 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. + + 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. + + MAXPLAYERS = Limit the maximum number of games that can be running + at the same time. + + SUPPORT = A string explaining how to get local support (no default + value). + + RECOVER = A string explaining how to recover a game on this system + (no default value). + + SEDUCE = 0 or 1 to disable or enable, respectively, the SEDUCE option. When disabled, incubi and succubi behave like nymphs. - CHECK_PLNAME = Setting this to 1 will make the EXPLORERS, WIZARDS, - and SHELLERS check for the player name instead of the user's login + CHECK_PLNAME = Setting this to 1 will make the EXPLORERS, WIZARDS, + and SHELLERS check for the player name instead of the user's login name. - CHECK_SAVE_UID = 0 or 1 to disable or enable, respectively, the UID + CHECK_SAVE_UID = 0 or 1 to disable or enable, respectively, the UID (used identification number) checking for save files (to verify that the user who is restoring is the same one who saved). @@ -6819,28 +6853,40 @@ ENTRYMAX = Maximum number of entries in the score file. - POINTSMIN = Minimum number of points to get an entry in the score + POINTSMIN = Minimum number of points to get an entry in the score file. - PERS_IS_UID = 0 or 1 to use user names or numeric userids, respec- + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 105 + + + + PERS_IS_UID = 0 or 1 to use user names or numeric userids, respec- tively, to identify unique people for the score file. - HIDEUSAGE = 0 or 1 to control whether the help menu entry for com- + HIDEUSAGE = 0 or 1 to control whether the help menu entry for com- mand line usage is shown or suppressed. - MAX_STATUENAME_RANK = Maximum number of score file entries to use + MAX_STATUENAME_RANK = Maximum number of score file entries to use for random statue names (default is 10). ACCESSIBILITY = 0 or 1 to disable or enable, respectively, the abil- ity for players to set S_pet_override and S_hero_override symbols in their configuration file. - PORTABLE_DEVICE_PATHS = 0 or 1 Windows OS only, the game will look - for all of its external files, and write to all of its output files + PORTABLE_DEVICE_PATHS = 0 or 1 Windows OS only, the game will look + for all of its external files, and write to all of its output files in one place rather than at the standard locations. - DUMPLOGFILE = A filename where the end-of-game dumplog is saved. - Not defining this will prevent dumplog from being created. Only + DUMPLOGFILE = A filename where the end-of-game dumplog is saved. + Not defining this will prevent dumplog from being created. Only available if your game is compiled with DUMPLOG. Allows the follow- ing placeholders: @@ -6854,77 +6900,31 @@ %n - player name %N - first character of player name - LIVELOG = A bit-mask of types of events that should be written to - the livelog file if one is present. The sample sysconf file accom- - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 105 - - - - panying the program contains a comment which lists the meaning of - the various bits used. Intended for server systems supporting + LIVELOG = A bit-mask of types of events that should be written to + the livelog file if one is present. The sample sysconf file accom- + panying the program contains a comment which lists the meaning of + the various bits used. Intended for server systems supporting simultaneous play by multiple players (to be clear, each one running - a separate single player game), for displaying their game progress - to observers. Only relevant if the program was built with LIVELOG - enabled. When available, it should be left commented out on single - player installations because over time the file could grow to be + a separate single player game), for displaying their game progress + to observers. Only relevant if the program was built with LIVELOG + enabled. When available, it should be left commented out on single + player installations because over time the file could grow to be extremely large unless it is actively maintained. CRASHREPORTURL = If set to https://www.nethack.org/links/cr-37BETA.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 + 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. 10. Scoring - NetHack maintains a list of the top scores or scorers on your - machine, depending on how it is set up. In the latter case, each - account on the machine can post only one non-winning score on this - list. If you score higher than someone else on this list, or better - your previous score, you will be inserted in the proper place under - your current name. How many scores are kept can also be set up when - NetHack is compiled. - - Your score is chiefly based upon how much experience you gained, - how much loot you accumulated, how deep you explored, and how the game - ended. If you quit the game, you escape with all of your gold intact. - If, however, you get killed in the Mazes of Menace, the guild will - only hear about 90% of your gold when your corpse is discovered - (adventurers have been known to collect finder's fees). So, consider - whether you want to take one last hit at that monster and possibly - live, or quit and stop with whatever you have. If you quit, you keep - all your gold, but if you swing and live, you might find more. - - If you just want to see what the current top players/games list - is, you can type nethack -s all on most versions. - - 11. Explore mode - - NetHack is an intricate and difficult game. Novices might falter - in fear, aware of their ignorance of the means to survive. Well, fear - not. Your dungeon comes equipped with an "explore" or "discovery" - mode that enables you to keep old save files and cheat death, at the - paltry cost of not getting on the high score list. - - There are two ways of enabling explore mode. One is to start the - game with the -X command-line switch or with the playmode:explore - option. The other is to issue the "#exploremode" extended command - while already playing the game. Starting a new game in explore mode - provides your character with a wand of wishing in initial inventory; - switching during play does not. The other benefits of explore mode - are left for the trepid reader to discover. + NetHack maintains a list of the top scores or scorers on your + machine, depending on how it is set up. In the latter case, each - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -6934,63 +6934,63 @@ + account on the machine can post only one non-winning score on this + list. If you score higher than someone else on this list, or better + your previous score, you will be inserted in the proper place under + your current name. How many scores are kept can also be set up when + NetHack is compiled. + + Your score is chiefly based upon how much experience you gained, + how much loot you accumulated, how deep you explored, and how the game + ended. If you quit the game, you escape with all of your gold intact. + If, however, you get killed in the Mazes of Menace, the guild will + only hear about 90% of your gold when your corpse is discovered + (adventurers have been known to collect finder's fees). So, consider + whether you want to take one last hit at that monster and possibly + live, or quit and stop with whatever you have. If you quit, you keep + all your gold, but if you swing and live, you might find more. + + If you just want to see what the current top players/games list + is, you can type nethack -s all on most versions. + + 11. Explore mode + + NetHack is an intricate and difficult game. Novices might falter + in fear, aware of their ignorance of the means to survive. Well, fear + not. Your dungeon comes equipped with an "explore" or "discovery" + mode that enables you to keep old save files and cheat death, at the + paltry cost of not getting on the high score list. + + There are two ways of enabling explore mode. One is to start the + game with the -X command-line switch or with the playmode:explore + option. The other is to issue the "#exploremode" extended command + while already playing the game. Starting a new game in explore mode + provides your character with a wand of wishing in initial inventory; + switching during play does not. The other benefits of explore mode + are left for the trepid reader to discover. + 11.1. Debug mode Debug mode, also known as wizard mode, is undocumented aside from - this brief description and the various "debug mode only" commands - listed among the command descriptions. It is intended for tracking - down problems within the program rather than to provide god-like pow- - ers to your character, and players who attempt debugging are expected - to figure out how to use it themselves. It is initiated by starting - the game with the -D command-line switch or with the playmode:debug + this brief description and the various "debug mode only" commands + listed among the command descriptions. It is intended for tracking + down problems within the program rather than to provide god-like pow- + ers to your character, and players who attempt debugging are expected + to figure out how to use it themselves. It is initiated by starting + 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 - start a game in debug mode when not allowed or not available will + 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. - 12. Credits - - The original hack game was modeled on the Berkeley UNIX rogue - game. Large portions of this document were shamelessly cribbed from A - Guide to the Dungeons of Doom, by Michael C. Toy and Kenneth C. R. C. - Arnold. Small portions were adapted from Further Exploration of the - Dungeons of Doom, by Ken Arromdee. - - NetHack is the product of literally scores of people's work. - Main events in the course of the game development are described below: - - Jay Fenlason wrote the original Hack, with help from Kenny Wood- - land, Mike Thome, and Jon Payne. - - Andries Brouwer did a major re-write while at Stichting Mathema- - tisch Centrum (now Centrum Wiskunde & Informatica), transforming Hack - into a very different game. He published the Hack source code for use - on UNIX systems by posting that to Usenet newsgroup net.sources (later - renamed comp.sources) releasing version 1.0 in December of 1984, then - versions 1.0.1, 1.0.2, and finally 1.0.3 in July of 1985. Usenet - newsgroup net.games.hack (later renamed rec.games.hack, eventually - replaced by rec.games.roguelike.nethack) was created for discussing - it. - - Don G. Kneller ported Hack 1.0.3 to Microsoft C and MS-DOS, pro- - ducing PC HACK 1.01e, added support for DEC Rainbow graphics in ver- - sion 1.03g, and went on to produce at least four more versions (3.0, - 3.2, 3.51, and 3.6; note that these are old Hack version numbers, not - contemporary NetHack ones). - - R. Black ported PC HACK 3.51 to Lattice C and the Atari - 520/1040ST, producing ST Hack 1.03. - - Mike Stephenson merged these various versions back together, - incorporating many of the added features, and produced NetHack version - 1.4 in 1987. He then coordinated a cast of thousands in enhancing and - NetHack 3.7.0 December 25, 2024 + + NetHack 3.7.0 May 1, 2025 @@ -7000,63 +7000,63 @@ + 12. Credits + + The original hack game was modeled on the Berkeley UNIX rogue + game. Large portions of this document were shamelessly cribbed from A + Guide to the Dungeons of Doom, by Michael C. Toy and Kenneth C. R. C. + Arnold. Small portions were adapted from Further Exploration of the + Dungeons of Doom, by Ken Arromdee. + + NetHack is the product of literally scores of people's work. + Main events in the course of the game development are described below: + + Jay Fenlason wrote the original Hack, with help from Kenny Wood- + land, Mike Thome, and Jon Payne. + + Andries Brouwer did a major re-write while at Stichting Mathema- + tisch Centrum (now Centrum Wiskunde & Informatica), transforming Hack + into a very different game. He published the Hack source code for use + on UNIX systems by posting that to Usenet newsgroup net.sources (later + renamed comp.sources) releasing version 1.0 in December of 1984, then + versions 1.0.1, 1.0.2, and finally 1.0.3 in July of 1985. Usenet + newsgroup net.games.hack (later renamed rec.games.hack, eventually + replaced by rec.games.roguelike.nethack) was created for discussing + it. + + Don G. Kneller ported Hack 1.0.3 to Microsoft C and MS-DOS, pro- + ducing PC HACK 1.01e, added support for DEC Rainbow graphics in ver- + sion 1.03g, and went on to produce at least four more versions (3.0, + 3.2, 3.51, and 3.6; note that these are old Hack version numbers, not + contemporary NetHack ones). + + R. Black ported PC HACK 3.51 to Lattice C and the Atari + 520/1040ST, producing ST Hack 1.03. + + Mike Stephenson merged these various versions back together, + incorporating many of the added features, and produced NetHack version + 1.4 in 1987. He then coordinated a cast of thousands in enhancing and debugging NetHack 1.4 and released NetHack versions 2.2 and 2.3. Like - Hack, they were released by posting their source code to Usenet where - they remained available in various archives accessible via ftp and + Hack, they were released by posting their source code to Usenet where + they remained available in various archives accessible via ftp and uucp after expiring from the newsgroup. - Later, Mike coordinated a major re-write of the game, heading a + Later, Mike coordinated a major re-write of the game, heading a team which included Ken Arromdee, Jean-Christophe Collet, Steve Creps, - Eric Hendrickson, Izchak Miller, Eric S. Raymond, John Rupley, Mike + 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 + 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. - Along with various other Dungeoneers, they continued to enhance the - PC, Macintosh, and Amiga ports through the later revisions of 3.0. - - Version 3.0 went through ten relatively rapidly released "patch- - level" revisions. Versions at the time were known as 3.0 for the base - release and variously as "3.0a" through "3.0j", "3.0 patchlevel 1" - through "3.0 patchlevel 10", or "3.0pl1" through "3.0pl10" rather than - 3.0.0 and 3.0.1 through 3.0.10; the three component numbering scheme - began to be used with 3.1.0. - - Headed by Mike Stephenson and coordinated by Izchak Miller and - Janet Walz, the NetHack Development Team which now included Ken - Arromdee, David Cohrs, Jean-Christophe Collet, Kevin Darcy, Matt Day, - Timo Hakulinen, Steve Linhart, Dean Luick, Pat Rankin, Eric Raymond, - and Eric Smith undertook a radical revision of 3.0. They re-struc- - tured the game's design, and re-wrote major parts of the code. They - added multiple dungeons, a new display, special individual character - quests, a new endgame and many other new features, and produced - NetHack 3.1. Version 3.1.0 was released in January of 1993. - - Ken Lorber, Gregg Wonderly and Greg Olson, with help from Richard - Addison, Mike Passaretti, and Olaf Seibert, developed NetHack 3.1 for - the Amiga. - - Norm Meluch and Kevin Smolkowski, with help from Carl Schelin, - Stephen Spackman, Steve VanDevender, and Paul Winner, ported NetHack - 3.1 to the PC. - - Jon W{tte and Hao-yang Wang, with help from Ross Brown, Mike Eng- - ber, David Hairston, Michael Hamel, Jonathan Handler, Johnny Lee, Tim - Lennan, Rob Menke, and Andy Swanson, developed NetHack 3.1 for the - Macintosh, porting it for MPW. Building on their development, Bart - House added a Think C port. - - Timo Hakulinen ported NetHack 3.1 to OS/2. Eric Smith ported - NetHack 3.1 to the Atari. Pat Rankin, with help from Joshua + 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. - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -7066,63 +7066,63 @@ - Delahunty, was responsible for the VMS version of NetHack 3.1. + Along with various other Dungeoneers, they continued to enhance the + PC, Macintosh, and Amiga ports through the later revisions of 3.0. + + Version 3.0 went through ten relatively rapidly released "patch- + level" revisions. Versions at the time were known as 3.0 for the base + release and variously as "3.0a" through "3.0j", "3.0 patchlevel 1" + through "3.0 patchlevel 10", or "3.0pl1" through "3.0pl10" rather than + 3.0.0 and 3.0.1 through 3.0.10; the three component numbering scheme + began to be used with 3.1.0. + + Headed by Mike Stephenson and coordinated by Izchak Miller and + Janet Walz, the NetHack Development Team which now included Ken + Arromdee, David Cohrs, Jean-Christophe Collet, Kevin Darcy, Matt Day, + Timo Hakulinen, Steve Linhart, Dean Luick, Pat Rankin, Eric Raymond, + and Eric Smith undertook a radical revision of 3.0. They re-struc- + tured the game's design, and re-wrote major parts of the code. They + added multiple dungeons, a new display, special individual character + quests, a new endgame and many other new features, and produced + NetHack 3.1. Version 3.1.0 was released in January of 1993. + + Ken Lorber, Gregg Wonderly and Greg Olson, with help from Richard + Addison, Mike Passaretti, and Olaf Seibert, developed NetHack 3.1 for + the Amiga. + + Norm Meluch and Kevin Smolkowski, with help from Carl Schelin, + Stephen Spackman, Steve VanDevender, and Paul Winner, ported NetHack + 3.1 to the PC. + + Jon W{tte and Hao-yang Wang, with help from Ross Brown, Mike Eng- + ber, David Hairston, Michael Hamel, Jonathan Handler, Johnny Lee, Tim + Lennan, Rob Menke, and Andy Swanson, developed NetHack 3.1 for the + Macintosh, porting it for MPW. Building on their development, Bart + House added a Think C port. + + Timo Hakulinen ported NetHack 3.1 to OS/2. Eric Smith ported + NetHack 3.1 to the Atari. Pat Rankin, with help from Joshua + Delahunty, was responsible for the VMS version of NetHack 3.1. Michael Allison ported NetHack 3.1 to Windows NT. Dean Luick, with help from David Cohrs, developed NetHack 3.1 for - X11. It drew the map as text rather than graphically but included - nh10.bdf, an optionally used custom X11 font which has tiny images in - place of letters and punctuation, a precursor of tiles. Those images + X11. It drew the map as text rather than graphically but included + nh10.bdf, an optionally used custom X11 font which has tiny images in + place of letters and punctuation, a precursor of tiles. Those images don't extend to individual monster and object types, just replacements - for monster and object classes (so one custom image for all "a" - insects and another for all "[" armor and so forth, not separate + 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 - 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- - port was then implemented on other platforms (initially MS-DOS but - eventually Windows, Qt, and X11 too). - - The 3.2 NetHack Development Team, comprised of Michael Allison, - Ken Arromdee, David Cohrs, Jessie Collet, Steve Creps, Kevin Darcy, - Timo Hakulinen, Steve Linhart, Dean Luick, Pat Rankin, Eric Smith, - Mike Stephenson, Janet Walz, and Paul Winner, released version 3.2.0 - in April of 1996. - - Version 3.2 marked the tenth anniversary of the formation of the - development team. In a testament to their dedication to the game, all - thirteen members of the original NetHack Development Team remained on - the team at the start of work on that release. During the interval - between the release of 3.1.3 and 3.2.0, one of the founding members of - the NetHack Development Team, Dr. Izchak Miller, was diagnosed with - cancer and passed away. That release of the game was dedicated to him - by the development and porting teams. - - Version 3.2 proved to be more stable than previous versions. - Many bugs were fixed, abuses eliminated, and game features tuned for - better game play. - - During the lifespan of NetHack 3.1 and 3.2, several enthusiasts - of the game added their own modifications to the game and made these - "variants" publicly available: - - Tom Proudfoot and Yuval Oren created NetHack++, which was quickly - renamed NetHack-- when some people incorrectly assumed that it was a - conversion of the C source code to C++. Working independently, - Stephen White wrote NetHack Plus. Tom Proudfoot later merged NetHack - Plus and his own NetHack-- to produce SLASH. Larry Stewart-Zerba and - Warwick Allison improved the spell casting system with the Wizard - Patch. Warwick Allison also ported NetHack to use the Qt interface. - - Warren Cheung combined SLASH with the Wizard Patch to produce - Slash'EM, and with the help of Kevin Hugo, added more features. Kevin + 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- - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -7132,63 +7132,63 @@ + port was then implemented on other platforms (initially MS-DOS but + eventually Windows, Qt, and X11 too). + + The 3.2 NetHack Development Team, comprised of Michael Allison, + Ken Arromdee, David Cohrs, Jessie Collet, Steve Creps, Kevin Darcy, + Timo Hakulinen, Steve Linhart, Dean Luick, Pat Rankin, Eric Smith, + Mike Stephenson, Janet Walz, and Paul Winner, released version 3.2.0 + in April of 1996. + + Version 3.2 marked the tenth anniversary of the formation of the + development team. In a testament to their dedication to the game, all + thirteen members of the original NetHack Development Team remained on + the team at the start of work on that release. During the interval + between the release of 3.1.3 and 3.2.0, one of the founding members of + the NetHack Development Team, Dr. Izchak Miller, was diagnosed with + cancer and passed away. That release of the game was dedicated to him + by the development and porting teams. + + Version 3.2 proved to be more stable than previous versions. + Many bugs were fixed, abuses eliminated, and game features tuned for + better game play. + + During the lifespan of NetHack 3.1 and 3.2, several enthusiasts + of the game added their own modifications to the game and made these + "variants" publicly available: + + Tom Proudfoot and Yuval Oren created NetHack++, which was quickly + renamed NetHack-- when some people incorrectly assumed that it was a + conversion of the C source code to C++. Working independently, + Stephen White wrote NetHack Plus. Tom Proudfoot later merged NetHack + Plus and his own NetHack-- to produce SLASH. Larry Stewart-Zerba and + Warwick Allison improved the spell casting system with the Wizard + Patch. Warwick Allison also ported NetHack to use the Qt interface. + + Warren Cheung combined SLASH with the Wizard Patch to produce + Slash'EM, and with the help of Kevin Hugo, added more features. Kevin later joined the NetHack Development Team and incorporated the best of these ideas into NetHack 3.3. - The final update to 3.2 was the bug fix release 3.2.3, which was - released simultaneously with 3.3.0 in December 1999 just in time for - the Year 2000. Because of the newer version, 3.2.3 was released as a - source code patch only, without any ready-to-play distribution for + The final update to 3.2 was the bug fix release 3.2.3, which was + released simultaneously with 3.3.0 in December 1999 just in time for + the Year 2000. Because of the newer version, 3.2.3 was released as a + source code patch only, without any ready-to-play distribution for systems that usually had such. (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 + 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 + 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.) - The 3.3 NetHack Development Team, consisting of Michael Allison, - Ken Arromdee, David Cohrs, Jessie Collet, Steve Creps, Kevin Darcy, - Timo Hakulinen, Kevin Hugo, Steve Linhart, Ken Lorber, Dean Luick, Pat - Rankin, Eric Smith, Mike Stephenson, Janet Walz, and Paul Winner, - released 3.3.0 in December 1999 and 3.3.1 in August of 2000. - Version 3.3 offered many firsts. It was the first version to sep- - arate race and profession. The Elf class was removed in preference to - an elf race, and the races of dwarves, gnomes, and orcs made their - first appearance in the game alongside the familiar human race. Monk - and Ranger roles joined Archeologists, Barbarians, Cavemen, Healers, - Knights, Priests, Rogues, Samurai, Tourists, Valkyries and of course, - Wizards. It was also the first version to allow you to ride a steed, - and was the first version to have a publicly available web-site list- - ing all the bugs that had been discovered. Despite that constantly - growing bug list, 3.3 proved stable enough to last for more than a - year and a half. - - The 3.4 NetHack Development Team initially consisted of Michael - Allison, Ken Arromdee, David Cohrs, Jessie Collet, Kevin Hugo, Ken - Lorber, Dean Luick, Pat Rankin, Mike Stephenson, Janet Walz, and Paul - Winner, with Warwick Allison joining just before the release of - NetHack 3.4.0 in March 2002. - - As with version 3.3, various people contributed to the game as a - whole as well as supporting ports on the different platforms that - NetHack runs on: - - Pat Rankin maintained 3.4 for VMS. - - Michael Allison maintained NetHack 3.4 for the MS-DOS platform. - Paul Winner and Yitzhak Sapir provided encouragement. - - Dean Luick, Mark Modrall, and Kevin Hugo maintained and enhanced - the Macintosh port of 3.4. - - - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -7198,63 +7198,63 @@ - Michael Allison, David Cohrs, Alex Kompel, Dion Nicolaas, and - Yitzhak Sapir maintained and enhanced 3.4 for the Microsoft Windows - platform. Alex Kompel contributed a new graphical interface for the - Windows port. Alex Kompel also contributed a Windows CE port for + The 3.3 NetHack Development Team, consisting of Michael Allison, + Ken Arromdee, David Cohrs, Jessie Collet, Steve Creps, Kevin Darcy, + Timo Hakulinen, Kevin Hugo, Steve Linhart, Ken Lorber, Dean Luick, Pat + Rankin, Eric Smith, Mike Stephenson, Janet Walz, and Paul Winner, + released 3.3.0 in December 1999 and 3.3.1 in August of 2000. + + Version 3.3 offered many firsts. It was the first version to sep- + arate race and profession. The Elf class was removed in preference to + an elf race, and the races of dwarves, gnomes, and orcs made their + first appearance in the game alongside the familiar human race. Monk + and Ranger roles joined Archeologists, Barbarians, Cavemen, Healers, + Knights, Priests, Rogues, Samurai, Tourists, Valkyries and of course, + Wizards. It was also the first version to allow you to ride a steed, + and was the first version to have a publicly available web-site list- + ing all the bugs that had been discovered. Despite that constantly + growing bug list, 3.3 proved stable enough to last for more than a + year and a half. + + The 3.4 NetHack Development Team initially consisted of Michael + Allison, Ken Arromdee, David Cohrs, Jessie Collet, Kevin Hugo, Ken + Lorber, Dean Luick, Pat Rankin, Mike Stephenson, Janet Walz, and Paul + Winner, with Warwick Allison joining just before the release of + NetHack 3.4.0 in March 2002. + + As with version 3.3, various people contributed to the game as a + whole as well as supporting ports on the different platforms that + NetHack runs on: + + Pat Rankin maintained 3.4 for VMS. + + Michael Allison maintained NetHack 3.4 for the MS-DOS platform. + Paul Winner and Yitzhak Sapir provided encouragement. + + Dean Luick, Mark Modrall, and Kevin Hugo maintained and enhanced + the Macintosh port of 3.4. + + Michael Allison, David Cohrs, Alex Kompel, Dion Nicolaas, and + Yitzhak Sapir maintained and enhanced 3.4 for the Microsoft Windows + platform. Alex Kompel contributed a new graphical interface for the + Windows port. Alex Kompel also contributed a Windows CE port for 3.4.1. - 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 + 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 + 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. - The release of NetHack 3.4.3 in December 2003 marked the begin- - ning of a long release hiatus. 3.4.3 proved to be a remarkably stable - version that provided continued enjoyment by the community for more - than a decade. The NetHack Development Team slowly and quietly contin- - ued to work on the game behind the scenes during the tenure of 3.4.3. - It was during that same period that several new variants emerged - within the NetHack community. Notably sporkhack by Derek S. Ray, - unnethack by Patric Mueller, nitrohack and its successors originally - by Daniel Thaler and then by Alex Smith, and Dynahack by Tung Nguyen. - Some of those variants continue to be developed, maintained, and - enjoyed by the community to this day. - - In September 2014, an interim snapshot of the code under develop- - ment was released publicly by other parties. Since that code was a - work-in-progress and had not gone through the process of debugging it - as a suitable release, it was decided that the version numbers present - on that code snapshot would be retired and never used in an official - NetHack release. An announcement was posted on the NetHack Develop- - ment Team's official nethack.org website to that effect, stating that - there would never be a 3.4.4, 3.5, or 3.5.0 official release version. - - In January 2015, preparation began for the release of NetHack - 3.6. - - At the beginning of development for what would eventually get - released as 3.6.0, the NetHack Development Team consisted of Warwick - Allison, Michael Allison, Ken Arromdee, David Cohrs, Jessie Collet, - Ken Lorber, Dean Luick, Pat Rankin, Mike Stephenson, Janet Walz, and - Paul Winner. In early 2015, ahead of the release of 3.6.0, new mem- - bers Sean Hunt, Pasi Kallinen, and Derek S. Ray joined the NetHack - Development Team. - - Near the end of the development of 3.6.0, one of the significant - inspirations for many of the humorous and fun features found in the - game, author Terry Pratchett, passed away. NetHack 3.6.0 introduced a - tribute to him. - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -7264,63 +7264,63 @@ - 3.6.0 was released in December 2015, and merged work done by the - development team since the release of 3.4.3 with some of the beloved - community patches. Many bugs were fixed and some code was restruc- + The release of NetHack 3.4.3 in December 2003 marked the begin- + ning of a long release hiatus. 3.4.3 proved to be a remarkably stable + version that provided continued enjoyment by the community for more + than a decade. The NetHack Development Team slowly and quietly contin- + ued to work on the game behind the scenes during the tenure of 3.4.3. + It was during that same period that several new variants emerged + within the NetHack community. Notably sporkhack by Derek S. Ray, + unnethack by Patric Mueller, nitrohack and its successors originally + by Daniel Thaler and then by Alex Smith, and Dynahack by Tung Nguyen. + Some of those variants continue to be developed, maintained, and + enjoyed by the community to this day. + + In September 2014, an interim snapshot of the code under develop- + ment was released publicly by other parties. Since that code was a + work-in-progress and had not gone through the process of debugging it + as a suitable release, it was decided that the version numbers present + on that code snapshot would be retired and never used in an official + NetHack release. An announcement was posted on the NetHack Develop- + ment Team's official nethack.org website to that effect, stating that + there would never be a 3.4.4, 3.5, or 3.5.0 official release version. + + In January 2015, preparation began for the release of NetHack + 3.6. + + At the beginning of development for what would eventually get + released as 3.6.0, the NetHack Development Team consisted of Warwick + Allison, Michael Allison, Ken Arromdee, David Cohrs, Jessie Collet, + Ken Lorber, Dean Luick, Pat Rankin, Mike Stephenson, Janet Walz, and + Paul Winner. In early 2015, ahead of the release of 3.6.0, new mem- + bers Sean Hunt, Pasi Kallinen, and Derek S. Ray joined the NetHack + Development Team. + + Near the end of the development of 3.6.0, one of the significant + inspirations for many of the humorous and fun features found in the + game, author Terry Pratchett, passed away. NetHack 3.6.0 introduced a + tribute to him. + + 3.6.0 was released in December 2015, and merged work done by the + development team since the release of 3.4.3 with some of the beloved + community patches. Many bugs were fixed and some code was restruc- tured. - The NetHack Development Team, as well as Steve VanDevender and - Kevin Smolkowski, ensured that NetHack 3.6 continued to operate on + 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 + 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 + 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. - Pat Rankin attempted to keep the VMS port running for NetHack - 3.6, hindered by limited access. Kevin Smolkowski has updated and - tested it for the most recent version of OpenVMS (V8.4 as of this - writing) on Alpha and Integrity (aka Itanium aka IA64) but not VAX. - - Ray Chason resurrected the MS-DOS port for 3.6 and contributed - the necessary updates to the community at large. - - In late April 2018, several hundred bug fixes for 3.6.0 and some - new features were assembled and released as NetHack 3.6.1. The - NetHack Development Team at the time of release of 3.6.1 consisted of - Warwick Allison, Michael Allison, Ken Arromdee, David Cohrs, Jessie - Collet, Pasi Kallinen, Ken Lorber, Dean Luick, Patric Mueller, Pat - Rankin, Derek S. Ray, Alex Smith, Mike Stephenson, Janet Walz, and - Paul Winner. - - In early May 2019, another 320 bug fixes along with some enhance- - ments and the adopted curses window port, were released as 3.6.2. - - Bart House, who had contributed to the game as a porting team - participant for decades, joined the NetHack Development Team in late - May 2019. - - NetHack 3.6.3 was released on December 5, 2019 containing over - 190 bug fixes to NetHack 3.6.2. - - NetHack 3.6.4 was released on December 18, 2019 containing a - security fix and a few bug fixes. - - NetHack 3.6.5 was released on January 27, 2020 containing some - security fixes and a small number of bug fixes. - - NetHack 3.6.6 was released on March 8, 2020 containing a security - fix and some bug fixes. - - NetHack 3.6.7 was released on February 16, 2023 containing a - security fix and some bug fixes. - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 @@ -7330,7 +7330,45 @@ - The official NetHack web site is maintained by Ken Lorber at + Pat Rankin attempted to keep the VMS port running for NetHack + 3.6, hindered by limited access. Kevin Smolkowski has updated and + tested it for the most recent version of OpenVMS (V8.4 as of this + writing) on Alpha and Integrity (aka Itanium aka IA64) but not VAX. + + Ray Chason resurrected the MS-DOS port for 3.6 and contributed + the necessary updates to the community at large. + + In late April 2018, several hundred bug fixes for 3.6.0 and some + new features were assembled and released as NetHack 3.6.1. The + NetHack Development Team at the time of release of 3.6.1 consisted of + Warwick Allison, Michael Allison, Ken Arromdee, David Cohrs, Jessie + Collet, Pasi Kallinen, Ken Lorber, Dean Luick, Patric Mueller, Pat + Rankin, Derek S. Ray, Alex Smith, Mike Stephenson, Janet Walz, and + Paul Winner. + + In early May 2019, another 320 bug fixes along with some enhance- + ments and the adopted curses window port, were released as 3.6.2. + + Bart House, who had contributed to the game as a porting team + participant for decades, joined the NetHack Development Team in late + May 2019. + + NetHack 3.6.3 was released on December 5, 2019 containing over + 190 bug fixes to NetHack 3.6.2. + + NetHack 3.6.4 was released on December 18, 2019 containing a + security fix and a few bug fixes. + + NetHack 3.6.5 was released on January 27, 2020 containing some + security fixes and a small number of bug fixes. + + NetHack 3.6.6 was released on March 8, 2020 containing a security + fix and some bug fixes. + + NetHack 3.6.7 was released on February 16, 2023 containing a + security fix and some bug fixes. + + The official NetHack web site is maintained by Ken Lorber at https://www.nethack.org/. @@ -7348,59 +7386,83 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - 12.1. Special Thanks - - On behalf of the NetHack community, thank you very much once - 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 - 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). - - - - - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025 NetHack Guidebook 113 + + + + 12.1. Special Thanks + + On behalf of the NetHack community, thank you very much once + 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 + 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). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 12.2. Dungeoneers - From time to time, some depraved individual out there in netland - sends a particularly intriguing modification to help out with the - game. The NetHack Development Team sometimes makes note of the names + From time to time, some depraved individual out there in netland + sends a particularly intriguing modification to help out with the + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 114 + + + + game. The NetHack Development Team sometimes makes note of the names of the worst of these miscreants in this, the list of Dungeoneers: @@ -7449,23 +7511,23 @@ Andy Church Jeff Bailey Pasi Kallinen Andy Swanson Jochen Erwied Pat Rankin Andy Thomson John Kallen Patric Mueller - - - - NetHack 3.7.0 December 25, 2024 - - - - - - NetHack Guidebook 114 - - - Ari Huttunen John Rupley Paul Winner Bart House John S. Bien Pierre Martineau Benson I. Margulies Johnny Lee Ralf Brown Bill Dyer Jon W{tte Ray Chason + + + + NetHack 3.7.0 May 1, 2025 + + + + + + NetHack Guidebook 115 + + + Boudewijn Waijers Jonathan Handler Richard Addison Bruce Cox Joshua Delahunty Richard Beigel Bruce Holloway Karl Garrison Richard P. Hughey @@ -7518,17 +7580,21 @@ - NetHack 3.7.0 December 25, 2024 + + + + + NetHack 3.7.0 May 1, 2025 - NetHack Guidebook 115 + NetHack Guidebook 116 - Brand and product names are trademarks or registered trademarks + Brand and product names are trademarks or registered trademarks of their respective holders. @@ -7584,7 +7650,7 @@ - NetHack 3.7.0 December 25, 2024 + NetHack 3.7.0 May 1, 2025