Modding:Module - Revision history

Epyon at 12:22, 11 August 2025

2025-08-11T12:22:36Z

Simon-v: /* Metadata */ typo

2012-01-31T11:51:07Z

‎Metadata: typo

Simon-v: /* Metadata */ Episodic module format is now allowed

2012-01-31T11:49:40Z

‎Metadata: Episodic module format is now allowed

Game Hunter: /* Engine Hooks */ quick syntax fix and some links

2012-01-24T20:48:29Z

‎Engine Hooks: quick syntax fix and some links

Game Hunter: /* Engine Hooks */ added descriptions

2012-01-24T20:30:12Z

‎Engine Hooks: added descriptions

Show changes

Game Hunter: added engine hooks for each module hook type (descriptions on the way)

2012-01-24T19:16:58Z

added engine hooks for each module hook type (descriptions on the way)

Game Hunter: removed 0994 warning

2011-09-05T01:51:09Z

removed 0994 warning

Game Hunter: stupid case-sensitive typo

2011-09-04T02:25:30Z

stupid case-sensitive typo

Game Hunter: linked color escapes

2011-09-04T02:22:55Z

linked color escapes

Tehtmi at 11:58, 14 August 2011

2011-08-14T11:58:51Z

@@ Line 1: / Line 1: @@
-A module is the DoomRL name for a mod. A module must contain a module.lua metadata file and a main.lua source file. It may also contain sounds, music, and ASCII art.
+A module is the DRL name for a mod. A module must contain a module.lua metadata file and a main.lua source file. It may also contain sounds, music, and ASCII art.
-Modules can be either compiled or raw. Generally, modders distribute compiled modules. Compiled modules are files with the .wad extension. A .wad file contains all the information needed to run a module including sounds and music. A raw module is a folder with the .module extension. A raw module's folder contains all the files separately. Modders will typically have their own mod in raw format while they are developing it. A raw module can be compiled into a .wad file. In either case, modules should reside in the modules subdirectory of the main DoomRL folder.
+Modules can be either compiled or raw. Generally, modders distribute compiled modules. Compiled modules are files with the .wad extension. A .wad file contains all the information needed to run a module including sounds and music. A raw module is a folder with the .module extension. A raw module's folder contains all the files separately. Modders will typically have their own mod in raw format while they are developing it. A raw module can be compiled into a .wad file. In either case, modules should reside in the modules subdirectory of the main DRL folder.
 == Metadata ==
@@ Line 11: / Line 11: @@
 |-
 |style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''string''' id
-|This is the name DoomRL internally use for the module. It should not be changed from version to version. The folder of a raw module must be named as the module's id with the ".module" extension. The .wad file of a compiled module must be named as the module's id with the ".wad" extension. By convention, only lowercase letters, numbers, and the underscore are used in a module's id.
+|This is the name DRL internally use for the module. It should not be changed from version to version. The folder of a raw module must be named as the module's id with the ".module" extension. The .wad file of a compiled module must be named as the module's id with the ".wad" extension. By convention, only lowercase letters, numbers, and the underscore are used in a module's id.
 |-style="background: #333;"
 |style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''string''' name
@@ Line 23: / Line 23: @@
 |-
 |style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''integer list''' version
-|This is the module's version number. The mod's version number should be updated whenever a new version is release, as future versions of DoomRL will use this to determine whether local mods are synced with the mod server. The format for a version is e.g. {1,0,0}.
+|This is the module's version number. The mod's version number should be updated whenever a new version is release, as future versions of DRL will use this to determine whether local mods are synced with the mod server. The format for a version is e.g. {1,0,0}.
 |-style="background: #333;"
 |style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''integer list''' drlver
-|This is the version of DoomRL that the module was designed to run with. For modules developed for 0.9.9.4, this will be {0,9,9,4}.
+|This is the version of DRL that the module was designed to run with. For modules developed for 0.9.9.4, this will be {0,9,9,4}.
 |-
 |style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''string''' type
@@ Line 180: / Line 180: @@
 {{Anchor|global_OnLogo}}
 ;OnLogo()
-:Called immediately after the module is loaded, but before the menu is created. In the base game this is used to create the DooM title graphic.
+:Called immediately after the module is loaded, but before the menu is created. In the base game this is used to create the title graphic.
 ----
 {{Anchor|global_OnCreatePlayer}}
@@ Line 227: / Line 227: @@
 == Data Files ==
-Sound files used by a module must be included in a subdirectory called ''sound'' of the main module folder. These files are automatically loaded when the module is run even if they aren't referenced by DoomRL's config file. Their lua string ids correspond to their file names (without the file type extension). Sounds can only have a .wav extension.
+Sound files used by a module must be included in a subdirectory called ''sound'' of the main module folder. These files are automatically loaded when the module is run even if they aren't referenced by DRL's config file. Their lua string ids correspond to their file names (without the file type extension). Sounds can only have a .wav extension.
 Music files are handled analogously to sound files; they should be put in a directory called ''music''. Music can have a .mid, .mp3, or .ogg extension.
-ASCII art should be contained in a directory called ''ascii''. ASCII art files are text files that use [[Modding:Constants#Colors|valkyrie color escapes]] for coloring. By convention these files have the .asc extension. The name of an ASCII art file should be the same as the corresponding being's string id (or for custom player armor art, the same as the armor's string id). Currently, DoomRL only loads ASCII art from compiled modules.
+ASCII art should be contained in a directory called ''ascii''. ASCII art files are text files that use [[Modding:Constants#Colors|valkyrie color escapes]] for coloring. By convention these files have the .asc extension. The name of an ASCII art file should be the same as the corresponding being's string id (or for custom player armor art, the same as the armor's string id). Currently, DRL only loads ASCII art from compiled modules.

@@ Line 29: / Line 29: @@
 |-
 |style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''string''' type
-|Thus is the type of the module. Can currently be "single" or "episode".
+|This is the type of the module. Can currently be "single" or "episode".
 |-style="background: #333;"
 |style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''string''' description

@@ Line 29: / Line 29: @@
 |-
 |style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''string''' type
-|Currently, this must be "single", as no other types are supported yet.
+|Thus is the type of the module. Can currently be "single" or "episode".
 |-style="background: #333;"
 |style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''string''' description

@@ Line 78: / Line 78: @@
 {{Anchor|chained_OnDieCheck}}
 ;OnDieCheck() &rarr; '''boolean'''
-:Called whenever any being's HP is reduced to zero on the map, before being:kill() is called.
+:Called whenever any being's HP is reduced to zero on the map, before [[Modding:Being|being:kill()]] is called.
 ----
 {{Anchor|chained_OnKillAll}}
@@ Line 212: / Line 212: @@
 {{Anchor|global_OnWinGame}}
 ;OnWinGame()
-:Called whenever the player wins the game. Simply, this is called using the player:win() function.
+:Called whenever the player wins the game. Simply, this is called using the [[Modding:Player|player:win()]] function.
 ----
 {{Anchor|global_OnMortem}}
@@ Line 220: / Line 220: @@
 {{Anchor|global_OnMortem}}
 ;OnMortemPrint()
-:Called alongside mortem printing. This is where all player:print_mortem() functions should be used.
+:Called alongside mortem printing. This is where all [[Modding:Player|player:mortem_print()]] functions should be used.
 ----
 {{Anchor|global_OnMortem}}

@@ Line 39: / Line 39: @@
 == Main ==
-Every module must also have a main.lua file directly in the module folder. This file will be loaded after the module is selected from the Custom Game menu. It must declare a global table (via [[core.declare]]) with the same name as the module's id. This table contains various functions that determine how the module works. For single-type modules, the available hooks are precisely the [[Modding:Level|Level]] hooks, with a new function called ''run'' used to handle initial set up.
+=== Engine Hooks ===
-== Data Files ==
+*'''Chained''' hooks are defined across the various underpinnings of the game. By order of lowest to highest priority are: ''module'' hooks, which are written for a given "game"; challenge hooks, which are written for a particular challenge; and ''core'' hooks, which take place across all modules. In addition to the normal priorities, chained hooks defined at the module level (at least) always override object-specific hooks when applicable.
 Sound files used by a module must be included in a subdirectory called ''sound'' of the main module folder. These files are automatically loaded when the module is run even if they aren't referenced by DoomRL's config file. Their lua string ids correspond to their file names (without the file type extension). Sounds can only have a .wav extension.

← Older revision		Revision as of 01:51, 5 September 2011
Line 1:		Line 1:
−	~~{{994 modding}}~~
−
	A module is the DoomRL name for a mod. A module must contain a module.lua metadata file and a main.lua source file. It may also contain sounds, music, and ASCII art.		A module is the DoomRL name for a mod. A module must contain a module.lua metadata file and a main.lua source file. It may also contain sounds, music, and ASCII art.

← Older revision		Revision as of 02:25, 4 September 2011
Line 50:		Line 50:
	Music files are handled analogously to sound files; they should be put in a directory called ''music''. Music can have a .mid, .mp3, or .ogg extension.		Music files are handled analogously to sound files; they should be put in a directory called ''music''. Music can have a .mid, .mp3, or .ogg extension.

−	ASCII art should be contained in a directory called ''ascii''. ASCII art files are text files that use [[Modding:Constants#~~colors~~\|valkyrie color escapes]] for coloring. By convention these files have the .asc extension. The name of an ASCII art file should be the same as the corresponding being's string id (or for custom player armor art, the same as the armor's string id). Currently, DoomRL only loads ASCII art from compiled modules.	+	ASCII art should be contained in a directory called ''ascii''. ASCII art files are text files that use [[Modding:Constants#Colors\|valkyrie color escapes]] for coloring. By convention these files have the .asc extension. The name of an ASCII art file should be the same as the corresponding being's string id (or for custom player armor art, the same as the armor's string id). Currently, DoomRL only loads ASCII art from compiled modules.

← Older revision		Revision as of 02:22, 4 September 2011
Line 50:		Line 50:
	Music files are handled analogously to sound files; they should be put in a directory called ''music''. Music can have a .mid, .mp3, or .ogg extension.		Music files are handled analogously to sound files; they should be put in a directory called ''music''. Music can have a .mid, .mp3, or .ogg extension.

−	ASCII art should be contained in a directory called ''ascii''. ASCII art files are text files that use [[valkyrie color escapes]] for coloring. By convention these files have the .asc extension. The name of an ASCII art file should be the same as the corresponding being's string id (or for custom player armor art, the same as the armor's string id). Currently, DoomRL only loads ASCII art from compiled modules.	+	ASCII art should be contained in a directory called ''ascii''. ASCII art files are text files that use [[Modding:Constants#colors\|valkyrie color escapes]] for coloring. By convention these files have the .asc extension. The name of an ASCII art file should be the same as the corresponding being's string id (or for custom player armor art, the same as the armor's string id). Currently, DoomRL only loads ASCII art from compiled modules.

← Older revision		Revision as of 11:58, 14 August 2011
Line 1:		Line 1:
−	~~Note: This page is related to DoomRL 0.9.9.4~~ modding. For information on 0.9.9.3 modding, check out the [http://old-wiki.chaosforge.org/wiki/index.php?title=Sandbox old wiki]. Keep in mind that, as 0.9.9.4 is as-of-yet unreleased, this information is subject to change.	+	{{994 modding}}

	A module is the DoomRL name for a mod. A module must contain a module.lua metadata file and a main.lua source file. It may also contain sounds, music, and ASCII art.		A module is the DoomRL name for a mod. A module must contain a module.lua metadata file and a main.lua source file. It may also contain sounds, music, and ASCII art.