diff --git a/doc/Guidebook.txt b/doc/Guidebook.txt index aed582b7d..82544f9b6 100644 --- a/doc/Guidebook.txt +++ b/doc/Guidebook.txt @@ -803,6 +803,12 @@ in inventory. Precede `e' with the `m' prefix to bypass at- tempting to eat anything off the floor. + If you attempt to eat while already satiated, you might + choke to death. If you risk it, you will be asked whether + to "continue eating?" if you survive the first bite. You + can set the paranoid_confirmation:eating option to require a + response of yes instead of just y. + E Engrave a message on the floor. E- - write in the dust with your fingers. @@ -844,24 +850,25 @@ ing upon it, depending on your user interface). For the non-boolean choices, a further menu or prompt will appear once you've closed this menu. The available options are - listed later in this Guidebook. Options are usually set be- - fore the game rather than with the `O' command; see the sec- - tion on options below. - ^O Show overview. + NetHack 3.6 November 27, 2019 NetHack 3.7 November 17, 2019 - - NetHack Guidebook 14 + listed later in this Guidebook. Options are usually set be- + fore the game rather than with the `O' command; see the sec- + tion on options below. + + ^O Show overview. + Shortcut for "#overview": list interesting dungeon levels visited. @@ -910,24 +917,24 @@ `T' command below. It lists armor as the inventory choices but will accept an accessory and attempt to remove it.) - ^R Redraw the screen. - s Search for secret doors and traps around you. It usually - takes several tries to find something. + NetHack 3.6 November 27, 2019 NetHack 3.7 November 17, 2019 - - - NetHack Guidebook 15 + ^R Redraw the screen. + + s Search for secret doors and traps around you. It usually + takes several tries to find something. + Can also be used to figure out whether there is still a mon- ster at an adjacent "remembered, unseen monster" marker. @@ -976,24 +983,26 @@ ^T Teleport, if you have the ability. - v Display version number. - V Display the game history. - w Wield weapon. + NetHack 3.6 November 27, 2019 NetHack 3.7 November 17, 2019 - - NetHack Guidebook 16 + v Display version number. + + V Display the game history. + + w Wield weapon. + w- - wield nothing, use your bare (or gloved) hands. Some characters can wield two weapons at once; use the `X' @@ -1042,12 +1051,6 @@ Z Zap (cast) a spell. - Z. - to cast at yourself, use `.' for the direction. - - - - __________ - (R)UNIX is a registered trademark of The Open Group. NetHack 3.7 November 17, 2019 @@ -1060,6 +1063,8 @@ + Z. - to cast at yourself, use `.' for the direction. + ^Z Suspend the game (UNIX(R) versions with job control only). : Look at what is here. @@ -1108,24 +1113,29 @@ ` Show discovered types for one class of objects. - ! Escape to a shell. - - # Perform an extended command. + __________ + (R)UNIX is a registered trademark of The Open Group. + NetHack 3.6 November 27, 2019 + NetHack 3.7 November 17, 2019 - - NetHack Guidebook 18 + ! Escape to a shell. + + # Perform an extended command. + + + As you can see, the authors of NetHack used up all the let- ters, so this is a way to introduce the less frequently used com- mands. What extended commands are available depends on what fea- @@ -1174,24 +1184,25 @@ If the tool used acts on items on the floor, using the `m' prefix skips those items. - If used on a wand, that wand will be broken, releasing its - magic in the process. Confirmation is required. - #attributes - Show your attributes. Default key is `^X'. + NetHack 3.6 November 27, 2019 NetHack 3.7 November 17, 2019 - - NetHack Guidebook 19 + If used on a wand, that wand will be broken, releasing its + magic in the process. Confirmation is required. + + #attributes + Show your attributes. Default key is `^X'. + #autopickup Toggle the autopickup option on/off. Default key is `@'. @@ -1240,14 +1251,9 @@ Advance or check weapon and spell skills. Autocompletes. Default key is `M-e'. - #exploremode - Enter the explore mode. - - Requires confirmation; default response is n (no). To real- - ly switch to explore mode, respond with y. You can set the - paranoid_confirmation:quit option to require a response of + NetHack 3.6 November 27, 2019 NetHack 3.7 November 17, 2019 @@ -1258,6 +1264,12 @@ + #exploremode + Enter the explore mode. + + Requires confirmation; default response is n (no). To real- + ly switch to explore mode, respond with y. You can set the + paranoid_confirmation:quit option to require a response of yes instead. #fire @@ -1306,12 +1318,6 @@ Show discovered types for one class of objects. Default key is ``'. - #levelchange - Change your experience level. Autocompletes. Debug mode - only. - - #lightsources - Show mobile light sources. Autocompletes. Debug mode only. NetHack 3.7 November 17, 2019 @@ -1324,6 +1330,13 @@ + #levelchange + Change your experience level. Autocompletes. Debug mode + only. + + #lightsources + Show mobile light sources. Autocompletes. Debug mode only. + #look Look at what is here, under you. Default key is `:'. @@ -1370,14 +1383,7 @@ ited level will be included regardless of annotations. Au- tocompletes. Default keys are `^O', and `M-O'. - #panic - Test the panic routine. Terminates the current game. Auto- - completes. Debug mode only. - Asks for confirmation; default is n (no); continue playing. - To really panic, respond with y. You can set the para- - noid_confirmation:quit option to require a response of yes - instead. NetHack 3.7 November 17, 2019 @@ -1390,6 +1396,15 @@ + #panic + Test the panic routine. Terminates the current game. Auto- + completes. Debug mode only. + + Asks for confirmation; default is n (no); continue playing. + To really panic, respond with y. You can set the para- + noid_confirmation:quit option to require a response of yes + instead. + #pay Pay your shopping bill. Default key is `p'. @@ -1434,16 +1449,7 @@ really quit, respond with y. You can set the paranoid_con- firmation:quit option to require a response of yes instead. - #quiver - Select ammunition for quiver. Default key is `Q'. - #read - Read a scroll, a spellbook, or something else. Default key - is `r'. - - #redraw - Redraw the screen. Default key is `^R', and also `^L' if - number_pad is on. NetHack 3.7 November 17, 2019 @@ -1456,6 +1462,17 @@ + #quiver + Select ammunition for quiver. Default key is `Q'. + + #read + Read a scroll, a spellbook, or something else. Default key + is `r'. + + #redraw + Redraw the screen. Default key is `^R', and also `^L' if + number_pad is on. + #remove Remove an accessory (ring, amulet, etc). Default key is `R'. @@ -1499,6 +1516,19 @@ #seetools Show the tools currently in use. Default key is `('. + + + NetHack 3.6 November 27, 2019 + + + + NetHack 3.7 November 17, 2019 + + + NetHack Guidebook 24 + + + #seetrap Show the type of an adjacent trap. Default key is `^'. @@ -1511,17 +1541,6 @@ #sit Sit down. Autocompletes. Default key is `M-s'. - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 24 - - - #stats Show memory usage statistics. Autocompletes. Debug mode only. @@ -1563,8 +1582,21 @@ Travel to a specific location on the map. Default key is `_'. Using the "request menu" prefix shows a menu of inter- esting targets in sight without asking to move the cursor. - When picking a target with cursor and the autodescribe op- - tion is on, the top line will show "(no travel path)" if + When picking a target with cursor and the autodescribe + + + NetHack 3.6 November 27, 2019 + + + + NetHack 3.7 November 17, 2019 + + + NetHack Guidebook 25 + + + + option is on, the top line will show "(no travel path)" if your character does not know of a path to that location. #turn @@ -1577,17 +1609,6 @@ Note that you must use suitable weapons for this type of combat, or it will be automatically turned off. - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 25 - - - #untrap Untrap something (trap, door, or chest). Default key is `M- u', and `u' if number_pad is on. @@ -1628,6 +1649,19 @@ #wield Wield a weapon. Default key is `w'. + + + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 26 + + + #wipe Wipe off your face. Autocompletes. Default key is `M-w'. @@ -1642,18 +1676,7 @@ #wizgenesis Create a monster. May be prefixed by a count to create more - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 26 - - - than one. Autocompletes. Debug mode only. Default key is `^G'. @@ -1693,6 +1716,19 @@ #zap Zap a wand. Default key is `z'. + + + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 27 + + + #? Help menu: get the list of available extended commands. @@ -1708,18 +1744,7 @@ behavior. On other systems, if typing "Alt" plus another key transmits a two character sequence consisting of an Escape fol- lowed by the other key, you may set the altmeta option to have - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 27 - - - NetHack combine them into meta+key. M-? #? (not supported by all platforms) @@ -1758,6 +1783,20 @@ M-q #quit + + + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 28 + + + NetHack 3.7 November 17, 2019 + M-r #rub M-R #ride @@ -1776,18 +1815,6 @@ - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 28 - - - - - If the number_pad option is on, some additional letter com- mands are available: @@ -1825,6 +1852,18 @@ the lock with the `a' (apply) command, or by kicking it open with the `^D' (kick) command. + + NetHack 3.6 November 27, 2019 + + + + NetHack 3.7 November 17, 2019 + + + NetHack Guidebook 29 + + + Open doors cannot be entered diagonally; you must approach them straight on, horizontally or vertically. Doorways without doors are not restricted in this fashion. @@ -1837,21 +1876,6 @@ (search) command. Once found they are in all ways equivalent to normal doors. - - - - - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 29 - - - 5.2. Traps (`^') There are traps throughout the dungeon to snare the unwary @@ -1894,6 +1918,19 @@ Ordinarily when you climb a set of stairs, you will arrive on the corresponding staircase at your destination. However, + + + NetHack 3.6 November 27, 2019 + + + NetHack 3.7 November 17, 2019 + + + + NetHack Guidebook 30 + + + pets (see below) and some other monsters will follow along if they're close enough when you travel up or down stairs, and occa- sionally one of these creatures will displace you during the @@ -1904,20 +1941,6 @@ types of inter-level connections are nearly indistinguishable during game play. - - - - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 30 - - - 5.4. Shops and shopping Occasionally you will run across a room with a shopkeeper @@ -1961,6 +1984,20 @@ * The price of a given item can vary due to a variety of factors. + + + + NetHack 3.6 November 27, 2019 + + + NetHack 3.7 November 17, 2019 + + + + NetHack Guidebook 31 + + + * A shopkeeper treats the spot immediately inside the door as if it were outside the shop. @@ -1973,17 +2010,6 @@ * Shops do not get restocked with new items, regardless of inven- tory depletion. - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 31 - - - 6. Monsters Monsters you cannot see are not displayed on the screen. @@ -2026,6 +2052,18 @@ 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 + + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 32 + + + `F' command. 6.2. Your pet @@ -2039,17 +2077,7 @@ feed it, too, by throwing it food. A properly trained pet can be very useful under certain circumstances. - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 32 - - - 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 @@ -2091,6 +2119,18 @@ You may encounter the shades and corpses of other adventur- ers (or even former incarnations of yourself!) and their personal + + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 33 + + + 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. @@ -2105,17 +2145,7 @@ more will result in it disappearing from your map, similarly if it is the one who moved rather than you. - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 33 - - - 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 @@ -2156,6 +2186,18 @@ When you pick up an object, it is assigned an inventory let- ter. Many commands that operate on objects must ask you to find + + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 34 + + + 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- @@ -2170,18 +2212,7 @@ When you use one of these objects, if its effect is obvious, NetHack will remember what it is for you. If its effect isn't extremely obvious, you will be asked what you want to call this - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 34 - - - 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 all objects of a particular type or just an individual object. @@ -2222,6 +2253,18 @@ 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 redundant when + + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 35 + + + enough other information is displayed. The implicit_uncursed op- tion can be used to control this; toggle it off to have "un- cursed" be displayed even when that can be deduced from other at- @@ -2236,18 +2279,7 @@ exception; they normally do more damage with bare (or gloved) hands than they do with weapons. - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 35 - - - There are wielded weapons, like maces and swords, and thrown weapons, like arrows and spears. To hit monsters with a weapon, you must wield it and attack them, or throw it at them. You can @@ -2289,6 +2321,18 @@ mand which allows you to unwield the current weapon in addition to taking off other worn items. + + NetHack 3.6 November 27, 2019 + + + + NetHack 3.7 November 17, 2019 + + + NetHack Guidebook 36 + + + 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 @@ -2299,21 +2343,6 @@ `f' (fire, an alternate way of throwing), `Q' (quiver), `x' (ex- change), `X' (twoweapon), and "#enhance" (see below). - - - - - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 36 - - - 7.2.1. Throwing and shooting You can throw just about anything via the `t' command. It @@ -2355,6 +2384,21 @@ in the same direction; if the first ones kill a monster, the oth- ers can still continue beyond that spot. + + + + + NetHack 3.7 November 17, 2019 + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 37 + + + 7.2.2. Weapon proficiency You will have varying degrees of skill in the weapons avail- @@ -2368,18 +2412,6 @@ polearms. Each role has a limit on what level of proficiency a character can achieve for each group. For instance, wizards can become highly skilled in daggers or staves but not in swords or - - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 37 - - - bows. The "#enhance" extended command is used to review current @@ -2421,6 +2453,19 @@ 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.6 November 27, 2019 + + + NetHack 3.7 November 17, 2019 + + + + NetHack Guidebook 38 + + + as alternate weapon.) If your primary weapon is wielded but your off hand is empty @@ -2433,19 +2478,6 @@ first wield the intended secondary, swap it to off hand, and then wield the primary. - - - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 38 - - - The whole process can be simplified via use of the push- weapon option. When it is enabled, then using `w' to wield some- thing causes the currently wielded weapon to become your alter- @@ -2488,6 +2520,18 @@ leather jacket 9 no armor 10 + + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 39 + + + You can also wear other pieces of armor (for example hel- mets, boots, shields, cloaks) to lower your armor class even fur- ther, but you can only wear one item of each category (one suit @@ -2500,18 +2544,7 @@ would give you better protection than normal chain mail, lowering your armor class one unit further to 4. When you put on a piece of armor, you immediately find out the armor class and any - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 39 - - - "plusses" it provides. Cursed pieces of armor usually have nega- tive enchantments (minuses) in addition to being unremovable. @@ -2554,18 +2587,6 @@ or "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- - jects of subtle enchantment are difficult to identify without - these. - - A mail daemon may run up and deliver mail to you as a scroll - of mail (on versions compiled with this feature). To use this - feature on versions where NetHack mail delivery is triggered by - electronic mail appearing in your system mailbox, you must let - NetHack know where to look for new mail by setting the "MAIL" en- - vironment variable to the file name of your mailbox. You may NetHack 3.7 November 17, 2019 @@ -2578,12 +2599,24 @@ - also want to set the "MAILREADER" environment variable to the - file 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 vari- - ables are ignored. You can disable the mail daemon by turning - off the mail option. + 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- + jects of subtle enchantment are difficult to identify without + these. + + A mail daemon may run up and deliver mail to you as a scroll + of mail (on versions compiled with this feature). To use this + feature on versions where NetHack mail delivery is triggered by + electronic mail appearing in your system mailbox, you must let + NetHack know where to look for new mail by setting the "MAIL" en- + vironment variable to the file name of your mailbox. You may al- + so want to set the "MAILREADER" environment variable to the file + 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 + ignored. You can disable the mail daemon by turning off the mail + option. The command to read a scroll is `r'. @@ -2620,6 +2653,19 @@ In a truly desperate situation, when your back is up against the wall, you might decide to go for broke and break your wand. + + + NetHack 3.6 November 27, 2019 + + + + NetHack 3.7 November 17, 2019 + + + NetHack Guidebook 41 + + + This is not for the faint of heart. Doing so will almost cer- tainly cause a catastrophic release of magical energies. @@ -2632,18 +2678,6 @@ The command to use a wand is `z' (zap). To break one, use the `a' (apply) command. - - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 41 - - - 7.8. Rings (`=') Rings are very useful items, since they are relatively per- @@ -2686,6 +2720,18 @@ lar to wands. To cast one at yourself, just give a `.' or `s' for the direction. A few spells require you to pick a target lo- cation rather than just specify a particular direction. Other + + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 42 + + + spells don't require any direction or target. Just as weapons are divided into groups in which a character @@ -2699,17 +2745,7 @@ slots are shared with weapons skills. (See also the section on "Weapon proficiency".) - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 42 - - - Casting a spell also requires flexible movement, and wearing various types of armor may interfere with that. @@ -2750,6 +2786,20 @@ Like rings, amulets have various magical properties, some benefi- cial, some harmful, which are activated by putting them on. + + + + NetHack 3.6 November 27, 2019 + + + + NetHack 3.7 November 17, 2019 + + + NetHack Guidebook 43 + + + Only one amulet may be worn at a time, around your neck. The commands to use amulets are the same as for rings, `P' @@ -2763,21 +2813,9 @@ you exit. Other small rocks are also categorized as gems, but they are - much less valuable. All rocks, however, can be used as - - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 43 - - - - projectile weapons (if you have a sling). In the most desperate - of cases, you can still throw them by hand. + much less valuable. All rocks, however, can be used as projec- + tile weapons (if you have a sling). In the most desperate of + cases, you can still throw them by hand. 7.13. Large rocks (``') @@ -2815,6 +2853,19 @@ then once you see or feel that location again you will re-discov- er the object and resume remembering it. + + + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 44 + + + 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 @@ -2830,18 +2881,7 @@ action which breaks a challenge, it will no longer be listed. This gives players extra "bragging rights" for winning the game with these challenges. Note that it is perfectly acceptable to - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 44 - - - win the game without resorting to these restrictions and that it is unusual for players to adhere to challenges the first time they win the game. @@ -2881,6 +2921,18 @@ 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.6 November 27, 2019 + + + + + + NetHack Guidebook 45 + + + an animal, although wax is only an animal byproduct. Regardless of conduct, there will be some items which are @@ -2896,18 +2948,7 @@ "fruits", although they could be anything from "cherries" to "pork chops", are also assumed to be vegan. - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 45 - - - 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 @@ -2947,6 +2988,18 @@ 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.6 November 27, 2019 + + + + + + NetHack Guidebook 46 + + + 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 @@ -2963,17 +3016,7 @@ NetHack should do things, there are options you can set to change how NetHack behaves. - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 46 - - - 9.1. Setting the options Options may be set in a number of ways. Within the game, @@ -3011,8 +3054,20 @@ Any line beginning with `[' and ending in `]' is considered a section marker. The text between the square brackets is the section name. Lines after a section marker belong to that sec- - tion, and are ignored unless a CHOOSE statement was used to se- - lect that section. Section names are case insensitive. + tion, and are ignored unless a CHOOSE statement was used to + + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 47 + + + + select that section. Section names are case insensitive. You can use different configuration statements in the file, some of which can be used multiple times. In general, the state- @@ -3028,18 +3083,7 @@ "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 - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 47 - - - OPTIONS statements, and multiple options separated by commas in a single OPTIONS statement. (Comma separated options are pro- cessed from right to left.) @@ -3078,6 +3122,18 @@ AUTOCOMPLETE Enable or disable an extended command autocompletion. Autocom- pletion has no effect for the X11 windowport. You can specify + + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 48 + + + multiple autocompletions. To enable autocompletion, list the extended command. Prefix the command with "!" to disable the autocompletion for that command. @@ -3094,18 +3150,7 @@ 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. - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 48 - - - See the "Changing Key Bindings" section for more information. Example: @@ -3145,6 +3190,17 @@ Define the directory that contains the sound files. See the "Configuring User Sounds" section. + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 49 + + + SYMBOLS Override one or more symbols in the symbol set used for all dungeon levels except for the special rogue level. See the @@ -3161,17 +3217,7 @@ names, one per line, up to a maximum of 128 lines. Each line is processed by the function that handles wishing. - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 49 - - - Example: WIZKIT=~/wizkit.txt @@ -3209,6 +3255,19 @@ 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.6 November 27, 2019 + + + + + + NetHack Guidebook 50 + + + 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 @@ -3226,18 +3285,7 @@ The NETHACKOPTIONS value is effectively the same as a single OPTIONS statement in a configuration file. The "OPTIONS=" prefix is implied and comma separated options are processed from right - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 50 - - - to left. Other types of configuration statements such as BIND or MSGTYPE are not allowed. @@ -3276,6 +3324,17 @@ get a location on the map (default true). The whatis_coord op- tion controls whether the description includes map coordinates. + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 51 + + + autodig Automatically dig if you are wielding a digging tool and moving into a place that can be dug (default false). Persistent. @@ -3292,18 +3351,7 @@ 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 November 17, 2019 - - - - - - NetHack Guidebook 51 - - - 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- @@ -3343,6 +3391,17 @@ up looking like insufficient space). Only applies when MFLOPPY was defined during compilation. + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 52 + + + clicklook Allows looking at things on the screen by navigating the mouse over them and clicking the right mouse button (default off). @@ -3359,17 +3418,7 @@ dark_room Show out-of-sight areas of lit rooms (default on). Persistent. - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 52 - - - disclose Controls what information the program reveals when the game ends. Value is a space separated list of prompting/category @@ -3409,6 +3458,17 @@ Order of the disclosure categories does not matter, program display for end-of-game disclosure follows a set sequence. + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 53 + + + (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- @@ -3424,18 +3484,7 @@ Name your starting dog (for example "dogname:Fang"). Cannot be set with the `O' command. - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 53 - - - extmenu Changes the extended commands interface to pop-up a menu of available commands. It is keystroke compatible with the tradi- @@ -3475,6 +3524,18 @@ 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. + + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 54 + + + Cannot be set with the `O' command. Persistent. goldX @@ -3490,18 +3551,7 @@ 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 - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 54 - - - means that you might miss some interesting and/or important in- formation. Persistent. @@ -3542,6 +3592,17 @@ Ignore interrupt signals, including breaks (default off). Per- sistent. + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 55 + + + implicit_uncursed Omit "uncursed" from inventory lists, if possible (default on). @@ -3556,18 +3617,7 @@ lootabc When using a menu to interact with a container, use the old `a', `b', and `c' keyboard shortcuts rather than the mnemonics - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 55 - - - `o', `i', and `b' (default off). Persistent. mail @@ -3609,6 +3659,17 @@ of a menu. Implemented by the Amiga, Gem and tty ports. De- fault `\'. + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 56 + + + menu_first_page Menu character accelerator to jump to the first page in a menu. Implemented by the Amiga, Gem and tty ports. Default `^'. @@ -3622,18 +3683,7 @@ Menu character accelerator to invert all items in a menu. Im- plemented by the Amiga, Gem, X11 and tty ports. Default `@'. - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 56 - - - 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 @@ -3675,6 +3725,19 @@ monpolycontrol Prompt for new form whenever any monster changes shape (default + + + NetHack 3.6 November 27, 2019 + + + + + NetHack 3.7 November 17, 2019 + + NetHack Guidebook 57 + + + off). Debug mode only. mouse_support @@ -3688,18 +3751,6 @@ Omitting a value is the same as specifying 1 and negating mouse_support is the same as specifying 0. - - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 57 - - - 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. @@ -3742,6 +3793,17 @@ Use digit keys instead of letters to move (default 0 or off). Valid settings are: + + NetHack 3.6 November 27, 2019 + + + + + + NetHack Guidebook 58 + + + 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' @@ -3753,23 +3815,11 @@ 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 - - + 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 NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 58 - - - - accommodate some QWERTZ keyboards which have the location of - the `y' and `z' keys swapped.) When moving by numbers, to en- - ter a count prefix for those commands which accept one (such as - "12s" to search twelve times), precede it with the letter `n' + to search twelve times), precede it with the letter `n' ("n12s"). packorder @@ -3798,43 +3848,45 @@ 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 + 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 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 - "paranoid_confirmation:none". To keep it enabled while setting - 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- - plement this feature. + NetHack 3.6 November 27, 2019 NetHack 3.7 November 17, 2019 - - - NetHack Guidebook 59 + 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 + "paranoid_confirmation:none". To keep it enabled while setting + 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- + 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. @@ -3848,35 +3900,47 @@ 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 + 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. + 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. + + NetHack 3.6 November 27, 2019 + + + NetHack 3.7 November 17, 2019 + + + + NetHack Guidebook 60 + + + 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 + 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 @@ -3885,89 +3949,76 @@ uration file lines to further refine autopickup behavior. Per- sistent. - - - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 60 - - - 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. + 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. race Selects your race (for example, "race:human"). Default is ran- - dom. If you prefix the value with `!' or "no", you will ex- + 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- + 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", + 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 + 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.6 November 27, 2019 NetHack 3.7 November 17, 2019 - - NetHack Guidebook 61 + 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; @@ -3976,13 +4027,13 @@ 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. safe_pet - Prevent you from (knowingly) attacking your pets (default on). + Prevent you from (knowingly) attacking your pets (default on). Persistent. sanity_check @@ -3990,8 +4041,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. @@ -4000,119 +4051,120 @@ 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 Show your approximate accumulated score on bottom line (default off). Persistent. - silent - Suppress terminal beeps (default on). Persistent. - 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; + NetHack 3.6 November 27, 2019 NetHack 3.7 November 17, 2019 - - NetHack Guidebook 62 - loot - only sort the lists that don't use inventory letters, + silent + Suppress terminal beeps (default on). Persistent. + + 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. sortpack - Sort the pack contents by type when displaying inventory (de- + 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- + 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. + 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 + 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 + 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 - only; "X11" interface always uses a timer based delay. The de- - fault is on if configured into the program.) Persistent. + 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 - 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 + NetHack 3.6 November 27, 2019 NetHack 3.7 November 17, 2019 - - NetHack Guidebook 63 - visible when a windowing version of NetHack is started without - a parent window, but it no longer leaves the score list around + default is on if configured into the program.) Persistent. + + 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 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 + 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- + 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: @@ -4129,27 +4181,18 @@ 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 NetHack 3.7 November 17, 2019 @@ -4162,19 +4205,29 @@ + 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- + 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 + 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. @@ -4183,56 +4236,57 @@ 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 + 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 an ascii character map if it - can. - color - If NetHack can, it should display color if it can for different + NetHack 3.6 November 27, 2019 NetHack 3.7 November 17, 2019 - - NetHack Guidebook 65 + align_status + Where to align or place the status window (top, bottom, left, + or right). + + ascii_map + If NetHack can, it should display an ascii character map if it + can. + + color + If NetHack can, it should display color if it can for different monsters, objects, and dungeon features. eight_bit_tty - If NetHack can, it should pass eight-bit character values (for - example, specified with the traps option) straight through to + 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 @@ -4240,7 +4294,7 @@ map window. font_menu - 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 menu windows. font_message @@ -4252,57 +4306,57 @@ 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 + 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. + NetHack 3.6 November 27, 2019 NetHack 3.7 November 17, 2019 - - NetHack Guidebook 66 + 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- + 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 + If NetHack can, it should pop up dialog boxes, or use prompts for character selection. popup_dialog @@ -4310,27 +4364,27 @@ 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 + 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 @@ -4338,39 +4392,40 @@ 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). Curses and tty - interfaces only. + Number of lines for traditional below-the-map status display. - 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. + NetHack 3.6 November 27, 2019 NetHack 3.7 November 17, 2019 - - NetHack Guidebook 67 + Acceptable values are 2 and 3 (default is 2). Curses and tty + interfaces only. + + 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. tiled_map If NetHack can, it should display a tiled map if it can. tile_file - Specify the name of an alternative tile file to override the + Specify the name of an alternative tile file to override the default. 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 @@ -4380,40 +4435,31 @@ Use bold black instead of blue for black glyphs (TTY only). use_inverse - If NetHack can, it should display inverse when the game speci- + 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 + 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- + 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) - (The 26x82 size threshold for `2' refers to number of rows and - columns of the display. A width of at least 110 columns + (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 for align_status set to left or right.) windowcolors - If NetHack can, it should display windows with the specified + 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, NetHack 3.7 November 17, 2019 @@ -4426,8 +4472,18 @@ - greytext, highlight, highlighttext, inactiveborder, inactivecap- - tion, menu, menutext, scrollbar, window, windowframe, window- + 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 @@ -4436,12 +4492,12 @@ 9.6. Platform-specific Customization options - Here are explanations of options that are used by specific + 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 + 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. @@ -4451,25 +4507,38 @@ 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 + 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 + 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 + set -- is also subject to this conversion, so attempting to + abort the count by typing ESC will leave NetHack waiting for another character to complete the two character sequence. Type - a second ESC to finish cancelling such a count. At other + a second ESC to finish cancelling such a count. At other prompts a single ESC suffices. BIOS Use BIOS calls to update the screen display quickly and to read - the keyboard (allowing the use of arrow keys to move) on ma- - chines with an IBM PC compatible BIOS ROM (default off, OS/2, + 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). + + + NetHack 3.6 November 27, 2019 + + + + NetHack 3.7 November 17, 2019 + + + NetHack Guidebook 69 + + + flush (default off, Amiga NetHack only). @@ -4479,24 +4548,11 @@ page_wait (default on, Mac NetHack only). - - - - NetHack 3.7 November 17, 2019 - - - - - - NetHack Guidebook 69 - - - 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 @@ -4536,18 +4592,12 @@ 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. - 9.8. Configuring Autopickup Exceptions - You can further refine the behavior of the autopickup option beyond what is available through the pickup_types option. - By placing autopickup_exception lines in your configuration file, you can define patterns to be checked when the game is - NetHack 3.7 November 17, 2019 @@ -4558,6 +4608,12 @@ + expression support on a platform where there is no regular ex- + pression library. While this is not true of any modern platform, + if your NetHack was built this way, patterns are instead glob + patterns. This applies to Autopickup exceptions, Message types, + Menu colors, and User sounds. + about to autopickup something. autopickup_exception @@ -4599,10 +4655,6 @@ 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. - - For example: - BIND=^X:getpos.autodescribe BIND={:menu_first_page BIND=v:loot @@ -4613,17 +4665,20 @@ to. You can also bind the "", "", and "" keys. + NetHack 3.6 November 27, 2019 NetHack 3.7 November 17, 2019 - - NetHack Guidebook 71 + a meta key ("M-x"), or a three-digit decimal ASCII code. + + For example: + Menu accelerator keys The menu control or accelerator keys can also be rebound via OPTIONS lines in the configuration file. You cannot bind ob- @@ -4663,10 +4718,7 @@ fault is `s'. getpos.autodescribe - When asked for a location, the key to toggle autodescribe. De- - fault is `#'. - - getpos.all.next + When asked for a location, the key to toggle autodescribe. When asked for a location, the key to go to next closest inter- esting thing. Default is `a'. @@ -4688,6 +4740,10 @@ NetHack Guidebook 72 + getpos.all.next + When asked for a location, the key to go to next closest inter- + esting thing. Default is `a'. + getpos.door.prev @@ -4730,10 +4786,7 @@ Toggles between no filtering, in view only, and in the same area only. Default is `"'. - getpos.pick When asked for a location, the key to choose the location, and - possibly ask for more info. Default is `.'. - getpos.pick.once When asked for a location, the key to choose the location, and skip asking for more info. Default is `,'. @@ -4754,6 +4807,10 @@ NetHack Guidebook 73 + getpos.pick + When asked for a location, the key to choose the location, and + possibly ask for more info. Default is `.'. + getpos.pick.verbose @@ -4797,12 +4854,8 @@ 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'. @@ -4819,6 +4872,8 @@ NetHack Guidebook 74 + Prefix key to request menu from some commands. Default is `m'. + @@ -4860,16 +4915,14 @@ matching rule is used. Put the general case first, exceptions below them. - 9.11. Configuring Menu Colors - Some platforms allow you to define colors used in menu lines when the line matches a user-defined pattern. At this time the - tty, curses, win32tty and win32gui interfaces support this. In general, the configuration file entries to describe the menu color mappings look like this: MENUCOLOR="pattern"=color&attribute + NetHack 3.6 November 27, 2019 pattern - the pattern to match; color - the color to use for lines matching the pat- @@ -4886,6 +4939,10 @@ NetHack Guidebook 75 + Some platforms allow you to define colors used in menu lines + when the line matches a user-defined pattern. At this time the + tty, curses, win32tty and win32gui interfaces support this. + left out, you must also leave out the preced- @@ -4924,12 +4981,9 @@ plicit_uncursed option off so that all items known to be uncursed are actually displayed with the "uncursed" description. - 9.12. 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 configuration file entries are relevant to mapping user sounds to messages: @@ -4952,6 +5006,12 @@ NetHack Guidebook 76 + 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. + + MESG - message window mapping (the only one supported in @@ -4989,14 +5049,10 @@ OPTION=hilite_status:wisdom/down/red/up/green Allowed colors are black, red, green, brown, blue, magenta, - cyan, gray, orange, light-green, yellow, light-blue, light-magen- + cyan, gray, orange, light-green, yellow, light-blue, light- ta, light-cyan, and white. And "no-color", the default fore- - ground color on the display, which is not necessarily the same as - black or white or any of the other colors. - Allowed attributes are none, bold, dim, underline, blink, and inverse. "Normal" is a synonym for "none"; they should not - be used in combination with any of the other attributes. To specify both a color and an attribute, use `&' to combine them. To specify multiple attributes, use `+' to combine those. @@ -5018,6 +5074,14 @@ NetHack Guidebook 77 + magenta, light-cyan, and white. And "no-color", the default + foreground color on the display, which is not necessarily the + same as black or white or any of the other colors. + + Allowed attributes are none, bold, dim, underline, blink, + and inverse. "Normal" is a synonym for "none"; they should not + be used in combination with any of the other attributes. + combine with it. Since NetHack issues attribute requests sequen- @@ -5056,13 +5120,10 @@ * "up", "down" set the field attributes for when the field value changes upwards or downwards. This attribute times - out after statushilites turns. - * "changed" sets the field attribute for when the field val- ue changes. This attribute times out after statushilites turns. (If a field has both a "changed" rule and an "up" or "down" rule which matches a change in the field's val- - ue, the "up" or "down" one takes precedence.) * percentage sets the field attribute when the field value matches the percentage. It is specified as a number be- @@ -5080,12 +5141,18 @@ - - NetHack Guidebook 78 + out after statushilites turns. + + * "changed" sets the field attribute for when the field val- + ue changes. This attribute times out after statushilites + turns. (If a field has both a "changed" rule and an "up" + or "down" rule which matches a change in the field's val- + ue, the "up" or "down" one takes precedence.) + maximum field. Percentage highlight rules are also al- lowed for "experience level" and "experience points" (valid when the showexp option is enabled). For those,