Original version - Eric S. Raymond
(Edited and expanded for 3.7 by Mike Stephenson and others)
- February 07, 2023
+ February 09, 2023
you awaken suddenly and cry out, terrified at the vivid recollec-
tion of the strange and powerful creatures that seem to be lurk-
ing behind every corner of the dungeon in your dream. Could
- these details haunting your dreams be real? As each night pass-
- es, you feel the desire to enter the mysterious caverns near the
- ruins grow stronger. Each morning, however, you quickly put the
- idea out of your head as you recall the tales of those who en-
- tered the caverns before you and did not return. Eventually you
- can resist the yearning to seek out the fantastic place in your
- dreams no longer. After all, when other adventurers came back
- this way after spending time in the caverns, they usually seemed
- better off than when they passed through the first time. And who
- was to say that all of those who did not return had not just kept
- going?
+ these details haunting your dreams be real? As each night
+ passes, you feel the desire to enter the mysterious caverns near
+ the ruins grow stronger. Each morning, however, you quickly put
+ the idea out of your head as you recall the tales of those who
+ entered the caverns before you and did not return. Eventually
+ you can resist the yearning to seek out the fantastic place in
+ your dreams no longer. After all, when other adventurers came
+ back this way after spending time in the caverns, they usually
+ seemed better off than when they passed through the first time.
+ And who was to say that all of those who did not return had not
+ just kept going?
Asking around, you hear about a bauble, called the Amulet of
Yendor by some, which, if you can find it, will bring you great
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
you have seen on the current dungeon level; as you explore more
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
NetHack offers a variety of display options. The options
available to you will vary from port to port, depending on the
capabilities of your hardware and software, and whether various
- compile-time options were enabled when your executable was creat-
- ed. The three possible display options are: a monochrome charac-
- ter interface, a color character interface, and a graphical in-
+ compile-time options were enabled when your executable was cre-
+ ated. The three possible display options are: a monochrome char-
+ acter interface, a color character interface, and a graphical in-
terface using small pictures called tiles. The two character in-
terfaces allow fonts with other characters to be substituted, but
the default assignments use standard ASCII characters to repre-
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
3.1. The status lines (bottom)
- The bottom two (or three) lines of the screen contain sever-
- al cryptic pieces of information describing your current status.
- Figure 1 shows the traditional two-line status area below the
- map. Figure 2 shows just the status area, when the statuslines:3
- option has been set (not all interfaces support this option). If
- any status line becomes wider than the screen, you might not see
- all of it due to truncation. When the numbers grow bigger and
- multiple conditions are present, the two-line format will run out
- of room on the second line, but statuslines:2 is the default be-
- cause a basic 24-line terminal isn't tall enough for the third
- line.
+ The bottom two (or three) lines of the screen contain sev-
+ eral cryptic pieces of information describing your current sta-
+ tus. Figure 1 shows the traditional two-line status area below
+ the map. Figure 2 shows just the status area, when the sta-
+ tuslines:3 option has been set (not all interfaces support this
+ option). If any status line becomes wider than the screen, you
+ might not see all of it due to truncation. When the numbers grow
+ bigger and multiple conditions are present, the two-line format
+ will run out of room on the second line, but statuslines:2 is the
+ default because a basic 24-line terminal isn't tall enough for
+ the third line.
Here are explanations of what the various status items mean:
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
you have available for spell casting. Again, resting will
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
ing a `*' lists your entire inventory, so you can see the
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
for which one to take off. (Note that this treats a cloak
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
This command may also be used to remove accessories. The
prompt for which inventory item to take off only lists worn
armor, but a worn accessory can be chosen. (See the `R'
- command above. It lists accessories as the inventory choic-
- es but will accept an item of armor and attempt to take it
- off.)
+ command above. It lists accessories as the inventory
+ choices but will accept an item of armor and attempt to take
+ it off.)
^T Teleport, if you have the ability.
weapon slot.
The latter is used as your secondary weapon when engaging in
- two-weapon combat. Note that if one of these slots is emp-
- ty, the exchange still takes place.
+ two-weapon combat. Note that if one of these slots is
+ empty, the exchange still takes place.
X Toggle two-weapon combat, if your character can do it. Also
available via the "#twoweapon" extended command.
that redundant, such as Caveman or Priestess), and
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
(R)UNIX is a registered trademark of The Open Group.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
Switch from normal play to non-scoring explore mode. De-
fault key is `M-X'.
- Requires confirmation; default response is n (no). To real-
- ly switch to explore mode, respond with y. You can set the
- paranoid_confirmation:quit option to require a response of
- yes instead.
+ Requires confirmation; default response is n (no). To re-
+ ally switch to explore mode, respond with y. You can set
+ the paranoid_confirmation:quit option to require a response
+ of yes instead.
#fight
Prefix key to force fight a direction, even if you see noth-
ber_pad
#fire
- Fire ammunition from quiver, possibly autowielding a launch-
- er, or hit with a wielded polearm. Default key is `f'.
+ Fire ammunition from quiver, possibly autowielding a
+ launcher, or hit with a wielded polearm. Default key is
+ `f'.
#force
Force a lock. Autocompletes. Default key is `M-f'.
#glance
- Show what type of thing a map symbol corresponds to. De-
+ Show what type of thing a map symbol corresponds to. De-
fault key is `;'.
#help
- Show the help menu. Default key is `?', and also `h' if
+ Show the help menu. Default key is `?', and also `h' if
number_pad is on.
#herecmdmenu
Show a menu of possible actions directed at your current lo-
- cation. The menu is limited to a subset of the likeliest
- actions, not an exhaustive set of all possibilities. Auto-
+ cation. The menu is limited to a subset of the likeliest
+ actions, not an exhaustive set of all possibilities. Auto-
completes.
- If mouse support is enabled and the herecmd_menu option is
- On, clicking on the hero (or steed when mounted) will exe-
+ If mouse support is enabled and the herecmd_menu option is
+ On, clicking on the hero (or steed when mounted) will exe-
cute this command.
#history
#inventtype
Inventory specific item types. Default key is `I'.
- #invoke
- Invoke an object's special powers. Autocompletes. Default
- NetHack 3.7 February 07, 2023
+
+ NetHack 3.7 February 09, 2023
+ #invoke
+ Invoke an object's special powers. Autocompletes. Default
key is `M-i'.
#jump
- Jump to another location. Autocompletes. Default key is
+ Jump to another location. Autocompletes. Default key is
`M-j', and also `j' if number_pad is on.
#kick
- Kick something. Default key is `^D', and `k' if number_pad
+ Kick something. Default key is `^D', and `k' if number_pad
is on.
#known
Show what object types have been discovered. Default key is
`\'.
- The `m' prefix allows assigning a new value to the sortdis-
- coveries option to control the order in which the discover-
+ The `m' prefix allows assigning a new value to the sortdis-
+ coveries option to control the order in which the discover-
ies are displayed.
#knownclass
The `m' prefix operates the same as for "#known".
#levelchange
- Change your experience level. Autocompletes. Debug mode
+ Change your experience level. Autocompletes. Debug mode
only.
#lightsources
Look at what is here, under you. Default key is `:'.
#loot
- Loot a box or bag on the floor beneath you, or the saddle
- from a steed standing next to you. Autocompletes. Precede
- with the `m' prefix to skip containers at your location and
+ Loot a box or bag on the floor beneath you, or the saddle
+ from a steed standing next to you. Autocompletes. Precede
+ with the `m' prefix to skip containers at your location and
go directly to removing a saddle. Default key is `M-l', and
also `l' if number_pad is on.
#monster
- Use a monster's special ability (when polymorphed into mon-
+ Use a monster's special ability (when polymorphed into mon-
ster form). Autocompletes. Default key is `M-m'.
#name
- Name a monster, an individual object, or a type of object.
- Same as "#call". Autocompletes. Default keys are `N', `M-
+ Name a monster, an individual object, or a type of object.
+ Same as "#call". Autocompletes. Default keys are `N', `M-
n', and `M-N'.
#offer
- Offer a sacrifice to the gods. Autocompletes. Default key
- is `M-o'.
-
+ Offer a sacrifice to the gods. Autocompletes. Default key
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- You'll need to find an altar to have any chance at success.
- Corpses of recently killed monsters are the fodder of
+ is `M-o'.
+
+ You'll need to find an altar to have any chance at success.
+ Corpses of recently killed monsters are the fodder of
choice.
The `m' prefix skips offering any items which are on the al-
Open a door. Default key is `o'.
#options
- Show and change option settings. Default key is `O'. Pre-
+ Show and change option settings. Default key is `O'. Pre-
cede with the `m' prefix to show advanced options.
#optionsfull
- Show advanced game option settings. No default key. Pre-
+ Show advanced game option settings. No default key. Pre-
cede with the `m' prefix to execute the simpler options com-
- mand. (Mainly useful if you use BINDING=O:optionsfull to
- switch `O' from simple options back to traditional advanced
+ mand. (Mainly useful if you use BINDING=O:optionsfull to
+ switch `O' from simple options back to traditional advanced
options.)
#overview
- Display information you've discovered about the dungeon.
- Any visited level (unless forgotten due to amnesia) with an
- annotation is included, and many things (altars, thrones,
- fountains, and so on; extra stairs leading to another dun-
- geon branch) trigger an automatic annotation. If dungeon
+ Display information you've discovered about the dungeon.
+ Any visited level (unless forgotten due to amnesia) with an
+ annotation is included, and many things (altars, thrones,
+ fountains, and so on; extra stairs leading to another dun-
+ geon branch) trigger an automatic annotation. If dungeon
overview is chosen during end-of-game disclosure, every vis-
- ited level will be included regardless of annotations. Au-
+ ited level will be included regardless of annotations. Au-
tocompletes. Default keys are `^O', and `M-O'.
#panic
Test the panic routine. Terminates the current game. Auto-
completes. Debug mode only.
- Asks for confirmation; default is n (no); continue playing.
- To really panic, respond with y. You can set the para-
- noid_confirmation:quit option to require a response of yes
+ Asks for confirmation; default is n (no); continue playing.
+ To really panic, respond with y. You can set the para-
+ noid_confirmation:quit option to require a response of yes
instead.
#pay
Pay your shopping bill. Default key is `p'.
#perminv
- If persistent inventory display is supported and enabled
- (with the perm_invent option), interact with it instead of
- with the map. You'll be prompted for menu scrolling key-
- strokes such as `>' and `<'. Press Return or Escape to re-
+ If persistent inventory display is supported and enabled
+ (with the perm_invent option), interact with it instead of
+ with the map. You'll be prompted for menu scrolling key-
+ strokes such as `>' and `<'. Press Return or Escape to re-
sume normal play. Default key is `|'.
#pickup
Pick up things at the current location. Default key is `,'.
- The `m' prefix forces use of a menu.
-
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
+ The `m' prefix forces use of a menu.
+
#polyself
Polymorph self. Autocompletes. Debug mode only.
#pray
- Pray to the gods for help. Autocompletes. Default key is
+ Pray to the gods for help. Autocompletes. Default key is
`M-p'.
- Praying too soon after receiving prior help is a bad idea.
- (Hint: entering the dungeon alive is treated as having re-
+ Praying too soon after receiving prior help is a bad idea.
+ (Hint: entering the dungeon alive is treated as having re-
ceived help. You probably shouldn't start off a new game by
- praying right away.) Since using this command by accident
- can cause trouble, there is an option to make you confirm
- your intent before praying. It is enabled by default, and
- you can reset the paranoid_confirmation option to disable
+ praying right away.) Since using this command by accident
+ can cause trouble, there is an option to make you confirm
+ your intent before praying. It is enabled by default, and
+ you can reset the paranoid_confirmation option to disable
it.
#prevmsg
- Show previously displayed game messages. Default key is
+ Show previously displayed game messages. Default key is
`^P'.
#puton
- Put on an accessory (ring, amulet, etc). Default key is
+ Put on an accessory (ring, amulet, etc). Default key is
`P'.
#quaff
Quaff (drink) something. Default key is `q'.
- The `m' prefix skips drinking from a fountain or sink if
+ The `m' prefix skips drinking from a fountain or sink if
there is one at your location.
#quit
Quit the program without saving your game. Autocompletes.
- Since using this command by accident would throw away the
- current game, you are asked to confirm your intent before
+ Since using this command by accident would throw away the
+ current game, you are asked to confirm your intent before
quitting. Default response is n (no); continue playing. To
- really quit, respond with y. You can set the paranoid_con-
+ really quit, respond with y. You can set the paranoid_con-
firmation:quit option to require a response of yes instead.
#quiver
Select ammunition for quiver. Default key is `Q'.
#read
- Read a scroll, a spellbook, or something else. Default key
+ Read a scroll, a spellbook, or something else. Default key
is `r'.
#redraw
- Redraw the screen. Default key is `^R', and also `^L' if
+ Redraw the screen. Default key is `^R', and also `^L' if
number_pad is on.
#remove
- Remove an accessory (ring, amulet, etc). Default key is
- `R'.
-
+ Remove an accessory (ring, amulet, etc). Default key is
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
+ `R'.
+
#repeat
Repeat the previous command. Default key is `^A'.
#reqmenu
- Prefix key to modify the behavior or request menu from some
- commands. Prevents autopickup when used with movement com-
+ Prefix key to modify the behavior or request menu from some
+ commands. Prevents autopickup when used with movement com-
mands. Default key is `m'.
#retravel
key is `C-_'. See also #travel.
#ride
- Ride (or stop riding) a saddled creature. Autocompletes.
+ Ride (or stop riding) a saddled creature. Autocompletes.
Default key is `M-R'.
#rub
- Rub a lamp or a stone. Autocompletes. Default key is `M-
+ Rub a lamp or a stone. Autocompletes. Default key is `M-
r'.
#run
- Prefix key to run towards a direction. Default key is `G'
- when number_pad is off, `5' when number_pad is set to 1 or
+ Prefix key to run towards a direction. Default key is `G'
+ when number_pad is off, `5' when number_pad is set to 1 or
3, otherwise `M-5' when it is set to 2 or 4.
#rush
Prefix key to rush towards a direction. Default is `g' when
- number_pad is off, `M-5' when number_pad is set to 1 or 3,
+ number_pad is off, `M-5' when number_pad is set to 1 or 3,
otherwise `5' when it is set to 2 or 4.
#save
Save the game and exit the program. Default key is `S'.
#saveoptions
- Save configuration options to the config file. This will
- overwrite the file, removing all comments, so if you have
+ Save configuration options to the config file. This will
+ overwrite the file, removing all comments, so if you have
manually edited the config file, don't use this.
#search
- Search for traps and secret doors around you. Default key
+ Search for traps and secret doors around you. Default key
is `s'.
#seeall
#seearmor
Show the armor currently worn. Default key is `['.
- #seerings
- Show the ring(s) currently worn. Default key is `='.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
+ #seerings
+ Show the ring(s) currently worn. Default key is `='.
+
#seetools
Show the tools currently in use. Default key is `('.
Show the weapon currently wielded. Default key is `)'.
#shell
- Do a shell escape, switching from NetHack to a subprocess.
- Can be disabled at the time the program is built. When en-
- abled, access for specific users can be controlled by the
- system configuration file. Use the shell command `exit' to
+ Do a shell escape, switching from NetHack to a subprocess.
+ Can be disabled at the time the program is built. When en-
+ abled, access for specific users can be controlled by the
+ system configuration file. Use the shell command `exit' to
return to the game. Default key is `!'.
#showgold
- Report the gold in your inventory, including gold you know
- about in containers you're carrying. If you are inside a
- shop, report any credit or debt you have in that shop. De-
+ Report the gold in your inventory, including gold you know
+ about in containers you're carrying. If you are inside a
+ shop, report any credit or debt you have in that shop. De-
fault key is `$'.
#showspells
List and reorder known spells. Default key is `+'.
#showtrap
- Describe an adjacent trap, possibly covered by objects or a
- monster. To be eligible, the trap must already be discov-
+ Describe an adjacent trap, possibly covered by objects or a
+ monster. To be eligible, the trap must already be discov-
ered. (The "#terrain" command can display your map with all
objects and monsters temporarily removed, making it possible
to see all discovered traps.) Default key is `^'.
Sit down. Autocompletes. Default key is `M-s'.
#stats
- Show memory usage statistics. Autocompletes. Debug mode
+ Show memory usage statistics. Autocompletes. Debug mode
only.
#suspend
- Suspend the game, switching from NetHack to the terminal it
- was started from without performing save-and-exit. Can be
- disabled at the time the program is built. When enabled,
- mainly useful for tty and curses interfaces on UNIX. Use
- the shell command `fg' to return to the game. Default key
+ Suspend the game, switching from NetHack to the terminal it
+ was started from without performing save-and-exit. Can be
+ disabled at the time the program is built. When enabled,
+ mainly useful for tty and curses interfaces on UNIX. Use
+ the shell command `fg' to return to the game. Default key
is `^Z'.
#swap
#takeoff
Take off one piece of armor. Default key is `T'.
- #takeoffall
- Remove all armor. Default key is `A'.
-
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
+ #takeoffall
+ Remove all armor. Default key is `A'.
+
#teleport
Teleport around the level. Default key is `^T'.
#terrain
- Show map without obstructions. In normal play you can view
+ Show map without obstructions. In normal play you can view
the explored portion of the current level's map without mon-
- sters; without monsters and objects; or without monsters,
+ sters; without monsters and objects; or without monsters,
objects, and traps.
- In explore mode, you can choose to view the full map rather
+ In explore mode, you can choose to view the full map rather
than just its explored portion. In debug mode there are ad-
ditional choices.
- Autocompletes. Default key is `<del>' or `<delete>' (see
+ Autocompletes. Default key is `<del>' or `<delete>' (see
Del above).
#therecmdmenu
- Show a menu of possible actions directed at a location next
- to you. The menu is limited to a subset of the likeliest
- actions, not an exhaustive set of all possibilities. Auto-
+ Show a menu of possible actions directed at a location next
+ to you. The menu is limited to a subset of the likeliest
+ actions, not an exhaustive set of all possibilities. Auto-
completes.
#throw
Look at the timeout queue. Autocompletes. Debug mode only.
#tip
- Tip over a container (bag or box) to pour out its contents.
- Autocompletes. Default key is `M-T'. The `m' prefix makes
+ Tip over a container (bag or box) to pour out its contents.
+ Autocompletes. Default key is `M-T'. The `m' prefix makes
the command use a menu.
#travel
- Travel to a specific location on the map. Default key is
+ Travel to a specific location on the map. Default key is
`_'. Using the "request menu" prefix shows a menu of inter-
- esting targets in sight without asking to move the cursor.
- When picking a target with cursor and the autodescribe op-
- tion is on, the top line will show "(no travel path)" if
- your character does not know of a path to that location.
+ esting targets in sight without asking to move the cursor.
+ When picking a target with cursor and the autodescribe op-
+ tion is on, the top line will show "(no travel path)" if
+ your character does not know of a path to that location.
See also #retravel.
#turn
Toggle two-weapon combat on or off. Autocompletes. Default
key is `X', and also `M-2' if number_pad is off.
- Note that you must use suitable weapons for this type of
+ Note that you must use suitable weapons for this type of
combat, or it will be automatically turned off.
- #untrap
- Untrap something (trap, door, or chest). Default key is `M-
-
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
+ #untrap
+ Untrap something (trap, door, or chest). Default key is `M-
u', and `u' if number_pad is on.
- In some circumstances it can also be used to rescue trapped
+ In some circumstances it can also be used to rescue trapped
monsters.
#up
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) or were already corpses when placed on
+ 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) or were already corpses when placed on
the map.
- Using the "request menu" prefix prior to #vanquished brings
- up a menu of sorting orders available (provided that the
+ Using the "request menu" prefix prior to #vanquished brings
+ up a menu of sorting orders available (provided that the
vanquished monsters list contains at least two types of mon-
- sters). Whichever ordering is picked gets assigned to the
- sortvanquished option so is remembered for subsequent #van-
+ sters). Whichever ordering is picked gets assigned to the
+ sortvanquished option so is remembered for subsequent #van-
quished requests. During end-of-game disclosure, when asked
- whether to show vanquished monsters answering `a' will let
+ 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.
- The second paragraph lists the user interface(s) that are
- included. If there are more than one, you can use the win-
+ The second paragraph lists the user interface(s) that are
+ included. If there are more than one, you can use the win-
dowtype option in your run-time configuration file to select
the one you want.
Autocompletes. Default key is `M-v'.
#versionshort
- Show the program's version number, plus the date and time
- that the running copy was built from sources (not the ver-
+ Show the program's version number, plus the date and time
+ that the running copy was built from sources (not the ver-
sion's release date). Default key is `v'.
#vision
Show vision array. Autocompletes. Debug mode only.
#wait
- Rest one move while doing nothing. Default key is `.', and
+ Rest one move while doing nothing. Default key is `.', and
also ` ' if rest_on_space is on.
- #wear
- Wear a piece of armor. Default key is `W'.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
+ #wear
+ Wear a piece of armor. Default key is `W'.
+
#whatdoes
Tell what a key does. Default key is `&'.
#whatis
- Show what type of thing a symbol corresponds to. Default
+ Show what type of thing a symbol corresponds to. Default
key is `/'.
#wield
Debug mode only.
#wizbury
- Bury objects under and around you. Autocompletes. Debug
+ Bury objects under and around you. Autocompletes. Debug
mode only.
#wizcast
Cast any spell. Debug mode only.
#wizdetect
- Reveal hidden things (secret doors or traps or unseen mon-
- sters) within a modest radius. No time elapses. Autocom-
+ 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
- than one. Autocompletes. Debug mode only. Default key is
+ than one. Autocompletes. Debug mode only. Default key is
`^G'.
#wizidentify
mode only.
#wizkill
- Remove monsters from play by just pointing at them. By de-
+ Remove monsters from play by just pointing at them. By de-
fault the hero gets credit or blame for killing the targets.
- Precede this command with the `m' prefix to override that.
+ Precede this command with the `m' prefix to override that.
Autocompletes. Debug mode only.
#wizlevelport
Teleport to another level. Autocompletes. Debug mode only.
Default key is `^V'.
- #wizmap
- Map the level. Autocompletes. Debug mode only. Default
-
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
+ #wizmap
+ Map the level. Autocompletes. Debug mode only. Default
key is `^F'.
#wizrumorcheck
- Verify rumor boundaries by displaying first and last true
+ Verify rumor boundaries by displaying first and last true
rumors and first and last false rumors.
- Also displays first, second, and last random engravings,
+ Also displays first, second, and last random engravings,
epitaphs, and hallucinatory monsters.
Autocompletes. Debug mode only.
#wizseenv
- Show map locations' seen vectors. Autocompletes. Debug
+ Show map locations' seen vectors. Autocompletes. Debug
mode only.
#wizsmell
Smell monster. Autocompletes. Debug mode only.
#wizwhere
- Show locations of special levels. Autocompletes. Debug
+ Show locations of special levels. Autocompletes. Debug
mode only.
#wizwish
- Wish for something. Autocompletes. Debug mode only. De-
+ Wish for something. Autocompletes. Debug mode only. De-
fault key is `^W'.
#wmode
If your keyboard has a meta key (which, when pressed in com-
- bination with another key, modifies it by setting the "meta"
- [8th, or "high"] bit), you can invoke many extended commands by
+ bination with another key, modifies it by setting the "meta"
+ [8th, or "high"] bit), you can invoke many extended commands by
meta-ing the first letter of the command.
- On Windows and MS-DOS, the "Alt" key can be used in this
- fashion. On other systems, if typing "Alt" plus another key
- transmits a two character sequence consisting of an Escape fol-
- lowed by the other key, you may set the altmeta option to have
- NetHack combine them into meta+<key>. (This combining action on-
- ly takes place when NetHack is expecting a command to execute,
+ On Windows and MS-DOS, the "Alt" key can be used in this
+ fashion. On other systems, if typing "Alt" plus another key
+ transmits a two character sequence consisting of an Escape fol-
+ lowed by the other key, you may set the altmeta option to have
+ NetHack combine them into meta+<key>. (This combining action
+ only takes place when NetHack is expecting a command to execute,
not when accepting input to name something or to make a wish.)
- Unlike control characters, where ^x and ^X denote the same
+ Unlike control characters, where ^x and ^X denote the same
thing, meta characters are case-sensitive: M-x and M-X represent
- different things. Some commands which can be run via a meta
- character require that the letter be capitalized because the
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- lower-case equivalent is used for another command, so the three
+ different things. Some commands which can be run via a meta
+ character require that the letter be capitalized because the
+ lower-case equivalent is used for another command, so the three
key combination meta+Shift+<letter> is needed.
M-v #version
- M-V #vanquished
-
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
+ M-V #vanquished
+
M-w #wipe
M-X #exploremode
- If the number_pad option is on, some additional letter com-
+ If the number_pad option is on, some additional letter com-
mands are available:
h #help
5. Rooms and corridors
- Rooms and corridors in the dungeon are either lit or dark.
- Any lit areas within your line of sight will be displayed; dark
- areas are only displayed if they are within one space of you.
+ Rooms and corridors in the dungeon are either lit or dark.
+ Any lit areas within your line of sight will be displayed; dark
+ areas are only displayed if they are within one space of you.
Walls and corridors remain on the map as you explore them.
- Secret corridors are hidden and appear to be solid rock.
- You can find them with the `s' (search) command when adjacent to
+ 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
- successful, secret corridors become ordinary open corridor loca-
- tions. Mapping magic reveals secret corridors, so converts them
+ successful, secret corridors become ordinary open corridor loca-
+ tions. Mapping magic reveals secret corridors, so converts them
into ordinary corridors and shows them as such.
5.1. Doorways
Doorways connect rooms and corridors. Some doorways have no
- doors; you can walk right through. Others have doors in them,
+ doors; you can walk right through. Others have doors in them,
which may be open, closed, or locked. To open a closed door, use
- the `o' (open) command; to close it again, use the `c' (close)
- 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
+ the `o' (open) command; to close it again, use the `c' (close)
+ 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 attri-
bute.
- Open doors cannot be entered diagonally; you must approach
- them straight on, horizontally or vertically. Doorways without
+ Open doors cannot be entered diagonally; you must approach
+ them straight on, horizontally or vertically. Doorways without
doors are not restricted in this fashion except on one particular
level (described by "#overview" as "a primitive area").
-
-
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- Unlocking magic exists but usually won't be available early
+ Unlocking magic exists but usually won't be available early
on. You can get through a locked door without magic by first us-
- ing an unlocking tool with the `a' (apply) command, and then
+ ing an unlocking tool with the `a' (apply) command, and then
opening it. By default the autounlock option is also enabled, so
- if you attempt to open (via `o' or autoopen) a locked door while
- carrying an unlocking tool, you'll be asked whether to use it on
- the door's lock. Alternatively, you can break a closed door
- (whether locked or not) down by kicking it via the `^D' (kick)
- command. Kicking down a door destroys it and makes a lot of
+ if you attempt to open (via `o' or autoopen) a locked door while
+ carrying an unlocking tool, you'll be asked whether to use it on
+ the door's lock. Alternatively, you can break a closed door
+ (whether locked or not) down by kicking it via the `^D' (kick)
+ command. Kicking down a door destroys it and makes a lot of
noise which might wake sleeping monsters.
- 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
- makes a lot of noise. The "#untrap" command can be used to
- search a door for traps but might take multiple attempts to find
+ 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
+ makes a lot of noise. The "#untrap" command can be used to
+ search a door for traps but might take multiple attempts to find
one. When one is found, you'll be asked whether to try to disarm
- it. If you accede, success will eliminate the trap but failure
- will set off the trap's explosion. (If you decline, you effec-
+ it. If you accede, success will eliminate the trap but failure
+ will set off the trap's explosion. (If you decline, you effec-
tively forget that a trap was found there.)
- Closed doors can be useful for shutting out monsters. Most
- monsters cannot open closed doors, although a few don't need to
- (for example, ghosts can walk through doors and fog clouds can
- flow under them). Some monsters who can open doors can also use
+ Closed doors can be useful for shutting out monsters. Most
+ monsters cannot open closed doors, although a few don't need to
+ (for example, ghosts can walk through doors and fog clouds can
+ flow under them). Some monsters who can open doors can also use
unlocking tools. And some (giants) can smash doors.
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
- (possibly many tries if your luck is poor). Once found they are
- in all ways equivalent to normal doors. Mapping magic does not
+ inside a room) or solid rock (from outside). You can find them
+ with the `s' (search) command but it might take multiple tries
+ (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.
5.2. Traps (`^')
- There are traps throughout the dungeon to snare the unwary
- intruder. For example, you may suddenly fall into a pit and be
- stuck for a few turns trying to climb out (see below). A trap
- usually won't appear on your map until you trigger it by moving
+ There are traps throughout the dungeon to snare the unwary
+ intruder. For example, you may suddenly fall into a pit and be
+ stuck for a few turns trying to climb out (see below). A trap
+ usually won't appear on your map until you trigger it by moving
onto it, you see someone else trigger it, or you discover it with
- the `s' (search) command (multiple attempts are often needed; if
- your luck is poor, many attempts might be needed). Wands of se-
- cret door detection and spell of detect unseen also reveal traps
- within a modest radius but only if the trap is also within line-
+ the `s' (search) command (multiple attempts are often needed; if
+ your luck is poor, many attempts might be needed). Wands of se-
+ cret door detection and spell of detect unseen also reveal traps
+ within a modest radius but only if the trap is also within line-
of-sight (whether you can see at the time or not). There is also
other magic which can reveal traps.
- Monsters can fall prey to traps, too, which can potentially
- be used as a defensive strategy. Unfortunately traps can be
- harmful to your pet(s) as well. Monsters, including pets, usual-
- ly will avoid moving onto a trap which is shown on your map if
+ Monsters can fall prey to traps, too, which can potentially
+ be used as a defensive strategy. Unfortunately traps can be
+ harmful to your pet(s) as well. Monsters, including pets, usu-
+ ally will avoid moving onto a trap which is shown on your map if
they have encountered that type of trap before.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- Some traps such as pits, bear traps, and webs hold you in
- one place. You can escape by simply trying to move to an adja-
+ Some traps such as pits, bear traps, and webs hold you in
+ one place. You can escape by simply trying to move to an adja-
cent spot and repeat as needed; eventually you will get free.
- Other traps can send you to different locations. Tele-
- porters send you elsewhere on the same dungeon level. Level
- teleporters send you to a random dungeon level, the destination
- chosen from a few levels lower all the way to the top. These
+ Other traps can send you to different locations. Tele-
+ porters send you elsewhere on the same dungeon level. Level
+ teleporters send you to a random dungeon level, the destination
+ chosen from a few levels lower all the way to the top. These
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
- 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
- each time--though not necessarily the same spot on the level.
- Magic portals behave similarly, but with some additional varia-
- tion. Some portals are two-way and their remote destination is
- always the same: another portal which can take you back. Others
- are one-way and send you to a specific destination level but not
+ doors and holes also send you to another level, but one which is
+ always below the current level. Usually that will be the next
+ 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
+ each time--though not necessarily the same spot on the level.
+ Magic portals behave similarly, but with some additional varia-
+ tion. Some portals are two-way and their remote destination is
+ always the same: another portal which can take you back. Others
+ are one-way and send you to a specific destination level but not
necessarily to a specific location there.
- There is a special multi-level branch of the dungeon with
- pre-mapped levels based on the classic computer game "Sokoban."
+ There is a special multi-level branch of the dungeon with
+ pre-mapped levels based on the classic computer game "Sokoban."
In that game, you operate as a warehouse worker who pushes crates
- around obstacles to position them at designated locations. In
- NetHack, the goal is to push boulders into pits or holes until
+ around obstacles to position them at designated locations. In
+ NetHack, the goal is to push boulders into pits or holes until
those traps have all been nullified, giving access to whatever is
- beyond them. In the Sokoban game, you can only move in the four
+ 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, 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
- or hole removes both the boulder and the trap so opens up normal
- access to that spot. With careful foresight, it is possible to
- complete all of the levels according to the traditional rules of
+ blocks further access to that spot. In the Sokoban levels of
+ 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
+ or hole removes both the boulder and the trap so opens up normal
+ access to that spot. With careful foresight, it is possible to
+ complete all of the levels according to the traditional rules of
Sokoban. (Hint: to solve Sokoban puzzles, you often need to move
- things away from their eventual destinations in order to open up
- more room to maneuver.) Since NetHack does not support an undo
- capability, some allowances are permitted in case you get stuck.
+ things away from their eventual destinations in order to open up
+ more room to maneuver.) Since NetHack does not support an undo
+ capability, some allowances are permitted in case you get stuck.
For example, each level has at least one extra boulder. Also, it
- is possible to drop everything in order to be able to squeeze in-
- to the same location as a boulder (and then presumably move past
- it), or to destroy a boulder with magic or tools, or to create
- new boulders with a scroll of earth. However, doing such things
- will lower your luck without any specific message given about
- that. See the Conduct section for information about getting
- feedback for your actions in Sokoban.
+ is possible to drop everything in order to be able to squeeze
+ into the same location as a boulder (and then presumably move
+ past it), or to destroy a boulder with magic or tools, or to cre-
+ ate new boulders with a scroll of earth. However, doing such
+ things will lower your luck without any specific message given
+ about that. See the Conduct section for information about get-
+ ting feedback for your actions in Sokoban.
5.3. Stairs and ladders (`<', `>')
- In general, each level in the dungeon will have a staircase
+ In general, each level in the dungeon will have a staircase
going up (`<') to the previous level and another going down (`>')
- to the next level. There are some exceptions though. For
+ to the next level. There are some exceptions though. For
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- instance, fairly early in the dungeon you will find a level with
- two down staircases, one continuing into the dungeon and the oth-
- er branching into an area known as the Gnomish Mines. Those
- mines eventually hit a dead end, so after exploring them (if you
- choose to do so), you'll need to climb back up to the main dun-
+ instance, fairly early in the dungeon you will find a level with
+ two down staircases, one continuing into the dungeon and the
+ other branching into an area known as the Gnomish Mines. Those
+ mines eventually hit a dead end, so after exploring them (if you
+ choose to do so), you'll need to climb back up to the main dun-
geon.
- When you traverse a set of stairs, or trigger a trap which
- sends you to another level, the level you're leaving will be de-
- activated and stored in a file on disk. If you're moving to a
+ When you traverse a set of stairs, or trigger a trap which
+ sends you to another level, the level you're leaving will be de-
+ activated and stored in a file on disk. If you're moving to a
previously visited level, it will be loaded from its file on disk
- and reactivated. If you're moving to a level which has not yet
- been visited, it will be created (from scratch for most random
+ 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
the remains of an earlier game for a "bones" level as briefly de-
- scribed below). Monsters are only active on the current level;
+ scribed below). Monsters are only active on the current level;
those on other levels are essentially placed into stasis.
- Ordinarily when you climb a set of stairs, you will arrive
- on the corresponding staircase at your destination. However,
- pets (see below) and some other monsters will follow along if
+ Ordinarily when you climb a set of stairs, you will arrive
+ on the corresponding staircase at your destination. However,
+ pets (see below) and some other monsters will follow along if
they're close enough when you travel up or down stairs, and occa-
- sionally one of these creatures will displace you during the
+ sionally one of these creatures will displace you during the
climb. When that occurs, the pet or other monster will arrive on
the staircase and you will end up nearby.
- Ladders serve the same purpose as staircases, and the two
- types of inter-level connections are nearly indistinguishable
+ Ladders serve the same purpose as staircases, and the two
+ types of inter-level connections are nearly indistinguishable
during game play.
5.4. Shops and shopping
- Occasionally you will run across a room with a shopkeeper
- near the door and many items lying on the floor. You can buy
+ Occasionally you will run across a room with a shopkeeper
+ near the door and many items lying on the floor. You can buy
items by picking them up and then using the `p' command. You can
- inquire about the price of an item prior to picking it up by us-
- ing the "#chat" command while standing on it. Using an item pri-
- or to paying for it will incur a charge, and the shopkeeper won't
- allow you to leave the shop until you have paid any debt you owe.
+ inquire about the price of an item prior to picking it up by us-
+ ing the "#chat" command while standing on it. Using an item
+ prior to paying for it will incur a charge, and the shopkeeper
+ won't allow you to leave the shop until you have paid any debt
+ you owe.
You can sell items to a shopkeeper by dropping them to the
floor while inside a shop. You will either be offered an amount
Shopkeepers sometime run out of money. When that happens,
you'll be offered credit instead of gold when you try to sell
- something. Credit can be used to pay for purchases, but it is
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
+ something. Credit can be used to pay for purchases, but it is
only good in the shop where it was obtained; other shopkeepers
won't honor it. (If you happen to find a "credit card" in the
dungeon, don't bother trying to use it in shops; shopkeepers will
auto-pickup and without giving feedback about them.
-
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
And monsters represented by lower-case letters aren't randomly
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
sters with you. Like you, your pet needs food to survive. Dogs
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
be displayed even when that can be deduced from other attributes.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
to taking off other worn items.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
ber of items that the character has a chance to fire varies from
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
When in two-weapon combat mode, using the `X' command tog-
gles back to single-weapon mode. Throwing or dropping either of
- the weapons or having one of them be stolen or destroyed will al-
- so make you revert to single-weapon combat.
+ the weapons or having one of them be stolen or destroyed will
+ also make you revert to single-weapon combat.
7.3. Armor (`[')
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
Food is necessary to survive. If you go too long without
eating you will faint, and eventually die of starvation. Some
types of food will spoil, and become unhealthy to eat, if not
- protected. Food stored in ice boxes or tins ("cans") will usual-
- ly stay fresh, but ice boxes are heavy, and tins take a while to
- open.
+ protected. Food stored in ice boxes or tins ("cans") will usu-
+ ally stay fresh, but ice boxes are heavy, and tins take a while
+ to open.
When you kill monsters, they usually leave corpses which are
also "food." Many, but not all, of these are edible; some also
give you special powers when you eat them. A good rule of thumb
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
feature on versions where NetHack mail delivery is triggered by
electronic mail appearing in your system mailbox, you must let
NetHack know where to look for new mail by setting the "MAIL" en-
- vironment variable to the file name of your mailbox. You may al-
- so want to set the "MAILREADER" environment variable to the file
- name of your favorite reader, so NetHack can shell to it when you
- read the scroll. On versions of NetHack where mail is randomly
- generated internal to the game, these environment variables are
- ignored. You can disable the mail daemon by turning off the mail
- option.
+ vironment variable to the file name of your mailbox. You may
+ also want to set the "MAILREADER" environment variable to the
+ file name of your favorite reader, so NetHack can shell to it
+ when you read the scroll. On versions of NetHack where mail is
+ randomly generated internal to the game, these environment vari-
+ ables are ignored. You can disable the mail daemon by turning
+ off the mail option.
The command to read a scroll is `r'.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
tools have a limited number of uses, akin to wand charges. For
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
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
They are also a far more efficient way of carrying your riches.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
you've verified that no monster is there, you will have forgotten
that there was any object there regardless of whether the unseen
monster actually took the object. If the object is still there,
- then once you see or feel that location again you will re-discov-
- er the object and resume remembering it.
+ then once you see or feel that location again you will re-dis-
+ cover the object and resume remembering it.
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-
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
ments representing progress toward ultimate ascension, if any
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
those levels since doing so is not necessary to complete the
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
as a file name. If it does start with `/', the at-sign is
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
quiver sack or make ready some suitable weapon. Note that it
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
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'
+ ment, damage, or quality of the weapon; you are free to manu-
+ ally 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.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
Asking refers to picking one of the orderings from a menu. The
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
(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.
+ fault to no, vanquished to disclose without prompting, geno-
+ cided 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.
set with the `O' command.
extmenu
- Changes the extended commands interface to pop-up a menu of
+ 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
+ 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
+ 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
+ An obsolete synonym for "gender:female". Cannot be set with
the `O' command.
fireassist
- This option controls what happens when you attempt the `f'
+ 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
+ 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.
-
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
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 gender using either of the deprecated male and female op-
+ Your starting gender (gender:male or gender:female). You may
+ specify just the first letter. Although you can still denote
+ your gender using either of the deprecated male and female op-
tions, if the gender option is also present it will take prece-
- dence. See role for a description of how to use negation to
+ dence. See role for a description of how to use negation to
exclude choices.
- Default is random. Cannot be set with the `O' command. Per-
+ Default is random. Cannot be set with the `O' command. Per-
sistent.
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
+ 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
+ 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-
+ 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
+ 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
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
(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
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.
on). Persistent.
lit_corridor
- Show corridor squares seen by night vision or a light source
+ 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
+ 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
+ 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).
Cannot be set with the `O' command. Persistent.
mention_walls
- Give feedback when walking against a wall (default off). Per-
+ Give feedback when walking against a wall (default off). Per-
sistent.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
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 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
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
+ Do not clear the screen before drawing menus, and align menus
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- to the right edge of the screen. Only for the tty port. (de-
+ 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
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 `}'.
off). Debug mode only.
mouse_support
- Allow use of the mouse for input and travel. Valid settings
+ 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
+ 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
+ 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:
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
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
Send padding nulls to the terminal (default on). Persistent.
number_pad
- Use digit keys instead of letters to move (default 0 or off).
+ Use digit keys instead of letters to move (default 0 or off).
Valid settings are:
0 - move by letters; "yuhjklbn"
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
+ 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
+ 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'
+ 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
+ containing the symbols for the various object types. Any
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
omitted 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
+ pray - require `y' to confirm an attempt to pray rather
than immediately praying; on by default;
- Remove - require selection from inventory for `R' and `T'
- commands even when wearing just one applicable
+ Remove - require selection from inventory for `R' and `T'
+ commands even when wearing just one applicable
item.
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
+ By default, the pray choice is enabled, the others disabled.
+ To disable it without setting any of the other choices, use
"paranoid_confirmation:none". To keep it enabled while setting
- any of the others, include it in the list, such as "para-
+ any of the others, include it in the list, such as "para-
noid_confirmation:attack pray Remove".
perm_invent
- If true, always display your current inventory in a window.
- This only makes sense for windowing system interfaces that im-
+ If true, always display your current inventory in a window.
+ This only makes sense for windowing system interfaces that im-
plement this feature.
petattr
- Specifies one or more text highlighting attributes to use when
- showing pets on the map. Effectively a superset of the
+ Specifies one or more text highlighting attributes to use when
+ showing pets on the map. Effectively a superset of the
hilite_pet boolean option. Curses interface only; value is one
or more of the following letters.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
l - Left line indicator
r - Right line indicator
- Some of those choices might not work, particularly the final
- three, depending upon terminal hardware or terminal emulation
+ Some of those choices might not work, particularly the final
+ three, depending upon terminal hardware or terminal emulation
software.
- Currently multiple highlight-style letters can be combined by
- simply stringing them together (for example, "bk"), but in the
- future they might require being separated by plus signs (such
- as "b+k", which works already). When using the `n' choice, it
- should be specified on its own, not in combination with any of
+ Currently multiple highlight-style letters can be combined by
+ simply stringing them together (for example, "bk"), but in the
+ future they might require being separated by plus signs (such
+ as "b+k", which works already). When using the `n' choice, it
+ should be specified on its own, not in combination with any of
the other letters.
pettype
- Specify the type of your initial pet, if you are playing a
- character class that uses multiple types of pets; or choose to
- have no initial pet at all. Possible values are "cat", "dog",
+ Specify the type of your initial pet, if you are playing a
+ character class that uses multiple types of pets; or choose to
+ have no initial pet at all. Possible values are "cat", "dog",
"horse", and "none". If the choice is not allowed for the role
- you are currently playing, it will be silently ignored. For
- example, "horse" will only be honored when playing a knight.
+ you are currently playing, it will be silently ignored. For
+ example, "horse" will only be honored when playing a knight.
Cannot be set with the `O' command.
pickup_burden
- When you pick up an item that would exceed this encumbrance
- level (Unencumbered, Burdened, streSsed, straiNed, overTaxed,
- or overLoaded), you will be asked if you want to continue.
+ When you pick up an item that would exceed this encumbrance
+ level (Unencumbered, Burdened, streSsed, straiNed, overTaxed,
+ or overLoaded), you will be asked if you want to continue.
(Default `S'). Persistent.
pickup_thrown
- If this option is on and autopickup is also on, try to pick up
- things that you threw, even if they aren't in pickup_types or
+ If this option is on and autopickup is also on, try to pick up
+ things that you threw, even if they aren't in pickup_types or
match an autopickup exception. Default is on. Persistent.
pickup_types
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.
+ to pick up gold, scrolls, and potions. You can use au-
+ topickup_exception configuration file lines to further refine
+ autopickup 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-
+ 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
+ topickup on in order to have autopickup_exception settings
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
control 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
+ to `.'. That is the type symbol for venom and you won't come
across any venom items so won't unintentionally pick such up.
pile_limit
- When walking across a pile of objects on the floor, threshold
- at which the message "there are few/several/many objects here"
- is given instead of showing a popup list of those objects. A
- value of 0 means "no limit" (always list the objects); a value
- of 1 effectively means "never show the objects" since the pile
- size will always be at least that big; default value is 5.
+ 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-
+ 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
+ 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-
+ objects or monsters is less intrusive. Default is off. Per-
sistent.
race
- Selects your race (for example, race:human). Choices are hu-
- man, dwarf, elf, gnome, and orc but most roles restrict which
+ Selects your race (for example, race:human). Choices are hu-
+ man, dwarf, elf, gnome, and orc but most roles restrict which
of the non-human races are allowed. See role for a description
of how to use negation to exclude choices.
- Default is random. Cannot be set with the `O' command. Per-
+ Default is random. Cannot be set with the `O' command. Per-
sistent.
rest_on_space
- Make the space bar a synonym for the `.' (#wait) command (de-
+ Make the space bar a synonym for the `.' (#wait) command (de-
fault off). Persistent.
role
- Pick your type of character (for example, role:Samurai); syn-
- onym for character. See name for an alternate method of
+ Pick your type of character (for example, role:Samurai); syn-
+ onym for character. See name for an alternate method of
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
specifying your role.
- This option can also be used to limit selection when role is
- chosen randomly. Use a space-separated list of roles and ei-
- ther negate each one or negate the option itself instead.
+ This option can also be used to limit selection when role is
+ chosen randomly. Use a space-separated list of roles and ei-
+ ther negate each one or negate the option itself instead.
Negation is accomplished in the same manner as with boolean op-
- tions, by prefixing the option or its value(s) with `!' or
+ tions, by prefixing the option or its value(s) with `!' or
"no".
Examples:
OPTIONS=role:!arc !bar !kni
OPTIONS=!role:arc bar kni
- There can be multiple instances of the role option if they're
+ There can be multiple instances of the role option if they're
all negations.
- Default is random. Cannot be set with the `O' command. Per-
+ Default is random. Cannot be set with the `O' command. Per-
sistent.
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;
crawl - like walk, but pause briefly after each step.
This option only affects the game's screen display, not the ac-
- tual results of moving. The default is "run"; versions prior
- to 3.4.1 used "teleport" only. Whether or not the effect is
+ tual results of moving. The default is "run"; versions prior
+ to 3.4.1 used "teleport" only. Whether or not the effect is
noticeable will depend upon the window port used or on the type
of terminal. Persistent.
safe_pet
- Prevent you from (knowingly) attacking your pets (default on).
+ Prevent you from (knowingly) attacking your pets (default on).
Persistent.
safe_wait
- Prevents you from waiting or searching when next to a hostile
+ Prevents you from waiting or searching when next to a hostile
monster (default on). Persistent.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
off). Debug mode only.
scores
- Control what parts of the score list you are shown at the end
- (for example "scores:5 top scores/4 around my score/own
+ Control what parts of the score list you are shown at the end
+ (for example "scores:5 top scores/4 around my score/own
scores"). Only the first letter of each category (`t', `a', or
`o') is necessary. Persistent.
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
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
The possible values are:
full - always sort the lists;
- loot - only sort the lists that don't use inventory letters,
+ loot - only sort the lists that don't use inventory letters,
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
none - show lists the traditional way without sorting; default.
sortpack
- Sort the pack contents by type when displaying inventory (de-
+ Sort the pack contents by type when displaying inventory (de-
fault on). Persistent.
sortvanquished
ternal monster index; default;
d - order by monster difficulty rating; ties broken by internal
index;
- a - order alphabetically, first any unique monsters then all
+ a - order alphabetically, first any unique monsters then all
the others;
- c - order by monster class, by low to high level within each
+ c - order by monster class, by low to high level within each
class;
- n - order by count, high to low; ties are broken by internal
+ n - order by count, high to low; ties are broken by internal
monster index;
z - order by count, low to high; ties broken by internal index.
`m' prefix before the #vanquished command.
sounds
- Allow sounds to be emitted from an integrated sound library
+ Allow sounds to be emitted from an integrated sound library
(default on).
sparkle
Display a sparkly effect when a monster (including yourself) is
- hit by an attack to which it is resistant (default on). Per-
+ hit by an attack to which it is resistant (default on). Per-
sistent.
standout
Boldface monsters and "--More--" (default off). Persistent.
statushilites
- Controls how many turns status hilite behaviors highlight the
- field. If negated or set to zero, disables status hiliting.
+ Controls how many turns status hilite behaviors highlight the
+ field. If negated or set to zero, disables status hiliting.
See "Configuring Status Hilites" for further information.
status_updates
- Allow updates to the status lines at the bottom of the screen
+ Allow updates to the status lines at the bottom of the screen
(default true).
suppress_alert
- This option may be set to a NetHack version level to suppress
- alert notification messages about feature changes for that and
+ This option may be set to a NetHack version level to suppress
+ alert notification messages about feature changes for that and
prior versions (for example "suppress_alert:3.3.1").
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
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
toptenwin
Put the ending display in a NetHack window instead of on stdout
- (default off). Setting this option makes the score list visi-
- ble when a windowing version of NetHack is started without a
- parent window, but it no longer leaves the score list around
+ (default off). Setting this option makes the score list visi-
+ ble when a windowing version of NetHack is started without a
+ parent window, but it no longer leaves the score list around
after game end on a terminal or emulating window.
travel
Allow the travel command via mouse click (default on). Turning
- this option off will prevent the game from attempting unintend-
- ed moves if you make inadvertent mouse clicks on the map win-
- dow. Does not affect traveling via the `_' ("#travel") com-
+ this option off will prevent the game from attempting unin-
+ tended moves if you make inadvertent mouse clicks on the map
+ window. 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:
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
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
+ 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
+ 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
+ When getting a location on the map, and using shifted movement
keys or meta-digit keys to fast-move, instead of moving 8 units
at a time, move by skipping the same glyphs. (default off)
windowtype
When the program has been built to support multiple interfaces,
- select which one to use, such as "tty" or "X11" (default de-
+ select which one to use, such as "tty" or "X11" (default de-
pends on build-time settings; use "#version" to check). Cannot
be set with the `O' command.
- When used, it should be the first option set since its value
- might enable or disable the availability of various other op-
- tions. For multiple lines in a configuration file, that would
- be the first non-comment line. For a comma-separated list in
+ When used, it should be the first option set since its value
+ might enable or disable the availability of various other op-
+ tions. For multiple lines in a configuration file, that would
+ be the first non-comment line. For a comma-separated list in
NETHACKOPTIONS or an OPTIONS line in a configuration file, that
would be the rightmost option in the list.
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.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
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,
+ 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
+ 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.
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
+ 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
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
If NetHack can, it should use a font by the chosen name for the
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
status window.
font_text
- If NetHack can, it should use a font by the chosen name for
+ If NetHack can, it should use a font by the chosen name for
text windows.
font_size_map
- If NetHack can, it should use this size font for the map win-
+ If NetHack can, it should use this size font for the map win-
dow.
font_size_menu
If NetHack can, it should use this size font for menu windows.
font_size_message
- If NetHack can, it should use this size font for the message
+ If NetHack can, it should use this size font for the message
window.
font_size_status
- If NetHack can, it should use this size font for the status
+ If NetHack can, it should use this size font for the status
window.
font_size_text
If NetHack can, it should use this size font for text windows.
fullscreen
- If NetHack can, it should try and display on the entire screen
+ 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-
+ Use color text and/or highlighting attributes when displaying
+ some non-map data (such as menu selector letters). Curses in-
terface only; default is on.
large_font
If NetHack can, it should use a large font.
map_mode
- If NetHack can, it should display the map in the manner speci-
+ If NetHack can, it should display the map in the manner speci-
fied.
player_selection
- If NetHack can, it should pop up dialog boxes, or use prompts
+ If NetHack can, it should pop up dialog boxes, or use prompts
for character selection.
popup_dialog
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.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
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
it starts up (default yes).
statuslines
- Number of lines for traditional below-the-map status display.
+ 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
+ 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
+ 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
+ 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. (If
+ 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
+ statuslines can only be set in the run-time configuration file
or via NETHACKOPTIONS, not during play with the `O' command.)
term_cols and
term_rows
- Curses interface only. Number of columns and rows to use for
+ Curses interface only. Number of columns and rows to use for
the display. Curses will attempt to resize to the values spec-
- ified but will settle for smaller sizes if they are too big.
+ ified but will settle for smaller sizes if they are too big.
Default is the current window size.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
tile_file
- Specify the name of an alternative tile file to override the
+ Specify the name of an alternative tile file to override the
default.
- Note: the X11 interface uses X resources rather than NetHack's
- options to select an alternate tile file. See NetHack.ad, the
+ Note: the X11 interface uses X resources rather than NetHack's
+ options to select an alternate tile file. See NetHack.ad, the
sample X "application defaults" file.
tile_height
- Specify the preferred height of each tile in a tile capable
+ Specify the preferred height of each tile in a tile capable
port.
tile_width
Specify the preferred width of each tile in a tile capable port
tiled_map
- If NetHack can, it should display the map using tiles graphics
- rather than simple characters (letters and punctuation, possi-
- bly augmented by line-drawing symbols). Setting tiled_map to
+ If NetHack can, it should display the map using tiles graphics
+ rather than simple characters (letters and punctuation, possi-
+ bly augmented by line-drawing symbols). Setting tiled_map to
True forces ascii_map to be False.
use_darkgray
Use bold black instead of blue for black glyphs (TTY only).
use_inverse
- If NetHack can, it should display inverse when the game speci-
+ If NetHack can, it should display inverse when the game speci-
fies it.
vary_msgcount
- If NetHack can, it should display this number of messages at a
+ If NetHack can, it should display this number of messages at a
time in the message window.
windowborders
- Whether to draw boxes around the map, status area, message
- area, and persistent inventory window if enabled. Curses in-
+ Whether to draw boxes around the map, status area, message
+ area, and persistent inventory window if enabled. Curses in-
terface only. Acceptable values are
0 - off, never show borders
3 - on, except forced off for perm_invent
4 - auto, except forced off for perm_invent
- (The 26x82 size threshold for `2' refers to number of rows and
- columns of the display. A width of at least 110 columns
+ (The 26x82 size threshold for `2' refers to number of rows and
+ columns of the display. A width of at least 110 columns
(80+2+26+2) is needed to show borders if align_status is set to
left or right.)
- The persistent inventory window, when enabled, can grow until
- it is too big to fit on most displays, resulting in truncation
- of its contents. If borders are forced on (1) or the display
+ The persistent inventory window, when enabled, can grow until
+ it is too big to fit on most displays, resulting in truncation
+ of its contents. If borders are forced on (1) or the display
is big enough to show them (2), setting the value to 3 or 4 in-
- stead will keep borders for the map, message, and status win-
- dows but have room for two additional lines of inventory plus
+ stead will keep borders for the map, message, and status win-
+ dows but have room for two additional lines of inventory plus
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
widen each inventory line by two columns.
windowcolors
- If NetHack can, it should display windows with the specified
+ If NetHack can, it should display windows with the specified
foreground/background colors. Windows GUI only. The format is
OPTION=windowcolors:wintype foreground/background
- where wintype is one of "menu", "message", "status", or
- "text", and foreground and background are colors, either a hexa-
- decimal \'#rrggbb', one of the named colors (black, red, green,
- brown, blue, magenta, cyan, orange, brightgreen, yellow, bright-
- blue, brightmagenta, brightcyan, white, trueblack, gray, purple,
- silver, maroon, fuchsia, lime, olive, navy, teal, aqua), or one
- of Windows UI colors (activeborder, activecaption, appworkspace,
- background, btnface, btnshadow, btntext, captiontext, graytext,
- greytext, highlight, highlighttext, inactiveborder, inactivecap-
- tion, menu, menutext, scrollbar, window, windowframe, window-
+ where wintype is one of "menu", "message", "status", or
+ "text", and foreground and background are colors, either a hexa-
+ decimal \'#rrggbb', one of the named colors (black, red, green,
+ brown, blue, magenta, cyan, orange, brightgreen, yellow, bright-
+ blue, brightmagenta, brightcyan, white, trueblack, gray, purple,
+ silver, maroon, fuchsia, lime, olive, navy, teal, aqua), or one
+ of Windows UI colors (activeborder, activecaption, appworkspace,
+ background, btnface, btnshadow, btntext, captiontext, graytext,
+ greytext, highlight, highlighttext, inactiveborder, inactivecap-
+ tion, menu, menutext, scrollbar, window, windowframe, window-
text).
wraptext
9.6. Platform-specific Customization options
- Here are explanations of options that are used by specific
+ Here are explanations of options that are used by specific
platforms or ports to customize and change the port behavior.
altkeyhandling
Select an alternate way to handle keystrokes (Win32 tty NetHack
- only). The name of the handling type is one of "default",
+ only). The name of the handling type is one of "default",
"ray", "340".
altmeta
- On systems where this option is available, it can be set to
+ On systems where this option is available, it can be set to
tell NetHack to convert a two character sequence beginning with
- ESC into a meta-shifted version of the second character (de-
+ ESC into a meta-shifted version of the second character (de-
fault off).
- This conversion is only done for commands, not for other input
+ This conversion is only done for commands, not for other input
prompts. Note that typing one or more digits as a count prefix
- prior to a command--preceded by n if the number_pad option is
+ prior to a command--preceded by n if the number_pad option is
set--is also subject to this conversion, so attempting to abort
- the count by typing ESC will leave NetHack waiting for another
- character to complete the two character sequence. Type a sec-
- ond ESC to finish cancelling such a count. At other prompts a
+ the count by typing ESC will leave NetHack waiting for another
+ character to complete the two character sequence. Type a sec-
+ ond ESC to finish cancelling such a count. At other prompts a
single ESC suffices.
BIOS
Use BIOS calls to update the screen display quickly and to read
- the keyboard (allowing the use of arrow keys to move) on ma-
- chines with an IBM PC compatible BIOS ROM (default off, OS/2,
+ the keyboard (allowing the use of arrow keys to move) on ma-
+ chines with an IBM PC compatible BIOS ROM (default off, OS/2,
PC, and ST NetHack only).
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
(default on, Mac NetHack only).
rawio
- Force raw (non-cbreak) mode for faster output and more bullet-
- proof input (MS-DOS sometimes treats `^P' as a printer toggle
- without it) (default off, OS/2, PC, and ST NetHack only).
- Note: DEC Rainbows hang if this is turned on. Cannot be set
+ Force raw (non-cbreak) mode for faster output and more bullet-
+ proof input (MS-DOS sometimes treats `^P' as a printer toggle
+ without it) (default off, OS/2, PC, and ST NetHack only).
+ Note: DEC Rainbows hang if this is turned on. Cannot be set
with the `O' command.
subkeyvalue
- (Win32 tty NetHack only). May be used to alter the value of
+ (Win32 tty NetHack only). May be used to alter the value of
keystrokes that the operating system returns to NetHack to help
- compensate for international keyboard issues. OPTIONS=subkey-
- value:171/92 will return 92 to NetHack, if 171 was originally
+ compensate for international keyboard issues. OPTIONS=subkey-
+ value:171/92 will return 92 to NetHack, if 171 was originally
going to be returned. You can use multiple subkeyvalue assign-
- ments in the configuration file if needed. Cannot be set with
+ ments in the configuration file if needed. Cannot be set with
the `O' command.
video
Set the video mode used (PC NetHack only). Values are "autode-
- tect", "default", "vga", or "vesa". Setting "vesa" will cause
+ tect", "default", "vga", or "vesa". Setting "vesa" will cause
the game to display tiles, using the full capability of the VGA
- hardware. Setting "vga" will cause the game to display tiles,
- fixed at 640x480 in 16 colors, a mode that is compatible with
- all VGA hardware. Third party tilesets will probably not work.
- Setting "autodetect" attempts "vesa", then "vga", and finally
- sets "default" if neither of those modes works. Cannot be set
+ hardware. Setting "vga" will cause the game to display tiles,
+ fixed at 640x480 in 16 colors, a mode that is compatible with
+ all VGA hardware. Third party tilesets will probably not work.
+ Setting "autodetect" attempts "vesa", then "vga", and finally
+ sets "default" if neither of those modes works. Cannot be set
with the `O' command.
video_height
- Set the VGA mode resolution height (MS-DOS only, with
+ Set the VGA mode resolution height (MS-DOS only, with
video:vesa)
video_width
- Set the VGA mode resolution width (MS-DOS only, with
+ Set the VGA mode resolution width (MS-DOS only, with
video:vesa)
videocolors
- Set the color palette for PC systems using NO_TERMS (default
- 4-2-6-1-5-3-15-12-10-14-9-13-11, (PC NetHack only). The order
- of colors is red, green, brown, blue, magenta, cyan,
- bright.white, bright.red, bright.green, yellow, bright.blue,
- bright.magenta, and bright.cyan. Cannot be set with the `O'
+ Set the color palette for PC systems using NO_TERMS (default
+ 4-2-6-1-5-3-15-12-10-14-9-13-11, (PC NetHack only). The order
+ of colors is red, green, brown, blue, magenta, cyan,
+ bright.white, bright.red, bright.green, yellow, bright.blue,
+ bright.magenta, and bright.cyan. Cannot be set with the `O'
command.
videoshades
- Set the intensity level of the three gray scales available
+ Set the intensity level of the three gray scales available
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
(default dark normal light, PC NetHack only). If the game dis-
- play is difficult to read, try adjusting these scales; if this
- does not correct the problem, try !color. Cannot be set with
+ play is difficult to read, try adjusting these scales; if this
+ does not correct the problem, try !color. Cannot be set with
the `O' command.
9.7. Regular Expressions
- Regular expressions are normally POSIX extended regular ex-
- pressions. It is possible to compile NetHack without regular ex-
- pression support on a platform where there is no regular expres-
- sion library. While this is not true of any modern platform, if
- your NetHack was built this way, patterns are instead glob pat-
+ Regular expressions are normally POSIX extended regular ex-
+ pressions. It is possible to compile NetHack without regular ex-
+ pression support on a platform where there is no regular expres-
+ sion library. While this is not true of any modern platform, if
+ your NetHack was built this way, patterns are instead glob pat-
terns. This applies to Autopickup exceptions, Message types, Menu
colors, and User sounds.
You can further refine the behavior of the autopickup option
beyond what is available through the pickup_types option.
- By placing autopickup_exception lines in your configuration
- file, you can define patterns to be checked when the game is
+ By placing autopickup_exception lines in your configuration
+ file, you can define patterns to be checked when the game is
about to autopickup something.
autopickup_exception
- Sets an exception to the pickup_types option. The autopick-
- up_exception option should be followed by a regular expression
- to be used as a pattern to match against the singular form of
- the description of an object at your location.
+ Sets an exception to the pickup_types option. The au-
+ topickup_exception option should be followed by a regular ex-
+ pression to be used as a pattern to match against the singular
+ form of the description of an object at your location.
- In addition, some characters are treated specially if they oc-
+ In addition, some characters are treated specially if they oc-
cur as the first character in the pattern, specifically:
< - always pickup an object that matches rest of pattern;
> - never pickup an object that matches rest of pattern.
- The autopickup_exception rules are processed in the order in
- which they appear in your configuration file, thus allowing a
+ The autopickup_exception rules are processed in the order in
+ which they appear in your configuration file, thus allowing a
later rule to override an earlier rule.
- Exceptions can be set with the `O' command, but because they
- are not included in your configuration file, they won't be in
- effect if you save and then restore your game. autopickup_ex-
+ Exceptions can be set with the `O' command, but because they
+ are not included in your configuration file, they won't be in
+ effect if you save and then restore your game. autopickup_ex-
ception rules and not saved with the game.
Here are some examples:
autopickup_exception=">*corpse"
autopickup_exception=">* cursed*"
- The first example above will result in autopickup of any
- type of arrow. The second example results in the exclusion of
- any corpse from autopickup. The last example results in the
+ The first example above will result in autopickup of any
+ type of arrow. The second example results in the exclusion of
+ any corpse from autopickup. The last example results in the
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
9.9. Changing Key Bindings
- It is possible to change the default key bindings of some
- special commands, menu accelerator keys, and extended commands,
- by using BIND stanzas in the configuration file. Format is key,
- followed by the command to bind to, separated by a colon. The
+ It is possible to change the default key bindings of some
+ special commands, menu accelerator keys, and extended commands,
+ by using BIND stanzas in the configuration file. Format is key,
+ followed by the command to bind to, separated by a colon. The
key can be a single character ("x"), a control key ("^X", "C-x"),
- a meta key ("M-x"), a mouse button, or a three-digit decimal
+ a meta key ("M-x"), a mouse button, or a three-digit decimal
ASCII code.
For example:
BIND=v:loot
Extended command keys
- You can bind multiple keys to the same extended command. Un-
- bind a key by using "nothing" as the extended command to bind
- to. You can also bind the "<esc>", "<enter>", and "<space>"
+ You can bind multiple keys to the same extended command. Un-
+ bind a key by using "nothing" as the extended command to bind
+ to. You can also bind the "<esc>", "<enter>", and "<space>"
keys.
Menu accelerator keys
- The menu control or accelerator keys can also be rebound via
- OPTIONS lines in the configuration file. You cannot bind ob-
+ The menu control or accelerator keys can also be rebound via
+ OPTIONS lines in the configuration file. You cannot bind ob-
ject symbols or selection letters into menu accelerators. Some
interfaces only support some of the menu accelerators.
"clicklook", or "mouseaction".
Special command keys
- Below are the special commands you can rebind. Some of them
- can be bound to same keys with no problems, others are in the
- same "context", and if bound to same keys, only one of those
- commands will be available. Special command can only be bound
+ Below are the special commands you can rebind. Some of them
+ can be bound to same keys with no problems, others are in the
+ same "context", and if bound to same keys, only one of those
+ commands will be available. Special command can only be bound
to a single key.
count
- Prefix key to start a count, to repeat a command this many
+ Prefix key to start a count, to repeat a command this many
times. With number_pad only. Default is `n'.
getdir.help
- When asked for a direction, the key to show the help. Default
+ When asked for a direction, the key to show the help. Default
is `?'.
getdir.mouse
- When asked for a direction, the key to initiate a simulated
- mouse click. You will be asked to pick a location. Use move-
- ment keystrokes to move the cursor around the map, then type
- the getpos.pick.once key (default `,') or the getpos.pick key
+ When asked for a direction, the key to initiate a simulated
+ mouse click. You will be asked to pick a location. Use move-
+ ment keystrokes to move the cursor around the map, then type
+ the getpos.pick.once key (default `,') or the getpos.pick key
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- (default `.') to finish as if performing a left or right
- click. Only useful when using the #therecmdmenu command. De-
+ (default `.') to finish as if performing a left or right
+ click. Only useful when using the #therecmdmenu command. De-
fault is `_'.
getdir.self
- When asked for a direction, the key to target yourself. De-
+ When asked for a direction, the key to target yourself. De-
fault is `.'.
getdir.self2
- When asked for a direction, an alternate key to target your-
+ When asked for a direction, an alternate key to target your-
self. Default is `s'.
getpos.autodescribe
esting thing. Default is `a'.
getpos.all.prev
- When asked for a location, the key to go to previous closest
+ When asked for a location, the key to go to previous closest
interesting thing. Default is `A'.
getpos.door.next
- When asked for a location, the key to go to next closest door
+ When asked for a location, the key to go to next closest door
or doorway. Default is `d'.
getpos.door.prev
- When asked for a location, the key to go to previous closest
+ When asked for a location, the key to go to previous closest
door or doorway. Default is `D'.
getpos.help
- When asked for a location, the key to show help. Default is
+ When asked for a location, the key to show help. Default is
`?'.
getpos.mon.next
- When asked for a location, the key to go to next closest mon-
+ When asked for a location, the key to go to next closest mon-
ster. Default is `m'.
getpos.mon.prev
- When asked for a location, the key to go to previous closest
+ When asked for a location, the key to go to previous closest
monster. Default is `M'.
getpos.obj.next
- When asked for a location, the key to go to next closest ob-
+ When asked for a location, the key to go to next closest ob-
ject. Default is `o'.
getpos.obj.prev
- When asked for a location, the key to go to previous closest
+ When asked for a location, the key to go to previous closest
object. Default is `O'.
getpos.menu
- When asked for a location, and using one of the next or
+ When asked for a location, and using one of the next or
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- previous keys to cycle through targets, toggle showing a menu
+ previous keys to cycle through targets, toggle showing a menu
instead. Default is `!'.
getpos.moveskip
- When asked for a location, and using the shifted movement keys
- or meta-digit keys to fast-move around, move by skipping the
+ When asked for a location, and using the shifted movement keys
+ or meta-digit keys to fast-move around, move by skipping the
same glyphs instead of by 8 units. Default is `*'.
getpos.filter
When asked for a location, change the filtering mode when using
- one of the next or previous keys to cycle through targets.
- Toggles between no filtering, in view only, and in the same
+ one of the next or previous keys to cycle through targets.
+ Toggles between no filtering, in view only, and in the same
area only. Default is `"'.
getpos.pick
- When asked for a location, the key to choose the location, and
- possibly ask for more info. When simulating a mouse click af-
- ter being asked for a direction (see getdir.mouse above), the
+ When asked for a location, the key to choose the location, and
+ possibly ask for more info. When simulating a mouse click af-
+ ter being asked for a direction (see getdir.mouse above), the
key to use to respond as right click. Default is `.'.
getpos.pick.once
- When asked for a location, the key to choose the location, and
+ When asked for a location, the key to choose the location, and
skip asking for more info. When simulating a mouse click after
- being asked for a direction, the key to respond as left click.
+ being asked for a direction, the key to respond as left click.
Default is `,'.
getpos.pick.quick
When asked for a location, the key to choose the location, skip
- asking for more info, and exit the location asking loop. De-
+ asking for more info, and exit the location asking loop. De-
fault is `;'.
getpos.pick.verbose
- When asked for a location, the key to choose the location, and
+ When asked for a location, the key to choose the location, and
show more info without asking. Default is `:'.
getpos.self
fault is `@'.
getpos.unexplored.next
- When asked for a location, the key to go to next closest unex-
+ When asked for a location, the key to go to next closest unex-
plored location. Default is `x'.
getpos.unexplored.prev
- When asked for a location, the key to go to previous closest
+ When asked for a location, the key to go to previous closest
unexplored location. Default is `X'.
getpos.valid
- When asked for a location, the key to go to show valid target
+ When asked for a location, the key to go to show valid target
locations. Default is `$'.
getpos.valid.next
- When asked for a location, the key to go to next closest valid
+ When asked for a location, the key to go to next closest valid
location. Default is `z'.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
getpos.valid.prev
- When asked for a location, the key to go to previous closest
+ When asked for a location, the key to go to previous closest
valid location. Default is `Z'.
9.10. Configuring Message Types
You can change the way the messages are shown in the message
area, when the message matches a user-defined pattern.
- In general, the configuration file entries to describe the
+ In general, the configuration file entries to describe the
message types look like this: MSGTYPE=type "pattern"
type - how the message should be shown;
show - show message normally;
hide - never show the message;
stop - wait for user with more-prompt;
- norep - show the message once, but not again if no other mes-
+ norep - show the message once, but not again if no other mes-
sage is shown in between.
- Here's an example of message types using NetHack's internal
+ Here's an example of message types using NetHack's internal
pattern matching facility:
MSGTYPE=stop "You feel hungry."
MSGTYPE=hide "You displaced *."
- specifies that whenever a message "You feel hungry" is shown,
- the user is prompted with more-prompt, and a message matching
+ specifies that whenever a message "You feel hungry" is shown,
+ the user is prompted with more-prompt, and a message matching
"You displaced <something>." is not shown at all.
- The order of the defined MSGTYPE lines is important; the last
- matching rule is used. Put the general case first, exceptions
+ The order of the defined MSGTYPE lines is important; the last
+ matching rule is used. Put the general case first, exceptions
below them.
9.11. Configuring Menu Colors
Some platforms allow you to define colors used in menu lines
- when the line matches a user-defined pattern. At this time the
+ when the line matches a user-defined pattern. At this time the
tty, curses, win32tty and win32gui interfaces support this.
- In general, the configuration file entries to describe the
+ In general, the configuration file entries to describe the
menu color mappings look like this:
MENUCOLOR="pattern"=color&attribute
pattern - the pattern to match;
- color - the color to use for lines matching the pat-
+ color - the color to use for lines matching the pat-
tern;
- attribute - the attribute to use for lines matching the
+ attribute - the attribute to use for lines matching the
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- pattern. The attribute is optional, and if
+ pattern. The attribute is optional, and if
left out, you must also leave out the preced-
- ing ampersand. If no attribute is defined,
+ ing ampersand. If no attribute is defined,
no attribute is used.
The pattern should be a regular expression.
- Allowed colors are black, red, green, brown, blue, magenta,
- cyan, gray, orange, light-green, yellow, light-blue, light-ma-
- genta, light-cyan, and white. And no-color, the default fore-
- ground color, which isn't necessarily the same as any of the
+ Allowed colors are black, red, green, brown, blue, magenta,
+ cyan, gray, orange, light-green, yellow, light-blue, light-ma-
+ genta, light-cyan, and white. And no-color, the default fore-
+ ground color, which isn't necessarily the same as any of the
other colors.
- Allowed attributes are none, bold, dim, italic, underline,
- blink, and inverse. "Normal" is a synonym for "none". Note
- that the platform used may interpret the attributes any way it
+ 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
wants.
- Here's an example of menu colors using NetHack's internal pat-
+ Here's an example of menu colors using NetHack's internal pat-
tern matching facility:
MENUCOLOR="* blessed *"=green
MENUCOLOR="* cursed *"=red
MENUCOLOR="* cursed *(being worn)"=red&underline
- specifies that any menu line with " blessed " contained in it
- will be shown in green color, lines with " cursed " will be
- shown in red, and lines with " cursed " followed by "(being
- worn)" on the same line will be shown in red color and under-
+ specifies that any menu line with " blessed " contained in it
+ will be shown in green color, lines with " cursed " will be
+ shown in red, and lines with " cursed " followed by "(being
+ worn)" on the same line will be shown in red color and under-
lined. You can have multiple MENUCOLOR entries in your config-
- uration file, and the last MENUCOLOR line that matches a menu
+ uration file, and the last MENUCOLOR line that matches a menu
line will be used for the line.
Note that if you intend to have one or more color specifica-
- tions match " uncursed ", you will probably want to turn the im-
+ 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
- Some platforms allow you to define sound files to be played
- when a message that matches a user-defined pattern is delivered
+ Some platforms allow you to define sound files to be played
+ when a message that matches a user-defined pattern is delivered
to the message window. At this time the Qt port and the win32tty
and win32gui ports support the use of user sounds.
- The following configuration file entries are relevant to
+ The following configuration file entries are relevant to
mapping user sounds to messages:
SOUNDDIR
The directory that houses the sound files to be played.
SOUND
- An entry that maps a sound file to a user-specified message
- pattern. Each SOUND entry is broken down into the following
+ An entry that maps a sound file to a user-specified message
+ pattern. Each SOUND entry is broken down into the following
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
MESG - message window mapping (the only one supported in
3.7);
- msgtype - optional; message type to use, see "Configuring
+ msgtype - optional; message type to use, see "Configuring
Message Types"
pattern - the pattern to match;
sound file - the sound file to play;
- volume - the volume to be set while playing the sound
+ volume - the volume to be set while playing the sound
file;
- sound index - optional; the index corresponding to a sound
+ sound index - optional; the index corresponding to a sound
file.
The pattern should be a POSIX extended regular expression.
9.13. Configuring Status Hilites
Your copy of NetHack may have been compiled with support for
- "Status Hilites". If so, you can customize your game display by
+ "Status Hilites". If so, you can customize your game display by
setting thresholds to change the color or appearance of fields in
the status display.
OPTION=hilite_status:field-name/behavior/color&attributes
- For example, the following line in your configuration file
- will cause the hitpoints field to display in the color red if
+ For example, the following line in your configuration file
+ will cause the hitpoints field to display in the color red if
your hitpoints drop to or below a threshold of 30%:
OPTION=hilite_status:hitpoints/<=30%/red/normal
(That example is actually specifying red&normal for <=30% and no-
color&normal for >30%.)
- For another example, the following line in your configura-
- tion file will cause wisdom to be displayed red if it drops and
+ For another example, the following line in your configura-
+ tion file will cause wisdom to be displayed red if it drops and
green if it rises:
OPTION=hilite_status:wisdom/down/red/up/green
- Allowed colors are black, red, green, brown, blue, magenta,
- cyan, gray, orange, light-green, yellow, light-blue, light-magen-
- ta, light-cyan, and white. And "no-color", the default fore-
+ Allowed colors are black, red, green, brown, blue, magenta,
+ cyan, gray, orange, light-green, yellow, light-blue, light-ma-
+ genta, light-cyan, and white. And "no-color", the default fore-
ground color on the display, which is not necessarily the same as
black or white or any of the other colors.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- Allowed attributes are none, bold, dim, underline, blink,
- and inverse. "Normal" is a synonym for "none"; they should not
+ Allowed attributes are none, bold, dim, underline, blink,
+ and inverse. "Normal" is a synonym for "none"; they should not
be used in combination with any of the other attributes.
To specify both a color and an attribute, use `&' to combine
- them. To specify multiple attributes, use `+' to combine those.
+ them. To specify multiple attributes, use `+' to combine those.
For example: "magenta&inverse+dim".
- Note that the display may substitute or ignore particular
- attributes depending upon its capabilities, and in general may
- 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-
+ Note that the display may substitute or ignore particular
+ attributes depending upon its capabilities, and in general may
+ interpret the attributes any way it wants. For example, on some
+ display systems a request for bold might yield blink or vice
+ versa. On others, issuing an attribute request while another is
+ already set up will replace the earlier attribute rather than
+ combine with it. Since NetHack issues attribute requests 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.
+ the only way a situation like that can be controlled is to spec-
+ ify just one attribute.
- You can adjust the appearance of the following status
+ You can adjust the appearance of the following status
fields:
title dungeon-level experience-level
strength gold experience
charisma armor-class condition
alignment score
- The pseudo-field "characteristics" can be used to set all six
- of Str, Dex, Con, Int, Wis, and Cha at once. "HD" is "hit
- dice", an approximation of experience level displayed when
- polymorphed. "experience", "time", and "score" are condition-
+ The pseudo-field "characteristics" can be used to set all six
+ of Str, Dex, Con, Int, Wis, and Cha at once. "HD" is "hit
+ dice", an approximation of experience level displayed when
+ polymorphed. "experience", "time", and "score" are condition-
ally displayed depending upon your other option settings.
- 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-
- jor_troubles" as an alias for stone through termill, "mi-
+ 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-
+ jor_troubles" as an alias for stone through termill, "mi-
nor_troubles" for blind through hallu, "movement" for lev, fly,
and ride, and "all" for every condition.
* "always" will set the default attributes for that field.
- * "up", "down" set the field attributes for when the field
- value changes upwards or downwards. This attribute times
+ * "up", "down" set the field attributes for when the field
+ value changes upwards or downwards. This attribute times
out after statushilites turns.
- * "changed" sets the field attribute for when the field val-
- ue changes. This attribute times out after statushilites
+ * "changed" sets the field attribute for when the field
+ value changes. This attribute times out after
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- turns. (If a field has both a "changed" rule and an "up"
- or "down" rule which matches a change in the field's val-
- ue, the "up" or "down" one takes precedence.)
+ statushilites turns. (If a field has both a "changed"
+ rule and an "up" or "down" rule which matches a change in
+ the field's value, the "up" or "down" one takes prece-
+ dence.)
* percentage sets the field attribute when the field value
matches the percentage. It is specified as a number be-
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.
+ perience level to the start of the next level. So if
+ level 2 starts at 20 points and level 3 starts at 40
+ points, having 30 points is 50% and 35 points is 75%.
+ 100% is unattainable for experience because you'll gain a
+ level and the calculations will be reset for that new
+ level, but a rule for =100% is allowed and matches the
+ special case of being exactly 1 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-
-
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
geting.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
in the same format as the traditional per-user configuration file
(see above). This file should be named sysconf and placed in the
same directory as the other NetHack support files. The options
- recognized in this file are listed below. Any option not set us-
- es a compiled-in default (which may not be appropriate for your
+ recognized in this file are listed below. Any option not set
+ uses a compiled-in default (which may not be appropriate for your
system).
WIZARDS = A space-separated list of user names who are allowed
save file content in ascii text.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
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
+ 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
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
Mathematisch Centrum (now Centrum Wiskunde & Informatica),
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
Ken Arromdee, David Cohrs, Jean-Christophe Collet, Kevin Darcy,
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
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.
+ Timo Hakulinen ported NetHack 3.1 to OS/2. Eric Smith
+ ported NetHack 3.1 to the Atari. Pat Rankin, with help from
+ Joshua Delahunty, was responsible for the VMS version of NetHack
+ 3.1. Michael Allison ported NetHack 3.1 to Windows NT.
Dean Luick, with help from David Cohrs, developed NetHack
3.1 for X11. It drew the map as text rather than graphically but
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
- version 3.2.0 in April of 1996.
+ Darcy, Timo Hakulinen, Steve Linhart, Dean Luick, Pat Rankin,
+ Eric Smith, Mike Stephenson, Janet Walz, and Paul Winner, re-
+ leased version 3.2.0 in April of 1996.
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
Walz, and Paul Winner, released 3.3.0 in December 1999 and 3.3.1
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
stable version that provided continued enjoyment by the community
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
NetHack 3.6, hindered by limited access. Kevin Smolkowski has
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
- NetHack 3.7 February 07, 2023
+ NetHack 3.7 February 09, 2023
projects / nethack / commitdiff