From: PatR Date: Mon, 30 Nov 2015 21:49:43 +0000 (-0800) Subject: Guidebook: #annotate, #overview X-Git-Tag: NetHack-3.6.0_RC01~1 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=9b751e7d1ca80ddc30935fd366dc2c32c1164ad1;p=nethack Guidebook: #annotate, #overview Another issue from old beta-tester mail: #annotate and #overview were missing from the list of extended commands. M-A and M-O were listed but marked "(if supported)" even though they've become unconditional. Same for M-R, although in its case #ride wasn't missing. --- diff --git a/doc/Guidebook.mn b/doc/Guidebook.mn index 1f95641b5..29b83d34e 100644 --- a/doc/Guidebook.mn +++ b/doc/Guidebook.mn @@ -1,4 +1,4 @@ -.\" $NHDT-Branch: master $:$NHDT-Revision: 1.186 $ $NHDT-Date: 1448917136 2015/11/30 20:58:56 $ +.\" $NHDT-Branch: master $:$NHDT-Revision: 1.187 $ $NHDT-Date: 1448920179 2015/11/30 21:49:39 $ .ds h0 "NetHack Guidebook .ds h1 .ds h2 % @@ -846,6 +846,10 @@ or that it will appear in a particular location when inventory listings are displayed. ``#adjust'' can also be used to split a stack of objects; when choosing the item to adjust, enter a count prior to its letter. +.lp #annotate +Allows you to specify one line of text to associate with the current +dungeon level. All levels with annotations are displayed by the +``#overview'' command. .lp #chat Talk to someone. .lp #conduct @@ -874,6 +878,13 @@ Offer a sacrifice to the gods. .lp "" You'll need to find an altar to have any chance at success. Corpses of recently killed monsters are the fodder of choice. +.lp #overview +Display information you've discovered about the dungeon. Any visited +level (unless forgotten due to amnesia) with an annotation is included, +and many things (altars, thrones, fountains, and so on; extra stairs +leading to another dungeon branch) trigger an automatic annotation. +If dungeon overview is chosen during end-of-game disclosure, every visited +level will be included regardless of annotations. .lp #pray Pray to the gods for help. .lp "" @@ -894,7 +905,7 @@ response of 'y' acknowledges that intent. You can set the .op paranoid_confirmation option to require a response of "yes" instead. .lp #ride -Ride (or stop riding) a monster. +Ride (or stop riding) a saddled creature. .lp "#rub " Rub a lamp or a stone. .lp "#sit " @@ -943,7 +954,7 @@ option to have nethack combine them into meta+key. .lp M-a #adjust .lp M-A -#annotate (if supported) +#annotate .lp M-c #chat .lp M-C @@ -967,7 +978,7 @@ option to have nethack combine them into meta+key. .lp M-o #offer .lp M-O -#overview (if supported) +#overview .lp M-p #pray .lp M-q @@ -975,7 +986,7 @@ option to have nethack combine them into meta+key. .lp M-r #rub .lp M-R -#ride (if supported) +#ride .lp M-s #sit .lp M-t diff --git a/doc/Guidebook.tex b/doc/Guidebook.tex index 8b60f18d4..94d4dd4bc 100644 --- a/doc/Guidebook.tex +++ b/doc/Guidebook.tex @@ -1023,6 +1023,11 @@ are displayed. ``{\tt \#adjust}'' can also be used to split a stack of objects; when choosing the item to adjust, enter a count prior to its letter. %.lp +\item[\tb{\#annotate}] +Allows you to specify one line of text to associate with the current +dungeon level. All levels with annotations are displayed by the +``{\tt \#overview}'' command. +%.lp \item[\tb{\#chat}] Talk to someone. %.lp @@ -1062,6 +1067,14 @@ Offer a sacrifice to the gods.\\ You'll need to find an altar to have any chance at success. Corpses of recently killed monsters are the fodder of choice. %.lp +\item[\tb{\#overview}] +Display information you've discovered about the dungeon. Any visited +level (unless forgotten due to amnesia) with an annotation is included, +and many things (altars, thrones, fountains, and so on; extra stairs +leading to another dungeon branch) trigger an automatic annotation. +If dungeon overview is chosen during end-of-game disclosure, every visited +level will be included regardless of annotations. +%.lp \item[\tb{\#pray}] Pray to the gods for help.\\ %.lp "" @@ -1084,7 +1097,7 @@ response of `{\tt y}' acknowledges that intent. You can set the option to require a response of ``{\tt yes}'' instead. %.lp \item[\tb{\#ride}] -Ride (or stop riding) a monster. +Ride (or stop riding) a saddled creature. %.lp \item[\tb{\#rub}] Rub a lamp or a stone. @@ -1146,7 +1159,7 @@ option to have nethack combine them into meta\+key. {\tt\#adjust} %.lp \item[\tb{M-A}] -{\tt\#annotate} (if supported) +{\tt\#annotate} %.lp \item[\tb{M-c}] {\tt\#chat} @@ -1182,7 +1195,7 @@ option to have nethack combine them into meta\+key. {\tt\#offer} %.lp \item[\tb{M-O}] -{\tt\#overview} (if supported) +{\tt\#overview} %.lp \item[\tb{M-p}] {\tt\#pray} @@ -1194,7 +1207,7 @@ option to have nethack combine them into meta\+key. {\tt\#rub} %.lp \item[\tb{M-R}] -{\tt\#ride} (if supported) +{\tt\#ride} %.lp \item[\tb{M-s}] {\tt\#sit} diff --git a/doc/Guidebook.txt b/doc/Guidebook.txt index 8651dd65a..1be4abc86 100644 --- a/doc/Guidebook.txt +++ b/doc/Guidebook.txt @@ -1013,6 +1013,11 @@ choosing the item to adjust, enter a count prior to its let- ter. + #annotate + Allows you to specify one line of text to associate with the + current dungeon level. All levels with annotations are dis- + played by the ``#overview'' command. + #chat Talk to someone. @@ -1044,11 +1049,6 @@ Use a monster's special ability (when polymorphed into mon- ster form). - #name - Name a monster, an individual object, or a type of object. - Same as `C'. - - NetHack 3.6 June 22, 2015 @@ -1060,6 +1060,10 @@ + #name + Name a monster, an individual object, or a type of object. + Same as `C'. + #offer Offer a sacrifice to the gods. @@ -1067,6 +1071,15 @@ Corpses of recently killed monsters are the fodder of choice. + #overview + Display information you've discovered about the dungeon. + Any visited level (unless forgotten due to amnesia) with an + annotation is included, and many things (altars, thrones, + fountains, and so on; extra stairs leading to another dun- + geon branch) trigger an automatic annotation. If dungeon + overview is chosen during end-of-game disclosure, every vis- + ited level will be included regardless of annotations. + #pray Pray to the gods for help. @@ -1089,7 +1102,7 @@ quire a response of "yes" instead. #ride - Ride (or stop riding) a monster. + Ride (or stop riding) a saddled creature. #rub Rub a lamp or a stone. @@ -1101,30 +1114,29 @@ Show bare map without displaying monsters, objects, or traps. - #tip - Tip over a container (bag or box) to pour out its contents. - - #turn - Turn undead. - #twoweapon - Toggle two-weapon combat on or off. - Note that you must use suitable weapons for this type of - combat, or it will be automatically turned off. + NetHack 3.6 June 22, 2015 - NetHack 3.6 June 22, 2015 + NetHack Guidebook 18 + #tip + Tip over a container (bag or box) to pour out its contents. - NetHack Guidebook 18 + #turn + Turn undead. + #twoweapon + Toggle two-weapon combat on or off. + Note that you must use suitable weapons for this type of + combat, or it will be automatically turned off. #untrap Untrap something (trap, door, or chest). @@ -1158,7 +1170,7 @@ M-a #adjust - M-A #annotate (if supported) + M-A #annotate M-c #chat @@ -1168,33 +1180,33 @@ M-e #enhance - M-f #force - M-i #invoke - M-j #jump + NetHack 3.6 June 22, 2015 - M-l #loot - M-m #monster - M-n #name + NetHack Guidebook 19 - NetHack 3.6 June 22, 2015 + M-f #force + M-i #invoke + M-j #jump - NetHack Guidebook 19 + M-l #loot + M-m #monster + M-n #name M-o #offer - M-O #overview (if supported) + M-O #overview M-p #pray @@ -1202,7 +1214,7 @@ M-r #rub - M-R #ride (if supported) + M-R #ride M-s #sit @@ -1234,29 +1246,28 @@ Same as ``#name'' (or ``M-n'') which is the same as the `C' command. - u Untrap a trap, door, or chest. Same as ``#untrap'' or ``M- - u''. - 5. Rooms and corridors - - Rooms and corridors in the dungeon are either lit or dark. - Any lit areas within your line of sight will be displayed; dark - areas are only displayed if they are within one space of you. - Walls and corridors remain on the map as you explore them. + NetHack 3.6 June 22, 2015 - NetHack 3.6 June 22, 2015 + NetHack Guidebook 20 + u Untrap a trap, door, or chest. Same as ``#untrap'' or ``M- + u''. - NetHack Guidebook 20 + 5. Rooms and corridors + Rooms and corridors in the dungeon are either lit or dark. + Any lit areas within your line of sight will be displayed; dark + areas are only displayed if they are within one space of you. + Walls and corridors remain on the map as you explore them. Secret corridors are hidden. You can find them with the `s' (search) command. @@ -1302,17 +1313,6 @@ tional rules of Sokoban. Some allowances are permitted in case the player gets stuck; however, they will lower your luck. - 5.3. Stairs (`<', `>') - - In general, each level in the dungeon will have a staircase - going up (`<') to the previous level and another going down (`>') - to the next level. There are some exceptions though. For in- - stance, fairly early in the dungeon you will find a level with - two down staircases, one continuing into the dungeon and the oth- - er branching into an area known as the Gnomish Mines. Those - mines eventually hit a dead end, so after exploring them (if you - choose to do so), you'll need to climb back up to the main - NetHack 3.6 June 22, 2015 @@ -1324,7 +1324,17 @@ - dungeon. + 5.3. Stairs (`<', `>') + + In general, each level in the dungeon will have a staircase + going up (`<') to the previous level and another going down (`>') + to the next level. There are some exceptions though. For in- + stance, fairly early in the dungeon you will find a level with + two down staircases, one continuing into the dungeon and the oth- + er branching into an area known as the Gnomish Mines. Those + mines eventually hit a dead end, so after exploring them (if you + choose to do so), you'll need to climb back up to the main dun- + geon. 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- @@ -1368,16 +1378,6 @@ 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 sometimes 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 NetHack 3.6 June 22, 2015 @@ -1390,6 +1390,16 @@ + 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 sometimes 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.) @@ -1435,16 +1445,6 @@ 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 - monsters such as a shopkeeper or the Oracle of Delphi can produce - useful results. - - - - - NetHack 3.6 June 22, 2015 @@ -1456,6 +1456,12 @@ + 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 + monsters 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 @@ -1504,12 +1510,6 @@ 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- - 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 NetHack 3.6 June 22, 2015 @@ -1522,11 +1522,17 @@ - order to forge the alliance. Once you do have the beast under - your control however, you can easily climb in and out of the sad- - dle 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. + 6.3. Steeds + + 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- + 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 + 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 section on Weapon proficiency for more information about that. @@ -1571,12 +1577,6 @@ `Overloaded' are displayed on the bottom line display to indicate your condition. - When you pick up an object, it is assigned an inventory let- - ter. Many commands that operate on objects must ask you to find - out which object you want to use. When NetHack asks you to - choose a particular object you are carrying, you are usually pre- - sented with a list of inventory letters to choose from (see - NetHack 3.6 June 22, 2015 @@ -1588,7 +1588,12 @@ - Commands, above). + When you pick up an object, it is assigned an inventory let- + ter. Many commands that operate on objects must ask you to find + out which object you want to use. When NetHack asks you to + choose a particular object you are carrying, you are usually pre- + sented with a list of inventory letters to choose from (see Com- + mands, above). Some objects, such as weapons, are easily differentiated. Others, like scrolls and potions, are given descriptions which @@ -1637,11 +1642,6 @@ An item with unknown status will be reported in your inven- tory with no prefix. An item which you know the state of will be distinguished in your inventory by the presence of the word - ``cursed'', ``uncursed'' or ``blessed'' in the description of the - item. In some cases ``uncursed'' will be omitted as being redun- - dant when enough other information is displayed. The implic- - it_uncursed option can be used to control this; toggle it off to - have ``uncursed'' be displayed even when that can be deduced from NetHack 3.6 June 22, 2015 @@ -1654,6 +1654,11 @@ + ``cursed'', ``uncursed'' or ``blessed'' in the description of the + item. In some cases ``uncursed'' will be omitted as being redun- + dant when enough other information is displayed. The implic- + it_uncursed option can be used to control this; toggle it off to + have ``uncursed'' be displayed even when that can be deduced from other attributes. 7.2. Weapons (`)') @@ -1702,11 +1707,6 @@ curs a penalty in the chance to hit your target compared to using just one weapon at a time. - There might be times when you'd rather not wield any weapon - at all. To accomplish that, wield `-', or else use the `A' com- - mand which allows you to unwield the current weapon in addition - to taking off other worn items. - @@ -1720,6 +1720,11 @@ + There might be times when you'd rather not wield any weapon + at all. To accomplish that, wield `-', or else use the `A' com- + mand which allows you to unwield the current weapon in addition + to taking off other worn items. + Those of you in the audience who are AD&D players, be aware that each weapon which existed in AD&D does roughly the same dam- age to monsters in NetHack. Some of the more obscure weapons @@ -1768,12 +1773,7 @@ would have been shot (``4f'' in this example), you'll just end up shooting the same number (3, here) as if no limit had been speci- fied. Once the volley is in motion, all of the items will travel - in the same direction; if the first ones kill a monster, the oth- - ers can still continue beyond that spot. - - - - + in the same direction; if the first ones kill a monster, the NetHack 3.6 June 22, 2015 @@ -1786,6 +1786,8 @@ + others can still continue beyond that spot. + 7.2.2. Weapon proficiency You will have varying degrees of skill in the weapons avail- @@ -1838,8 +1840,6 @@ (Note that your two weapons are not fully equal; the one in the hand you normally wield with is considered primary and the other one is considered secondary. The most noticeable difference is - after you stop--or before you begin, for that matter--wielding - two weapons at once. The primary is your wielded weapon and the NetHack 3.6 June 22, 2015 @@ -1852,6 +1852,8 @@ + after you stop--or before you begin, for that matter--wielding + two weapons at once. The primary is your wielded weapon and the secondary is just an item in your inventory that's been designat- ed as alternate weapon.) @@ -1903,8 +1905,6 @@ studded leather armor 7 ring mail 7 orcish ring mail 8 - leather armor 8 - leather jacket 9 @@ -1918,6 +1918,8 @@ + leather armor 8 + leather jacket 9 no armor 10 You can also wear other pieces of armor (ex. helmets, boots, @@ -1970,8 +1972,6 @@ Scrolls are labeled with various titles, probably chosen by ancient wizards for their amusement value (ex. ``READ ME,'' or - ``THANX MAUD'' backwards). Scrolls disappear after you read them - (except for blank ones, without magic spells on them). NetHack 3.6 June 22, 2015 @@ -1984,6 +1984,9 @@ + ``THANX MAUD'' backwards). Scrolls disappear after you read them + (except for blank ones, without magic spells on them). + One of the most useful of these is the scroll of identify, which can be used to determine what another object is, whether it is cursed or blessed, and how many uses it has left. Some ob- @@ -2035,9 +2038,6 @@ 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 - the wand is recharged. - - NetHack 3.6 June 22, 2015 @@ -2050,6 +2050,8 @@ + the wand is recharged. + In a truly desperate situation, when your back is up against the wall, you might decide to go for broke and break your wand. This is not for the faint of heart. Doing so will almost cer- @@ -2101,9 +2103,7 @@ Over time, however, your memory of each spell will dim, and you will need to relearn it. - Some spells are directional--you must give a direction in - which to cast them. You can also cast them at yourself (just - give a `.' or `s' for the direction). Be warned, however, for + NetHack 3.6 June 22, 2015 @@ -2116,6 +2116,9 @@ + Some spells are directional--you must give a direction in + which to cast them. You can also cast them at yourself (just + give a `.' or `s' for the direction). Be warned, however, for this is often unwise. Other spells are nondirectional--they don't require a direction. @@ -2164,11 +2167,8 @@ you unlock or open them. You can check for and try to deactivate traps with the ``#untrap'' extended command. - 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. + @@ -2182,6 +2182,12 @@ + 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. + Only one amulet may be worn at a time, around your neck. The commands to use amulets are the same as for rings, `P' @@ -2230,12 +2236,6 @@ is unusual for players to adhere to challenges the first time they win the game. - Several of the challenges are related to eating behavior. - 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 - drinking beverages, even if they provide some minor food bene- - fits. Calling upon your god for help with starvation does not NetHack 3.6 June 22, 2015 @@ -2248,6 +2248,12 @@ + Several of the challenges are related to eating behavior. + 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 + 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. A strict vegan diet is one which avoids any food derived @@ -2295,13 +2301,7 @@ An atheist is one who rejects religion. This means that you cannot #pray, #offer sacrifices to any god, #turn undead, or #chat with a priest. Particularly selective readers may argue - that playing Monk or Priest characters should violate this con- - duct; that is a choice left to the player. Offering the Amulet - 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 - figure; a true atheist would hear the words but attach no special - meaning to them. + that playing Monk or Priest characters should violate this NetHack 3.6 June 22, 2015 @@ -2314,6 +2314,13 @@ + conduct; that is a choice left to the player. Offering the + Amulet of Yendor to your god is necessary to win the game and is + not counted against this conduct. You are also not penalized for + being spoken to by an angry god, priest(ess), or other religious + figure; a true atheist would hear the words but attach no special + meaning to them. + Most players fight with a wielded weapon (or tool intended to be wielded as a weapon). Another challenge is to win the game without using such a wielded weapon. You are still permitted to @@ -2359,15 +2366,8 @@ 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, - the `O' command allows you to view all options and change most of - them. You can also set options automatically by placing them in - the NETHACKOPTIONS environment variable or in a configuration - file. Some versions of NetHack also have front-end programs that - allow you to set options before starting the game or a global - configuration for system administrators. + NetHack 3.6 June 22, 2015 @@ -2380,6 +2380,16 @@ + 9.1. Setting the options + + 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 + the NETHACKOPTIONS environment variable or in a configuration + file. Some versions of NetHack also have front-end programs that + allow you to set options before starting the game or a global + configuration for system administrators. + 9.2. Using the NETHACKOPTIONS environment variable The NETHACKOPTIONS variable is a comma-separated list of @@ -2424,27 +2434,26 @@ The default name of the configuration file varies on differ- ent operating systems, but NETHACKOPTIONS can also be set to the - full name of a file you want to use (possibly preceded by an - `@'). - 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. + NetHack 3.6 June 22, 2015 - NetHack 3.6 June 22, 2015 + NetHack Guidebook 38 - NetHack Guidebook 38 + full name of a file you want to use (possibly preceded by an + `@'). + 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- @@ -2491,15 +2500,6 @@ Start the character permanently blind. Persistent. (default false) - bones - Allow saving and loading bones files. Persistent. (default - true) - - boulder - Set the character used to display boulders (default is rock - class symbol). - - NetHack 3.6 June 22, 2015 @@ -2512,6 +2512,14 @@ + bones + Allow saving and loading bones files. Persistent. (default + true) + + boulder + Set the character used to display boulders (default is rock + class symbol). + catname Name your starting cat (ex. ``catname:Morris''). Cannot be set with the `O' command. @@ -2556,16 +2564,8 @@ sponse of `n' for each candidate). Persistent. The possibili- ties are: - i - disclose your inventory; - a - disclose your attributes; - v - summarize monsters that have been vanquished; - g - list monster species that have been genocided; - c - display your conduct; - o - display dungeon overview. - Each disclosure possibility can optionally be preceded by a - prefix which lets you refine how it behaves. Here are the - valid prefixes: + NetHack 3.6 June 22, 2015 @@ -2578,6 +2578,17 @@ + i - disclose your inventory; + a - disclose your attributes; + v - summarize monsters that have been vanquished; + g - list monster species that have been genocided; + c - display your conduct; + o - display dungeon overview. + + 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; n - prompt you and default to no on the prompt; + - disclose it without prompting; @@ -2620,18 +2631,7 @@ the remaining inventory letters. Persistent. fruit - Name a fruit after something you enjoy eating (ex. ``fruit:man- - go'') (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 gender using the ``male'' and ``female'' options, the - ``gender'' option will take precedence. The default is to + Name a fruit after something you enjoy eating (ex. NetHack 3.6 June 22, 2015 @@ -2644,7 +2644,18 @@ - randomly pick an appropriate gender. If you prefix a `!' or + ``fruit:mango'') (default ``slime mold''). Basically a nostal- + gic 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 gender using the ``male'' and ``female'' options, the + ``gender'' option will take precedence. The default is to ran- + domly pick an appropriate gender. If you prefix a `!' or ``no'' to the value, you can exclude that gender from being picked randomly. Cannot be set with the `O' command. Persis- tent. @@ -2686,17 +2697,6 @@ 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 - Use the old `a', `b', and `c' keyboard shortcuts when looting, - rather than the mnemonics `o', `i', and `b' (default off). - Persistent. - - mail - Enable mail delivery during the game (default on). Persistent. @@ -2710,6 +2710,18 @@ + lit_corridor + Show corridor squares seen by night vision or a light source + held by your character as lit (default off). Persistent. + + lootabc + Use the old `a', `b', and `c' keyboard shortcuts when looting, + 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. @@ -2752,29 +2764,29 @@ menu_headings 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 - Menu character accelerator to invert all items in a menu. Im- - plemented by the Amiga, Gem, X11 and tty ports. Default '@'. - menu_invert_page - Menu character accelerator to invert all items on this page of - a menu. Implemented by the Amiga, Gem and tty ports. Default - '~'. + NetHack 3.6 June 22, 2015 - NetHack 3.6 June 22, 2015 + NetHack Guidebook 43 - NetHack Guidebook 43 + are 'none', 'bold', 'dim', 'underline', 'blink', or 'inverse'. + Not all ports can actually display all types. + menu_invert_all + Menu character accelerator to invert all items in a menu. Im- + plemented by the Amiga, Gem, X11 and tty ports. Default '@'. + menu_invert_page + Menu character accelerator to invert all items on this page of + a menu. Implemented by the Amiga, Gem and tty ports. Default + '~'. menu_last_page Menu character accelerator to jump to the last page in a menu. @@ -2819,18 +2831,6 @@ 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 de- - faults 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 - 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 - be set with the `O' command. - NetHack 3.6 June 22, 2015 @@ -2842,6 +2842,18 @@ + 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 + 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 + be set with the `O' command. + news Read the NetHack news file, if present (default on). Since the news is shown at the beginning of the game, there's no point in @@ -2884,18 +2896,6 @@ 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 instead of ac- - cepting any non-yes response as no - quit - require "yes" rather than 'y' to confirm quitting the - game or switching into non-scoring explore mode; - die - require "yes" rather than 'y' to confirm dying (not - useful in normal play; applies to explore mode); - bones - require "yes" rather than 'y' to confirm saving bones - data when dying in debug mode; NetHack 3.6 June 22, 2015 @@ -2908,6 +2908,18 @@ + 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 instead of ac- + cepting any non-yes response as no + quit - require "yes" rather than 'y' to confirm quitting the + game or switching into non-scoring explore mode; + die - require "yes" rather than 'y' to confirm dying (not + useful in normal play; applies to explore mode); + bones - require "yes" rather than 'y' to confirm saving bones + data when dying in debug mode; attack - require "yes" rather than 'y' to confirm attacking a peaceful monster; pray - require 'y' to confirm an attempt to pray rather than @@ -2950,6 +2962,18 @@ pickup_types Specify the object types to be picked up when autopickup is on. + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 46 + + + Default is all types. You can use autopickup_exception config- uration file lines to further refine autopickup behavior. Per- sistent. @@ -2963,17 +2987,6 @@ size will always be at least that big; default value is 5. Persistent. - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 46 - - - playmode Values are `normal', `explore', or `debug'. Allows selection of explore mode (also known as discovery mode) or debug mode @@ -3014,6 +3027,19 @@ found within ``symbols'' to alter the symbols displayed on the screen on the rogue level. + + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 47 + + + rlecomp When writing out a save file, perform run length compression of the map. Not all ports support run length compression. It has @@ -3028,18 +3054,6 @@ teleport - update the map after movement has finished; run - update the map after every seven or so steps; walk - update the map after each step; - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 47 - - - crawl - like walk, but pause briefly after each step. This option only affects the game's screen display, not the ac- @@ -3080,6 +3094,18 @@ and #loot commands and some others. Persistent. The possible values are: + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 48 + + + full - always sort the lists; loot - only sort the lists that don't use inventory letters, like with the #loot and pickup commands; @@ -3094,18 +3120,6 @@ hit by an attack to which it is resistant (default on). Per- sistent. - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 48 - - - standout Boldface monsters and ``--More--'' (default off). Persistent. @@ -3145,32 +3159,32 @@ 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 (default on). Turning this option off - will prevent the game from attempting unintended moves if you - make inadvertent mouse clicks on the map window. Persistent. - verbose - Provide more commentary during the game (default on). Persis- - tent. - windowtype - Select which windowing system to use, such as ``tty'' or - ``X11'' (default depends on version). Cannot be set with the - `O' command. + NetHack 3.6 June 22, 2015 - NetHack 3.6 June 22, 2015 + NetHack Guidebook 49 - NetHack Guidebook 49 + travel + Allow the travel command (default on). Turning this option off + will prevent the game from attempting unintended moves if you + make inadvertent mouse clicks on the map window. Persistent. + verbose + Provide more commentary during the game (default on). Persis- + tent. + windowtype + Select which windowing system to use, such as ``tty'' or + ``X11'' (default depends on version). Cannot be set with the + `O' command. zerocomp When writing out a save file, perform zero-comp compression of @@ -3212,6 +3226,18 @@ specified with the traps option) straight through to your ter- minal (default off). + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 50 + + + font_map NetHack should use a font by the chosen name for the map win- dow. @@ -3227,17 +3253,6 @@ NetHack should use a font by the chosen name for the status window. - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 50 - - - font_text NetHack should use a font by the chosen name for text windows. @@ -3276,33 +3291,33 @@ popup_dialog NetHack should pop up dialog boxes for input. - preload_tiles - NetHack should preload tiles into memory. For example, in the - protected mode MSDOS 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. (de- - fault on). Cannot be set with the `O' command. - scroll_amount - NetHack should scroll the display by this number of cells when - the hero reaches the scroll_margin. - scroll_margin - NetHack should scroll the display when the hero or cursor is - this number of cells away from the edge of the window. + NetHack 3.6 June 22, 2015 - NetHack 3.6 June 22, 2015 + NetHack Guidebook 51 - NetHack Guidebook 51 + preload_tiles + NetHack should preload tiles into memory. For example, in the + protected mode MSDOS 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. (de- + fault on). Cannot be set with the `O' command. + scroll_amount + NetHack should scroll the display by this number of cells when + the hero reaches the scroll_margin. + scroll_margin + NetHack should scroll the display when the hero or cursor is + this number of cells away from the edge of the window. selectsaved NetHack should display a menu of existing saved games for the @@ -3342,34 +3357,34 @@ message window. windowcolors - NetHack should display windows with the specified fore- - ground/background colors if it can. + NetHack should display windows with the specified - wraptext - NetHack port should wrap long lines of text if they don't fit - in the visible area of the window. - 9.6. Platform-specific Customization options + NetHack 3.6 June 22, 2015 - Here are explanations of options that are used by specific - platforms or ports to customize and change the port behavior. - altkeyhandler - Select an alternate keystroke handler dll to load (Win32 tty - NetHack only). The name of the handler is specified without - the .dll extension and without any path information. Cannot be - NetHack 3.6 June 22, 2015 + NetHack Guidebook 52 + foreground/background colors if it can. - NetHack Guidebook 52 + wraptext + NetHack port 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. + altkeyhandler + Select an alternate keystroke handler dll to load (Win32 tty + NetHack only). The name of the handler is specified without + the .dll extension and without any path information. Cannot be set with the `O' command. altmeta @@ -3409,6 +3424,18 @@ rawio Force raw (non-cbreak) mode for faster output and more bullet- proof input (MS-DOS sometimes treats `^P' as a printer toggle + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 53 + + + 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. @@ -3424,18 +3451,6 @@ value:171/92 will return 92 to NetHack, if 171 was originally going to be returned. You can use multiple subkeyvalue state- ments in the config file if needed. Cannot be set with the `O' - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 53 - - - command. video @@ -3475,6 +3490,18 @@ By placing autopickup_exception lines in your configuration file, you can define patterns to be checked when the game is + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 54 + + + about to autopickup something. autopickup_exception @@ -3490,18 +3517,6 @@ > - never pickup an object that matches rest of pattern. A `never pickup' rule takes precedence over an `always pickup' - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 54 - - - rule if both match. Exceptions can be set with the `O' command, but ones set that @@ -3541,6 +3556,18 @@ Here's an example of message types using NetHack's internal pattern matching facility: + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 55 + + + MSGTYPE=stop "You feel hungry." MSGTYPE=hide "You displaced *." @@ -3556,18 +3583,6 @@ Some platforms allow you to define colors used in menu lines when the line matches a user-defined pattern. At this time the - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 55 - - - tty, win32tty and win32gui support this. In general, the config file entries to configure the menu @@ -3607,32 +3622,31 @@ worn)" on the same line will be shown in red color and under- lined. You can have multiple MENUCOLOR entries in your config file, and the last MENUCOLOR-line in your config file that - matches a menu line will be used for the line. - Note that if you intend to have one or more color specifica- - tions match " uncursed ", you will probably want to turn the im- - plicit_uncursed option off so that all items known to be uncursed - are actually displayed with the ``uncursed'' description. - 9.11. Configuring User Sounds - - Some platforms allow you to define sound files to be played - when a message that matches a user-defined pattern is delivered - to the message window. At this time the Qt port and the win32tty - and win32gui ports support the use of user sounds. + NetHack 3.6 June 22, 2015 - NetHack 3.6 June 22, 2015 + NetHack Guidebook 56 + matches a menu line will be used for the line. - NetHack Guidebook 56 + Note that if you intend to have one or more color specifica- + tions match " uncursed ", you will probably want to turn the im- + plicit_uncursed option off so that all items known to be uncursed + are actually displayed with the ``uncursed'' description. + 9.11. Configuring User Sounds + Some platforms allow you to define sound files to be played + when a message that matches a user-defined pattern is delivered + to the message window. At this time the Qt port and the win32tty + and win32gui ports support the use of user sounds. The following config file entries are relevant to mapping user sounds to messages: @@ -3673,6 +3687,19 @@ OPTION=hilite_status: wisdom/updown/red/green You can adjust the display of the following status fields: + + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 57 + + + title strength dexterity constitution intelligence wisdom charisma alignment score @@ -3689,17 +3716,6 @@ Allowed attributes are bold, inverse, normal. Note that the platform used may interpret the attributes any way it wants. - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 57 - - - Behaviours can occur based on percentage thresholds, updown, or absolute values. The in-game options menu can help you deter- mine the correct syntax for a config file. @@ -3737,6 +3753,19 @@ _ S_altar (altar) " S_amulet (amulet) A S_angel (angelic being) + + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 58 + + + a S_ant (ant or other insect) ^ S_anti_magic_trap (anti-magic field) [ S_armor (suit or piece of armor) @@ -3753,19 +3782,6 @@ ( S_boomright (boomerang open right) ` S_boulder (boulder) - S_brcorn (bottom right corner) - - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 58 - - - C S_centaur (centaur) _ S_chain (iron chain) # S_cloud (cloud) @@ -3803,6 +3819,19 @@ S_ghost (ghost) H S_giant (giant humanoid) G S_gnome (gnome) + + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 59 + + + ' S_golem (golem) | S_grave (grave) g S_gremlin (gremlin) @@ -3819,19 +3848,6 @@ j S_jelly (jelly) k S_kobold (kobold) K S_kop (Keystone Kop) - - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 59 - - - ^ S_land_mine (land mine) } S_lava (molten lava) l S_leprechaun (leprechaun) @@ -3869,6 +3885,19 @@ ? S_scroll (scroll) # S_sink (sink) ^ S_sleeping_gas_trap (sleeping gas trap) + + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 60 + + + S S_snake (snake) s S_spider (arachnid or centipede) ^ S_spiked_pit (spiked pit) @@ -3885,19 +3914,6 @@ | S_sw_ml (swallow middle left) | S_sw_mr (swallow middle right) - S_sw_tc (swallow top center) - - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 60 - - - / S_sw_tl (swallow top left) `\' S_sw_tr (swallow top right) - S_tdwall (wall) @@ -3935,6 +3951,19 @@ x S_xan (xan or other mythical/fantastic insect) X S_xorn (xorn) Y S_yeti (apelike creature) + + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 61 + + + Z S_zombie (zombie) z S_zruty (zruty) @@ -3951,22 +3980,10 @@ examine this Guidebook before playing so you have an idea what the screen layout is like. You'll also need to be able to locate the PC cursor. It is always where your character is located. - Merely searching for an @-sign will not always find your - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 61 - - - - character since there are other humanoids represented by the same - sign. Your screen-reader should also have a function which gives - you the row and column of your review cursor and the PC cursor. + Merely searching for an @-sign will not always find your charac- + ter since there are other humanoids represented by the same sign. + Your screen-reader should also have a function which gives you + the row and column of your review cursor and the PC cursor. These co-ordinates are often useful in giving players a better sense of the overall location of items on the screen. @@ -4001,6 +4018,18 @@ If NetHack is compiled with the SYSCF option, a system ad- ministrator should set up a global configuration; this is a file in the same format as the traditional per-user configuration file + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 62 + + + (see above). This file should be named sysconf and placed in the same directory as the other NetHack support files. The options recognized in this file are listed below. Any option not set us- @@ -4018,18 +4047,6 @@ EXPLORERS A list of users who are allowed to use the explore mode. The syntax is the same as WIZARDS. - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 62 - - - MAXPLAYERS Limit the maximum number of games that can be run- ning at the same time. @@ -4067,6 +4084,18 @@ each account on the machine can post only one non-winning score on this list. If you score higher than someone else on this list, or better your previous score, you will be inserted in the + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 63 + + + proper place under your current name. How many scores are kept can also be set up when NetHack is compiled. @@ -4085,17 +4114,6 @@ list is, you can type nethack -s all on most versions. - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 63 - - - 11. Explore mode NetHack is an intricate and difficult game. Novices might @@ -4134,6 +4152,16 @@ in falling back to explore mode instead. + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 64 + + + 12. Credits The original hack game was modeled on the Berkeley UNIX @@ -4150,18 +4178,6 @@ Jay Fenlason wrote the original Hack, with help from Kenny Woodland, Mike Thome and Jon Payne. - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 64 - - - Andries Brouwer did a major re-write, transforming Hack into a very different game, and published (at least) three versions (1.0.1, 1.0.2, and 1.0.3) for UNIX machines to the Usenet. @@ -4200,6 +4216,18 @@ and Janet Walz, the development team which now included Ken Ar- romdee, David Cohrs, Jean-Christophe Collet, Kevin Darcy, Matt Day, Timo Hakulinen, Steve Linhart, Dean Luick, Pat Rankin, Eric + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 65 + + + Raymond, and Eric Smith undertook a radical revision of 3.0. They re-structured the game's design, and re-wrote major parts of the code. They added multiple dungeons, a new display, special @@ -4216,18 +4244,6 @@ Jon W{tte and Hao-yang Wang, with help from Ross Brown, Mike Engber, David Hairston, Michael Hamel, Jonathan Handler, Johnny - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 65 - - - Lee, Tim Lennan, Rob Menke, and Andy Swanson, developed NetHack 3.1 for the Macintosh, porting it for MPW. Building on their de- velopment, Barton House added a Think C port. @@ -4266,6 +4282,18 @@ wrote NetHack Plus. Tom Proudfoot later merged NetHack Plus and his own NetHack-- to produce SLASH. Larry Stewart-Zerba and War- wick Allison improved the spell casting system with the Wizard + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 66 + + + Patch. Warwick Allison also ported NetHack to use the Qt inter- face. @@ -4282,18 +4310,6 @@ Arromdee, David Cohrs, Jessie Collet, Steve Creps, Kevin Darcy, Timo Hakulinen, Kevin Hugo, Steve Linhart, Ken Lorber, Dean Luick, Pat Rankin, Eric Smith, Mike Stephenson, Janet Walz, and - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 66 - - - Paul Winner, released 3.3.0 in December 1999 and 3.3.1 in August of 2000. @@ -4331,8 +4347,20 @@ Michael Allison, David Cohrs, Alex Kompel, Dion Nicolaas, and Yitzhak Sapir maintained and enhanced 3.4 for the Microsoft Windows platform. Alex Kompel contributed a new graphical inter- - face for the Windows port. Alex Kompel also contributed a Win- - dows CE port for 3.4.1. + face for the Windows port. Alex Kompel also contributed a + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 67 + + + + Windows CE port for 3.4.1. Ron Van Iwaarden was the sole maintainer of NetHack for OS/2 the past several releases. Unfortunately Ron's last OS/2 machine @@ -4348,18 +4376,6 @@ The release of NetHack 3.4.3 in December 2003 marked the be- ginning of a long release hiatus. 3.4.3 proved to be a remarkably - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 67 - - - stable version that provided continued enjoyment by the community for more than a decade. The devteam slowly and quietly continued to work on the game behind the scenes during the tenure of 3.4.3. @@ -4398,6 +4414,18 @@ Smolkowski ensured that NetHack 3.6.0 continued to operate on various Unix flavors and maintained the X11 interface. + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 68 + + + Ken Lorber, Haoyang Wang, Pat Rankin, and Dean Luick main- tained the port of NetHack 3.6.0 for Mac. @@ -4414,18 +4442,6 @@ thank the generous people primarily responsible for the public NetHack servers available for playing the game at nethack.alt.org and devnull.net. In addition to providing a way for the public to - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 68 - - - play a game of NetHack from almost anywhere, they have hosted an- nual NetHack tournaments for many, many years. @@ -4463,6 +4479,19 @@ Del Lamb Kevin Smolkowski Sascha Wostmann Derek S. Ray Kevin Sweet Scott Bigham Deron Meranda Lars Huttar Scott R. Turner + + + + NetHack 3.6 June 22, 2015 + + + + + + NetHack Guidebook 69 + + + Dion Nicolaas Leon Arnott Sean Hunt Dylan O'Donnell M. Drew Streib Stephen Spackman Eric Backus Malcolm Ryan Stefan Thielscher @@ -4479,19 +4508,6 @@ Helge Hafting Mike Gallop Warwick Allison Irina Rempt-Drijfhout Mike Passaretti Yitzhak Sapir Izchak Miller Mike Stephenson - - - - NetHack 3.6 June 22, 2015 - - - - - - NetHack Guidebook 69 - - - J. Ali Harlow Mikko Juola Brand and product names are trademarks or registered trademarks @@ -4516,22 +4532,6 @@ - - - - - - - - - - - - - - - -