diff --git a/doc/Guidebook.txt b/doc/Guidebook.txt index 07323a086..81b5a7b8b 100644 --- a/doc/Guidebook.txt +++ b/doc/Guidebook.txt @@ -15,7 +15,7 @@ Original version - Eric S. Raymond (Edited and expanded for 3.7 by Mike Stephenson and others) - January 11, 2022 + January 16, 2022 @@ -126,7 +126,7 @@ - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -192,7 +192,7 @@ you have seen on the current dungeon level; as you explore more - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -258,7 +258,7 @@ - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -324,7 +324,7 @@ - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -390,7 +390,7 @@ you have available for spell casting. Again, resting will - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -456,7 +456,7 @@ scribe things that are impossible to represent visually. If you - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -522,7 +522,7 @@ - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -588,7 +588,7 @@ - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -654,7 +654,7 @@ - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -720,7 +720,7 @@ - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -786,7 +786,7 @@ - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -852,7 +852,7 @@ it out); this is often useful to give yourself a breather. - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -918,7 +918,7 @@ that command.) - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -984,7 +984,7 @@ to hold the saved data is deleted. In explore mode, once - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -1050,7 +1050,7 @@ - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -1116,7 +1116,7 @@ (R)UNIX is a registered trademark of The Open Group. - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -1182,7 +1182,7 @@ `>', `|' by default). Some interfaces also support - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -1248,7 +1248,7 @@ that situation, moving (no count given) a compatible stack - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -1314,7 +1314,7 @@ Go down a staircase. Default key is `>'. - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -1350,6 +1350,11 @@ paranoid_confirmation:quit option to require a response of yes instead. + #fight + Prefix key to force fight a direction, even if you see noth- + ing to fight there. Default key is `F', or `-' with num- + ber_pad + #fire Fire ammunition from quiver, possibly autowielding a launch- er, or hit with a wielded polearm. Default key is `f'. @@ -1372,15 +1377,10 @@ completes. If mouse support is enabled and the herecmd_menu option is - On, clicking on the hero (or steed when mounted) will exe- - cute this command. - - #history - Show long version and game history. Default key is `V'. + On, clicking on the hero (or steed when mounted) will - - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -1390,6 +1390,11 @@ + execute this command. + + #history + Show long version and game history. Default key is `V'. + #inventory Show your inventory. Default key is `i'. @@ -1439,14 +1444,9 @@ go directly to removing a saddle. Default key is `M-l', and also `l' if number_pad is on. - #monster - Use a monster's special ability (when polymorphed into mon- - ster form). Autocompletes. Default key is `M-m'. - - - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -1456,6 +1456,10 @@ + #monster + Use a monster's special ability (when polymorphed into mon- + ster form). Autocompletes. Default key is `M-m'. + #name Name a monster, an individual object, or a type of object. Same as "#call". Autocompletes. Default keys are `N', `M- @@ -1507,12 +1511,8 @@ strokes such as `>' and `<'. Press Return or Escape to re- sume normal play. Default key is `|'. - #pickup - Pick up things at the current location. Default key is `,'. - The `m' prefix forces use of a menu. - - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -1522,6 +1522,10 @@ + #pickup + Pick up things at the current location. Default key is `,'. + The `m' prefix forces use of a menu. + #polyself Polymorph self. Autocompletes. Debug mode only. @@ -1573,12 +1577,8 @@ Remove an accessory (ring, amulet, etc). Default key is `R'. - #retravel - Travel to a previously selected travel destination. Default - key is `C-_'. See also #travel. - - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -1588,6 +1588,15 @@ + #reqmenu + Prefix key to modify the behaviour or request menu from some + commands. Prevents autopickup when used with movement com- + mands. Default key is `m'. + + #retravel + Travel to a previously selected travel destination. Default + key is `C-_'. See also #travel. + #ride Ride (or stop riding) a saddled creature. Autocompletes. Default key is `M-R'. @@ -1596,6 +1605,16 @@ Rub a lamp or a stone. Autocompletes. Default key is `M- r'. + #run + Prefix key to run towards a direction. Default key is `G' + when number_pad is off, `5' when number_pad is set to 1 or + 3, otherwise `M-5' when it is set to 2 or 4. + + #rush + Prefix key to rush towards a direction. Default is `g' when + number_pad is off, `M-5' when number_pad is set to 1 or 3, + otherwise `5' when it is set to 2 or 4. + #save Save the game and exit the program. Default key is `S'. @@ -1623,6 +1642,18 @@ #shell Do a shell escape, switching from NetHack to a subprocess. + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 26 + + + Can be disabled at the time the program is built. When en- abled, access for specific users can be controlled by the system configuration file. Use the shell command `exit' to @@ -1642,18 +1673,6 @@ monster. To be eligible, the trap must already be discov- ered. (The "#terrain" command can display your map with all objects and monsters temporarily removed, making it possible - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 26 - - - to see all discovered traps.) Default key is `^'. #sit @@ -1689,6 +1708,18 @@ sters; without monsters and objects; or without monsters, objects, and traps. + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 27 + + + In explore mode, you can choose to view the full map rather than just its explored portion. In debug mode there are ad- ditional choices. @@ -1708,18 +1739,6 @@ #timeout Look at the timeout queue. Autocompletes. Debug mode only. - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 27 - - - #tip Tip over a container (bag or box) to pour out its contents. Autocompletes. Default key is `M-T'. The `m' prefix makes @@ -1754,6 +1773,19 @@ #up Go up a staircase. Default key is `<'. + + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 28 + + + #vanquished List vanquished monsters. Autocompletes. Debug mode only. @@ -1775,17 +1807,6 @@ #vision Show vision array. Autocompletes. Debug mode only. - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 28 - - - #wait Rest one move while doing nothing. Default key is `.', and also ` ' if rest_on_space is on. @@ -1819,6 +1840,18 @@ sters) within a modest radius. No time elapses. Autocom- pletes. Debug mode only. Default key is `^E'. + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 29 + + + #wizgenesis Create a monster. May be prefixed by a count to create more than one. Autocompletes. Debug mode only. Default key is @@ -1840,18 +1873,6 @@ Map the level. Autocompletes. Debug mode only. Default key is `^F'. - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 29 - - - #wizrumorcheck Verify rumor boundaries by displaying first and last true rumors and first and last false rumors. @@ -1887,6 +1908,18 @@ + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 30 + + + + + If your keyboard has a meta key (which, when pressed in com- bination with another key, modifies it by setting the "meta" [8th, or "high"] bit), you can invoke many extended commands by @@ -1908,16 +1941,6 @@ combination meta+shift+letter is needed. - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 30 - - - M-? #? (not supported by all platforms) M-2 #twoweapon (unless the number_pad option is enabled) @@ -1948,6 +1971,19 @@ M-o #offer + + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 31 + + + M-O #overview M-p #pray @@ -1972,18 +2008,6 @@ - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 31 - - - If the number_pad option is on, some additional letter com- mands are available: @@ -2014,6 +2038,18 @@ tions. Mapping magic reveals secret corridors, so converts them into ordinary corridors and shows them as such. + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 32 + + + 5.1. Doorways Doorways connect rooms and corridors. Some doorways have no @@ -2038,18 +2074,6 @@ if you attempt to open (via `o' or autoopen) a locked door while carrying an unlocking tool, you'll be asked whether to use it on the door's lock. Alternatively, you can break a closed door - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 32 - - - (whether locked or not) down by kicking it via the `^D' (kick) command. Kicking down a door destroys it and makes a lot of noise which might wake sleeping monsters. @@ -2077,6 +2101,21 @@ in all ways equivalent to normal doors. Mapping magic does not reveal secret doors. + + + + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 33 + + + 5.2. Traps (`^') There are traps throughout the dungeon to snare the unwary @@ -2104,18 +2143,6 @@ Other traps can send you to different locations. Tele- porters send you elsewhere on the same dungeon level. Level teleporters send you to a random dungeon level, the destination - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 33 - - - chosen from a few levels lower all the way to the top. Trap doors and holes also send you to another level, but one which is always below the current level. Usually that will be the next @@ -2143,6 +2170,18 @@ access to that spot. With careful foresight, it is possible to complete all of the levels according to the traditional rules of Sokoban. (Hint: to solve Sokoban puzzles, you often need to move + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 34 + + + things away from their eventual destinations in order to open up more room to maneuver.) Since NetHack does not support an undo capability, some allowances are permitted in case you get stuck. @@ -2170,18 +2209,6 @@ When you traverse a set of stairs, or trigger a trap which sends you to another level, the level you're leaving will be de- activated and stored in a file on disk. If you're moving to a - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 34 - - - previously visited level, it will be loaded from its file on disk and reactivated. If you're moving to a level which has not yet been visited, it will be created (from scratch for most random @@ -2208,37 +2235,10 @@ near the door and many items lying on the floor. You can buy items by picking them up and then using the `p' command. You can inquire about the price of an item prior to picking it up by us- - ing the "#chat" command while standing on it. Using an item pri- - or to paying for it will incur a charge, and the shopkeeper won't - allow you to leave the shop until you have paid any debt you owe. - - You can sell items to a shopkeeper by dropping them to the - floor while inside a shop. You will either be offered an amount - of gold and asked whether you're willing to sell, or you'll be - told that the shopkeeper isn't interested (generally, your item - needs to be compatible with the type of merchandise carried by - the shop). - - If you drop something in a shop by accident, the shopkeeper - will usually claim ownership without offering any compensation. - You'll have to buy it back if you want to reclaim it. - - Shopkeepers sometime run out of money. When that happens, - you'll be offered credit instead of gold when you try to sell - something. Credit can be used to pay for purchases, but it is - only good in the shop where it was obtained; other shopkeepers - won't honor it. (If you happen to find a "credit card" in the - dungeon, don't bother trying to use it in shops; shopkeepers will - not accept it.) - - The `$' command, which reports the amount of gold you are - carrying (in inventory, not inside bags or boxes), will also show - current shop debt or credit, if any. The "Iu" command lists un- - paid items (those which still belong to the shop) if you are car- - rying any. The "Ix" command shows an inventory-like display of + ing the "#chat" command while standing on it. Using an item - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -2248,7 +2248,35 @@ - any unpaid items which have been used up, along with other shop + prior to paying for it will incur a charge, and the shopkeeper + won't allow you to leave the shop until you have paid any debt + you owe. + + You can sell items to a shopkeeper by dropping them to the + floor while inside a shop. You will either be offered an amount + of gold and asked whether you're willing to sell, or you'll be + told that the shopkeeper isn't interested (generally, your item + needs to be compatible with the type of merchandise carried by + the shop). + + If you drop something in a shop by accident, the shopkeeper + will usually claim ownership without offering any compensation. + You'll have to buy it back if you want to reclaim it. + + Shopkeepers sometime run out of money. When that happens, + you'll be offered credit instead of gold when you try to sell + something. Credit can be used to pay for purchases, but it is + only good in the shop where it was obtained; other shopkeepers + won't honor it. (If you happen to find a "credit card" in the + dungeon, don't bother trying to use it in shops; shopkeepers will + not accept it.) + + The `$' command, which reports the amount of gold you are + carrying (in inventory, not inside bags or boxes), will also show + current shop debt or credit, if any. The "Iu" command lists un- + paid items (those which still belong to the shop) if you are car- + rying any. The "Ix" command shows an inventory-like display of + any unpaid items which have been used up, along with other shop fees, if any. 5.4.1. Shop idiosyncrasies @@ -2257,13 +2285,13 @@ * The price of a given item can vary due to a variety of factors. - * A shopkeeper treats the spot immediately inside the door as if + * A shopkeeper treats the spot immediately inside the door as if it were outside the shop. - * While the shopkeeper watches you like a hawk, he or she will + * While the shopkeeper watches you like a hawk, he or she will generally ignore any other customers. - * If a shop is "closed for inventory," it will not open of its + * If a shop is "closed for inventory," it will not open of its own accord. * Shops do not get restocked with new items, regardless of inven- @@ -2271,40 +2299,12 @@ 5.5. Movement feedback - Moving around the map usually provides no feedback--other - than drawing the hero at the new location--unless you step on an - object or pile of objects, or on a trap, or attempt to move onto - a spot where a monster is located. There are several options - which can be used to augment the normal feedback. - - The pile_limit option controls how many objects can be in a - pile--sharing the same map location--for the game to state "there - are objects here" instead of listing them. The default is 5. - Setting it to 1 would always give that message instead of listing - any objects. Setting it to 0 is a special case which will always - list all objects no matter how big a pile is. Note that the num- - ber refers to the count of separate stacks of objects present - rather than the sum of the quantities of those stacks (so 7 ar- - rows or 25 gold pieces will each count as 1 rather than as 7 and - 25, respectively, and total to 2 when both are at the same loca- - tion). - - The "nopickup" command prefix (default `m') can be used be- - fore a movement direction to step on objects without attempting - auto-pickup and without giving feedback about them. - - The mention_walls option controls whether you get feedback - if you try to walk into a wall or solid stone or off the edge of - the map. Normally nothing happens (unless the hero is blind and - no wall is shown, then the wall that is being bumped into will be - drawn on the map). This option also gives feedback when rushing - or running stops for some non-obvious reason. - - The mention_decor option controls whether you get feedback - when walking on "furniture." Normally stepping onto stairs or a + Moving around the map usually provides no feedback--other + than drawing the hero at the new location--unless you step on an + object or pile of objects, or on a trap, or attempt to move onto - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -2314,63 +2314,63 @@ - fountain or an altar or various other things doesn't elicit any- - thing unless it is covered by one or more objects so is obscured - on the map. Setting this option to true will describe such - things even when they aren't obscured. Doorless doorways and - open doors aren't considered worthy of mention; closed doors (if - you can move onto their spots) and broken doors are. Assuming - that you're able to do so, moving onto water or lava or ice will - give feedback if not yet on that type of terrain but not repeat - it (unless there has been some intervening message) when moving + a spot where a monster is located. There are several options + which can be used to augment the normal feedback. + + The pile_limit option controls how many objects can be in a + pile--sharing the same map location--for the game to state "there + are objects here" instead of listing them. The default is 5. + Setting it to 1 would always give that message instead of listing + any objects. Setting it to 0 is a special case which will always + list all objects no matter how big a pile is. Note that the num- + ber refers to the count of separate stacks of objects present + rather than the sum of the quantities of those stacks (so 7 ar- + rows or 25 gold pieces will each count as 1 rather than as 7 and + 25, respectively, and total to 2 when both are at the same loca- + tion). + + The "nopickup" command prefix (default `m') can be used be- + fore a movement direction to step on objects without attempting + auto-pickup and without giving feedback about them. + + The mention_walls option controls whether you get feedback + if you try to walk into a wall or solid stone or off the edge of + the map. Normally nothing happens (unless the hero is blind and + no wall is shown, then the wall that is being bumped into will be + drawn on the map). This option also gives feedback when rushing + or running stops for some non-obvious reason. + + The mention_decor option controls whether you get feedback + when walking on "furniture." Normally stepping onto stairs or a + fountain or an altar or various other things doesn't elicit any- + thing unless it is covered by one or more objects so is obscured + on the map. Setting this option to true will describe such + things even when they aren't obscured. Doorless doorways and + open doors aren't considered worthy of mention; closed doors (if + you can move onto their spots) and broken doors are. Assuming + that you're able to do so, moving onto water or lava or ice will + give feedback if not yet on that type of terrain but not repeat + it (unless there has been some intervening message) when moving from water to another water spot, or lava to lava, or ice to ice. - Moving off of any of those back onto "normal" terrain will give - one message too, unless there is feedback about one or more ob- + Moving off of any of those back onto "normal" terrain will give + one message too, unless there is feedback about one or more ob- jects, in which case the back on land circumstance is implied. - The confirm and safe_pet options control what happens when - you try to move onto a peaceful monster's spot or a tame one's + The confirm and safe_pet options control what happens when + you try to move onto a peaceful monster's spot or a tame one's spot. - The "nopickup" command prefix (default `m') is also the + The "nopickup" command prefix (default `m') is also the move-without-attacking prefix and can be used to try to step onto a visible monster's spot without the move being considered an at- - tack (see the Fighting subsection of Monsters below). The - "fight" command prefix (default `F'; also `-' if number_pad is + tack (see the Fighting subsection of Monsters below). The + "fight" command prefix (default `F'; also `-' if number_pad is on) can be used to force an attack, when guessing where an unseen - monster is or when deliberately attacking a peaceful or tame + monster is or when deliberately attacking a peaceful or tame creature. - The run_mode option controls how frequently the map gets re- - drawn when moving more than one step in a single command (so when - rushing, running, or traveling). - 5.6. Rogue level - - One dungeon level (occurring in mid to late teens of the - main dungeon) is a tribute to the ancestor game hack's inspira- - tion rogue. - - It is usually displayed differently from other levels: pos- - sibly in characters instead of tiles, or without line-drawing - symbols if already in characters; also, gold is shown as * rather - than $ and stairs are shown as % rather than < and >. There are - some minor differences in actual game play: doorways lack doors; - a scroll, wand, or spell of light used in a room lights up the - whole room rather than within a radius around your character. - And monsters represented by lower-case letters aren't randomly - generated on the rogue level. - - The slight strangeness of this level is a feature, not a - bug.... - - 6. Monsters - - Monsters you cannot see are not displayed on the screen. - Beware! You may suddenly come upon one in a dark place. Some - - - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -2380,63 +2380,63 @@ - magic items can help you locate them before they locate you + The run_mode option controls how frequently the map gets re- + drawn when moving more than one step in a single command (so when + rushing, running, or traveling). + + 5.6. Rogue level + + One dungeon level (occurring in mid to late teens of the + main dungeon) is a tribute to the ancestor game hack's inspira- + tion rogue. + + It is usually displayed differently from other levels: pos- + sibly in characters instead of tiles, or without line-drawing + symbols if already in characters; also, gold is shown as * rather + than $ and stairs are shown as % rather than < and >. There are + some minor differences in actual game play: doorways lack doors; + a scroll, wand, or spell of light used in a room lights up the + whole room rather than within a radius around your character. + And monsters represented by lower-case letters aren't randomly + generated on the rogue level. + + The slight strangeness of this level is a feature, not a + bug.... + + 6. Monsters + + Monsters you cannot see are not displayed on the screen. + Beware! You may suddenly come upon one in a dark place. Some + magic items can help you locate them before they locate you (which some monsters can do very well). - The commands `/' and `;' may be used to obtain information - about those monsters who are displayed on the screen. The com- - mand "#name" (by default bound to `C'), allows you to assign a - name to a monster, which may be useful to help distinguish one - from another when multiple monsters are present. Assigning a + The commands `/' and `;' may be used to obtain information + about those monsters who are displayed on the screen. The com- + mand "#name" (by default bound to `C'), allows you to assign a + name to a monster, which may be useful to help distinguish one + from another when multiple monsters are present. Assigning a name which is just a space will remove any prior name. The extended command "#chat" can be used to interact with an adjacent monster. There is no actual dialog (in other words, you don't get to choose what you'll say), but chatting with some mon- - sters such as a shopkeeper or the Oracle of Delphi can produce + sters such as a shopkeeper or the Oracle of Delphi can produce useful results. 6.1. Fighting - If you see a monster and you wish to fight it, just attempt - to walk into it. Many monsters you find will mind their own + If you see a monster and you wish to fight it, just attempt + to walk into it. Many monsters you find will mind their own business unless you attack them. Some of them are very dangerous when angered. Remember: discretion is the better part of valor. - In most circumstances, if you attempt to attack a peaceful - monster by moving into its location, you'll be asked to confirm - your intent. By default an answer of `y' acknowledges that in- - tent, which can be error prone if you're using `y' to move. You - can set the paranoid_confirmation option to require a response of - "yes" instead. - - If you can't see a monster (if it is invisible, or if you - are blinded), the symbol `I' will be shown when you learn of its - presence. If you attempt to walk into it, you will try to fight - it just like a monster that you can see; of course, if the mon- - ster has moved, you will attack empty air. If you guess that the - monster has moved and you don't wish to fight, you can use the - `m' command to move without fighting; likewise, if you don't re- - member a monster but want to try fighting anyway, you can use the - `F' command. - - 6.2. Your pet - - You start the game with a little dog (`d'), kitten (`f'), or - pony (`u'), which follows you about the dungeon and fights mon- - sters with you. Like you, your pet needs food to survive. Dogs - and cats usually feed themselves on fresh carrion and other - meats; horses need vegetarian food which is harder to come by. - If you're worried about your pet or want to train it, you can - feed it, too, by throwing it food. A properly trained pet can be - very useful under certain circumstances. - - Your pet also gains experience from killing monsters, and - can grow over time, gaining hit points and doing more damage. - Initially, your pet may even be better at killing things than + In most circumstances, if you attempt to attack a peaceful + monster by moving into its location, you'll be asked to confirm + your intent. By default an answer of `y' acknowledges that in- + tent, which can be error prone if you're using `y' to move. You - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -2446,63 +2446,63 @@ + can set the paranoid_confirmation option to require a response of + "yes" instead. + + If you can't see a monster (if it is invisible, or if you + are blinded), the symbol `I' will be shown when you learn of its + presence. If you attempt to walk into it, you will try to fight + it just like a monster that you can see; of course, if the mon- + ster has moved, you will attack empty air. If you guess that the + monster has moved and you don't wish to fight, you can use the + `m' command to move without fighting; likewise, if you don't re- + member a monster but want to try fighting anyway, you can use the + `F' command. + + 6.2. Your pet + + You start the game with a little dog (`d'), kitten (`f'), or + pony (`u'), which follows you about the dungeon and fights mon- + sters with you. Like you, your pet needs food to survive. Dogs + and cats usually feed themselves on fresh carrion and other + meats; horses need vegetarian food which is harder to come by. + If you're worried about your pet or want to train it, you can + feed it, too, by throwing it food. A properly trained pet can be + very useful under certain circumstances. + + Your pet also gains experience from killing monsters, and + can grow over time, gaining hit points and doing more damage. + Initially, your pet may even be better at killing things than you, which makes pets useful for low-level characters. - Your pet will follow you up and down staircases if it is - next to you when you move. Otherwise your pet will be stranded - and may become wild. Similarly, when you trigger certain types - of traps which alter your location (for instance, a trap door - which drops you to a lower dungeon level), any adjacent pet will + Your pet will follow you up and down staircases if it is + next to you when you move. Otherwise your pet will be stranded + and may become wild. Similarly, when you trigger certain types + of traps which alter your location (for instance, a trap door + which drops you to a lower dungeon level), any adjacent pet will accompany you and any non-adjacent pet will be left behind. Your - pet may trigger such traps itself; you will not be carried along + pet may trigger such traps itself; you will not be carried along with it even if adjacent at the time. 6.3. Steeds - Some types of creatures in the dungeon can actually be rid- + Some types of creatures in the dungeon can actually be rid- den if you have the right equipment and skill. Convincing a wild - beast to let you saddle it up is difficult to say the least. - Many a dungeoneer has had to resort to magic and wizardry in or- + beast to let you saddle it up is difficult to say the least. + Many a dungeoneer has had to resort to magic and wizardry in or- der to forge the alliance. Once you do have the beast under your - control however, you can easily climb in and out of the saddle + control however, you can easily climb in and out of the saddle with the "#ride" command. Lead the beast around the dungeon when riding, in the same manner as you would move yourself. It is the beast that you will see displayed on the map. - Riding skill is managed by the "#enhance" command. See the + Riding skill is managed by the "#enhance" command. See the section on Weapon proficiency for more information about that. - Use the `a' (apply) command and pick a saddle in your inven- - tory to attempt to put that saddle on an adjacent creature. If - successful, it will be transferred to that creature's inventory. - - Use the "#loot" command while adjacent to a saddled creature - to try to remove the saddle from that creature. If successful, - it will be transferred to your inventory. - - 6.4. Bones levels - - You may encounter the shades and corpses of other adventur- - ers (or even former incarnations of yourself!) and their personal - effects. Ghosts are hard to kill, but easy to avoid, since - they're slow and do little damage. You can plunder the deceased - adventurer's possessions; however, they are likely to be cursed. - Beware of whatever killed the former player; it is probably still - lurking around, gloating over its last victory. - - 6.5. Persistence of Monsters - - Monsters (a generic reference which also includes humans and - pets) are only shown while they can be seen or otherwise sensed. - Moving to a location where you can't see or sense a monster any - more will result in it disappearing from your map, similarly if - it is the one who moved rather than you. - - However, if you encounter a monster which you can't see or - sense--perhaps it is invisible and has just tapped you on the - NetHack 3.7 January 11, 2022 + + NetHack 3.7 January 16, 2022 @@ -2512,11 +2512,39 @@ - noggin--a special "remembered, unseen monster" marker will be - displayed at the location where you think it is. That will per- - sist until you have proven that there is no monster there, even - if the unseen monster moves to another location or you move to a - spot where the marker's location ordinarily wouldn't be seen any + Use the `a' (apply) command and pick a saddle in your inven- + tory to attempt to put that saddle on an adjacent creature. If + successful, it will be transferred to that creature's inventory. + + Use the "#loot" command while adjacent to a saddled creature + to try to remove the saddle from that creature. If successful, + it will be transferred to your inventory. + + 6.4. Bones levels + + You may encounter the shades and corpses of other adventur- + ers (or even former incarnations of yourself!) and their personal + effects. Ghosts are hard to kill, but easy to avoid, since + they're slow and do little damage. You can plunder the deceased + adventurer's possessions; however, they are likely to be cursed. + Beware of whatever killed the former player; it is probably still + lurking around, gloating over its last victory. + + 6.5. Persistence of Monsters + + Monsters (a generic reference which also includes humans and + pets) are only shown while they can be seen or otherwise sensed. + Moving to a location where you can't see or sense a monster any + more will result in it disappearing from your map, similarly if + it is the one who moved rather than you. + + However, if you encounter a monster which you can't see or + sense--perhaps it is invisible and has just tapped you on the + noggin--a special "remembered, unseen monster" marker will be + displayed at the location where you think it is. That will per- + sist until you have proven that there is no monster there, even + if the unseen monster moves to another location or you move to a + spot where the marker's location ordinarily wouldn't be seen any more. 7. Objects @@ -2524,24 +2552,37 @@ When you find something in the dungeon, it is common to want to pick it up. In NetHack, this is accomplished by using the `,' command. If autopickup option is on, you will automatically pick - up the object by walking over, unless you move with the `m' pre- + up the object by walking over, unless you move with the `m' pre- fix. - If you're carrying too many items, NetHack will tell you so - and you won't be able to pick up anything more. Otherwise, it - will add the object(s) to your pack and tell you what you just + If you're carrying too many items, NetHack will tell you so + and you won't be able to pick up anything more. Otherwise, it + will add the object(s) to your pack and tell you what you just picked up. - As you add items to your inventory, you also add the weight - of that object to your load. The amount that you can carry de- - pends on your strength and your constitution. The stronger and - sturdier you are, the less the additional load will affect you. + As you add items to your inventory, you also add the weight + of that object to your load. The amount that you can carry de- + pends on your strength and your constitution. The stronger and + sturdier you are, the less the additional load will affect you. There comes a point, though, when the weight of all of that stuff - you are carrying around with you through the dungeon will encum- - ber you. Your reactions will get slower and you'll burn calories - faster, requiring food more frequently to cope with it. Eventu- - ally, you'll be so overloaded that you'll either have to discard - some of what you're carrying or collapse under its weight. + you are carrying around with you through the dungeon will + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 40 + + + + encumber you. Your reactions will get slower and you'll burn + calories faster, requiring food more frequently to cope with it. + Eventually, you'll be so overloaded that you'll either have to + discard some of what you're carrying or collapse under its + weight. NetHack will tell you how badly you have loaded yourself. If you are encumbered, one of the conditions Burdened, Stressed, @@ -2566,18 +2607,6 @@ extremely obvious, you will be asked what you want to call this type of object so you will recognize it later. You can also use the "#name" command, for the same purpose at any time, to name - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 40 - - - all objects of a particular type or just an individual object. When you use "#name" on an object which has already been named, specifying a space as the value will remove the prior name in- @@ -2603,6 +2632,18 @@ as uncursed. They could just as easily have been described as unblessed, but the uncursed designation is what you will see within the game. A "glass half full versus glass half empty" + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 41 + + + situation; make of that what you will. There are magical means of bestowing or removing curses upon @@ -2632,18 +2673,6 @@ Given a chance, most monsters in the Mazes of Menace will gratuitously try to kill you. You need weapons for self-defense (killing them first). Without a weapon, you do only 1-2 hit - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 41 - - - points of damage (plus bonuses, if any). Monk characters are an exception; they normally do more damage with bare (or gloved) hands than they do with weapons. @@ -2669,6 +2698,18 @@ encumbrance, and proficiency (see below). The monster's armor class--a general defense rating, not necessarily due to wearing of armor--is a factor too; also, some monsters are particularly + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 42 + + + vulnerable to certain types of weapons. Many weapons can be wielded in one hand; some require both @@ -2699,17 +2740,6 @@ `f' (fire), `Q' (quiver), `x' (exchange), `X' (twoweapon), and "#enhance" (see below). - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 42 - - - 7.2.1. Throwing and shooting You can throw just about anything via the `t' command. It @@ -2734,6 +2764,18 @@ You can simplify the throwing operation by using the `Q' command to select your preferred "missile", then using the `f' command to throw it. You'll be prompted for a direction as + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 43 + + + above, but you don't have to specify which item to throw each time you use `f'. There is also an option, autoquiver, which has NetHack choose another item to automatically fill your quiver (or @@ -2765,17 +2807,6 @@ ones kill a monster, the others can still continue beyond that spot. - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 43 - - - 7.2.2. Weapon proficiency You will have varying degrees of skill in the weapons avail- @@ -2799,6 +2830,18 @@ to advance), "unskilled", "basic", "skilled", and "expert". Re- stricted skills simply will not appear in the list shown by "#en- hance". (Divine intervention might unrestrict a particular + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 44 + + + skill, in which case it will start at unskilled and be limited to basic.) Some characters can enhance their barehanded combat or martial arts skill beyond expert to "master" or "grand master". @@ -2830,18 +2873,6 @@ you stop--or before you begin, for that matter--wielding two weapons at once. The primary is your wielded weapon and the sec- ondary is just an item in your inventory that's been designated - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 44 - - - as alternate weapon.) If your primary weapon is wielded but your off hand is empty @@ -2864,8 +2895,20 @@ When in two-weapon combat mode, using the `X' command tog- gles back to single-weapon mode. Throwing or dropping either of - the weapons or having one of them be stolen or destroyed will al- - so make you revert to single-weapon combat. + the weapons or having one of them be stolen or destroyed will + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 45 + + + + also make you revert to single-weapon combat. 7.3. Armor (`[') @@ -2896,18 +2939,6 @@ armor class even further. Most of these provide a one or two point improvement to AC (making the overall value smaller and eventually negative) but can also be enchanted. Shirts are an - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 45 - - - exception; they don't provide any protection unless enchanted. Some cloaks also don't improve AC when unenchanted but all cloaks offer some protection against rust or corrosion to suits worn un- @@ -2930,6 +2961,19 @@ tempt to play the entire game without wearing any armor (a self- imposed challenge which is extremely difficult to accomplish). + + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 46 + + + The commands to use armor are `W' (wear) and `T' (take off). The `A' command can be used to take off armor as well as other worn items. Also, `P' (put on) and `R' (remove) which are nor- @@ -2961,19 +3005,6 @@ The command to eat food is `e'. - - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 46 - - - 7.5. Scrolls (`?') Scrolls are labeled with various titles, probably chosen by @@ -2997,6 +3028,18 @@ name of your favorite reader, so NetHack can shell to it when you read the scroll. On versions of NetHack where mail is randomly generated internal to the game, these environment variables are + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 47 + + + ignored. You can disable the mail daemon by turning off the mail option. @@ -3028,18 +3071,6 @@ tempts to use the wand will usually result in nothing happening. Occasionally, however, it may be possible to squeeze the last few mana points from an otherwise spent wand, destroying it in the - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 47 - - - process. A wand may be recharged by using suitable magic, but doing so runs the risk of causing it to explode. The chance for such an explosion starts out very small and increases each time @@ -3063,6 +3094,18 @@ Rings are very useful items, since they are relatively per- manent magic, unlike the usually fleeting effects of potions, + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 48 + + + scrolls, and wands. Putting on a ring activates its magic. You can wear at most @@ -3094,18 +3137,6 @@ level, or if you have little skill with the appropriate spell type, or cast it at a time when your luck is particularly bad, you can end up wasting both the energy and the time required in - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 48 - - - casting. Casting a spell calls forth magical energies and focuses @@ -3129,6 +3160,18 @@ using the "#enhance" command to advance a sufficiently exercised skill will affect all spells within the group. Advanced skill may increase the potency of spells, reduce their risk of failure + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 49 + + + during casting attempts, and improve the accuracy of the estimate for how much longer they will be retained in your memory. Skill slots are shared with weapons skills. (See also the section on @@ -3161,17 +3204,6 @@ to play the entire game without being able to see (a self-imposed challenge which is very difficult to accomplish). - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 49 - - - The command to use a tool is `a' (apply). 7.10.1. Containers @@ -3193,8 +3225,20 @@ 7.11. Amulets (`"') Amulets are very similar to rings, and often more powerful. - Like rings, amulets have various magical properties, some benefi- - cial, some harmful, which are activated by putting them on. + Like rings, amulets have various magical properties, some + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 50 + + + + beneficial, some harmful, which are activated by putting them on. Only one amulet may be worn at a time, around your neck. Like wearing rings, wearing an amulet affects your metabolism, @@ -3226,18 +3270,6 @@ generally heavy. It is rumored that some statues are not what they seem. - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 50 - - - Boulders occasionally block your path. You can push one forward (by attempting to walk onto its spot) when nothing blocks its path, or you can smash it into a pile of small rocks with @@ -3260,6 +3292,18 @@ longer shown as ``' but by the letter representing the monster they depict instead. + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 51 + + + 7.14. Gold (`$') Gold adds to your score, and you can buy things in shops @@ -3291,19 +3335,6 @@ then once you see or feel that location again you will re-discov- er the object and resume remembering it. - - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 51 - - - The situation is the same for a pile of objects, except that only the top item of the pile is displayed. The hilite_pile op- tion can be enabled in order to show an item differently when it @@ -3327,6 +3358,18 @@ The most difficult of these is the foodless challenge. Although creatures can survive long periods of time without food, there is a physiological need for water; thus there is no restriction on + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 52 + + + drinking beverages, even if they provide some minor food bene- fits. Calling upon your god for help with starvation does not violate any food challenges either. @@ -3358,18 +3401,6 @@ corpse. Eating leather, dragon hide, or bone items while poly- morphed into a creature that can digest it, or eating monster brains while polymorphed into a mind flayer, is considered eating - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 52 - - - an animal, although wax is only an animal byproduct. Regardless of conduct, there will be some items which are @@ -3393,6 +3424,18 @@ of Yendor to your god is necessary to win the game and is not counted against this conduct. You are also not penalized for be- ing spoken to by an angry god, priest(ess), or other religious + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 53 + + + figure; a true atheist would hear the words but attach no special meaning to them. @@ -3423,61 +3466,60 @@ to plug those in order to both get the boulders out of the way and be able to go past the traps. There are some special "rules" that are active when in that branch of the dungeon. Some rules - can't be bypassed, such as being unable to push a boulder + can't be bypassed, such as being unable to push a boulder diago- + nally. Other rules can, such as not smashing boulders with magic + or tools, but doing so causes you to receive a luck penalty. No + message about that is given at the time, but it is tracked as a + conduct. The #conduct command and end of game disclosure will + report whether you have abided by the special rules of Sokoban, + and if not, how many times you violated them, providing you with + a way to discover which actions incur bad luck so that you can be + better informed about whether or not to avoid repeating those ac- + tions in the future. (Note: the Sokoban conduct will only be + displayed if you have entered the Sokoban branch of the dungeon + during the current game. Once that has happened, it becomes part + of disclosed conduct even if you haven't done anything interest- + ing there. Ending the game with "never broke the Sokoban rules" + conduct is most meaningful if you also manage to perform the "ob- + tained the Sokoban prize" achievement (see Achievements below).) - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 53 - - - - diagonally. Other rules can, such as not smashing boulders with - magic or tools, but doing so causes you to receive a luck penal- - ty. No message about that is given at the time, but it is - tracked as a conduct. The #conduct command and end of game dis- - closure will report whether you have abided by the special rules - of Sokoban, and if not, how many times you violated them, provid- - ing you with a way to discover which actions incur bad luck so - that you can be better informed about whether or not to avoid re- - peating those actions in the future. (Note: the Sokoban conduct - will only be displayed if you have entered the Sokoban branch of - the dungeon during the current game. Once that has happened, it - becomes part of disclosed conduct even if you haven't done any- - thing interesting there. Ending the game with "never broke the - Sokoban rules" conduct is most meaningful if you also manage to - perform the "obtained the Sokoban prize" achievement (see - Achievements below).) - - There are several other challenges tracked by the game. It + There are several other challenges tracked by the game. It is possible to eliminate one or more species of monsters by geno- - cide; playing without this feature is considered a challenge. + cide; playing without this feature is considered a challenge. When the game offers you an opportunity to genocide monsters, you - may respond with the monster type "none" if you want to decline. - You can change the form of an item into another item of the same - type ("polypiling") or the form of your own body into another - creature ("polyself") by wand, spell, or potion of polymorph; - avoiding these effects are each considered challenges. Polymor- - phing monsters, including pets, does not break either of these - challenges. Finally, you may sometimes receive wishes; a game - without an attempt to wish for any items is a challenge, as is a - game without wishing for an artifact (even if the artifact imme- - diately disappears). When the game offers you an opportunity to - make a wish for an item, you may choose "nothing" if you want to + may respond with the monster type "none" if you want to decline. + You can change the form of an item into another item of the same + type ("polypiling") or the form of your own body into another + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 54 + + + + creature ("polyself") by wand, spell, or potion of polymorph; + avoiding these effects are each considered challenges. Polymor- + phing monsters, including pets, does not break either of these + challenges. Finally, you may sometimes receive wishes; a game + without an attempt to wish for any items is a challenge, as is a + game without wishing for an artifact (even if the artifact imme- + diately disappears). When the game offers you an opportunity to + make a wish for an item, you may choose "nothing" if you want to decline. 8.1. Achievements - End of game disclosure will also display various achieve- - ments representing progress toward ultimate ascension, if any - have been attained. They aren't directly related to conduct but - are grouped with it because they fall into the same category of - "bragging rights" and to limit the number of questions during - disclosure. Listed here roughly in order of difficulty and not + End of game disclosure will also display various achieve- + ments representing progress toward ultimate ascension, if any + have been attained. They aren't directly related to conduct but + are grouped with it because they fall into the same category of + "bragging rights" and to limit the number of questions during + disclosure. Listed here roughly in order of difficulty and not necessarily in the order in which you might accomplish them. - Attained rank title . @@ -3490,18 +3532,6 @@ Sokoban - Entered Sokoban. Big Room - Entered the Big Room. Soko-Prize - Explored to the top of Sokoban - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 54 - - - and found a special item there. Mines' End - Explored to the bottom of the Gnomish Mines and found a special item there. @@ -3520,45 +3550,15 @@ Notes: - Achievements are recorded and subsequently reported in the - order in which they happen during your current game rather than + Achievements are recorded and subsequently reported in the + order in which they happen during your current game rather than the order listed here. - There are nine titles for each role, bestowed at ex- + There are nine titles for each role, bestowed at ex- perience levels 1, 3, 6, 10, 14, 18, 22, 26, and 30. The one for - experience level 1 is not recorded as an achievement. Losing - enough levels to revert to lower rank(s) does not discard the - corresponding achievement(s). - - There's no guaranteed Novel so the achievement to read one - might not always be attainable (except perhaps by wishing). Sim- - ilarly, the Big Room level is not always present. Unlike with - the Novel, there's no way to wish for this opportunity. - - The "special items" hidden in Mines' End and Sokoban are not - unique but are considered to be prizes or rewards for exploring - those levels since doing so is not necessary to complete the - game. Finding other instances of the same objects doesn't record - the corresponding achievement. - - The Medusa achievement is recorded if she dies for any rea- - son, even if you are not directly responsible, and only if she - dies. - - Blind and Nudist are also conducts, and they can only be en- - abled by setting the correspondingly named option in NETHACKOP- - TIONS or run-time configuration file prior to game start. In the - case of Blind, the option also enforces the conduct. They aren't - really significant accomplishments unless/until you make substan- - tial progress into the dungeon. - - 9. Options - - Due to variations in personal tastes and conceptions of how - NetHack should do things, there are options you can set to change - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -3568,16 +3568,46 @@ + experience level 1 is not recorded as an achievement. Losing + enough levels to revert to lower rank(s) does not discard the + corresponding achievement(s). + + There's no guaranteed Novel so the achievement to read one + might not always be attainable (except perhaps by wishing). Sim- + ilarly, the Big Room level is not always present. Unlike with + the Novel, there's no way to wish for this opportunity. + + The "special items" hidden in Mines' End and Sokoban are not + unique but are considered to be prizes or rewards for exploring + those levels since doing so is not necessary to complete the + game. Finding other instances of the same objects doesn't record + the corresponding achievement. + + The Medusa achievement is recorded if she dies for any rea- + son, even if you are not directly responsible, and only if she + dies. + + Blind and Nudist are also conducts, and they can only be en- + abled by setting the correspondingly named option in NETHACKOP- + TIONS or run-time configuration file prior to game start. In the + case of Blind, the option also enforces the conduct. They aren't + really significant accomplishments unless/until you make substan- + tial progress into the dungeon. + + 9. Options + + Due to variations in personal tastes and conceptions of how + NetHack should do things, there are options you can set to change how NetHack behaves. 9.1. Setting the options - Options may be set in a number of ways. Within the game, + Options may be set in a number of ways. Within the game, the `O' command allows you to view all options and change most of - them. You can also set options automatically by placing them in - a configuration file, or in the NETHACKOPTIONS environment vari- + them. You can also set options automatically by placing them in + a configuration file, or in the NETHACKOPTIONS environment vari- able. Some versions of NetHack also have front-end programs that - allow you to set options before starting the game or a global + allow you to set options before starting the game or a global configuration for system administrators. 9.2. Using a configuration file @@ -3585,46 +3615,16 @@ The default name of the configuration file varies on differ- ent operating systems. - On UNIX, Linux, and Mac OS X it is ".nethackrc" in the us- - er's home directory. The file may not exist, but it is a normal + On UNIX, Linux, and Mac OS X it is ".nethackrc" in the us- + er's home directory. The file may not exist, but it is a normal ASCII text file and can be created with any text editor. - On Windows, it is ".nethackrc" in the folder "\%USERPRO- - FILE%\NetHack\3.6". The file may not exist, but it is a normal - ASCII text file can can be created with any text editor. After - running NetHack for the first time, you should find a default - template for the configuration file named ".nethackrc.template" - in "\%USERPROFILE%\NetHack\3.6". If you had not created the con- - figuration file, NetHack will create the configuration file for - you using the default template file. - - On MS-DOS, it is "defaults.nh" in the same folder as - nethack.exe. - - Any line in the configuration file starting with `#' is - treated as a comment and ignored. Empty lines are ignored. - - Any line beginning with `[' and ending in `]' is a section - marker (the closing `]' can be followed by whitespace and then an - arbitrary 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 insensi- - tive. Lines after a section marker belong to that section up un- - til another section starts or a marker without a name is encoun- - tered or the file ends. Lines within sections are ignored unless - a CHOOSE directive has selected that section. - - You can use different configuration directives in the file, - some of which can be used multiple times. In general, the direc- - tives are written in capital letters, followed by an equals sign, - followed by settings particular to that directive. - - Here is a list of allowed directives: + On Windows, it is ".nethackrc" in the folder "\%USERPRO- + FILE%\NetHack\3.6". The file may not exist, but it is a normal + ASCII text file can can be created with any text editor. After - - - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -3634,15 +3634,44 @@ + running NetHack for the first time, you should find a default + template for the configuration file named ".nethackrc.template" + in "\%USERPROFILE%\NetHack\3.6". If you had not created the con- + figuration file, NetHack will create the configuration file for + you using the default template file. + + On MS-DOS, it is "defaults.nh" in the same folder as + nethack.exe. + + Any line in the configuration file starting with `#' is + treated as a comment and ignored. Empty lines are ignored. + + Any line beginning with `[' and ending in `]' is a section + marker (the closing `]' can be followed by whitespace and then an + arbitrary 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 insensi- + tive. Lines after a section marker belong to that section up un- + til another section starts or a marker without a name is encoun- + tered or the file ends. Lines within sections are ignored unless + a CHOOSE directive has selected that section. + + You can use different configuration directives in the file, + some of which can be used multiple times. In general, the direc- + tives are written in capital letters, followed by an equals sign, + followed by settings particular to that directive. + + Here is a list of allowed directives: + OPTIONS - There are two types of options, boolean and compound options. - Boolean options toggle a setting on or off, while compound op- - tions take more diverse values. Prefix a boolean option with - "no" or `!' to turn it off. For compound options, the option + There are two types of options, boolean and compound options. + Boolean options toggle a setting on or off, while compound op- + tions take more diverse values. Prefix a boolean option with + "no" or `!' to turn it off. For compound options, the option name and value are separated by a colon. Some options are per- sistent, and apply only to new games. You can specify multiple OPTIONS directives, and multiple options separated by commas in - a single OPTIONS directive. (Comma separated options are pro- + a single OPTIONS directive. (Comma separated options are pro- cessed from right to left.) Example: @@ -3651,46 +3680,17 @@ OPTIONS=!legacy,autopickup,pickup_types:$"=/!?+ HACKDIR - Default location of files NetHack needs. On Windows HACKDIR - defaults to the location of the NetHack.exe or NetHackw.exe - file so setting HACKDIR to override that is not usually neces- + Default location of files NetHack needs. On Windows HACKDIR + defaults to the location of the NetHack.exe or NetHackw.exe + file so setting HACKDIR to override that is not usually neces- sary or recommended. LEVELDIR - The location that in-progress level files are stored. Defaults + The location that in-progress level files are stored. Defaults to HACKDIR, must be writable. - SAVEDIR - The location where saved games are kept. Defaults to HACKDIR, - must be writable. - BONESDIR - The location that bones files are kept. Defaults to HACKDIR, - must be writable. - - LOCKDIR - The location that file synchronization locks are stored. - Defaults to HACKDIR, must be writable. - - TROUBLEDIR - The location that a record of game aborts and self-diagnosed - game problems is kept. Defaults to HACKDIR, must be writable. - - AUTOCOMPLETE - Enable or disable an extended command autocompletion. Autocom- - pletion has no effect for the X11 windowport. You can specify - multiple autocompletions. To enable autocompletion, list the - extended command. Prefix the command with "!" to disable the - autocompletion for that command. - - Example: - - AUTOCOMPLETE=zap,!annotate - - - - - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -3700,14 +3700,41 @@ + SAVEDIR + The location where saved games are kept. Defaults to HACKDIR, + must be writable. + + BONESDIR + The location that bones files are kept. Defaults to HACKDIR, + must be writable. + + LOCKDIR + The location that file synchronization locks are stored. + Defaults to HACKDIR, must be writable. + + TROUBLEDIR + The location that a record of game aborts and self-diagnosed + game problems is kept. Defaults to HACKDIR, must be writable. + + AUTOCOMPLETE + Enable or disable an extended command autocompletion. Autocom- + pletion has no effect for the X11 windowport. You can specify + multiple autocompletions. To enable autocompletion, list the + extended command. Prefix the command with "!" to disable the + autocompletion for that command. + + Example: + + AUTOCOMPLETE=zap,!annotate + AUTOPICKUP_EXCEPTION - Set exceptions to the pickup_types option. See the "Configur- + Set exceptions to the pickup_types option. See the "Configur- ing Autopickup Exceptions" section. BINDINGS - Change the key bindings of some special keys, menu accelera- + Change the key bindings of some special keys, menu accelera- tors, or extended commands. You can specify multiple bindings. - Format is key followed by the command, separated by a colon. + Format is key followed by the command, separated by a colon. See the "Changing Key Bindings" section for more information. Example: @@ -3715,11 +3742,30 @@ BIND=^X:getpos.autodescribe CHOOSE - Chooses at random one of the comma-separated parameters as an + Chooses at random one of the comma-separated parameters as an active section name. Lines in other sections are ignored. Example: + + + + + + + + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 58 + + + OPTIONS=color CHOOSE=char A,char B [char A] @@ -3729,9 +3775,9 @@ [] #end of CHOOSE OPTIONS=!rest_on_space - If [] is present, the preceding section is closed and no new - section begins; whatever follows will be common to all sec- - tions. Otherwise the last section extends to the end of the + If [] is present, the preceding section is closed and no new + section begins; whatever follows will be common to all sec- + tions. Otherwise the last section extends to the end of the options file. MENUCOLOR @@ -3739,11 +3785,11 @@ ing Menu Colors" section. MSGTYPE - Change the way messages are shown in the top status line. See + Change the way messages are shown in the top status line. See the "Configuring Message Types" section. ROGUESYMBOLS - Custom symbols for for the rogue level's symbol set. See SYM- + Custom symbols for for the rogue level's symbol set. See SYM- BOLS below. SOUND @@ -3751,24 +3797,12 @@ tion. SOUNDDIR - Define the directory that contains the sound files. See the + Define the directory that contains the sound files. See the "Configuring User Sounds" section. - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 58 - - - SYMBOLS - Override one or more symbols in the symbol set used for all - dungeon levels except for the special rogue level. See the + Override one or more symbols in the symbol set used for all + dungeon levels except for the special rogue level. See the "Modifying NetHack Symbols" section. Example: @@ -3777,9 +3811,9 @@ SYMBOLS=S_boulder:0,S_golem:7 WIZKIT - Debug mode only: extra items to add to initial inventory. - Value is the name of a text file containing a list of item - names, one per line, up to a maximum of 128 lines. Each line + Debug mode only: extra items to add to initial inventory. + Value is the name of a text file containing a list of item + names, one per line, up to a maximum of 128 lines. Each line is processed by the function that handles wishing. Example: @@ -3788,6 +3822,18 @@ + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 59 + + + + + Here is an example of configuration file contents: # Set your character's role, race, gender, and alignment. @@ -3810,35 +3856,22 @@ 9.3. Using the NETHACKOPTIONS environment variable - 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, and turn it off by typing a `!' or "no" be- - fore the name. Others take a character string as a value. You - can set string options by typing the option name, a colon or + 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, and turn it off by typing a `!' or "no" be- + fore 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 string. The value is ter- minated by the next comma or the end of string. - - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 59 - - - For example, to set up an environment variable so that color is on, legacy is off, character name is set to "Blue Meanie", and named fruit is set to "lime", you would enter the command % setenv NETHACKOPTIONS "color,\!leg,name:Blue Meanie,fruit:lime" - in csh (note the need to escape the `!' since it's special to + in csh (note the need to escape the `!' since it's special to that shell), or the pair of commands $ NETHACKOPTIONS="color,!leg,name:Blue Meanie,fruit:lime" @@ -3848,47 +3881,14 @@ The NETHACKOPTIONS value is effectively the same as a single OPTIONS directive in a configuration file. The "OPTIONS=" prefix - is implied and comma separated options are processed from right + is implied and comma separated options are processed from right to left. Other types of configuration directives such as BIND or MSGTYPE are not allowed. - Instead of a comma-separated list of options, NETHACKOPTIONS - can be set to the full name of a configuration file you want to - use. If that full name doesn't start with a slash, precede it - with `@' (at-sign) to let NetHack know that the rest is intended - as a file name. If it does start with `/', the at-sign is op- - tional. - - 9.4. Customization options - - Here are explanations of what the various options do. Char- - acter strings that are too long may be truncated. Some of the - options listed may be inactive in your dungeon. - - Some options are persistent, and are saved and reloaded - along with the game. Changing a persistent option in the config- - uration file applies only to new games. - - acoustics - Enable messages about what your character hears (default on). - Note that this has nothing to do with your computer's audio ca- - pabilities. Persistent. - - align - Your starting alignment (align:lawful, align:neutral, or - align:chaotic). You may specify just the first letter. The - default is to randomly pick an appropriate alignment. If you - prefix the value with `!' or "no", you will exclude that align- - ment from being picked randomly. Cannot be set with the `O' - command. Persistent. - - autodescribe - Automatically describe the terrain under cursor when asked to - get a location on the map (default true). The whatis_coord op- - tion controls whether the description includes map coordinates. - NetHack 3.7 January 11, 2022 + + NetHack 3.7 January 16, 2022 @@ -3898,63 +3898,63 @@ + Instead of a comma-separated list of options, NETHACKOPTIONS + can be set to the full name of a configuration file you want to + use. If that full name doesn't start with a slash, precede it + with `@' (at-sign) to let NetHack know that the rest is intended + as a file name. If it does start with `/', the at-sign is op- + tional. + + 9.4. Customization options + + Here are explanations of what the various options do. Char- + acter strings that are too long may be truncated. Some of the + options listed may be inactive in your dungeon. + + Some options are persistent, and are saved and reloaded + along with the game. Changing a persistent option in the config- + uration file applies only to new games. + + acoustics + Enable messages about what your character hears (default on). + Note that this has nothing to do with your computer's audio ca- + pabilities. Persistent. + + align + Your starting alignment (align:lawful, align:neutral, or + align:chaotic). You may specify just the first letter. The + default is to randomly pick an appropriate alignment. If you + prefix the value with `!' or "no", you will exclude that align- + ment from being picked randomly. Cannot be set with the `O' + command. Persistent. + + autodescribe + Automatically describe the terrain under cursor when asked to + get a location on the map (default true). The whatis_coord op- + tion controls whether the description includes map coordinates. + autodig Automatically dig if you are wielding a digging tool and moving into a place that can be dug (default false). Persistent. autoopen - Walking into a closed door attempts to open it (default true). + Walking into a closed door attempts to open it (default true). Persistent. autopickup Automatically pick up things onto which you move (default off). Persistent. - See pickup_types and also autopickup_exception to refine the + See pickup_types and also autopickup_exception to refine the behavior. autoquiver - 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 ready some suitable weapon. Note that it - will not take into account the blessed/cursed status, enchant- - ment, damage, or quality of the weapon; you are free to manual- - ly fill your quiver or quiver sack or make ready with the `Q' - command instead. If no weapon is found or the option is false, - the `t' (throw) command is executed instead. Persistent. - - autounlock - Walking into a locked door or looting a locked container while - carrying an unlocking tool (such as a key) will ask whether to - use that tool to unlock the door or container (default true). - Persistent. - - blind - Start the character permanently blind (default false). Persis- - tent. - - bones - Allow saving and loading bones files (default true). Persis- - tent. - - boulder - Set the character used to display boulders (default is the - "large rock" class symbol, ``'). - - catname - Name your starting cat (for example "catname:Morris"). Cannot - be set with the `O' command. - - character - Synonym for "role" to pick the type of your character (for ex- - ample "character:Monk"). See role for more details. - - checkpoint - Save game state after each level change, for possible recovery + 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 - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -3964,28 +3964,76 @@ + quiver sack or make ready some suitable weapon. Note that it + will not take into account the blessed/cursed status, enchant- + ment, damage, or quality of the weapon; you are free to manual- + ly fill your quiver or quiver sack or make ready with the `Q' + command instead. If no weapon is found or the option is false, + the `t' (throw) command is executed instead. Persistent. + + autounlock + Walking into a locked door or looting a locked container while + carrying an unlocking tool (such as a key) will ask whether to + use that tool to unlock the door or container (default true). + Persistent. + + blind + Start the character permanently blind (default false). Persis- + tent. + + bones + Allow saving and loading bones files (default true). Persis- + tent. + + boulder + Set the character used to display boulders (default is the + "large rock" class symbol, ``'). + + catname + Name your starting cat (for example "catname:Morris"). Cannot + be set with the `O' command. + + character + Synonym for "role" to pick the type of your character (for ex- + ample "character:Monk"). See role for more details. + + checkpoint + Save game state after each level change, for possible recovery after program crash (default on). Persistent. clicklook - Allows looking at things on the screen by navigating the mouse + Allows looking at things on the screen by navigating the mouse over them and clicking the right mouse button (default off). cmdassist - Have the game provide some additional command assistance for - new players if it detects some anticipated mistakes (default + Have the game provide some additional command assistance for + new players if it detects some anticipated mistakes (default on). confirm - Have user confirm attacks on pets, shopkeepers, and other + Have user confirm attacks on pets, shopkeepers, and other peaceable creatures (default on). Persistent. dark_room Show out-of-sight areas of lit rooms (default on). Persistent. + + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 62 + + + disclose - Controls what information the program reveals when the game - ends. Value is a space separated list of prompting/category - pairs (default is "ni na nv ng nc no", prompt with default re- + Controls what information the program reveals when the game + ends. Value is a space separated list of prompting/category + pairs (default is "ni na nv ng nc no", prompt with default re- sponse of `n' for each candidate). Persistent. The possibili- ties are: @@ -3996,8 +4044,8 @@ c - display your conduct; also achievements, if any; o - display dungeon overview. - Each disclosure possibility can optionally be preceded by a - prefix which lets you refine how it behaves. Here are the + Each disclosure possibility can optionally be preceded by a + prefix which lets you refine how it behaves. Here are the valid prefixes: y - prompt you and default to yes on the prompt; @@ -4005,41 +4053,29 @@ + - disclose it without prompting; - - do not disclose it and do not prompt. - The listing of vanquished monsters can be sorted, so there are + The listing of vanquished monsters can be sorted, so there are two additional choices for `v': ? - 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 + `+' disclose without prompting choice, or being prompted and answering `y' rather than `a', will default to showing monsters in the traditional order, from high level to low level. Omitted categories are implicitly added with `n' prefix. Spec- ified categories with omitted prefix implicitly use `+' prefix. - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 62 - - - - Order of the disclosure categories does not matter, program + Order of the disclosure categories does not matter, program display for end-of-game disclosure follows a set sequence. - (for example "disclose:yi na +v -g o") The example sets inven- + (for example "disclose:yi na +v -g o") The example sets inven- tory to prompt and default to yes, attributes to prompt and de- fault to no, vanquished to disclose without prompting, genocid- ed to not disclose and not prompt, conduct to implicitly prompt and default to no, and overview to disclose without prompting. - Note that the vanquished monsters list includes all monsters + Note that the vanquished monsters list includes all monsters killed by traps and each other as well as by you. And the dun- geon overview shows all levels you had visited but does not re- veal things about them that you hadn't discovered. @@ -4048,45 +4084,9 @@ Name your starting dog (for example "dogname:Fang"). Cannot be set with the `O' command. - extmenu - Changes the extended commands interface to pop-up a menu of - available commands. It is keystroke compatible with the tradi- - tional interface except that it does not require that you hit - Enter. It is implemented for the tty interface (default off). - - For the X11 interface, which always uses a menu for choosing an - extended command, it controls whether the menu shows all avail- - able commands (on) or just the subset of commands which have - traditionally been considered extended ones (off). - - female - An obsolete synonym for "gender:female". Cannot be set with - the `O' command. - - fireassist - This option controls what happens when you attempt the `f' - (fire) and don't have an appropriate launcher, such as a bow or - a sling, wielded. If on, you will automatically wield the - launcher. Default is on. - - fixinv - An object's inventory letter sticks to it when it's dropped - (default on). If this is off, dropping an object shifts all - the remaining inventory letters. Persistent. - - force_invmenu - Commands asking for an inventory item show a menu instead of a - text query with possible menu letters. Default is off. - - fruit - Name a fruit after something you enjoy eating (for example - "fruit:mango") (default "slime mold"). Basically a nostalgic - whimsy that NetHack uses from time to time. You should set - this to something you find more appetizing than slime mold. - Apples, oranges, pears, bananas, and melons already exist in - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -4096,63 +4096,63 @@ + extmenu + Changes the extended commands interface to pop-up a menu of + available commands. It is keystroke compatible with the tradi- + tional interface except that it does not require that you hit + Enter. It is implemented for the tty interface (default off). + + For the X11 interface, which always uses a menu for choosing an + extended command, it controls whether the menu shows all avail- + able commands (on) or just the subset of commands which have + traditionally been considered extended ones (off). + + female + An obsolete synonym for "gender:female". Cannot be set with + the `O' command. + + fireassist + This option controls what happens when you attempt the `f' + (fire) and don't have an appropriate launcher, such as a bow or + a sling, wielded. If on, you will automatically wield the + launcher. Default is on. + + fixinv + An object's inventory letter sticks to it when it's dropped + (default on). If this is off, dropping an object shifts all + the remaining inventory letters. Persistent. + + force_invmenu + Commands asking for an inventory item show a menu instead of a + text query with possible menu letters. Default is off. + + fruit + Name a fruit after something you enjoy eating (for example + "fruit:mango") (default "slime mold"). Basically a nostalgic + whimsy that NetHack uses from time to time. You should set + this to something you find more appetizing than slime mold. + Apples, oranges, pears, bananas, and melons already exist in NetHack, so don't use those. gender - Your starting gender (gender:male or gender:female). You may - specify just the first letter. Although you can still denote + Your starting gender (gender:male or gender:female). You may + specify just the first letter. Although you can still denote your gender using the "male" and "female" options, the "gender" - option will take precedence. The default is to randomly pick - an appropriate gender. If you prefix the value with `!' or - "no", you will exclude that gender from being picked randomly. + option will take precedence. The default is to randomly pick + an appropriate gender. If you prefix the value with `!' or + "no", you will exclude that gender from being picked randomly. 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 de- - fault). Gold is never blessed or cursed, but it is not de- + 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 de- + fault). Gold is never blessed or cursed, but it is not de- scribed as "uncursed" even when the implicit_uncursed option is "off". - help - If more information is available for an object looked at with - the `/' command, ask if you want to see it (default on). Turn- - ing help off makes just looking at things faster, since you - aren't interrupted with the "More info?" prompt, but it also - means that you might miss some interesting and/or important in- - formation. Persistent. - herecmd_menu - When using a windowport that supports mouse and clicking on - yourself or next to you, show a menu of possible actions for - the location. Same as "#herecmdmenu" and "#therecmdmenu" com- - mands. - - hilite_pet - Visually distinguish pets from similar animals (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 heart symbol - near pets. - - With the curses interface, the petattr option controls how to - highlight pets and setting it will turn the hilite_pet option - on or off as warranted. - - hilite_pile - Visually distinguish piles of objects from individual objects - (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-symbol beside the object on the top of the pile. - - hitpointbar - Show a hit point bar graph behind your name and title. Only - available for TTY and Windows GUI, and only when statushilites - - - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -4162,10 +4162,45 @@ + help + If more information is available for an object looked at with + the `/' command, ask if you want to see it (default on). Turn- + ing help off makes just looking at things faster, since you + aren't interrupted with the "More info?" prompt, but it also + means that you might miss some interesting and/or important in- + formation. Persistent. + + herecmd_menu + When using a windowport that supports mouse and clicking on + yourself or next to you, show a menu of possible actions for + the location. Same as "#herecmdmenu" and "#therecmdmenu" com- + mands. + + hilite_pet + Visually distinguish pets from similar animals (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 heart symbol + near pets. + + With the curses interface, the petattr option controls how to + highlight pets and setting it will turn the hilite_pet option + on or off as warranted. + + hilite_pile + Visually distinguish piles of objects from individual objects + (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-symbol beside the object on the top of the pile. + + hitpointbar + Show a hit point bar graph behind your name and title. Only + available for TTY and Windows GUI, and only when statushilites is on. horsename - Name your starting horse (for example "horsename:Trigger"). + Name your starting horse (for example "horsename:Trigger"). Cannot be set with the `O' command. ignintr @@ -4174,51 +4209,16 @@ implicit_uncursed Omit "uncursed" from object descriptions when it can be deduced - from other aspects of the description (default on). Persis- + from other aspects of the description (default on). Persis- tent. If you use menu coloring, you may want to turn this off. legacy Display an introductory message when starting the game (default - on). Persistent. - - lit_corridor - Show corridor squares seen by night vision or a light source - held by your character as lit (default off). Persistent. - - lootabc - When using a menu to interact with a container, use the old - `a', `b', and `c' keyboard shortcuts rather than the mnemonics - `o', `i', and `b' (default off). Persistent. - - mail - Enable mail delivery during the game (default on). Persistent. - - male - An obsolete synonym for "gender:male". Cannot be set with the - `O' command. - - mention_decor - Give feedback when walking onto various dungeon features such - as stairs, fountains, or altars which are ordinarily only de- - scribed when covered by one or more objects (default off). - Persistent. - - mention_walls - Give feedback when walking against a wall (default off). Per- - sistent. - - menucolors - Enable coloring menu lines (default off). See "Configuring - Menu Colors" on how to configure the colors. - - menustyle - Controls the interface used when you need to choose various ob- - jects (in response to the Drop command, for instance). The - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -4228,24 +4228,72 @@ - value specified should be the first letter of one of the fol- - lowing: traditional, combination, full, or partial. Persis- + on). Persistent. + + lit_corridor + Show corridor squares seen by night vision or a light source + held by your character as lit (default off). Persistent. + + lootabc + When using a menu to interact with a container, use the old + `a', `b', and `c' keyboard shortcuts rather than the mnemonics + `o', `i', and `b' (default off). Persistent. + + mail + Enable mail delivery during the game (default on). Persistent. + + male + An obsolete synonym for "gender:male". Cannot be set with the + `O' command. + + mention_decor + Give feedback when walking onto various dungeon features such + as stairs, fountains, or altars which are ordinarily only de- + scribed when covered by one or more objects (default off). + Persistent. + + mention_walls + Give feedback when walking against a wall (default off). Per- + sistent. + + menucolors + Enable coloring menu lines (default off). See "Configuring + Menu Colors" on how to configure the colors. + + menustyle + Controls the interface used when you need to choose various ob- + jects (in response to the Drop command, for instance). The + value specified should be the first letter of one of the fol- + lowing: traditional, combination, full, or partial. Persis- tent. - Traditional was the only interface available for very early - versions; it consists of a prompt for object class characters, - followed by an object-by-object prompt for all items matching - the selected object class(es). Combination starts with a - prompt for object class(es) of interest, but then displays a - menu of matching objects rather than prompting one-by-one. - Full displays a menu of object classes rather than a character - prompt, and then a menu of matching objects for selection. - Partial skips the object class filtering and immediately dis- + Traditional was the only interface available for very early + versions; it consists of a prompt for object class characters, + followed by an object-by-object prompt for all items matching + the selected object class(es). Combination starts with a + prompt for object class(es) of interest, but then displays a + menu of matching objects rather than prompting one-by-one. + Full displays a menu of object classes rather than a character + prompt, and then a menu of matching objects for selection. + Partial skips the object class filtering and immediately dis- plays a menu of all objects. menu_deselect_all Key to deselect all items in a menu. Default `-'. + + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 66 + + + menu_deselect_page Key to deselect all items on this page of a menu. Default `\'. @@ -4253,8 +4301,8 @@ Key to jump to the first page in a menu. Default `^'. menu_headings - Controls how the headings in a menu are highlighted. Values - are "none", "bold", "dim", "underline", "blink", or "inverse". + Controls how the headings in a menu are highlighted. Values + are "none", "bold", "dim", "underline", "blink", or "inverse". Not all ports can actually display all types. menu_invert_all @@ -4270,32 +4318,19 @@ Key to go to the next menu page. Default `>'. menu_objsyms - Show object symbols in menu headings in menus where the object + Show object symbols in menu headings in menus where the object symbols act as menu accelerators (default off). menu_overlay - Do not clear the screen before drawing menus, and align menus - to the right edge of the screen. Only for the tty port. (de- + Do not clear the screen before drawing menus, and align menus + to the right edge of the screen. Only for the tty port. (de- fault on) menu_previous_page Key to go to the previous menu page. Default `<'. - - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 66 - - - menu_search - Key to search for some text and toggle selection state of + Key to search for some text and toggle selection state of matching menu items. Default `:'. menu_select_all @@ -4305,52 +4340,17 @@ Key to select all items on this page of a menu. Default `,'. 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 + 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 `{'. menu_shift_right - Key to scroll a menu which has text beyond the right edge to + Key to scroll a menu which has text beyond the right edge to the right. Implemented for perm_invent only by curses and X11. Default `}'. - monpolycontrol - Prompt for new form whenever any monster changes shape (default - off). Debug mode only. - mouse_support - Allow use of the mouse for input and travel. Valid settings - are: - - 0 - disabled - 1 - enabled and make OS adjustments to support mouse use - 2 - like 1 but does not make any OS adjustments - - Omitting a value is the same as specifying 1 and negating - mouse_support is the same as specifying 0. - - msghistory - The number of top line messages to keep (and be able to recall - with `^P') (default 20). Cannot be set with the `O' command. - - msg_window - Allows you to change the way recalled messages are displayed. - Currently it is only supported for tty (all four choices) and - for curses (`f' and `r' choices, default `r'). The possible - values are: - - 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; - r - full window reversed, newest message first. - - For backward compatibility, no value needs to be specified - (which defaults to "full"), or it can be negated (which - defaults to "single"). - - - - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -4360,12 +4360,46 @@ + monpolycontrol + Prompt for new form whenever any monster changes shape (default + off). Debug mode only. + + mouse_support + Allow use of the mouse for input and travel. Valid settings + are: + + 0 - disabled + 1 - enabled and make OS adjustments to support mouse use + 2 - like 1 but does not make any OS adjustments + + Omitting a value is the same as specifying 1 and negating + mouse_support is the same as specifying 0. + + msghistory + The number of top line messages to keep (and be able to recall + with `^P') (default 20). Cannot be set with the `O' command. + + msg_window + Allows you to change the way recalled messages are displayed. + Currently it is only supported for tty (all four choices) and + for curses (`f' and `r' choices, default `r'). The possible + values are: + + 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; + r - full window reversed, newest message first. + + For backward compatibility, no value needs to be specified + (which defaults to "full"), or it can be negated (which + defaults to "single"). + name - Set your character's name (defaults to your user name). You - can also set your character's role by appending a dash and one + 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 -P -Ra -Ro -S -T -V -W). If -@ is used for the - role, then a random one will be automatically chosen. Cannot + -C -H -K -M -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' command. news @@ -4379,44 +4413,10 @@ null Send padding nulls to the terminal (default on). Persistent. - number_pad - Use digit keys instead of letters to move (default 0 or off). - Valid settings are: - - 0 - move by letters; "yuhjklbn" - 1 - move by numbers; digit `5' acts as `G' movement prefix - 2 - like 1 but `5' works as `g' prefix instead of as `G' - 3 - by numbers using phone key layout; 123 above, 789 below - 4 - combines 3 with 2; phone layout plus MS-DOS compatibility - -1 - by letters but use `z' to go northwest, `y' to zap wands - - For backward compatibility, omitting a value is the same as - specifying 1 and negating number_pad is the same as specifying - 0. (Settings 2 and 4 are for compatibility with MS-DOS or old - PC Hack; in addition to the different behavior for `5', `Alt-5' - acts as `G' and `Alt-0' acts as `I'. Setting -1 is to accommo- - date some QWERTZ keyboards which have the location of the `y' - and `z' keys swapped.) When moving by numbers, to enter a - count prefix for those commands which accept one (such as "12s" - to search twelve times), precede it with the letter `n' - ("n12s"). - - packorder - Specify the order to list object types in (default - "")[%?+!=/(*`0_"). The value of this option should be a string - containing the symbols for the various object types. Any omit- - ted types are filled in at the end from the previous order. - - paranoid_confirmation - A space separated list of specific situations where alternate - prompting is desired. The default is paranoid_confirma- - tion:pray. - - Confirm - for any prompts which are set to require "yes" - rather than `y', also require "no" to reject - NetHack 3.7 January 11, 2022 + + NetHack 3.7 January 16, 2022 @@ -4426,45 +4426,92 @@ - instead of accepting any non-yes response as no + number_pad + Use digit keys instead of letters to move (default 0 or off). + Valid settings are: + + 0 - move by letters; "yuhjklbn" + 1 - move by numbers; digit `5' acts as `G' movement prefix + 2 - like 1 but `5' works as `g' prefix instead of as `G' + 3 - by numbers using phone key layout; 123 above, 789 below + 4 - combines 3 with 2; phone layout plus MS-DOS compatibility + -1 - by letters but use `z' to go northwest, `y' to zap wands + + For backward compatibility, omitting a value is the same as + specifying 1 and negating number_pad is the same as specifying + 0. (Settings 2 and 4 are for compatibility with MS-DOS or old + PC Hack; in addition to the different behavior for `5', `Alt-5' + acts as `G' and `Alt-0' acts as `I'. Setting -1 is to accommo- + date some QWERTZ keyboards which have the location of the `y' + and `z' keys swapped.) When moving by numbers, to enter a + count prefix for those commands which accept one (such as "12s" + to search twelve times), precede it with the letter `n' + ("n12s"). + + packorder + Specify the order to list object types in (default + "")[%?+!=/(*`0_"). The value of this option should be a string + containing the symbols for the various object types. Any omit- + ted types are filled in at the end from the previous order. + + paranoid_confirmation + A space separated list of specific situations where alternate + prompting is desired. The default is paranoid_confirma- + tion:pray. + + Confirm - for any prompts which are set to require "yes" + rather than `y', also require "no" to reject in- + stead of accepting any non-yes response as no quit - require "yes" rather than `y' to confirm quitting - the game or switching into non-scoring explore + the game or switching into non-scoring explore mode; - die - require "yes" rather than `y' to confirm dying - (not useful in normal play; applies to explore + die - require "yes" rather than `y' to confirm dying + (not useful in normal play; applies to explore mode); - bones - require "yes" rather than `y' to confirm saving + bones - require "yes" rather than `y' to confirm saving bones data when dying in debug mode; - attack - require "yes" rather than `y' to confirm attack- + attack - require "yes" rather than `y' to confirm attack- ing a peaceful monster; wand-break - require "yes" rather than `y' to confirm breaking a wand; - eating - require "yes" rather than `y' to confirm whether + eating - require "yes" rather than `y' to confirm whether to continue eating; Were-change - require "yes" rather than `y' to confirm changing - form due to lycanthropy when hero has polymorph + form due to lycanthropy when hero has polymorph control; - pray - require `y' to confirm an attempt to pray rather + pray - require `y' to confirm an attempt to pray rather + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 69 + + + than immediately praying; on by default; - Remove - require selection from inventory for `R' and `T' - commands even when wearing just one applicable + Remove - require selection from inventory for `R' and `T' + commands even when wearing just one applicable item. all - turn on all of the above. - By default, the pray choice is enabled, the others disabled. - To disable it without setting any of the other choices, use + By default, the pray choice is enabled, the others disabled. + To disable it without setting any of the other choices, use "paranoid_confirmation:none". To keep it enabled while setting - any of the others, include it in the list, such as "para- + any of the others, include it in the list, such as "para- noid_confirmation:attack pray Remove". perm_invent - If true, always display your current inventory in a window. - This only makes sense for windowing system interfaces that im- + If true, always display your current inventory in a window. + This only makes sense for windowing system interfaces that im- plement this feature. petattr - Specifies one or more text highlighting attributes to use when - showing pets on the map. Effectively a superset of the + Specifies one or more text highlighting attributes to use when + showing pets on the map. Effectively a superset of the hilite_pet boolean option. Curses interface only; value is one or more of the following letters. @@ -4478,77 +4525,30 @@ l - Left line indicator r - Right line indicator - Some of those choices might not work, particularly the final - three, depending upon terminal hardware or terminal emulation - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 69 - - - + Some of those choices might not work, particularly the final + three, depending upon terminal hardware or terminal emulation software. - Currently multiple highlight-style letters can be combined by - simply stringing them together (for example, "bk"), but in the - future they might require being separated by plus signs (such - as "b+k", which works already). When using the `n' choice, it - should be specified on its own, not in combination with any of + Currently multiple highlight-style letters can be combined by + simply stringing them together (for example, "bk"), but in the + future they might require being separated by plus signs (such + as "b+k", which works already). When using the `n' choice, it + should be specified on its own, not in combination with any of the other letters. pettype - Specify the type of your initial pet, if you are playing a - character class that uses multiple types of pets; or choose to - have no initial pet at all. Possible values are "cat", "dog", + Specify the type of your initial pet, if you are playing a + character class that uses multiple types of pets; or choose to + have no initial pet at all. Possible values are "cat", "dog", "horse", and "none". If the choice is not allowed for the role - you are currently playing, it will be silently ignored. For - example, "horse" will only be honored when playing a knight. + you are currently playing, it will be silently ignored. For + example, "horse" will only be honored when playing a knight. Cannot be set with the `O' command. - pickup_burden - When you pick up an item that would exceed this encumbrance - level (Unencumbered, Burdened, streSsed, straiNed, overTaxed, - or overLoaded), you will be asked if you want to continue. - (Default `S'). Persistent. - - pickup_thrown - If this option is on and autopickup is also on, try to pick up - things that you threw, even if they aren't in pickup_types or - match an autopickup exception. Default is on. Persistent. - - pickup_types - Specify the object types to be picked up when autopickup is on. - Default is all types. Persistent. - - The value is a list of object symbols, such as pickup_types:$?! - to pick up gold, scrolls, and potions. You can use autopick- - up_exception configuration file lines to further refine au- - topickup behavior. - - There is no way to set pickup_types to "none". (Setting it to - an empty value reverts to "all".) If you want to avoid auto- - matically picking up any types of items but do want to have au- - topickup on in order to have autopickup_exception settings con- - trol what you do and don't pick up, you can set pickup_types to - `.'. That is the type symbol for venom and you won't come - across any venom items so won't unintentionally pick such up. - - pile_limit - When walking across a pile of objects on the floor, threshold - at which the message "there are few/several/many objects here" - is given instead of showing a popup list of those objects. A - value of 0 means "no limit" (always list the objects); a value - of 1 effectively means "never show the objects" since the pile - size will always be at least that big; default value is 5. - Persistent. - NetHack 3.7 January 11, 2022 + + NetHack 3.7 January 16, 2022 @@ -4558,63 +4558,63 @@ + pickup_burden + When you pick up an item that would exceed this encumbrance + level (Unencumbered, Burdened, streSsed, straiNed, overTaxed, + or overLoaded), you will be asked if you want to continue. + (Default `S'). Persistent. + + pickup_thrown + If this option is on and autopickup is also on, try to pick up + things that you threw, even if they aren't in pickup_types or + match an autopickup exception. Default is on. Persistent. + + pickup_types + Specify the object types to be picked up when autopickup is on. + Default is all types. Persistent. + + The value is a list of object symbols, such as pickup_types:$?! + to pick up gold, scrolls, and potions. You can use autopick- + up_exception configuration file lines to further refine au- + topickup behavior. + + There is no way to set pickup_types to "none". (Setting it to + an empty value reverts to "all".) If you want to avoid auto- + matically picking up any types of items but do want to have au- + topickup on in order to have autopickup_exception settings con- + trol what you do and don't pick up, you can set pickup_types to + `.'. That is the type symbol for venom and you won't come + across any venom items so won't unintentionally pick such up. + + pile_limit + When walking across a pile of objects on the floor, threshold + at which the message "there are few/several/many objects here" + is given instead of showing a popup list of those objects. A + value of 0 means "no limit" (always list the objects); a value + of 1 effectively means "never show the objects" since the pile + size will always be at least that big; default value is 5. + Persistent. + playmode - Values are "normal", "explore", or "debug". Allows selection - of explore mode (also known as discovery mode) or debug mode + Values are "normal", "explore", or "debug". Allows selection + of explore mode (also known as discovery mode) or debug mode (also known as wizard mode) instead of normal play. Debug mode - might only be allowed for someone logged in under a particular - user name (on multi-user systems) or specifying a particular + might only be allowed for someone logged in under a particular + user name (on multi-user systems) or specifying a particular character name (on single-user systems) or it might be disabled - entirely. Requesting it when not allowed or not possible re- + entirely. Requesting it when not allowed or not possible re- sults in explore mode instead. Default is normal play. pushweapon - Using the `w' (wield) command when already wielding something - pushes the old item into your alternate weapon slot (default - off). Likewise for the `a' (apply) command if it causes the + Using the `w' (wield) command when already wielding something + pushes the old item into your alternate weapon slot (default + off). Likewise for the `a' (apply) command if it causes the applied item to become wielded. Persistent. - quick_farsight - When set, usually prevents the "you sense your surroundings" - message where play pauses to allow you to browse the map when- - ever clairvoyance randomly activates. Some situations, such as - being underwater or engulfed, ignore this option. It does not - affect the clairvoyance spell where pausing to examine revealed - objects or monsters is less intrusive. Default is off. Per- - sistent. - - race - Selects your race (for example, "race:human"). Default is ran- - dom. If you prefix the value with `!' or "no", you will ex- - clude that race from being picked randomly. Cannot be set with - the `O' command. Persistent. - - rest_on_space - Make the space bar a synonym for the `.' (#wait) command (de- - fault off). Persistent. - - role - Pick your type of character (for example "role:Samurai"); syn- - onym for "character". See "name" for an alternate method of - specifying your role. Normally only the first letter of the - value is examined; `r' is an exception with "Rogue", "Ranger", - and "random" values. If you prefix the value with `!' or "no", - you will exclude that role from being picked randomly. Cannot - be set with the `O' command. Persistent. - - roguesymset - This option may be used to select one of the named symbol sets - found within "symbols" to alter the symbols displayed on the - screen on the rogue level. - - rlecomp - When writing out a save file, perform run length compression of - the map. Not all ports support run length compression. It has - no effect on reading an existing save file. - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -4624,10 +4624,48 @@ + quick_farsight + When set, usually prevents the "you sense your surroundings" + message where play pauses to allow you to browse the map when- + ever clairvoyance randomly activates. Some situations, such as + being underwater or engulfed, ignore this option. It does not + affect the clairvoyance spell where pausing to examine revealed + objects or monsters is less intrusive. Default is off. Per- + sistent. + + race + Selects your race (for example, "race:human"). Default is ran- + dom. If you prefix the value with `!' or "no", you will ex- + clude that race from being picked randomly. Cannot be set with + the `O' command. Persistent. + + rest_on_space + Make the space bar a synonym for the `.' (#wait) command (de- + fault off). Persistent. + + role + Pick your type of character (for example "role:Samurai"); syn- + onym for "character". See "name" for an alternate method of + specifying your role. Normally only the first letter of the + value is examined; `r' is an exception with "Rogue", "Ranger", + and "random" values. If you prefix the value with `!' or "no", + you will exclude that role from being picked randomly. Cannot + be set with the `O' command. Persistent. + + roguesymset + This option may be used to select one of the named symbol sets + found within "symbols" to alter the symbols displayed on the + screen on the rogue level. + + rlecomp + When writing out a save file, perform run length compression of + 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 - control+direction and so forth, or via the travel command or + Controls the amount of screen updating for the map window when + engaged in multi-turn movement (running via shift+direction or + control+direction and so forth, or via the travel command or mouse click). The possible values are: teleport - update the map after movement has finished; @@ -4636,17 +4674,28 @@ crawl - like walk, but pause briefly after each step. This option only affects the game's screen display, not the ac- - tual results of moving. The default is "run"; versions prior - to 3.4.1 used "teleport" only. Whether or not the effect is + tual 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. Persistent. + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 72 + + + safe_pet - Prevent you from (knowingly) attacking your pets (default on). + Prevent you from (knowingly) attacking your pets (default on). Persistent. safe_wait - Prevents you from waiting or searching when next to a hostile + Prevents you from waiting or searching when next to a hostile monster (default on). Persistent. sanity_check @@ -4654,8 +4703,8 @@ 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 + 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. @@ -4664,9 +4713,9 @@ off). Persistent. showrace - Display yourself as the glyph for your race, rather than the - glyph for your role (default off). Note that this setting af- - fects only the appearance of the display, not the way the game + Display yourself as the glyph for your race, rather than the + glyph for your role (default off). Note that this setting af- + fects only the appearance of the display, not the way the game treats you. Persistent. showscore @@ -4678,75 +4727,26 @@ sortdiscoveries Controls the sorting behavior for the output of the `\' and ``' - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 72 - - - commands. Persistent. 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 + 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 + 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 #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 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 (de- - fault on). Persistent. - - sparkle - Display a sparkly effect when a monster (including yourself) is - hit by an attack to which it is resistant (default on). Per- - sistent. - - standout - Boldface monsters and "--More--" (default off). Persistent. - - statushilites - Controls how many turns status hilite behaviors highlight the - field. If negated or set to zero, disables status hiliting. - See "Configuring Status Hilites" for further information. - - status_updates - 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 versions (for example "suppress_alert:3.3.1"). - - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -4756,49 +4756,98 @@ + sortloot + 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 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 (de- + fault on). Persistent. + + sparkle + Display a sparkly effect when a monster (including yourself) is + hit by an attack to which it is resistant (default on). Per- + sistent. + + standout + Boldface monsters and "--More--" (default off). Persistent. + + statushilites + Controls how many turns status hilite behaviors highlight the + field. If negated or set to zero, disables status hiliting. + See "Configuring Status Hilites" for further information. + + status_updates + 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 versions (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 "symset:default" to explicitly select the default + 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 "symset:default" to explicitly select the default symbols. time - Show the elapsed game time in turns on bottom line (default + Show the elapsed game time in turns on bottom line (default off). Persistent. timed_delay - When pausing momentarily for display effect, such as with ex- - plosions and moving objects, use a timer rather than sending - extra characters to the screen. (Applies to "tty" interface + When pausing momentarily for display effect, such as with ex- + plosions and moving objects, use a timer rather than sending + extra characters to the screen. (Applies to "tty" interface only; "X11" interface always uses a timer based delay. The de- fault is on if configured into the program.) Persistent. + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 74 + + + tombstone Draw a tombstone graphic upon your death (default on). Persis- tent. toptenwin Put the ending display in a NetHack window instead of on stdout - (default off). Setting this option makes the score list visi- - ble when a windowing version of NetHack is started without a - parent window, but it no longer leaves the score list around + (default off). Setting this option makes the score list visi- + ble when a windowing version of NetHack is started without a + parent window, but it no longer leaves the score list around after game end on a terminal or emulating window. travel Allow the travel command via mouse click (default on). Turning this option off will prevent the game from attempting unintend- - ed moves if you make inadvertent mouse clicks on the map win- - dow. Does not affect traveling via the `_' ("#travel") com- + ed moves if you make inadvertent mouse clicks on the map win- + dow. Does not affect traveling via the `_' ("#travel") com- mand. Persistent. verbose - Provide more commentary during the game (default on). Persis- + Provide more commentary during the game (default on). Persis- tent. whatis_coord - When using the `/' or `;' commands to look around on the map - with autodescribe on, display coordinates after the descrip- - tion. Also works in other situations where you are asked to + When using the `/' or `;' commands to look around on the map + with autodescribe on, display coordinates after the descrip- + tion. Also works in other situations where you are asked to pick a location. The possible settings are: @@ -4810,75 +4859,26 @@ n - none (no coordinates shown) [default]. The whatis_coord option is also used with the "/m", "/M", "/o", - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 74 - - - and "/O" sub-commands of `/', where the "none" setting is over- ridden 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 possi- + through next and previous targets, allows filtering the possi- ble targets. n - no filtering [default] v - in view only a - in same area only - The area-filter tries to be slightly predictive--if you're + The area-filter tries to be slightly predictive--if you're standing on a doorway, it will consider the area on the side of the door you were last moving towards. - Filtering can also be changed when getting a location with the - "getpos.filter" key. - - 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 de- - pends 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 op- - tions. 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. - - - - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -4888,63 +4888,63 @@ + Filtering can also be changed when getting a location with the + "getpos.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 de- + pends 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 op- + tions. 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 + 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 adjust- - ing to suit your preferences, it will attempt to do so. If it - can't it will silently ignore it. You can find out if an option - is supported by the window port that you are currently using by + 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 adjust- + ing to suit your preferences, it will attempt to do so. If it + can't it will silently ignore it. You can find out if an option + is supported by the window port that you are currently using by checking to see if it shows up in the Options list. Some options - are dynamic and can be specified during the game with the `O' + 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, + Where to align or place the message window (top, bottom, left, or right) - align_status - Where to align or place the status window (top, bottom, left, - or right). - - ascii_map - If NetHack can, it should display the map using simple charac- - ters (letters and punctuation) rather than tiles graphics. In - some cases, characters can be augmented with line-drawing sym- - bols; use the symset option to select a symbol set such as - DECgraphics or IBMgraphics if your display supports them. Set- - ting ascii_map to True forces tiled_map to be False. - - color - If NetHack can, it should display color if it can for different - monsters, objects, and dungeon features (default on). - - eight_bit_tty - If NetHack can, it should pass eight-bit character values (for - example, specified with the traps option) straight through to - your terminal (default off). - - font_map - if NetHack can, it should use a font by the chosen name for the - map window. - - font_menu - If NetHack can, it should use a font by the chosen name for - menu windows. - - font_message - If NetHack can, it should use a font by the chosen name for the - message window. - - font_status - If NetHack can, it should use a font by the chosen name for the - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -4954,63 +4954,63 @@ + align_status + Where to align or place the status window (top, bottom, left, + or right). + + ascii_map + If NetHack can, it should display the map using simple charac- + ters (letters and punctuation) rather than tiles graphics. In + some cases, characters can be augmented with line-drawing sym- + bols; use the symset option to select a symbol set such as + DECgraphics or IBMgraphics if your display supports them. Set- + ting ascii_map to True forces tiled_map to be False. + + color + If NetHack can, it should display color if it can for different + monsters, objects, and dungeon features (default on). + + eight_bit_tty + If NetHack can, it should pass eight-bit character values (for + example, specified with the traps option) straight through to + your terminal (default off). + + font_map + if NetHack can, it should use a font by the chosen name for the + map window. + + font_menu + If NetHack can, it should use a font by the chosen name for + menu windows. + + font_message + If NetHack can, it should use a font by the chosen name for the + message window. + + font_status + If NetHack can, it should use a font by the chosen name for the status window. font_text - If NetHack can, it should use a font by the chosen name for + If NetHack can, it should use a font by the chosen name for text windows. font_size_map - If NetHack can, it should use this size font for the map win- + If NetHack can, it should use this size font for the map win- dow. font_size_menu If NetHack can, it should use this size font for menu windows. font_size_message - If NetHack can, it should use this size font for the message + If NetHack can, it should use this size font for the message window. font_size_status - If NetHack can, it should use this size font for the status - window. - - font_size_text - If NetHack can, it should use this size font for text windows. - - fullscreen - If NetHack can, it should try and display on the entire screen - rather than in a window. - - guicolor - Use color text and/or highlighting attributes when displaying - some non-map data (such as menu selector letters). Curses in- - terface only; default is on. - - large_font - If NetHack can, it should use a large font. - - map_mode - If NetHack can, it should display the map in the manner speci- - fied. - - player_selection - 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 exam- - ple, in the protected mode MS-DOS version, control whether - tiles get pre-loaded into RAM at the start of the game. Doing - so enhances performance of the tile graphics, but uses more - memory. (default on). Cannot be set with the `O' command. + If NetHack can, it should use this size font for the status - - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -5020,63 +5020,63 @@ + window. + + font_size_text + If NetHack can, it should use this size font for text windows. + + fullscreen + If NetHack can, it should try and display on the entire screen + rather than in a window. + + guicolor + Use color text and/or highlighting attributes when displaying + some non-map data (such as menu selector letters). Curses in- + terface only; default is on. + + large_font + If NetHack can, it should use a large font. + + map_mode + If NetHack can, it should display the map in the manner speci- + fied. + + player_selection + 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 exam- + ple, in the protected mode MS-DOS version, control whether + tiles get pre-loaded into RAM at the start of the game. Doing + so enhances performance of the tile graphics, but uses more + memory. (default on). Cannot be set with the `O' command. + scroll_amount - If NetHack can, it should scroll the display by this number of + If NetHack can, it should scroll the display by this number of cells when the hero reaches the scroll_margin. scroll_margin - If NetHack can, it should scroll the display when the hero or - cursor is this number of cells away from the edge of the win- + If NetHack can, it should scroll the display when the hero or + cursor is this number of cells away from the edge of the win- dow. selectsaved - If NetHack can, it should display a menu of existing saved + If NetHack can, it should display a menu of existing saved games for the player to choose from at game startup, if it can. Not all ports support this option. softkeyboard - Display an onscreen keyboard. Handhelds are most likely to + Display an onscreen keyboard. Handhelds are most likely to support this option. - splash_screen - If NetHack can, it should display an opening splash screen when - it starts up (default yes). - - statuslines - Number of lines for traditional below-the-map status display. - Acceptable values are 2 and 3 (default is 2). - - 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' com- - mand. - - 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 ren- - ders 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. - - 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 spec- - ified 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. - NetHack 3.7 January 11, 2022 + + NetHack 3.7 January 16, 2022 @@ -5086,63 +5086,63 @@ + splash_screen + If NetHack can, it should display an opening splash screen when + it starts up (default yes). + + statuslines + Number of lines for traditional below-the-map status display. + Acceptable values are 2 and 3 (default is 2). + + 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' com- + mand. + + 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 ren- + ders 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. + + 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 spec- + ified 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. + tile_height - Specify the preferred height of each tile in a tile capable + Specify the preferred height of each tile in a tile capable port. tile_width Specify the preferred width of each tile in a tile capable port tiled_map - If NetHack can, it should display the map using tiles graphics - rather than simple characters (letters and punctuation, possi- - bly augmented by line-drawing symbols). Setting tiled_map to + If NetHack can, it should display the map using tiles graphics + rather than simple characters (letters and punctuation, possi- + bly augmented by line-drawing symbols). Setting tiled_map to True forces ascii_map to be False. use_darkgray Use bold black instead of blue for black glyphs (TTY only). - use_inverse - If NetHack can, it should display inverse when the game speci- - fies it. - - vary_msgcount - 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 in- - terface 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 - columns of the display. A width of at least 110 columns - (80+2+26+2) is needed to show borders if align_status is set to - left or right.) - - The persistent inventory window, when enabled, can grow until - it is too big to fit on most displays, resulting in truncation - of its contents. If borders are forced on (1) or the display - is big enough to show them (2), setting the value to 3 or 4 in- - stead will keep borders for the map, message, and status win- - dows but have room for two additional lines of inventory plus - widen each inventory line by two columns. - - windowcolors - If NetHack can, it should display windows with the specified - foreground/background colors. Windows GUI only. The format is - - OPTION=windowcolors:wintype foreground/background - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -5152,63 +5152,63 @@ - where wintype is one of "menu", "message", "status", or - "text", and foreground and background are colors, either a hexa- - decimal \'#rrggbb', one of the named colors (black, red, green, - brown, blue, magenta, cyan, orange, brightgreen, yellow, bright- - blue, brightmagenta, brightcyan, white, trueblack, gray, purple, - silver, maroon, fuchsia, lime, olive, navy, teal, aqua), or one - of Windows UI colors (activeborder, activecaption, appworkspace, - background, btnface, btnshadow, btntext, captiontext, graytext, - greytext, highlight, highlighttext, inactiveborder, inactivecap- - tion, menu, menutext, scrollbar, window, windowframe, window- + use_inverse + If NetHack can, it should display inverse when the game speci- + fies it. + + vary_msgcount + 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 in- + terface 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 + columns of the display. A width of at least 110 columns + (80+2+26+2) is needed to show borders if align_status is set to + left or right.) + + The persistent inventory window, when enabled, can grow until + it is too big to fit on most displays, resulting in truncation + of its contents. If borders are forced on (1) or the display + is big enough to show them (2), setting the value to 3 or 4 in- + stead will keep borders for the map, message, and status win- + dows but have room for two additional lines of inventory plus + widen each inventory line by two columns. + + windowcolors + If NetHack can, it should display windows with the specified + foreground/background colors. Windows GUI only. The format is + + OPTION=windowcolors:wintype foreground/background + + where wintype is one of "menu", "message", "status", or + "text", and foreground and background are colors, either a hexa- + decimal \'#rrggbb', one of the named colors (black, red, green, + brown, blue, magenta, cyan, orange, brightgreen, yellow, bright- + blue, brightmagenta, brightcyan, white, trueblack, gray, purple, + silver, maroon, fuchsia, lime, olive, navy, teal, aqua), or one + of Windows UI colors (activeborder, activecaption, appworkspace, + background, btnface, btnshadow, btntext, captiontext, graytext, + greytext, highlight, highlighttext, inactiveborder, inactivecap- + tion, menu, menutext, scrollbar, window, windowframe, window- text). wraptext If NetHack can, it should wrap long lines of text if they don't fit in the visible area of the window. - 9.6. Platform-specific Customization options - - Here are explanations of options that are used by specific - platforms 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 Amiga, this option controls whether typing "Alt" plus anoth- - er key functions as a meta-shift for that key (default on). - - altmeta - On other (non-Amiga) 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 sec- - ond ESC to finish cancelling such a count. At other prompts a - single ESC suffices. - - BIOS - Use BIOS calls to update the screen display quickly and to read - the keyboard (allowing the use of arrow keys to move) on ma- - chines with an IBM PC compatible BIOS ROM (default off, OS/2, - PC, and ST NetHack only). - - flush - (default off, Amiga NetHack only). - - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -5218,6 +5218,44 @@ + 9.6. Platform-specific Customization options + + Here are explanations of options that are used by specific + platforms 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 Amiga, this option controls whether typing "Alt" plus anoth- + er key functions as a meta-shift for that key (default on). + + altmeta + On other (non-Amiga) 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 sec- + ond ESC to finish cancelling such a count. At other prompts a + single ESC suffices. + + BIOS + Use BIOS calls to update the screen display quickly and to read + the keyboard (allowing the use of arrow keys to move) on ma- + chines with an IBM PC compatible BIOS ROM (default off, OS/2, + PC, and ST NetHack only). + + flush + (default off, Amiga NetHack only). + MACgraphics (default on, Mac NetHack only). @@ -5225,56 +5263,18 @@ (default on, Mac NetHack only). rawio - Force raw (non-cbreak) mode for faster output and more bullet- - proof 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 + Force raw (non-cbreak) mode for faster output and more bullet- + proof 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 + (Win32 tty NetHack only). May be used to alter the value of keystrokes that the operating system returns to NetHack to help - compensate for international keyboard issues. OPTIONS=subkey- - value:171/92 will return 92 to NetHack, if 171 was originally - going to be returned. You can use multiple subkeyvalue assign- - ments in the configuration file if needed. Cannot be set with - the `O' command. - - video - Set the video mode used (PC NetHack only). Values are "autode- - tect", "default", "vga", or "vesa". Setting "vesa" will cause - the game to display tiles, using the full capability of the VGA - hardware. Setting "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 (de- - fault dark normal light, PC NetHack only). If the game display - is difficult to read, try adjusting these scales; if this does - not correct the problem, try !color. Cannot be set with the - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -5284,15 +5284,53 @@ + compensate for international keyboard issues. OPTIONS=subkey- + value:171/92 will return 92 to NetHack, if 171 was originally + going to be returned. You can use multiple subkeyvalue assign- + ments in the configuration file if needed. Cannot be set with + the `O' command. + + video + Set the video mode used (PC NetHack only). Values are "autode- + tect", "default", "vga", or "vesa". Setting "vesa" will cause + the game to display tiles, using the full capability of the VGA + hardware. Setting "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 (de- + fault dark normal light, PC NetHack only). If the game display + is difficult to read, try adjusting these scales; if this does + not correct the problem, try !color. Cannot be set with the `O' command. 9.7. Regular Expressions - Regular expressions are normally POSIX extended regular ex- - pressions. It is possible to compile NetHack without regular ex- - pression support on a platform where there is no regular expres- - sion library. While this is not true of any modern platform, if - your NetHack was built this way, patterns are instead glob pat- + Regular expressions are normally POSIX extended regular ex- + pressions. It is possible to compile NetHack without regular ex- + pression support on a platform where there is no regular expres- + sion library. While this is not true of any modern platform, if + your NetHack was built this way, patterns are instead glob pat- terns. This applies to Autopickup exceptions, Message types, Menu colors, and User sounds. @@ -5301,46 +5339,8 @@ 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 autopick- - up_exception option should be followed by a regular expression - to be used as 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 oc- - cur 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_ex- - ception 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 ex- - clusion of items known to be cursed from autopickup. - - - - - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -5350,12 +5350,48 @@ + 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 autopick- + up_exception option should be followed by a regular expression + to be used as 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 oc- + cur 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_ex- + ception 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 ex- + clusion of items known to be cursed from autopickup. + 9.9. Changing Key Bindings - It is possible to change the default key bindings of some - special commands, menu accelerator keys, and extended commands, - by using BIND stanzas in the configuration file. Format is key, - followed by the command to bind to, separated by a colon. The + It is possible to change the default key bindings of some + special commands, menu accelerator keys, and extended commands, + by using BIND stanzas in the configuration file. Format is key, + followed by the command to bind to, separated by a colon. The key can be a single character ("x"), a control key ("^X", "C-x"), a meta key ("M-x"), or a three-digit decimal ASCII code. @@ -5366,47 +5402,11 @@ BIND=v:loot Extended command keys - You can bind multiple keys to the same extended command. Un- - bind 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 ob- - ject symbols or selection letters into menu accelerators. Some - interfaces only support some of the menu accelerators. - - 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 "context", 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'. - - fight - Prefix key to force fight a direction. Default is `F'. - - fight.numpad - Prefix key to force fight a direction. With number_pad only. - Default is `-'. - - getdir.help - When asked for a direction, the key to show the help. Default - is `?'. - - getdir.self - When asked for a direction, the key to target yourself. De- - fault is `.'. + You can bind multiple keys to the same extended command. Un- + bind a key by using "nothing" as the extended command to bind - - - NetHack 3.7 January 11, 2022 + NetHack 3.7 January 16, 2022 @@ -5416,6 +5416,34 @@ + 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 ob- + ject symbols or selection letters into menu accelerators. Some + interfaces only support some of the menu accelerators. + + 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 "context", 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.self + When asked for a direction, the key to target yourself. De- + fault is `.'. + getdir.self2 When asked for a direction, the key to target yourself. De- fault is `s'. @@ -5442,6 +5470,18 @@ getpos.help When asked for a location, the key to show help. Default is + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 84 + + + `?'. getpos.mon.next @@ -5470,18 +5510,6 @@ or meta-digit keys to fast-move around, move by skipping the same glyphs instead of by 8 units. Default is `*'. - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 84 - - - getpos.filter When asked for a location, change the filtering mode when using one of the next or previous keys to cycle through targets. @@ -5509,6 +5537,17 @@ When asked for a location, the key to go to your location. De- fault is `@'. + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 85 + + + getpos.unexplored.next When asked for a location, the key to go to next closest unex- plored location. Default is `x'. @@ -5529,57 +5568,9 @@ When asked for a location, the key to go to previous closest valid location. Default is `Z'. - nopickup - Prefix key to move without picking up items. Default is `m'. - - redraw - Key to redraw the screen. Default is `^R'. - - - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 85 - - - - redraw.numpad - Key to redraw the screen. With number_pad only. Default is - `^L'. - repeat Key to repeat previous command. Default is `^A'. - reqmenu - Prefix key to request menu from some commands. Default is `m'. - - run - Prefix key to run towards a direction. Default is `G'. - - run.nopickup - Prefix key to run towards a direction without picking up items - on the way. Default is `M'. - - run.numpad - Prefix key to run towards a direction. With number_pad only. - - Default is `5' when number_pad is set to 1 or 3, otherwise - `M-5' when it is set to 2 or 4. - - rush - Prefix key to rush towards a direction. Default is `g'. - - rush.numpad - Prefix key to rush towards a direction. With number_pad only. - - Default is `M-5' when number_pad is set to 1 or 3, otherwise - `5' when it is set to 2 or 4. - 9.10. Configuring Message Types You can change the way the messages are shown in the message @@ -5601,19 +5592,6 @@ norep - show the message once, but not again if no other mes- sage is shown in between. - - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 86 - - - Here's an example of message types using NetHack's internal pattern matching facility: @@ -5624,6 +5602,18 @@ the user is prompted with more-prompt, and a message matching "You displaced ." is not shown at all. + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 86 + + + The order of the defined MSGTYPE lines is important; the last matching rule is used. Put the general case first, exceptions below them. @@ -5668,18 +5658,6 @@ MENUCOLOR="* cursed *(being worn)"=red&underline specifies that any menu line with " blessed " contained in it - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 87 - - - 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 under- @@ -5690,6 +5668,18 @@ Note that if you intend to have one or more color specifica- tions match " uncursed ", you will probably want to turn the im- plicit_uncursed option off so that all items known to be uncursed + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 87 + + + are actually displayed with the "uncursed" description. 9.12. Configuring User Sounds @@ -5734,18 +5724,6 @@ For example, the following line in your configuration file will cause the hitpoints field to display in the color red if - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 88 - - - your hitpoints drop to or below a threshold of 30%: OPTION=hilite_status:hitpoints/<=30%/red/normal @@ -5757,6 +5735,17 @@ tion file will cause wisdom to be displayed red if it drops and green if it rises: + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 88 + + + OPTION=hilite_status:wisdom/down/red/up/green Allowed colors are black, red, green, brown, blue, magenta, @@ -5801,17 +5790,6 @@ polymorphed. "experience", "time", and "score" are condition- ally displayed depending upon your other option settings. - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 89 - - - Instead of a behavior, "condition" takes the following condi- tion flags: stone, slime, strngl, foodpois, termill, blind, deaf, stun, conf, hallu, lev, fly, and ride. You can use "ma- @@ -5822,6 +5800,18 @@ Allowed behaviors are "always", "up", "down", "changed", a per- centage or absolute number threshold, or text to match against. + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 89 + + + * "always" will set the default attributes for that field. * "up", "down" set the field attributes for when the field @@ -5865,19 +5855,6 @@ is below or above. If the prefix is `<' or `>', only match when strictly above or below. - - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 90 - - - * text match sets the attribute when the field value matches the text. Text matches can only be used for "alignment", "carrying-capacity", "hunger", "dungeon-level", and "ti- @@ -5890,6 +5867,17 @@ The whole feature can be disabled by setting option sta- tushilites to 0. + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 90 + + + Example hilites: OPTION=hilite_status: gold/up/yellow/down/brown @@ -5931,19 +5919,6 @@ ----------------------------------------------------------------- S_air (air) _ S_altar (altar) - - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 91 - - - " S_amulet (amulet) A S_angel (angelic being) a S_ant (ant or other insect) @@ -5956,6 +5931,19 @@ B S_bat (bat or bird) ^ S_bear_trap (bear trap) - S_blcorn (bottom left corner) + + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 91 + + + b S_blob (blob) + S_book (spellbook) ) S_boomleft (boomerang open left) @@ -5997,19 +5985,6 @@ f S_feline (cat or other feline) ^ S_fire_trap (fire trap) ! S_flashbeam (flash beam) - - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 92 - - - % S_food (piece of food) { S_fountain (fountain) F S_fungus (fungus or mold) @@ -6022,6 +5997,19 @@ g S_gremlin (gremlin) - S_hbeam (horizontal beam [zap animation]) # S_hcdbridge (horizontal raised drawbridge) + + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 92 + + + + S_hcdoor (closed door in horizontal wall) . S_hodbridge (horizontal lowered drawbridge) | S_hodoor (open door in horizontal wall) @@ -6063,19 +6051,6 @@ ! S_potion (potion) P S_pudding (pudding or ooze) q S_quadruped (quadruped) - - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 93 - - - Q S_quantmech (quantum mechanic) = S_ring (ring) ` S_rock (boulder or statue) @@ -6088,6 +6063,19 @@ ? S_scroll (scroll) # S_sink (sink) ^ S_sleeping_gas_trap (sleeping gas trap) + + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 93 + + + S S_snake (snake) s S_spider (arachnid or centipede) ^ S_spiked_pit (spiked pit) @@ -6129,19 +6117,6 @@ | S_vbeam (vertical beam [zap animation]) # S_vcdbridge (vertical raised drawbridge) + S_vcdoor (closed door in vertical wall) - - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 94 - - - . S_venom (splash of venom) ^ S_vibrating_square (vibrating square) . S_vodbridge (vertical lowered drawbridge) @@ -6154,6 +6129,19 @@ " S_web (web) w S_worm (worm) ~ S_worm_tail (long worm tail) + + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 94 + + + W S_wraith (wraith) x S_xan (xan or other extraordinary insect) X S_xorn (xorn) @@ -6196,18 +6184,6 @@ These co-ordinates are often useful in giving players a better sense of the overall location of items on the screen. - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 95 - - - 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 @@ -6220,6 +6196,18 @@ While it is not difficult for experienced users to edit the defaults.nh file to accomplish this, novices may find this task + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 95 + + + somewhat daunting. Included within the "symbols" file of all of- ficial distributions of NetHack is a symset called NHAccess. Se- lecting that symset in your configuration file will cause the @@ -6261,19 +6249,6 @@ Give feedback messages when walking towards a wall or when travel command was interrupted. - - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 96 - - - whatis_coord:compass When targeting with cursor, describe the cursor position with coordinates relative to your character. @@ -6287,6 +6262,18 @@ When targeting with cursor and using fast-move, skip the same glyphs instead of moving 8 units at a time. + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 96 + + + nostatus_updates Prevent updates to the status lines at the bottom of the screen, if your screen-reader reads those lines. The same in- @@ -6328,18 +6315,6 @@ 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 - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 97 - - - the first format exist. Valid choices are "historical" for bi- nary writing of entire structs, "lendian" for binary writing of each field in little-endian order, "ascii" for writing the @@ -6354,6 +6329,17 @@ SEDUCE = 0 or 1 to disable or enable, respectively, the SEDUCE option. When disabled, incubi and succubi behave like nymphs. + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 97 + + + CHECK_PLNAME = Setting this to 1 will make the EXPLORERS, WIZ- ARDS, and SHELLERS check for the player name instead of the us- er's login name. @@ -6394,18 +6380,6 @@ %% - literal `%' %v - version (eg. "3.6.3-0") - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 98 - - - %u - game UID %t - game start time, UNIX timestamp format %T - current time, UNIX timestamp format @@ -6420,6 +6394,18 @@ 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 + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 98 + + + 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. @@ -6460,18 +6446,6 @@ Debug mode, also known as wizard mode, is undocumented aside from this brief description and the various "debug mode only" - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 99 - - - commands listed among the command descriptions. It is intended for tracking down problems within the program rather than to pro- vide god-like powers to your character, and players who attempt @@ -6487,6 +6461,17 @@ allowed or not available will result in falling back to explore mode instead. + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 99 + + + 12. Credits The original hack game was modeled on the Berkeley UNIX @@ -6526,18 +6511,6 @@ 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 - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 100 - - - source code to Usenet where they remained available in various archives accessible via ftp and uucp after expiring from the newsgroup. @@ -6553,6 +6526,18 @@ of them and Kevin Darcy later joined the main NetHack Development Team to produce subsequent revisions of 3.0. + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 100 + + + 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 @@ -6592,18 +6577,6 @@ 3.1 for the Macintosh, porting it for MPW. Building on their de- velopment, Bart House added a Think C port. - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 101 - - - Timo Hakulinen ported NetHack 3.1 to OS/2. Eric Smith port- ed NetHack 3.1 to the Atari. Pat Rankin, with help from Joshua Delahunty, was responsible for the VMS version of NetHack 3.1. @@ -6619,6 +6592,18 @@ mor and so forth, not separate images for beetles and ants or for cloaks and boots). + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 101 + + + 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 ob- @@ -6658,18 +6643,6 @@ 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. - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 102 - - - Larry Stewart-Zerba and Warwick Allison improved the spell cast- ing system with the Wizard Patch. Warwick Allison also ported NetHack to use the Qt interface. @@ -6685,6 +6658,18 @@ released as a source code patch only, without any ready-to-play distribution for systems that usually had such. + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 102 + + + (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- @@ -6724,18 +6709,6 @@ As with version 3.3, various people contributed to the game as a whole as well as supporting ports on the different platforms - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 103 - - - that NetHack runs on: Pat Rankin maintained 3.4 for VMS. @@ -6752,6 +6725,17 @@ face for the Windows port. Alex Kompel also contributed a Win- dows CE port for 3.4.1. + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 103 + + + 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 @@ -6790,18 +6774,6 @@ In January 2015, preparation began for the release of NetHack 3.6. - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 104 - - - 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, @@ -6818,6 +6790,18 @@ 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 + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 104 + + + restructured. The NetHack Development Team, as well as Steve VanDevender @@ -6856,18 +6840,6 @@ team participant for decades, joined the NetHack Development Team in late May 2019. - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 105 - - - NetHack 3.6.3 was released on December 5, 2019 containing over 190 bug fixes to NetHack 3.6.2. @@ -6884,6 +6856,18 @@ https://www.nethack.org/. + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 105 + + + 12.1. Special Thanks On behalf of the NetHack community, thank you very much once @@ -6921,19 +6905,6 @@ Bruce Mewborne Keizo Yamamoto Rob Menke Carl Schelin Keith Simpson Robin Bandy Chris Russo Ken Arnold Robin Johnson - - - - NetHack 3.7 January 11, 2022 - - - - - - NetHack Guidebook 106 - - - David Cohrs Ken Arromdee Roderick Schertler David Damerell Ken Lorber Roland McGrath David Gentzel Ken Washikita Ron Van Iwaarden @@ -6950,6 +6921,19 @@ Eric S. Raymond Mark Modrall Steve Linhart Erik Andersen Marvin Bressler Steve VanDevender Fredrik Ljungdahl Matthew Day Teemu Suikki + + + + NetHack 3.7 January 16, 2022 + + + + + + NetHack Guidebook 106 + + + Frederick Roeber Merlyn LeRoy Tim Lennan Gil Neiger Michael Allison Timo Hakulinen Greg Laskin Michael Feir Tom Almy @@ -6990,7 +6974,23 @@ - NetHack 3.7 January 11, 2022 + + + + + + + + + + + + + + + + + NetHack 3.7 January 16, 2022