Key bindings

From Wurmpedia
Jump to: navigation, search

Main Page / Key bindings

Introduction

Game actions, toggles and chat or console commands may be bound to certain keys on the keyboard or buttons of a mouse to allow quick access to actions or commands. These may be modified via the launcher settings under the Keybindings tab. This page provides an overview of what each command does along with its alias for when setting manually via the console or in the textfile. See the topic advanced binding below for more information on manual changes. It's advisable to always use the launcher settings for creating binds as a warning is presented when duplicate assignments are chosen so that none are unexpectedly overwritten, unless the action is not available in the settings.

Default keybindings

These keybinds are set as default in the client but cannot be directly modified in the settings. Read the advanced section below for details on how to modify these.

Advanced key binding

There are more advanced methods to changing key binds and this section will attempt to explain these. Do not attempt to modify key bindings manually without an understanding of the pitfalls and advice below.

Overwriting a key bind may be done unintentionally and there is no undo, the original will have to be re-added.
Accidental binds on movement, camera or interface may cause undesired effects and could get the character into trouble, for example if movement keys are changed and they are attacked.
If in doubt, back-up the keybindings.txt file before making any changes via the console or in the file itself.

Console

To access the console press the default keybind of F1 to open the window. From here the BIND command may be used to assign keys to actions, chat or console commands.

Usage: bind <key> [<action>|"<command>"]

There are three types of action or command which can be assigned to a key bind. Action, console and chat.

Actions are the Bind type entries listed in the tables above, such as MINE_FORWARD or PRAY. These cannot be used stand-alone and normally reference right-click in-game context menu actions.
BIND UP MINE_FORWARD
Console commands are Console type entries such as "toggle console" and "screenshot". These must be added to the bind with the double quotes (") surrounding them. They may also be used stand-alone in the console without the quotations.
BIND F1 "toggle console"
Chat commands are Chat type entries, "say /time" or "say /sleep". These must also be added to the bind with double quotes and can be used in the chat window without the quotes and without the prefix say.
BIND F5 "/say sleep"

In-game wiki

The in-game wiki is an important tool for new players so this section describes how to re-bind the key should it ever become unbound. Open the console using the default F1, if this has been unbound check in the keybindings setting. Now enter the following to have it re-bound to H.

bind h "toggle wikisearch"

Now when the player hits H the wiki box will appear so that in-game searches may be made.

keybindings.txt

Editing the keybindings.txt file in the location specified under Keybindings source in the Game tab of the launcher settings will allow players to manually change, delete or add in, line by line, a list of keybindings as already discussed. They are entered the in the same method as they would be typed into the console. It's advisable that a backup is taken before any changes are made.

Console EXEC

Key binds may also be combined with the Exec console command to enable a player to perform a wide range of tasks with only a few keys, swapping keybinds on the fly. See quickswitch hotkeys for more information and examples.

Special characters

Some keys cannot be entered as typed on a keyboard and must be refereed to by their Java reference.

Java name On QWERTY On QWERTZ
SLASH / #
APOSTROPHE ' ä
PERIOD . .
SEMICOLON  ; ü
EQUALS {{{1}}} *
COMMA , ,
SUBTRACT - -
PLUS + ; or NUMPAD +
GRAVE ` ö
RBRACKET ] ´
LBRACKET [ ß
BACKSLASH \ ^
DECIMAL NUMPAD . NUMPAD ,
divide NUMPAD / NUMPAD /
MULTIPLY NUMPAD * NUMPAD *
MOUSE2 MMB MMB
MOUSE3 MB4 MB4
MOUSE4 MB5 MB5
AT @ @
COLON  : :
CIRCUMFLEX ^ ^

Most mouse buttons will be detected by Java and the game may make them all available. Simply increment the number at the end of MOUSE to test if your buttons will accept binds. Java mouse button labels are: left, right, MOUSE2, MOUSE3, and MOUSE4. On windows this corresponds to buttons: left, right, middle or button3, button4, and button5.

Notes

  • To reset key bindings to their default state delete the keybindings.txt file at the location specified under Keybindings source in the Game tab of the launcher settings. This will generate a new file on next load.
  • To access the console, press F1 (by default). It's also accessable via the Main Menu.
  • Key modifiers may also be specified, e.g. SHIFT or CTRL+ALT. Add these before the key you with to bind, e.g. SHIFT+D. Available modifiers are:
  • shift
  • ctrl, ctrl+alt, ctrl+shift
  • alt, alt+shift
  • ctrl+alt+shift
  • Numpad keys are not the same as the normal keys on the keyboard, ensure the correct assignment is used.
  • It is possible to assign binds to mouse buttons, e.g. forward, back, middle-click.
  • To see the current assignment via the console type bind <key>
  • To remove a key bind assignment type bind <key> ""
  • Chat messages may also be bound to keys:
bind <key> "say guards!"
bind <key> "say /shout Hello kingdom people!"
bind <key> "say /v Hello village people!"
bind <key> "say /tell <name> Enemies in local run awayyyy!"
  • All possible chat commands are available by typing /help in a chat box.
  • To list all key binds in the console type dump binds in the console window.
  • Keys bound to actions are sensitive to the mouse cursor's hover location/position and object highlight. So, if the cursor is hovering over an item or tile that will be the target of the action. Some actions require an activated item to be available.

Further reading