Console: Difference between revisions

From Eternity Wiki
Jump to navigationJump to search
(cat)
Line 33: Line 33:


An ellipsis (...) signifies that the command will accept any number of arguments and will amalgamate them into one continuous string.
An ellipsis (...) signifies that the command will accept any number of arguments and will amalgamate them into one continuous string.
=Lists=
=List of console commands=
*[[List of console commands]]
:''See [[List of console commands]]''
*[[List of console variables]]
=List of console variables=
:''See [[List of console variables]]''


=Constants=
=Constants=

Revision as of 11:48, 3 March 2012

This reference contains information on useful console commands and variables that work with the Eternity console, as well as pointers on console command syntax.

Notes on Special Command Syntax

Commands which take parameters may accept numbers, strings, or members of a predefined set of values.

 ex:
 $ delay 50
 $ spawn 249 1
 $ name Quasar
 $ hu_overlay distributed

If string arguments contain whitespace, they must be in quotations. Quotations around strings are otherwise optional.

 ex:
 $ echo "This has to be in quotes"
 $ i_error "R_FindVisplane: no more visplanes!"

Multiple commands can be run from one prompt by separating them with a semicolon.

 ex:
 $ delay; kill

Variables of type integer, named-value, on / off, and yes / no can be affected by the following operators:

  • +
Affixed to the end of the variable, it will increment it to the next valid value, but no higher than the maximum allowed.
   ex:
   $ screensize +
   
  • -
Affixed to the end of the variable, it will decrement it to the next lower valid value, but no lower than the minimum allowed.
   ex:
   $ screensize -
   
  • /
Toggles through the variable values from minimum to maximum, wrapping around to the minimum value again when it is maxed out. This is most useful with two-state yes/no and on/off variables.
   ex:
   $ hu_overlay /

Notes on Notation

In the list below, command arguments enclosed in brackets are optional. Commands typically have some default behavior when the arguments they expect are not provided, although this is often to simply print usage information.

An ellipsis (...) signifies that the command will accept any number of arguments and will amalgamate them into one continuous string.

List of console commands

See List of console commands

List of console variables

See List of console variables

Constants

These values are constant in that they are read-only and cannot be modified by the user.

Console basics

  • version
Version of the running Eternity build.
  • ver_date
Release date of Eternity.
  • ver_time
Release time of Eternity.
  • ver_name
Special name of the version.
  • creator
Name of the current map's author if one was provided.

Game functions

  • rngseed
Current value of the random seed.

Commands

Console commands carry out a particular action when sent to the console.

Console basics

  • alias name "command"
Creates "name" as an alias of the command string. The command string must not contain the alias as a command.
  • cmdlist
Lists all available console commands.
  • echo "string" ...
Repeats the concatenation of all string arguments as a console message.
  • delay tics
Causes console command interpretation to delay for the specified number of gametics (1/35 second).
  • flood
Floods the console with garbage. Debug command.
  • quote
Displays a random IRC quote. Known internally as "the most useful command."
  • dumplog filename
Dumps the current contents of the console back buffer to the given file as plain text.
  • openlog filename
Begins interactive logging of all console messages to the given file as plain text.
  • closelog
Closes any currently open log file created by the openlog command.
  • cvarhelp varname
Given a console variable name, this will display all possible values for that variable.
  • dir
Lists the contents of Eternity's directory.

Small Scripting (deprecated)

  • sm_running
  • sm_execv
  • sm_execi

Netgame

  • playerinfo
Displays name information for all connected players.

EDF and ExtraData

  • e_dumpthings
Displays all EDF thingtype mnemonics and numeric key information.
  • e_thingtype thingtypename
Displays extended information on a given EDF thingtype.
  • e_dumpmeta thingtypename
Displays all metatable fields and their values for the given EDF thingtype.
  • e_dumpitems
Displays all EDF thingtype mnemonics which belong to collectable items.
  • e_playsound soundname
Plays the given EDF sound definition from the console on a global sound channel.
  • e_listmapthings
Dumps a list of all ExtraData mapthing definitions to the console.
  • e_mapthing number
Dumps extended information on the given ExtraData mapthing record to the console.
  • e_listlinedefs
Dumps a list of all ExtraData linedef definitions to the console.
  • e_linedef number
Dumps extended information on the given ExtraData linedef record to the console.

Key bindings

  • bind key "commandoraction"
Binds the command or action string in the third parameter to the named key. If given only a key name, this command will display the actions currently bound to that key.
  • listactions
Lists all available built-in key actions.
  • listkeys
Lists all available keys to which commands and actions may be bound. Includes mouse and gamepad buttons.
  • unbind key (class)
Given a key name, this command will unbind all actions from the given key. Given a key and a class number, only the action of that particular class will be unbound. Key action classes may be seen using the bind or bindings commands.
  • unbindall
Unbinds all dynamic key bindings. Use with extreme caution!
  • bindings
Displays all dynamic key bindings.

Internal debug functions

  • i_error "message"
Causes an internal error, for testing purposes only. The game will exit with the given message.
  • z_print
Prints the contents of the zone heap to a heap.txt file in Eternity's working directory.
  • z_dumpcore
Dumps the entire contents of the zone heap to a binary file. Disabled in the official build.

Game functions

  • starttitle
Begins the demo screen loop from the titlescreen.
  • endgame
Ends any current game and enters fullscreen console mode.
  • pause
Pauses the game.
  • quit
Causes Eternity to exit. A sound may be played first in Doom or Doom II.
  • animshot <numframes>
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.
  • screenshot
Takes a screenshot in the currently selected format which will be placed in the base/shots folder.
  • playdemo lumpname
Plays the given demo.
  • stopdemo
Stops any demo currently playing.
  • timedemo lumpname
Plays the given demo for profiling purposes.
  • addfile wadfilename
Adds the given wad file at runtime.
  • listwads
Lists all currently loaded wad files.
  • puke
  • enable_lightning
Turns on the global lightning/thunder engine otherwise only available via MapInfo.
  • thunder
Causes a lightning strike to occur if the lightning/thunder engine is enabled on the current level.

Deathmatch flags

  • defdmflags

Sound

  • s_playmusic musicname
Plays the given music.

Frag counter

  • frags

System

  • i_joystick

Video

  • i_default_videomode

Cheating

  • infammo
Enables infinite ammo.
  • noclip
Enables no-clipping mode.
  • god
Enables god mode.
  • nuke
Kills all monsters.
  • summon thingtypename (flags) (mode)
Summons an mobj in front of the player of the given EDF thingtype. BEX flags may be optionally specified as a second parameter and by default these flags will be added to the normal flags of the thingtype. If the words "set" or "remove" are provided as the optional third parameter, the listed flags will instead be set or removed to/from the thingtype respectively.
  • viles
Only available in DOOM II. Activates Arch-Vile mode.
  • give thingtype num
Gives the player "num" amount of a collectable item of the given EDF thingtype. The thingtype must be a collectable item or nothing will happen. If the player cannot collect the items, they will be removed immediately.
  • whistle thingtypename
Teleports a semi-random friend of the given EDF thingtype in front of the player, if there is a living friendly thing of that type anywhere on the map, and it can fit at the current location.
  • mdk
Fires an instant-kill tracer from the player.
  • mdkbomb
Fires 40 instant-kill tracers in a circle from the player.
  • banish
Fires a tracer which can remove objects from the game.
  • resurrect
Respawns the player at the point of death with all inventory intact, even in a single-player game. Any solid objects on top of the player will be telefragged.
  • spacejump
Causes player 1 to jump, and can be done repeatedly even in midair. This command is not available during netgames or while recording demos.

Menus

  • mn_dynamenu menuname
Starts the given dynamic menu.
  • mn_clearmenus
Clears any active menu and returns to the game.
  • mn_prevmenu
Backs up one menu. If there is no previous menu, the menu system is exited.
  • mn_newgame
Stars the default New Game menu.
  • mn_quit
Asks the player if he/she wishes to quit the current game, if one is in progress.
  • mn_episode
  • newgame
  • mn_demos
  • mn_loadwad
  • mn_loadwaditem
  • mn_gset
  • mn_player
  • mn_loadgame
  • mn_load
  • quickload
  • mn_savegame
  • quicksave
  • mn_options
  • mn_endgame
  • mn_vidmode
  • mn_video
  • mn_particle
  • mn_sound
  • mn_mouse
  • mn_joysticks
  • mn_joymenu
  • mn_hud
  • mn_status
  • mn_automap
  • mn_weapons
  • mn_compat
  • mn_enemies
  • mn_movekeys
  • mn_advkeys
  • mn_weaponkeys
  • mn_envkeys
  • mn_gamefuncs
  • mn_menukeys
  • mn_automapkeys
  • mn_consolekeys
  • mn_search
  • mn_menus
  • mn_config
  • skinviewer
  • mn_old_options
  • mn_old_sound
  • mn_selectwad
  • mn_selectmusic
  • mn_selectflat
  • mn_hnewgame
  • mn_hepis
  • help
  • credits

Skins

  • listskins

Variables

Console basics

  • c_height
Console height.
  • c_speed
Console speed.

Automap

  • am_drawnodelines
  • mapcolor_back
  • mapcolor_grid
  • mapcolor_wall
  • mapcolor_fchg
  • mapcolor_cchg
  • mapcolor_clsd
  • mapcolor_rkey
  • mapcolor_bkey
  • mapcolor_ykey
  • mapcolor_rdor
  • mapcolor_bdor
  • mapcolor_ydor
  • mapcolor_tele
  • mapcolor_secr
  • mapcolor_exit
  • mapcolor_unsn
  • mapcolor_flat
  • mapcolor_sprt
  • mapcolor_hair
  • mapcolor_sngl
  • mapcolor_frnd
  • mapcolor_prtl
  • mapcolor_overlay

Game functions

  • draw_particles
  • bloodsplattype
  • bulletpufftype
  • rocket_trails
  • grenade_trails
  • bfg_cloud
  • alwaysmlook
  • invertmouse
  • sens_horiz
  • sens_vert
  • sens_combined
  • doom_weapon_toggles
  • turbo
  • cooldemo
  • shot_type
  • shot_gamma
  • textmode_startup
  • demo_insurance
  • smooth_turning
  • mouse_accel
  • mouse_novert
  • map_coords
  • numhelpers
  • startonnewmap
  • autorun
  • runiswalk
  • iwad_doom_shareware
  • iwad_doom
  • iwad_ultimate_doom
  • iwad_doom2
  • iwad_tnt
  • iwad_plutonia
  • iwad_heretic_shareware
  • iwad_heretic
  • iwad_heretic_sosr
  • use_doom_config
  • spechits_emulation
  • donut_emulation
  • p_markunknowns
  • wipewait
  • wipetype
  • show_scores
  • use_startmap

Heads-up display

  • hu_overlay
  • hu_hidesecrets
  • hu_obituaries
  • hu_obitcolor
  • hu_crosshair
  • hu_crosshair_hilite
  • hu_showvpo
  • hu_vpo_threshold
  • hu_messages
  • hu_messagecolor
  • hu_messagelines
  • hu_messagescroll
  • hu_messagetime
  • hu_showtime
  • hu_showcoords
  • hu_timecolor
  • hu_levelnamecolor
  • hu_coordscolor

Sound

  • snd_card
  • mus_card
  • detect_voices
  • snd_spcpreamp
  • snd_spcbassboost
  • s_precache
  • s_pitched
  • snd_channels
  • sfx_volume
  • music_volume
  • s_flippan

System

  • i_gamespeed
  • i_ledsoff
  • i_waitatexit
  • i_showendoom
  • i_endoomdelay
  • i_grabmouse
  • i_videomode
  • i_usemouse
  • i_usejoystick
  • joysens_x
  • joysens_y

Video

  • v_diskicon
  • v_retrace
  • v_ticker

Menus

  • mn_toggleisback
  • mn_background
  • mn_start_mapname
  • mn_demoname
  • mn_wadname
  • startlevel
  • mn_searchstr
  • use_traditional_menu
  • mn_classic_menus
  • wad_directory

Cameras

  • chasecam
  • chasecam_height
  • chasecam_dist
  • chasecam_speed
  • walkcam

Rendering

  • r_fov
  • r_showrefused
  • gamma
  • lefthanded
  • r_blockmap
  • r_homflash
  • r_planeview
  • r_precache
  • r_showgun
  • r_showhom
  • r_stretchsky
  • r_swirl
  • r_trans
  • r_tranpct
  • screensize
  • r_ptcltrans
  • r_columnengine
  • r_spanengine
  • r_detail
  • r_vissprite
  • r_tlstyle

Status bar

  • ammo_red
  • ammo_yellow
  • health_red
  • health_yellow
  • health_green
  • armor_red
  • armor_yellow
  • armor_green
  • st_graypct
  • st_rednum
  • st_singlekey

Network commands

  • exitlevel
  • kill
  • map
  • say

Network variables

Game functions

  • bobbing
  • name
  • dogjumping
  • colour
  • gametype
  • skill
  • allowmlook
  • bfgtype
  • autoaim
  • recoil
  • pushers
  • varfriction
  • nukage
  • weapspeed
  • bfglook
  • timelimit
  • fraglimit
  • fast
  • nomonsters
  • respawn
  • mon_remember
  • mon_infight
  • mon_backing
  • mon_avoid
  • mon_friction
  • mon_climb
  • mon_helpfriends
  • mon_distfriend

Skins

  • skin

Deathmatch flags

  • dmflags