DeHackEd / BEX Reference - Revision history

Printz at 18:56, 22 August 2025

2025-08-22T18:56:12Z

← Older revision		Revision as of 14:56, 22 August 2025
Line 29:		Line 29:

	However, none of this information is needed or used by Eternity in any way, and it is discarded as unrecognized text. You do not need to include any header information in your own files. Note that the patch version information is important for old patches in that it will tell you whether or not Eternity can use the file. Patches of format other than 6 are not guaranteed to work, and Eternity does NOT support the older, obsolete binary patch format.		However, none of this information is needed or used by Eternity in any way, and it is discarded as unrecognized text. You do not need to include any header information in your own files. Note that the patch version information is important for old patches in that it will tell you whether or not Eternity can use the file. Patches of format other than 6 are not guaranteed to work, and Eternity does NOT support the older, obsolete binary patch format.

			===DSDHacked extensible definitions===
			By setting <code>Doom version = 2021</code>, you enable [https://doomwiki.org/wiki/DSDHacked DSDHacked] mode, which allows you to define items (e.g. things, frames) even outside the valid range, without being limited to the values with provided <code>dehackednum</code> in [[EDF]].

	==BEX Extension: INCLUDE Directive==		==BEX Extension: INCLUDE Directive==

Printz at 16:13, 27 November 2021

2021-11-27T16:13:07Z

← Older revision		Revision as of 12:13, 27 November 2021
Line 7:		Line 7:
	DeHackEd does NOT support the addition or deletion of any of these elements, however. It is limited to the number and order of entries as they exist in the source port. For information on how Eternity addresses this problem via the EDF system, see the [[EDF]] Documentation.		DeHackEd does NOT support the addition or deletion of any of these elements, however. It is limited to the number and order of entries as they exist in the source port. For information on how Eternity addresses this problem via the EDF system, see the [[EDF]] Documentation.

	~~NOTE~~: DeHackEd lumps are always loaded after EDF has been fully loaded.		NOTES:
			* DeHackEd lumps are always loaded after EDF has been fully loaded.
			* Heretic HHE patches are ''not'' supported and will not be. Make sure to provide equivalent [[EMAPINFO]] (or [[UMAPINFO]]) and EDF equivalents for whatever HHE patching you want in your mod.

	{{backto\|Eternity Engine}}		{{backto\|Eternity Engine}}
	{{editref}}		{{editref}}

Printz at 14:29, 25 April 2020

2020-04-25T14:29:18Z

← Older revision		Revision as of 10:29, 25 April 2020
Line 10:		Line 10:
	{{backto\|Eternity Engine}}		{{backto\|Eternity Engine}}
	{{editref}}		{{editref}}
	=General Syntax=		==General Syntax==
	White-space, empty lines, and unrecognized tokens are ignored outside of any block, and the DeHackEd parser is in general very forgiving.		White-space, empty lines, and unrecognized tokens are ignored outside of any block, and the DeHackEd parser is in general very forgiving.

Line 27:		Line 27:
	However, none of this information is needed or used by Eternity in any way, and it is discarded as unrecognized text. You do not need to include any header information in your own files. Note that the patch version information is important for old patches in that it will tell you whether or not Eternity can use the file. Patches of format other than 6 are not guaranteed to work, and Eternity does NOT support the older, obsolete binary patch format.		However, none of this information is needed or used by Eternity in any way, and it is discarded as unrecognized text. You do not need to include any header information in your own files. Note that the patch version information is important for old patches in that it will tell you whether or not Eternity can use the file. Patches of format other than 6 are not guaranteed to work, and Eternity does NOT support the older, obsolete binary patch format.

	=BEX Extension: INCLUDE Directive=		==BEX Extension: INCLUDE Directive==
	To include a DEH or BEX file in another one, put one or more of the following lines in your BEX file:		To include a DEH or BEX file in another one, put one or more of the following lines in your BEX file:
	INCLUDE filename		INCLUDE filename
Line 37:		Line 37:
	You may not nest include files (one include file can't include another). In addition, DEHACKED lumps in wads cannot use INCLUDE directives in any form.		You may not nest include files (one include file can't include another). In addition, DEHACKED lumps in wads cannot use INCLUDE directives in any form.

	=Thing Block=		==Thing Block==
	{{See\|DeHackEd / BEX Reference/Thing Block}}		{{See\|DeHackEd / BEX Reference/Thing Block}}

	=Frame Block=		==Frame Block==
	{{see\|DeHackEd / BEX Reference/Frame Block}}		{{see\|DeHackEd / BEX Reference/Frame Block}}

	=Sound Block=		==Sound Block==
	{{see\|DeHackEd / BEX Reference/Sound Block}}		{{see\|DeHackEd / BEX Reference/Sound Block}}

	=Ammo Block=		==Ammo Block==
	{{see\|DeHackEd / BEX Reference/Ammo Block}}		{{see\|DeHackEd / BEX Reference/Ammo Block}}

	=Weapon Block=		==Weapon Block==
	{{see\|DeHackEd / BEX Reference/Weapon Block}}		{{see\|DeHackEd / BEX Reference/Weapon Block}}

	=Cheat Block=		==Cheat Block==
	{{see\|DeHackEd / BEX Reference/Cheat Block}}		{{see\|DeHackEd / BEX Reference/Cheat Block}}

	=Misc Block=		==Misc Block==
	{{See\|DeHackEd / BEX Reference/Misc Block}}		{{See\|DeHackEd / BEX Reference/Misc Block}}

	=BEX Extension: [STRINGS] Block=		==BEX Extension: [STRINGS] Block==
	{{see\|DeHackEd / BEX Reference/BEX Extension: STRINGS Block}}		{{see\|DeHackEd / BEX Reference/BEX Extension: STRINGS Block}}

	=BEX Extension: [PARS] Block=		==BEX Extension: [PARS] Block==
	{{see\|DeHackEd / BEX Reference/BEX Extension: PARS Block}}		{{see\|DeHackEd / BEX Reference/BEX Extension: PARS Block}}

	=BEX Extension: [CODEPTR] Block=		==BEX Extension: [CODEPTR] Block==
	{{see\|DeHackEd / BEX Reference/BEX Extension: CODEPTR Block}}		{{see\|DeHackEd / BEX Reference/BEX Extension: CODEPTR Block}}

	=Eternity Extension: [HELPER] Block=		==Eternity Extension: [HELPER] Block==
	{{See\|DeHackEd / BEX Reference/Eternity Extension: HELPER Block}}		{{See\|DeHackEd / BEX Reference/Eternity Extension: HELPER Block}}

	=Eternity Extension: [SPRITES] Block=		==Eternity Extension: [SPRITES] Block==
	{{see\|DeHackEd / BEX Reference/Eternity Extension: SPRITES Block}}		{{see\|DeHackEd / BEX Reference/Eternity Extension: SPRITES Block}}

	=Eternity Extension: [SOUNDS] Block=		==Eternity Extension: [SOUNDS] Block==
	{{see\|DeHackEd / BEX Reference/Eternity Extension: SOUNDS Block}}		{{see\|DeHackEd / BEX Reference/Eternity Extension: SOUNDS Block}}

	=Eternity Extension: [MUSIC] Block=		==Eternity Extension: [MUSIC] Block==
	{{See\|DeHackEd / BEX Reference/Eternity Extension: MUSIC Block}}		{{See\|DeHackEd / BEX Reference/Eternity Extension: MUSIC Block}}

	=BEX String Mnemonics Table=		==BEX String Mnemonics Table==
	{{see\|DeHackEd / BEX Reference/BEX String Mnemonics Table}}		{{see\|DeHackEd / BEX Reference/BEX String Mnemonics Table}}

	=Sound Table=		==Sound Table==
	{{see\|DeHackEd / BEX Reference/Sound Table}}		{{see\|DeHackEd / BEX Reference/Sound Table}}
	[[category:dehacked]]		[[category:dehacked]]

Printz at 05:48, 30 March 2020

2020-03-30T05:48:59Z

← Older revision		Revision as of 01:48, 30 March 2020
Line 5:		Line 5:
	DeHackEd allows editing of things, frames, codepointers, ammo and weapon data, cheats, miscellaneous settings, and text strings. Through BEX and Eternity extensions, support has also been added for a cleaner form of text substitution, default level par times, a more powerful method of codepointer editing, helper thing type editing, and better support for substitution of sprite, sound, and music names.		DeHackEd allows editing of things, frames, codepointers, ammo and weapon data, cheats, miscellaneous settings, and text strings. Through BEX and Eternity extensions, support has also been added for a cleaner form of text substitution, default level par times, a more powerful method of codepointer editing, helper thing type editing, and better support for substitution of sprite, sound, and music names.

	DeHackEd does NOT support the addition or deletion of any of these elements, however. It is limited to the number and order of entries as they exist in the source port. For information on how Eternity addresses this problem via the EDF system, see the EDF Documentation.		DeHackEd does NOT support the addition or deletion of any of these elements, however. It is limited to the number and order of entries as they exist in the source port. For information on how Eternity addresses this problem via the EDF system, see the [[EDF]] Documentation.

			NOTE: DeHackEd lumps are always loaded after EDF has been fully loaded.
	{{backto\|Eternity Engine}}		{{backto\|Eternity Engine}}
	{{editref}}		{{editref}}

Printz at 05:45, 30 March 2020

2020-03-30T05:45:49Z

← Older revision		Revision as of 01:45, 30 March 2020
Line 1:		Line 1:
	DeHackEd with BOOM Extensions (BEX) is a form of text script for modifying various aspects of the DOOM engine. Originally, DeHackEd patches were used by the DeHackEd program to modify the DOOM.EXE file itself. Now, modern source ports provide alternative methods of use.		DeHackEd with BOOM Extensions (BEX) is a form of text script for modifying various aspects of the DOOM engine. Originally, DeHackEd patches were used by the DeHackEd program to modify the DOOM.EXE file itself. Now, modern source ports provide alternative methods of use.

	Eternity allows use of DeHackEd files via the -deh command-line parameter, via GFS files, and as a text lump called "DEHACKED" in wad files. Eternity can also specify up to two DeHackEd patches which are always added at start-up in its configuration file. Starting with Eternity Engine v3.31 public beta 5, DeHackEd/BEX files can also be included by EDF modules.		Eternity allows use of DeHackEd files via the -deh or -bex command-line parameter, via GFS files, and as a text lump called "DEHACKED" in wad files. Eternity can also specify up to two DeHackEd patches which are always added at start-up in its configuration file. Starting with Eternity Engine v3.31 public beta 5, DeHackEd/BEX files can also be included by EDF modules.

	DeHackEd allows editing of things, frames, codepointers, ammo and weapon data, cheats, miscellaneous settings, and text strings. Through BEX and Eternity extensions, support has also been added for a cleaner form of text substitution, default level par times, a more powerful method of codepointer editing, helper thing type editing, and better support for substitution of sprite, sound, and music names.		DeHackEd allows editing of things, frames, codepointers, ammo and weapon data, cheats, miscellaneous settings, and text strings. Through BEX and Eternity extensions, support has also been added for a cleaner form of text substitution, default level par times, a more powerful method of codepointer editing, helper thing type editing, and better support for substitution of sprite, sound, and music names.

Printz: /* General Syntax */

2019-10-26T10:12:11Z

General Syntax

← Older revision		Revision as of 06:12, 26 October 2019
Line 12:		Line 12:

	Comments can be provided for your own benefit, or for that of other editors. Comments start with a pound sign (#) and extend to the end of the line. Example:		Comments can be provided for your own benefit, or for that of other editors. Comments start with a pound sign (#) and extend to the end of the line. Example:
	# This is a comment		# This is a comment
	Note that comments are not allowed within some blocks, including several of the BEX extension blocks. It is best to keep all comments outside of blocks for this reason.		Note that comments are not allowed within some blocks, including several of the BEX extension blocks. It is best to keep all comments outside of blocks for this reason.

	It is common for this header to appear in DeHackEd files which pre-date the DOOM source release:		It is common for this header to appear in DeHackEd files which pre-date the DOOM source release:
	Patch File for DeHackEd v3.0		Patch File for DeHackEd v3.0

	# Note: Use the pound sign ('#') to start comment lines.		# Note: Use the pound sign ('#') to start comment lines.

	Doom version = 21		Doom version = 21
	Patch format = 6		Patch format = 6

	However, none of this information is needed or used by Eternity in any way, and it is discarded as unrecognized text. You do not need to include any header information in your own files. Note that the patch version information is important for old patches in that it will tell you whether or not Eternity can use the file. Patches of format other than 6 are not guaranteed to work, and Eternity does NOT support the older, obsolete binary patch format.		However, none of this information is needed or used by Eternity in any way, and it is discarded as unrecognized text. You do not need to include any header information in your own files. Note that the patch version information is important for old patches in that it will tell you whether or not Eternity can use the file. Patches of format other than 6 are not guaranteed to work, and Eternity does NOT support the older, obsolete binary patch format.

Printz: /* General Syntax */

2019-10-26T10:01:01Z

General Syntax

← Older revision		Revision as of 06:01, 26 October 2019
Line 17:		Line 17:
	It is common for this header to appear in DeHackEd files which pre-date the DOOM source release:		It is common for this header to appear in DeHackEd files which pre-date the DOOM source release:
	Patch File for DeHackEd v3.0		Patch File for DeHackEd v3.0

	# Note: Use the pound sign ('#') to start comment lines.		# Note: Use the pound sign ('#') to start comment lines.

	Doom version = 21		Doom version = 21
	Patch format = 6		Patch format = 6

Printz at 08:39, 9 March 2012

2012-03-09T08:39:05Z

← Older revision		Revision as of 04:39, 9 March 2012
Line 7:		Line 7:
	DeHackEd does NOT support the addition or deletion of any of these elements, however. It is limited to the number and order of entries as they exist in the source port. For information on how Eternity addresses this problem via the EDF system, see the EDF Documentation.		DeHackEd does NOT support the addition or deletion of any of these elements, however. It is limited to the number and order of entries as they exist in the source port. For information on how Eternity addresses this problem via the EDF system, see the EDF Documentation.
	{{backto\|Eternity Engine}}		{{backto\|Eternity Engine}}
			{{editref}}
	=General Syntax=		=General Syntax=
	White-space, empty lines, and unrecognized tokens are ignored outside of any block, and the DeHackEd parser is in general very forgiving.		White-space, empty lines, and unrecognized tokens are ignored outside of any block, and the DeHackEd parser is in general very forgiving.

Printz: /* Sound Table */

2012-03-03T18:45:13Z

Sound Table

@@ Line 81: / Line 81: @@
 =Sound Table=
-This is a current list of the default sounds defined by sounds.edf. The number by each sound is the number that is used in Thing blocks and elsewhere to call for this sound by number (also known as its sound DeHackEd number). Note: Heretic sounds have not been standardized yet and thus are not listed here. You should not attempt to use them until they have been documented.
+{{see|DeHackEd / BEX Reference/Sound Table}}
 [[category:dehacked]]

Printz: /* BEX String Mnemonics Table */

2012-03-03T18:44:09Z

BEX String Mnemonics Table

Show changes