Compile-time options - Revision history

Umbire the Phantom: lede

2025-02-05T19:47:16Z

lede

Ion frigate: phrasing - trying to fit IFNDEF into the same sentence is just too awkward

2025-02-05T18:54:09Z

phrasing - trying to fit IFNDEF into the same sentence is just too awkward

Ion frigate: be consistent with what's currently in the article

2025-02-05T07:07:51Z

be consistent with what's currently in the article

Ion frigate: wording - build does mean compile, but that's not the first meaning most people will think of

2025-02-05T07:01:07Z

wording - build does mean compile, but that's not the first meaning most people will think of

Ion frigate: be explicit

2025-02-05T06:49:37Z

be explicit

Ion frigate: rewrite lede to get into history, make clear that modern nethack doesn't let you compile out features

2025-02-05T06:48:35Z

rewrite lede to get into history, make clear that modern nethack doesn't let you compile out features

Umbire the Phantom: pothole

2023-11-12T22:54:32Z

pothole

Paxed: Update somewhat for 3.6.1

2019-03-23T09:33:23Z

Update somewhat for 3.6.1

Tjr: add keyword NetHack for Google

2010-11-21T16:42:33Z

add keyword NetHack for Google

Paxed: this is 3.4.3 specific

2010-11-21T14:44:35Z

this is 3.4.3 specific

← Older revision		Revision as of 19:47, 5 February 2025
Line 1:		Line 1:
−	'''Compile-time options''' are certain features of ''NetHack'' that can be enabled or disabled when ~~the game is~~ [[compiling~~\|compiled~~]]~~, that is, built afresh~~ from the [[source code]]. In the source code, blocks of code that will be enabled by a compile-time option are separated into "#IFDEF <option> / #ENDIF" blocks; if <option> is disabled, the code in the block will not be compiled into the binary executable file. Most of these can be selected in [[config.h]], in particular, at the end of this file, or on a UNIX system, in a hints file.	+	'''Compile-time options''' are certain features of ''NetHack'' that can be enabled or disabled when [[compiling]] the game from the [[source code]]. In the source code, blocks of code that will be enabled by a compile-time option are separated into "#IFDEF <option> / #ENDIF" blocks; if <option> is disabled, the code in the block will not be compiled into the binary executable file. Most of these can be selected in [[config.h]], in particular, at the end of this file, or on a UNIX system, in a hints file.

	The compile-time options listed below are those that visibly affect the end-user experience. In modern ''NetHack'', most compile-time options govern back-end features (such as compression of bones and save files) that do not have a visible effect on the game. Historically, NetHack had a large number of compile-time options that added or removed entire game features, such as [[foocubi]], [[Tourist]]s, or (going farther back) the whole [[spellcasting]] system. This was done for two reasons: to provide users a way to test and potentially opt out of then-new features, and to allow users on systems with limited memory to compile a smaller executable file. The second reason may sound strange to a modern audience, but NetHack, being originally built for UNIX systems, did not fit into the base 640-kilobyte memory of an [[MS-DOS]] machine by version [[3.0.0]].		The compile-time options listed below are those that visibly affect the end-user experience. In modern ''NetHack'', most compile-time options govern back-end features (such as compression of bones and save files) that do not have a visible effect on the game. Historically, NetHack had a large number of compile-time options that added or removed entire game features, such as [[foocubi]], [[Tourist]]s, or (going farther back) the whole [[spellcasting]] system. This was done for two reasons: to provide users a way to test and potentially opt out of then-new features, and to allow users on systems with limited memory to compile a smaller executable file. The second reason may sound strange to a modern audience, but NetHack, being originally built for UNIX systems, did not fit into the base 640-kilobyte memory of an [[MS-DOS]] machine by version [[3.0.0]].

← Older revision		Revision as of 18:54, 5 February 2025
Line 1:		Line 1:
−	'''Compile-time options''' are certain features of ''NetHack'' that can be enabled or disabled when the game is [[compiling\|compiled]], that is, built afresh from the [[source code]]. In the source code, blocks of code that will be enabled~~/disabled~~ by compile-time ~~options~~ are separated into #IFDEF/#~~IFNDEF~~ blocks; if ~~the corresponding~~ option is disabled~~/enabled respectively~~, the code will not be compiled into the binary executable file. Most of these can be selected in [[config.h]], in particular, at the end of this file, or on a UNIX system, in a hints file.	+	'''Compile-time options''' are certain features of ''NetHack'' that can be enabled or disabled when the game is [[compiling\|compiled]], that is, built afresh from the [[source code]]. In the source code, blocks of code that will be enabled by a compile-time option are separated into "#IFDEF <option> / #ENDIF" blocks; if <option> is disabled, the code in the block will not be compiled into the binary executable file. Most of these can be selected in [[config.h]], in particular, at the end of this file, or on a UNIX system, in a hints file.

	The compile-time options listed below are those that visibly affect the end-user experience. In modern ''NetHack'', most compile-time options govern back-end features (such as compression of bones and save files) that do not have a visible effect on the game. Historically, NetHack had a large number of compile-time options that added or removed entire game features, such as [[foocubi]], [[Tourist]]s, or (going farther back) the whole [[spellcasting]] system. This was done for two reasons: to provide users a way to test and potentially opt out of then-new features, and to allow users on systems with limited memory to compile a smaller executable file. The second reason may sound strange to a modern audience, but NetHack, being originally built for UNIX systems, did not fit into the base 640-kilobyte memory of an [[MS-DOS]] machine by version [[3.0.0]].		The compile-time options listed below are those that visibly affect the end-user experience. In modern ''NetHack'', most compile-time options govern back-end features (such as compression of bones and save files) that do not have a visible effect on the game. Historically, NetHack had a large number of compile-time options that added or removed entire game features, such as [[foocubi]], [[Tourist]]s, or (going farther back) the whole [[spellcasting]] system. This was done for two reasons: to provide users a way to test and potentially opt out of then-new features, and to allow users on systems with limited memory to compile a smaller executable file. The second reason may sound strange to a modern audience, but NetHack, being originally built for UNIX systems, did not fit into the base 640-kilobyte memory of an [[MS-DOS]] machine by version [[3.0.0]].

@@ Line 3: / Line 3: @@
 The compile-time options listed below are those that visibly affect the end-user experience. In modern ''NetHack'', most compile-time options govern back-end features (such as compression of bones and save files) that do not have a visible effect on the game.  Historically, NetHack had a large number of compile-time options that added or removed entire game features, such as [[foocubi]], [[Tourist]]s, or (going farther back) the whole [[spellcasting]] system.  This was done for two reasons: to provide users a way to test and potentially opt out of then-new features, and to allow users on systems with limited memory to compile a smaller executable file.  The second reason may sound strange to a modern audience, but NetHack, being originally built for UNIX systems, did not fit into the base 640-kilobyte memory of an [[MS-DOS]] machine by version [[3.0.0]].
-The number of gameplay-affecting compile-time options decreased over time, as increasing computer memories made the second reason irrelevant and the rise of [[public server]]s made a "standard" game more desirable.  By [[3.4.3]], only a few feature-affecting options remained, arguably the most significant being that [[Elbereth]] could still be compiled out of the game.  When [[3.6.0]] came out, virtually all such options were removed, with only a few minor tweaks to the game's interface remaining.
+The number of gameplay-affecting compile-time options decreased over time, as increasing computer memories made the second reason irrelevant and the rise of [[public server]]s made a "standard" game more desirable.  By [[3.4.3]], only a few feature-affecting options remained, arguably the most significant being that [[Elbereth]] could still be compiled out of the game.  By [[3.6.1]], virtually all such options were removed, with only a few minor tweaks to the game's interface remaining.
 Note that some compile-time NetHack options (particularly those that change gameplay features) change the format of the bones and save files and will render these incompatible if they are changed.

@@ Line 1: / Line 1: @@
 '''Compile-time options''' are certain features of ''NetHack'' that can be enabled or disabled when the game is [[compiling|compiled]], that is, built afresh from the [[source code]].  In the source code, blocks of code that will be enabled/disabled by compile-time options are separated into #IFDEF/#IFNDEF blocks; if the corresponding option is disabled/enabled respectively, the code will not be compiled into the binary executable file.  Most of these can be selected in [[config.h]], in particular, at the end of this file, or on a UNIX system, in a hints file.
-The compile-time options listed below are those that visibly affect the end-user experience. In modern ''NetHack'', most compile-time options govern back-end features (such as compression of bones and save files) that do not have a visible effect on the game.  Historically, NetHack had a large number of compile-time options that added or removed entire game features, such as [[foocubi]], [[Tourist]]s, or (going farther back) the whole [[spellcasting]] system.  This was done for two reasons: to provide users a way to test and potentially opt out of then-new features, and to allow users on systems with limited memory to build a smaller executable file.  The second reason may sound strange to a modern audience, but NetHack, being originally built for UNIX systems, did not fit into the base 640-kilobyte memory of an [[MS-DOS]] machine by version [[3.0.0]].
+The compile-time options listed below are those that visibly affect the end-user experience. In modern ''NetHack'', most compile-time options govern back-end features (such as compression of bones and save files) that do not have a visible effect on the game.  Historically, NetHack had a large number of compile-time options that added or removed entire game features, such as [[foocubi]], [[Tourist]]s, or (going farther back) the whole [[spellcasting]] system.  This was done for two reasons: to provide users a way to test and potentially opt out of then-new features, and to allow users on systems with limited memory to compile a smaller executable file.  The second reason may sound strange to a modern audience, but NetHack, being originally built for UNIX systems, did not fit into the base 640-kilobyte memory of an [[MS-DOS]] machine by version [[3.0.0]].
 The number of gameplay-affecting compile-time options decreased over time, as increasing computer memories made the second reason irrelevant and the rise of [[public server]]s made a "standard" game more desirable.  By [[3.4.3]], only a few feature-affecting options remained, arguably the most significant being that [[Elbereth]] could still be compiled out of the game.  When [[3.6.0]] came out, virtually all such options were removed, with only a few minor tweaks to the game's interface remaining.

@@ Line 1: / Line 1: @@
 '''Compile-time options''' are certain features of ''NetHack'' that can be enabled or disabled when the game is [[compiling|compiled]], that is, built afresh from the [[source code]].  In the source code, blocks of code that will be enabled/disabled by compile-time options are separated into #IFDEF/#IFNDEF blocks; if the corresponding option is disabled/enabled respectively, the code will not be compiled into the binary executable file.  Most of these can be selected in [[config.h]], in particular, at the end of this file, or on a UNIX system, in a hints file.
-The compile-time options listed below are those that visibly affect the end-user experience. In modern ''NetHack'', most compile-time options govern back-end features (such as compression of bones and save files) that do not have a visible effect on the game.  Historically, NetHack had a large number of compile-time options that added or removed entire game features, such as [[foocubi]], [[Tourist]]s, or (going farther back) the whole [[spellcasting]] system.  This was done for two reasons: to provide users a way to test and potentially opt out of then-new features, and to allow users on systems with limited memory to build a smaller executable file.  The second reason may sound strange to a modern audience, but NetHack, being originally built for UNIX systems, did not fit into the base 640K memory of an [[MS-DOS]] machine by version [[3.0.0]].
+The compile-time options listed below are those that visibly affect the end-user experience. In modern ''NetHack'', most compile-time options govern back-end features (such as compression of bones and save files) that do not have a visible effect on the game.  Historically, NetHack had a large number of compile-time options that added or removed entire game features, such as [[foocubi]], [[Tourist]]s, or (going farther back) the whole [[spellcasting]] system.  This was done for two reasons: to provide users a way to test and potentially opt out of then-new features, and to allow users on systems with limited memory to build a smaller executable file.  The second reason may sound strange to a modern audience, but NetHack, being originally built for UNIX systems, did not fit into the base 640-kilobyte memory of an [[MS-DOS]] machine by version [[3.0.0]].
 The number of gameplay-affecting compile-time options decreased over time, as increasing computer memories made the second reason irrelevant and the rise of [[public server]]s made a "standard" game more desirable.  By [[3.4.3]], only a few feature-affecting options remained, arguably the most significant being that [[Elbereth]] could still be compiled out of the game.  When [[3.6.0]] came out, virtually all such options were removed, with only a few minor tweaks to the game's interface remaining.

@@ Line 12: / Line 12: @@
   #define KOPS		/* Keystone Kops by Scott R. Turner */
-The above line enables the [[Keystone Kop]]s.  If it is ''commented out'', then Kops no longer exist in the game, and a [[shopkeeper]] who is robbed will have to fend for himself:
+The above line enables the [[Keystone Kop (monster class)|Keystone Kops]].  If it is ''commented out'', then Kops no longer exist in the game, and a [[shopkeeper]] who is robbed will have to fend for himself:
   /*#define KOPS*/		/* Keystone Kops by Scott R. Turner */

@@ Line 1: / Line 1: @@
-'''Compile-time options''' are certain features of NetHack that can be enabled or disabled when the game is [[compiling|compiled]], that is, built afresh from the [[source code]].  Most of these can be selected in [[config.h]], in particular, at the end of this file.
+'''Compile-time options''' are certain features of NetHack that can be enabled or disabled when the game is [[compiling|compiled]], that is, built afresh from the [[source code]].  Most of these can be selected in [[config.h]], in particular, at the end of this file, or on a UNIX, in a hints file.
 This article is principally about those compile-time options that affect gameplay by adding or removing certain features of the game. Some features, such as compression of bones and save files, are enabled by similar means to the options described here, but do not have a highly visible effect on the user's experience.
@@ Line 7: / Line 7: @@
 ==Enabling or disabling options==
 The options are mainly controlled by certain lines in [[config.h]], which may look like this one:
@@ Line 19: / Line 20: @@
   //#define KOPS		/* Keystone Kops by Scott R. Turner */
-==Some options==
+===In a hints file===
 ===SINKS===

@@ Line 3: / Line 3: @@
 This article is principally about those compile-time options that affect gameplay by adding or removing certain features of the game. Some features, such as compression of bones and save files, are enabled by similar means to the options described here, but do not have a highly visible effect on the user's experience.
-Many compile-time options change the format of the bones and save files, and will render these incompatible if they are changed.
+Many compile-time NetHack options change the format of the bones and save files, and will render these incompatible if they are changed.
 ==Enabling or disabling options==
@@ Line 22: / Line 22: @@
 ===SINKS===
-SINKS is enabled by default.  If it is turned off, [[sink]]s do not appear; this may make the game harder, as it is no longer possible to get a random [[ring]] or a [[foocubus|dishwasher]] by kicking a sink.
+SINKS is enabled by default in NetHack.  If it is turned off, [[sink]]s do not appear; this may make the game harder, as it is no longer possible to get a random [[ring]] or a [[foocubus|dishwasher]] by kicking a sink.
 ===WALLIFIED_MAZE===
@@ Line 43: / Line 43: @@
 ===ELBERETH===
-ELBERETH is enabled by default.  If it is turned off, engraving [[Elbereth]] does not repel monsters.  [[Crowning]] is also removed, because the lawful crowned title is the Hand of Elbereth.  There will still be engravings of Elbereth in the [[Castle]] and [[Sokoban]] levels, since level maps are defined outside the source code, but they will have no effect.
+ELBERETH is enabled by default.  If it is turned off, engraving [[Elbereth]] does not repel monsters.  [[Crowning]] is also removed, because the lawful crowned title is the Hand of Elbereth.  There will still be engravings of Elbereth in the [[Castle]] and [[Sokoban]] levels, since level maps are defined outside the NetHack source code, but they will have no effect.
 ===REDO===
@@ Line 58: / Line 58: @@
 ===AUTOPICKUP_EXCEPTIONS===
-[[autopickup_exception|AUTOPICKUP_EXCEPTIONS]] is '''not''' enabled by default in the source code, though at least the official Linux binary includes it.  If enabled, it is possible to specify, through [[option]]s, certain objects that will or will not be automatically picked up in spite of the autopickup setting for their object type; using AUTOPICKUP_EXCEPTIONS, one can for instance specify that [[food ration]]s are to be automatically picked up and [[cockatrice]] corpses are not. Without AUTOPICKUP_EXCEPTIONS, this distinction is not possible:  either all food items are automatically picked up (by specifying % in ''[[options#pickup_types|pickup_types]]'') or none are.
+[[autopickup_exception|AUTOPICKUP_EXCEPTIONS]] is '''not''' enabled by default in the NetHack source code, though at least the official Linux binary includes it.  If enabled, it is possible to specify, through [[option]]s, certain objects that will or will not be automatically picked up in spite of the autopickup setting for their object type; using AUTOPICKUP_EXCEPTIONS, one can for instance specify that [[food ration]]s are to be automatically picked up and [[cockatrice]] corpses are not. Without AUTOPICKUP_EXCEPTIONS, this distinction is not possible:  either all food items are automatically picked up (by specifying % in ''[[options#pickup_types|pickup_types]]'') or none are.
 ===SHELL===

← Older revision		Revision as of 14:44, 21 November 2010
Line 63:		Line 63:
	This can be found in [[unixconf.h]]. By default this is on, and it allows the user to [[shell escape\|escape to the command-line shell]] with {{kbd\|!}}; Disabling this is a good idea on [[public server]]s.		This can be found in [[unixconf.h]]. By default this is on, and it allows the user to [[shell escape\|escape to the command-line shell]] with {{kbd\|!}}; Disabling this is a good idea on [[public server]]s.
	[[Category:Development]]		[[Category:Development]]
		+	{{Nethack-343}}