View source for Options

{{otheruses|options for the most current stable release of NetHack ([[3.6.7]])|NetHack 3.4.3 and 3.4.3-NAO options|Options (3.4.3)}}
{{for|SLASH'EM and dNetHack options|Options (SLASH'EM)|Options (dNetHack)}}
{{tocright}}
Like most other games, ''[[NetHack]]'' has '''options''' that affect the look and feel of the game.

==Description==
There are two types of options: ''boolean'' and ''compound'' options. Boolean options toggle a setting on or off, while compound options take more diverse values.

The game options can be changed at the following locations:
* permanently in the [[#Configuration file|configuration file]] at one of the following locations:
** '''[[Windows]]''' (as of Nethack 3.6.2): '''.nethackrc''' located in %USERPROFILE%\NetHack\)
** '''[[DOS]] and [[Windows]]''' (before 3.6.2): '''defaults.nh''' in the same directory as <tt>nethack.exe</tt> or <tt>nethackW.exe</tt>)
** '''[[Unix]]''' (unix-based or unix-like systems, including macOS and Linux): '''~/.nethackrc''' 
** '''pre-OSX-[[Mac]] and [[wikipedia:BeOS|BeOS]]''': '''NetHack Defaults''' 
** '''[[Amiga]], [[Atari]], [[OS/2]] and [[VMS]]''': '''NetHack.cnf'''
* Temporarily by using the [[#In-game|in-game]] options screen, accessible by pressing {{kbd|shift|o}} in the game
* Each time the game is run, on the [[#Command line|command line]].
* When the game is [[Compile-time options|compiled]].

==Configuration file==
Options are usually prefixed by '<tt>OPTIONS=</tt>' on each line.

Name a boolean option in the configuration file to turn it on, and prefix it with 'no' or '!' to turn it off. Options can be combined into one line for brevity:
 OPTIONS=boulder:0, color, autodig, !cmdassist, norest_on_space
For compound options, the option name and value are separated by a colon:
 OPTIONS=catname:Mirri
The above two lines set <tt>[[#boulder|boulder]]</tt> to <tt>0</tt>, enable <tt>[[#color|color]]</tt> and <tt>[[#autodig|autodig]]</tt>, disable <tt>[[#cmdassist|cmdassist]]</tt> and <tt>[[#rest_on_space|rest_on_space]]</tt>, and set your [[#catname|cat's name]] to Mirri.

Any line beginning with a '#' is a comment; i.e. the line is ignored.

'''Persistent options:''' Some options are marked persistent, and are saved and reloaded along with the game. Changing a persistent option in the configuration file applies only to new games.

If a configuration file does not exist, create a new one that's appropriate for your system with a text file editor. (For Mac macOS Terminal, use ~/.nethackrc instead of NetHack Defaults)

==In-game==
The in-game configuration menu is brought up by pressing {{kbd|shift|o}}. It is similar to an item selection menu, where you use alphabetic letters to select which options to change. Boolean options are toggled on or off, while you are prompted to enter new values for compound options.

Some options cannot be changed in-game.

==Command line==
You can also set options from the command line by setting the <tt>NETHACKOPTIONS</tt> environment variable. If the value starts with '\' or '/' or '@', it is considered to be a config file name. For example:
 NETHACKOPTIONS=boulder:0, color, autodig
or
 NETHACKOPTIONS=@/home/username/.nethackrc

==Options==
===AUTOCOMPLETE===
Enable or disable autocompletion when entering particular extended commands. Listing them in a comma-separated list enables, prefixing with <tt>!</tt> disables. Example:

 AUTOCOMPLETE=zap,!annotate

===acoustics===
Enable messages about what your character hears. Boolean option, defaults to TRUE.

===align===
Your starting [[alignment]]. Compound option, with possible values of <tt>lawful</tt>, <tt>neutral</tt>, <tt>chaotic</tt>, or <tt>random</tt>. The first letter may be given alone. Prefix with ! to exclude that alignment from being picked randomly. Cannot be set in-game. Example that excludes chaotic:
 OPTIONS=align:!c

===autodescribe===
Automatically describe the terrain under cursor when asked to get a location on the map. The [[#whatis_coord|whatis_coord]] option controls whether the description includes map coordinates. It can be toggled by typing <tt>#</tt> while targeting.

===autodig===
Automatically dig, if you're wielding a [[digging tool]] and moving into a place that can be dug. Boolean option, defaults to FALSE. Can be set in-game. Persistent.

===autoopen===
Walking into a door attempts to open it. Boolean option, defaults to TRUE. Persistent.

===autopickup===
{{main|Autopickup}}
Automatically pick up things onto which you move. See also [[#pickup_types|pickup_types]], [[#pickup_burden|pickup_burden]], [[#pickup_thrown|pickup_thrown]], and [[Autopickup_exception]]s. Boolean option, defaults to TRUE. Can be set in-game.

===AUTOPICKUP_EXCEPTION===
{{main|Autopickup_exception}}
Autopickup exceptions allow you to specify particular expression matches for more nuanced autopickup usage. See the main article for usage information.

===autoquiver===
Automatically [[quiver]] some suitable weapon if your quiver empties when [[firing]]. Boolean option, defaults to FALSE. Can be set in-game. Persistent.

=== BIND ===
Change the key bindings of special keys, menu accelerators, or extended commands. You can specify multiple bindings for a single command. The format is a comma-separated list, with colon-separated keybinding and command. A binding overrides an existing key usage. Example:
 BIND=!:loot,^v:untrap,M-x:terrain
See [[Binding keys]] for a more detailed description and a list of bindable special commands.

===blind===
Start the character permanently blind. Boolean option, defaults to FALSE. Persistent.

===bones===
Allow saving and loading bones files. Boolean option, defaults to TRUE. Persistent.

===boulder===
Set the symbol used to display [[boulder]]s. For example <tt>boulder:0</tt>
Compound option with default value of <tt>`</tt>. Can be set in-game.

Can also be defined using ASCII value, and without the <tt>OPTIONS</tt> prefix simply as
 BOULDER=48
For example, <tt>BOULDER=64</tt> would be equal to <tt>OPTIONS=boulder:@</tt>.
See also [[Custom map symbols#BOULDER]]

This option has been superseded by the <tt>SYMBOLS=</tt> format described in the [[#symset|symset]] option, though this method still functions.

===catname===
Set the name of your starting [[kitten|cat]]. Compound option, and it cannot be set within game. See also [[#dogname|dogname]] and [[#horsename|horsename]]. Example:
 OPTIONS=catname:Whiskers

===character===
Synonym for [[#role|role]].

===checkpoint===
Save game state after each level change, for possible [[recover]]y after program crash. Boolean option, defaults to TRUE. Can be set in-game.

===checkspace===
Check free disk space before writing files to disk. You may have to turn this off if you have more than 2 GB free space on the partition used for your save and level files. A boolean option, defaults to on. Only applies when MFLOPPY was defined during compilation.

=== CHOOSE ===
Choose at random one of the comma-separated parameters as an active section name. Lines in other sections are ignored. This allows for a fine-tuned options set for particular roles. Example:

 CHOOSE=char A,char B
 [char A]
 OPTIONS=role:arc,race:dwa,align:law,gender:fem
 [char B]
 OPTIONS=role:wiz,race:elf,align:cha,gender:mal

===clicklook===
Allows looking at things on the screen by navigating the mouse over them and clicking the right mouse button. Boolean option, defaults to FALSE.

===cmdassist===
NetHack provides some additional command assistance when it detects some anticipated mistakes. Boolean option, defaults to TRUE. Can be set in-game.

===confirm===
Have user confirm attacks on [[peaceful]] creatures. Boolean option, defaults to TRUE. Can be set in-game. Persistent.

===dark_room===
Draw unseen (line-of-sight blocked) areas of lit rooms as if they were unlit. Boolean value, defaults to FALSE. Persistent.

===disclose===
Controls the prompts at the end of the game. Possible values are
*<tt>i</tt> - disclose your [[inventory]]
*<tt>a</tt> - disclose your [[attributes]]
*<tt>v</tt> - summarize monsters you've killed
*<tt>g</tt> - list [[genocide]]d monsters
*<tt>c</tt> - display [[conduct]]
*<tt>o</tt> - display dungeon overview
Each of those values can be preceded with a value that tells how it behaves. The possible values are
*<tt>y</tt> - prompt, defaults to yes
*<tt>n</tt> - prompt, defaults to no
*<tt>+</tt> - disclose without prompting
*<tt>-</tt> - don't disclose, don't prompt
The listing of killed monsters can be sorted, so there are two additional choices for <tt>v</tt>:
*<tt>?</tt> - prompt you and default to ask on the prompt;
*<tt>#</tt> - disclose it without prompting, ask for sort order.
For example
 OPTIONS=disclose:yi na +v -g -c -o

Persistent.

===dogname===
Set the name of your starting [[dog]]. Compound option, and it cannot be set within game. See also [[#catname|catname]] and [[#horsename|horsename]]. Example:

 OPTIONS=dogname:Cujo

===extmenu===
Does extended commands interface pop up a menu? Boolean option, defaults to FALSE. Only implemented for the TTY windowport.

===female===
An obsolete synonym for <tt>[[#gender|gender]]:female</tt>. Cannot be set in-game.

===fixinv===
An object's inventory letter sticks to it when it's dropped, so when you pick it up again, it will have the same inventory letter, unless there is already another item in your inventory using that letter. Boolean option, defaults to TRUE. Can be set in-game. Persistent.

===force_invmenu===
Commands asking for an inventory item will show a menu instead of a text query with possible menu letters. Boolean option, default is FALSE.

===fruit===
Set the name of the [[slime mold|user-definable fruit]]. Compound option, takes a string, with a default value of <tt>[[slime mold]]</tt>. Can be set in-game.

===gender===
Sets the [[gender]] of your character. A compound option, with possible values of <tt>male</tt>, <tt>female</tt>, or <tt>random</tt>. Default value is to pick an appropriate gender randomly. Cannot be set in-game.

===goldX===
When filtering objects based on blessed/cursed state (BUCX), this options specifices whether to include gold as X (unknown state) when on, and U (uncursed) when off. Default is off.

===help===
If more information is available for an object looked at with the [[what is]] {{kbd|/}} command, ask if you want to see it. Boolean option, defaults to TRUE. Can be set in-game. 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 commands.

===hilite_pet===
Visually distinguish [[pets]] from similar animals (This includes both your starting pet and any monsters you happen to tame along the way). Boolean option, defaults to FALSE. Can be set in-game.

===hilite_pile===
Visually distinguish piles of objects from individual objects. Boolean option, defaults to FALSE.

===hilite_status===
If the [[#statushilites|statushilites]] option is set, this option allows you to customize your game display by setting thresholds to change the color or appearance of fields in the status bar.

This is an "experimental feature" in NetHack 3.6.0 (in particular, it is missing from all official binaries, but most public servers enable it). In NetHack 3.6.1, it has been changed significantly and uses some different syntax.

For a full guide on configuring status hilites, see [[Status hilites]].

The whole feature can be disabled by turning the [[#statushilites|statushilites]] option off.

===hitpointbar===
Show a hit point bar graph behind your name and title. Only available for TTY and Windows GUI, and only when statushilites is on.

===horsename===
Set the name of your starting [[pony|horse]]. Compound option, and it cannot be set within game. See also [[#catname|catname]] and [[#dogname|dogname]].

===ignintr===
Ignore interrupt signals, including breaks. Boolean option, defaults to FALSE. Not implemented on Mac. Can be set in-game. Persistent.

===implicit_uncursed===
Omit "uncursed" from inventory lists, if possible. Boolean option, defaults to TRUE.

===legacy===
Display an introductory message when starting the game. Boolean option, defaults to TRUE. Cannot be set in-game.

===lit_corridor===
Distinguish visually between lit and unlit [[corridor]]s. Boolean option, defaults to FALSE. Can be set in-game. Persistent.

===lootabc===
Use the old <tt>a</tt>, <tt>b</tt> and <tt>c</tt> keyboard shortcuts in the [[loot]]ing menu. Boolean option, defaults to FALSE. Can be set in-game. Persistent.

===mail===
Enable [[mail]] delivery during the game. Boolean option, defaults to TRUE. Only meaningful if NetHack was compiled with MAIL. Can be set in-game.

===male===
An obsolete synonym for <tt>[[#gender|gender]]:male</tt>. Cannot be set in-game.

===mention_walls===
Give feedback when walking against a wall. Boolean value, defaults to FALSE.

===menucolors===
{{main|Menucolors}}
Enable coloring menu lines. Boolean value, defaults to FALSE. See main article for how to set menucolors with particular expression matches.

===menustyle===
Controls the interface used when you need to choose various objects (in response to the Drop command, for instance). Persistent. Compound option, with following possible values:

{|class="prettytable striped"
!Option
!Description
|-
|<tt>traditional</tt>
|prompt for object class characters, followed by an object-by-object prompt for all matching items
|-
|<tt>combination</tt>
|prompt for object classes of interest, then display a menu of matching objects
|-
|<tt>partial</tt>
|skip the object class filtering and immediately display a menu of all objects
|-
|<tt>full</tt>
|display a menu of object classes, and then a menu of matching objects
|}

===menu_deselect_all===
Menu character accelerator to deselect all items in a menu. Implemented by the Amiga, Gem, X11 and tty ports. Compound option, with default of <tt>'-'</tt>. Cannot be set in-game.

===menu_deselect_page===
Menu character accelerator to deselect all items on this page of a menu. Implemented by the Amiga, Gem and tty ports. Compound option, with default of <tt>'\'</tt>. Cannot be set in-game.

===menu_first_page===
Menu character accelerator to jump to the first page of a menu. Implemented by the Amiga, Gem and tty ports. Compound option, with default of <tt>'^'</tt>. Cannot be set in-game.

===menu_headings===
Controls how the headings in a menu are highlighted. Compound option, with possible values of <tt>none</tt>, <tt>bold</tt>, <tt>dim</tt>, <tt>underline</tt>, <tt>blink</tt>, or <tt>inverse</tt>. Not all ports can actually display all types.

===menu_invert_all===
Menu character accelerator to toggle the selections in a menu. Implemented by the Amiga, Gem, X11 and tty ports. Compound option, with default of <tt>'@'</tt>. Cannot be set in-game.

===menu_invert_page===
Menu character accelerator to toggle the selection on this page of a menu. Implemented by the Amiga, Gem and tty ports. Compound option, with default of <tt>'~'</tt>. Cannot be set in-game.

===menu_last_page===
Menu character accelerator to jump to the last page of a menu. Implemented by the Amiga, Gem and tty ports. Compound option, with default of <tt>'|'</tt>. Cannot be set in-game.

===menu_next_page===
Menu character accelerator to goto the next page of a menu. Implemented by the Amiga, Gem and tty ports. Compound option, with default of <tt>'>'</tt>. Cannot be set in-game.

===menu_objsyms===
Show object symbols in menu headings in menus where the object symbols act as menu accelerators. Boolean option, defaults to FALSE.

===menu_overlay===
Do not clear the screen before drawing menus, and align menus to the right edge of the screen. Only for the TTY windowport. Boolean option, defaults to TRUE.

===menu_previous_page===
Menu character accelerator to goto the previous page of a menu. Implemented by the Amiga, Gem and tty ports. Compound option, with default of <tt>'<'</tt>. Cannot be set in-game.

===menu_search===
Menu character accelerator to search for a menu item. Implemented by the Amiga, Gem and X11 ports. Compound option, with default of <tt>':'</tt>. Cannot be set in-game.

===menu_select_all===
Menu character accelerator to select all items in a menu. Implemented by the Amiga, Gem, X11 and tty ports. Compound option, with default of <tt>'.'</tt>. Cannot be set in-game.

===menu_select_page===
Menu character accelerator to select all items on this page of a menu. Implemented by the Amiga, Gem and tty ports. Compound option, with default of <tt>','</tt>. Cannot be set in-game.

===menu_tab_sep===
Use tabs to separate menu names from their values. This option is only shown when in wizard-mode, and is only meant for testing purposes. <!--FIXME: move to wizmode section?-->

===msghistory===
Number of message-window messages to save. Compound option, takes a positive number, with default of 20. Maximum and minimum values depend on the window port; For the TTY, [[X11]] and Gem ports the minimum is 20 and maximum 60. Cannot be set in-game.

===msg_window===
How to show the latest messages recalled with <tt>^P</tt>. Compound option, with the following possible values:

{|class="prettytable striped"
!Option
!Description
|-
|<tt>single</tt>
|show single message
|-
|<tt>combination</tt>
|two messages as single, then as full
|-
|<tt>full</tt>
|full window, oldest message first
|-
|<tt>reversed</tt>
|full window, newest message first
|}

You can use the first letter of an option to specify that option. For backwards compatibility, no value needs to be given; in that case defaults to '<tt>full</tt>', or it can be negated like a boolean option, in which case defaults to '<tt>single</tt>'.
Can be set in-game only if playing the TTY windowport.

===MSGTYPE===
{{main|MSGTYPE}}

Can be used to hide obnoxious messages or emphasize dangerous ones. See main article for how to use MSGTYPEs.

===name===
The name of your character. Compound option, defaults to your user name. If set to <tt>player</tt>, then NetHack will ask for the user name, even on systems where it normally wouldn't. If suffixed with dash and character role letter (one of <tt>-A -B -C -H -K -M -P -Ra -Ro -S -T -V -W</tt>), then also defines the character role, or if suffixed with <tt>-@</tt>, then selects a random role.
Cannot be set in-game.

===news===
Read the NetHack <tt>news</tt> file at start of game, if present. Boolean option, defaults to TRUE.

===nudist===
Start the character with no armor. Boolean option, defaults to FALSE. Persistent.

===null===
Send padding NULLs to terminal. A boolean, defaults to FALSE. Only used if you compiled NetHack with TERMCAP and without TIMED_DELAY. Persistent.

===number_pad===
Use the number keys to move instead of [[hjklyubn]]. Valid options are:

{|class="prettytable striped"
!Option
!Description
|-
|<tt>0</tt>
|move by letters; 'yuhjklbn'
|-
|<tt>1</tt>
|move by numbers; digit {{kbd|5}} acts as {{kbd|G}} movement prefix
|-
|<tt>2</tt>
|like 1 but {{kbd|5}} works as {{kbd|g}} prefix instead of as {{kbd|G}}
|-
|<tt>3</tt>
|by numbers using phone key layout; 123 above, 789 below
|-
|<tt>4</tt>
|combines 3 with 2; phone layout plus MSDOS compatibility, where {{kbd|5}} means {{kbd|g}}, {{kbd|alt|5}} means {{kbd|G}}, and {{kbd|alt|0}} mean {{kbd|I}}
|-
|<tt>-1</tt>
|by letters but use {{kbd|z}} to go northwest, {{kbd|y}} to zap wands (for German keyboards)
|}

With <tt>number_pad</tt> set to <tt>1</tt>, <tt>2</tt>, <tt>3</tt>, or <tt>4</tt>, counts need to be prefixed with {{kbd|n}} ({{kbd|n}}{{kbd|5}}{{kbd|0}}{{kbd|s}} to search 50 times). Also, some [[extended command]]s are available in a short form ({{kbd|l}} performs #[[loot]], {{kbd|u}} performs #[[untrap]], etc).

For backwards compatibility, number_pad without a value is synonymous to <tt>number_pad:1</tt>.

===packorder===
Sets the order of item classes shown in [[inventory]]. Compound option, takes a string of up to 14 characters, with default values of <tt>")[%?+!=/(*`0_</tt>. Omitted types are filled in at the end from the previous order. Can be set in-game. Persistent.

===paranoid_confirmation===
A space-separated list of specific situations where alternate prompting is desired. The default is <tt>paranoid_confirmation:pray</tt>.

{|class="prettytable striped"
!Option
!Description
|-
|<tt>Confirm</tt>
|for any prompts which are set to require "yes" rather than 'y', also require "no" to reject instead of accepting any non-yes response as no
|-
|<tt>quit</tt>
|require "yes" rather than 'y' to confirm quitting the game or switching into non-scoring explore mode
|-
|<tt>die</tt>
|require "yes" rather than 'y' to confirm dying (applies only to [[explore mode]])
|-
|<tt>bones</tt>
|require "yes" rather than 'y' to confirm saving bones data when dying in [[wizard mode|debug mode]]
|-
|<tt>attack</tt>
|require "yes" rather than 'y' to confirm attacking a peaceful monster
|-
|<tt>pray</tt>
|require 'y' to confirm an attempt to pray rather than immediately praying; on by default
|-
|<tt>wand-break</tt>
|require "yes" rather than 'y' to confirm breaking a wand. (NetHack 3.6.2 only)
|-
|<tt>Were-change</tt>
|require "yes" rather than 'y' to confirm changing form due to lycanthropy when hero has polymorph control. (NetHack 3.6.2 only)
|-
|<tt>Remove</tt>
|require selection from inventory for {{kbd|R}} and {{kbd|T}} commands even when wearing just one applicable item
|-
|<tt>all</tt>
|turn on all of the above
|}

{{upcoming|NetHack 3.7.0|{{commit|03c715f17960efde6c121631bffa61cff25fddb6|This commit}} introduces <tt>paranoid_confirmation:swim</tt>, which will prevent you from walking onto water or lava unless you prefix the movement with {{kbd|m}}.}}

By default, the pray choice is enabled, the others disabled. To disable it without setting any of the other choices, use <tt>paranoid_confirmation:none</tt>. To keep it enabled while setting any of the others, include it in the list:

 OPTIONS=paranoid_confirmation:attack pray Remove

===perm_invent===
Show permanent inventory window. Boolean option, defaults to FALSE. Not used on TTY. Can be set in-game. Persistent.

===pettype===
Sets your preferred [[pet]] type. A compound option, with possible value of <tt>cat</tt>, <tt>dog</tt>, or use <tt>none</tt> to start a game without a pet. Cannot be set in-game.

===pickup_burden===
Prompt for confirmation before picking up items that will push the character's [[encumbrance]] past a given level -- <tt>Unencumbered</tt>, <tt>Burdened</tt>, <tt>streSsed</tt>, <tt>straiNed</tt>, <tt>Overtaxed</tt>, or <tt>overLoaded</tt>. This will '''not''' prompt the player when picking up a [[loadstone]].{{refsrc|src/pickup.c|1404|version=NetHack 3.6.6}} Defaults to <tt>S</tt>. Persistent.

===pickup_thrown===
If this option is on and [[#autopickup|autopickup]] is also on, try to pick up things that you threw, even if they aren't in [[#pickup_types|pickup_types]] or match an [[Autopickup_exception|autopickup exception]]. Boolean option, defaults to TRUE. Persistent.

===pickup_types===
Specify the object types to be picked up when [[#autopickup|autopickup]] is on. Default is <tt>all</tt> to pick up all types. For example "<tt>pickup_types:?!/</tt>" would pick up all [[scroll]]s, [[potion]]s and [[wand]]s. Persistent.

===pile_limit===
When walking across a pile of objects on the floor, threshold at which the message "there are few/several/many objects here" is given instead of showing a popup list of those objects. A value of 0 means "no limit" (always list the objects); a value of 1 effectively means "never show the objects" since the pile size will always be at least that big; default value is 5. Persistent.

===playmode===
Values are <tt>normal</tt>, <tt>explore</tt>, or <tt>debug</tt>. 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 system) or it might be disabled entirely. Requesting it when not allowed or not possible results in explore mode instead. NAO has both Explore and Debug modes disabled entirely. Default is normal play.

===pushweapon===
If you [[wield]] something when you are already wielding something else, the old [[weapon]] is pushed into the alternate weapon slot. Boolean option, defaults to FALSE. Can be set in-game. Persistent.

===race===
Set your character's [[race]]. A compound option, with possible values of <tt>human</tt>, <tt>elf</tt>, <tt>dwarf</tt>, <tt>gnome</tt>, <tt>orc</tt>, or <tt>random</tt>, with default of random. If you prefix a <tt>!</tt> to the value, you can exclude that race from being picked randomly. Cannot be set in-game. Persistent.

===rest_on_space===
Space [[wait]]s for a turn. This is considered by some as a very easy way to get killed.

Boolean option, defaults to FALSE. Can be set in-game. Persistent.

===role===
Set your character's [[role]]. Can also be <tt>random</tt>. A compound option. See [[#name|name option]] for an alternate method of specifying your role. Normally only the first letter of the value is examined, with <tt>r</tt> being the exception with <tt>Rogue</tt>, <tt>Ranger</tt>, and <tt>random</tt> values. If you prefix an option with <tt>!</tt>, you can exclude that role from being picked randomly. Cannot be set in-game. Persistent.

===roguesymset===
This option may be used to select one of the named symbol sets found within the [[Source:NetHack_3.6.0/dat/symbols|symbols]] file to alter the symbols displayed on the screen on the [[rogue level]].

===rlecomp===
When writing out a save file, perform a run length compression of the map. Not all ports support run length compression. It has no effect on reading an existing save file.

===runmode ===
Set the screen updating interval for multi-turn actions, eg. running or traveling. Can be set in-game. Compound option with the following possible values:

{|class="prettytable striped"
!Option
!Description
|-
|<tt>teleport</tt>
|update the map after movement has finished
|-
|<tt>run</tt>
|update the map after every seven or so steps (default)
|-
|<tt>walk</tt>
|update the map after each step
|-
|<tt>crawl</tt>
|like walk, but pause briefly after each step
|}

===safe_pet===
Prevents you from (knowingly) attacking your pet by moving into it. TRUE is the best setting as attacking a pet, should you wish to, is easily accomplished using the [[fight]] command. Boolean option, defaults to TRUE. Can be set in-game.

===sanity_check===
This option turns on debugging output, and is only available in [[wizard mode]]. Boolean option, defaults to FALSE. <!--FIXME: wizmode section?-->

===scores===
Control what part of hiscore list to show at the end of game. Compound option. Can be set in-game. Persistent. Accept the following options, separated by spaces:
*<tt>o</tt> - show my own score. Can be prefixed with <tt>!</tt> to not show own score.
*<tt>Xa</tt> - show X scores around own score
*<tt>Xt</tt> - show X scores from the top
For example:
 OPTIONS=scores:10t 2a o

===showexp===
Displays the exact number of experience points next to your [[experience level]] on the [[status line]]. Useful for seeing how close you are to the next level, but it may increase the length of the status line a lot, pushing important notifications (like Hungry, Ill, FoodPois, etc.) off the end.

Boolean option, defaults to FALSE. Can be set in-game. Persistent.

===showrace===
Uses the symbol for your race instead of {{white|@}}: {{white|h}} for [[Dwarf (starting race)|dwarves]], {{white|o}} for [[Orc (starting race)|orcs]] and {{white|G}} for [[Gnome (starting race)|gnomes]]. Elves are still {{white|@}}. This could be useful for reminding you not to [[genocide]] your racial glyph, but is not widely used. Boolean option, defaults to FALSE. Can be set in-game.

===showscore===
Shows your approximate accumulated score on the bottom line. Boolean option, defaults to FALSE. Can be set in-game. Persistent. Only available if NetHack was compiled with SCORE_ON_BOTL.

===silent===
Stops your terminal's bell sounding. Boolean option, defaults to TRUE. Can be set in-game. Persistent.

===sortloot===
Controls the sorting behavior of the pickup lists for inventory and #[[loot]] commands and some others. Persistent. The possible values are:

{|class="prettytable striped"
!Option
!Description
|-
|<tt>full</tt>
|always sort the lists
|-
|<tt>loot</tt>
|only sort the lists that don't use inventory letters, like with the #[[loot]] and pickup commands
|-
|<tt>none</tt>
|show lists the traditional way without sorting
|}

===sortpack===
Groups similar kinds of objects in your inventory. TRUE is highly recommended. Boolean option, defaults to TRUE. Can be set in-game. Persistent.

===SOUND===
{{main|User sounds}}
Allows user-defined sound file to be played when a message is shown.

===sparkle===
Display sparkly effect for resisted magical attacks (e.g. a fire attack on a fire-resistant monster). It can be helpful to turn this off on the [[Plane of Fire]], otherwise a dozen or more sparkles will occur per turn. See also [[#timed_delay|timed_delay]].

Boolean option, defaults to TRUE. Can be set in-game. Persistent.

===standout===
Uses standout mode (reverse video) for displaying "<tt>--More--</tt>". Boolean option, defaults to FALSE. Can be set in-game. Persistent.

===status_updates===
Allow updates to the status lines at the bottom of the screen (default true).

===statushilites===
Controls how many turns status hilite behaviors highlight the field. If negated or set to zero, disables status hiliting.

Only useful when you have status hilite rules configured; see the [[#hilite_status|hilite_status]] option for more information.

===statuslines===
Allows you to choose whether your status bar has 2 or 3 lines. Can also be set during the game. Your user interface must support at least 25 rows, when using the value of 3. This is especially useful in [[Curses interface]].

===suppress_alert===
Prevent alert notification messages about feature changes in a NetHack version and the previous versions. Compound option, accepts a string describing a NetHack version. Can be set in-game. Currently only one use, which is to prevent the [[quiver]] and [[quit]]-command changes:
 OPTIONS=suppress_alert:3.3.1

===symset===
{{main|symset}}

Select the symbols used to display the game. Replaces the DECgraphics, IBMgraphics, and MACgraphics options.

* NHAccess (Recommended for blind players)
* MACgraphics
* IBMGraphics_2
* IBMGraphics_1
* IBMgraphics
* DECgraphics

Individual symbols may be set using the following format:

 SYMBOLS=S_boulder:0
 SYMBOLS=S_golem:7
 SYMBOLS=S_ghost:8

For a complete list of symbol names, please see the [[symset]] article.

===time===
Displays elapsed game time, in turns, on the status line. Very useful for estimating prayer timeouts, spell lifespan, and more. Boolean option, defaults to FALSE. Can be set in-game. Persistent.

===timed_delay===
On TTY interfaces ([[unix]] and [[VMS]]), use a timer instead of sending extra screen output when attempting to pause for a display effect. On [[MSDOS]] without the termcap lib, chooses whether or not to pause for visual effect.  See also [[#sparkle|sparkle]].

Boolean option, defaults to TRUE if configured into the program. Can be set in-game. Persistent.

===tombstone===
Prints an ASCII tombstone when you die. Boolean option, defaults to TRUE. Can be set in-game. Persistent.

===toptenwin===
Prints the top ten high scores in a window rather than stdout. This isn't very useful unless you are using a [[GUI]] version. Boolean option, defaults to FALSE. Can be set in-game. Persistent.

===travel===
Enables the [[travel]] command. Boolean option, defaults to TRUE. Can be set in-game. Persistent.

===verbose===
Chooses whether or not to display certain non-essential messages, such as doors being destroyed. Boolean option, defaults to TRUE. Can be set in-game. Persistent.

===vt_tiledata===
{{main|vt_tiledata}}
Boolean option. Turning it on will output extra information in the datastream in the form of escape code "ESC [ ... z", meant for graphical frontends. See also [[EbonHack]].

===whatis_coord===
When using the <tt>/</tt> ([[What is|what is]]) or <tt>;</tt> ([[Far look|far look]]) commands to [[Targeting|look around on the map]] with autodescribe on, display coordinates after the description. Also works in other situations where you are asked to pick a location.

The possible settings are:
*<tt>c</tt> - compass ('east' or '3s' or '2n,4w')
*<tt>f</tt> - full compass ('east' or '3south' or '2north,4west')
*<tt>m</tt> - map &lt;x,y&gt; (map column x=0 is not used)
*<tt>s</tt> - screen [row,column] (row is offset to match tty usage)
*<tt>n</tt> - none (no coordinates shown). Default.

The whatis_coord option is also used with the sub-commands <tt>m</tt>, <tt>M</tt>, <tt>o</tt>, and <tt>O</tt> when using <tt>/</tt>, where the 'none' setting is overridden with 'map'.

===whatis_filter===
When using the <tt>m</tt>, <tt>o</tt>, <tt>d</tt>, <tt>x</tt> or <tt>a</tt> keys to [[Targeting|select a location on the map]], allows filtering the possible targets. It can be set by typing <tt>"</tt> while targeting. It can be set to:
*<tt>n</tt> - no filtering (default)
*<tt>v</tt> - in view only
*<tt>a</tt> - in same area only (e.g. same room or same corridor)

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 toward.

===whatis_menu===
When using the <tt>m</tt>, <tt>o</tt>, <tt>d</tt>, <tt>x</tt> or <tt>a</tt> keys to [[Targeting|select a location on the map]], uses a menu to pick a target. Otherwise, typing a lowercase letter will cycle through targets from nearest to furthest, and an uppercase letter from furthest to nearest. It can be toggled by typing <tt>!</tt> while targeting. Boolean, default off.

===whatis_moveskip===
When [[Targeting|selecting 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. It can be toggled by typing <tt>*</tt> while targeting. Boolean, default off.

===windowtype===
Select which windowing system to use, such as <tt>tty</tt> or <tt>X11</tt> (default depends on version). Cannot be set in-game. Example:
 OPTIONS=windowtype:tty

===wizkit===
[[Wizard mode]]-only option. Specifies the path to a text file that contains a list of item names, one per line, up to a maximum of 128 lines. Each line is processed by the function that handles wishing.

For example, if you enter this path to a text file in your config:

 WIZKIT=wizkit.txt

And the contents of <tt>wizkit.txt</tt> are:
 blessed [[scroll of monster detection|monster detection]]
 [[ring of levitation]]
 [[Amulet of Yendor|amulet of yendor]]
 2 blessed [[scroll of genocide|genocide]]

Then your character start with those items in their inventory, in addition to the normal starting items.

===zerocomp===
When writing out a save file, perform zero-comp compression of the contents. Not all ports support zero-comp compression. It has no effect on reading an existing save file.

== Window Port Customization Options ==

===align_message===
Where to align or place the message window. Compound option, with possible values of <tt>top</tt>, <tt>bottom</tt>, <tt>left</tt>, or <tt>right</tt>. Cannot be set in-game.

===align_status===
Where to align or place the status window. Compound option, with possible values of <tt>top</tt>, <tt>bottom</tt>, <tt>left</tt>, or <tt>right</tt>. Cannot be set in-game.

===ascii_map===
NetHack should display an [[ASCII]] character map if it can. Boolean option. Can be set in-game.

===color===
{{Main|colors}}
NetHack should display color if it can for different [[monster]]s, [[object]]s, and [[dungeon feature]]s. This option matters only for the TTY windowport. Boolean option, defaults to TRUE on most systems including Windows and Mac. Can be set in-game.

In case the default color scheme is hard to distinguish on your monitor, you might want to [[Colors#Changing_terminal_colors|edit the color preferences in your terminal emulator]].

If you are looking for colors of the wiki itself, see [[:Category:Function_templates]] and [[User:Paxed/ReplaceCharsBlock]].

===eight_bit_tty===
NetHack should pass eight-bit character values straight through to your terminal. Boolean option, defaults to FALSE. Can be set in-game.

===font_map===
NetHack should use a font by the chosen name for the map window.

===font_menu===
NetHack should use a font by the chosen name for menu windows.

===font_message===
NetHack should use a font by the chosen name for the message window.

===font_status===
NetHack should use a font by the chosen name for the status window.

===font_text===
NetHack should use a font by the chosen name for text windows.

===font_size_map===
NetHack should use this size font for the map window.

===font_size_menu===
NetHack should use this size font for menu windows.

===font_size_message===
NetHack should use this size font for the message window.

===font_size_status===
NetHack should use this size font for the status window.

===font_size_text===
NetHack should use this size font for text windows.

===fullscreen===
NetHack should try and display on the entire screen rather than in a window. Boolean option, defaults to false. Cannot be set in-game.

If the game cannot be displayed in fullscreen through this option and you are using the tty interface, you can usually adjust your terminal emulator configuration to achieve a similar effect (e.g. by increasing the font size).

===large_font===
NetHack should use a large font.

===map_mode===
NetHack should display the map in the manner specified. Used in Windows port to choose between tiles or different sizes of ASCII. Consult defaults.nh for possible options.

===mouse_support===
Use mouse for moving around. A boolean, defaults to FALSE. Is displayed, but cannot be set in-game.

===player_selection===
NetHack should pop up dialog boxes, or use prompts for character selection. Compound option. Cannot be set in-game.

===popup_dialog===
NetHack should pop up dialog boxes for input. Boolean option, defaults to false. Can be set in-game.

===preload_tiles===
NetHack should preload tiles into memory. Boolean option, defaults to true. Cannot be set in-game.

===scroll_amount===
NetHack should scroll the display this many map cells when the hero reaches the [[#scroll_margin|scroll_margin]]. A compound option, accepts a positive number. Cannot be set in-game.

===scroll_margin===
NetHack should scroll the display when the hero or cursor is this number of cells away from the edge of the window. A compound option, accepts a positive number. Cannot be set in-game.

===selectsaved===
NetHack 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 on-screen keyboards; handhelds are most likely to support this. Boolean option, defaults to off. Cannot be set in-game.

===splash_screen===
NetHack should display an opening splash screen when it starts up. Boolean option, defaults to yes.

===tile_width===
Specify the preferred width of each tile in a tile capable port. Compound option, accepts a positive number. Cannot be set in-game.

===tile_height===
Specify the preferred height of each tile in a tile capable port. Compound option, accepts a positive number. Cannot be set in-game.

===tile_file===
Specify the name of an alternative tile file to override the default. Compound option. Cannot be set in-game.

===tiled_map===
NetHack should display a tiled map if it can. Boolean option, Cannot be set in-game.

===use_darkgray===
Use bold black instead of blue for black glyphs (TTY only). Boolean option.

===use_inverse===
Displays certain things in reverse video. Boolean option, defaults to FALSE on non-Win32 platforms. Can be set in-game.

===vary_msgcount===
NetHack should display this number of messages at a time in the message window. Compound option, accepts a positive number. Cannot be set in-game. Implemented only for the Atari GEM, Win32 GUI and WinCE builds.

===WARNINGS===
{{todo|NetHack 3.6.7 parses this option, but it is unclear what it does with the information. Setting the warning symbols to non-default values still shows default warning symbols of '1' through '5'. However, with non-default values, the farlook command on a warning symbol (on  screen as '1') says "I've never heard of such things" rather than "an unknown creature causing you concern". So NetHack 3.6.7 is parsing this option, but then not fully using it.}}

===windowcolors===
NetHack should display windows with the specified foreground/background colors if it can. Compound option. Cannot be set in-game.
 OPTIONS=windowcolors:''wintype'' ''fground''/''bground''
where ''wintype'' is one of <tt>menu</tt>, <tt>message</tt>, <tt>status</tt>, <tt>text</tt>,
and ''fground'' and ''bground'' are colors, either a hexadecimal <tt>#rrggbb</tt>,
one of the named colors (<tt>black</tt>, <tt>red</tt>, <tt>green</tt>, <tt>brown</tt>,
<tt>blue</tt>, <tt>magenta</tt>, <tt>cyan</tt>, <tt>orange</tt>, <tt>brightgreen</tt>, <tt>yellow</tt>, <tt>brightblue</tt>,
<tt>brightmagenta</tt>, <tt>brightcyan</tt>, <tt>white</tt>, <tt>trueblack</tt>, <tt>gray</tt>, <tt>purple</tt>,
<tt>silver</tt>, <tt>maroon</tt>, <tt>fuchsia</tt>, <tt>lime</tt>, <tt>olive</tt>, <tt>navy</tt>, <tt>teal</tt>, <tt>aqua</tt>),
or one of Windows UI colors (<tt>activeborder</tt>, <tt>activecaption</tt>,
<tt>appworkspace</tt>, <tt>background</tt>, <tt>btnface</tt>, <tt>btnshadow</tt>, <tt>btntext</tt>,
<tt>captiontext</tt>, <tt>graytext</tt>, <tt>greytext</tt>, <tt>highlight</tt>, <tt>highlighttext</tt>,
<tt>inactiveborder</tt>, <tt>inactivecaption</tt>, <tt>menu</tt>, <tt>menutext</tt>, <tt>scrollbar</tt>,
<tt>window</tt>, <tt>windowframe</tt>, <tt>windowtext</tt>).

Example:
 OPTIONS=windowcolors:menu white/black message green/yellow status white/blue text #ffffff/#000000

===wraptext===
NetHack port should wrap long lines of text if they don't fit in the visible portion of the window. Boolean, defaults to false. Can be set in-game.

<!-- ---------------------------------------- -->
<!-- ---------------------------------------- -->
<!-- ---------------------------------------- -->

== Platform-specific Customization options ==

===altkeyhandler===
Select an alternate keystroke handler dll to load. The name of the handler is specified without the .dll extension and without any path information. Win32 only. Cannot be set in-game. NetHack comes with <tt>nhdefkey.dll</tt>, <tt>nhraykey.dll</tt>, and <tt>nh340key.dll</tt>. If you are using a non-US keyboard layout and cannot type the dollar sign or the hash mark, try nhraykey.

===altmeta===
Enables [[extended command]] shortcuts, such as {{kbd|alt|d}} to [[dip]].<ref name="unixesc">{{kbd|esc}} followed by {{kbd|d}} on unix systems also works</ref> Boolean option, default is off, except on Amiga. Can be set in-game. Is saved into the savefile.{{refsrc|src/options.c|54|nethack=3.6.0}}

===BIOS===
Use BIOS calls to update the screen display quickly and to read the keyboard (allowing the use of arrow keys to move) on machines with an IBM PC compatible BIOS ROM. Boolean option, default off. OS/2, PC, and ST NetHack only. Cannot be set in-game.

===DECgraphics===
Use DEC line-drawing characters. Won't work for all terminals. Boolean option, defaults to TRUE. Can be set in-game. Turning this on sets [[#IBMgraphics|IBMgraphics]] to FALSE.

Starting with [[NetHack 3.6.0]], this option is equivalent to [[symset]]:DECgraphics.

===flush===
Prevent typeahead. Boolean option, defaults to off. Only usable on Amiga. Can be set in-game.

===IBMgraphics===
{{main|IBMgraphics}}

Use IBM extended characters. Won't work for all terminals. Boolean option, defaults to FALSE. Only implemented for the TTY windowport. Can be set in-game.

Starting with [[NetHack 3.6.0]], this option is equivalent to [[symset]]:IBMgraphics.

===MacGraphics===
Use Mac-specific character set to display map. A boolean, Mac-only, defaults to on. See also [[#IBMgraphics|IBMgraphics]] and [[#DECgraphics|DECgraphics]].

Starting with [[NetHack 3.6.0]], this option is equivalent to [[symset]]:MACgraphics.

===page_wait===
Show --more-- after a page of messages. A boolean, Macs only, defaults to on.

===rawio===
Force raw (non-cbreak) mode for faster output and more bulletproof 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 in-game.

===soundcard===
Compound option, defaults to on. Only for the PC NetHack. Cannot be set in-game.

===subkeyvalue===
(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. <tt>OPTIONS=subkeyvalue:171/92</tt> will return 92 to NetHack, if 171 was originally going to be returned. You can use multiple subkeyvalue statements in the config file if needed. Cannot be set in-game.

===video===
Set the video mode used. PC NetHack only. Values are <tt>autodetect</tt>, <tt>default</tt>, or <tt>vga</tt>. Setting <tt>vga</tt> (or <tt>autodetect</tt> with vga hardware present) will cause the game to display tiles.
Cannot be set in-game.

===videocolors===
Set the color palette for PC systems using NO_TERMS (default <tt>4-2-6-1-5-3-15-12-10-14-9-13-11</tt>, 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 in-game.

Note: If the <tt>#version</tt>-command shows <tt>screen control via foo</tt>, where foo is one of <tt>mactty</tt>, <tt>BIOS</tt>, <tt>DJGPP fast</tt>, <tt>VGA graphics</tt> or <tt>WIN32 console I/O</tt>, then your version of NetHack supports setting videocolors.

===videoshades===
Set the intensity level of the three gray scales available (default is <code>videoshades:dark-normal-light</code>, PC NetHack only). If the game display is difficult to read, try adjusting these scales; if this does not correct the problem, try !color.

Possible values are the 3 brightnesses (dark, normal, light) separated by hyphens, eg. <code>videoshades:dark-normal-light</code> or <code>videoshades:normal-dark-normal</code>.

Cannot be set in-game.



<!-- ---------------------------------------- -->
<!-- ---------------------------------------- -->
<!-- ---------------------------------------- -->

==References==
<References />

[[Category:User interface]]
[[Category:Options]]
{{nethack-361}}