Binds

From DDraceNetwork
Revision as of 01:45, 2 August 2021 by Tela (talk | contribs)

DDNet client has a multitude of commands and settings that can be bound to nearly any key or mouse button. You can enter commands into the console, which by default is accessed by pressing F1.

Syntax

Single binds

bind [key] [command/setting] [value]

This is the basic syntax for simple binds.

  • [key] is the key on your keyboard/mouse you want to bind a command to. You can find keycodes here, or just type the key temporarily into one of the controls in the Settings > Controls page in DDNet client and it will show the key name.
  • [command/setting] A full list of all commands and settings can be found here.
  • [value] is the variable you want to set your setting to or an argument for a command. Not all commands require arguments.

Multiple binds

You can also chain commands/settings together by separating them using a semicolon and wrapping them in quotes. You can add as many commands to this chain as you want.

bind [key] "[command/setting] [value]; [command/setting] [value]" 

Nested binds

You can nest multiple quoted strings in a single line by escaping each new set of quotes with backslashes.

bind [key] "bind [key] \"[command/setting] [value]; bind [key] \\\"[command/setting] [value] \\\"\""

As the quoted strings go deeper, you also need to escape the backslash. Since each new layer will again un-escape them, you need to double the amount of backslashes per layer. The third layer will require 3 backslashes, the 4th will require 7, etc. If this is confusing to look at, try making a new line for each escaped quote to get a more clear visual idea of what's happening.

bind [key] 
 "bind [key] 
  \"[command/setting] [value]; bind [key]
   \\\"[command/setting] [value]; bind [key] 
    \\\\\\\"[command/setting] [value]
    \\\\\\\"
   \\\"
  \"
 "

Client Commands

Toggles

Toggles are a way to use a single key to alternate between 2 values for a setting. There are two types of toggles.

  • toggle is used so that each time you press a key, it will change between one of the two values for the setting
  • +toggle is used so that your first value is set only while the key is being pressed, and the second value is set while the key is not being pressed.
bind [key] "toggle [setting] [value1] [value2]"
bind [key] "+toggle [setting] [value1] [value2]"

Toggles only work for client settings. They cannot be used for client or chat commands.

Say

Say is an important client command for binding. It allows you to incorporate chat commands into a bind as well as just send text to the chat.

bind [key] say /[chat command]
bind [key] say [chat message]

Exec

Exec is a useful client command for reading (executing) files which contain settings or commands

bind [key] exec [file]

Using Config Files

Syntax

For more complicated binds, you can make text files containing settings/commands that get executed via a key press.

settings.cfg
[command/setting] [value]
[command/setting] [value]
[command/setting] [value]; [command/setting] [value]
[command/setting] [value]; [command/setting] [value]
bind [key] [command/setting] [value]
bind [key] exec [file.cfg]

Settings/commands can be chained together via a semicolon or by just using a new line. You can put as many commands/settings/binds as you want in these files.

Path/Exec

In order to execute these files, you need to put them in correct directory and execute them with the 'exec' command. The correct path depends on your operating system.

Windows
%APPDATA%\Teeworlds\
MacOS
~/Library/Application\ Support/Teeworlds
Linux
~./Teeworlds

The standard file extension for these files is .cfg, but any other text file extension will work too. Once the files are in the correct path, you can execute them in the game console with the 'exec' command.

bind [key] exec [file.cfg]

You can use sub-directories within the 'Teeworlds' directory to organize files. Just include the path when you execute the file.

bind [key] exec [path/to/file.cfg]

Improved toggle with config files

The most common reason to use config files is to create a single-key toggle to alternate between two files.

file1.cfg
[command/setting] [value]
[command/setting] [value]
[command/setting] [value]
bind [key] exec [file2.cfg]

file2.cfg

[command/setting] [value]
[command/setting] [value]
[command/setting] [value]
bind [key] exec [file1.cfg]

In this case, [key] would be the same key in both files. This way each time you press the key, it will switch to the other file. Once you have both of these files in the correct path, you can exec either one just once and they will be bound forever until you unbind them.

Examples

See also