Contents |
nKey
<wiki:toc max_depth="3" />
Introduction
nKey is a hotkey module for LiteStep. It lets you execute actions when some key combination is pressed.
Configuration
Hotkeys
Settings and commands for creating/removing hotkeys.
`*`Hotkey
Creates a new hotkey.
- Format:* `*`Hotkey _Mods_ _Key_ _Action_
- Corresponding bang:* `!`Hotkey _Mods_ _Key_ _Action_
|| *Parameter* || *Type* || *Description* || || Mods || [MODIFIER_KEYS] || The modifier keys for the hotkey. || || Key || KEY || The keyboard key to use. Either a single character corresponding to the key on the keyboard or one of the keys defined in the VKTable. || || Action || ACTION || The action to execute when this hotkey is pressed. ||
!RemoveHotkey
Removes a hotkey, if it exists.
- Format:* `!`RemoveHotkey _Mods_ _Key
|| *Parameter* || *Type* || *Description* || || Mods || [MODIFIER_KEYS] || The modifier keys for the hotkey. || || Key || KEY || The keyboard key the hotkey is using. ||
nKeyLeftWindows
Specifies an action to execute if the left windows key is released without another hotkey being executed first.
- Format:* nKeyLeftWindows _Action_
- Corresponding bang:* !nKeySetLeftWindows _Action_
- Default setting:* ""
|| *Parameter* || *Type* || *Description* || || Action || ACTION || The action to execute. ||
nKeyRightWindows
Specifies an action to execute if the right windows key is released without another hotkey being executed first.
- Format:* nKeyRightWindows _Action_
- Corresponding bang:* !nKeySetRightWindows _Action_
- Default setting:* ""
|| *Parameter* || *Type* || *Description* || || Action || ACTION || The action to execute. ||
Settings
Settings which effect all hotkeys
nKeyVKTable
Specifies the path to the VKTable nKey should use. The VKTable maps keyboard keys -> strings which you use with the `*`Hotkey/!Hotkey commands.
- Format:* nKeyVKTable _Path_
- Corresponding bang:* !nKeySetVKTable _Path_
- Default setting:* ""
|| *Parameter* || *Type* || *Description* || || Path || PATH || Path to the VKTable file. ||