Key bindings

From Wurmpedia
Revision as of 15:16, 1 March 2011 by Ago (talk | contribs) (→‎Key binds: Added examples how to use key bindings)
Jump to navigation Jump to search

Main Page / Key bindings

Introduction

Key bindings are defined in the keybindings.txt file, which is automatically updated if you rebind keys while playing. Binds in autorun.txt will be executed on startup and these will overwrite any in keybindings.txt. These files can be found in the Wurm game directory under configs. e.g. C:\Games\Wurm\configs\default

Additionally, key binds can 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.

Key binds

Key binds allow quick "hotkey" access to common commands and actions. The bind command requires special values as input.

bind <key> <action>
bind <key> <console command>

<key> is based on Java key constants. Letters and numbers represent themselves. For other keys, if you can't guess the correct name search the full KeyEvent list. Meta keys can also be specified, e.g. shift-tab or ctrl-alt-w. Available meta keys are Ctrl, Shift, and Alt. The "Alt Gr" key is treated as Alt (if your keyboard has one). The non-meta key must always be the last key in the combination. It is not possible to bind only meta keys.

(The numpad keys can be tricky, as they duplicate other keys on the main keyboard. They are: numpad[0-9], add, subtract, multiply, divide and decimal.)

<action> is a bindable action as listed in the table below.

bind M MINE_FORWARD

<console command> can be any console command. If the command contains spaces the command has to be in quotes.

bind F2 "toggle inventory"

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 in an inventory or highlighting an item on the ground (or a tile itself for other binds), and the TAKE bind key is pressed, that item will be taken. It is not necessary to left-click the mouse button in order to select an item first either; just hovering the mouse over something will allow the key bind to affect it.

Table

Bindable actions
Bind Category Notes
CENTER_VIEW Camera
GLANCE_LEFT Camera
GLANCE_RIGHT Camera
TURN_DOWN Camera
TURN_UP Camera
AUTORUN Player movement
TURN_LEFT Player movement
TURN_RIGHT Player movement
MOVE_FORWARD Player movement
MOVE_BACK Player movement
MOVE_LEFT Player movement
MOVE_RIGHT Player movement
STRAFE Player movement
FIGHT_DEFENSIVE Fighting
FIGHT_NORMAL Fighting
FIGHT_AGGRESSIVELY Fighting
NO_TARGET Fighting
TARGET Fighting
AIM_LOWER_LEFT Fighting
AIM_LOWER_MIDDLE Fighting
AIM_LOWER_RIGHT Fighting
AIM_LEFT Fighting
AIM_MIDDLE Fighting
AIM_RIGHT Fighting
AIM_UPPER_LEFT Fighting
AIM_UPPER_MIDDLE Fighting
AIM_UPPER_RIGHT Fighting
FOCUS Fighting
SHIELD_BASH Fighting
DEFEND_LEFT Fighting
DEFEND_UPPER Fighting
DEFEND_LOWER Fighting
DEFEND_RIGHT Fighting
special_move1 Fighting
special_move2 Fighting
special_move3 Fighting
special_move4 Fighting
special_move5 Fighting
NEXT_TAB Interface
PREVIOUS_TAB Interface
NEXT_WINDOW Interface
PREVIOUS_WINDOW Interface
TOGGLE_CHAT Interface
TOGGLE_CLIMB Climbing
TOGGLE_FAITHFUL Religion
TOGGLE_LAWFUL Morality
ACTIVATE_TOOL1 Toolbelt
ACTIVATE_TOOL2 Toolbelt
ACTIVATE_TOOL3 Toolbelt
ACTIVATE_TOOL4 Toolbelt
ACTIVATE_TOOL5 Toolbelt
TOGGLE_FIGHT_SPAM Spam mode
EXAMINE Item movement/manipulation
ACTIVATE Item manipulation
TAKE Item movement/manipulation
DROP Item movement/manipulation This also pours liquids.
DRAG Item movement/manipulation
STOP_DRAGGING Item movement/manipulation
PUSH Item movement/manipulation
REPAIR Item movement/manipulation
TURN_CLOCKWISE Item movement/manipulation
TURN_COUNTERCLOCKWISE Item movement/manipulation
PULL Item movement/manipulation
IMPROVE Item movement/manipulation
FINISH Item movement/manipulation
CONTINUE Item movement/manipulation This action does not work on any item where the continues material does not have to be activated such as house walls and stone walls.
DIG Digging
DREDGE Digging
FLATTEN Digging
PACK Digging
CULTIVATE Digging
HARVEST Farming
FARM Farming
MINE_FORWARD Mining
MINE_UP Mining
MINE_DOWN Mining
MINE_SURFACE Mining
MINE_TUNNEL Mining
PROSPECT Mining
PICK_SPROUT Forestry
PRUNE Forestry
CUT_DOWN Woodcutting
CHOP_UP Woodcutting
TAME Animal taming
LEAD Animals
STOP_LEADING Animals
FEED Animals
ABSORB Mycelium
BREED Animal husbandry
GROOM Animal husbandry
FORAGE Foraging
BOTANIZE Botanizing
PICK_FLOWERS Gardening
FISH Fishing
TRACK Tracking
OPEN Container
CLOSE Container
STOP_OR_MAIN_MENU Actions


A note specifically about the in-game wiki. This command is bound by default to the H key. If you've managed to unbind it, you can put it back by using the bind command in your console with "toggle wikisearch" as your bound action. So if you wanted to bind your H key to the wiki search, you would open your console (F1) and type in exactly as below:
bind h "toggle wikisearch"

Examples

For an example of how key bindings can help you, see quickswitch hotkeys.

Additional autorun.txt uses

autorun.txt can be used in several other useful ways.

The following opens windows when the client loads:

toggle skills
toggle inventory
toggle stats

This stops kingdom chat from loading when the game starts, but sometimes someone gets in a message before it takes effect. Placing it at the top of the file may help.

say /kchat

You could add this to know how much sleep bonus you have when you log in. This works best at the bottom of the file.

say /sleep

You could add this to know how long the server has been up. This works best at the bottom of the file.

say /uptime

Defaults

If you want to reset your key bindings to their default state simply delete the keybindings file. A new one will be created with the default values.