Eternity Wiki - User contributions [en]

User:Afterglow

2021-03-16T22:36:41Z

Afterglow: I Am Not a Number. I Am a Free Man

DoomWiki: [[Doom Wiki:Derek MacDonald (Afterglow)|Derek MacDonald (Afterglow)]]

List of console commands and variables

2021-03-16T22:33:57Z

Afterglow: Remove "use_startmap" CVAR no longer in use

Console commands carry out a particular action when sent to the console.
:''Back to [[Console]]''
==Console commands==
Console commands are executed, they don't inherently store values to be checked.
===Flags===
Console commands have flags assigned to them, which alter their usability. They are:
*buffered: wait until all screen has rendered before running command.
*hidden: not showing when running cmdlist.
*level: only runnable during levels.
*netvar: under multiplayer, synchronizes with the other players.
*notnet: forbidden in multiplayer (unless during a demo).
*server: if under multiplayer, only triggerable by the "server" player.
===Categories===
The commands can be grouped by their purpose:
*Control: general game control.
*Core: main console stuff, such as "echo" or "delay".
*I/O: input/output setup.
*Information: purely informative commands. Can be executed any time as they don't affect the game.
*Logging: special console logging commands.
*Menu: commands that show various menus, as well as a few commands with actual effects, which depend on the current menu state, and can't be run standalone.
*Testing: gameplay testing and "cheating" commands.
===List of console commands===
{|class="wikitable sortable"
! Name
! Parameters
! Flags
! Category
! Description
|-
||'''addfile'''||''wadfilename''||buffered notnet||Control||Adds the specified wad file at run-time. Some features will not function completely as expected when WADs are loaded at run-time, so for maximum compatibility always use the command line to load files.
|-
||'''alias'''||''newcmdname'' ''command''||||Core||'''alias''' alone will list all currently defined aliases. Providing ''newcmdname'' alone will remove that alias if it exists. Providing ''newcmdname'' and a valid console ''command'' will create "newcmdname" as an alias to that command, allowing shortcuts.

In order to make an alias take parameters, use the special variable "%opt", as such:
alias "mycommand" "hu_overlay %opt"
|-
||'''animshot'''||''numframes''||||Control||Takes the given number of consecutive screenshots for the purpose of making a crude animation. Would be useful for animated GIFs or AVI movies. This command will make the game run very slow, however, and will eat up disk space quickly, so use it with care.
|-
||'''banish'''||||level notnet||Testing||If the player is autoaiming at an enemy, the enemy will be removed from the play simulation and its memory will be freed once no other objects reference it.
|-
||'''bind'''||''keyname'' ''actionname''||||I/O||Binds the specified action to the specified key. actionname is a string and should be enclosed in quotes if it contains whitespace. actionname may specify any valid action or console command. If "actionname" is not provided, the current binding status of the specified key will be displayed.
|-
||'''bindings'''||||||Information||Dumps a list of all active keybindings to the console.
|-
||'''buddha'''||||level notnet||Testing||Toggles "Buddha" mode, where you can take any amount of damage without dying.
|-
||'''c_popup'''||||||Core||Instantly removes the console from view.
|-
||'''closelog'''||||||Logging||Closes a console log opened by the '''openlog''' command. If no logging is currently occuring, this command does nothing. This command doesn't apply to files used by '''dumplog''', as they are closed immediately, so it doesn't need to be used with the '''dumplog''' command.
|-
||'''cmdlist'''||''filter''||||Core||Displays all user-visible console commands, one per line. As of Eternity Engine v3.31 Delta, this command accepts an optional ''filter'' parameter that, if provided, should consist of a single character between A and Z. The character will be used to filter the command list down to only commands beginning with that letter.
|-
||'''creator'''||||||Information||Displays the name of the creator as set in [[EMAPINFO]].
|-
||'''credits'''||||||Menu||Displays game engine / game credits.
|-
||'''cvarhelp'''||''variablename''||||Core||Outputs a list of possible values for the given variable.
|-
||'''delay'''||''amt''||||Core||Delays the running of the next console command by either 1, or if provided, by ''amt'' game tics.
|-
||'''defdmflags'''||''mode''||server||Control||Sets the deathmatch flags variable to its default settings. If no argument is provided, dmflags is set to the default for the current game type. Otherwise, the "mode" parameter indicates what game mode's defaults to set, with the following values:

*0 = Single-player mode
*1 = Cooperative mode
*2 = Deathmatch mode
*3 = Altdeath mode (deathmatch 2.0, items respawn)
*4 = Trideath mode (DM 3, barrels respawn, players drop backpacks)
|-
||'''dir'''||||||Information||Lists the contents of the current working directory to the console.
|-
||'''dumplog'''||''filename''||||Logging||Dumps the current state of the console message buffer to the specified file as ASCII text. The text will be appended to the file if it already exists, allowing multiple use of a single log file.
|-
||'''e_dumpitemeffect'''||''mnemonic''||||Information||Displays the properties of an item effect metatable.
|-
||'''e_dumpitems'''||||||Information||Lists all EDF thing type mnemonics and DeHackEd/DoomEd numbers for thing types which are collectable items. Useful in conjunction with the give command.
|-
||'''e_dumpmeta'''||''mnemonic''||||Information||Displays the properties stored in the metatable for the given thingtype.
|-
||'''e_dumpstate'''||''mnemonic''||||Information||Displays information on one EDF state definition.
|-
||'''e_dumpthings'''||||||Information||Lists all EDF thing type mnemonics along with the DeHackEd numbers and doomednums of the corresponding types.
|-
||'''e_linedef'''||''recordnum''||level||Information||Lists verbose information on an ExtraData linedef record with the given numeric record number. If no such linedef is defined or no ExtraData exists for the current map, an appropriate error message will be given.
|-
||'''e_listkeyitems'''||||||Information||Lists all key-type artifact definitions.
|-
||'''e_listlinedefs'''||||level||Information||Lists all linedef definitions from the current map's ExtraData. If no linedefs are defined or no ExtraData exists for the current map, an appropriate error message will be given.
|-
||'''e_listmapthings'''||||level||Information||Lists all mapthing definitions from the current map's [[ExtraData]]. If no mapthings are defined or no [[ExtraData]] exists for the current map, an appropriate error message will be given.
|-
||'''e_mapthing'''||''recordnum''||level||Information||Lists verbose information on an ExtraData mapthing record with the given numeric record number. If no such mapthing is defined or no ExtraData exists for the current map, an appropriate error message will be given.
|-
||'''e_playsound'''||''name''||||Testing||Plays an EDF sound.
|-
||'''e_thingtype'''||''thingtypename''||||Information||Lists verbose information on an EDF thingtype with the given mnemonic. If no such thingtype is defined, an error message will be given.
|-
||'''echo'''||''msg''||||Core||Echoes a string message to the console. As with all console strings, the string should be in quotes if it contains whitespace.
|-
||'''enable_lightning'''||||||Testing||Enables lightning sky effects in current level.
|-
||'''endgame'''||||notnet||Testing||Ends game and drops to console mode.
|-
||'''ev_mapsectorspecs'''||||level||Information||List out all the sector specials in use on the current map.
|-
||'''ev_mapspecials'''||||level||Information||Lists all linedef specials in current map.
|-
||'''exitlevel'''||||level netvar server||Testing||Exits the current level. Starting with EE v3.31 beta 1, this command will not allow an exit if the player is dead unless the comp_zombie variable is set to allow zombie exits.
|-
||'''flood'''||||||Testing||Writes 300 garbage characters to the console. Usefulness is of debate.
|-
||'''fly'''||||level notnet||Testing||Toggles flight mode, allowing you to fly like when having the [[Doom Wiki:Wings of Wrath|Wings of Wrath]].
|-
||'''frags'''||||||Information||Displays the current frag count for all players.
|-
||'''g_padprofile'''||''profilename''||||I/O||Runs a console script that can setup default bindings for a particular model/brand of gamepad. ''Profilename'' is the name of a lump, typically inside "gamepads/" in the Eternity's [[PKE]]. Example values (as currently in the base Eternity PKE) are:
*firestorm digital 3
*vanilla
*xbox360 keylook
*xbox360
|-
||'''give'''||''thingtypename'' ''num''||level notnet||Testing||Spawns 1, or "num" if provided, of the object with this EDF thing type name on the player and causes the player to collect it/them. If the requested thing type is not collectable, it will not be spawned. In addition, if a collectable item is not picked up by the player, it will be removed immediately.
|-
||'''GIVEARSENAL'''||||level notnet||Testing||Gives all weapons (as with IDFA).
|-
||'''GIVEKEYS'''||||level notnet||Testing||Gives all keys (as with IDK).
|-
||'''god'''||||level notnet||Testing||Toggles god mode (IDDQD) on or off.
|-
||'''help'''||||||Menu||Displays built-in and user-provided help screens. See the BOOM editing reference on how to provide up to 99 custom help screens.
|-
||'''i_error'''||...||||Testing||Exits Eternity with error. Prints any arguments provided as a single string when the game exits.
|-
||'''i_exitwithmessage'''||...||||Testing||Causes a non-error exit with message.
|-
||'''i_fatalerror'''||...||||Testing||Exits Eternity with error. Prints any arguments provided as a single string when the game exits.
|-
||'''i_joystick'''||''num''||||I/O||Selects the gamepad configured in ''num'', if it can be found.
|-
||'''infammo'''||||level notnet||Testing||Toggles infinite ammo (INFSHOTS) on or off.
|-
||'''kill'''||||level netvar||Testing||Causes the player to commit suiceide.
|-
||'''listactions'''||||||Information||Displays a list of all bindable actions, aside from console commands.
|-
||'''listkeys'''||||||Information||Displays a list of all bindable key names. Not all bindable key codes correspond to pressable keys, however. Most pressable keys have obvious names which correspond to those on the keyboard.
|-
||'''listskins'''||||||Information||Lists names of all available player skins.
|-
||'''listwads'''||||||Information||Lists all currently loaded WAD files.
|-
||'''map'''||''mapname''||netvar server||Control||Transfers game play to the given map. mapname may be the name of a WAD file to load, as well as the name of a map header itself.
Examples:
map E1M1
map w00t.wad
|-
||'''maxdisplaynum'''||||||Information||Displays the maximum index of the available displaynum.
|-
||'''mdk'''||||level notnet||Testing||Fires a tracer from the player that instantly kills any monster the player is targetting.
|-
||'''mdkbomb'''||||level notnet||Testing||As above, but fires 60 such tracers in a circle around the player.
|-
||'''mn_advkeys'''||||||Menu||Displays the advanced movement control customize menu.
|-
||'''mn_automap'''||||||Menu||Displays the automap options menu.
|-
||'''mn_automapkeys'''||||||Menu||Displays the automap keybindings menu.
|-
||'''mn_bindings||||||Menu||Displays the control customize menu.
|-
||'''mn_clearmenus'''||||||Menu||Deactivates any active menu and returns to the game
|-
||'''mn_compat'''||||||Menu||Displays the DOOM compatibility options menu.
|-
||'''mn_config'''||||||Menu||Displays the user configuration menu.
|-
||'''mn_consolekeys'''||||||Menu||Brings up the console keybindings menu.
|-
||'''mn_demos'''||||notnet||Menu||Displays the Demos menu
|-
||'''mn_dynamenu'''||''menuname''||||Menu||Brings up the EDF dynamic menu with the given mnemonic. If no such menu exists, an error message will appear in the console.
|-
||'''mn_endgame'''||||||Menu||Prompts the user to end the current game and return to the title screen.
|-
||'''mn_enemies'''||||||Menu||Displays enemy AI options menu.
|-
||'''mn_envkeys'''||||||Menu||Displays the environment keybindings menu.
|-
||'''mn_episode'''||''num''||notnet||Menu||Brings up the Doom difficulty selection menu. ''Num'' it the index of the episode after which to show the difficulty settings.
|-
||'''mn_gamefuncs'''||||||Menu||Brings up the game function key bindings menu.
|-
||'''mn_gset'''||||||Menu||Brings up the game settings menu.
|-
||'''mn_hepis'''||''num''||notnet||Menu||Brings up the Heretic difficulty selection menu. ''Num'' it the index of the episode after which to show the difficulty settings.
|-
||'''mn_hud'''||||||Menu||Displays the heads-up display options menu.
|-
||'''mn_joymenu'''||||||Menu||Brings up the SDL joystick configuration menu. NOTE: This command does not exist in the DOS version of Eternity.
|-
||'''mn_load'''||''slotnum''||||Menu||Loads the save game from save slot slotnum.
|-
||'''mn_loadgame'''||||||Menu||Displays the load game menu.
|-
||'''mn_loadwad'''||||notnet||Menu||Displays the wad/file options menu.
|-
||'''mn_menukeys'''||||||Menu||Brings up the menue control keybindings menu.
|-
||'''mn_menus'''||||||Menu||Brings up the menu options menu.
|-
||'''mn_mouse'''||||||Menu||Displays the mouse options menu.
|-
||'''mn_movekeys'''||||||Menu||Displays the basic movement control customize menu.
|-
||'''mn_newgame'''||||||Menu||Displays the New Game menu or takes the player to the start map, depending on their configuration.
|-
||'''mn_old_options'''||||||Menu||Displays the vanilla Doom options menu.
|-
||'''mn_old_sound'''||||||Menu||Displays the vanilla Doom sounds menu.
|-
||'''mn_options'''||||||Menu||Displays the main options menu.
|-
||'''mn_padtest'''||||||Menu||If there's an active gamepad, brings up the testing widget.
|-
||'''mn_particle'''||||||Menu||Displays the particle effects options menu.
|-
||'''mn_player'''||||||Menu||Displays the player setup menu.
|-
||'''mn_prevmenu'''||||||Menu||Returns user to the last menu they viewed, or to the game if the present menu is the highest-most in that chain.
|-
||'''mn_quit'''||||||Menu||Displays a prompt asking the user if they want to quit.
|-
||'''mn_savegame'''||||||Menu||Displays the save game menu. Will not display if not in a level.
|-
||'''mn_selectflat'''||||||Menu||Brings up the menu background customization menu.
|-
||'''mn_selectmusic'''||||||Menu||Brings up the music menu.
|-
||'''mn_selectwad'''||||||Menu||Brings up the wad selection dialog box. The selected wad cannot be loaded if the current gamemode is a shareware game. Flags: not in a netgame
|-
||'''mn_sound'''||||||Menu||Displays the sound options menu.
|-
||'''mn_status'''||||||Menu||Displays the status bar options menu.
|-
||'''mn_testfont'''||''fontname'' [''message'']||||Testing||Displays a widget to test a font.
|-
||'''mn_video'''||||||Menu||Displays the video options menu.
|-
||'''mn_weaponkeys'''||||||Menu||Displays the weapon control customize menu.
|-
||'''mn_weapons'''||||||Menu||Displays the weapons preferences menu
|-
||'''newgame'''||||notnet||Menu||Clears any active menus and starts a new game.
|-
||'''noclip'''||||level notnet||Testing||Toggles no clipping (IDCLIP) on or off.
|-
||'''nuke'''||||netvar level server||Testing||Kills all enemies on the level, and if there are no enemies, kills all friends on the level (equivalent to KILLEM).
|-
||'''openlog'''||''filename''||||Logging||Opens the specified file in append mode and begins writing any text printed to the console into the file. All console messages will be logged until either the '''closelog''' command is used, or the program closes. Note this log file is totally separate from any used with the "dumplog" command, which is simply for saving the current buffer. If a log file is already open, this command does nothing.
|-
||'''p_dumphubs'''||||||Information||Displays hub information (if hubs exist).
|-
||'''p_linespec'''||''name'' ''arg'' ''arg'' ''arg'' ''arg'' ''arg''||level notnet||Testing||Executes the named Eternity Engine parameterized line special with the given parameters. The line special is restricted to behaving as though it has been invoked without any linedef to reference, and thus certain effects such as sector special transfers will not occur even if specified by the special type or arguments.
|-
||'''p_testenvironment||''id1'' ''id2''||level||Testing||Alters player's sound zone to the one identified by ''id1'' and ''id2''.
|-
||'''pause'''||||server||Control||Pauses or unpauses the game.
|-
||'''playdemo'''||''demoname''||notnet||Control||Plays the given demo normally.
|-
||'''playerinfo'''||||||Information||Displays name information for all connected players.
|-
||'''puke'''||''script'' ''arg...''||notnet||Testing||Executes an [[ACS]] script. Neither activator thing nor trigger linedef are set.
|-
||'''r_changesky'''||''texturename'' [''index'']||||Testing||Changes sky to specified one in ''texturename''. If ''index'' is set, it uses the specified sky flat (if more than one).
|-
||'''quicksave'''||||||Control||Quicksaves a game. First time command is used, a slot must be chosen normally. Subsequent uses will overwrite the save in that slot.

NOTE: does nothing in network games or demos
|-
||'''quickload'''||||||Control||Quickloads a game from a previously chosen quicksave slot. NOTE: does nothing in network games or demos
|-
||'''quit'''||||||Control||Plays a random monster sound and exits the game normally, with no prompt.
|-
||'''quote'''||||||Core||Currently does nothing.
|-
||'''restartmap'''||||server netvar||Testing||Restarts current map.
|-
||'''resurrect'''||||level notnet||Testing||Raises dead player.
|-
||'''s_playmusic'''||''name''||||Testing||Plays the given lump as music, if that lump can be found in the music hash table. Only lumps listed in the internal music table, or new lumps with names beginning with "D_" in DOOM or "MUS_" in Heretic are available.
|-
||'''say'''||''...''||netvar||Control||Sends all arguments as a single message to all players in a network game.
|-
||'''screenshot'''||||||Control||Takes a single screenshot. Bind this command to a key in order to take a shot without the console in the way.
|-
||'''skinviewer'''||||||Menu||Brings up the skin viewer menu widget.
|-
||'''snd_selectbank||||||Menu||Brings up the ADLMidi sound bank selector menu.
|-
||'''spacejump'''||||hidden notnet||Testing||Allows the player to jump any number of times in midair; useful for testing linked portals.
|-
||'''spectate_next'''||||||Control||Switches display to next player (spy mode). Only works during non-deathmatch gameplay, or during any multiplayer demo.
|-
||'''spectate_prev'''||||||Control||Switches display to previous player (spy mode). Only works during non-deathmatch gameplay, or during any multiplayer demo.
|-
||'''starttitle'''||||notnet||Testing||Returns the game to the title screen / demo / credits loop.
|-
||'''stopdemo'''||||notnet||Control||Stops any currently playing demo and drops to console.
|-
||'''summon'''||''thingtypename'' ''flagslist'' ''mode''||hidden level notnet||Testing||Allows spawning of things via their EDF thing type name. An EDF/BEX flag list can optionally be provided, with the flags separated by commas only. By default, this will cause the listed flags to be added to the thing along with its normal flags. By specifying the third parameter as "set" or "remove", it is possible to set the thing's flags value to only the listed flags, or to remove the listed flags if the thingtype has them set by default.

Example to spawn a friendly thing:
$ summon doomimp friend
|-
||'''thunder'''||||||Testing||Forces a thunder to occur.
|-
||'''timedemo'''||''demoname'' ''showmenu''||notnet||Control||Starts the given demo as a time demo, in which the framerate of the game can be measured. If showmenu is set to 1, a meter comparing the framerate against that of a "fast" machine will be displayed after the demo is complete. Otherwise, the framerate will be printed to the console as a number.
|-
||'''togglefullscreen'''||||buffered||I/O||Toggles between fullscreen and window, by toggling between 'w' and 'f' in the current [[geom string]].
|-
||'''unbind'''||''keyname'' ''bindingclass''||||I/O||Unbinds the specified key from any action, or from only the action in the specified class if the bindingclass parameter is specified. As of Eternity Engine v3.31 Delta, keys may have one binding from each separate binding class. Binding class numbers are displayed next to action names when using the "bind keyname" command.
|-
||'''unbindall'''||||||I/O||Releases *all* dynamic keybindings. Use with caution!
|-
||'''v_dumppatch'''||''lumpname'' ''filename'' ''fillcolor''||||Testing||Dumps a patch to a file as a PNG.
|-
||'''v_fontcolors'''||''fontname'' ''filename''||||Testing||Writes the colors of ''fontname'' to a file names ''filename''.
|-
||'''vilehit'''||||level notnet||Testing||If the player is autoaiming at an enemy, the player will perform an Arch-vile attack on that enemy.
|-
||'''viles'''||||hidden level notnet||Testing||A special command for DOOM II only. Try it and see what happens :)
|-
||'''w_masterlevels'''||[''skill'']||notnet||Menu||Shows the Master Levels menu, assuming master_levels_dir is properly configured.
|-
||'''w_playnorest'''||[''skill'']||||Control||Start playing No Rest for the Living (if available).
|-
||'''w_writelump'''||''lumpname''||||Testing||Writes a lump to a file, with the name of the lump followed by .lmp, stored in the user game path.
|-
||'''warp'''||''x'' ''y''||level notnet||Testing||Teleports player to given XY coordinates.
|-
||'''whistle'''||''thingtypename''||level notnet||Testing||If there is a live, friendly thing of the given EDF type, the first such thing found on the map will be teleported in front of the player. If the thing doesn't fit where the player is trying to teleport it, it will not be teleported. It will also not be teleported across blocking lines.
|-
||'''xl_dumpemapinfo'''||''mapname''||||Information||Displays information on a single [[EMAPINFO]] (Eternity) entry by map name.
|-
||'''xl_dumpmapinfo'''||''mapname''||||Information||Displays information on a single MAPINFO (Hexen/ZDoom) entry by map name.
|-
||'''z_dumpcore'''||||hidden||Information||Write the zone heap to a file. Useful for debugging.
|-
||'''z_print'''||||hidden||Information||Prints the zone heap. Useful for development debugging.
|}

==Console constants==
These can't be changed, and when executed, show their content as information.
{|class="wikitable sortable"
! Name
! Description
|-
||'''version'''||Eternity version number (only the major and minor components, not the subversion).
|-
||'''ver_date'''||Build date.
|-
||'''ver_time'''||Build time.
|-
||'''ver_name'''||Textual name of version.
|-
||'''opt'''||
|-
||'''rngseed'''||Show the random generator seed.
|}

==Console variables==
These items store inherent values (unlike the commands) which can be queried by simply executing the variable without a new value, and can also be changed, often with side effects to the game.
{|class="wikitable sortable"
! Name
! Type
! Limits
! Description
|-
||'''mapcolor_back'''||int||0 to 255||Colour of automap background
|-
||'''mapcolor_grid'''||int||0 to 255||Colour of grid
|-
||'''mapcolor_wall'''||int||0 to 255||Colour of normal walls
|-
||'''mapcolor_fchg'''||int||0 to 255||Colour of lines with floor height change
|-
||'''mapcolor_cchg'''||int||0 to 255||Colour of lines with ceiling height change
|-
||'''mapcolor_clsd'''||int||0 to 255||Colour of closed doors or areas
|-
||'''mapcolor_rkey'''||int||0 to 255||Colour of red key objects
|-
||'''mapcolor_bkey'''||int||0 to 255||Colour of blue key objects
|-
||'''mapcolor_ykey'''||int||0 to 255||Colour of yellow key objects
|-
||'''mapcolor_rdor'''||int||0 to 255||Colour of red doors
|-
||'''mapcolor_bdor'''||int||0 to 255||Colour of blue doors
|-
||'''mapcolor_ydor'''||int||0 to 255||Colour of yellow doors
|-
||'''mapcolor_tele'''||int||0 to 255||Colour of teleport lines
|-
||'''mapcolor_secr'''||int||0 to 255||Colour of secret sector boundaries
|-
||'''mapcolor_exit'''||int||0 to 255||Colour of exit lines
|-
||'''mapcolor_unsn'''||int||0 to 255||Colour of computer map unexplored lines
|-
||'''mapcolor_flat'''||int||0 to 255||Colour of no-height-change line seen when doing iddt
|-
||'''mapcolor_sprt'''||int||0 to 255||Colour of normal map objects when doing iddt/iddt
|-
||'''mapcolor_hair'''||int||0 to 255||Colour of map pointer
|-
||'''mapcolor_sngl'''||int||0 to 255||Colour of player arrow in single player
|-
||'''mapcolor_frnd'''||int||0 to 255||Colour of friends in iddt/iddt
|-
||'''mapcolor_prtl'''||int||0 to 255||Colour of lines from other portal layers
|-
||'''mapportal_overlay'''||bool||yes/no||
|-
||'''am_drawnodelines'''||toggle||on/off||Whether to draw node lines and other internal lines, for debugging
|-
||'''am_dynasegs_bysubsec'''||toggle||yes/no||
|-
||'''c_height'''||int||20 to 200||normal height of the console in pixels
|-
||'''c_speed'''||int||1 to 200||speed at which console descends/recedes
|-
||'''d_drawfps'''||toggle||on/off||
|-
||'''d_fastrefresh'''||toggle||on/off||
|-
||'''d_interpolate'''||toggle||on/off||
|-
||'''gl_colordepth'''||int||16 to 32||
|-
||'''gl_filter_type'''||int||0 to 1 or GL_LINEAR, GL_NEAREST||
|-
||'''gl_use_extensions'''||toggle||yes/no||
|-
||'''gl_arb_pixelbuffer'''||toggle||yes/no||
|-
||'''draw_particles'''||bool||on/off||Whether to show particle effects.
|-
||'''bloodsplattype'''||int||0 to 2 or sprites, particles, both||effect for blood splats
|-
||'''bulletpufftype'''||int||0 to 2 or sprites, particles, both||effect for bullet puffs
|-
||'''rocket_trails'''||bool||on/off||whether rockets have a smoke trail
|-
||'''grenade_trails'''||bool||on/off||whether MBF grenades have a smoke trail
|-
||'''bfg_cloud'''||bool||on/off||whether BFG projectiles have a particle cloud
|-
||'''alwaysmlook'''||bool||on/off||Whether mouse movements are always interpreted as mouse-look.
|-
||'''invertmouse'''||bool||on/off||Whether vertical mouse movements are reversed.
|-
||'''invert_padlock'''||bool||on/off||
|-
||'''sens_horiz'''||float||0 to 1024||Relative horizontal sensitivity of the mouse.
|-
||'''sens_vert'''||float||0 to 1024||Relative vertical sensitivity of the mouse.
|-
||'''sens_combined'''||int||0 to 16||Also changes '''sens_horiz''' and '''sens_vert''' with this value times 4.
|-
||'''sens_vanilla'''||toggle||yes/no||
|-
||'''weapon_hotkey_cycling'''||bool||on/off||
|-
||'''turbo'''||int||10 to 400||Turbo scale factor for walking/running. Only affects current player, even in multiplayer.
|-
||'''cooldemo'''||int||0 to 2 or off, random, follow||If '''follow''' and if the level has intermission cameras, the view will move between them randomly during the demo. If '''random''', it will alternate between the "follow" mode and the chase-cam. If '''off''', demos are normal even in levels with intermission cameras.
|-
||'''shot_type'''||int||0 to 3 or bmp, pcx, tga, png||file type written when screenshots are taken
|-
||'''shot_gamma'''||bool||yes/no||whether to create gamma correct screenshots
|-
||'''textmode_startup'''||bool||on/off||If '''on''', game starts in text mode like the original DOOM. If '''off''', game starts in console mode with graphics.
|-
||'''demo_insurance'''||int||0 to 2 or off, on, "when recording"||Determines whether or not extra steps should be taken to ensure that demos will remain in sync. This should not be needed for vanilla Doom demos.
|-
||'''smooth_turning'''||bool||on/off||Whether mouse turning is smoothed by the game.
|-
||'''mouse_accel_type'''||int||0 to 3 or off, linear, choco, custom||
|-
||'''mouse_accel_threshold'''||int||0 to 1024||
|-
||'''mouse_accel_value'''||float||0 to 100||
|-
||'''mouse_novert'''||bool||on/off||
|-
||'''mouse_dblc1'''||int||-1 to 2||
|-
||'''mouse_dblc2'''||int||-1 to 2||
|-
||'''map_coords'''||bool||on/off||Whether automap coordinates follow the pointer in non-follow mode, or show the player coordinates.
|-
||'''map_secret_after'''||bool||yes/no||
|-
||'''numhelpers'''||int||0 to 3||Number of helper creatures that spawn with the player.
|-
||'''autorun'''||bool||on/off||Makes the player always run, without having to hold the shift key.
|-
||'''runiswalk'''||bool||on/off||Makes it so the shift key makes the player walk if '''autorun''' is '''on'''.
|-
||'''iwad_doom_shareware'''||string||||
|-
||'''iwad_doom'''||string||||
|-
||'''iwad_ultimate_doom'''||string||||
|-
||'''iwad_doom2'''||string||||
|-
||'''iwad_bfgdoom2'''||string||||
|-
||'''iwad_tnt'''||string||||
|-
||'''iwad_plutonia'''||string||||
|-
||'''iwad_hacx'''||string||||
|-
||'''iwad_heretic_shareware'''||string||||
|-
||'''iwad_heretic'''||string||||
|-
||'''iwad_heretic_sosr'''||string||||
|-
||'''iwad_freedoom'''||string||||
|-
||'''iwad_freedoomu'''||string||||
|-
||'''iwad_freedm'''||string||||
|-
||'''master_levels_dir||string||||Path to the Master Levels for DOOM II WADs. Must be path to the location which contains the actual WAD files. Used when starting the Master Level menu.
|-
||'''w_norestpath'''||string||||
|-
||'''use_doom_config'''||bool||yes/no||
|-
||'''i_joysticksens'''||int||0 to 32767||
|-
||'''i_forcefeedback'''||toggle||on/off||
|-
||'''i_gamespeed'''||int||0 to 500||Changes the speed of the entire game. The value is a percentage. 100 means the normal speed. Caution: setting 0 effectively freezes the game (stops time), but fortunately the console is available even then, so you can restore it to a nonzero value. This variable is useful for testing rendering interpolation.
|-
||'''v_retrace'''||bool||yes/no||Vertical synchronization. Turn it on if the display looks like tearing in the middle when changing frames. Turn it off if you experience other problems due to it.
|-
||'''i_usemouse'''||bool||yes/no||
|-
||'''i_grabmouse'''||bool||yes/no||whether the window grabs mouse input
|-
||'''i_videomode'''||string||buffered||This is a [[geom string]]. Use it to change the video mode.
|-
||'''i_resolution'''||string||buffered||Resolution of the renderer's target (WWWWxHHHH or native). Usually it's set to '''native''', which means to just use the same resolution as in '''i_videomode''', but sometimes you may want a different resolution, such as for displaying in low-detail.
|-
||'''i_videodriverid'''||int||-1 to 1 or default, "SDL Software", "SDL GL2D"||
|-
||'''i_letterbox'''||toggle||yes/no buffered||Whether to enable letterboxing when '''i_videomode''' is set to a square tower-like aspect ratio. This flag only applies for that; it does not apply for fullscreen letter/pillarboxing of 4:3 or wider aspect ratios.
|-
||'''show_scores'''||bool||on/off||Whether to show frags when you die.
|-
||'''hu_overlayid'''||int||-1 to 1 or default, "Modern HUD", "Boom HUD"||
|-
||'''hu_overlaystyle'''||int||0 to 4 or off, "boom style", flat, distributed, graphical||
|-
||'''hu_hidesecrets'''||bool||yes/no||whether to display kills/items/secrets on the HUD.
|-
||'''hu_obituaries'''||bool||on/off||whether to show obituary when player dies.
|-
||'''hu_obitcolor'''||int||0 to 9||Color of obituary message
|-
||'''hu_crosshair'''||int||0 to 2 or none, cross, angle||Shape/presence of aiming crosshairs.
|-
||'''hu_crosshair_hilite'''||toggle||on/off||Whether crosshair will highlight when player is aiming at a monster or friend
|-
||'''hu_messages'''||bool||on/off||Whether to show HUD messages.
|-
||'''hu_messagealignment'''||int||0 to 2 or default, left, centered||
|-
||'''hu_messagecolor'''||int||0 to 9||Colour of HUD messages.
|-
||'''hu_messagelines'''||int||0 to 14||Number of lines of the HUD message widget.
|-
||'''hu_messagescroll'''||bool||yes/no||Whether the widget can be scrolled to see previous messages.
|-
||'''hu_messagetime'''||int||0 to 100000||Length of time messages appear.
|-
||'''hu_showtime'''||toggle||yes/no||Whether to display level time in the automap.
|-
||'''hu_showcoords'''||toggle||yes/no||Whether to display player/pointer coordinates in the automap.
|-
||'''hu_alwaysshowcoords'''||toggle||yes/no||
|-
||'''hu_timecolor'''||int||0 to 9||Colour of the time widget
|-
||'''hu_levelnamecolor'''||int||0 to 9||Colour of the level name widget
|-
||'''hu_coordscolor'''||int||0 to 9||Colour of the coordinate widget.
|-
||'''mn_toggleisback'''||toggle||yes/no||whether the '''menu_toggle''' keybinding action goes back one menu instead of exiting.
|-
||'''mn_background'''||string||length 8||
|-
||'''wad_directory'''||string||length 1024||user's wad directory which will be listed in the wad loading dialog
|-
||'''mn_wadname'''||string||handlerset||
|-
||'''mn_start_mapname'''||string||length 9 handlerset||Exact map header name of a map at which a new game started from the menus should begin at. If invoked from the menus, this command will immediately invoke the gamemode-dependent skill selection menu when its value is set.
|-
||'''mn_demoname'''||string||length 12||
|-
||'''startlevel'''||string||length 9 handlerset||name of first level to start new games
|-
||'''mn_favaspectratio'''||int||0 to 7 or Legacy, 5:4, 4:3, 3:2, 16:10, 5:3, WSVGA, 16:9||
|-
||'''mn_favscreentype'''||int||0 to 1 or windowed, fullscreen||
|-
||'''mn_searchstr'''||string||length 32||string to search for in menus via the '''mn_search''' command
|-
||'''mn_classic_menus'''||bool||yes/no||
|-
||'''chasecam'''||bool||on/off||Whether to have a third-person camera behind you.
|-
||'''chasecam_height'''||int||-31 to 100||Preferred height of the chasecam above player's viewheight.
|-
||'''chasecam_dist'''||int||10 to 1024||Preferred distance from chasecam to player.
|-
||'''chasecam_speed'''||int||1 to 100||Percentage of distance to target chasecam moves per gametic.
|-
||'''walkcam'''||bool||on/off notnet||Whether to control a walkcam, which lets you explore the entire level as a spectator.
|-
||'''spechits_emulation'''||int||0 to 2 or off, chocodoom, prboomplus||
|-
||'''donut_emulation'''||bool||on/off||
|-
||'''p_markunknowns'''||bool||yes/no||'''yes''': location of unknown thingtypes will be marked with EDF '''Unknown''' objects. '''no''': only messages are displayed when unknown things are used in a map.
|-
||'''wipewait'''||int||0 to 2 or never, always, demos||Whether or not the screen wipe routine blocks the main game loop
|-
||'''wipetype'''||int||0 to 2 or none, melt, fade||
|-
||'''p_lastenemyroar'''||bool||on/off||
|-
||'''r_fov'''||int||20 to 179||
|-
||'''r_showrefused'''||bool||on/off||
|-
||'''gamma'''||int||0 to 4||Gamma correction level
|-
||'''lefthanded'''||bool||right/left||whether player is left handed (flips the player weapon sprites)
|-
||'''r_blockmap'''||bool||on/off||whether to rebuild blockmaps at runtime
|-
||'''r_homflash'''||bool||on/off||whether to flash the HOM indicator or keep it red.
|-
||'''r_precache'''||bool||on/off||whether to precache graphics
|-
||'''r_showgun'''||bool||yes/no||whether to draw weapon sprites
|-
||'''r_showhom'''||bool||yes/no||whether to show the flashing HOM indicator
|-
||'''r_stretchsky'''||bool||on/off||Whether to visually stretch skies when looking up.
|-
||'''r_swirl'''||bool||on/off||Whether to enable the swirling effect for all animated flats. Meant mainly for testing the effect; otherwise it's preferable to use [[EDF animations]].
|-
||'''r_trans'''||bool||on/off||whether general translucency is enabled
|-
||'''r_tranpct'''||int||0 to 100||general global translucency percentage
|-
||'''screensize'''||int||0 to 8 buffered||View frame size.
|-
||'''r_ptcltrans'''||int||0 to 2 or none, smooth, general||translucency type for particle effects — smoth is ZDoom-style smooth fading, and general is static, BOOM-style translucency as used in Eternity v3.29 Gamma and earlier.
|-
||'''r_columnengine'''||int||0 to 1 or normal, quad||
|-
||'''r_spanengine'''||int||0 or highprecision||
|-
||'''r_tlstyle'''||int||0 to 2 or none, boom, new||
|-
||'''r_boomcolormaps'''||toggle||on/off||If '''on''', causes all sectors with colormaps to apply the Boom-like logic of changing player's full colormap instead of using it locally. This is mainly for compatibility. See also '''sector-colormap''' in [[EMAPINFO]] for level-based options on how to customize this behaviour.
|-
||'''r_drawplayersprites'''||toggle||on/off||
|-
||'''displaynum'''||int||0 to number of displays||
|-
||'''snd_card'''||int||-1 to 1 or "SDL mixer", none, "PC Speaker"||type of sound driver to be used by SDL
|-
||'''mus_card'''||int||-1 to 0 or "SDL mixer", none||MIDI driver used by SDL
|-
||'''detect_voices'''||int||0 to 1 or yes, no||Unused.
|-
||'''snd_spcpreamp'''||int||1 to 6||amplification factor for SPC music
|-
||'''snd_spcbassboost'''||int||0 to 31||logarithmic bass boost scale for SPC music
|-
||'''snd_mididevice'''||int||-1 to 0 or Default, ADLMIDI||
|-
||'''snd_numchips'''||int||1 to 8||
|-
||'''snd_bank'''||int||0 to bank count||
|-
||'''snd_oplemulator'''||int||0 to 4 or "Nuked 1.8", "Nuked 1.7.4", Dosbox, Opal, Java||
|-
||'''s_lowfreq'''||float||minimum 0||
|-
||'''s_highfreq'''||float||minimum 0||
|-
||'''s_eqpreamp'''||float||0 to 1||
|-
||'''s_lowgain'''||float||0 to 3||
|-
||'''s_midgain'''||float||0 to 3||
|-
||'''s_highgain'''||float||0 to 3||
|-
||'''i_ledsoff'''||bool||yes/no||Whether to keep keyboard LEDs off regardless of lock states.
|-
||'''i_waitatexit'''||bool||yes/no||whether game will wait for input after exiting ('''yes'''), or shut down immediately ('''no''').
|-
||'''i_showendoom'''||bool||yes/no||whether to show ENDOOM on exit.
|-
||'''i_endoomdelay'''||int||35 to 3500||how long is ENDOOM shown
|-
||'''com'''||int||1 to 4||COM port to use for serial connections
|-
||'''ammo_red'''||int||0 to 100||ammo amount at which status bar numbers turn red
|-
||'''ammo_yellow'''||int||0 to 100||ammo amount at which status bar numbers turn yellow
|-
||'''health_red'''||int||0 to 200||health amount at which status bar numbers turn red
|-
||'''health_yellow'''||int||0 to 200||health amount at which status bar numbers turn yellow
|-
||'''health_green'''||int||0 to 200||health amount at which status bar numbers turn green
|-
||'''armor_red'''||int||0 to 200||armor amount at which status bar numbers turn red
|-
||'''armor_yellow'''||int||0 to 200||armor amount at which status bar numbers turn yellow
|-
||'''armor_green'''||int||0 to 200||armor amount at which status bar numbers turn green
|-
||'''armor_byclass'''||toggle||yes/no||
|-
||'''st_graypct'''||bool||yes/no||whether to keep % sign grey or to make it change colour with the numbers (if that's enabled).
|-
||'''st_rednum'''||bool||yes/no||whether status bar numbers are always red, or coloured like in Boom.
|-
||'''st_singlekey'''||bool||yes/no||Whether to show just the skull keys when both are picked, like in vanilla Doom.
|-
||'''st_fsalpha'''||int||0 to 100||
|-
||'''s_enviro_volume'''||int||0 to 16||
|-
||'''s_precache'''||bool||on/off||whether to precache sounds at the beginning of the game
|-
||'''s_pitched'''||bool||on/off||whether to have variable pitched sounds like in old Doom and new Doom re-releases.
|-
||'''snd_channels'''||int||1 to 32||number of software sound channels to maintain.
|-
||'''sfx_volume'''||int||0 to 15||base volume for digital sound effects
|-
||'''music_volume'''||int||0 to 15||base volume for MIDI synthesis
|-
||'''s_flippan'''||bool||on/off||whether to reverse stereo channels
|-
||'''s_hidefmusic'''||bool||on/off||
|-
||'''s_randmusic'''||toggle||on/off||
|-
||'''v_ticker'''||int||0 to 3 or off, chart, classic, text||FPS ticker display
|-
||'''bobbing'''||bool||on/off netvar||'''on''': players see themselves bob about like chickens. '''off''': players see themselves scoot around like robots on wheels.
|-
||'''name'''||string||length 20 netvar||Name of player.
|-
||'''dogjumping'''||bool||on/off netvar||
|-
||'''dmflags'''||int||minimum 0 netvar||deathmatch flags bitmask -- add the values below together to set individual flags; values are as follows:
* 1 (0x1): items respawn
* 2 (0x2): weapons stay
* 4 (0x4): barrels respawn
* 8 (0x8): players drop backpacks
* 16 (0x10): super powerups respawn
* 32 (0x20): instagib, any damage gibs players
* 64 (0x40): keep items when player respawns
|-
||'''colour'''||int||netvar 0 to 14 or green, indigo, brown, red, tomato, dirt, blue, gold, sea, black, purple, orange, pink, cream, white||Player's uniform color.
|-
||'''gametype'''||int||netvar 0 to 2 or single, coop, deathmatch||determines rules used for gameplay; cannot set single if more than one player is present
|-
||'''skill'''||int||netvar 0 to 4 or "im too young to die", "hey not too rough", "hurt me plenty", "ultra violence", "nightmare"||game skill level
|-
||'''allowmlook'''||bool||on/off netvar||Whether to allow looking up and down.
|-
||'''bfgtype'''||int||netvar 0 to 4 or bfg9000, "press release", bfg11k, bouncing, "plasma burst"||Choose between one of the various port-implemented BFG variants.
|-
||'''autoaim'''||bool||on/off netvar||Autoaim enabled.
|-
||'''recoil'''||bool||on/off netvar||Boom-style recoil enabled.
|-
||'''pushers'''||bool||on/off netvar||Whether objects are affected by wind and current.
|-
||'''varfriction'''||bool||on/off netvar||Whether players (and possibly monsters) experience variable friction.
|-
||'''nukage'''||bool||on/off netvar||Whether damaging sectors hurt players as normal.
|-
||'''p_pitchedflight'''||toggle||on/off netvar||Whether flying in a pitched direction follows that direction (unlike vanilla Heretic).
|-
||'''timelimit'''||int||0 to 100 netvar||Time limit for deathmatch.
|-
||'''fraglimit'''||int||0 to 100 netvar||Frag limit for deathmatch.
|-
||'''fast'''||toggle||on/off netvar||Fast monsters.
|-
||'''nomonsters'''||toggle||on/off netvar||No monsters spawned.
|-
||'''respawn'''||toggle||on/off netvar||Respawning enabled.
|-
||'''mon_remember'''||bool||on/off netvar||Monsters remember target.
|-
||'''mon_infight'''||bool||on/off netvar||Monster infighting.
|-
||'''mon_backing'''||bool||on/off netvar||Monsters backing out from melee attackers.
|-
||'''mon_avoid'''||bool||on/off netvar||Monsters avoiding hazards such as crushing ceilings.
|-
||'''mon_friction'''||bool||on/off netvar||Monsters affected by friction.
|-
||'''mon_climb'''||bool||on/off netvar||Monsters can walk steep stairs.
|-
||'''mon_helpfriends'''||bool||on/off netvar||
|-
||'''mon_distfriend'''||int||0 to 1024 netvar||Distance friends stay away.
|-
||'''skin'''||string||length 256 netvar||Player skin setting.
|-
||'''comp_*'''||bool||on/off netvar||These are the various compatibility options. See the equivalent '''comp_*''' fields from the [[OPTIONS]] lump for a full list of variables.
|}

[[category:console]]

Predefined lumps

2021-03-16T22:32:27Z

Afterglow: Remove START & STARTSCR lump refs no longer in eternity.pke

Most predefined lumps used in BOOM and MBF are still present in Eternity, although not all are used. These lumps can be found in eternity.pke and are no longer stored inside the executable, primarily for reasons of code size and compile time.
{{Backto|Editing reference}}

== New lump list ==
Menu text
---------
M_KEYBND Key Bindings entry in setup menu
M_AUTO Automap entry in setup menu
M_CHATM Chat strings entry in setup menu (Replaces M_CHAT, New to SMMU)
M_ENEM Enemies options entry in setup menu
M_STAT Status bar and Hud entry in setup menu
M_WEAP Weapons entry in setup menu
M_COLORS Palette color picker diagram
M_PALNO Xed-out symbol for unused automap features
M_BUTT1 Setup reset button off state (currently unused)
M_BUTT2 Setup reset button on state (currently unused)
M_LDSV Load/Save menu graphic (new to SMMU)
M_FEAT Features menu graphic (new to SMMU)
M_MULTI Multiplayer options menu graphic (new to SMMU)
M_ABOUT About menu graphic (new to SMMU)
M_DEMOS Demos menu graphic (new to SMMU)
M_WAD Wad loading menu graphic (new to SMMU)
M_SOUND Sound options menu graphic (new to SMMU)
M_VIDEO Video options menu graphic (new to SMMU)
M_MOUSE Mouse options menu graphic (new to SMMU)
M_HUD Heads-up options menu graphic (new to SMMU)
M_TCPIP TCP/IP connect menu graphic (new to SMMU)
M_SERIAL Serial connect menu graphic (new to SMMU)
M_PLAYER Player options menu graphic (new to SMMU)
M_COMPAT Compatibility options menu graphic (new to MBF)
M_SLIDEM Small slider gfx, middle segment (new to SMMU)
M_SLIDEL Small slider gfx, left end (new to SMMU)
M_SLIDEO Small slider gfx, caret (new to SMMU)
M_SLIDER Small slider gfx, right end (new to SMMU)
MBFTEXT Marine's Best Friend menu graphic (new to MBF, currently unused)
M_ETCOPT Eternity options menu graphic (new to Eternity)

Font chars
----------
STCFN096 ` character for standard DOOM font
STCFN123 left end of console horizontal divider bar (new to SMMU)
STCFN124 center of console horizontal divider bar (new to SMMU)
STCFN125 right end of console horizontal divider bar (new to SMMU)

STBR123 HUD font bargraph char, full, 4 vertical bars
STBR124 HUD font bargraph char, partial, 3 vertical bars
STBR125 HUD font bargraph char, partial, 2 vertical bars
STBR126 HUD font bargraph char, partial, 1 vertical bars
STBR127 HUD font bargraph char, empty, 0 vertical bars

DIG0 HUD font 0 char
DIG1 HUD font 1 char
DIG2 HUD font 2 char
DIG3 HUD font 3 char
DIG4 HUD font 4 char
DIG5 HUD font 5 char
DIG6 HUD font 6 char
DIG7 HUD font 7 char
DIG8 HUD font 8 char
DIG9 HUD font 9 char
DIGA HUD font A char
DIGB HUD font B char
DIGC HUD font C char
DIGD HUD font D char
DIGE HUD font E char
DIGF HUD font F char
DIGG HUD font G char
DIGH HUD font H char
DIGI HUD font I char
DIGJ HUD font J char
DIGK HUD font K char
DIGL HUD font L char
DIGM HUD font M char
DIGN HUD font N char
DIGO HUD font O char
DIGP HUD font P char
DIGQ HUD font Q char
DIGR HUD font R char
DIGS HUD font S char
DIGT HUD font T char
DIGU HUD font U char
DIGV HUD font V char
DIGW HUD font W char
DIGX HUD font X char
DIGY HUD font Y char
DIGZ HUD font Z char
DIG45 HUD font - char
DIG47 HUD font / char
DIG58 HUD font : char
DIG91 HUD font [ char
DIG93 HUD font ] char

Status bar
----------
STKEYS6 Both blue keys graphic
STKEYS7 Both yellow keys graphic
STKEYS8 Both red keys graphic

Box chars
---------
BOXUL Upper left corner of box
BOXUC Center of upper border of box
BOXUR Upper right corner of box
BOXCL Center of left border of box
BOXCC Center of box
BOXCR Center of right border of box
BOXLL Lower left corner of box
BOXLC Center of lower border of box
BOXLR Lower right corner of box

Misc HUD Graphics
-----------------
HU_FRAGS Frags display header graphic (new to SMMU)
HU_FRAGBX Frags display name plate graphic (new to SMMU)
CROSS1 + crosshair graphic (new to SMMU)
CROSS2 Angle crosshair graphic (new to SMMU)
VPO Visplane overflow indicator (new to SMMU)
OPENSOCK Network connection error indicator (new to SMMU)

Misc Graphics
-------------
UDTTL00 Hires Ultimate DOOM title screen, upper left (new to SMMU)
UDTTL01 Hires Ultimate DOOM title screen, lower left (new to SMMU)
UDTTL10 Hires Ultimate DOOM title screen, upper rght (new to SMMU)
UDTTL11 Hires Ultimate DOOM title screen, lower rght (new to SMMU)
D2TTL00 Hires DOOM II title screen, upper left (new to SMMU)
D2TTL01 Hires DOOM II title screen, lower left (new to SMMU)
D2TTL10 Hires DOOM II title screen, upper rght (new to SMMU)
D2TTL11 Hires DOOM II title screen, lower rght (new to SMMU)
DLGBACK Default dialog background graphic (new to Eternity)

Lumps missing in v1.1
---------------------
STTMINUS minus sign for neg frags in status bar
WIMINUS minus sign for neg frags on end screen
M_NMARE nightmare skill menu string
STBAR status bar background
DSGETPOW sound for obtaining power-up

Sprites
-------
TNT1A0 Invisible sprite for push/pull controller things
DOGS* MBF helper dog sprite (new to MBF)
PLS1* BFG 2704 plasma 1 sprite (new to MBF)
PLS2* BFG 2704 plasma 2 sprite (new to MBF)
SLDG* FLOOR_SLUDGE TerrainType fx sprite (new to Eternity)
LVAS* FLOOR_LAVA TerrainType fx sprite (new to Eternity)
SPSH* FLOOR_WATER TerrainType fx sprite (new to Eternity)

Misc Sounds
-----------
DSDGSIT MBF helper dog alert (new to MBF)
DSDGATK MBF helper dog attack (new to MBF)
DSDGACT MBF helper dog idle (new to MBF)
DSDGDTH MBF helper dog death (new to MBF)
DSDGPAIN MBF helper dog pain (new to MBF)
DSPLFEET Light player impact (new to Eternity)
DSFALLHT Falling damage impact death (new to Eternity)
DSPLFALL Falling damage player scream (new to Eternity)
DSTHUNDR MapInfo global thunder effect (new to Eternity)
DSMUCK FLOOR_SLUDGE TerrainType sound (new to Eternity)
DSBURN FLOOR_LAVA TerrainType sound (new to Eternity)
DSGLOOP FLOOR_WATER TerrainType sound (new to Eternity)

Flats
-----
METAL Complimentary brown metal flat (new to SMMU)
F_SKY2 Dummy flat for Hexen-style sky sectors (new to Eternity)

Switches and Animations
-----------------------
SWITCHES Definition of switch textures recognized
ANIMATED Definition of animated textures and flats recognized
==SWITCHES format==

The SWITCHES lump makes the names of the switch textures used in the game known to the engine. It consists of a list of records each 20 bytes long, terminated by an entry (not used) whose last 2 bytes are 0.

9 bytes Null terminated string naming "off" state texture for switch
9 bytes Null terminated string naming "off" state texture for switch
2 bytes Short integer for the IWADs switch will work in
1 = shareware
2 = registered/retail DOOM or shareware
3 = DOOM II, registered/retail DOOM, or shareware
0 = terminates list of known switches

'''NOTE''': for defining new switches, use [[EDF switch]], unless you need Boom compatibility. You can also use [[ANIMDEFS]] if you need GZDoom compatibility.

==ANIMATED format==

The ANIMATED lump makes the names of the animated flats and textures known to the engine. It consists of a list of records, each 23 bytes long, terminated by a record (not used) whose first byte is -1 (255).

1 byte -1 to terminate list, 0 if a flat, 1 if a texture
9 bytes Null terminated string naming last texture/flat in animation
9 bytes Null terminated string naming first texture/flat in animation
4 bytes Animation speed, number of frames between animation changes
The [http://www.doomworld.com/idgames/index.php?id=9463 BOOM utility package] contains a program, SWANTBLS.EXE that will generate both the SWITCHES and ANIMATED lumps from a text file. An example is provided, DEFSWANI.DAT that generates the standard set of switches and animations for DOOM.

'''NOTE''': for defining new animations, use [[EDF animation]], unless you need Boom compatibility. You can also use [[ANIMDEFS]] if you need GZDoom compatibility.

==OPTIONS lump==
New to MBF, this lump allows you to set certain game settings for when the wad is loaded. See the [[OPTIONS]] documentation for more information.

== New to SMMU ==

Setting the animation speed for a flat to a number higher than 65535 will
cause the flat to use the swirling liquid effect rather than animation.

===Colormaps===
WATERMAP Custom greenish colormap for underwater use
LAVAMAP Custom red colormap for lava (new to SMMU)
The WATERMAP lump has the same format as COLORMAP, 34 tables of 256 bytes each, see the [http://www.doomworld.com/idgames/index.php?id=1138 UDS] for details. Note that colormaps you add to a PWAD must be between C_START and C_END markers.

The BOOM utility package contains a program, CMAPTOOL.EXE, that will generate custom colormaps for use with Eternity. It also includes 7 premade colormaps, and an add-on wad containing them.

===Color translation tables===
CRBRICK Translates red range to brick red
CRTAN Translates red range to tan
CRGRAY Translates red range to gray
CRGREEN Translates red range to green
CRBROWN Translates red range to brown
CRGOLD Translates red range to dark yellow
CRRED Translates red range to red range (no change)
CRBLUE Translates red range to light blue
CRBLUE2 Translates red range to dark blue (status bar numerals)
CRORANGE Translates red range to orange
CRYELLOW Translates red range to light yellow
These tables are used to translate the red font characters to other colors. They are made replaceable in order to support custom palettes in TC's better. Note however that the font character graphics must be defined using the palette indices for the standard red range of the palette 176-191.

== Eternity Note ==

The default text translation range in Heretic is gray rather than red, and replacement fonts should use the gray range in the palette to support color translations.

Data Lumps and Scripts
----------------------
TXTRCONV DOOM -> DOOM II texture conversion table (new to SMMU)
KEYDEFS Default keybindings (new to Eternity)
==TXTRCONV format==

The TXTRCONV lump is used to translate DOOM textures to DOOM II textures, for the purpose of playing ExMy levels under DOOM II (accessed via the map command). The format of this lump is currently very strict. The pairs of texture names must be aligned precisely, with the first texture name (<= 8 character) starting in column 0, followed by spaces up to column 16, where the second DOOM II replacement texture name must start. Only one pair must be on a line, and lines must be terminated with a line break. This lump is ASCII text.

==KEYDEFS format==

KEYDEFS contains the engine's default key bindings. This lump is written to file as keys.csc when a file by that name cannot be found. Editing of this defaults lump is not generally desirable, but it is a simple console script, the syntax of which is expounded upon in the Eternity Engine Console Reference. This lump is ASCII text.

==Sprite colour translation tables==
[[Thingtype]] [[EDF]] definitions allow a sprite's colour range to be translated, similar to how the green range is changed with the TRANSLATION1 and TRANSLATION2 [[thing type flags]], but in this case, by using custom external tables. These lumps are 256 bytes large and must be included between T_START and T_END. Normally, they will consist of consecutive 8-bit numbers from 0 to 255 if there is no translation, but the indices which need to be changed will have the numbers of the target colours.

[[Category:Editing reference]]

OPTIONS

2021-03-16T22:31:16Z

Afterglow: Remove "use_startmap" option years ago commented out in the source, fully removed in v4.03.00

New to MBF, the OPTIONS lump allows wads to set game options, such as Doom Compatibility options, chat strings, and enemies options.

The OPTIONS lump has the same format as eternity.cfg: A text file listing option names and values, optionally separated by blank or comment lines. Eternity.cfg indicates options which are allowed to be set in wads, with asterisks (*).

Wad authors are urged to use these options responsibly, because they should not be used to limit players, but to enhance the game. Many options such as automap colors are allowed to be set from wads, but they should only be done so if there are strong reasons to do so. More recommended to enforce are the compatibility (comp_) settings, because certain map effects (such as moving floor combinations) may depend on them to work properly. [[Linked portals]] for example require the setting "comp_overunder 0" in order to work, and in addition, due to Doom's default definition of solid static decorations, it is recommended to also set "comp_theights 0".

If a wad with OPTIONS lump is loaded, it will not overwrite the user configuration file.
{{backto|Eternity Engine}}
{{mbfref}}
==Options settable using the lump==
The Eternity.cfg file provides user-friendly explanation on each flag and if it's allowed to be set in wads. At the end of this document there is an excerpt from the default Eternity.cfg, with only the wad-settable options. Note that the lines beginning with semicolons or brackets are treated as comments and do nothing.

===Common options which are set in other lumps===

There may be other options you may be looking for, which for now aren't set here, but in other wad lumps:
*To disable jumping, set '''disable-jump''' in [[EMAPINFO]] for each needed level.

==OPTIONS full listing==
[0-1(0)] 1 to enable variable pitch in sound effects (from id's original code) *
pitched_sounds 0

[0-1(1)] 1 to enable translucency for some things *
translucency 1

[0-100(66)] set percentage of foreground/background translucency mix *
tran_filter_pct 66

[0-1(0)] 1 to enable recoil from weapon fire *
weapon_recoil 0

[0-4(0)] 0 - normal, 1 - classic, 2 - 11k, 3 - bouncing!, 4 - burst *
bfgtype 0

[0-3(0)] 0 - none, 1 - cross, 2 - angle *
crosshair 0

[0-1(0)] 0 - no highlighting, 1 - aim highlighting enabled *
crosshair_hilite 0

[0-1(0)] show scores in deathmatch *
show_scores 0

[0-1(0)] 0 - right handed, 1 - left handed *
lefthanded 0

[0-1(1)] 1 to enable player bobbing (view moving up/down slightly) *
player_bobbing 1

[0-1(0)] 1 to enable monsters remembering enemies after killing others *
monsters_remember 0

[0-1(1)] 1 to enable monsters fighting against each other when provoked *
monster_infighting 1

[0-1(0)] 1 to enable monsters backing away from targets *
monster_backing 0

[0-1(0)] 1 to enable monsters to intelligently avoid hazards *
monster_avoid_hazards 0

[0-1(0)] 1 to enable monsters to move up/down steep stairs *
monkeys 0

[0-1(1)] 1 to enable monsters to be affected by friction *
monster_friction 1

[0-1(1)] 1 to enable monsters to help dying friends *
help_friends 1

[0-3(0)] number of single-player helpers *
player_helpers 0

[0-999(128)] distance friends stay away *
friend_distance 128

[0-1(1)] 1 to enable dogs to jump *
dog_jumping 1

[0-1(1)] 1 to enable monster roaring when last enemy is remembered *
p_lastenemyroar 1

[0-1(1)] 1 to enable flying in the direction you are looking *
p_pitchedflight 1

[0-1(1)] 1 to disable use of color on status bar *
sts_always_red 1

[0-1(0)] 1 to make percent signs on status bar always gray *
sts_pct_always_gray 0

[0-1(0)] 1 to disable doubled card and skull key display on status bar *
sts_traditional_keys 0

[0-1(1)] Zombie players can exit levels *
comp_zombie 1

[0-1(1)] Powerup cheats are not infinite duration *
comp_infcheat 1

[0-1(1)] Build stairs exactly the same way that Doom does *
comp_stairs 1

[0-1(0)] Monsters can telefrag on MAP30 *
comp_telefrag 0

[0-1(0)] Some objects never move over tall ledges *
comp_dropoff 0

[0-1(0)] Objects don't fall off ledges under their own weight *
comp_falloff 0

[0-1(0)] Monsters randomly walk off of moving lifts *
comp_staylift 0

[0-1(0)] Monsters get stuck on doortracks *
comp_doorstuck 0

[0-1(0)] Monsters don't give up pursuit of targets *
comp_pursuit 0

[0-1(1)] Arch-Vile resurrects invincible ghosts *
comp_vile 1

[0-1(0)] Pain Elemental limited to 20 lost souls *
comp_pain 0

[0-1(1)] Lost souls get stuck behind walls *
comp_skull 1

[0-1(0)] Blazing doors make double closing sounds *
comp_blazing 0

[0-1(0)] Tagged doors don't trigger special lighting *
comp_doorlight 0

[0-1(1)] God mode isn't absolute *
comp_god 1

[0-1(1)] Sky is unaffected by invulnerability *
comp_skymap 1

[0-1(0)] Use exactly Doom's floor motion behavior *
comp_floors 0

[0-1(0)] Use exactly Doom's linedef trigger model *
comp_model 0

[0-1(0)] Linedef effects work with sector tag = 0 *
comp_zerotags 0

[0-1(1)] Terrain effects not activated on floor contact *
comp_terrain 1

[0-1(0)] Creatures with no spawnpoint respawn at (0,0) *
comp_respawnfix 0

[0-1(1)] Players do not take falling damage *
comp_fallingdmg 1

[0-1(0)] Lost souls do not bounce on floors *
comp_soul 0

[0-1(0)] Things not fully clipped with respect to z coord *
comp_overunder 0

[0-1(0)] DOOM thingtypes use inaccurate height information *
comp_theights 0

[0-1(0)] Tracer shots cannot hit the floor or ceiling *
comp_planeshoot 0

[0-1(0)] One-time line specials are cleared on failure *
comp_special 0

[0-1(0)] Silent spawns at W/SW/S-facing DM spots *
comp_ninja 0

[0-1(1)] Disable jumping for DOOM/Heretic *
comp_aircontrol 1

[("No")] chat string associated with 0 key *
chatmacro0 "No"

[("I'm ready to kick butt!")] chat string associated with 1 key *
chatmacro1 "I'm ready to kick butt!"

[("I'm OK.")] chat string associated with 2 key *
chatmacro2 "I'm OK."

[("I'm not looking too good!")] chat string associated with 3 key *
chatmacro3 "I'm not looking too good!"

[("Help!")] chat string associated with 4 key *
chatmacro4 "Help!"

[("You suck!")] chat string associated with 5 key *
chatmacro5 "You suck!"

[("Next time, scumbag...")] chat string associated with 6 key *
chatmacro6 "Next time, scumbag..."

[("Come here!")] chat string associated with 7 key *
chatmacro7 "Come here!"

[("I'll take care of it.")] chat string associated with 8 key *
chatmacro8 "I'll take care of it."

[("Yes")] chat string associated with 9 key *
chatmacro9 "Yes"

[0-255(247)] color used as background for automap *
mapcolor_back 247

[0-255(104)] color used for automap grid lines *
mapcolor_grid 104

[0-255(181)] color used for one side walls on automap *
mapcolor_wall 181

[0-255(166)] color used for lines floor height changes across *
mapcolor_fchg 166

[0-255(231)] color used for lines ceiling height changes across *
mapcolor_cchg 231

[0-255(231)] color used for lines denoting closed doors, objects *
mapcolor_clsd 231

[0-255(175)] color used for red key sprites *
mapcolor_rkey 175

[0-255(204)] color used for blue key sprites *
mapcolor_bkey 204

[0-255(231)] color used for yellow key sprites *
mapcolor_ykey 231

[0-255(175)] color used for closed red doors *
mapcolor_rdor 175

[0-255(204)] color used for closed blue doors *
mapcolor_bdor 204

[0-255(231)] color used for closed yellow doors *
mapcolor_ydor 231

[0-255(119)] color used for teleporter lines *
mapcolor_tele 119

[0-255(176)] color used for lines around secret sectors *
mapcolor_secr 176

[0-255(0)] color used for exit lines *
mapcolor_exit 0

[0-255(96)] color used for lines not seen without computer map *
mapcolor_unsn 96

[0-255(88)] color used for lines with no height changes *
mapcolor_flat 88

[0-255(112)] color used as things *
mapcolor_sprt 112

[0-255(208)] color used for dot crosshair denoting center of map *
mapcolor_hair 208

[0-255(208)] color used for the single player arrow *
mapcolor_sngl 208

[0-255(112)] color used for the green player arrow *
mapcolor_ply1 112

[0-255(88)] color used for the gray player arrow *
mapcolor_ply2 88

[0-255(64)] color used for the brown player arrow *
mapcolor_ply3 64

[0-255(176)] color used for the red player arrow *
mapcolor_ply4 176

[0-255(252)] color used for friends *
mapcolor_frnd 252

[0-255(109)] color for lines not in the player's portal area *
mapcolor_prtl 109

[0-1(1)] 1 to overlay different linked portal areas in the automap *
mapportal_overlay 1

[0-1(1)] 1 to show automap pointer coordinates in non-follow mode *
map_point_coord 1

[0-1(1)] 1 to not show secret sectors till after entered *
map_secret_after 1

[0-1(1)] enable secret notification *
secret_notification 1

[1-16(1)] number of lines in review display *
hud_msg_lines 1

[0-1(1)] 1 enables message review list scrolling upward *
hud_msg_scrollup 1

[0-4(2)] fullscreen hud layout *
hud_overlaylayout 2

[0-1(1)] fullscreen hud enabled *
hud_enabled 1

[0-1(0)] hide kills/items/secrets info on fullscreen hud *
hud_hidestatus 0

[0-1(1)] display current level time on automap *
hu_showtime 1

[0-1(1)] display player/pointer coordinates on automap *
hu_showcoords 1

[0-9(6)] color of automap level time widget *
hu_timecolor 6

[0-9(6)] color of automap level name widget *
hu_levelnamecolor 6

[0-9(6)] color of automap coordinates widget *
hu_coordscolor 6

[0-200(25)] amount of health for red to yellow transition *
health_red 25

[0-200(50)] amount of health for yellow to green transition *
health_yellow 50

[0-200(100)] amount of health for green to blue transition *
health_green 100

[0-200(25)] amount of armor for red to yellow transition *
armor_red 25

[0-200(50)] amount of armor for yellow to green transition *
armor_yellow 50

[0-200(100)] amount of armor for green to blue transition *
armor_green 100

[0-1(1)] reflect armor class using blue or green color *
armor_byclass 1

[0-100(25)] percent of ammo for red to yellow transition *
ammo_red 25

[0-100(50)] percent of ammo for yellow to green transition *
ammo_yellow 50

[0-100(100)] fullscreen HUD translucency level *
st_fsalpha 100

[0-1(0)] obituaries on/off *
obituaries 0

[0-1(0)] toggle particle effects on or off *
draw_particles 0

[0-2(1)] particle translucency (0 = none, 1 = smooth, 2 = general) *
particle_trans 1

[0-2(0)] use sprites, particles, or both for blood (sprites = 0) *
blood_particles 0

[0-2(0)] use sprites, particles, or both for bullet puffs (sprites = 0) *
bullet_particles 0

[0-1(0)] draw particle rocket trails *
rocket_trails 0

[0-1(0)] draw particle grenade trails *
grenade_trails 0

[0-1(0)] draw particle bfg cloud *
bfg_cloud 0

[0-1(0)] draw particle rocket explosions *
pevent_rexpl 0

[0-1(0)] draw particle bfg explosions *
pevent_bfgexpl 0

[0-1(0)] stretch short sky textures for mlook *
stretchsky 0

[0-1(1)] 1 to show ENDOOM at exit *
showendoom 1

[0-1(1)] 1 to enable autoaiming *
autoaim 1

[0-1(0)] 1 to allow players to look up/down *
allowmlook 0

[0-1(0)] 1 to enable use of full classic menu emulation *
mn_classic_menus 0

[("default")] menu background *
mn_background "default"

[0-2(1)] Doom object translucency style (0 = none, 1 = Boom, 2 = new) *
r_tlstyle 1

[0-2(1)] 0 = none, 1 = melt, 2 = fade *
wipetype 1

[1-6(1)] preamp volume factor for SPC music *
snd_spcpreamp 1

[1-31(8)] bass boost for SPC music (logarithmic scale, 8 = normal) *
snd_spcbassboost 8

[-1-0(-1)] device used for MIDI playback *
snd_mididevice -1

[1-8(2)] TODO: adlmidi_numcards description *
snd_numchips 2

[0-75(72)] TODO: adlmidi_bank description *
snd_bank 72

SMMU

2021-03-16T22:29:19Z

Afterglow: Remove outdated docs to start map that EE stopped loading years ago. No known PWADs (for either SMMU or EE) actually used this feature

'''SMMU''' (''Smack my Marine Up'') is a [[Doom Wiki:source port|source port]] created by [[Doom Wiki:Simon "Fraggle" Howard|Simon Howard]]. It is derived from [[MBF]].

Features of SMMU:

* FraggleScript (''later removed from Eternity due to design flaws'')
* [[List_of_console_commands|Console]]
* Rewritten [[menu]], [[heads-up display]], and [[networking]] code
* Quake-style "start map" for skill selection, courtesy of [[Doom Wiki:Derek MacDonald (Afterglow)|Derek "Afterglow" MacDonald]] (''later removed from Eternity due to its FraggleScript dependency'')
* Windows, MS-DOS and Linux ports (''Eternity also runs on macOS'')
* Chasecam
* Various demo features, including the ability to move cameras freely within demos while they are playing
* [[Text Mode Doom|Text-mode]] rendering

After the project was abandoned, the [[Eternity Engine]] emerged as a derivative of the SMMU codebase.

SMMU is licensed under the [[Wikipedia:GPL|GNU GPL]].

Eternity is based upon SMMU, and therefore contains support for most SMMU features, as well standard [[BOOM]] and [[MBF]] linedef and sector types, [[Dehacked]] lumps, etc. Basically anything they can do, Eternity can do.

Eternity also contains further support for a number of extra linedef types which will only work with it.
{{backto|Eternity Engine}}
{{smmuedit}}
==The level header==
A 'level header' is the wad resource which starts a level. For example, the level headers for all the original doom levels were all in the format ''MAPxy'' or ''ExMy''.

In Eternity, the level header can take any name, for example, the SMMU 'start map' had the name {{c|START}}. Levels with nonstandard names can be accessed from the [[console]] using the "map" command, e.g. "map start".

Additionally, Eternity automatically detects new levels loaded from wads and will start on the appropriate level when the 'new game' option is chosen from the main menu (only if the "start new game on first new map" option on the Eternity Options menu is set to "yes", and only in DOOM II).

==The level info lump==
In original Doom, the level header resource was empty: it was always 0 bytes long. This is not to say that it ''had'' to be 0 bytes long: any data in the level header was simply ignored.

In SMMU, the level header was used to hold information about the level. The format is a simple text file, similar in style to the '.ini' files which are found in a typical Windows directory.

See the Eternity Engine [[MapInfo]] Reference for full information. As of Eternity Engine v3.31 'Delta', Eternity supports global MapInfo lumps. '''Setting MapInfo data in the level header lump is now deprecated.'''

==Thing options==
===Directions===
In original Doom, you could place things in levels, but their directions were rounded down to the nearest 45 degrees. However, in Eternity you can specify any angle right down to the nearest degree.

This does not require any kind of change in wad format. The original system allowed you to specify angles that were not 45 degree 'aligned'. However these were simply rounded down. Eternity has greater accuracy so you can specify any angle.

===Intermission cameras===
Eternity allows you to change the background in intermission screens but there is also a more advanced system that allows you to see a view of the after you have left it. If you place a thing of type 5003 in the level, when you get to the intermission screen you will see a view from that point rather than the standard 'still' background.

Placing more than one camera in a level works, also. If you make more than one camera, one of them is simply chosen at random.

==Other==
===Swirly flats===
The console variable <code>r_swirl</code>, when set to 1, will stop all animated flats from animating and instead give them a 'swirling' effect similar to the quake water effect. However, this affects all flats and for some animated flats it doesn't look right.

You can specify when to use the 'swirl' effect on individual animated flats using the [[EDF animations]], the Boom [[ANIMATED]] resource or [[ANIMDEFS]]. For Boom ANIMATED, you can use the <code>SWANTBLS.EXE</code> program to create your own set of animated flats. If the delay between flat frames is set greater than 65535, that flat will be given the swirl effect.

===Sector Flags===
Boom once promised two extra sector flags, if you look in boomref.txt:

Bits 10 and 11 are not implemented yet, but are reserved for use in
sound control. Bit 10 will suppress all sounds within the sector,
while bit 11 will disable any sounds due to floor or ceiling motion
by the sector.

In some levels, fake vanilla-compatible 3D bridges may "clunk" when you walk over them (due to the instant floor move specials). SMMU thus implemented sector flags which block mechanical sounds (or alternatively, ''all'' sounds) coming from them. You may now use bits 10 and 11 in your wads for the generalized sector types. Modern editors should offer this feature in the sector properties dialog box. See [[Generalized sector types]].

== Sources ==
* {{Doom Wiki|title=SMMU}}
* ''SMMUEDIT.TXT, supplied with the old Eternity documentation''

== External links ==

* [http://www.soulsphere.org/projects/smmu/ SMMU homepage]

[[Category:Source ports]]

EDF game properties reference

2021-03-16T22:21:52Z

Afterglow: Document "menu.startmap" field being added by V4.03.00

This unique block changes global game properties from established hardcoded defaults.

==Structure==
gameproperties
{
flags.add <string>
flags.remove <string>
missionflags.add <string>
missionflags.remove <string>
demo.titletics <integer>
demo.advisortics <integer>
demo.pagetics <integer>
menu.background <string>
menu.transframe <string>
menu.skvattacksound <string>
menu.offset <integer>
menu.pointer1 <string>
menu.pointer2 <string>
menu.startmap <string>
border.flat <string>
border.topleft <string>
border.top <string>
border.topright <string>
border.left <string>
border.right <string>
border.bottomleft <string>
border.bottom <string>
border.bottomright <string>
console.charsperline <integer>
console.bellsound <string>
console.chatsound <string>
console.backdrop <string>
hud.pausepatch <string>
game.pufftype <string>
game.telefogtype <string>
game.telefogheight <integer>
game.telesound <string>
game.thrustfactor <integer>
game.defpclass <string>
game.endgamefinaletype <string>
game.skillammomultiplier <floating-point>
game.monstermeleerange <value>
game.itemheight <floating-point>
game.skillammomultiplier <number>
finale.text.x <integer>
finale.text.y <integer>
castcall.title.y <integer>
castcall.name.y <integer>
intermission.pic <string>
sound.defaultmusname <string>
sound.defaultsndname <string>
credit.background <string>
credit.y <integer>
credit.titlestep <integer>
exit.endtextname <string>
blood.defaultnormal <string>
blood.defaultrip <string>
blood.defaultcrush <string>
}

==Description==
===Flags===
'''flags.add''' and '''flags.remove'''

Adds or removes general gameplay flags from the default set. Group them using the usual syntax, separating them by | (vertical bar), + or "," (comma). For plus and comma, you need to surround all flags in quotes.
====List of flags====
You can use the flags from the following categories:
=====Gameplay=====
These flags control gameplay physics:
:*'''CHASEFAST''': accelerates all the [[Chase]] states of monsters on skill 5 and '''-fast''' like in Heretic.
:*'''HASMADMELEE''': causes all monsters to fight each other when player dies in single player (like in Heretic).
:*'''LOSTSOULBOUNCE''': for demo compatibility, decide whether lost souls should bounce on floors (normally it's a user or [[OPTIONS]] gameplay setting).
:*'''SKILL5RESPAWN''': make monsters respawn on skill 5.
=====Game flow control=====
These flags don't control gameplay per se, but are important for player control and progression:
:*'''DOOMWEAPONOFFSET''': setup weapon frame '''offset()''' attributes to render like in Doom. Necessary for Dehacked compatibility.
:*'''INVALWAYSOPEN''': Inventory is always open (like Strife, but not Heretic).
:*'''MAPXY''': use ''MAPxy'' map names by default. This implies that the '''-warp''' command-line parameter will expect one value, and any legacy features which depended on the ''ExMy'' vs. ''MAPxy'' arrangements will favour ''MAPxy''.
:*'''NODIEHI''': avoid playing the '''pdiehi''' (high) death sound.
:*'''SETENDOFGAME''': [[Teleport_EndGame]] enables the cast finale.
=====Cosmetic=====
These flags control minor display differences between the games. Usually they're of limited use for mod authors, only relevant for the base game differences. Check this list if you have particular issues to solve in your mod:
:*'''CENTERHUDMSG''': make messages always show in center. Typical with Heretic.
:*'''CHEATSOUND''': make the menu sound when cheating.
:*'''HASADVISORY''': display the advisory popup in the title screen. This means drawing an "ADVISOR" lump image at coordinates (4, 160) of a virtual 320x200 screen space, soon as the title screen appears.
:*'''HUDSTARTBARNAME''': displays the automap level name and time relative to the status bar instead of at a hardcoded position.
:*'''IMPACTBLOOD''': '''(unused)'''. Projectiles causing blood on impact is a [[thingtype]] flag now.
:*'''MNBIGFONT''': use big font for menu titles.
:*'''SAVESOUND''': make a sound in save and load menus. This is a small interface detail.
:*'''SHADOWTITLES''': adds shadows font effects to the titles in menus.
:*'''SKILL5WARNING''': warn player if they want to start a new game on skill 5.
:*'''WOLFHACK''': is subject to German-edition restriction on secret levels. Typical for Doom 2.

====Internally preset flags====
The games supported by Eternity start with the following flags preset:
=====Doom=====
Common to all variants: '''DOOMWEAPONOFFSET''', '''HUDSTATBARNAME''', '''SKILL5RESPAWN''', '''SKILL5WARNING'''.

In addition, the following variants of Doom have extra flags:
*shareware: '''NODIEHI'''
*retail (Ultimate Doom): '''LOSTSOULBOUNCE'''
*commercial (Doom II): '''MAPXY''', '''SETENDOFGAME''', '''WOLFHACK'''
:Final Doom, the Xbox and the BFG edition versions also have '''LOSTSOULBOUNCE'''.
=====Heretic=====
For Heretic, the preset flags are: '''CENTERHUDMSG''', '''CHASEFAST''', '''CHEATSOUND''', '''HASADVISORY''', '''HASMADMELEE''', '''MNBIGFONT''', '''SAVESOUND''', '''SHADOWTITLES'''.

===Mission flags===
'''missionflags.add''' and '''missionflags.remove'''

Adds or removes mission-specific flags. A mission is a variant of a game, such as how we have Ultimate Doom, Doom II, Final Doom etc. The available mission flags are:
====List of flags====
*'''ALLOWEXITTAG''': mission allows tagged normal exit lines.
*'''ALLOWSECRETTAG''': mission allows tagged secret exit lines.
*'''CONBACKTITLE''': use '''console.backdrop''' (settable here) instead of TITLEPIC for the console background.
*'''DEMOIFDEMO4''': fine control for DEMO4 lump's existence.
*'''DOOM2MISSIONS''': supports the Doom II mission packs.
*'''HASBETRAY''': has the "Betray" secret MAP33 level.
*'''NOGDHIGH''': BFG edition setup flag.
*'''NOTELEPORTZ''': preserves Z coordinate when teleporting, like in Final Doom. Only acts like this in vanilla/demo compatibility.
*'''WOLFNAMEHACKS''': override Wolfenstein secret level names.
====Mission-preset flags====
Those missions have the following flags set:
*Doom II: '''DOOM2MISSIONS'''
*Final Doom: '''DEMOIFDEMO4''', '''NOTELEPORTZ'''
*Xbox and BFG edition: '''DOOM2MISSIONS''', '''HASBETRAY''', '''NOGDHIGH''', '''WOLFNAMEHACKS'''
All other missions have 0 flags.
===Demo control===
*'''demo.titletics'''
:Time to show the title screen. Defaults: 170 (Doom I), 385 (Doom II), 210 (Heretic).
*'''demo.advisortics'''
:Time to show the advisory banner over the title screen. This adds up to the whole time the title pic is shown. Only nonzero default is 140 in Heretic.
*'''demo.pagetics'''
:Time to show the page between demos. Defaults: 385 (Doom), 200 (Heretic).
===Menu customization===
*'''menu.background'''
:The default menu background flat. Defaults: FLOOR4_6 (Doom), FLOOR16 (Heretic), CONS1_5 (HacX mission).
*'''menu.transframe'''
:Name of [[frame]] to use in the video menu translucency preview. Defaults: S_TBALL1 (Doom), S_MUMMYFX1_1 (Heretic).
*'''menu.skvattacksound'''
:Name of [[sound]] to play when simulating attacking in the skin viewer. Defaults: shotgn (Doom), gldhit (Heretic).
*'''menu.offset'''
:Vertical offset upwards to draw the menu. Defaults: 0 (Doom), 4 (Heretic).
*'''menu.pointer1''' and '''menu.pointer2'''
:Graphic patches to use for the menu selector. Defaults: M_SKULL1 and M_SKULL2 (Doom), M_SLCTR1 and M_SLCTR2 (Heretic).
*'''menu.startmap'''
*Map lump name to load when the new game menu item is selected. This will skip the menus for episode and skill level selection. Default: No default
===Border customization===
*'''border.flat'''
:The flat to use for the background around the status bar and when the view window is reduced. Defaults: FLOOR7_2 (Doom I), GRNROCK (Doom II), FLOOR04 (Heretic shareware), FLAT513 (Heretic full).
*'''border.topleft''', '''.top''', '''.topright''', '''.left''', '''.right''', '''.bottomleft''', '''.bottom''' and '''.bottomright'''
:Pictures to use for the border. Defaults: BRDR_TL, BRDR_T, BRDR_TR, BRDR_L, BRDR_R, BRDR_BL, BRDR_B and BRDR_BR (Doom); BORD** (Heretic), same suffixes.
===Console customization===
*'''console.charsperline'''
:Number of characters per line to display in console. Default: 40.
*'''console.bellsound'''
:The beep error sound to use from the console, such as when errors occur. Defaults: tink (Doom), ht_chat (Heretic).
*'''console.chatsound'''
:The sound to play when receiving messages from other players. Defaults: tink (Doom I), radio (Doom II), ht_chat (Heretic).
*'''console.backdrop'''
:The name of the graphics lump to display for the console. Defaults: TITLEPIC (Doom), TITLE (Heretic).
===Heads-up display===
*'''hud.pausepatch'''
:The name of the graphics lump to display for the pause banner. Defaults: M_PAUSE (Doom), PAUSED (Heretic).
===Gameplay===
These options are relevant for gameplay physics. See also the similar gameplay flags.
*'''game.pufftype'''
:The default hitscan puff when no EDF [[pufftype]] is specified. Defaults: BulletPuff (Doom), HereticStaffPuff (Heretic).
*'''game.telefogtype'''
:The teleportation fog thing type. Defaults: DoomTeleFog (Doom), HereticTeleFog (Heretic).
*'''game.telefogheight'''
:The distance of the telefog from the ground. Defaults: 0 (Doom), 32 (Heretic).
*'''game.telesound'''
:The teleportation sound. Defaults: telept (Doom), htelept (Heretic).
*'''game.thrustfactor'''
:The percentage of how much to thrust things based on damage. Defaults: 100 (Doom), 150 (Heretic).
*'''game.defpclass'''
:The default player class when starting a new game. Defaults: DoomMarine (Doom), Corvus (Heretic).
*'''game.endgamefinaletype'''
:Default behavior for [[Teleport_EndGame]]. Supported options are:
:*text
:*doom_credits
:*doom_deimos
:*doom_bunny
:*doom_marine
:*htic_credits
:*htic_water
:*htic_demon
:*psx_udoom
:*psx_doom2
:Defaults: doom_credits (Doom I), text (Doom II), htic_credits (Heretic)
*'''game.skillammomultiplier'''
:Floating-point value for skill 1 and 5 ammo multiplier. Defaults: 2 (Doom), 1.5 (Heretic)
*'''game.monstermeleerange'''
:Mode to calculate melee range. Supported options are:
:*doom: range is 44 + radius(enemy)
:*raven: range is 64
:Defaults: doom (Doom), raven (Heretic).
*'''game.itemheight'''
:Item pick-up height. Unlike expectations, the height is not thingtype's height, but this value. Defaults: 8.0 (Doom), 32.0 (Heretic).
===Finale and intermission===
*'''finale.text.x''' and '''finale.text.y'''
:Finale text coordinates. Defaults: 10, 10 (Doom); 20, 5 (Heretic)
*'''castcall.title.y'''
:Cast call title Y. Default: 20
*'''castcall.name.y'''
:Cast call name Y. Default: 180
*'''intermission.pic'''
:Intermission backdrop. Default: INTERPIC
===Sound===
*'''sound.defaultmusname'''
:Default music to play if none specified. Defaults: e1m1 (Doom I and Heretic), runnin (Doom II)
*'''sound.defaultsndname'''
:Sound to play when the one specified in EDF is unavailable. Defaults: pistol (Doom), gldhit (Heretic)
*'''sound.titlemusic'''
:Title screen music. No default.
===Credits===
*'''credit.background'''
:Swirling flat to use in the Eternity credits background. Defaults: NUKAGE1 (Doom I), SLIME05 (Doom II), SLIME01 (Hacx mission), FLTWAWA1 (Heretic)
*'''credit.y'''
:Credits Y coordinate. Defaults: 20 (Doom), 8 (Heretic)
*'''credit.titlestep'''
:Y step for each line. Defaults: 12 (Doom), 8 (Heretic)
===ENDOOM===
*'''exit.endtextname'''
:Exit text lump. Defaults: ENDOOM (Doom), ENDTEXT (Heretic)
===Blood===
*'''blood.defaultnormal'''
:Thing type for the default blood splat. Defaults: DoomBlood (Doom), HereticBloodSplatter (Heretic)
*'''blood.defaultrip'''
:Thing type for the piercing RIP projectiles. Defaults: DoomBlood (Doom), HereticBlood (Heretic)
*'''blood.defaultcrush'''
:Thing type for the crushing ceiling blood. Defaults: DoomBlood (Doom), HereticBlood (Heretic)

EDF menu reference

2021-03-16T22:15:30Z

Afterglow: Fix "first" field's bullet point nesting

New to EDF 1.6, dynamic menus allow the Eternity Engine's menu system to be customized in various ways, including through the definition of the custom user menu and via overriding of specific menus within the native menu heirarchy.

Remember that all fields are optional and may be provided in any order. Note that the order of item sections within a menu is important, however.
{{backto|EDF}}
==Syntax==
menu <unique mnemonic>
{
# one or more item sections can exist; the items appear on the menu in the
# order they are defined within their parent menu section
item
{
type = <menu item type name>
text = <string>
cmd = <string>
patch = <string>
flags = <menu item flags string>
}

prevpage = <menu mnemonic>
nextpage = <menu mnemonic>
x = <number>
y = <number>
first = <number>
flags = <menu flags string>
}
==Explanation of Fields==
*item
:Default = No default
:One or more items must be defined in every menu. There is no upper limit on the number of item sections. The items will appear in the menu in the same order in which they were defined in EDF.
:Explanation of menu item fields:
:*type
::Default = info
::One of the following values with the given meanings:
::*info - The item is an informational string. It cannot be selected or execute a command, even if one is provided. This type of item is used as a section title. It is usual for the text to be given gold coloration, but this is up to the user.
::*gap - The item is a gap of blank space. It cannot be selected or execute a command. The amount of space is determined by the font used by the menu.
::*runcmd - This item type executes a command when the key bound to menu_confirm is pressed while it is selected. Only the text description is displayed; there is no value or other graphic to the right. If the command provided to this item is invalid, this item will be disabled.
::*variable - This item type allows editing of a console variable's value directly. The value editing must be done by typing in the new value. The value will appear to the right of the text description of this item at a distance determined by the layout of the menu. If the variable provided to this item is invalid, it will be disabled.
::*toggle - This item allows editing of a console variable's value using the menu_left or menu_right actions to scroll through its possible set of values. This type of item is only appropriate for console variables which are of "yes/no", "on/off", or "named value" types. The value of the variable will appear to the right of the text description of this item at a distance determined by the layout of the menu. If the variable provided to this item is invalid, it will be disabled.
::*title - This item type is appropriate only for use as the main title of the menu. Titles are drawn using the gamemode's "Big" font if no graphic patch is available for them. In Heretic, menu title text is also shadowed by default. This type of item has no value, is not selectable, and cannot execute a command.
::*slider - This item type allows editing of a console variable's value using a slider. The slider will appear to the right of the text description at a distance determined by the menu's layout. If the variable assigned to this item is invalid, the slider will be disabled. Sliders are only appropriate for use with ranged integer console variables.
::*automap - This item is an automap color selector.
::*binding - This item is a keybinding. The value provided to the cmd field must be a key action name instead of a console command. The keys currently bound to the action will appear to the right of text description at a distance determined by the menu's layout.
::*bigslider - This item is a giant slider for emulated menus. Otherwise, it works similar to the normal slider.
*text
::Default = ""
::This is the textual description of the menu item, which is drawn for all item types unless a valid patch graphic is specified, in which case it will be drawn instead. The height of the menu item is determined by the text or graphic used by the item, and item spacing is performed automatically by the menu engine.
:*cmd
::Default = No default
::This is the console command, console variable, or other special value which this item will execute or set a value to when it is activated. This field only has meaning for item types which are selectable. Non-selectable types will ignore it entirely. If a runcmd, variable, toggle, slider, automap, or binding item type is given an invalid console command or variable, the item will be disabled by the menu engine.
:*patch
::Default = No default
::If specified, this field will override the text description with a patch graphic of the given name. If the patch named doesn't exist amongst all loaded WAD files, the text description will appear instead. If the graphic named exists but is not a valid patch graphic lump, behavior is undefined.
:*flags
::A BEX-format flags field which can accept any combination of the following values. All values are off by default.
Flag name Effect
--------------------------------------------------------------------
BIGFONT Item uses the gamemode's "big" font
CENTERED Menu item is centered. Useful only for info items.
LALIGNED Menu item is aligned to the left.
--------------------------------------------------------------------

::Example:
menu foo
{
item { type = info; text = "Hello EDF!"; flags = BIGFONT|CENTERED }
}

::As with all other BEX-format flag fields, if the field's value contains whitespace, commas, or other characters disallowed in unquoted strings, you must surround the entire field value in single or double quotation marks.
*prevpage
:Default = No default
:This field specifies the previous page of this menu. Menus may be attached to each other in a circular chain of pages, which can be perused either by pressing Ctrl plus the keys bound to menu_left or menu_right, or by pressing the keys bound to menu_pageup or menu_pagedown. The default value means that there is no previous page. If the menu named by this field does not exist, there will also be no previous page. Table of contents functionality is not available for dynamic menus.
*nextpage
:Default = No default
:This field specifies the next page of this menu. It is otherwise identical to the prevpage field above.
*x
:Default = 200
:Specifies the x offset of the menu starting from the upper lefthand corner of the screen. Menu coordinates are relative to a 320x200 screen and are scaled at runtime by the game engine. All patches are clipped to the screen, so it is not harmful if a menu or any items on it extend off the framebuffer. Note that this value specifies the right end of description strings for normal menu items. Item values will be drawn further to the right of this.
*y
:Default = 15
:Specifies the y offset of the menu starting from the upper lefthand corner of the screen. Menu coordinates are relative to a 320x200 screen and are scaled at runtime by the game engine.
*first
:Default = 0
:Zero-based index of the first item that should be selected on the menu. If this value is out of range or is set to a normally unselectable item, the selection pointer will not appear until the user moves to a new item, at which point it will appear to jump to the proper item. On most native menus, the first selectable item is at index 3. This is due to a title, gap, and info item usually being the first three items on the menu.
*flags
:A BEX-format flags field which can accept any combination of the following values. All values are off by default.
Flag name Effect
------------------------------------------------------------------------
skullmenu This menu uses the large skull pointer.
background This menu has a background and uses the small pointer.
leftaligned This menu is aligned to the left. Does not work with
all item types.
centeraligned All items on this menu are centered. Not useful for
menus that contain anything other than title, gap,
info, or command items.
emulated This menu is an emulated original DOOM menu. All items
are spaced at 16-pixel intervals.
------------------------------------------------------------------------

:Example:
menu foo
{
item { type = info; text = "Hello EDF!"; flags = BIGFONT }

flags = skullmenu|leftaligned
}

:As with all other BEX-format flag fields, if the field's value contains whitespace, commas, or other characters disallowed in unquoted strings, you must surround the entire field value in single or double quotation marks.
==Restrictions and Caveats==
*All menus must have a unique mnemonic no longer than 32 characters. They should only contain alphanumeric characters and underscores. Length will be verified, but format will not (non-unique mnemonics will overwrite previous definitions).
==Replacing Existing Menus==

To replace the values of an existing EDF menu definition, simply define a new menu with the exact same mnemonic value (as stated above, all menus need a unique mnemonic, so duplicate mnemonics serve to indicate that an existing menu should be replaced).

==Example==
/*

Define the reserved _MN_Custom menu, which is automatically made available on
the second page of Eternity's main options menu when it is defined.
This is a great use for the new optional "user.edf" file. Note that by using
the new "mn_dynamenu" command, it is possible to create your own inter-menu
links and form a complete heirarchy of custom menus. See the console reference
for full information.

*/
menu _MN_Custom
{
item { type = title; text = "my custom menu" }
item { type = gap }
item { type = info; text = "\Hitems here" }
item { type = runcmd; text = "get outta here!"; cmd = "mn_prevmenu" }

first = 3
flags = background
}
==Overriding Native Menus==

Eternity allows specific native menus to be overridden by menus you define in EDF. Currently the following menus can be overridden:
*Episode selection menu
To override a specific menu, you set a global variable in either the root EDF or in an EMENUS lump to the mnemonic of the menu you have provided. A table of variables and the menus they replace follows:
EDF Variable Menu Overridden
-------------------------------------------------------
mn_episode Episode selection menu
-------------------------------------------------------
Example
/*
This could be placed at global scope anywhere within the root chain of EDF
files/lumps or within an EMENUS lump along with the menu it names.
*/
mn_episode = MyEpisodeMenu
[[category:EDF]]

EMAPINFO

2021-03-16T22:04:48Z

Afterglow: Document 'levelnum' being added in v4.03.00

'''MapInfo''' serves as a method of customizing some aesthetic properties of a map which would otherwise be unchangeable, as well as adding the ability to use some [[Eternity]]-specific features. Eternity's MapInfo is stored in the EMAPINFO text lump.
{{Backto|Eternity Engine}}
{{editref}}

==Usage==
MapInfo data is stored in the global EMAPINFO lump, which is a plain-text lump containing information for all maps together. Variables for each level must be placed under a section header that has the same name as the map's header lump.

==Syntax==
*Each map definition begins with a block header. This consists of the map's lump name in brackets, such as [MAP01], [E1M1], or [MYLEVEL].
*Variables are specified in the lines following the block header.
*All values are treated as text strings, and quotation marks are not required.
*Comments may start with '#', ';', or '//'. All three comments are single line only, and extend to the end of the line.
*An optional equal sign can be placed between a variable and the value it is given. It is not an error to omit it.

==MapInfo Variables==
===Level identification===
====creator====
:The level author's name, which can be viewed in the console using the "creator" console command. If this value is not provided, the default value is "unknown". For example:
creator = Edwin Chadwick 'chadders'

====edf-intername====
:Boolean value which, if true, enables the use of [[EDF]]-defined intermission map name strings which will be drawn using the FONTB graphics (provided in eternity.wad for DOOM/DOOM II, and natively supported by Heretic). This feature is meant to obsolete the levelpic variable and to remove the need for authors to create title graphics for their maps in DOOM/DOOM II. It also allows intermission map name replacement to work correctly for the next level and for Heretic without any hacks.
The EDF string which will be used as the intermission name for the current map should have the mnemonic _IN_NAME_<mapname>, where <mapname> is the exact name of the map's header lump (Example: _IN_NAME_MAP01).
In order for the name of the next map to display correctly, the current level must either define its nextlevel/nextsecret values explicitly, or it must be an ExMy or MAPxy level. For example:
edf-intername = true

====inter-levelname====
:Name of the map to display in the intermission score screen. This is separate from '''levelname''' which is for the automap display, and can be used as an alternative to '''levelpic''' which is a graphic lump for the intermission name. If both '''inter-levelname''' and '''levelpic''' are present, '''levelpic''' takes precedence. Unlike '''levelpic''', this one also works in Heretic. For example:
inter-levelname = Circle of death

====interpic====
:Name of a 320x200 graphic lump to be displayed as the background of the statistics intermission. For example:
interpic = BOSSBACK

====killstats====
:Boolean value that allows the statistics intermission between two maps to be disabled. If the map has a finale sequence to be displayed, it will start immediately, otherwise the next map will be loaded. For example:
killstats = true

====levelname====
:This is the name of the level which will be displayed in the automap. This value overrides any string provided via DeHackEd. If you want to change the level name displayed in the intermission, change '''levelpic''' or '''inter-levelname'''. '''Levelname''' example:
levelname = chadders' lair

====levelnum====
:Integer value used to identify it for the [[Parameterized_linedef_specials#Exits|Teleport_NewMap]] special. When the map's lump name does not follow the format MAPxx or ExMy, a numeric value is required.
[D2DM1]
levelnum = 1

====levelpic====
:This is the name of a graphic lump which will be shown as the level name during the statistics intermission when this map is the previous map which was just beaten. This value is only used for DOOM and DOOM II maps. You can also use '''inter-levelname''' to set the intermission display level name, which will use the necessary font, already included in Eternity. '''Levelpic''' example:
levelpic = E1M1PIC

====levelpicnext====
:The level pic to show for the next level, only when taking the normal exit. If omitted, it will try that level's '''levelpic''' or write the name of it using the font.

====levelpicsecret====
:Same as '''levelpicnext''', but for taking the secret exit instead.

====nextlevel====
:The exact header name of the next level to go to when a normal exit occurs on this map. This can specify *any* lump name, but the lump should be a valid level header or an error will occur. For example:
nextlevel = CHAD2

====nextsecret====
:The exact header name of the next level to go to when a secret exit occurs on this map. This can specify *any* lump name, but the lump should be a valid level header or an error will occur. Note that except for maps which normally have secret exits, the default behavior is to repeat the same level. This MapInfo value allows you to avoid that and use a secret exit on any map. For example:
nextsecret = MAP34

====partime====
:Partime for the map in seconds. This value overrides any value provided via DeHackEd. Note that partimes are only supported in episodes 1-3 of DOOM and any map of DOOM II. Ultimate DOOM episode 4, Heretic, and non-standard maps currently never display par times. For example:
partime = 200

===Scripting===
====acsopendelay====
:Boolean value that determines whether or not scripts' execution within the first 35 tics after entering the map is delayed until 35 tics have passed. '''(since 16th Feb 2016)'''
acsopendelay = true

====acsscript====
:Name of the lump containing the compiled ACS script for this map.
acsscript = SCRIPT01

====extradata====
:Name of the ExtraData script lump for this map. See the ExtraData Reference for full information on ExtraData. There are no naming restrictions on ExtraData script lumps. For example:
extradata = EXTRDT01

====levelscript====
:Name of a compiled {{Deprecated}} Small script lump which will serve as the Levelscript for this map. NOTE: use '''acsscript''' for compiled ACS scripts.

===Physics===
====aircontrol====
:How much control the player has when attempting to move while in mid-air. By default Doom and Heretic have it 0 (no control whatsoever) and Hexen and Strife have a tiny value, just enough to allow jumping on objects.
:Default value is 0. Keep in mind you can set the '''comp_aircontrol''' property in the [[OPTIONS]] lump to "yes" or "no", which if enabled, will produce the Hexen effect. Maximum air control is 65536, so anything between 0 and 65536 is equivalent to air control between 0 and 100%.

====airfriction====
:This is an optional field, useful if '''aircontrol''' is significant, in order to limit player's speed when moving in mid-air. ''Non-player objects, such as projectiles, are not affected by this''. Default value is 0 (no friction, like in the original games), and the maximum is 65536 (no acceleration whatsoever). In order to feel realistic, if it's needed, make sure to keep '''airfriction''' very low, or lower than the ground friction anyway, as it ''only'' applies while you're above ground.

====disable-jump====
:If set to '''true''', it will disable player jumping in current level. Default is '''false'''.
disable-jump = true

====gravity====
:Global gravity factor for the current level. The default gravity value is 65536. For example:
# Enable 50% gravity
gravity = 32768

===Ambience===
====altskyname====
:Name of a texture to display instead of the normal sky texture during a lightning strike. This value is only used if lightning is enabled for this level. If this value is not provided, no sky animation will occur during lightning strikes. For example:
altskyname = LBOLTSKY

====colormap====
:Name of a colormap lump to use as the global colormap for this level. This colormap is applied to any sectors which do not have their own colormaps specified either via use of 242 height transfer linedefs or scripting. This lump must be between C_START and C_END tags. For example:
colormap = FOGMAP

====defaultenvironment====
:Sets the default sound environment (reverb) effect to happen in the map. Use two identifiers, as defined in [[EDF]].
defaultenvironment = 1 2

====doublesky====
:Boolean value that determines whether or not this map uses double skies. When double skies are enabled, any F_SKY1 or F_SKY2 sectors *not* affected by MBF sky transfer lines will use both the primary and secondary sky textures together. The secondary texture will be drawn first, normally, then the primary texture will be drawn over it, omitting any pixels which use palette index zero (this is usually pure black). Any MapInfo sky delta values provided will be applied to their respective textures. For example:
doublesky = true

====fullbright====
:Boolean value that determines whether fullbright can be used on this level. When fullbright is disabled, player gun flashes will not occur, and fullbright sprites and particles will be drawn normally. This should be used with most custom colormaps, since flashes and fullbright sprites usually look incorrect with them. For example:
fullbright = false

====lightning====
:Boolean value that toggles the global lightning effect. When set to true, all sky sectors on the map will flash at randomly determined intervals along with a thunder sound and optional animation of the normal sky texture. Warning: sectors must currently have a sky ceiling at the beginning of the level in order to be affected by lightning. The only current method to make non-sky sectors flash during lightning strikes is via use of BOOM lighting transfer linedefs. This may be improved in the near future. For example:
lightning = true

====music====
:Provides the name of a MUS or MIDI lump to use as music. In DOOM gamemodes, the string provided should be the lump name minus the "D_" prefix. In Heretic, the string provided should be the lump name minus the "MUS_" prefix. You are *not* limited to using only the built-in music lump names; Eternity automatically adds any new lump which matches the naming convention for the current gamemode to the internal music list. For example:
music = cheese

====sector-colormaps====
:'''(since 2nd April 2017)''' This optional property can be used to enforce classic Boom or SMMU-style behaviour for sector colormap applications using either the [[Transfer_Heights]] linedef special or [[ExtraData]] or [[UDMF]] sector properties. Possible values are:
:*''normal'': this is the default value. It makes the [[Transfer_Heights]] special apply the Boom behaviour, where the sector the player is in causes the entire view to change colour, while [[ExtraData]] and [[UDMF]] use the SMMU-introduced behaviour, where the sector colour is local to the sector, as if having local coloured light or fog effect. It's default because of required compatibility with past Boom and MBF wad releases, whereas the new SMMU introduced behaviour can be more useful for new maps with ExtraData or UDMF.
:*''Boom'': the Boom sector colormap behaviour will apply to all kinds of colormap settings, like in Boom or MBF.
:*''SMMU'': the SMMU sector colormap behaviour will apply to all kinds of colormap settings, like in previous Eternity versions.
sector-colormaps = normal

====skydelta====
:Pixels per gametic that the primary sky texture should scroll. This effect will only be applied to double skies and to F_SKY1 sectors which are NOT affected by any MBF sky transfer linedefs. For example:
skydelta = 5

====sky2delta====
:Pixels per gametic that the secondary sky texture should scroll. This effect will only be applied to double skies and to F_SKY2 sectors (which cannot be affected by MBF sky transfer linedefs). For example:
sky2delta = 7

====skyname====
:Name of a texture to use as the primary sky for this map. This sky will appear in all sectors which use the F_SKY1 flat, and it will also appear as the top layer of Hexen-style double skies. The name provided for this lump must be a valid texture or an error will occur. For example:
skyname = SKY2

====sky2name====
:Name of a texture to use as the secondary sky for this map. This sky will appear in all sectors which use the F_SKY2 flat, and it will also appear as the bottom layer of Hexen- style double skies. The name provided for this lump must be a valid texture or an error will occur. If no name is provided for the secondary sky, the primary sky name will be copied to it, so it is not an error to use F_SKY2 or double skies in a level where the sky2 texture is not explicitly defined. For example:
sky2name = SKY4

====unevenlight====
:Boolean value that determines whether walls parallel to the x and y axes of the game world are given lighting values 1 level higher or lower than other walls. This can dramatically affect the perceived light level of an area, so only use it for maps that are designed specifically for it. Maps which use custom global colormaps should usually set this value to false, since it only generally looks appropriate with the normal colormap. For example:
unevenlight = false

====sound-*====
:There are several sound-* commands which can be used to replace the default sounds in a map with sounds, using their mnemonics defined in [[EDF]].
[[EDF]] mnemonic of a sound to replace the default "swtchn" sound for this map.

Sounds available for replacement:
swtchx
swtchn
stnmov
pstop
pstart
bdcls
bdopn
dorcls
doropn
fcmove

Examples of use:
sound-swtchx = newswtch
sound-doropn = dorcreak

===Finale control===
====boss-specials====
:A flags field that specifies what formerly level-specific boss "magic codepointer" actions are enabled for this level. This field takes a value in the same format as that used by [[EDF]], DeHackEd/BEX, and ExtraData flag fields, but the format will be reviewed here for completeness.

A BEX flag list is a string of flag names separated by whitespace, pipe characters, commas, or plus characters. Flags are combined using bitwise-OR logic, so a flag name can be specified more than once. Specifying a flag name causes that flag to be turned on. The default state of all flags is off.

These are the flag values which are available for this field:
Flag name Decimal Hex Meaning
-----------------------------------------------------------------
MAP07_1 1 0x0001 MAP07 Special 1 (BossDeath only)
MAP07_2 2 0x0002 MAP07 Special 2 (BossDeath only)
E1M8 4 0x0004 E1M8 Special
E2M8 8 0x0008 E2M8 Special
E3M8 16 0x0010 E3M8 Special
E4M6 32 0x0020 E4M6 Special (BossDeath only)
E4M8 64 0x0040 E4M8 Special
E5M8 128 0x0080 E5M8 Special (HticBossDeath Only)
-----------------------------------------------------------------

Notes: Actions differ depending on whether monsters use the BossDeath or HticBossDeath codepointers. See the documentation for those specific codepointers to see what actions they perform. The monsters which must be dead for a given special to activate are controlled by various [[EDF]]/BEX thingtype flags. Together, these features allow complete customization.

Example flags fields -- All of these are equivalent:
boss-specials = MAP07_1|MAP07_2
boss-specials = MAP07_1 | MAP07_2

boss-specials = MAP07_1+MAP07_2
boss-specials = MAP07_2 + MAP07_2

boss-specials = MAP07_1,MAP07_2
boss-specials = MAP07_1, MAP07_2

boss-specials = MAP07_1 MAP07_2

====endofgame====
:Boolean value which, if true, causes a DOOM II cast call to occur when this map is exited. This value is currently only usable in DOOM II. A level must also have intermission text defined for a cast call to take place. For example:
endofgame = true

====finale-early====
:Boolean value which, if true, indicates that a text intermission should occur after this map without displaying the usual score screen. If no intermission text is defined for this map, this variable has no effect. For example:
finale-early = true

====finale-normal====
:Boolean value which, if true, indicates that a text intermission should only occur after this map if a normal exit was taken. If no intermission text is defined for this map, this variable has no effect. For example:
finale-normal = true

====finale-secret====
:Boolean value which, if true, indicates that a text intermission should only occur after this map if a secret exit was taken. If no intermission text is defined for this map, this variable has no effect. For example:
finale-secret = true

====finaletype====
:Specifies which finale image sequence to use. Possible values are:
:*''text'': Only the intertext will be displayed. Play will then continue to the next level normally.
:*''doom_credits'': The DOOM CREDITS screen will be displayed after the intertext. Play ends after this map.
:*''doom_deimos'': The DOOM picture of Deimos above Hell will be displayed after the intertext. Play ends after this map.
:*''doom_bunny'': The scrolling picture of Daisy's head on a pike will be displayed, accompanied by the words "THE END" which are shot up with several bullets. Play ends after this map.
:*''doom_marine'': The E4 ending picture of the Marine holding Daisy's head is displayed after the intertext. Play ends after this map.
:*''htic_credits'': The Heretic CREDITS screen will be displayed after the intertext. Play ends after this map.
:*''htic_water'': The Heretic underwater screen with special palette is displayed after the intertext. Play ends after this map.
:*''htic_demon'': The Heretic demon scroller is displayed after the intertext. Play ends after this map.

====finalesecrettype====
:Like above, but for the secret exit.

====inter-backdrop====
:Name of a 64x64 flat OR a 320x200 graphic lump to be displayed as the background of a text intermission which occurs after this map. The flat namespace will be searched first, so if both a flat and a 320x200 picture of the same name exist, the flat will be chosen. For example:
inter-backdrop = FLATHUH1

====intermusic====
:Name of a MUS or MIDI lump to use as music during a text intermission which occurs after this map. If no intertext is defined for the map, this value will not be used. In DOOM gamemodes, the string provided should be the lump name minus the "D_" prefix. In Heretic, the string provided should be the lump name minus the "MUS_" prefix. You are *not* limited to using only the built-in music lump names; Eternity automatically adds any new lump which matches the naming convention for the current gamemode to the internal music list. For example:
intermusic = ROMERO

====intertext====
:Lump name of a text lump to be loaded as intermission text for this level. If the level has an intermission by default, this will replace the default intermission text, even if it has been edited via DeHackEd. If there is not normally a text intermission after this map, the presence of this variable serves to enable it. If no intertext is defined, a text intermission will not occur after a map. The formatting of the text inside the indicated lump will be preserved exactly, with the exception of tabs, which are converted to spaces. There is no length limitation, but only one screen of text (40 columns, 17 rows) can be displayed. Any extra text will be drawn off the bottom of the screen. For example:
intertext = MAP04TXT

====killfinale====
:Boolean value that allows built-in text intermission points to be disabled. For example, if you do not want text to appear after DOOM II MAP11, set this variable to true. For example:
killfinale = true

====levelaction====
:Specifies what happens when certain species of monsters all die in the map. The syntax is such: ''thingtype'' ''special'' [''arg1'' [''arg2'' [''arg3'' [''arg4'' [''arg5'']]]]]. You can even have more than one per level.
levelaction = BaronOfHell Floor_LowerToLowest 671 8
levelaction = Arachnotron Floor_RaiseByValue 667 8 24

==Examples of MapInfo Definitions==
A basic MapInfo lump may be similar to this:

[MAP01]
levelname = Evil Hell Lab
creator = DooMGuy667

[E1M1]
levelname = Not Hangar
creator = Not Romero
skyname = SKY3
skydelta = 1

The first example would change the automap and intermission screen names for MAP01 to "Evil Hell Lab" and when the <tt>creator</tt> command is used in the console, output "DooMGuy667". The name in the braces is the map the MapInfo applies to, so by changing <tt>[MAP01]</tt> to <tt>[MAP02]</tt>, the changes would apply to MAP02 instead.

The second example also sets a name and creator for the map (for the E1M1 mapslot, in this case), and also specifies that it will use SKY3 and scroll the sky slowly, using the skydelta variable.

[[Category:Editing]]