View source for Scripting

'''Scripting''' is the use of configuration files (.cfg) to create new keybinds and aliases automating complex behaviors and [[console]] command sequences.

* Keybinds connect a key to a console command, such as choosing a [[weapon]] slot or saying pre-written text in chat.

* Aliases build new commands by executing a series of console commands whenever they are used. An alias might define [[crouch]]ing and [[jump]]ing as a single [[Jumping#Crouch-jumping|crouch-jump]] command, which can then be bound to a key.

These scripts range in complexity from simple lists of commands to self-referential loops and nested aliases that redefine one another. With enough time and effort, you can use these tools to create almost any behavior available to the client at the press of a single key.

==Basic scripting files==
''Team Fortress 2'' automatically reads several game files and executes any keybinds and aliases within them. Here is the list of those files:

* config.cfg - This is the default config file which the game edits whenever you use the in-game menus to bind keys or change video settings. While editing the file is safe, it's simpler to leave it alone.

* autoexec.cfg - This is the default config file for executing custom keybinds and aliases. You may put your keybinds directly into this file, but it is often easier to create separate .cfg files for different scripts, which you then execute within this file.

* <class>.cfg - Each class has a config file which automatically runs whenever you switch to that class. You may put your keybinds directly into this file, but it is often easier to create separate .cfg files for different scripts, which you then execute within these files.

==Syntax==
Here is a list of syntactic rules:

* For any keybind or alias to work, you need to follow this format:

:'''command <argument1> <argument2>'''

:* command is the kind of scripting you want.  You have three choices:

::* bind - Used to bind commands to a particular key.
::* alias - Used to execute commands when the alias is executed.
::* exec - Used to execute commands automatically when a configuration file is loaded.

:* <argument1> is either the key being bound or the name of the alias being created.

:* <argument2> is either the command being bound or the commands executed by the alias.

*To run multiple commands, you must put the entire argument in quotation marks and separate the commands with semicolons, like so:

:'''alias "spraynpray" "+attack; wait 500; -attack"'''
:'''bind "mouse3" "spraynpray"

:*When executed, the alias starts firing the player's weapon, continues for 500 physics frames (that is roughly five seconds if you are on a server that runs at a 100 frames per second), and then stops firing. The alias is keybound to execute when you press the middle mouse button.
*To enclose something in quotes that already has quotes in it, you have to ''escape'' the internal quotes by using two consecutive quotes ("") in place of each one.
:'''alias "saysomestuff" "say ""Some Stuff..."""'''
:*When you type '''saysomestuff''' in the console, you will speak "Some Stuff..." in the chat. Without the internal quotes, the chat window will only show "Some".

==Keybinds==
''Team Fortress 2'' allows scripts and aliases to be bound to any key on the keyboard. The key you wish to bind a command to is placed after your bind command and before the action you want the key to execute, as in the section above. Most keys are self-explanatory, as all alphanumerics (a-z, 0-9) and function keys are simply listed by typing that key ("bind a" binds a key to 'a', "bind 5" binds to '5' and "bind F7" binds to 'F7'). Other keys require you type specific names into your .cfg file in order to access them, and these names are not all obvious. A list of these keys is provided below:

====List of key names====
* Keyboard Keys: Names of Keybinds 
* Left Shift: SHIFT
* Left Ctrl: CTRL
* Left Alt: ALT
* Right Shift: RSHIFT
* Right Control: RCTRL
* Right Alt: RALT
* Tab: TAB
* Backspace: BACKSPACE
* ---
* Insert: INS
* Scroll Lock: SCROLLLOCK
* Pause/Break: NUMLOCK
* ---
* Home: HOME
* End: END
* Delete: DEL
* Page Up: PGUP
* Page Down: PGDN
* ---
* Up Arrow: UPARROW
* Down Arrow: DOWNARROW
* Left Arrow: LEFTARROW
* Right Arrow: RIGHTARROW
* Numpad Keys: Names of Keybinds
* 0: KP_INS 
* 1: KP_END 
* 2: KP_DOWNARROW 
* 3: KP_PGDN
* 4: KP_LEFTARROW 
* 5: KP_5 
* 6: KP_RIGHTARROW 
* 7: KP_HOME 
* 8: KP_UPARROW
* 9: KP_PGUP
* Enter: KP_ENTER 
* ".": KP_DEL  
* "+": KP_PLUS 
* "-": KP_MINUS 
* "*": KP_MULTIPLY 
* "/":KP_SLASH 
* Mouse Wheel Direction: Names of Keybinds
* Mouse Wheel Up: MWHEELUP
* Mouse Wheel Down: MWHEELDOWN

Using the above keynames, you are able to place the following example command into one of your config files: <bind KP_ENTER "voicemenu 0 1">. When you hit 'Enter' on your numpad in-game, you will trigger the "Thanks" voice command.

==Basic commands==
Most commands accept a single argument, which is whatever value you want to execute.

'''bind "q" "sv_alltalk 1"'''

A handful of important commands accept multiple arguments. Here are some examples:

* disguise X Y - This [[disguise]]s the [[Spy]]. X is the class numbered 1 through 9, while Y is the team numbered 1 or 2.

* voicemenu X Y - This executes a voice command. X is the number of the primary menu, while Y is the command position in that menu.

Example: "voicemenu 1 1" is the command for Spy, so:

'''bind "t" "voicemenu 1 1"'''

This command will make your character yell Spy whenever you hit the key.

==Incrementvar==
This command cycles through a range of specified values whenever it executes and applies those values to another command. This has the form of:

:'''command "<argument1>" "incrementvar <argument2> X Y Z"'''

:*X and Y represent the range of values you want to execute with <argument2>.
:*Z is the size of the step you want to make while you cycle through the range.

If you wanted a value range of 1 through 10 and you wanted to increment your value by 2 each time the command was executed, you'd make X Y Z into 1 10 2. Each time it executes, <argument2> will execute with an incrementing value of 2, 4, 6, 8, 10, 2, 4, 6, 8, 10... and so forth.

Here is a real example of incrementvar in action:

:'''bind "n" "incrementvar net_graphpos 1 3 1"'''

This binds the key "n" to cycle to the next position in the 3 available net_graph positions.

==The + and - commands==
These commands have two states. While the bound key is pressed, the '''+''' command executes and continues to execute. When the key is released, the '''-''' command executes and continues to execute.

Example:
:'''bind "c" "+duck"

This + command is bound to "c" so whenever the key is pressed, the player ducks. Whenever the key is released, "+duck" is swapped to "-duck" and the player stops ducking.

In general, if a command or alias is bound to a key, a + tells the game to run the command as long as the key is held. Similarly, if a command or alias is bound to a key, a - tells the game to run the command when the key is released.

If an alias is defined with a + in front of it, the alias will be run whenever the key is pressed, as the key is pressed. The - command will then run as the key is released.

==Wait command==
If you want the game to delay for a period of time during an alias, or if you want to avoid client crashes caused by executing commands too quickly, use the '''wait''' command.

The wait command tells the game to delay the next command in the script by one physics frame, something like a full turn in the TF2 rules. It accepts values such as "wait 50", telling the game to wait fifty frames before the alias continues. "wait 100" is roughly a second on a 100 FPS server.

Some servers disable the wait command. While playing on them, wait commands will be ignored, making some scripts susceptible to crashes. A script containing an indeterminate loop spaced by wait commands will always immediately hang upon usage on such servers.

==Aliases==
An '''alias''' is like a variable that stores a series of commands which can be executed as a group. A simple alias will take the form:

'''alias "aliasname" "command1; command2; command3"'''

You can then execute the commands through a bound key:

'''bind "key" "aliasname"'''

Whenever the key is pressed, "command1", "command2", and "command3" are executed in order.

===Complex aliases===
Aliases can execute any command including other aliases. Furthermore, an alias can execute an alias in order to redefine that alias's commands. This allows you to create cycling aliases. Here is a very simple example:

'''bind "key" namescroll'''<br>
'''alias namescroll "firstname" '''<br>
'''alias firstname "setinfo name "First_name"; alias namescroll secondname" '''<br>
'''alias secondname "setinfo name "Second_name"; alias namescroll thirdname"'''<br>
'''alias thirdname "setinfo name "Third-name"; alias namescroll firstname"'''<br>

This is difficult to read, so to break it down.

*The first line binds "key" to an alias "namescroll" which we have yet to define.
*The second line creates the alias "namescroll" which executes the command "firstname"
*The third line defines the "firstname" alias as two commands:
:*The first command sets your in-game name to "First_name"
:*The second command redefines the alias "namescroll" as an alias for executing the alias "secondname"
*The fourth line defines "secondname" in the same manner.  A different in-game name is set, and then "namescroll" is redefined to another alias "thirdname"
*The fifth line defines "thirdname" just like the two before it, but with a twist.  It redefines the "namescroll" alias as executing the "firstname" alias.

This completes a loop. Each press of the key executes a command and redefines the alias bound to the key, so that when it is next pressed it will execute a different command. If there were no loop, then the alias "namescroll" wouldn't always have another alias to execute with each keypress.

===Alias loops===
Aliases can be used in conjunction with the wait command to create looping aliases.<br>
 	
''Warning:Not having the wait in place, or being on a server with wait disabled will cause this example to crash TF2.''<br>
'''alias "Loop" "echo Looping every 150 ticks.;wait 150;Loop"'''<br>
'''Loop'''<br>

Lets break this down into components:<br>
Line 1<br>
The echo displays a message to the console, just so you know it works.<br>
The wait makes it wait 150 ticks between iterations<br>
Loop calls the alias again, restarting at the echo.<br>
<br>
Line 2<br>
Loop starts the looping alias.<br>

You can also create loops of alias commands, like this example:<br>
 '''alias "Loop1" "echo Loop 1;wait 150;Loop2"'''<br>
 '''alias "Loop2" "echo Loop 2;wait 150;Loop1"'''<br>

Loop1 calls Loop2 which in turn calls Loop1, etc...<br>
This method can also be used for breaking a loop without clearing the loop alias:<br>
 '''alias "Loop1" "echo Loop1;wait 150;Loop2"'''<br>
 '''alias "Loop2" "Loop1"'''<br>
This would create a loop, then<br>
 '''alias "Loop2"'''<br>
would break it, by clearing the Loop2 alias.<br>

You can use these for button presses(Via the +/- prefixes covered earlier) like this:<br>
 '''alias "Loop2" "Loop1"'''<br>
 '''alias "Loop1" "echo Loop1;wait 150;Loop2"'''<br>
 '''alias "+Loop" "alias Loop2 Loop1;Loop2"'''<br>
 '''alias "-Loop" "alias Loop2"'''<br>
 '''bind "<Key>" "+Loop"'''<br>
In order of what it's doing:<br>
Make Loop2 point to Loop1<br>
Make Loop1 echo 'Loop1' to the console, wait 150, then call Loop2<br>
make +Loop point Loop2 to Loop1 and run Loop2<br>
make -Loop clear Loop2's link, breaking the loop<br>

== Useful script commands ==
There are literally hundreds of different arguments for your script that can make them do almost anything. Here's a list of a few of them.

===Voice commands===
A '''voice command''' is the act of making your class say something, often used in gameplay as a way of either signaling information or just for goofing-off.

Voice commands are used with the following syntax;

'''voicemenu <menu_number> <phrase_number>

Where <menu_number> is the one of the 3 menus where voice commands are spread out through <phrase_number> is one of the 7 voice commands that are within each <menu_number> menu.

====Arguments for voice commands====
*0 <phrase_number>
*:0: Medic
*:1: Thanks
*:2: Go
*:3: Move Up
*:4: Flank Left
*:5: Flank Right
*:6: Yes
*:7: No
*1 <phrase_number>
*:0: Incoming
*:1: Cloaked Spy
*:2: Sentry Ahead
*:3: Teleporter Here
*:4: Dispenser Here
*:5: Sentry Here
*:6: Activate ÜberCharge
*:7: (Medic Only) ÜberCharge Ready
*2 <phrase_number>
*:0: Help
*:1: Battlecry
*:2: Cheers
*:3: Jeers
*:4: Positive
*:5: Negative
*:6: Nice Shot
*:7: Good Job

===Quick Spy disguises===
With these quick and easy commands, you can bind keys to specific disguises instead of having to flip through the disguise menu.

Disguise commands are used with the following syntax:

'''disguise <class_number> <team_number>

Where <class_number> is the number of the class you wish to disguise as, and <team_number> the number of the team you wish to disguise as.

====Arguments for disguise commands====
*1 <class_number>
*:1: Scout
*:2: Sniper
*:3: Soldier
*:4: Demoman
*:5: Medic
*:6: Heavy
*:7: Pyro
*:8: Spy
*:9: Engineer

*2 <team_number>
*:1: BLU team
*:2: RED team
*:-1: Opposite team
*:-2: Same team

===Engineer quickbuilding===
Similar to the [[Spy]]'s quick disguise, this allows the [[Engineer]] to bypass his [[PDA]] interface and instantly destroy an existing building type, while simultaneously pulling up blueprints to place a new building of the same type.  

Building commands are used with the following syntax:

'''build <building_number><br>
'''destroy <building number>

Where <building_number> is the number of the building you wish to destroy or pull up blueprints for.

====Arguments for building commands====
*Number: Building/Destroying
*:0: Dispenser
*:1: Teleporter Entrance
*:2: Sentry Gun/Minisentry
*:3: Teleporter Exit

An example of how to implement the above syntax is as follows:

<pre>
alias sentry "destroy 2; build 2"
alias dispenser "destroy 0; build 0"
alias entrance "destroy 1; build 1"
alias exit "destroy 3; build 3"
bind f1 sentry
bind f2 dispenser
bind f3 entrance
bind f4 exit
</pre>

In this example, buildings are bound to the F1-F4 keys so that they do not interfere with weapon selection keys. When activated, the script will instantly and irreversibly destroy an existing building of the listed type, while pulling up the [[Engineer]]'s blueprints of the destroyed building's same type, ready to deploy. This script will still function if only one or two building types are used (in case you only want to map Sentry quickbuilding to a single key).

===Medic autocall===
The player can control the Medic's autocall threshold through keybinds. The command is:

'''hud_medicautocallersthreshold <percentage>

The percentage is the percent health below which the autocall is triggered; 0 will show nothing, while 150 will show all nearby allies (since 150% is the maximum possible health).

This command can be used to make the popular "Medic Radar" script:
This set of aliases and commands will temporarily boost the [[Medic]]'s autocall threshold to 150% (a fully overhealed player) for as long as they hold a key down, allowing the player to see where all of their teammates are by their [[Medic]] autocall speech bubbles in the event they find themselves alone.

  '''alias "autocall_default" "hud_medicautocallersthreshold "75""<br>
  '''alias "autocall_all" "hud_medicautocallersthreshold "150""<br>
  '''alias "+radar" "autocall_all"<br>
  '''alias "-radar" "autocall_default"<br>
  '''bind mouse3 "+radar"<br>

The default autocall value, or the autocall threshold when this command is not in use, can be adjusted to any desired number (in the example it is listed as 75% health) and the keybind to activate it can be changed as well (the example is bound to MOUSE3).

==Noteworthy scripts== 
There are several notable scripts that have affected gameplay. Some of these are patched out, while others remain functional.

===Patched scripts===
====Pistol scripts====
Originally, the [[Pistol]] could be fired almost as fast as the human hand could press a key. Realizing this, some people created scripts that made the Pistol fire as rapidly as possible as long as you held down the fire button. This not only allowed the [[Scout]] and [[Engineer]] to fire faster than most people could manage, but it was easier to aim because you weren't mashing any keys.

Valve eventually leveled the playing field. They patched the Pistol to have a lower max firing rate, which was reached by default whenever a player held down the attack key. The Pistol scripts were no longer necessary.

====Targe turn scripts====
Originally, the keyboard commands to turn your viewpoint left and right were not treated the same as the mouse commands. The [[Chargin' Targe]] was the first weapon to create a restriction on how quickly you could turn your viewpoint, therefore Valve put a limit on mouse turn-speed, yet forgot to apply the same restriction to the keyboard command that resulted in the same action.

Players made scripts that rebound keys whenever a player charged, allowing them to turn at full speed. The most sophisticated examples temporarily rebound the mouse x-axis inputs to the keyboard turn commands, then unbound them when the player attacked at the end of the charge.

Valve eventually capped the keyboard turn commands as they did with the mouse commands, thus conferring no advantage to individuals who used the script.

However, it is still possible to write a script that will toggle sensitivity between extremely high values when charging and normal values when the player performs an attack. It is also possible to turn easily while using a gamepad's analog sticks.

====Air crouching scripts====
Originally, you could crouch as many times as you liked in a single jump. By binding a script to crouch and uncrouch as rapidly as possible, you could exploit the engine and make it difficult to properly register shots on jumping targets.

Valve patched it so you could only crouch twice in a single jump.

===Current scripts===
====Weapon hiding scripts====
There are a large number of scripts which toggle the weapon display option depending on which weapon slot is selected for a class. Players often make their guns invisible to clear up the screen, but make items like melee weapons, PDAs, watches, and so forth visible because these models indicate important information. For example, the [[Spy]] relies heavily on his visible model to determine when he is cloaked, when his cloak is disturbed, and when the [[Dead Ringer]] activates. Other classes use the melee animations to judge when their attacks will hit.

====Sentry jumping scripts====
Since the [[Engineer Update]], Engineers have been able to pack up and carry their [[Sentry Gun]]s. Simultaneously, the [[Wrangler]] allows Engineers to [[Sentry jump]] with their Sentry rockets. With extremely fast inputs, it was discovered that a player could Sentry jump and successfully pack up their Sentry before they were launched away.

While a human can repeat this feat, it is difficult. Some players made scripts which could reliably execute the commands in the right order at the right speed. They can make a Sentry jump while carrying their Sentry every time.

====Gunslinger scripts====
Since it can be troublesome to destroy then rebuild a [[Combat Mini-Sentry]] in the heat of battle through the PDA, some players have scripted the destruction and rebuilding of their Combat Mini-Sentry with the click of one or two mouse buttons.

====Sensitivity and Control scripts====
Some players prefer different mouse sensitivities and control schemes for some classes. (For example, changing from the Demoman, which doesn't require fine aiming, to the Sniper, which encourages low sensitivity for precise aiming so that a hand twitching inadvertently won't ruin your aim too much) These scripts alter their control schemes and mouse settings on a per class, or even per weapon, basis.

====Charge dash scripts====
Since timing the charge and jump can be difficult, some may use a quick script that binds the two actions to a button so that the charge dash will do the maximum amount of distance possible. The player is still required to swing their melee weapon normally to end the charge though.

====Quickscope scripts====
Many players find it difficult to scope in and fire right after to get a quick headshot. There are scripts that will zoom in and fire just by clicking one mouse button. It may be harder to aim for some people because you must aim outside of the scope, but it speeds up how fast you fire if you can aim well.

====Gloves of Running Urgently scripts====
While using the Gloves of Running Urgently, the player will constantly lose 6 health per second. However, jumping preserves the speed bonus granted by this weapon while the player is still in the air. Because of this, by jumping with this weapon, and then immediately switching to another weapon, health loss can be minimised with very little negative impact on speed. While a player can manually jump and continually switch weapons, using a script greatly simplifies this technique.

==See also==
* [[List of useful console commands]]
* [[Customizing#tf.5Ccfg.5Cconfig default.cfg|Customizing - config_default.cfg]]: The default key-binds within TF2.

==External links==
*[http://forums.steampowered.com/forums/showthread.php?t=709568 Steam Users' Forums - TF2 Scripting Tutorial]. This covers the basics of scripting, using numerous useful, approachable examples.
*[http://warriornation.net/Forum/showthread.php?t=568008 TF2 scripting tutorial - Warrior Nation Network]. This is a much more advanced article, which requires pre-requisite knowledge of the basic scripting syntax. 
*[http://www.gamebanana.com/scripts/games/297 Gamebanana.com - TF2 scripts]. Hundreds of scripting examples for TF2.

[[Category:Customization]]