diff --git a/Files b/Files index ddaede9b3..efd22e19b 100644 --- a/Files +++ b/Files @@ -58,8 +58,9 @@ nhlib.lua opthelp optmenu oracle.lua oracles.txt orcus.lua quest.lua rumors.fal rumors.tru sanctum.lua soko1-1.lua soko1-2.lua soko2-1.lua soko2-2.lua soko3-1.lua soko3-2.lua soko4-1.lua soko4-2.lua symbols themerms.lua -tower1.lua tower2.lua tower3.lua tribute valley.lua -water.lua wizard1.lua wizard2.lua wizard3.lua wizhelp +tower1.lua tower2.lua tower3.lua tribute usagehlp +valley.lua water.lua wizard1.lua wizard2.lua wizard3.lua +wizhelp doc: (files for all versions) @@ -254,7 +255,7 @@ write.c zap.c submodules: (files in top directory) -lua pdcurses +lua pdcurses pdcursesmod sys/libnh: (files in top directory) diff --git a/doc/Guidebook.mn b/doc/Guidebook.mn index 97124f346..5176c7ad8 100644 --- a/doc/Guidebook.mn +++ b/doc/Guidebook.mn @@ -37,7 +37,7 @@ .ds f0 "\*(vr .ds f1 .\"DO NOT REMOVE NH_DATESUB .ds f2 "DATE(%B %-d, %Y) -.ds f2 "October 27, 2022 +.ds f2 "November 23, 2022 . .\" A note on some special characters: .\" \(lq = left double quote diff --git a/doc/Guidebook.tex b/doc/Guidebook.tex index 9990a95af..4ada3772c 100644 --- a/doc/Guidebook.tex +++ b/doc/Guidebook.tex @@ -46,7 +46,7 @@ \author{Original version - Eric S. Raymond\\ (Edited and expanded for 3.7 by Mike Stephenson and others)} %DO NOT REMOVE NH_DATESUB \date{DATE(%B %-d, %Y)} -\date{October 27, 2022} +\date{November 23, 2022} \maketitle diff --git a/doc/Guidebook.txt b/doc/Guidebook.txt index a1eec5dd4..eb52e21ff 100644 --- a/doc/Guidebook.txt +++ b/doc/Guidebook.txt @@ -15,7 +15,7 @@ Original version - Eric S. Raymond (Edited and expanded for 3.7 by Mike Stephenson and others) - October 27, 2022 + November 23, 2022 @@ -126,7 +126,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -192,7 +192,7 @@ you have seen on the current dungeon level; as you explore more - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -215,8 +215,8 @@ is recommended; if the screen is larger, only a 21x80 section will be used for the map. - NetHack can even be played by blind players, with the assis- - tance of Braille readers or speech synthesisers. Instructions + NetHack can even be played by blind players, with the as- + sistance of Braille readers or speech synthesisers. Instructions for configuring NetHack for the blind are included later in this document. @@ -258,7 +258,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -324,7 +324,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -390,7 +390,7 @@ you have available for spell casting. Again, resting will - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -456,7 +456,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -522,7 +522,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -588,7 +588,7 @@ ing a `*' lists your entire inventory, so you can see the - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -654,7 +654,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -720,7 +720,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -786,7 +786,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -852,7 +852,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -918,7 +918,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -984,7 +984,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -1041,8 +1041,8 @@ hand and it will generally be less effective than when shot. See also `f' (fire) for throwing or shooting an item pre-se- - lected via the `Q' (quiver) command, with some extra assis- - tance. + lected via the `Q' (quiver) command, with some extra assist- + ance. T Take off armor. @@ -1050,7 +1050,7 @@ for which one to take off. (Note that this treats a cloak - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -1116,7 +1116,7 @@ that redundant, such as Caveman or Priestess), and - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -1182,7 +1182,7 @@ (R)UNIX is a registered trademark of The Open Group. - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -1248,7 +1248,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -1314,7 +1314,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -1380,7 +1380,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -1446,7 +1446,7 @@ Jump to another location. Autocompletes. Default key is - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -1512,7 +1512,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -1578,7 +1578,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -1644,7 +1644,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -1710,7 +1710,7 @@ Do a shell escape, switching from NetHack to a subprocess. - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -1776,7 +1776,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -1842,7 +1842,7 @@ - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -1853,7 +1853,23 @@ #vanquished - List vanquished monsters. Autocompletes. Debug mode only. + List vanquished monsters by type and count. + + Note that the vanquished monsters list includes all monsters + killed by traps and each other as well as by you, and omits + any which got removed from the game without being killed + (perhaps by genocide, or by a mollified shopkeeper dismiss- + ing summoned Kops). + + Using the "request menu" prefix prior to #vanquished brings + up a menu of sorting orders available. Whichever one is + picked is remembered for subsequent #vanquished commands + during the current play session but not saved and restored + across sessions. During end-of-game disclosure, when asked + whether to show vanquished monsters answering `a' will let + you choose from the sort menu. + + Autocompletes. Default key is `M-V'. #version Print compile time options for this version of NetHack. @@ -1890,6 +1906,18 @@ #wield Wield a weapon. Default key is `w'. + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 30 + + + #wipe Wipe off your face. Autocompletes. Default key is `M-w'. @@ -1905,21 +1933,9 @@ Cast any spell. Debug mode only. #wizdetect - Reveal hidden things (secret doors or traps or unseen - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 30 - - - - monsters) within a modest radius. No time elapses. Auto- - completes. Debug mode only. Default key is `^E'. + Reveal hidden things (secret doors or traps or unseen mon- + sters) within a modest radius. No time elapses. Autocom- + pletes. Debug mode only. Default key is `^E'. #wizgenesis Create a monster. May be prefixed by a count to create more @@ -1955,6 +1971,19 @@ Also displays first, second, and last random engravings, epitaphs, and hallucinatory monsters. + + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 31 + + + Autocompletes. Debug mode only. #wizseenv @@ -1972,18 +2001,6 @@ Wish for something. Autocompletes. Debug mode only. De- fault key is `^W'. - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 31 - - - #wmode Show wall modes. Autocompletes. Debug mode only. @@ -2020,6 +2037,19 @@ M-2 #twoweapon (unless the number_pad option is enabled) + + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 32 + + + M-a #adjust M-A #annotate @@ -2038,18 +2068,6 @@ M-j #jump - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 32 - - - M-l #loot M-m #monster @@ -2076,6 +2094,8 @@ M-v #version + M-V #vanquished + M-w #wipe M-X #exploremode @@ -2085,6 +2105,17 @@ If the number_pad option is on, some additional letter com- mands are available: + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 33 + + + h #help j #jump @@ -2105,17 +2136,6 @@ 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.7 October 27, 2022 - - - - - - NetHack Guidebook 33 - - - Secret corridors are hidden and appear to be solid rock. You can find them with the `s' (search) command when adjacent to them. Multiple search attempts may be needed. When searching is @@ -2132,8 +2152,8 @@ command. By default the autoopen option is enabled, so simply attempting to walk onto a closed door's location will attempt to open it without needing `o'. Opening via autoopen will not work - if you are confused or stunned or suffer from the fumbling at- - tribute. + if you are confused or stunned or suffer from the fumbling attri- + bute. Open doors cannot be entered diagonally; you must approach them straight on, horizontally or vertically. Doorways without @@ -2151,6 +2171,17 @@ command. Kicking down a door destroys it and makes a lot of noise which might wake sleeping monsters. + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 34 + + + Some closed doors are booby-trapped and will explode if an attempt is made to open (when unlocked) or unlock (when locked) or kick down. Like kicking, an explosion destroys the door and @@ -2170,18 +2201,6 @@ Secret doors are hidden and appear to be ordinary wall (from inside a room) or solid rock (from outside). You can find them with the `s' (search) command but it might take multiple tries - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 34 - - - (possibly many tries if your luck is poor). Once found they are in all ways equivalent to normal doors. Mapping magic does not reveal secret doors. @@ -2217,6 +2236,18 @@ traps choose a new destination each time they're activated. Trap doors and holes also send you to another level, but one which is always below the current level. Usually that will be the next + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 35 + + + level down but it can be farther. Unlike (level) teleporters, the destination level of a particular trap door or hole is per- sistent, so falling into one will bring you to the same level @@ -2236,18 +2267,6 @@ beyond them. In the Sokoban game, you can only move in the four cardinal compass directions, and a crate in its final destination blocks further access to that spot. In the Sokoban levels of - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 35 - - - NetHack, you can move diagonally (unless that would let you pass between two neighboring boulders) but you can only push boulders in the four cardinal directions, and a boulder which fills a pit @@ -2283,6 +2302,18 @@ sends you to another level, the level you're leaving will be de- activated and stored in a file on disk. If you're moving to a previously visited level, it will be loaded from its file on disk + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 36 + + + and reactivated. If you're moving to a level which has not yet been visited, it will be created (from scratch for most random levels, from a template for some "special" levels, or loaded from @@ -2302,18 +2333,6 @@ types of inter-level connections are nearly indistinguishable during game play. - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 36 - - - 5.4. Shops and shopping Occasionally you will run across a room with a shopkeeper @@ -2350,6 +2369,17 @@ ventory-like display of any unpaid items which have been used up, along with other shop fees, if any. + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 37 + + + 5.4.1. Shop idiosyncrasies Several aspects of shop behavior might be unexpected. @@ -2368,18 +2398,6 @@ * Shops do not get restocked with new items, regardless of inven- tory depletion. - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 37 - - - 5.5. Movement feedback Moving around the map usually provides no feedback--other @@ -2416,6 +2434,18 @@ fountain or an altar or various other things doesn't elicit any- thing unless it is covered by one or more objects so is obscured on the map. Setting this option to true will describe such + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 38 + + + things even when they aren't obscured. Doorless doorways and open doors aren't considered worthy of mention; closed doors (if you can move onto their spots) and broken doors are. Assuming @@ -2433,20 +2463,8 @@ The "nopickup" command prefix (default `m') is also the move-without-attacking prefix and can be used to try to step onto - a visible monster's spot without the move being considered an - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 38 - - - - attack (see the Fighting subsection of Monsters below). The + a visible monster's spot without the move being considered an at- + tack (see the Fighting subsection of Monsters below). The "fight" command prefix (default `F'; also `-' if number_pad is on) can be used to force an attack, when guessing where an unseen monster is or when deliberately attacking a peaceful or tame @@ -2482,6 +2500,18 @@ magic items can help you locate them before they locate you (which some monsters can do very well). + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 39 + + + The commands `/' and `;' may be used to obtain information about those monsters who are displayed on the screen. The com- mand "#name" (by default bound to `C'), allows you to assign a @@ -2500,18 +2530,6 @@ If you see a monster and you wish to fight it, just attempt to walk into it. Many monsters you find will mind their own business unless you attack them. Some of them are very dangerous - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 39 - - - when angered. Remember: discretion is the better part of valor. In most circumstances, if you attempt to attack a peaceful @@ -2547,6 +2565,19 @@ Initially, your pet may even be better at killing things than you, which makes pets useful for low-level characters. + + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 40 + + + Your pet will follow you up and down staircases if it is next to you when you move. Otherwise your pet will be stranded and may become wild. Similarly, when you trigger certain types @@ -2566,18 +2597,6 @@ 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 - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 40 - - - beast that you will see displayed on the map. Riding skill is managed by the "#enhance" command. See the @@ -2612,11 +2631,23 @@ However, if you encounter a monster which you can't see or sense--perhaps it is invisible and has just tapped you on the noggin--a special "remembered, unseen monster" marker will be - displayed at the location where you think it is. That will per- - sist until you have proven that there is no monster there, even - if the unseen monster moves to another location or you move to a - spot where the marker's location ordinarily wouldn't be seen any - more. + displayed at the location where you think it is. That will + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 41 + + + + persist until you have proven that there is no monster there, + even if the unseen monster moves to another location or you move + to a spot where the marker's location ordinarily wouldn't be seen + any more. 7. Objects @@ -2631,19 +2662,6 @@ will add the object(s) to your pack and tell you what you just picked up. - - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 41 - - - As you add items to your inventory, you also add the weight of that object to your load. The amount that you can carry de- pends on your strength and your constitution. The stronger and @@ -2680,6 +2698,18 @@ the "#name" command, for the same purpose at any time, to name all objects of a particular type or just an individual object. When you use "#name" on an object which has already been named, + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 42 + + + specifying a space as the value will remove the prior name in- stead of assigning a new one. @@ -2699,17 +2729,6 @@ example, a blessed weapon will do slightly more damage against demons. - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 42 - - - Objects which are neither cursed nor blessed are referred to as uncursed. They could just as easily have been described as unblessed, but the uncursed designation is what you will see @@ -2745,6 +2764,18 @@ (killing them first). Without a weapon, you do only 1-2 hit points of damage (plus bonuses, if any). Monk characters are an exception; they normally do more damage with bare (or gloved) + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 43 + + + hands than they do with weapons. There are wielded weapons, like maces and swords, and thrown @@ -2763,24 +2794,12 @@ The chance that an attack will successfully hit a monster, and the amount of damage such a hit will do, depends upon many - factors. Among them are: type of weapon, quality of weapon - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 43 - - - - (enchantment and/or erosion), experience level, strength, dexter- - ity, encumbrance, and proficiency (see below). The monster's ar- - mor class--a general defense rating, not necessarily due to wear- - ing of armor--is a factor too; also, some monsters are particu- - larly vulnerable to certain types of weapons. + factors. Among them are: type of weapon, quality of weapon (en- + chantment and/or erosion), experience level, strength, dexterity, + encumbrance, and proficiency (see below). The monster's armor + class--a general defense rating, not necessarily due to wearing + of armor--is a factor too; also, some monsters are particularly + vulnerable to certain types of weapons. Many weapons can be wielded in one hand; some require both hands. When wielding a two-handed weapon, you can not wear a @@ -2810,6 +2829,19 @@ `f' (fire), `Q' (quiver), `x' (exchange), `X' (twoweapon), and "#enhance" (see below). + + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 44 + + + 7.2.1. Throwing and shooting You can throw just about anything via the `t' command. It @@ -2831,17 +2863,6 @@ turning thrown objects occasionally fail to be caught, sometimes even hitting the thrower, but when caught they become re-wielded. - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 44 - - - You can simplify the throwing operation by using the `Q' command to select your preferred "missile", then using the `f' command to throw it. You'll be prompted for a direction as @@ -2876,6 +2897,17 @@ ones kill a monster, the others can still continue beyond that spot. + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 45 + + + 7.2.2. Weapon proficiency You will have varying degrees of skill in the weapons avail- @@ -2896,18 +2928,6 @@ skill(s) to improve when you've used one or more skills enough to become eligible to do so. The skill rankings are "none" (some- times also referred to as "restricted", because you won't be able - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 45 - - - to advance), "unskilled", "basic", "skilled", and "expert". Re- stricted skills simply will not appear in the list shown by "#en- hance". (Divine intervention might unrestrict a particular @@ -2942,6 +2962,18 @@ you stop--or before you begin, for that matter--wielding two weapons at once. The primary is your wielded weapon and the sec- ondary is just an item in your inventory that's been designated + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 46 + + + as alternate weapon.) If your primary weapon is wielded but your off hand is empty @@ -2962,18 +2994,6 @@ want as primary which will push the first into secondary posi- tion. - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 46 - - - When in two-weapon combat mode, using the `X' command tog- gles back to single-weapon mode. Throwing or dropping either of the weapons or having one of them be stolen or destroyed will al- @@ -3008,6 +3028,18 @@ armor class even further. Most of these provide a one or two point improvement to AC (making the overall value smaller and eventually negative) but can also be enchanted. Shirts are an + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 47 + + + exception; they don't provide any protection unless enchanted. Some cloaks also don't improve AC when unenchanted but all cloaks offer some protection against rust or corrosion to suits worn un- @@ -3028,18 +3060,6 @@ The nudist option can be set (prior to game start) to at- tempt to play the entire game without wearing any armor (a self- - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 47 - - - imposed challenge which is extremely difficult to accomplish). The commands to use armor are `W' (wear) and `T' (take off). @@ -3073,6 +3093,19 @@ The command to eat food is `e'. + + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 48 + + + 7.5. Scrolls (`?') Scrolls are labeled with various titles, probably chosen by @@ -3094,18 +3127,6 @@ 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 - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 48 - - - 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 @@ -3139,6 +3160,18 @@ tempts to use the wand will usually result in nothing happening. Occasionally, however, it may be possible to squeeze the last few mana points from an otherwise spent wand, destroying it in the + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 49 + + + 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 @@ -3158,20 +3191,6 @@ The command to use a wand is `z' (zap). To break one, use the `a' (apply) command. - - - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 49 - - - 7.8. Rings (`=') Rings are very useful items, since they are relatively per- @@ -3207,6 +3226,18 @@ level, or if you have little skill with the appropriate spell type, or cast it at a time when your luck is particularly bad, you can end up wasting both the energy and the time required in + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 50 + + + casting. Casting a spell calls forth magical energies and focuses @@ -3226,18 +3257,6 @@ Just as weapons are divided into groups in which a character can become proficient (to varying degrees), spells are similarly - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 50 - - - grouped. Successfully casting a spell exercises its skill group; using the "#enhance" command to advance a sufficiently exercised skill will affect all spells within the group. Advanced skill @@ -3265,15 +3284,26 @@ Some tools (such as a blindfold) can be worn and can be put on and removed like other accessories (rings, amulets); see - Amulets. Other tools (such as pick-axe) can be wielded as - weapons in addition to being applied for their usual purpose, and - in some cases (again, pick-axe) become wielded as a weapon even - when applied. + Amulets. Other tools (such as pick-axe) can be wielded as weap- + ons in addition to being applied for their usual purpose, and in + some cases (again, pick-axe) become wielded as a weapon even when + applied. The blind option can be set (prior to game start) to attempt to play the entire game without being able to see (a self-imposed challenge which is very difficult to accomplish). + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 51 + + + The command to use a tool is `a' (apply). 7.10.1. Containers @@ -3292,18 +3322,6 @@ you unlock or open them. You can check for and try to deactivate traps with the "#untrap" extended command. - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 51 - - - 7.11. Amulets (`"') Amulets are very similar to rings, and often more powerful. @@ -3340,6 +3358,18 @@ generally heavy. It is rumored that some statues are not what they seem. + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 52 + + + Boulders occasionally block your path. You can push one forward (by attempting to walk onto its spot) when nothing blocks its path, or you can smash it into a pile of small rocks with @@ -3358,18 +3388,6 @@ be because they don't block movement. They can be smashed into rocks though. - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 52 - - - For some configurations of the program, statues are no longer shown as ``' but by the letter representing the monster they depict instead. @@ -3405,6 +3423,19 @@ then once you see or feel that location again you will re-discov- er the object and resume remembering it. + + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 53 + + + 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 @@ -3424,18 +3455,6 @@ is unusual for players to adhere to challenges the first time they win the game. - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 53 - - - 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 @@ -3471,6 +3490,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.7 November 23, 2022 + + + + + + NetHack Guidebook 54 + + + an animal, although wax is only an animal byproduct. Regardless of conduct, there will be some items which are @@ -3489,23 +3520,11 @@ 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 - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 54 - - - - 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 + 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. @@ -3536,29 +3555,10 @@ to plug those in order to both get the boulders out of the way and be able to go past the traps. There are some special "rules" that are active when in that branch of the dungeon. Some rules - can't be bypassed, such as being unable to push a boulder diago- - nally. Other rules can, such as not smashing boulders with magic - or tools, but doing so causes you to receive a luck penalty. No - message about that is given at the time, but it is tracked as a - conduct. The #conduct command and end of game disclosure will - report whether you have abided by the special rules of Sokoban, - and if not, how many times you violated them, providing you with - a way to discover which actions incur bad luck so that you can be - better informed about whether or not to avoid repeating those ac- - tions in the future. (Note: the Sokoban conduct will only be - displayed if you have entered the Sokoban branch of the dungeon - during the current game. Once that has happened, it becomes part - of disclosed conduct even if you haven't done anything interest- - ing there. Ending the game with "never broke the Sokoban rules" - conduct is most meaningful if you also manage to perform the "ob- - tained the Sokoban prize" achievement (see Achievements below).) - - There are several other challenges tracked by the game. It - is possible to eliminate one or more species of monsters by geno- - cide; playing without this feature is considered a challenge. + can't be bypassed, such as being unable to push a boulder - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -3568,28 +3568,48 @@ + diagonally. Other rules can, such as not smashing boulders with + magic or tools, but doing so causes you to receive a luck penal- + ty. No message about that is given at the time, but it is + tracked as a conduct. The #conduct command and end of game dis- + closure will report whether you have abided by the special rules + of Sokoban, and if not, how many times you violated them, provid- + ing you with a way to discover which actions incur bad luck so + that you can be better informed about whether or not to avoid re- + peating those actions in the future. (Note: the Sokoban conduct + will only be displayed if you have entered the Sokoban branch of + the dungeon during the current game. Once that has happened, it + becomes part of disclosed conduct even if you haven't done any- + thing interesting there. Ending the game with "never broke the + Sokoban rules" conduct is most meaningful if you also manage to + perform the "obtained the Sokoban prize" achievement (see + Achievements below).) + + There are several other challenges tracked by the game. It + is possible to eliminate one or more species of monsters by geno- + cide; playing without this feature is considered a challenge. When the game offers you an opportunity to genocide monsters, you - may respond with the monster type "none" if you want to decline. - You can change the form of an item into another item of the same - type ("polypiling") or the form of your own body into another - creature ("polyself") by wand, spell, or potion of polymorph; - avoiding these effects are each considered challenges. Polymor- - phing monsters, including pets, does not break either of these - challenges. Finally, you may sometimes receive wishes; a game - without an attempt to wish for any items is a challenge, as is a - game without wishing for an artifact (even if the artifact imme- - diately disappears). When the game offers you an opportunity to - make a wish for an item, you may choose "nothing" if you want to + may respond with the monster type "none" if you want to decline. + You can change the form of an item into another item of the same + type ("polypiling") or the form of your own body into another + creature ("polyself") by wand, spell, or potion of polymorph; + avoiding these effects are each considered challenges. Polymor- + phing monsters, including pets, does not break either of these + challenges. Finally, you may sometimes receive wishes; a game + without an attempt to wish for any items is a challenge, as is a + game without wishing for an artifact (even if the artifact imme- + diately disappears). When the game offers you an opportunity to + make a wish for an item, you may choose "nothing" if you want to decline. 8.1. Achievements - End of game disclosure will also display various achieve- - ments representing progress toward ultimate ascension, if any - have been attained. They aren't directly related to conduct but - are grouped with it because they fall into the same category of - "bragging rights" and to limit the number of questions during - disclosure. Listed here roughly in order of difficulty and not + End of game disclosure will also display various achieve- + ments representing progress toward ultimate ascension, if any + have been attained. They aren't directly related to conduct but + are grouped with it because they fall into the same category of + "bragging rights" and to limit the number of questions during + disclosure. Listed here roughly in order of difficulty and not necessarily in the order in which you might accomplish them. - Attained rank title . @@ -3602,11 +3622,23 @@ Sokoban - Entered Sokoban. Big Room - Entered the Big Room. Soko-Prize - Explored to the top of Sokoban + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 56 + + + and found a special item there. Mines' End - Explored to the bottom of the Gnomish Mines and found a special item there. Medusa - Defeated Medusa. - Tune - Discovered the tune that can be used to open and + Tune - Discovered the tune that can be used to open and close the drawbridge on the Castle level. Bell - Acquired the Bell of Opening. Gehennom - Entered Gehennom. @@ -3622,75 +3654,43 @@ Notes: - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 56 - - - - Achievements are recorded and subsequently reported in the - order in which they happen during your current game rather than + Achievements are recorded and subsequently reported in the + order in which they happen during your current game rather than the order listed here. - There are nine titles for each role, bestowed at ex- + There are nine titles for each role, bestowed at ex- perience levels 1, 3, 6, 10, 14, 18, 22, 26, and 30. The one for - experience level 1 is not recorded as an achievement. Losing - enough levels to revert to lower rank(s) does not discard the + experience level 1 is not recorded as an achievement. Losing + enough levels to revert to lower rank(s) does not discard the corresponding achievement(s). - There's no guaranteed Novel so the achievement to read one + There's no guaranteed Novel so the achievement to read one might not always be attainable (except perhaps by wishing). Sim- - ilarly, the Big Room level is not always present. Unlike with + ilarly, the Big Room level is not always present. Unlike with the Novel, there's no way to wish for this opportunity. The "special items" hidden in Mines' End and Sokoban are not - unique but are considered to be prizes or rewards for exploring - those levels since doing so is not necessary to complete the + unique but are considered to be prizes or rewards for exploring + those levels since doing so is not necessary to complete the game. Finding other instances of the same objects doesn't record the corresponding achievement. - The Medusa achievement is recorded if she dies for any rea- - son, even if you are not directly responsible, and only if she + The Medusa achievement is recorded if she dies for any rea- + son, even if you are not directly responsible, and only if she dies. - The 5-note tune can be learned via trial and error with a - musical instrument played closely enough--but not too close!--to - the Castle level's drawbridge or can be given to you via prayer + The 5-note tune can be learned via trial and error with a + musical instrument played closely enough--but not too close!--to + the Castle level's drawbridge or can be given to you via prayer boon. Blind and Nudist are also conducts, and they can only be en- - abled by setting the correspondingly named option in NETHACKOP- + abled by setting the correspondingly named option in NETHACKOP- TIONS or run-time configuration file prior to game start. In the case of Blind, the option also enforces the conduct. They aren't - really significant accomplishments unless/until you make substan- - tial progress into the dungeon. - - 9. Options - - Due to variations in personal tastes and conceptions of how - NetHack should do things, there are options you can set to change - how NetHack behaves. - - 9.1. Setting the options - - Options may be set in a number of ways. Within the game, - the `O' command allows you to view all options and change most of - them. You can also set options automatically by placing them in - a configuration file, or in the NETHACKOPTIONS environment vari- - able. 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.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -3700,63 +3700,63 @@ + really significant accomplishments unless/until you make substan- + tial progress into the dungeon. + + 9. Options + + Due to variations in personal tastes and conceptions of how + NetHack should do things, there are options you can set to change + how NetHack behaves. + + 9.1. Setting the options + + Options may be set in a number of ways. Within the game, + the `O' command allows you to view all options and change most of + them. You can also set options automatically by placing them in + a configuration file, or in the NETHACKOPTIONS environment vari- + able. 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 a configuration file The default name of the configuration file varies on differ- ent operating systems. - On UNIX, Linux, and macOS it is ".nethackrc" in the user's + On UNIX, Linux, and macOS it is ".nethackrc" in the user's home directory. The file may not exist, but it is a normal ASCII text file and can be created with any text editor. - On Windows, it is ".nethackrc" in the folder "\%USERPRO- - FILE%\NetHack\3.7". The file may not exist, but it is a normal - ASCII text file can can be created with any text editor. After - running NetHack for the first time, you should find a default - template for the configuration file named ".nethackrc.template" + On Windows, it is ".nethackrc" in the folder "\%USERPRO- + FILE%\NetHack\3.7". The file may not exist, but it is a normal + ASCII text file can can be created with any text editor. After + running NetHack for the first time, you should find a default + template for the configuration file named ".nethackrc.template" in "\%USERPROFILE%\NetHack\3.7". If you had not created the con- - figuration file, NetHack will create the configuration file for + figuration file, NetHack will create the configuration file for you using the default template file. - On MS-DOS, it is "defaults.nh" in the same folder as + On MS-DOS, it is "defaults.nh" in the same folder as nethack.exe. - Any line in the configuration file starting with `#' is + Any line in the configuration file starting with `#' is treated as a comment and ignored. Empty lines are ignored. - Any line beginning with `[' and ending in `]' is a section + Any line beginning with `[' and ending in `]' is a section marker (the closing `]' can be followed by whitespace and then an - arbitrary comment beginning with `#'). The text between the - square brackets is the section name. Section markers are only - valid after a CHOOSE directive and their names are case insensi- + arbitrary comment beginning with `#'). The text between the + square brackets is the section name. Section markers are only + valid after a CHOOSE directive and their names are case insensi- tive. Lines after a section marker belong to that section up un- - til another section starts or a marker without a name is encoun- + til another section starts or a marker without a name is encoun- tered or the file ends. Lines within sections are ignored unless a CHOOSE directive has selected that section. - You can use different configuration directives in the file, - some of which can be used multiple times. In general, the direc- - tives are written in capital letters, followed by an equals sign, - followed by settings particular to that directive. - - Here is a list of allowed directives: - - OPTIONS - There are two types of options, boolean and compound options. - Boolean options toggle a setting on or off, while compound op- - tions take more diverse values. Prefix a boolean option with - "no" or `!' to turn it off. For compound options, the option - name and value are separated by a colon. Some options are per- - sistent, and apply only to new games. You can specify multiple - OPTIONS directives, and multiple options separated by commas in - a single OPTIONS directive. (Comma separated options are pro- - cessed from right to left.) - - Example: - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -3766,25 +3766,45 @@ + You can use different configuration directives in the file, + some of which can be used multiple times. In general, the direc- + tives are written in capital letters, followed by an equals sign, + followed by settings particular to that directive. + + Here is a list of allowed directives: + + OPTIONS + There are two types of options, boolean and compound options. + Boolean options toggle a setting on or off, while compound op- + tions take more diverse values. Prefix a boolean option with + "no" or `!' to turn it off. For compound options, the option + name and value are separated by a colon. Some options are per- + sistent, and apply only to new games. You can specify multiple + OPTIONS directives, and multiple options separated by commas in + a single OPTIONS directive. (Comma separated options are pro- + cessed from right to left.) + + Example: + OPTIONS=dogname:Fido OPTIONS=!legacy,autopickup,pickup_types:$"=/!?+ HACKDIR - Default location of files NetHack needs. On Windows HACKDIR - defaults to the location of the NetHack.exe or NetHackw.exe - file so setting HACKDIR to override that is not usually neces- + Default location of files NetHack needs. On Windows HACKDIR + defaults to the location of the NetHack.exe or NetHackw.exe + file so setting HACKDIR to override that is not usually neces- sary or recommended. LEVELDIR - The location that in-progress level files are stored. Defaults + The location that in-progress level files are stored. Defaults to HACKDIR, must be writable. SAVEDIR - The location where saved games are kept. Defaults to HACKDIR, + The location where saved games are kept. Defaults to HACKDIR, must be writable. BONESDIR - The location that bones files are kept. Defaults to HACKDIR, + The location that bones files are kept. Defaults to HACKDIR, must be writable. LOCKDIR @@ -3792,37 +3812,17 @@ Defaults to HACKDIR, must be writable. TROUBLEDIR - The location that a record of game aborts and self-diagnosed + The location that a record of game aborts and self-diagnosed game problems is kept. Defaults to HACKDIR, must be writable. AUTOCOMPLETE Enable or disable an extended command autocompletion. Autocom- - pletion has no effect for the X11 windowport. You can specify - multiple autocompletions. To enable autocompletion, list the - extended command. Prefix the command with "!" to disable the - autocompletion for that command. - - Example: - - AUTOCOMPLETE=zap,!annotate - - AUTOPICKUP_EXCEPTION - Set exceptions to the pickup_types option. See the "Configur- - ing Autopickup Exceptions" section. - - BINDINGS - Change the key bindings of some special keys, menu accelera- - tors, extended commands, or mouse buttons. You can specify - multiple bindings. Format is key followed by the command, sep- - arated by a colon. See the "Changing Key Bindings" section for - more information. - - Example: - - BIND=^X:getpos.autodescribe + pletion has no effect for the X11 windowport. You can specify + multiple autocompletions. To enable autocompletion, list the + extended command. Prefix the command with "!" to disable the - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -3832,8 +3832,29 @@ + autocompletion for that command. + + Example: + + AUTOCOMPLETE=zap,!annotate + + AUTOPICKUP_EXCEPTION + Set exceptions to the pickup_types option. See the "Configur- + ing Autopickup Exceptions" section. + + BINDINGS + Change the key bindings of some special keys, menu accelera- + tors, extended commands, or mouse buttons. You can specify + multiple bindings. Format is key followed by the command, sep- + arated by a colon. See the "Changing Key Bindings" section for + more information. + + Example: + + BIND=^X:getpos.autodescribe + CHOOSE - Chooses at random one of the comma-separated parameters as an + Chooses at random one of the comma-separated parameters as an active section name. Lines in other sections are ignored. Example: @@ -3847,9 +3868,9 @@ [] #end of CHOOSE OPTIONS=!rest_on_space - If [] is present, the preceding section is closed and no new - section begins; whatever follows will be common to all sec- - tions. Otherwise the last section extends to the end of the + If [] is present, the preceding section is closed and no new + section begins; whatever follows will be common to all sec- + tions. Otherwise the last section extends to the end of the options file. MENUCOLOR @@ -3857,38 +3878,17 @@ ing Menu Colors" section. MSGTYPE - Change the way messages are shown in the top status line. See + Change the way messages are shown in the top status line. See the "Configuring Message Types" section. ROGUESYMBOLS - Custom symbols for for the rogue level's symbol set. See SYM- + Custom symbols for for the rogue level's symbol set. See SYM- BOLS below. - SOUND - Define a sound mapping. See the "Configuring User Sounds" sec- - tion. - - SOUNDDIR - Define the directory that contains the sound files. See the - "Configuring User Sounds" section. - - SYMBOLS - Override one or more symbols in the symbol set used for all - dungeon levels except for the special rogue level. See the - "Modifying NetHack Symbols" section. - - Example: - - # replace small punctuation (tick marks) with digits - SYMBOLS=S_boulder:0,S_golem:7 - - WIZKIT - Debug mode only: extra items to add to initial inventory. - Value is the name of a text file containing a list of item - names, one per line, up to a maximum of 128 lines. Each line - NetHack 3.7 October 27, 2022 + + NetHack 3.7 November 23, 2022 @@ -3898,6 +3898,28 @@ + SOUND + Define a sound mapping. See the "Configuring User Sounds" sec- + tion. + + SOUNDDIR + Define the directory that contains the sound files. See the + "Configuring User Sounds" section. + + SYMBOLS + Override one or more symbols in the symbol set used for all + dungeon levels except for the special rogue level. See the + "Modifying NetHack Symbols" section. + + Example: + + # replace small punctuation (tick marks) with digits + SYMBOLS=S_boulder:0,S_golem:7 + + WIZKIT + Debug mode only: extra items to add to initial inventory. + Value is the name of a text file containing a list of item + names, one per line, up to a maximum of 128 lines. Each line is processed by the function that handles wishing. Example: @@ -3928,33 +3950,11 @@ 9.3. Using the NETHACKOPTIONS environment variable - The NETHACKOPTIONS variable is a comma-separated list of - initial values for the various options. Some can only be turned - on or off. You turn one of these on by adding the name of the - option to the list, and turn it off by typing a `!' or "no" be- - fore the name. Others take a character string as a value. You - can set string options by typing the option name, a colon or - equals sign, and then the value of the string. The value is ter- - minated by the next comma or the end of string. - - For example, to set up an environment variable so that color - is on, legacy is off, character name is set to "Blue Meanie", and - named fruit is set to "lime", you would enter the command - - % setenv NETHACKOPTIONS "color,\!leg,name:Blue Meanie,fruit:lime" - - in csh (note the need to escape the `!' since it's special to - that shell), or the pair of commands - - $ NETHACKOPTIONS="color,!leg,name:Blue Meanie,fruit:lime" - $ export NETHACKOPTIONS - - in sh, ksh, or bash. + The NETHACKOPTIONS variable is a comma-separated list of + initial values for the various options. Some can only be turned - - - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -3964,63 +3964,63 @@ + on or off. You turn one of these on by adding the name of the + option to the list, and turn it off by typing a `!' or "no" be- + fore the name. Others take a character string as a value. You + can set string options by typing the option name, a colon or + equals sign, and then the value of the string. The value is ter- + minated by the next comma or the end of string. + + For example, to set up an environment variable so that color + is on, legacy is off, character name is set to "Blue Meanie", and + named fruit is set to "lime", you would enter the command + + % setenv NETHACKOPTIONS "color,\!leg,name:Blue Meanie,fruit:lime" + + in csh (note the need to escape the `!' since it's special to + that shell), or the pair of commands + + $ NETHACKOPTIONS="color,!leg,name:Blue Meanie,fruit:lime" + $ export NETHACKOPTIONS + + in sh, ksh, or bash. + The NETHACKOPTIONS value is effectively the same as a single OPTIONS directive in a configuration file. The "OPTIONS=" prefix - is implied and comma separated options are processed from right + is implied and comma separated options are processed from right to left. Other types of configuration directives such as BIND or MSGTYPE are not allowed. Instead of a comma-separated list of options, NETHACKOPTIONS - can be set to the full name of a configuration file you want to - use. If that full name doesn't start with a slash, precede it - with `@' (at-sign) to let NetHack know that the rest is intended - as a file name. If it does start with `/', the at-sign is op- + can be set to the full name of a configuration file you want to + use. If that full name doesn't start with a slash, precede it + with `@' (at-sign) to let NetHack know that the rest is intended + as a file name. If it does start with `/', the at-sign is op- tional. 9.4. Customization options Here are explanations of what the various options do. Char- - acter strings that are too long may be truncated. Some of the + 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 + Some options are persistent, and are saved and reloaded along with the game. Changing a persistent option in the config- uration file applies only to new games. acoustics - Enable messages about what your character hears (default on). + Enable messages about what your character hears (default on). Note that this has nothing to do with your computer's audio ca- pabilities. Persistent. align - Your starting alignment (align:lawful, align:neutral, or - align:chaotic). You may specify just the first letter. The - default is to randomly pick an appropriate alignment. If you - prefix the value with `!' or "no", you will exclude that align- - ment from being picked randomly. Cannot be set with the `O' - command. Persistent. - - autodescribe - Automatically describe the terrain under cursor when asked to - get a location on the map (default true). The whatis_coord op- - tion controls whether the description includes map coordinates. - - autodig - Automatically dig if you are wielding a digging tool and moving - into a place that can be dug (default false). Persistent. - - autoopen - Walking into a closed door attempts to open it (default true). - Persistent. - - autopickup - Automatically pick up things onto which you move (default off). - Persistent. + Your starting alignment (align:lawful, align:neutral, or + align:chaotic). You may specify just the first letter. The + default is to randomly pick an appropriate alignment. If you + prefix the value with `!' or "no", you will exclude that - - - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -4030,63 +4030,63 @@ - See pickup_types and also autopickup_exception for ways to re- + alignment from being picked randomly. Cannot be set with the + `O' command. Persistent. + + autodescribe + Automatically describe the terrain under cursor when asked to + get a location on the map (default true). The whatis_coord op- + tion controls whether the description includes map coordinates. + + autodig + Automatically dig if you are wielding a digging tool and moving + into a place that can be dug (default false). Persistent. + + autoopen + Walking into a closed door attempts to open it (default true). + Persistent. + + autopickup + Automatically pick up things onto which you move (default off). + Persistent. + + See pickup_types and also autopickup_exception for ways to re- fine the behavior. Note: prior to version 3.7, the default for autopickup was on. autoquiver - This option controls what happens when you attempt the `f' - (fire) command when nothing is quivered or readied (default - false). When true, the computer will fill your quiver or - quiver sack or make ready some suitable weapon. Note that it - will not take into account the blessed/cursed status, enchant- + This option controls what happens when you attempt the `f' + (fire) command when nothing is quivered or readied (default + false). When true, the computer will fill your quiver or + quiver sack or make ready some suitable weapon. Note that it + will not take into account the blessed/cursed status, enchant- ment, damage, or quality of the weapon; you are free to manual- - ly fill your quiver or quiver sack or make ready with the `Q' + ly fill your quiver or quiver sack or make ready with the `Q' command instead. If no weapon is found or the option is false, the `t' (throw) command is executed instead. Persistent. autounlock - Controls what action to take when attempting to walk into a - locked door or to loot a locked container. Takes a plus-sign + Controls what action to take when attempting to walk into a + locked door or to loot a locked container. Takes a plus-sign separated list of values: - Untrap - prompt about whether to attempt to find a trap; it - might fail to find one even when present; if it - does find one, it will ask whether you want to try - to disarm the trap; if you decline, your character + Untrap - prompt about whether to attempt to find a trap; it + might fail to find one even when present; if it + does find one, it will ask whether you want to try + to disarm the trap; if you decline, your character will forget that the door or box is trapped; - Apply-Key - if carrying a key or other unlocking tool, prompt + Apply-Key - if carrying a key or other unlocking tool, prompt about using it; Kick - kick the door (if you omit untrap or decline to at- - tempt untrap and you omit apply-key or you lack a + tempt untrap and you omit apply-key or you lack a key or you decline to use the key; has no effect on containers); - Force - try to force a container's lid with your currently - wielded weapon (if you omit untrap or decline to - attempt untrap and you omit apply-key or you lack a - key or you decline to use the key; has no effect on - doors); - None - none of the above; can't be combined with the other - choices. - - Omitting the value is treated as if autounlock:apply-key. Pre- - ceding autounlock with `!' or "no" is treated as autoun- - lock:none. - - Applying a key might set off a trap if the door or container is - trapped. Successfully kicking a door will break it and wake up - nearby monsters. Successfully forcing a container open will - break its lock and might also destroy some of its contents or - damage your weapon or both. - - The default is Apply-Key. Persistent. - - blind - Start the character permanently blind (default false). + Force - try to force a container's lid with your currently + wielded weapon (if you omit untrap or decline to - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -4096,44 +4096,76 @@ - Persistent. + attempt untrap and you omit apply-key or you lack a + key or you decline to use the key; has no effect on + doors); + None - none of the above; can't be combined with the other + choices. + + Omitting the value is treated as if autounlock:apply-key. Pre- + ceding autounlock with `!' or "no" is treated as autoun- + lock:none. + + Applying a key might set off a trap if the door or container is + trapped. Successfully kicking a door will break it and wake up + nearby monsters. Successfully forcing a container open will + break its lock and might also destroy some of its contents or + damage your weapon or both. + + The default is Apply-Key. Persistent. + + blind + Start the character permanently blind (default false). Persis- + tent. bones - Allow saving and loading bones files (default true). Persis- + Allow saving and loading bones files (default true). Persis- tent. boulder - Set the character used to display boulders (default is the + Set the character used to display boulders (default is the "large rock" class symbol, ``'). catname - Name your starting cat (for example "catname:Morris"). Cannot + Name your starting cat (for example "catname:Morris"). Cannot be set with the `O' command. character - Synonym for "role" to pick the type of your character (for ex- + Synonym for "role" to pick the type of your character (for ex- ample "character:Monk"). See role for more details. checkpoint - Save game state after each level change, for possible recovery + Save game state after each level change, for possible recovery after program crash (default on). Persistent. cmdassist - Have the game provide some additional command assistance for - new players if it detects some anticipated mistakes (default + Have the game provide some additional command assistance for + new players if it detects some anticipated mistakes (default on). confirm - Have user confirm attacks on pets, shopkeepers, and other + Have user confirm attacks on pets, shopkeepers, and other peaceable creatures (default on). Persistent. dark_room Show out-of-sight areas of lit rooms (default on). Persistent. + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 64 + + + disclose - Controls what information the program reveals when the game - ends. Value is a space separated list of prompting/category - pairs (default is "ni na nv ng nc no", prompt with default re- + Controls what information the program reveals when the game + ends. Value is a space separated list of prompting/category + pairs (default is "ni na nv ng nc no", prompt with default re- sponse of `n' for each candidate). Persistent. The possibili- ties are: @@ -4144,52 +4176,38 @@ c - display your conduct; also achievements, if any; o - display dungeon overview. - Each disclosure possibility can optionally be preceded by a - prefix which lets you refine how it behaves. Here are the + Each disclosure possibility can optionally be preceded by a + prefix which lets you refine how it behaves. Here are the valid prefixes: - - - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 64 - - - y - prompt you and default to yes on the prompt; n - prompt you and default to no on the prompt; + - disclose it without prompting; - - do not disclose it and do not prompt. - The listing of vanquished monsters can be sorted, so there are + The listing of vanquished monsters can be sorted, so there are two additional choices for `v': ? - prompt you and default to ask on the prompt; # - disclose it without prompting, ask for sort order. Asking refers to picking one of the orderings from a menu. The - `+' disclose without prompting choice, or being prompted and + `+' disclose without prompting choice, or being prompted and answering `y' rather than `a', will default to showing monsters in the traditional order, from high level to low level. Omitted categories are implicitly added with `n' prefix. Spec- ified categories with omitted prefix implicitly use `+' prefix. - Order of the disclosure categories does not matter, program + Order of the disclosure categories does not matter, program display for end-of-game disclosure follows a set sequence. - (for example "disclose:yi na +v -g o") The example sets inven- + (for example "disclose:yi na +v -g o") The example sets inven- tory to prompt and default to yes, attributes to prompt and de- fault to no, vanquished to disclose without prompting, genocid- ed to not disclose and not prompt, conduct to implicitly prompt and default to no, and overview to disclose without prompting. - Note that the vanquished monsters list includes all monsters + Note that the vanquished monsters list includes all monsters killed by traps and each other as well as by you. And the dun- geon overview shows all levels you had visited but does not re- veal things about them that you hadn't discovered. @@ -4198,27 +4216,9 @@ Name your starting dog (for example "dogname:Fang"). Cannot be set with the `O' command. - extmenu - Changes the extended commands interface to pop-up a menu of - available commands. It is keystroke compatible with the tradi- - tional interface except that it does not require that you hit - Enter. It is implemented for the tty interface (default off). - - For the X11 interface, which always uses a menu for choosing an - extended command, it controls whether the menu shows all avail- - able commands (on) or just the subset of commands which have - traditionally been considered extended ones (off). - - female - An obsolete synonym for "gender:female". Cannot be set with - the `O' command. - - fireassist - This option controls what happens when you attempt the `f' - (fire) and don't have an appropriate launcher, such as a bow or - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -4228,63 +4228,63 @@ - a sling, wielded. If on, you will automatically wield the + extmenu + Changes the extended commands interface to pop-up a menu of + available commands. It is keystroke compatible with the tradi- + tional interface except that it does not require that you hit + Enter. It is implemented for the tty interface (default off). + + For the X11 interface, which always uses a menu for choosing an + extended command, it controls whether the menu shows all avail- + able commands (on) or just the subset of commands which have + traditionally been considered extended ones (off). + + female + An obsolete synonym for "gender:female". Cannot be set with + the `O' command. + + fireassist + This option controls what happens when you attempt the `f' + (fire) and don't have an appropriate launcher, such as a bow or + a sling, wielded. If on, you will automatically wield the launcher. Default is on. fixinv - An object's inventory letter sticks to it when it's dropped - (default on). If this is off, dropping an object shifts all + An object's inventory letter sticks to it when it's dropped + (default on). If this is off, dropping an object shifts all the remaining inventory letters. Persistent. force_invmenu - Commands asking for an inventory item show a menu instead of a + Commands asking for an inventory item show a menu instead of a text query with possible menu letters. Default is off. fruit - Name a fruit after something you enjoy eating (for example - "fruit:mango") (default "slime mold"). Basically a nostalgic - whimsy that NetHack uses from time to time. You should set - this to something you find more appetizing than slime mold. - Apples, oranges, pears, bananas, and melons already exist in + Name a fruit after something you enjoy eating (for example + "fruit:mango") (default "slime mold"). Basically a nostalgic + whimsy that NetHack uses from time to time. You should set + this to something you find more appetizing than slime mold. + Apples, oranges, pears, bananas, and melons already exist in NetHack, so don't use those. gender - Your starting gender (gender:male or gender:female). You may - specify just the first letter. Although you can still denote + Your starting gender (gender:male or gender:female). You may + specify just the first letter. Although you can still denote your gender using the "male" and "female" options, the "gender" - option will take precedence. The default is to randomly pick - an appropriate gender. If you prefix the value with `!' or - "no", you will exclude that gender from being picked randomly. + option will take precedence. The default is to randomly pick + an appropriate gender. If you prefix the value with `!' or + "no", you will exclude that gender from being picked randomly. Cannot be set with the `O' command. Persistent. goldX - When filtering objects based on bless/curse state (BUCX), - whether to treat gold pieces as X (unknown bless/curse state, - when "on") or U (known to be uncursed, when "off", the de- - fault). Gold is never blessed or cursed, but it is not de- + When filtering objects based on bless/curse state (BUCX), + whether to treat gold pieces as X (unknown bless/curse state, + when "on") or U (known to be uncursed, when "off", the de- + fault). Gold is never blessed or cursed, but it is not de- scribed as "uncursed" even when the implicit_uncursed option is "off". - help - If more information is available for an object looked at with - the `/' command, ask if you want to see it (default on). Turn- - ing help off makes just looking at things faster, since you - aren't interrupted with the "More info?" prompt, but it also - means that you might miss some interesting and/or important in- - formation. Persistent. - herecmd_menu - When using a windowport that supports mouse and clicking on - yourself or next to you, show a menu of possible actions for - the location. Same as "#herecmdmenu" and "#therecmdmenu" com- - mands. - - hilite_pet - Visually distinguish pets from similar animals (default off). - The behavior of this option depends on the type of windowing - - - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -4294,28 +4294,45 @@ + help + If more information is available for an object looked at with + the `/' command, ask if you want to see it (default on). Turn- + ing help off makes just looking at things faster, since you + aren't interrupted with the "More info?" prompt, but it also + means that you might miss some interesting and/or important in- + formation. Persistent. + + herecmd_menu + When using a windowport that supports mouse and clicking on + yourself or next to you, show a menu of possible actions for + the location. Same as "#herecmdmenu" and "#therecmdmenu" com- + mands. + + hilite_pet + Visually distinguish pets from similar animals (default off). + The behavior of this option depends on the type of windowing you use. In text windowing, text highlighting or inverse video - is often used; with tiles, generally displays a heart symbol + is often used; with tiles, generally displays a heart symbol near pets. - With the curses interface, the petattr option controls how to - highlight pets and setting it will turn the hilite_pet option + With the curses interface, the petattr option controls how to + highlight pets and setting it will turn the hilite_pet option on or off as warranted. hilite_pile - Visually distinguish piles of objects from individual objects + Visually distinguish piles of objects from individual objects (default off). The behavior of this option depends on the type - of windowing you use. In text windowing, text highlighting or - inverse video is often used; with tiles, generally displays a + of windowing you use. In text windowing, text highlighting or + inverse video is often used; with tiles, generally displays a small plus-symbol beside the object on the top of the pile. hitpointbar - Show a hit point bar graph behind your name and title. Only - available for TTY and Windows GUI, and only when statushilites + Show a hit point bar graph behind your name and title. Only + available for TTY and Windows GUI, and only when statushilites is on. horsename - Name your starting horse (for example "horsename:Trigger"). + Name your starting horse (for example "horsename:Trigger"). Cannot be set with the `O' command. ignintr @@ -4324,33 +4341,16 @@ implicit_uncursed Omit "uncursed" from object descriptions when it can be deduced - from other aspects of the description (default on). Persis- + from other aspects of the description (default on). Persis- tent. If you use menu coloring, you may want to turn this off. legacy Display an introductory message when starting the game (default - on). Persistent. - - lit_corridor - Show corridor squares seen by night vision or a light source - held by your character as lit (default off). Persistent. - - lootabc - When using a menu to interact with a container, use the old - `a', `b', and `c' keyboard shortcuts rather than the mnemonics - `o', `i', and `b' (default off). Persistent. - - mail - Enable mail delivery during the game (default on). Persistent. - - male - An obsolete synonym for "gender:male". Cannot be set with the - `O' command. - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -4360,41 +4360,72 @@ + on). Persistent. + + lit_corridor + Show corridor squares seen by night vision or a light source + held by your character as lit (default off). Persistent. + + lootabc + When using a menu to interact with a container, use the old + `a', `b', and `c' keyboard shortcuts rather than the mnemonics + `o', `i', and `b' (default off). Persistent. + + mail + Enable mail delivery during the game (default on). Persistent. + + male + An obsolete synonym for "gender:male". Cannot be set with the + `O' command. + mention_decor - Give feedback when walking onto various dungeon features such - as stairs, fountains, or altars which are ordinarily only de- - scribed when covered by one or more objects (default off). + Give feedback when walking onto various dungeon features such + as stairs, fountains, or altars which are ordinarily only de- + scribed when covered by one or more objects (default off). Persistent. mention_walls - Give feedback when walking against a wall (default off). Per- + Give feedback when walking against a wall (default off). Per- sistent. menucolors - Enable coloring menu lines (default off). See "Configuring + Enable coloring menu lines (default off). See "Configuring Menu Colors" on how to configure the colors. menustyle Controls the interface used when you need to choose various ob- - jects (in response to the Drop command, for instance). The - value specified should be the first letter of one of the fol- - lowing: traditional, combination, full, or partial. Persis- + jects (in response to the Drop command, for instance). The + value specified should be the first letter of one of the fol- + lowing: traditional, combination, full, or partial. Persis- tent. - Traditional was the only interface available for very early - versions; it consists of a prompt for object class characters, - followed by an object-by-object prompt for all items matching - the selected object class(es). Combination starts with a - prompt for object class(es) of interest, but then displays a - menu of matching objects rather than prompting one-by-one. - Full displays a menu of object classes rather than a character - prompt, and then a menu of matching objects for selection. - Partial skips the object class filtering and immediately dis- + Traditional was the only interface available for very early + versions; it consists of a prompt for object class characters, + followed by an object-by-object prompt for all items matching + the selected object class(es). Combination starts with a + prompt for object class(es) of interest, but then displays a + menu of matching objects rather than prompting one-by-one. + Full displays a menu of object classes rather than a character + prompt, and then a menu of matching objects for selection. + Partial skips the object class filtering and immediately dis- plays a menu of all objects. menu_deselect_all Key to deselect all items in a menu. Default `-'. + + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 68 + + + menu_deselect_page Key to deselect all items on this page of a menu. Default `\'. @@ -4402,8 +4433,8 @@ Key to jump to the first page in a menu. Default `^'. menu_headings - Controls how the headings in a menu are highlighted. Values - are "none", "bold", "dim", "italic", "underline", "blink", or + Controls how the headings in a menu are highlighted. Values + are "none", "bold", "dim", "italic", "underline", "blink", or "inverse". Not all ports can actually display all types. menu_invert_all @@ -4415,34 +4446,23 @@ menu_last_page Key to jump to the last page in a menu. Default `|'. - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 68 - - - menu_next_page Key to go to the next menu page. Default `>'. menu_objsyms - Show object symbols in menu headings in menus where the object + Show object symbols in menu headings in menus where the object symbols act as menu accelerators (default off). menu_overlay - Do not clear the screen before drawing menus, and align menus - to the right edge of the screen. Only for the tty port. (de- + Do not clear the screen before drawing menus, and align menus + to the right edge of the screen. Only for the tty port. (de- fault on) menu_previous_page Key to go to the previous menu page. Default `<'. menu_search - Key to search for some text and toggle selection state of + Key to search for some text and toggle selection state of matching menu items. Default `:'. menu_select_all @@ -4452,37 +4472,17 @@ Key to select all items on this page of a menu. Default `,'. menu_shift_left - Key to scroll a menu--one which has been scrolled right--back - to the left. Implemented for perm_invent only by curses and + Key to scroll a menu--one which has been scrolled right--back + to the left. Implemented for perm_invent only by curses and X11. Default `{'. menu_shift_right - Key to scroll a menu which has text beyond the right edge to + Key to scroll a menu which has text beyond the right edge to the right. Implemented for perm_invent only by curses and X11. Default `}'. - monpolycontrol - Prompt for new form whenever any monster changes shape (default - off). Debug mode only. - mouse_support - Allow use of the mouse for input and travel. Valid settings - are: - - 0 - disabled - 1 - enabled and make OS adjustments to support mouse use - 2 - like 1 but does not make any OS adjustments - - Omitting a value is the same as specifying 1 and negating - mouse_support is the same as specifying 0. - - msghistory - The number of top line messages to keep (and be able to recall - with `^P') (default 20). Cannot be set with the `O' command. - - - - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -4492,10 +4492,29 @@ + monpolycontrol + Prompt for new form whenever any monster changes shape (default + off). Debug mode only. + + mouse_support + Allow use of the mouse for input and travel. Valid settings + are: + + 0 - disabled + 1 - enabled and make OS adjustments to support mouse use + 2 - like 1 but does not make any OS adjustments + + Omitting a value is the same as specifying 1 and negating + mouse_support is the same as specifying 0. + + msghistory + The number of top line messages to keep (and be able to recall + with `^P') (default 20). Cannot be set with the `O' command. + msg_window - Allows you to change the way recalled messages are displayed. - Currently it is only supported for tty (all four choices) and - for curses (`f' and `r' choices, default `r'). The possible + Allows you to change the way recalled messages are displayed. + Currently it is only supported for tty (all four choices) and + for curses (`f' and `r' choices, default `r'). The possible values are: s - single message (default; only choice prior to 3.4.0); @@ -4503,16 +4522,16 @@ 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 + For backward compatibility, no value needs to be specified + (which defaults to "full"), or it can be negated (which defaults to "single"). name - Set your character's name (defaults to your user name). You - can also set your character's role by appending a dash and one + Set your character's name (defaults to your user name). You + can also set your character's role by appending a dash and one or more letters of the role (that is, by suffixing one of -A -B - -C -H -K -M -P -Ra -Ro -S -T -V -W). If -@ is used for the - role, then a random one will be automatically chosen. Cannot + -C -H -K -M -P -Ra -Ro -S -T -V -W). If -@ is used for the + role, then a random one will be automatically chosen. Cannot be set with the `O' command. news @@ -4526,29 +4545,10 @@ null Send padding nulls to the terminal (default on). Persistent. - number_pad - Use digit keys instead of letters to move (default 0 or off). - Valid settings are: - - 0 - move by letters; "yuhjklbn" - 1 - move by numbers; digit `5' acts as `G' movement prefix - 2 - like 1 but `5' works as `g' prefix instead of as `G' - 3 - by numbers using phone key layout; 123 above, 789 below - 4 - combines 3 with 2; phone layout plus MS-DOS compatibility - -1 - by letters but use `z' to go northwest, `y' to zap wands - - For backward compatibility, omitting a value is the same as - specifying 1 and negating number_pad is the same as specifying - 0. (Settings 2 and 4 are for compatibility with MS-DOS or old - PC Hack; in addition to the different behavior for `5', `Alt-5' - acts as `G' and `Alt-0' acts as `I'. Setting -1 is to accommo- - date some QWERTZ keyboards which have the location of the `y' - and `z' keys swapped.) When moving by numbers, to enter a - count prefix for those commands which accept one (such as "12s" - to search twelve times), precede it with the letter `n' - NetHack 3.7 October 27, 2022 + + NetHack 3.7 November 23, 2022 @@ -4558,63 +4558,63 @@ + number_pad + Use digit keys instead of letters to move (default 0 or off). + Valid settings are: + + 0 - move by letters; "yuhjklbn" + 1 - move by numbers; digit `5' acts as `G' movement prefix + 2 - like 1 but `5' works as `g' prefix instead of as `G' + 3 - by numbers using phone key layout; 123 above, 789 below + 4 - combines 3 with 2; phone layout plus MS-DOS compatibility + -1 - by letters but use `z' to go northwest, `y' to zap wands + + For backward compatibility, omitting a value is the same as + specifying 1 and negating number_pad is the same as specifying + 0. (Settings 2 and 4 are for compatibility with MS-DOS or old + PC Hack; in addition to the different behavior for `5', `Alt-5' + acts as `G' and `Alt-0' acts as `I'. Setting -1 is to accommo- + date some QWERTZ keyboards which have the location of the `y' + and `z' keys swapped.) When moving by numbers, to enter a + count prefix for those commands which accept one (such as "12s" + to search twelve times), precede it with the letter `n' ("n12s"). packorder - Specify the order to list object types in (default + Specify the order to list object types in (default "")[%?+!=/(*`0_"). The value of this option should be a string containing the symbols for the various object types. Any omit- ted types are filled in at the end from the previous order. paranoid_confirmation - A space separated list of specific situations where alternate + A space separated list of specific situations where alternate prompting is desired. The default is "paranoid_confirma- tion:pray swim". - Confirm - for any prompts which are set to require "yes" - rather than `y', also require "no" to reject in- + Confirm - for any prompts which are set to require "yes" + rather than `y', also require "no" to reject in- stead of accepting any non-yes response as no quit - require "yes" rather than `y' to confirm quitting - the game or switching into non-scoring explore + the game or switching into non-scoring explore mode; - die - require "yes" rather than `y' to confirm dying - (not useful in normal play; applies to explore + die - require "yes" rather than `y' to confirm dying + (not useful in normal play; applies to explore mode); - bones - require "yes" rather than `y' to confirm saving + bones - require "yes" rather than `y' to confirm saving bones data when dying in debug mode; - attack - require "yes" rather than `y' to confirm attack- + attack - require "yes" rather than `y' to confirm attack- ing a peaceful monster; wand-break - require "yes" rather than `y' to confirm breaking a wand; - eating - require "yes" rather than `y' to confirm whether + eating - require "yes" rather than `y' to confirm whether to continue eating; Were-change - require "yes" rather than `y' to confirm changing - form due to lycanthropy when hero has polymorph + form due to lycanthropy when hero has polymorph control; - pray - require `y' to confirm an attempt to pray rather - than immediately praying; on by default; - Remove - require selection from inventory for `R' and `T' - commands even when wearing just one applicable - item. - swim - prevent walking into water or lava. - 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 + pray - require `y' to confirm an attempt to pray rather - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -4624,7 +4624,27 @@ - showing pets on the map. Effectively a superset of the + than immediately praying; on by default; + Remove - require selection from inventory for `R' and `T' + commands even when wearing just one applicable + item. + swim - prevent walking into water or lava. + 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 hilite_pet boolean option. Curses interface only; value is one or more of the following letters. @@ -4638,49 +4658,29 @@ 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. - (Default `S'). Persistent. - - pickup_thrown - If this option is on and autopickup is also on, try to pick up - things that you threw, even if they aren't in pickup_types or - match an autopickup exception. Default is on. Persistent. - - pickup_types - Specify the object types to be picked up when autopickup is on. - Default is all types. Persistent. - - The value is a list of object symbols, such as pickup_types:$?! - to pick up gold, scrolls, and potions. You can use autopick- - up_exception configuration file lines to further refine au- - topickup behavior. - - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -4690,63 +4690,63 @@ - There is no way to set pickup_types to "none". (Setting it to - an empty value reverts to "all".) If you want to avoid auto- + pickup_burden + When you pick up an item that would exceed this encumbrance + level (Unencumbered, Burdened, streSsed, straiNed, overTaxed, + or overLoaded), you will be asked if you want to continue. + (Default `S'). Persistent. + + pickup_thrown + If this option is on and autopickup is also on, try to pick up + things that you threw, even if they aren't in pickup_types or + match an autopickup exception. Default is on. Persistent. + + pickup_types + Specify the object types to be picked up when autopickup is on. + Default is all types. Persistent. + + The value is a list of object symbols, such as pickup_types:$?! + to pick up gold, scrolls, and potions. You can use autopick- + up_exception configuration file lines to further refine au- + topickup behavior. + + There is no way to set pickup_types to "none". (Setting it to + an empty value reverts to "all".) If you want to avoid auto- matically picking up any types of items but do want to have au- topickup on in order to have autopickup_exception settings con- trol what you do and don't pick up, you can set pickup_types to - `.'. That is the type symbol for venom and you won't come + `.'. That is the type symbol for venom and you won't come across any venom items so won't unintentionally pick such up. pile_limit - When walking across a pile of objects on the floor, threshold - at which the message "there are few/several/many objects here" - is given instead of showing a popup list of those objects. A - value of 0 means "no limit" (always list the objects); a value - of 1 effectively means "never show the objects" since the pile - size will always be at least that big; default value is 5. + When walking across a pile of objects on the floor, threshold + at which the message "there are few/several/many objects here" + is given instead of showing a popup list of those objects. A + value of 0 means "no limit" (always list the objects); a value + of 1 effectively means "never show the objects" since the pile + size will always be at least that big; default value is 5. Persistent. playmode - Values are "normal", "explore", or "debug". Allows selection - of explore mode (also known as discovery mode) or debug mode + Values are "normal", "explore", or "debug". Allows selection + of explore mode (also known as discovery mode) or debug mode (also known as wizard mode) instead of normal play. Debug mode - might only be allowed for someone logged in under a particular - user name (on multi-user systems) or specifying a particular + might only be allowed for someone logged in under a particular + user name (on multi-user systems) or specifying a particular character name (on single-user systems) or it might be disabled - entirely. Requesting it when not allowed or not possible re- + entirely. Requesting it when not allowed or not possible re- sults in explore mode instead. Default is normal play. pushweapon - Using the `w' (wield) command when already wielding something - pushes the old item into your alternate weapon slot (default - off). Likewise for the `a' (apply) command if it causes the + Using the `w' (wield) command when already wielding something + pushes the old item into your alternate weapon slot (default + off). Likewise for the `a' (apply) command if it causes the applied item to become wielded. Persistent. - quick_farsight - When set, usually prevents the "you sense your surroundings" - message where play pauses to allow you to browse the map when- - ever clairvoyance randomly activates. Some situations, such as - being underwater or engulfed, ignore this option. It does not - affect the clairvoyance spell where pausing to examine revealed - objects or monsters is less intrusive. Default is off. Per- - sistent. - - race - Selects your race (for example, "race:human"). Default is ran- - dom. If you prefix the value with `!' or "no", you will ex- - clude that race from being picked randomly. Cannot be set with - the `O' command. Persistent. - - rest_on_space - Make the space bar a synonym for the `.' (#wait) command (de- - fault off). Persistent. - - role - Pick your type of character (for example "role:Samurai"); - NetHack 3.7 October 27, 2022 + + NetHack 3.7 November 23, 2022 @@ -4756,27 +4756,48 @@ - synonym 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", + quick_farsight + When set, usually prevents the "you sense your surroundings" + message where play pauses to allow you to browse the map when- + ever clairvoyance randomly activates. Some situations, such as + being underwater or engulfed, ignore this option. It does not + affect the clairvoyance spell where pausing to examine revealed + objects or monsters is less intrusive. Default is off. Per- + sistent. + + race + Selects your race (for example, "race:human"). Default is ran- + dom. If you prefix the value with `!' or "no", you will ex- + clude that race from being picked randomly. Cannot be set with + the `O' command. Persistent. + + rest_on_space + Make the space bar a synonym for the `.' (#wait) command (de- + fault off). Persistent. + + role + Pick your type of character (for example "role:Samurai"); syn- + onym for "character". See "name" for an alternate method of + specifying your role. Normally only the first letter of the + value is examined; `r' is an exception with "Rogue", "Ranger", and "random" values. If you prefix the value with `!' or "no", - you will exclude that role from being picked randomly. Cannot + 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 + 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 + 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; @@ -4785,34 +4806,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). - Persistent. - safe_wait - Prevents you from waiting or searching when next to a hostile - monster (default on). Persistent. - - sanity_check - Evaluate monsters, objects, and map prior to each turn (default - off). Debug mode only. - - scores - Control what parts of the score list you are shown at the end - (for example "scores:5 top scores/4 around my score/own - scores"). Only the first letter of each category (`t', `a', or - `o') is necessary. Persistent. - - showexp - Show your accumulated experience points on bottom line (default - - - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -4822,12 +4822,32 @@ + safe_pet + Prevent you from (knowingly) attacking your pets (default on). + Persistent. + + safe_wait + Prevents you from waiting or searching when next to a hostile + monster (default on). Persistent. + + sanity_check + Evaluate monsters, objects, and map prior to each turn (default + off). Debug mode only. + + scores + Control what parts of the score list you are shown at the end + (for example "scores:5 top scores/4 around my score/own + scores"). Only the first letter of each category (`t', `a', or + `o') is necessary. Persistent. + + showexp + Show your accumulated experience points on bottom line (default off). Persistent. showrace - Display yourself as the glyph for your race, rather than the - glyph for your role (default off). Note that this setting 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 @@ -4843,42 +4863,22 @@ The possible values are: - o - list object types by class, in discovery order within each + o - list object types by class, in discovery order within each class; default; - s - list object types by sortloot classification: by class, by - sub-class within class for classes which have substantial - groupings (like helmets, boots, gloves, and so forth for - armor), with object types partly-discovered via assigned + s - list object types by sortloot classification: by class, by + sub-class within class for classes which have substantial + groupings (like helmets, boots, gloves, and so forth for + armor), with object types partly-discovered via assigned name coming before fully identified types; c - list by class, alphabetically within each class; a - list alphabetically across all classes. - Can be interactively set via the `O' command or via using the + Can be interactively set via the `O' command or via using the `m' prefix before the `\' or ``' command. - sortloot - Controls the sorting behavior of the pickup lists for inventory - and #loot commands and some others. Persistent. - - The possible values are: - - full - always sort the lists; - loot - only sort the lists that don't use inventory letters, - like with the #loot and pickup commands; - none - show lists the traditional way without sorting; default. - - sortpack - Sort the pack contents by type when displaying inventory (de- - fault on). Persistent. - - sparkle - Display a sparkly effect when a monster (including yourself) is - hit by an attack to which it is resistant (default on). Per- - sistent. - - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -4888,63 +4888,63 @@ + sortloot + Controls the sorting behavior of the pickup lists for inventory + and #loot commands and some others. Persistent. + + The possible values are: + + full - always sort the lists; + loot - only sort the lists that don't use inventory letters, + like with the #loot and pickup commands; + none - show lists the traditional way without sorting; default. + + sortpack + Sort the pack contents by type when displaying inventory (de- + fault on). Persistent. + + sparkle + Display a sparkly effect when a monster (including yourself) is + hit by an attack to which it is resistant (default on). Per- + sistent. + standout Boldface monsters and "--More--" (default off). Persistent. statushilites - Controls how many turns status hilite behaviors highlight the - field. If negated or set to zero, disables status hiliting. + 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 + 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" and "curses" - interfaces only; "X11" interface always uses a timer based de- - lay. The default is on if configured into the program.) Per- + interfaces only; "X11" interface always uses a timer-based de- + lay. The default is on if configured into the program.) Per- sistent. - 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 via mouse click (default on). Turning - this option off will prevent the game from attempting unintend- - ed moves if you make inadvertent mouse clicks on the map win- - dow. Does not affect traveling via the `_' ("#travel") com- - mand. Persistent. - - - - - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -4954,14 +4954,32 @@ + 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 via mouse click (default on). Turning + this option off will prevent the game from attempting unintend- + ed moves if you make inadvertent mouse clicks on the map win- + dow. Does not affect traveling via the `_' ("#travel") com- + mand. Persistent. + verbose - Provide more commentary during the game (default on). Persis- + Provide more commentary during the game (default on). Persis- tent. whatis_coord - When using the `/' or `;' commands to look around on the map - with autodescribe on, display coordinates after the descrip- - tion. Also works in other situations where you are asked to + When using the `/' or `;' commands to look around on the map + with autodescribe on, display coordinates after the descrip- + tion. Also works in other situations where you are asked to pick a location. The possible settings are: @@ -4978,39 +4996,21 @@ whatis_filter When getting a location on the map, and using the keys to cycle - through next and previous targets, allows filtering the possi- + through next and previous targets, allows filtering the possi- ble targets. n - no filtering [default] v - in view only a - in same area only - The area-filter tries to be slightly predictive--if you're + The area-filter tries to be slightly predictive--if you're standing on a doorway, it will consider the area on the side of the door you were last moving towards. - Filtering can also be changed when getting a location with the - "getpos.filter" key. - - whatis_menu - When getting a location on the map, and using a key to cycle - through next and previous targets, use a menu instead to pick a - target. (default off) - - whatis_moveskip - When getting a location on the map, and using shifted movement - keys or meta-digit keys to fast-move, instead of moving 8 units - at a time, move by skipping the same glyphs. (default off) - - windowtype - When the program has been built to support multiple interfaces, - select which one to use, such as "tty" or "X11" (default de- - pends on build-time settings; use "#version" to check). Cannot - be set with the `O' command. - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -5020,10 +5020,29 @@ - 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 + Filtering can also be changed when getting a location with the + "getpos.filter" key. + + whatis_menu + When getting a location on the map, and using a key to cycle + through next and previous targets, use a menu instead to pick a + target. (default off) + + whatis_moveskip + When getting a location on the map, and using shifted movement + keys or meta-digit keys to fast-move, instead of moving 8 units + at a time, move by skipping the same glyphs. (default off) + + windowtype + When the program has been built to support multiple interfaces, + select which one to use, such as "tty" or "X11" (default de- + pends on build-time settings; use "#version" to check). Cannot + be set with the `O' command. + + When used, it should be the first option set since its value + might enable or disable the availability of various other op- + tions. For multiple lines in a configuration file, that would + be the first non-comment line. For a comma-separated list in NETHACKOPTIONS or an OPTIONS line in a configuration file, that would be the rightmost option in the list. @@ -5032,51 +5051,32 @@ 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 the map using simple charac- - ters (letters and punctuation) rather than tiles graphics. In - some cases, characters can be augmented with line-drawing sym- - bols; use the symset option to select a symbol set such as - DECgraphics or IBMgraphics if your display supports them. Set- - ting ascii_map to True forces tiled_map to be False. - - color - If NetHack can, it should display color if it can for different - monsters, objects, and dungeon features (default on). - - eight_bit_tty - If NetHack can, it should pass eight-bit character values (for - example, specified with the traps option) straight through to - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -5086,6 +5086,25 @@ + align_status + Where to align or place the status window (top, bottom, left, + or right). + + ascii_map + If NetHack can, it should display the map using simple charac- + ters (letters and punctuation) rather than tiles graphics. In + some cases, characters can be augmented with line-drawing sym- + bols; use the symset option to select a symbol set such as + DECgraphics or IBMgraphics if your display supports them. Set- + ting ascii_map to True forces tiled_map to be False. + + color + If NetHack can, it should display color if it can for different + monsters, objects, and dungeon features (default on). + + eight_bit_tty + If NetHack can, it should pass eight-bit character values (for + example, specified with the traps option) straight through to your terminal (default off). font_map @@ -5093,7 +5112,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 @@ -5105,44 +5124,25 @@ status window. font_text - If NetHack can, it should use a font by the chosen name for + If NetHack can, it should use a font by the chosen name for text windows. font_size_map - If NetHack can, it should use this size font for the map win- + If NetHack can, it should use this size font for the map win- dow. font_size_menu If NetHack can, it should use this size font for menu windows. font_size_message - If NetHack can, it should use this size font for the message + If NetHack can, it should use this size font for the message window. font_size_status - If NetHack can, it should use this size font for the status - window. - - font_size_text - If NetHack can, it should use this size font for text windows. - - fullscreen - If NetHack can, it should try and display on the entire screen - rather than in a window. - - guicolor - Use color text and/or highlighting attributes when displaying - some non-map data (such as menu selector letters). Curses in- - terface only; default is on. - - large_font - If NetHack can, it should use a large font. - - map_mode - If NetHack can, it should display the map in the manner + If NetHack can, it should use this size font for the status - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -5152,10 +5152,29 @@ - specified. + window. + + font_size_text + If NetHack can, it should use this size font for text windows. + + fullscreen + If NetHack can, it should try and display on the entire screen + rather than in a window. + + guicolor + Use color text and/or highlighting attributes when displaying + some non-map data (such as menu selector letters). Curses in- + terface only; default is on. + + large_font + If NetHack can, it should use a large font. + + map_mode + If NetHack can, it should display the map in the manner speci- + fied. player_selection - If NetHack can, it should pop up dialog boxes, or use prompts + If NetHack can, it should pop up dialog boxes, or use prompts for character selection. popup_dialog @@ -5163,52 +5182,33 @@ 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 - If NetHack can, it should display an opening splash screen when - it starts up (default yes). - - statuslines - Number of lines for traditional below-the-map status display. - Acceptable values are 2 and 3 (default is 2). - - When set to 3, the tty interface moves some fields around and - mainly shows status conditions on their own line. A display - capable of showing at least 25 lines is recommended. The value - can be toggled back and forth during the game with the `O' com- - mand. - - The curses interface does likewise if the align_status option - is set to top or bottom but ignores statuslines when set to - left or right. - - The Qt interface already displays more than 3 lines for status - so uses the statuslines value differently. A value of 3 - NetHack 3.7 October 27, 2022 + + NetHack 3.7 November 23, 2022 @@ -5218,10 +5218,33 @@ - renders status in the Qt interface's original format, with the + splash_screen + If NetHack can, it should display an opening splash screen when + it starts up (default yes). + + statuslines + Number of lines for traditional below-the-map status display. + Acceptable values are 2 and 3 (default is 2). + + When set to 3, the tty interface moves some fields around and + mainly shows status conditions on their own line. A display + capable of showing at least 25 lines is recommended. The value + can be toggled back and forth during the game with the `O' com- + mand. + + The curses interface does likewise if the align_status option + is set to top or bottom but ignores statuslines when set to + left or right. + + The Qt interface already displays more than 3 lines for status + so uses the statuslines value differently. A value of 3 ren- + ders status in the Qt interface's original format, with the status window spread out vertically. A value of 2 makes status be slightly condensed, moving some fields to different lines to - eliminate one whole line, reducing the height needed. + eliminate one whole line, reducing the height needed. (If + NetHack has been built using a version of Qt older than qt-5.9, + statuslines can only be set in the run-time configuration file + or via NETHACKOPTIONS, not during play with the `O' command.) term_cols and @@ -5248,9 +5271,21 @@ tiled_map If NetHack can, it should display the map using tiles graphics - rather than simple characters (letters and punctuation, possi- - bly augmented by line-drawing symbols). Setting tiled_map to - True forces ascii_map to be False. + rather than simple characters (letters and punctuation, + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 81 + + + + possibly augmented by line-drawing symbols). Setting tiled_map + to True forces ascii_map to be False. use_darkgray Use bold black instead of blue for black glyphs (TTY only). @@ -5268,22 +5303,6 @@ area, and persistent inventory window if enabled. Curses in- terface only. Acceptable values are - - - - - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 81 - - - 0 - off, never show borders 1 - on, always show borders 2 - auto, on if display is at least (24+2)x(80+2) [default] @@ -5318,8 +5337,20 @@ 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). + tion, menu, menutext, scrollbar, window, windowframe, + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 82 + + + + windowtext). wraptext If NetHack can, it should wrap long lines of text if they don't @@ -5339,17 +5370,6 @@ On Amiga, this option controls whether typing "Alt" plus anoth- er key functions as a meta-shift for that key (default on). - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 82 - - - altmeta On other (non-Amiga) systems where this option is available, it can be set to tell NetHack to convert a two character sequence @@ -5384,6 +5404,18 @@ 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). + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 83 + + + Note: DEC Rainbows hang if this is turned on. Cannot be set with the `O' command. @@ -5404,18 +5436,6 @@ fixed at 640x480 in 16 colors, a mode that is compatible with all VGA hardware. Third party tilesets will probably not work. Setting "autodetect" attempts "vesa", then "vga", and finally - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 83 - - - sets "default" if neither of those modes works. Cannot be set with the `O' command. @@ -5450,6 +5470,18 @@ 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 + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 84 + + + colors, and User sounds. 9.8. Configuring Autopickup Exceptions @@ -5470,18 +5502,6 @@ In addition, some characters are treated specially if they oc- cur as the first character in the pattern, specifically: - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 84 - - - < - always pickup an object that matches rest of pattern; > - never pickup an object that matches rest of pattern. @@ -5515,6 +5535,19 @@ a meta key ("M-x"), a mouse button, or a three-digit decimal ASCII code. + + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 85 + + + For example: BIND=^X:getpos.autodescribe @@ -5537,17 +5570,6 @@ You can bind "mouse1" or "mouse2" to "nothing", "therecmdmenu", "clicklook", or "mouseaction". - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 85 - - - Special command keys Below are the special commands you can rebind. Some of them can be bound to same keys with no problems, others are in the @@ -5580,6 +5602,18 @@ When asked for a direction, an alternate key to target your- self. Default is `s'. + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 86 + + + getpos.autodescribe When asked for a location, the key to toggle autodescribe. De- fault is `#'. @@ -5602,18 +5636,6 @@ getpos.help When asked for a location, the key to show help. Default is - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 86 - - - `?'. getpos.mon.next @@ -5646,6 +5668,18 @@ When asked for a location, change the filtering mode when using one of the next or previous keys to cycle through targets. Toggles between no filtering, in view only, and in the same + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 87 + + + area only. Default is `"'. getpos.pick @@ -5669,17 +5703,6 @@ When asked for a location, the key to choose the location, and show more info without asking. Default is `:'. - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 87 - - - getpos.self When asked for a location, the key to go to your location. De- fault is `@'. @@ -5712,6 +5735,17 @@ In general, the configuration file entries to describe the message types look like this: MSGTYPE=type "pattern" + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 88 + + + type - how the message should be shown; pattern - the pattern to match. @@ -5735,17 +5769,6 @@ the user is prompted with more-prompt, and a message matching "You displaced ." is not shown at all. - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 88 - - - The order of the defined MSGTYPE lines is important; the last matching rule is used. Put the general case first, exceptions below them. @@ -5778,6 +5801,17 @@ ground color, which isn't necessarily the same as any of the other colors. + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 89 + + + Allowed attributes are none, bold, dim, italic, underline, blink, and inverse. "Normal" is a synonym for "none". Note that the platform used may interpret the attributes any way it @@ -5799,21 +5833,9 @@ 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 - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 89 - - - - implicit_uncursed option off so that all items known to be un- - cursed are actually displayed with the "uncursed" description. + 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.12. Configuring User Sounds @@ -5844,6 +5866,18 @@ sound index - optional; the index corresponding to a sound file. + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 90 + + + The pattern should be a POSIX extended regular expression. For example: @@ -5867,17 +5901,6 @@ will cause the hitpoints field to display in the color red if your hitpoints drop to or below a threshold of 30%: - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 90 - - - OPTION=hilite_status:hitpoints/<=30%/red/normal (That example is actually specifying red&normal for <=30% and no- @@ -5908,8 +5931,20 @@ interpret the attributes any way it wants. For example, on some display systems a request for bold might yield blink or vice ver- sa. On others, issuing an attribute request while another is al- - ready set up will replace the earlier attribute rather than com- - bine with it. Since NetHack issues attribute requests sequen- + ready set up will replace the earlier attribute rather than + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 91 + + + + combine with it. Since NetHack issues attribute requests sequen- tially (at least with the tty interface) rather than all at once, the only way a situation like that can be controlled is to speci- fy just one attribute. @@ -5931,19 +5966,6 @@ polymorphed. "experience", "time", and "score" are condition- ally displayed depending upon your other option settings. - - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 91 - - - Instead of a behavior, "condition" takes the following condi- tion flags: stone, slime, strngl, foodpois, termill, blind, deaf, stun, conf, hallu, lev, fly, and ride. You can use "ma- @@ -5975,32 +5997,10 @@ numeric limit is relaxed slightly for those: >-1% and <101% are allowed.) Only four fields support percentage rules. Percentages for "hitpoints" and "power" are - straightforward; they're based on the corresponding maxi- - mum field. Percentage highlight rules are also allowed - for "experience level" and "experience points" (valid when - the showexp option is enabled). For those, the percentage - is based on the progress from the start of the current ex- - perience level to the start of the next level. So if lev- - el 2 starts at 20 points and level 3 starts at 40 points, - having 30 points is 50% and 35 points is 75%. 100% is - unattainable for experience because you'll gain a level - and the calculations will be reset for that new level, but - a rule for =100% is allowed and matches the special case - of being exactly 1 experience point short of the next lev- - el. - - * absolute value sets the attribute when the field value - matches that number. The number must be 0 or higher, ex- - cept for "armor-class' which allows negative values, and - may optionally be preceded by `='. If the number is pre- - ceded by `<=' or `>=' instead, it also matches when value - is below or above. If the prefix is `<' or `>', only - match when strictly above or below. + straightforward; they're based on the corresponding - - - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -6010,6 +6010,27 @@ + maximum field. Percentage highlight rules are also al- + lowed for "experience level" and "experience points" + (valid when the showexp option is enabled). For those, + the percentage is based on the progress from the start of + the current experience level to the start of the next lev- + el. So if level 2 starts at 20 points and level 3 starts + at 40 points, having 30 points is 50% and 35 points is + 75%. 100% is unattainable for experience because you'll + gain a level and the calculations will be reset for that + new level, but a rule for =100% is allowed and matches the + special case of being exactly 1 experience point short of + the next level. + + * absolute value sets the attribute when the field value + matches that number. The number must be 0 or higher, ex- + cept for "armor-class' which allows negative values, and + may optionally be preceded by `='. If the number is pre- + ceded by `<=' or `>=' instead, it also matches when value + is below or above. If the prefix is `<' or `>', only + match when strictly above or below. + * text match sets the attribute when the field value matches the text. Text matches can only be used for "alignment", "carrying-capacity", "hunger", "dungeon-level", and "ti- @@ -6042,6 +6063,19 @@ The options that are used to select a particular symbol set from the symbol file are: + + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 93 + + + symset Set the name of the symbol set that you want to load. @@ -6063,19 +6097,6 @@ ----------------------------------------------------------------- S_air (air) _ S_altar (altar) - - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 93 - - - " S_amulet (amulet) A S_angel (angelic being) a S_ant (ant or other insect) @@ -6108,6 +6129,19 @@ # S_darkroom (dark room) ^ S_dart_trap (dart trap) & S_demon (major demon) + + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 94 + + + * S_digbeam (dig beam) > S_dnladder (ladder down) > S_dnstair (staircase down) @@ -6129,19 +6163,6 @@ f S_feline (cat or other feline) ^ S_fire_trap (fire trap) ! S_flashbeam (flash beam) - - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 94 - - - % S_food (piece of food) { S_fountain (fountain) F S_fungus (fungus or mold) @@ -6174,6 +6195,19 @@ ^ S_level_teleporter (level teleporter) L S_lich (lich) y S_light (light) + + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 95 + + + # S_litcorr (lit corridor) : S_lizard (lizard) \ S_lslant (diagonal beam [zap animation]) @@ -6195,19 +6229,6 @@ ! S_potion (potion) P S_pudding (pudding or ooze) q S_quadruped (quadruped) - - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 95 - - - Q S_quantmech (quantum mechanic) = S_ring (ring) ` S_rock (boulder or statue) @@ -6240,6 +6261,19 @@ / S_sw_tl (swallow top left) \ S_sw_tr (swallow top right) - S_tdwall (wall) + + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 96 + + + ^ S_teleportation_trap (teleportation trap) \ S_throne (opulent throne) - S_tlcorn (top left corner) @@ -6261,19 +6295,6 @@ | S_vbeam (vertical beam [zap animation]) # S_vcdbridge (vertical raised drawbridge) + S_vcdoor (closed door in vertical wall) - - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 96 - - - . S_venom (splash of venom) ^ S_vibrating_square (vibrating square) . S_vodbridge (vertical lowered drawbridge) @@ -6308,6 +6329,17 @@ pict. So S_rock is only used for boulders and not used at all if overridden by the more specific S_boulder. + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 97 + + + 9.15. Customizing Map Glyph Representations Using Unicode If your platform or terminal supports the display of UTF-8 @@ -6327,20 +6359,8 @@ displaying UTF-8 character sequences and explicit red-green-blue colors in order for the glyph representation to be visible. For example, the following line in your configuration file will cause - the glyph representation for glyphid G_pool to use Unicode - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 97 - - - - codepoint U+224B and the color represented by R-G-B value 0-0-160 + the glyph representation for glyphid G_pool to use Unicode code- + point U+224B and the color represented by R-G-B value 0-0-160 OPTIONS=glyph:G_pool/U+224B/0-0-160 @@ -6374,6 +6394,18 @@ ten useful in giving players a better sense of the overall loca- tion of items on the screen. + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 98 + + + NetHack can also be compiled with support for sending the game messages to an external program, such as a text-to-speech synthesizer. If the "#version" extended command shows "external @@ -6393,19 +6425,6 @@ menustyle:traditional This will assist in the interface to speech synthesizers. - - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 98 - - - nomenu_overlay Show menus on a cleared screen and aligned to the left edge. @@ -6440,8 +6459,20 @@ nostatus_updates Prevent updates to the status lines at the bottom of the - screen, if your screen-reader reads those lines. The same in- - formation can be seen via the "#attributes" command. + screen, if your screen-reader reads those lines. The same + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 99 + + + + information can be seen via the "#attributes" command. 9.17. Global Configuration for System Administrators @@ -6459,19 +6490,6 @@ value of a single asterisk (*) allows anyone to start a game in debug mode. - - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 99 - - - SHELLERS = A list of users who are allowed to use the shell es- cape command (!). The syntax is the same as WIZARDS. @@ -6507,8 +6525,20 @@ option. When disabled, incubi and succubi behave like nymphs. CHECK_PLNAME = Setting this to 1 will make the EXPLORERS, WIZ- - ARDS, and SHELLERS check for the player name instead of the us- - er's login name. + ARDS, and SHELLERS check for the player name instead of the + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 100 + + + + user's login name. CHECK_SAVE_UID = 0 or 1 to disable or enable, respectively, the UID (used identification number) checking for save files (to @@ -6527,32 +6557,24 @@ PERS_IS_UID = 0 or 1 to use user names or numeric userids, re- spectively, to identify unique people for the score file. + HIDEUSAGE = 0 or 1 to control whether the help menu entry for + command line usage is shown or suppressed. - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 100 - - - - MAX_STATUENAME_RANK = Maximum number of score file entries to + MAX_STATUENAME_RANK = Maximum number of score file entries to use for random statue names (default is 10). - ACCESSIBILITY = 0 or 1 to disable or enable, respectively, the - ability for players to set S_pet_override and S_hero_override + ACCESSIBILITY = 0 or 1 to disable or enable, respectively, the + ability for players to set S_pet_override and S_hero_override symbols in their configuration file. - PORTABLE_DEVICE_PATHS = 0 or 1 Windows OS only, the game will - look for all of its external files, and write to all of its - output files in one place rather than at the standard loca- + PORTABLE_DEVICE_PATHS = 0 or 1 Windows OS only, the game will + look for all of its external files, and write to all of its + output files in one place rather than at the standard loca- tions. DUMPLOGFILE = A filename where the end-of-game dumplog is - saved. Not defining this will prevent dumplog from being cre- - ated. Only available if your game is compiled with DUMPLOG. + saved. Not defining this will prevent dumplog from being cre- + ated. Only available if your game is compiled with DUMPLOG. Allows the following placeholders: %% - literal `%' @@ -6565,36 +6587,14 @@ %n - player name %N - first character of player name - LIVELOG = A bit-mask of types of events that should be written + LIVELOG = A bit-mask of types of events that should be written to the livelog file if one is present. The sample sysconf file - accompanying the program contains a comment which lists the - meaning of the various bits used. Intended for server systems - supporting simultaneous play by multiple players (to be clear, - each one running a separate single player game), for displaying - their game progress to observers. Only relevant if the program - was built with LIVELOG enabled. When available, it should be - left commented out on single player installations because over - time the file could grow to be extremely large unless it is ac- - tively maintained. - - 10. Scoring - - NetHack maintains a list of the top scores or scorers on - your machine, depending on how it is set up. In the latter case, - each account on the machine can post only one non-winning score - on this list. If you score higher than someone else on this - list, or better your previous score, you will be inserted in the - proper place under your current name. How many scores are kept - can also be set up when NetHack is compiled. - - Your score is chiefly based upon how much experience you - gained, how much loot you accumulated, how deep you explored, and - how the game ended. If you quit the game, you escape with all of - your gold intact. If, however, you get killed in the Mazes of - Menace, the guild will only hear about 90% of your gold when your + accompanying the program contains a comment which lists the + meaning of the various bits used. Intended for server systems + supporting simultaneous play by multiple players (to be clear, - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -6604,63 +6604,63 @@ - corpse is discovered (adventurers have been known to collect - finder's fees). So, consider whether you want to take one last - hit at that monster and possibly live, or quit and stop with - whatever you have. If you quit, you keep all your gold, but if + each one running a separate single player game), for displaying + their game progress to observers. Only relevant if the program + was built with LIVELOG enabled. When available, it should be + left commented out on single player installations because over + time the file could grow to be extremely large unless it is ac- + tively maintained. + + 10. Scoring + + NetHack maintains a list of the top scores or scorers on + your machine, depending on how it is set up. In the latter case, + each account on the machine can post only one non-winning score + on this list. If you score higher than someone else on this + list, or better your previous score, you will be inserted in the + proper place under your current name. How many scores are kept + can also be set up when NetHack is compiled. + + Your score is chiefly based upon how much experience you + gained, how much loot you accumulated, how deep you explored, and + how the game ended. If you quit the game, you escape with all of + your gold intact. If, however, you get killed in the Mazes of + Menace, the guild will only hear about 90% of your gold when your + corpse is discovered (adventurers have been known to collect + finder's fees). So, consider whether you want to take one last + hit at that monster and possibly live, or quit and stop with + whatever you have. If you quit, you keep all your gold, but if you swing and live, you might find more. - If you just want to see what the current top players/games + If you just want to see what the current top players/games list is, you can type nethack -s all on most versions. 11. Explore mode - NetHack is an intricate and difficult game. Novices might + NetHack is an intricate and difficult game. Novices might falter in fear, aware of their ignorance of the means to survive. Well, fear not. Your dungeon comes equipped with an "explore" or - "discovery" mode that enables you to keep old save files and - cheat death, at the paltry cost of not getting on the high score + "discovery" mode that enables you to keep old save files and + cheat death, at the paltry cost of not getting on the high score list. - There are two ways of enabling explore mode. One is to - start the game with the -X command-line switch or with the play- - mode:explore option. The other is to issue the "#exploremode" - extended command while already playing the game. Starting a new + There are two ways of enabling explore mode. One is to + start the game with the -X command-line switch or with the play- + mode:explore option. The other is to issue the "#exploremode" + extended command while already playing the game. Starting a new game in explore mode provides your character with a wand of wish- - ing in initial inventory; switching during play does not. The - other benefits of explore mode are left for the trepid reader to + ing in initial inventory; switching during play does not. The + other benefits of explore mode are left for the trepid reader to discover. 11.1. Debug mode Debug mode, also known as wizard mode, is undocumented aside - from this brief description and the various "debug mode only" - commands listed among the command descriptions. It is intended - for tracking down problems within the program rather than to pro- - vide god-like powers to your character, and players who attempt - debugging are expected to figure out how to use it themselves. - It is initiated by starting the game with the -D command-line - switch or with the playmode:debug option. - - For some systems, the player must be logged in under a par- - ticular user name to be allowed to use debug mode; for others, - the hero must be given a particular character name (but may be - any role; there's no connection between "wizard mode" and the - Wizard role). Attempting to start a game in debug mode when not - allowed or not available will result in falling back to explore - mode instead. - - 12. Credits - - The original hack game was modeled on the Berkeley UNIX - rogue game. Large portions of this document were shamelessly - cribbed from A Guide to the Dungeons of Doom, by Michael C. Toy - and Kenneth C. R. C. Arnold. Small portions were adapted from - Further Exploration of the Dungeons of Doom, by Ken Arromdee. + from this brief description and the various "debug mode only" + commands listed among the command descriptions. It is intended - - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -6670,63 +6670,63 @@ + for tracking down problems within the program rather than to pro- + vide god-like powers to your character, and players who attempt + debugging are expected to figure out how to use it themselves. + It is initiated by starting the game with the -D command-line + switch or with the playmode:debug option. + + For some systems, the player must be logged in under a par- + ticular user name to be allowed to use debug mode; for others, + the hero must be given a particular character name (but may be + any role; there's no connection between "wizard mode" and the + Wizard role). Attempting to start a game in debug mode when not + allowed or not available will result in falling back to explore + mode instead. + + 12. Credits + + The original hack game was modeled on the Berkeley UNIX + rogue game. Large portions of this document were shamelessly + cribbed from A Guide to the Dungeons of Doom, by Michael C. Toy + and Kenneth C. R. C. Arnold. Small portions were adapted from + Further Exploration of the Dungeons of Doom, by Ken Arromdee. + NetHack is the product of literally scores of people's work. - Main events in the course of the game development are described + Main events in the course of the game development are described below: - Jay Fenlason wrote the original Hack, with help from Kenny + Jay Fenlason wrote the original Hack, with help from Kenny Woodland, Mike Thome, and Jon Payne. - Andries Brouwer did a major re-write while at Stichting + Andries Brouwer did a major re-write while at Stichting Mathematisch Centrum (now Centrum Wiskunde & Informatica), trans- - forming Hack into a very different game. He published the Hack - source code for use on UNIX systems by posting that to Usenet + forming Hack into a very different game. He published the Hack + source code for use on UNIX systems by posting that to Usenet newsgroup net.sources (later renamed comp.sources) releasing ver- sion 1.0 in December of 1984, then versions 1.0.1, 1.0.2, and fi- - nally 1.0.3 in July of 1985. Usenet newsgroup net.games.hack - (later renamed rec.games.hack, eventually replaced by + nally 1.0.3 in July of 1985. Usenet newsgroup net.games.hack + (later renamed rec.games.hack, eventually replaced by rec.games.roguelike.nethack) was created for discussing it. - Don G. Kneller ported Hack 1.0.3 to Microsoft C and MS-DOS, - producing PC HACK 1.01e, added support for DEC Rainbow graphics - in version 1.03g, and went on to produce at least four more ver- + Don G. Kneller ported Hack 1.0.3 to Microsoft C and MS-DOS, + producing PC HACK 1.01e, added support for DEC Rainbow graphics + in version 1.03g, and went on to produce at least four more ver- sions (3.0, 3.2, 3.51, and 3.6; note that these are old Hack ver- sion numbers, not contemporary NetHack ones). - R. Black ported PC HACK 3.51 to Lattice C and the Atari + R. Black ported PC HACK 3.51 to Lattice C and the Atari 520/1040ST, producing ST Hack 1.03. Mike Stephenson merged these various versions back together, - incorporating many of the added features, and produced NetHack - version 1.4 in 1987. He then coordinated a cast of thousands in + incorporating many of the added features, and produced NetHack + version 1.4 in 1987. He then coordinated a cast of thousands in enhancing and debugging NetHack 1.4 and released NetHack versions - 2.2 and 2.3. Like Hack, they were released by posting their - source code to Usenet where they remained available in various - archives accessible via ftp and uucp after expiring from the - newsgroup. - - Later, Mike coordinated a major re-write of the game, head- - ing a team which included Ken Arromdee, Jean-Christophe Collet, - Steve Creps, Eric Hendrickson, Izchak Miller, Eric S. Raymond, - John Rupley, Mike Threepoint, and Janet Walz, to produce NetHack - 3.0c. - - NetHack 3.0 was ported to the Atari by Eric R. Smith, to - OS/2 by Timo Hakulinen, and to VMS by David Gentzel. The three - of them and Kevin Darcy later joined the main NetHack Development - Team to produce subsequent revisions of 3.0. - - Olaf Seibert ported NetHack 2.3 and 3.0 to the Amiga. Norm - Meluch, Stephen Spackman and Pierre Martineau designed overlay - code for PC NetHack 3.0. Johnny Lee ported NetHack 3.0 to the - Macintosh. Along with various other Dungeoneers, they continued - to enhance the PC, Macintosh, and Amiga ports through the later - revisions of 3.0. + 2.2 and 2.3. Like Hack, they were released by posting their + source code to Usenet where they remained available in various - - - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -6736,63 +6736,63 @@ - Version 3.0 went through ten relatively rapidly released - "patch-level" revisions. Versions at the time were known as 3.0 - for the base release and variously as "3.0a" through "3.0j", - "3.0 patchlevel 1" through "3.0 patchlevel 10", or "3.0pl1" + archives accessible via ftp and uucp after expiring from the + newsgroup. + + Later, Mike coordinated a major re-write of the game, head- + ing a team which included Ken Arromdee, Jean-Christophe Collet, + Steve Creps, Eric Hendrickson, Izchak Miller, Eric S. Raymond, + John Rupley, Mike Threepoint, and Janet Walz, to produce NetHack + 3.0c. + + NetHack 3.0 was ported to the Atari by Eric R. Smith, to + OS/2 by Timo Hakulinen, and to VMS by David Gentzel. The three + of them and Kevin Darcy later joined the main NetHack Development + Team to produce subsequent revisions of 3.0. + + Olaf Seibert ported NetHack 2.3 and 3.0 to the Amiga. Norm + Meluch, Stephen Spackman and Pierre Martineau designed overlay + code for PC NetHack 3.0. Johnny Lee ported NetHack 3.0 to the + Macintosh. Along with various other Dungeoneers, they continued + to enhance the PC, Macintosh, and Amiga ports through the later + revisions of 3.0. + + Version 3.0 went through ten relatively rapidly released + "patch-level" revisions. Versions at the time were known as 3.0 + for the base release and variously as "3.0a" through "3.0j", + "3.0 patchlevel 1" through "3.0 patchlevel 10", or "3.0pl1" through "3.0pl10" rather than 3.0.0 and 3.0.1 through 3.0.10; the three component numbering scheme began to be used with 3.1.0. - Headed by Mike Stephenson and coordinated by Izchak Miller - and Janet Walz, the NetHack Development Team which now included - Ken Arromdee, David Cohrs, Jean-Christophe Collet, Kevin Darcy, - Matt Day, Timo Hakulinen, Steve Linhart, Dean Luick, Pat Rankin, + Headed by Mike Stephenson and coordinated by Izchak Miller + and Janet Walz, the NetHack Development Team which now included + Ken Arromdee, David Cohrs, Jean-Christophe Collet, Kevin Darcy, + Matt Day, Timo Hakulinen, Steve Linhart, Dean Luick, Pat Rankin, Eric Raymond, and Eric Smith undertook a radical revision of 3.0. They re-structured the game's design, and re-wrote major parts of - the code. They added multiple dungeons, a new display, special - individual character quests, a new endgame and many other new - features, and produced NetHack 3.1. Version 3.1.0 was released + the code. They added multiple dungeons, a new display, special + individual character quests, a new endgame and many other new + features, and produced NetHack 3.1. Version 3.1.0 was released in January of 1993. - Ken Lorber, Gregg Wonderly and Greg Olson, with help from - Richard Addison, Mike Passaretti, and Olaf Seibert, developed + Ken Lorber, Gregg Wonderly and Greg Olson, with help from + Richard Addison, Mike Passaretti, and Olaf Seibert, developed NetHack 3.1 for the Amiga. - Norm Meluch and Kevin Smolkowski, with help from Carl Sche- + Norm Meluch and Kevin Smolkowski, with help from Carl Sche- lin, Stephen Spackman, Steve VanDevender, and Paul Winner, ported NetHack 3.1 to the PC. Jon W{tte and Hao-yang Wang, with help from Ross Brown, Mike - Engber, David Hairston, Michael Hamel, Jonathan Handler, Johnny - Lee, Tim Lennan, Rob Menke, and Andy Swanson, developed NetHack + Engber, David Hairston, Michael Hamel, Jonathan Handler, Johnny + Lee, Tim Lennan, Rob Menke, and Andy Swanson, developed NetHack 3.1 for the Macintosh, porting it for MPW. Building on their de- velopment, Bart House added a Think C port. - Timo Hakulinen ported NetHack 3.1 to OS/2. Eric Smith port- - ed NetHack 3.1 to the Atari. Pat Rankin, with help from Joshua - Delahunty, was responsible for the VMS version of NetHack 3.1. - Michael Allison ported NetHack 3.1 to Windows NT. - - Dean Luick, with help from David Cohrs, developed NetHack - 3.1 for X11. It drew the map as text rather than graphically but - included nh10.bdf, an optionally used custom X11 font which has - tiny images in place of letters and punctuation, a precursor of - tiles. Those images don't extend to individual monster and ob- - ject types, just replacements for monster and object classes (so - one custom image for all "a" insects and another for all "[" ar- - mor and so forth, not separate images for beetles and ants or for - cloaks and boots). - - Warwick Allison wrote a graphically displayed version of - NetHack for the Atari where the tiny pictures were described as - "icons" and were distinct for specific types of monsters and ob- - jects rather than just their classes. He contributed them to the - NetHack Development Team which rechristened them "tiles", origi- - nal usage which has subsequently been picked up by various other - games. NetHack's tiles support was then implemented on other - NetHack 3.7 October 27, 2022 + + NetHack 3.7 November 23, 2022 @@ -6802,63 +6802,63 @@ - platforms (initially MS-DOS but eventually Windows, Qt, and X11 + Timo Hakulinen ported NetHack 3.1 to OS/2. Eric Smith port- + ed NetHack 3.1 to the Atari. Pat Rankin, with help from Joshua + Delahunty, was responsible for the VMS version of NetHack 3.1. + Michael Allison ported NetHack 3.1 to Windows NT. + + Dean Luick, with help from David Cohrs, developed NetHack + 3.1 for X11. It drew the map as text rather than graphically but + included nh10.bdf, an optionally used custom X11 font which has + tiny images in place of letters and punctuation, a precursor of + tiles. Those images don't extend to individual monster and ob- + ject types, just replacements for monster and object classes (so + one custom image for all "a" insects and another for all "[" ar- + mor and so forth, not separate images for beetles and ants or for + cloaks and boots). + + Warwick Allison wrote a graphically displayed version of + NetHack for the Atari where the tiny pictures were described as + "icons" and were distinct for specific types of monsters and ob- + jects rather than just their classes. He contributed them to the + NetHack Development Team which rechristened them "tiles", origi- + nal usage which has subsequently been picked up by various other + games. NetHack's tiles support was then implemented on other + platforms (initially MS-DOS but eventually Windows, Qt, and X11 too). The 3.2 NetHack Development Team, comprised of Michael Alli- son, Ken Arromdee, David Cohrs, Jessie Collet, Steve Creps, Kevin Darcy, Timo Hakulinen, Steve Linhart, Dean Luick, Pat Rankin, Er- - ic Smith, Mike Stephenson, Janet Walz, and Paul Winner, released + ic Smith, Mike Stephenson, Janet Walz, and Paul Winner, released version 3.2.0 in April of 1996. Version 3.2 marked the tenth anniversary of the formation of - the development team. In a testament to their dedication to the - game, all thirteen members of the original NetHack Development - Team remained on the team at the start of work on that release. - During the interval between the release of 3.1.3 and 3.2.0, one - of the founding members of the NetHack Development Team, Dr. - Izchak Miller, was diagnosed with cancer and passed away. That - release of the game was dedicated to him by the development and + the development team. In a testament to their dedication to the + game, all thirteen members of the original NetHack Development + Team remained on the team at the start of work on that release. + During the interval between the release of 3.1.3 and 3.2.0, one + of the founding members of the NetHack Development Team, Dr. + Izchak Miller, was diagnosed with cancer and passed away. That + release of the game was dedicated to him by the development and porting teams. Version 3.2 proved to be more stable than previous versions. - Many bugs were fixed, abuses eliminated, and game features tuned + Many bugs were fixed, abuses eliminated, and game features tuned for better game play. During the lifespan of NetHack 3.1 and 3.2, several enthusi- - asts of the game added their own modifications to the game and + asts of the game added their own modifications to the game and made these "variants" publicly available: - Tom Proudfoot and Yuval Oren created NetHack++, which was - quickly renamed NetHack-- when some people incorrectly assumed - that it was a conversion of the C source code to C++. Working - independently, Stephen White wrote NetHack Plus. Tom Proudfoot + Tom Proudfoot and Yuval Oren created NetHack++, which was + quickly renamed NetHack-- when some people incorrectly assumed + that it was a conversion of the C source code to C++. Working + independently, Stephen White wrote NetHack Plus. Tom Proudfoot later merged NetHack Plus and his own NetHack-- to produce SLASH. - Larry Stewart-Zerba and Warwick Allison improved the spell cast- - ing system with the Wizard Patch. Warwick Allison also ported - NetHack to use the Qt interface. - - Warren Cheung combined SLASH with the Wizard Patch to pro- - duce Slash'EM, and with the help of Kevin Hugo, added more fea- - tures. Kevin later joined the NetHack Development Team and in- - corporated the best of these ideas into NetHack 3.3. - - The final update to 3.2 was the bug fix release 3.2.3, which - was released simultaneously with 3.3.0 in December 1999 just in - time for the Year 2000. Because of the newer version, 3.2.3 was - released as a source code patch only, without any ready-to-play - distribution for systems that usually had such. - - (To anyone considering resurrecting an old version: all - versions before 3.2.3 had a Y2K bug. The high scores file and - the log file contained dates which were formatted using a two- - digit year, and 1999's year 99 was followed by 2000's year 100. - That got written out successfully but it unintentionally intro- - duced an extra column in the file layout which prevented score - entries from being read back in correctly, interfering with - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -6868,63 +6868,63 @@ - insertion of new high scores and with retrieval of old character - names to use for random ghost and statue names in the current + Larry Stewart-Zerba and Warwick Allison improved the spell cast- + ing system with the Wizard Patch. Warwick Allison also ported + NetHack to use the Qt interface. + + Warren Cheung combined SLASH with the Wizard Patch to pro- + duce Slash'EM, and with the help of Kevin Hugo, added more fea- + tures. Kevin later joined the NetHack Development Team and in- + corporated the best of these ideas into NetHack 3.3. + + The final update to 3.2 was the bug fix release 3.2.3, which + was released simultaneously with 3.3.0 in December 1999 just in + time for the Year 2000. Because of the newer version, 3.2.3 was + released as a source code patch only, without any ready-to-play + distribution for systems that usually had such. + + (To anyone considering resurrecting an old version: all + versions before 3.2.3 had a Y2K bug. The high scores file and + the log file contained dates which were formatted using a two- + digit year, and 1999's year 99 was followed by 2000's year 100. + That got written out successfully but it unintentionally intro- + duced an extra column in the file layout which prevented score + entries from being read back in correctly, interfering with in- + sertion of new high scores and with retrieval of old character + names to use for random ghost and statue names in the current game.) - The 3.3 NetHack Development Team, consisting of Michael Al- - lison, Ken Arromdee, David Cohrs, Jessie Collet, Steve Creps, - Kevin Darcy, Timo Hakulinen, Kevin Hugo, Steve Linhart, Ken Lor- - ber, Dean Luick, Pat Rankin, Eric Smith, Mike Stephenson, Janet - Walz, and Paul Winner, released 3.3.0 in December 1999 and 3.3.1 + The 3.3 NetHack Development Team, consisting of Michael Al- + lison, Ken Arromdee, David Cohrs, Jessie Collet, Steve Creps, + Kevin Darcy, Timo Hakulinen, Kevin Hugo, Steve Linhart, Ken Lor- + ber, Dean Luick, Pat Rankin, Eric Smith, Mike Stephenson, Janet + Walz, and Paul Winner, released 3.3.0 in December 1999 and 3.3.1 in August of 2000. Version 3.3 offered many firsts. It was the first version to - separate race and profession. The Elf class was removed in pref- + separate race and profession. The Elf class was removed in pref- erence to an elf race, and the races of dwarves, gnomes, and orcs - made their first appearance in the game alongside the familiar - human race. Monk and Ranger roles joined Archeologists, Barbar- - ians, Cavemen, Healers, Knights, Priests, Rogues, Samurai, - Tourists, Valkyries and of course, Wizards. It was also the - first version to allow you to ride a steed, and was the first - version to have a publicly available web-site listing all the - bugs that had been discovered. Despite that constantly growing - bug list, 3.3 proved stable enough to last for more than a year + made their first appearance in the game alongside the familiar + human race. Monk and Ranger roles joined Archeologists, Barbar- + ians, Cavemen, Healers, Knights, Priests, Rogues, Samurai, + Tourists, Valkyries and of course, Wizards. It was also the + first version to allow you to ride a steed, and was the first + version to have a publicly available web-site listing all the + bugs that had been discovered. Despite that constantly growing + bug list, 3.3 proved stable enough to last for more than a year and a half. - The 3.4 NetHack Development Team initially consisted of - Michael Allison, Ken Arromdee, David Cohrs, Jessie Collet, Kevin - Hugo, Ken Lorber, Dean Luick, Pat Rankin, Mike Stephenson, Janet - Walz, and Paul Winner, with Warwick Allison joining just before + The 3.4 NetHack Development Team initially consisted of + Michael Allison, Ken Arromdee, David Cohrs, Jessie Collet, Kevin + Hugo, Ken Lorber, Dean Luick, Pat Rankin, Mike Stephenson, Janet + Walz, and Paul Winner, with Warwick Allison joining just before the release of NetHack 3.4.0 in March 2002. - As with version 3.3, various people contributed to the game + As with version 3.3, various people contributed to the game as a whole as well as supporting ports on the different platforms - that NetHack runs on: - - Pat Rankin maintained 3.4 for VMS. - - Michael Allison maintained NetHack 3.4 for the MS-DOS plat- - form. Paul Winner and Yitzhak Sapir provided encouragement. - - Dean Luick, Mark Modrall, and Kevin Hugo maintained and en- - hanced the Macintosh port of 3.4. - - Michael Allison, David Cohrs, Alex Kompel, Dion Nicolaas, - and Yitzhak Sapir maintained and enhanced 3.4 for the Microsoft - Windows platform. Alex Kompel contributed a new graphical inter- - face for the Windows port. Alex Kompel also contributed a Win- - dows CE port for 3.4.1. - - Ron Van Iwaarden was the sole maintainer of NetHack for OS/2 - the past several releases. Unfortunately Ron's last OS/2 machine - stopped working in early 2006. A great many thanks to Ron for - keeping NetHack alive on OS/2 all these years. - - - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -6934,8 +6934,29 @@ - Janne Salmijarvi and Teemu Suikki maintained and enhanced - the Amiga port of 3.4 after Janne Salmijarvi resurrected it for + that NetHack runs on: + + Pat Rankin maintained 3.4 for VMS. + + Michael Allison maintained NetHack 3.4 for the MS-DOS plat- + form. Paul Winner and Yitzhak Sapir provided encouragement. + + Dean Luick, Mark Modrall, and Kevin Hugo maintained and en- + hanced the Macintosh port of 3.4. + + Michael Allison, David Cohrs, Alex Kompel, Dion Nicolaas, + and Yitzhak Sapir maintained and enhanced 3.4 for the Microsoft + Windows platform. Alex Kompel contributed a new graphical inter- + face for the Windows port. Alex Kompel also contributed a Win- + dows CE port for 3.4.1. + + Ron Van Iwaarden was the sole maintainer of NetHack for OS/2 + the past several releases. Unfortunately Ron's last OS/2 machine + stopped working in early 2006. A great many thanks to Ron for + keeping NetHack alive on OS/2 all these years. + + Janne Salmijarvi and Teemu Suikki maintained and enhanced + the Amiga port of 3.4 after Janne Salmijarvi resurrected it for 3.3.1. Christian "Marvin" Bressler maintained 3.4 for the Atari af- @@ -6944,53 +6965,32 @@ 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 stable version that provided continued enjoyment by the community - for more than a decade. The NetHack Development Team slowly and - quietly continued to work on the game behind the scenes during - the tenure of 3.4.3. It was during that same period that several + for more than a decade. The NetHack Development Team slowly and + quietly continued to work on the game behind the scenes during + the tenure of 3.4.3. It was during that same period that several new variants emerged within the NetHack community. Notably sporkhack by Derek S. Ray, unnethack by Patric Mueller, nitrohack - and its successors originally by Daniel Thaler and then by Alex - Smith, and Dynahack by Tung Nguyen. Some of those variants con- - tinue to be developed, maintained, and enjoyed by the community + and its successors originally by Daniel Thaler and then by Alex + Smith, and Dynahack by Tung Nguyen. Some of those variants con- + tinue to be developed, maintained, and enjoyed by the community to this day. In September 2014, an interim snapshot of the code under de- - velopment was released publicly by other parties. Since that - code was a work-in-progress and had not gone through the process - of debugging it as a suitable release, it was decided that the - version numbers present on that code snapshot would be retired - and never used in an official NetHack release. An announcement + velopment was released publicly by other parties. Since that + code was a work-in-progress and had not gone through the process + of debugging it as a suitable release, it was decided that the + version numbers present on that code snapshot would be retired + and never used in an official NetHack release. An announcement was posted on the NetHack Development Team's official nethack.org - website to that effect, stating that there would never be a + website to that effect, stating that there would never be a 3.4.4, 3.5, or 3.5.0 official release version. - In January 2015, preparation began for the release of + In January 2015, preparation began for the release of NetHack 3.6. - At the beginning of development for what would eventually - get released as 3.6.0, the NetHack Development Team consisted of - Warwick Allison, Michael Allison, Ken Arromdee, David Cohrs, - Jessie Collet, Ken Lorber, Dean Luick, Pat Rankin, Mike Stephen- - son, Janet Walz, and Paul Winner. In early 2015, ahead of the - release of 3.6.0, new members Sean Hunt, Pasi Kallinen, and Derek - S. Ray joined the NetHack Development Team. - - Near the end of the development of 3.6.0, one of the signif- - icant inspirations for many of the humorous and fun features - found in the game, author Terry Pratchett, passed away. NetHack - 3.6.0 introduced a tribute to him. - - 3.6.0 was released in December 2015, and merged work done by - the development team since the release of 3.4.3 with some of the - beloved community patches. Many bugs were fixed and some code was - restructured. - - The NetHack Development Team, as well as Steve VanDevender - and Kevin Smolkowski, ensured that NetHack 3.6 continued to oper- - ate on various UNIX flavors and maintained the X11 interface. - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 @@ -7000,45 +7000,79 @@ - Ken Lorber, Haoyang Wang, Pat Rankin, and Dean Luick main- + At the beginning of development for what would eventually + get released as 3.6.0, the NetHack Development Team consisted of + Warwick Allison, Michael Allison, Ken Arromdee, David Cohrs, + Jessie Collet, Ken Lorber, Dean Luick, Pat Rankin, Mike Stephen- + son, Janet Walz, and Paul Winner. In early 2015, ahead of the + release of 3.6.0, new members Sean Hunt, Pasi Kallinen, and Derek + S. Ray joined the NetHack Development Team. + + Near the end of the development of 3.6.0, one of the signif- + icant inspirations for many of the humorous and fun features + found in the game, author Terry Pratchett, passed away. NetHack + 3.6.0 introduced a tribute to him. + + 3.6.0 was released in December 2015, and merged work done by + the development team since the release of 3.4.3 with some of the + beloved community patches. Many bugs were fixed and some code was + restructured. + + The NetHack Development Team, as well as Steve VanDevender + and Kevin Smolkowski, ensured that NetHack 3.6 continued to oper- + ate on various UNIX flavors and maintained the X11 interface. + + Ken Lorber, Haoyang Wang, Pat Rankin, and Dean Luick main- tained the port of NetHack 3.6 for Mac OSX. - Michael Allison, David Cohrs, Bart House, Pasi Kallinen, - Alex Kompel, Dion Nicolaas, Derek S. Ray and Yitzhak Sapir main- + Michael Allison, David Cohrs, Bart House, Pasi Kallinen, + Alex Kompel, Dion Nicolaas, Derek S. Ray and Yitzhak Sapir main- tained the port of NetHack 3.6 for Microsoft Windows. - Pat Rankin attempted to keep the VMS port running for + Pat Rankin attempted to keep the VMS port running for NetHack 3.6, hindered by limited access. Kevin Smolkowski has up- - dated and tested it for the most recent version of OpenVMS (V8.4 + dated and tested it for the most recent version of OpenVMS (V8.4 as of this writing) on Alpha and Integrity (aka Itanium aka IA64) but not VAX. - Ray Chason resurrected the MS-DOS port for 3.6 and contrib- + Ray Chason resurrected the MS-DOS port for 3.6 and contrib- uted the necessary updates to the community at large. - In late April 2018, several hundred bug fixes for 3.6.0 and - some new features were assembled and released as NetHack 3.6.1. + In late April 2018, several hundred bug fixes for 3.6.0 and + some new features were assembled and released as NetHack 3.6.1. The NetHack Development Team at the time of release of 3.6.1 con- - sisted of Warwick Allison, Michael Allison, Ken Arromdee, David - Cohrs, Jessie Collet, Pasi Kallinen, Ken Lorber, Dean Luick, - Patric Mueller, Pat Rankin, Derek S. Ray, Alex Smith, Mike + sisted of Warwick Allison, Michael Allison, Ken Arromdee, David + Cohrs, Jessie Collet, Pasi Kallinen, Ken Lorber, Dean Luick, + Patric Mueller, Pat Rankin, Derek S. Ray, Alex Smith, Mike Stephenson, Janet Walz, and Paul Winner. In early May 2019, another 320 bug fixes along with some en- - hancements and the adopted curses window port, were released as + hancements and the adopted curses window port, were released as 3.6.2. - Bart House, who had contributed to the game as a porting + Bart House, who had contributed to the game as a porting team participant for decades, joined the NetHack Development Team in late May 2019. - NetHack 3.6.3 was released on December 5, 2019 containing + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 108 + + + + NetHack 3.6.3 was released on December 5, 2019 containing over 190 bug fixes to NetHack 3.6.2. NetHack 3.6.4 was released on December 18, 2019 containing a security fix and a few bug fixes. - NetHack 3.6.5 was released on January 27, 2020 containing + NetHack 3.6.5 was released on January 27, 2020 containing some security fixes and a small number of bug fixes. NetHack 3.6.6 was released on March 8, 2020 containing a se- @@ -7051,33 +7085,21 @@ 12.1. Special Thanks On behalf of the NetHack community, thank you very much once - again to M. Drew Streib and Pasi Kallinen for providing a public - NetHack server at nethack.alt.org. Thanks to Keith Simpson and - Andy Thomson for hardfought.org. Thanks to all those unnamed - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 108 - - - - dungeoneers who invest their time and effort into annual NetHack - tournaments such as Junethack, The November NetHack Tournament, - and in days past, devnull.net (gone for now, but not forgotten). + again to M. Drew Streib and Pasi Kallinen for providing a public + NetHack server at nethack.alt.org. Thanks to Keith Simpson and + Andy Thomson for hardfought.org. Thanks to all those unnamed dun- + geoneers who invest their time and effort into annual NetHack + tournaments such as Junethack, The November NetHack Tournament, + and in days past, devnull.net (gone for now, but not forgotten). 12.2. Dungeoneers - From time to time, some depraved individual out there in - netland sends a particularly intriguing modification to help out + From time to time, some depraved individual out there in + netland sends a particularly intriguing modification to help out with the game. The NetHack Development Team sometimes makes note - of the names of the worst of these miscreants in this, the list + of the names of the worst of these miscreants in this, the list of Dungeoneers: Adam Aronow J. Ali Harlow Mikko Juola @@ -7097,6 +7119,19 @@ Bruce Mewborne Keizo Yamamoto Rob Menke Carl Schelin Keith Simpson Robin Bandy Chris Russo Ken Arnold Robin Johnson + + + + NetHack 3.7 November 23, 2022 + + + + + + NetHack Guidebook 109 + + + David Cohrs Ken Arromdee Roderick Schertler David Damerell Ken Lorber Roland McGrath David Gentzel Ken Washikita Ron Van Iwaarden @@ -7119,26 +7154,13 @@ Greg Olson Michael Hamel Tom West Gregg Wonderly Michael Sokolov Warren Cheung Hao-yang Wang Mike Engber Warwick Allison - - - - NetHack 3.7 October 27, 2022 - - - - - - NetHack Guidebook 109 - - - Helge Hafting Mike Gallop Yitzhak Sapir Irina Rempt-Drijfhout Mike Passaretti Izchak Miller Mike Stephenson - Brand and product names are trademarks or registered trade- + Brand and product names are trademarks or registered trade- marks of their respective holders. @@ -7166,29 +7188,7 @@ - - - - - - - - - - - - - - - - - - - - - - - NetHack 3.7 October 27, 2022 + NetHack 3.7 November 23, 2022 diff --git a/doc/nethack.txt b/doc/nethack.txt index b943b59c9..3d6bd78f2 100644 --- a/doc/nethack.txt +++ b/doc/nethack.txt @@ -6,12 +6,17 @@ NAME nethack - Exploring The Mazes of Menace SYNOPSIS - nethack [ -d directory ] [ -n ] [ -p profession ] [ -r race ] [ -[DX] ] - [ -u playername ] [ -dec ] [ -ibm ] [ --showpaths ] [ --version[:paste] - ] + nethack [ -d|--directory directory ] [ -w|--windowtype interface ] + [ --nethackrc:RC-file | --no-nethackrc ] [ -n ] [ -dec | -ibm ] + [ -u playername ] [ -X | -D ] [ -p profession ] [ -r race ] [ -@ ] - nethack [ -d directory ] -s [ -v ] [ -p profession ] [ -r race ] [ - playernames ] + Also [ -A|-Arc | -B|-Bar | -C|-Cav | -H|-Hea | -K|-Kni | -M|-Mon | + -P|-Pri | -R|-Rog | -Ran | -S|-Sam | -T|-Tou | -V|-Val | -W|-Wiz ] + + nethack [ -d|--directory directory ] -s|--scores [ -v ] + [ -p profession ] [ -r race ] [ playernames ] + + nethack [ --usage | --help ] [ --showpaths ] [ --version[:paste] ] DESCRIPTION NetHack is a display oriented Dungeons & Dragons(tm) - like game. The @@ -28,7 +33,7 @@ DESCRIPTION high scores) you must locate the Amulet of Yendor which is somewhere below the 20th level of the dungeon and get it out. Few people achieve this; most never do. Those who have done so go down in history as he- - roes among heroes - and then they find ways of making the game even + roes among heroes -- and then they find ways of making the game even harder. See the Guidebook section on Conduct if this game has gotten too easy for you. @@ -42,20 +47,22 @@ DESCRIPTION The environment variable NETHACKOPTIONS can be used to initialize many run-time options. The ? command provides a description of these - options and syntax. (The -dec and -ibm command line options are equiv- - alent to the decgraphics and ibmgraphics run-time options described - there, and are provided purely for convenience on systems supporting - multiple types of terminals.) + options and syntax. (The -dec and -ibm command line options are mutu- + ally exclusive and are equivalent to the decgraphics and ibmgraphics + run-time options described there, and are provided purely for conve- + nience on systems supporting multiple types of terminals.) - Because the option list can be very long (particularly when specifying - graphics characters), options may also be included in a configuration - file. The default is located in your home directory and named - .nethackrc on Unix systems. On other systems, the default may be dif- - ferent, usually NetHack.cnf. On DOS or Windows, the name is - defaults.nh, while on the Macintosh or BeOS, it is NetHack Defaults. - The configuration file's location may be specified by setting NETHACK- - OPTIONS to a string consisting of an @ character followed by the file- - name. + Because the option list can be very long, options may also be included + in a configuration file. The default is located in your home directory + and named .nethackrc on UNIX systems (including descendants such as + linux, NetBSD, and macOS). On Windows, the name is also .nethackrc but + the location can vary (see --showpaths below). On other systems, the + default may be different, possibly NetHack.cnf. On MS-DOS, the name is + defaults.nh in NetHack's directory (folder), while on VMS|OpenVMS it is + nethack.ini in your home directory. The default configuration file may + be overridden via the --nethackrc:rc-file command line option or by + setting NETHACKOPTIONS in your environment to a string consisting of an + @ character followed by the path and filename. The -u playername option supplies the answer to the question "Who are you?". It overrides any name from the options or configuration file, @@ -80,51 +87,85 @@ DESCRIPTION -p profession can be used to determine the character profession, also known as the role. You can specify either the male or female name for the character role, or the first three characters of the role as an - abbreviation. -p @ has been retained to explicitly request that a ran- - dom role be chosen. It may need to be quoted with a backslash (\@) if - @ is the "kill" character (see "stty") for the terminal, in order to - prevent the current input line from being cleared. + abbreviation. Likewise, -r race can be used to explicitly request that a race be cho- sen. - Leaving out any of these characteristics will result in you being - prompted during the game startup for the information. + The -A|-Arc | -B|-Bar | -C|-Cav | -H|-Hea | -K|-Kni | -M|-Mon | -P|-Pri + | -R|-Rog | -Ran | -S|-Sam | -T|-Tou | -V|-Val | -W|-Wiz options for + role selection are maintained for compatibility with older versions of + the program. They are mutually exclusive and the single-letter form + must be uppercase. Ranger has no single-letter choice because -R is + already used for the Rogue role. - The -s option alone will print out the list of your scores on the cur- - rent version. An immediately following -v reports on all versions - present in the score file. The -s may also be followed by arguments -p - and -r to print the scores of particular roles and races only. It may - also be followed by one or more player names to print the scores of the - players mentioned, by 'all' to print out all scores, or by a number to - print that many top scores. + -@ tells nethack to choose any omitted characteristics (profes- + sion/role, race, gender, alignment) randomly without prompting. Other- + wise, leaving out any of these characteristics will result in you being + prompted during game startup for the information. The -n option suppresses printing of any news from the game administra- tor. - The -D or -X option will start the game in a special non-scoring dis- - covery mode. -D will, if the player is the game administrator, start - in debugging (wizard) mode instead. + The -X option will start the game in a special non-scoring discovery + mode (also known as explore mode). -D will start the game in debug + mode (also known as wizard mode) after changing the character name to + "wizard", if the player is allowed. Otherwise it will switch to -X. + Control of who is allowed to use debug mode is done via the "WIZARDS=" + line in nethack's sysconf file. - The -d option, which must be the first argument if it appears, supplies - a directory which is to serve as the playground. It overrides the - value from NETHACKDIR, HACKDIR, or the directory specified by the game - administrator during compilation (usually /usr/games/lib/nethackdir). - This option is usually only useful to the game administrator. The - playground must contain several auxiliary files such as help files, the - list of top scorers, and a subdirectory save where games are saved. + The -d or --directory option, which must be the first argument if it + appears, supplies a directory which is to serve as the playground. It + overrides the value from NETHACKDIR, HACKDIR, or the directory speci- + fied by the game administrator during compilation (usually + /usr/games/lib/nethackdir). This option is usually only useful to the + game administrator. The playground must contain several auxiliary + files such as help files, the list of top scorers, and a subdirectory + save where games are saved. - --showpaths can be used to cause NetHack to show where it is expecting - to find various configuration files. + The -w or --windowtype interface option can be used to specify which + interface to use if the program has been built with support for more + than one. Specifying a value on the command line overrides any value + specified in the run-time configuration file. NetHack's #version com- + mand shows available interfaces. + + The --nethackrc:RC-file option will use RC-file instead of the default + run-time configuration file (typically ~/.nethackrc) and the + --no-nethackrc option can be used to skip any run-time configuration + file. + + Some options provide feedback and then exit rather than play the game: + + The -s or --scores option alone will print out the list of your scores + on the current version. An immediately following -v reports on all + versions present in the score file. '-s|-s -v' may also be followed by + arguments -p profession and -r race to print the scores of particular + roles and races only. Either can be specified multiple times to + include more than one role or more than one race. When both are speci- + fied, score entries which match either the role or the race (or both) + are printed rather than just entries which match both. '-s|-s -v' may + be followed by one or more player names to print the scores of the + players mentioned, by 'all' to print out all scores, or by a number to + print that many top scores. Combining names with role or race or both + will report entries which match any of those rather than just the ones + which match all. --version can be used to cause NetHack to show the version information - it was compiled with, then exit. That will include the git commit hash + it was compiled with, then exit. That will include the git commit hash if the information was available when the game was compiled. On some - platforms, such as windows and macosx, a variation --version:paste can + platforms, such as Windows and macOS, a variation --version:paste can be used to cause NetHack to show the version information, then exit, while also leaving a copy of the version information in the paste buf- fer or clipboard for potential insertion into things like bug reports. + --showpaths can be used to cause NetHack to show where it is expecting + to find various files. Among other things it shows the path to and + name for the player's run-time configuration file, a text file which + can be editted to customize aspects of how the game operates. + + --usage or --help will display information similar to this manual page, + then exit. Use 'nethack --usage | more' to read it a page at a time. + AUTHORS Jay Fenlason (+ Kenny Woodland, Mike Thome and Jon Payne) wrote the original hack, very much like rogue (but full of bugs). @@ -153,18 +194,20 @@ FILES nhdat, instead of being separate files. nethack The program itself. + Guidebook | Guidebook.txt NetHack's user manual. data, oracles, rumors Data files used by NetHack. - bogusmon another data file. + bogusmon Another data file. engrave, epitaph, tribute Still more data files. symbols Data file holding sets of specifications for how to display monsters, objects, and map features. - options Data file containing a description of the + options Data file containing a description of the build-time option settings. - help, hh, cmdhelp Help data files. + help, hh, cmdhelp Help data files. ('cmdhelp' is obsolete.) opthelp, optmenu, wizhelp More help data files. - *.lua Predefined special levels, dungeon control - for special levels, quest texts + keyhelp, usagehlp Even more help data files. + *.lua Predefined special levels, dungeon control + for special levels, quest texts. history A short history of NetHack. license Rules governing redistribution. record The list of top scorers. @@ -182,9 +225,10 @@ FILES character named 'cccccc' when there's no limit on number of active games. perm Lock file for xlock.0 or UUcccccc.0. - bonesDD.nn Descriptions of the ghost and belongings - of a deceased adventurer who met his - or her demise on level 'nn'. + bonD0.nn Descriptions of the ghost and belongings + of a deceased adventurer who met his or + her demise on level 'nn'. A subsequent + character might encounter this old level. save/ A subdirectory containing saved games. @@ -196,6 +240,9 @@ FILES changed except by updating source file "config.h" and rebuilding the program. + NetHack's Guidebook might not be present if whoever packaged or + installed the program distribution neglected to include it. + In a perfect world, 'paniclog' would remain empty. ENVIRONMENT @@ -208,10 +255,9 @@ ENVIRONMENT MAILREADER Replacement for default reader (probably /bin/mail or /usr/ucb/mail). NETHACKDIR or HACKDIR Playground. - NETHACKOPTIONS String predefining several NetHack - options. + NETHACKOPTIONS String predefining several NetHack options. - If the same option is specified in both NETHACKOPTIONS and .nethackrc, + If the same option is specified in both NETHACKOPTIONS and .nethackrc, the value assigned in NETHACKOPTIONS takes precedence. SHOPTYPE and SPLEVTYPE can be used in debugging (wizard) mode. @@ -224,8 +270,8 @@ BUGS Probably infinite. COPYRIGHT - This file is Copyright (C) Robert Patrick Rankin, 2022 for version - NetHack-3.7:1.23. NetHack may be freely redistributed. See license + This file is Copyright (C) Robert Patrick Rankin, 2022 for version + NetHack-3.7:1.27. NetHack may be freely redistributed. See license for details. Dungeons & Dragons is a Trademark of Wizards of the Coast, Inc.