CCMDs - Revision history

Dark Pulse: /* Examples */ mouse_sensitivity was split into m_sensitivty_x and m_sensitivity_y variables as of GZDoom 4.5.0, so the zoom example no longer worked. Updated with one that does. (Kept the old one for historical purposes.)

2021-05-31T20:18:34Z

Examples: mouse_sensitivity was split into m_sensitivty_x and m_sensitivity_y variables as of GZDoom 4.5.0, so the zoom example no longer worked. Updated with one that does. (Kept the old one for historical purposes.)

← Older revision		Revision as of 20:18, 31 May 2021
Line 111:		Line 111:

	===Examples===		===Examples===
	This is an example of a custom zoom that allows the player to toggle between a zoom and normal view with a single button.		This is an example of a custom zoom that allows the player to toggle between a zoom and normal view with a single button. This example works in all versions of ZDoom, and GZDoom prior to 4.5.0:
	alias zoomout "fov 90; eval * $mouse_sensitivity 4.5 mouse_sensitivity; rebind zoomin"		alias zoomout "fov 90; eval * $mouse_sensitivity 4.5 mouse_sensitivity; rebind zoomin"
	alias zoomin "fov 20; eval / $mouse_sensitivity 4.5 mouse_sensitivity; rebind zoomout"		alias zoomin "fov 20; eval / $mouse_sensitivity 4.5 mouse_sensitivity; rebind zoomout"
			bind F zoomin

			For a version that works in GZDoom 4.5.0 or later, this version must be used, as the mouse sensitivity was split into separate X and Y variables:
			alias zoomout "fov 90; eval * $m_sensitivity_x 4.5 m_sensitivity_x; eval * $m_sensitivity_y 4.5 m_sensitivity_y; rebind zoomin"
			alias zoomin "fov 20; eval / $m_sensitivity_x 4.5 m_sensitivity_x; eval / $m_sensitivity_y 4.5 m_sensitivity_y; rebind zoomout"
	bind F zoomin		bind F zoomin

Leonard: /* Console functions */

2014-08-13T00:35:20Z

Console functions

← Older revision		Revision as of 00:35, 13 August 2014
Line 61:		Line 61:
	:Creates a new command called ''command name'' which executes all instructions in ''string of commands''. Individual commands in an alias should be separated by semicolons (;). As an example, this alias will print a useless message and cause the player to jump:		:Creates a new command called ''command name'' which executes all instructions in ''string of commands''. Individual commands in an alias should be separated by semicolons (;). As an example, this alias will print a useless message and cause the player to jump:
	::<pre> alias Yay "echo Yippee!; +jump; -jump"</pre>		::<pre> alias Yay "echo Yippee!; +jump; -jump"</pre>
			:Note that you can input information in aliases by using the percent symbol (%). "%n" will refer to the nth string separated by spaces by the user. "%0" returns the name of the alias itself.
	:Any command that can be entered at the console can be used in an alias. As such, aliases can become powerful tools in the hands of a user with some imagination and knowledge of the various commands available. Alias is one of the commands that can be used in a [[KEYCONF]] lump.		:Any command that can be entered at the console can be used in an alias. As such, aliases can become powerful tools in the hands of a user with some imagination and knowledge of the various commands available. Alias is one of the commands that can be used in a [[KEYCONF]] lump.
	* '''{{LE\|eval}}''' <expression> [variable]		* '''{{LE\|eval}}''' <expression> [variable]

Gez: /* Console functions */

2013-07-14T17:00:34Z

Console functions

← Older revision		Revision as of 17:00, 14 July 2013
Line 58:		Line 58:
	The alias, eval and test commands are powerful functions that can be used to perform various calculations and then either display the results to the console or store them in a variable, as well as create scripted console macros.		The alias, eval and test commands are powerful functions that can be used to perform various calculations and then either display the results to the console or store them in a variable, as well as create scripted console macros.

	* '''{{LE\|alias}}''' <command name> [string of commands]		* '''{{LE\|alias\|Using aliases}}''' <command name> [string of commands]
	:Creates a new command called ''command name'' which executes all instructions in ''string of commands''. Individual commands in an alias should be separated by semicolons (;). As an example, this alias will print a useless message and cause the player to jump:		:Creates a new command called ''command name'' which executes all instructions in ''string of commands''. Individual commands in an alias should be separated by semicolons (;). As an example, this alias will print a useless message and cause the player to jump:
	::<pre> alias Yay "echo Yippee!; +jump; -jump"</pre>		::<pre> alias Yay "echo Yippee!; +jump; -jump"</pre>

Gez: consolidated alias, eval, and test together as they should be on the same page

2013-02-03T17:32:36Z

consolidated alias, eval, and test together as they should be on the same page

@@ Line 29: / Line 29: @@
 Example of autoexec.cfg file for creating a logfile:
  logfile log.txt
 ==Button commands==
@@ Line 78: / Line 54: @@
 Then instead of binding +forward to a key, you bind go to the key instead. This works because go does not begin with a + so nothing will happen when you release the key.  ZDoom only looks at the command actually bound to the key to determine if it should execute a - command when the key is released; it does not look inside aliases.
 [[category:ZDoom console]]

Gez: /* AutoExec */

2013-01-02T23:53:44Z

AutoExec

← Older revision		Revision as of 23:53, 2 January 2013
Line 23:		Line 23:

	==AutoExec==		==AutoExec==
	A series of console commands can be run automatically at startup from a file. The path and name of the file must be given in the ZDoom ~~ini~~ file, in one of the <tt>[<Game>.AutoExec]</tt> sections. By default, ZDoom will look for a file named '''autoexec.cfg''' for all games.		A series of console commands can be run automatically at startup from a file. The path and name of the file must be given in the ZDoom [[configuration file]], in one of the <tt>[<Game>.AutoExec]</tt> sections. By default, ZDoom will look for a file named '''autoexec.cfg''' for all games.

	Auto-execution of console commands is especially useful for the [[CCMDs:Informational#logfile\|logfile]] command as it allows then to save to the log file messages that are printed before the console becomes available. This makes it easier to detect and report bugs or other problems that prevent the game from starting normally.		Auto-execution of console commands is especially useful for the [[CCMDs:Informational#logfile\|logfile]] command as it allows then to save to the log file messages that are printed before the console becomes available. This makes it easier to detect and report bugs or other problems that prevent the game from starting normally.

Gez: /* Categories */ Added new category for commands that don't really fit in any of the existing pages

2011-10-03T17:51:24Z

Categories: Added new category for commands that don't really fit in any of the existing pages

← Older revision		Revision as of 17:51, 3 October 2011
Line 9:		Line 9:
	* [[CCMDs:Multiplayer\|Multiplayer]]		* [[CCMDs:Multiplayer\|Multiplayer]]
	* [[CCMDs:Control\|Player control]]		* [[CCMDs:Control\|Player control]]
			* [[CCMDs:Other\|Other commands]]

	==Usage==		==Usage==

Gez: /* AutoExec */

2010-03-28T12:27:27Z

AutoExec

← Older revision		Revision as of 12:27, 28 March 2010
Line 25:		Line 25:

	Auto-execution of console commands is especially useful for the [[CCMDs:Informational#logfile\|logfile]] command as it allows then to save to the log file messages that are printed before the console becomes available. This makes it easier to detect and report bugs or other problems that prevent the game from starting normally.		Auto-execution of console commands is especially useful for the [[CCMDs:Informational#logfile\|logfile]] command as it allows then to save to the log file messages that are printed before the console becomes available. This makes it easier to detect and report bugs or other problems that prevent the game from starting normally.

			Example of autoexec.cfg file for creating a logfile:
			logfile log.txt

	==Using aliases==		==Using aliases==

Gez: AutoExec

2010-03-28T12:26:18Z

AutoExec

← Older revision		Revision as of 12:26, 28 March 2010
Line 21:		Line 21:
	zdoom.exe -iwad doom2.wad -warp 01 '''+freeze'''		zdoom.exe -iwad doom2.wad -warp 01 '''+freeze'''

	==~~Using Aliases~~==		==AutoExec==
			A series of console commands can be run automatically at startup from a file. The path and name of the file must be given in the ZDoom ini file, in one of the <tt>[<Game>.AutoExec]</tt> sections. By default, ZDoom will look for a file named '''autoexec.cfg''' for all games.

			Auto-execution of console commands is especially useful for the [[CCMDs:Informational#logfile\|logfile]] command as it allows then to save to the log file messages that are printed before the console becomes available. This makes it easier to detect and report bugs or other problems that prevent the game from starting normally.

			==Using aliases==
	ZDoom supports the ability to create command "macros" called Aliases by using the alias CCMD at the console or in the [[KEYCONF]] lump. The alias command is used as followed:		ZDoom supports the ability to create command "macros" called Aliases by using the alias CCMD at the console or in the [[KEYCONF]] lump. The alias command is used as followed:

Line 45:		Line 50:
	Bind a key or mouse button to "+mslook" to begin the toggle bind. You will notice that when the key is pressed, the game will toggle between mouse-look being on and mouse-look being off.		Bind a key or mouse button to "+mslook" to begin the toggle bind. You will notice that when the key is pressed, the game will toggle between mouse-look being on and mouse-look being off.

	==Button ~~Commands~~==		==Button commands==
	Button commands are commands that represent buttons and come in pairs. Each "button" has a command prefixed by a + and another corresponding command prefixed by a -. The + version of the command simulates pushing the button (Or "turning on" the command), while the - version of the command simulates releasing the button ("Turning off" the command).		Button commands are commands that represent buttons and come in pairs. Each "button" has a command prefixed by a + and another corresponding command prefixed by a -. The + version of the command simulates pushing the button (Or "turning on" the command), while the - version of the command simulates releasing the button ("Turning off" the command).

Gez at 11:47, 28 March 2010

2010-03-28T11:47:47Z

← Older revision		Revision as of 11:47, 28 March 2010
Line 1:		Line 1:
	Console commands (CCMDs) are instructions entered at the [[console]] that can be used to cause an immediate effect within ZDoom.		Console commands (CCMDs) are instructions entered at the [[console]] that can be used to cause an immediate effect within ZDoom.


	__TOC__		__TOC__
		⚫	==Categories==
		⚫	To make finding specific commands easier, the wiki separates the available commands into several categories:
		⚫	* [[CCMDs:Customization\|Customization]]
		⚫	* [[CCMDs:Debug\|Debugging/Cheating]]
		⚫	* [[CCMDs:Informational\|Informational]]
		⚫	* [[CCMDs:Multiplayer\|Multiplayer]]
		⚫	* [[CCMDs:Control\|Player control]]

	==Usage==		==Usage==

	You can execute CCMDs in the ZDoom [[console]], accessed by pressing the tilde (~) key by default. Most commands need only be entered as shown to take effect, while others have one or more parameters (either required or optional) that are typed after the command, separated by a space. For example, to exit the game from the console, you can simply type "exit". However, if you want to bind the X key to +crouch, you must enter these as parameters in the console:		You can execute CCMDs in the ZDoom [[console]], accessed by pressing the tilde (~) key by default. Most commands need only be entered as shown to take effect, while others have one or more parameters (either required or optional) that are typed after the command, separated by a space. For example, to exit the game from the console, you can simply type "exit". However, if you want to bind the X key to +crouch, you must enter these as parameters in the console:

Line 17:		Line 22:

	==Using Aliases==		==Using Aliases==

	ZDoom supports the ability to create command "macros" called Aliases by using the alias CCMD at the console or in the [[KEYCONF]] lump. The alias command is used as followed:		ZDoom supports the ability to create command "macros" called Aliases by using the alias CCMD at the console or in the [[KEYCONF]] lump. The alias command is used as followed:

Line 42:		Line 46:

	==Button Commands==		==Button Commands==

	Button commands are commands that represent buttons and come in pairs. Each "button" has a command prefixed by a + and another corresponding command prefixed by a -. The + version of the command simulates pushing the button (Or "turning on" the command), while the - version of the command simulates releasing the button ("Turning off" the command).		Button commands are commands that represent buttons and come in pairs. Each "button" has a command prefixed by a + and another corresponding command prefixed by a -. The + version of the command simulates pushing the button (Or "turning on" the command), while the - version of the command simulates releasing the button ("Turning off" the command).

Line 66:		Line 69:

	Then instead of binding +forward to a key, you bind go to the key instead. This works because go does not begin with a + so nothing will happen when you release the key. ZDoom only looks at the command actually bound to the key to determine if it should execute a - command when the key is released; it does not look inside aliases.		Then instead of binding +forward to a key, you bind go to the key instead. This works because go does not begin with a + so nothing will happen when you release the key. ZDoom only looks at the command actually bound to the key to determine if it should execute a - command when the key is released; it does not look inside aliases.

⚫	==Categories==

⚫	To make finding specific commands easier, the wiki separates the available commands into several categories:

⚫	* [[CCMDs:Customization\|Customization]]
⚫	* [[CCMDs:Debug\|Debugging/Cheating]]
⚫	* [[CCMDs:Informational\|Informational]]
⚫	* [[CCMDs:Multiplayer\|Multiplayer]]
⚫	* [[CCMDs:Control\|Player control]]

	[[category:ZDoom console]]		[[category:ZDoom console]]

Gez: Reverted edits by Iceberg (Talk) to last revision by Mac917

2009-07-21T18:58:48Z

Reverted edits by Iceberg (Talk) to last revision by Mac917

← Older revision		Revision as of 18:58, 21 July 2009
Line 40:		Line 40:

	Bind a key or mouse button to "+mslook" to begin the toggle bind. You will notice that when the key is pressed, the game will toggle between mouse-look being on and mouse-look being off.		Bind a key or mouse button to "+mslook" to begin the toggle bind. You will notice that when the key is pressed, the game will toggle between mouse-look being on and mouse-look being off.

	Alias codes can also be looped constantly, an example code will allow the player to switch between 2 different colors:

	alias m "color red;wait 40;color blue;wait 40;m"

	When the player presses m on the console and then enters it, the player will begin to change colors endlessly until he/she exits a level.

	==Button Commands==		==Button Commands==