Difference between revisions of "Manual:config.lua"
From DoomRL Wiki
Game Hunter (Talk | contribs) (testing) |
Revision as of 20:27, 6 August 2011
This file combines all configuration files into a single package. It does this using the 'dofile' function:
- dofile "colors.lua"
- dofile "music.lua"
- dofile "sound.lua"
- dofile "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:
| Setting | Type/Range | Default | Description |
|---|---|---|---|
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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.) |
| 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. |
| 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. |
| 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. |
| 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). |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
| 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 Date and time formatting characters for more information. |
