Manual:config.lua - Revision history

Epyon at 12:04, 11 August 2025

2025-08-11T12:04:18Z

Shark20061: Added information for the options added in 0995/0996, updated a few options that changed

2012-03-06T09:52:19Z

Added information for the options added in 0995/0996, updated a few options that changed

Show changes

Game Hunter: d'oh

2011-08-10T03:12:39Z

d'oh

Game Hunter: dofile typo

2011-08-10T03:12:18Z

dofile typo

Game Hunter: fixing odds and ends

2011-08-08T16:46:30Z

fixing odds and ends

Game Hunter: testing

2011-08-06T20:27:32Z

testing

New page

This file combines all configuration files into a single package. It does this using the 'dofile' function:

*dofile "[[Manual:colors.lua|colors.lua]]"
*dofile "[[Manual:music.lua|music.lua]]"
*dofile "[[Manual:sound.lua|sound.lua]]"
*dofile "[[Manual:keybindings.lua|keybindings.lua]]"

This runs all of the config files before it. Thus, if there happens to be any redundant information (through copy-paste or other methods) then the last file run will override previous information.

The following table contains all settings within config.lua itself, sorted by the order in the configuration file:

{|
! scope="col" align="left" | Setting
! scope="col" align="left" cell-padding="1ex"| Type/Range
! scope="col" align="left" cell-padding="1ex"| Default
! scope="col" align="left" cell-padding="1ex"| Description
|-style="background:#333"
|AllowHighAscii
|boolean
|true
|Allows high-ASCII symbols (outside those normally found on a keyboard). Very few high-ASCII symbols are used. Set to false if you have unusual symbols that seem out of place.
|-
|AlwaysRandomName
|boolean
|false
|There are a handful of random names stored in DoomRL: setting this option to true will skip the name selection screen and pick one. This is equivalent to entering no name on the screen.
|-style="background:#333"
|InvMenuStyle
|string (3)
|"HYBRID"
|This specifies how the DoomRL inventory menu is handled. "CHOICE" uses arrow keys and ENTER to select items; "LETTER" uses alphabetical keys to select; "HYBRID" is the combination of "CHOICE" and "LETTER".
|-
|ColoredInventory
|boolean
|true
|Determines whether or not item labels are colored in the DoomRL inventory.
|-style="background:#333"
|AlwaysName
|string
|""
|Automatically sets player name as the one specified in this setting. Names longer than 12 character or containing the "@" symbols will cause an error. AlwaysName overrides AlwaysRandomName.
|-
|SkipIntro
|boolean
|false
|Each game of DoomRL begins with a three-screen text intro. This setting determines whether or not it is skipped.
|-style="background:#333"
|NoBloodSlides
|boolean
|false
|Each time a level is loaded, a "blood slide" effect crosses the screen. This setting determines whether or not it will appear.
|-
|NoFlashing
|boolean
|false
|Various triggers can cause the screen to flash (particularly nuclear explosions). This setting determines whether or not they appear.
|-style="background:#333"
|RunOverItems
|boolean
|false
|When moving with the "run" command, the player will stop if they step on an item. This setting determines whether or not this occurs.
|-
|GameMusic
|boolean
|true
|This setting sets all game music on or off. This is virtually equivalent to using the MusicToggle key in-game.
|-style="background:#333"
|GameSound
|boolean
|true
|This settings sets all game sounds on or off. This is virtually equivalent to using the SoundToggle key in-game.
|-
|BlindMode
|boolean
|false
|This setting allows for some additional help for people using screen readers to play DoomRL.
|-style="background:#333"
|ColorBlindMode
|boolean
|false
|This settings allows for some additional help for people who cannot easily distinguish colors.
|-
|ClearMessages
|boolean
|false
|This determines whether or not messages disappear from the screen after every player action. (Meant to be used in conjunction with BlindMode.)
|-style="background:#333"
|EmptyConfirm
|boolean
|false
|Determines if a confirmation is necessary to enter commands after attempting to fire an empty weapon. Using the space/ENTER keys are confirmations.
|-
|SoundEquipPickup
|boolean
|false
|Determines if the pickup sound is used when swapping weapons with the swap key or quickkeys.
|-style="background:#333"
|StartTrait
|integer (0-9, 255)
|0
|Determines the chosen trait when starting a new game. 0 allows you to select in-game; 255 randomizes the choice. 1=Ironman, 2=Finesse, 3=Hellrunner, 4=Tough as Nails, 5=Son of a Bitch, 6=Son of a Gun, 7=Reloader, 8=Eagle Eye, 9=Brute.
|-
|StartDifficulty
|integer (0-5, 255)
|0
|Determines the difficulty level when starting a new game. 0 allows you to select in-game; 255 randomizes the choice. 1=ITYTD, 2=HNTR, 3=HMP, 4=UV, N! doesn't work.
|-style="background:#333"
|RunDelay
|integer
|20
|Sets the delay value with moving with the "run" command (in ms). Setting to 0 provides instantaneous movement while running.
|-
|MusicVolume
|integer (0-25)
|12
|Sets the individual volume for in-game music. Setting to zero is virtually the same as having no music.
|-style="background:#333"
|SoundVolume
|integer (0-25)
|20
|Sets the individual volume for in-game sound. Setting to zero is virtually the same as having no sound.
|-
|InvFullDrop
|boolean
|false
|When your player attempts to unequip something and has no space in the inventory, this setting determines whether a the game asks if the player wants to drop the equipment or not unequip (this is done by the default setting).
|-style="background:#333"
|MessageBuffer
|integer
|100
|Determines how many message lines are held in the buffer. It couldn't hurt to add more if desired.
|-
|MessageColoring
|boolean
|true
|Determines if messages can be colored. Use a table ( Message = {} ) to specify what messages should be included and how they should be colored.
|-style="background:#333"
|MortemArchive
|boolean
|true
|A mortem.txt is saved (and replaced) each time you finish a game of DoomRL. This setting determines whether or not they are all archived in a "mortem" subfolder.
|-
|PlayerBackups
|integer
|7
|Determines how many player.wad backups are stored in the "backup" subdirectory. At most, one backup is stored on a given day.
|-style="background:#333"
|ScoreBackups
|integer
|7
|Determines how many score.wad backups are stored in the "backup" subdirectory. At most, one backup is stored on a given day.
|-
|MenuReturn
|boolean
|true
|Determines if DoomRL returns to the menu after a game is finished, or if DoomRL exits instead.
|-style="background:#333"
|Frontal
|boolean
|false
|Determines the spawning point of the player on [[Phobos Base Entry]].
|-
|MaxRun
|integer
|100
|Determines the number of times the "run" command is repeated while moving. Anything above 80 is virtually not limit on a single map.
|-style="background:#333"
|MaxWait
|integer
|20
|Determines the number of times the "run" command is repeated in conjunction with the "wait" command.
|-
|LockBreak
|boolean
|true
|Disables Ctrl-C/Ctrl-Break closing of DoomRL.
|-style="background:#333"
|LockClose
|boolean
|true
|Disables DoomRl closing by means of a console close button.
|-
|IntuitionColor
|color (see color.lua)
|RED
|Determines the color of the [[Intuition]] effect for enemies.
|-style="background:#333"
|IntuitionChar
|character
|"."
|Determines the symbol of the Intuition effect for enemies.
|-
|TimeStamp
|string
|"yyyy/mm/dd hh:nn:ss"
|Determines mortem and screenshot filename formatting. See [http://www.freepascal.org/docs-html/rtl/sysutils/formatchars.html Date and time formatting characters] for more information.
|}

@@ Line 19: / Line 19: @@
 |String (2)
 |"TILES"
-|Determines the default mode when running DoomRL.  TILES uses graphical tiles, CONSOLE uses the raw console.  Can be overrriden through the command line parameters -graphics and -console.
+|Determines the default mode when running DRL.  TILES uses graphical tiles, CONSOLE uses the raw console.  Can be overrriden through the command line parameters -graphics and -console.
 |-
 |SoundEngine
@@ Line 29: / Line 29: @@
 |boolean
 |true
-|True tells DoomRL to ask if you want to start in full screen mode each time you start it up.  False will use the value in StartFullscreen to determine if DoomRL starts in full screen mode.
+|True tells DRL to ask if you want to start in full screen mode each time you start it up.  False will use the value in StartFullscreen to determine if DRL starts in full screen mode.
 |-
 |StartFullscreen
 |boolean
 |false
-|If FullScreenQuery is set to false, this is used to determine if DoomRL will start in full screen mode or not.  True means it will start in full screen mode, false means it starts in windowed mode.  The mode can be changed at any time by pressing ALT+Enter.
+|If FullScreenQuery is set to false, this is used to determine if DRL will start in full screen mode or not.  True means it will start in full screen mode, false means it starts in windowed mode.  The mode can be changed at any time by pressing ALT+Enter.
 |-style="background:#333"
 |WindowedWidth
@@ Line 95: / Line 95: @@
 |boolean
 |false
-|There are a handful of random names stored in DoomRL: setting this option to true will skip the name selection screen and pick one. This is equivalent to entering no name on the screen.
+|There are a handful of random names stored in DRL: setting this option to true will skip the name selection screen and pick one. This is equivalent to entering no name on the screen.
 |-style="background:#333"
 |InvMenuStyle
 |string (3)
 |"HYBRID"
-|This specifies how the DoomRL inventory menu is handled. "CHOICE" uses arrow keys and ENTER to select items; "LETTER" uses alphabetical keys to select; "HYBRID" is the combination of "CHOICE" and "LETTER".
+|This specifies how the DRL inventory menu is handled. "CHOICE" uses arrow keys and ENTER to select items; "LETTER" uses alphabetical keys to select; "HYBRID" is the combination of "CHOICE" and "LETTER".
 |-
 |ColoredInventory
 |boolean
 |true
-|Determines whether or not item labels are colored in the DoomRL inventory.
+|Determines whether or not item labels are colored in the DRL inventory.
 |-style="background:#333"
 |AlwaysName
@@ Line 115: / Line 115: @@
 |boolean
 |false
-|Each game of DoomRL begins with a three-screen text intro. This setting determines whether or not it is skipped.
+|Each game of DRL begins with a three-screen text intro. This setting determines whether or not it is skipped.
 |-style="background:#333"
 |NoBloodSlides
@@ Line 150: / Line 150: @@
 |boolean
 |false
-|This setting allows for some additional help for people using screen readers to play DoomRL.
+|This setting allows for some additional help for people using screen readers to play DRL.
 |-
 |ColorBlindMode
@@ Line 225: / Line 225: @@
 |boolean
 |true
-|A mortem.txt is saved (and replaced) each time you finish a game of DoomRL. This setting determines whether or not they are all archived in a "mortem" subfolder.
+|A mortem.txt is saved (and replaced) each time you finish a game of DRL. This setting determines whether or not they are all archived in a "mortem" subfolder.
 |-style="background:#333"
 |PlayerBackups
@@ Line 240: / Line 240: @@
 |boolean
 |true
-|Determines if DoomRL returns to the menu after a game is finished, or if DoomRL exits instead.
+|Determines if DRL returns to the menu after a game is finished, or if DRL exits instead.
 |-
 |MaxRun
@@ Line 255: / Line 255: @@
 |boolean
 |true
-|Disables Ctrl-C/Ctrl-Break closing of DoomRL.
+|Disables Ctrl-C/Ctrl-Break closing of DRL.
 |-style="background:#333"
 |LockClose
 |boolean
 |true
-|Disables DoomRl closing by means of a console close button.
+|Disables DRL closing by means of a console close button.
 |-
 |IntuitionColor

@@ Line 1: / Line 1: @@
 This file combines all configuration files into a single package. It does this using the 'dofile' function:
-*dofile "[[Manual:color.lua|colors.lua]]"
+*dofile "[[Manual:color.lua|color.lua]]"
 *dofile "[[Manual:music.lua|music.lua]]"
 *dofile "[[Manual:sound.lua|sound.lua]]"

@@ Line 39: / Line 39: @@
 |string
 |""
-|Automatically sets player name as the one specified in this setting. Names longer than 12 character or containing the "@" symbols will cause an error. AlwaysName overrides AlwaysRandomName.
+|Automatically sets player name as the one specified in this setting. Names longer than 12 character or containing the "@" symbol will cause an error. AlwaysName overrides AlwaysRandomName.
 |-
 |SkipIntro
@@ Line 49: / Line 49: @@
 |boolean
 |false
-|Each time a level is loaded, a "blood slide" effect crosses the screen. This setting determines whether or not it will appear.
+|Each time a level is loaded, a "blood slide" effect crosses the screen. This setting determines whether or not it is suppressed.
 |-
 |NoFlashing
 |boolean
 |false
-|Various triggers can cause the screen to flash (particularly nuclear explosions). This setting determines whether or not they appear.
+|Various triggers can cause the screen to flash (particularly nuclear explosions). This setting determines whether or not they are suppressed.
 |-style="background:#333"
 |RunOverItems
 |boolean
 |false
-|When moving with the "run" command, the player will stop if they step on an item. This setting determines whether or not this occurs.
+|When moving with the "run" command, the player will stop if they step on an item. This setting determines whether or not this is suppressed.
 |-
 |GameMusic
 |boolean
 |true
-|This setting sets all game music on or off. This is virtually equivalent to using the MusicToggle key in-game.
+|This setting sets all game music on or off. This is virtually equivalent to using the MusicToggle key in-game. (See also MusicVolume.)
 |-style="background:#333"
 |GameSound
 |boolean
 |true
-|This settings sets all game sounds on or off. This is virtually equivalent to using the SoundToggle key in-game.
+|This settings sets all game sounds on or off. This is virtually equivalent to using the SoundToggle key in-game. (See also SoundVolume.)
 |-
 |BlindMode
@@ Line 109: / Line 109: @@
 |integer
 |20
-|Sets the delay value with moving with the "run" command (in ms). Setting to 0 provides instantaneous movement while running.
+|Sets the delay value between repetitions when moving with the "run" command (in ms). Setting to 0 provides instantaneous movement while running. (See also MaxRun and MaxWait.)
 |-
 |MusicVolume
 |integer (0-25)
 |12
-|Sets the individual volume for in-game music. Setting to zero is virtually the same as having no music.
+|Sets the individual volume for in-game music. Setting to zero is virtually the same as having no music. (See also GameMusic.)
 |-style="background:#333"
 |SoundVolume
 |integer (0-25)
 |20
-|Sets the individual volume for in-game sound. Setting to zero is virtually the same as having no sound.
+|Sets the individual volume for in-game sound. Setting to zero is virtually the same as having no sound. (See also GameSound.)
 |-
 |InvFullDrop
@@ Line 164: / Line 164: @@
 |integer
 |100
-|Determines the number of times the "run" command is repeated while moving. Anything above 80 is virtually not limit on a single map.
+|Determines the number of times the "run" command is repeated while moving. Anything above 80 is virtually no limit on a single map.
 |-style="background:#333"
 |MaxWait