Difference between revisions of "WkBindKeys"
From Worms Knowledge Base
(Add the wkBindKeys page.) |
(Fix download link) |
||
| (10 intermediate revisions by one other user not shown) | |||
| Line 3: | Line 3: | ||
| name = wkBindKeys | | name = wkBindKeys | ||
| developer = [[People/Drey08|drey08]] | | developer = [[People/Drey08|drey08]] | ||
| − | | version = 1 | + | | version = 1.0 / June 6, 2016 |
| games = [[Worms Armageddon|W:A]] | | games = [[Worms Armageddon|W:A]] | ||
| waver = All versions | | waver = All versions | ||
| Line 9: | Line 9: | ||
| license = Open source ([http://www.boost.org/users/license.html Boost]) | | license = Open source ([http://www.boost.org/users/license.html Boost]) | ||
| website = https://github.com/AndrejMitrovic/wkBindKeys | | website = https://github.com/AndrejMitrovic/wkBindKeys | ||
| − | | download = [https://github.com/AndrejMitrovic/wkBindKeys/releases/download/v1 | + | | download = [https://github.com/AndrejMitrovic/wkBindKeys/releases/download/v1.0/wkBindKeys.zip the archive (670 kB)] |
}} | }} | ||
| Line 15: | Line 15: | ||
'''Note:''' '''wkBindKeys''' does not automatically detect the chat window in-game, the key bindings have to be toggled on or off with the '''toggle''' key. Chat window detection is a planned feature. | '''Note:''' '''wkBindKeys''' does not automatically detect the chat window in-game, the key bindings have to be toggled on or off with the '''toggle''' key. Chat window detection is a planned feature. | ||
| + | |||
| + | == Requirements == | ||
| + | |||
| + | The wormkit module requires the DLL '''madCHook.dll'''. This DLL may have been distributed in earlier versions of WA, but if it's missing in your installation folder you will have to find and install it manually. Some other WormKit modules may contain this DLL in their zipped package. | ||
== How to use it == | == How to use it == | ||
| Line 36: | Line 40: | ||
a=enter | a=enter | ||
d=space | d=space | ||
| − | g=` | + | g=`</nowiki> |
| − | </nowiki> | + | |
| + | == Usage notes == | ||
| + | |||
| + | When the '''Num Lock''' key is toggled '''off''' the numpad arrow keys act as regular arrow keys, which means you cannot map them to different key bindings. The following bindings only work when the '''Num Lock''' key is toggled '''on''': | ||
| + | |||
| + | <nowiki> | ||
| + | VK_NUMPAD4=enter | ||
| + | VK_NUMPAD6=space</nowiki> | ||
| + | |||
| + | == Bugs / Feature Requests == | ||
| + | If you find bugs or want to submit feature requests, please file them [https://github.com/AndrejMitrovic/wkBindKeys/issues here]. You may need a [https://github.com/ GitHub account] before submitting any issues (registration is free). | ||
== List of supported keys == | == List of supported keys == | ||
[http://nehe.gamedev.net/article/msdn_virtualkey_codes/15009/ List of all virtual key codes] | [http://nehe.gamedev.net/article/msdn_virtualkey_codes/15009/ List of all virtual key codes] | ||
| − | Use the key names from the ''Symbolic Constant Name'' column when editing the '''wkBindKeys.ini''' config file. | + | Use the key names from the ''Symbolic Constant Name'' column when editing the '''wkBindKeys.ini''' config file. '''wkBindKeys''' also supports an alternate but simpler syntax for the key names, e.g. '''left-shift''', '''r-ctrl''', etc. |
Latest revision as of 20:19, 29 March 2018
| wkBindKeys | |
|---|---|
| Developer: | drey08 |
| Latest version: | 1.0 / June 6, 2016 |
| Supported games: | W:A |
| Supported W:A version: | All versions |
| Language: | D |
| License: | Open source (Boost) |
| Website: | https://github.com/AndrejMitrovic/wkBindKeys |
| Download: | the archive (670 kB) |
This WormKit module allows you to remap any keys on the keyboard when playing W:A. It uses a readable key binding config file, and has a toggle key option.
Note: wkBindKeys does not automatically detect the chat window in-game, the key bindings have to be toggled on or off with the toggle key. Chat window detection is a planned feature.
Contents
Requirements
The wormkit module requires the DLL madCHook.dll. This DLL may have been distributed in earlier versions of WA, but if it's missing in your installation folder you will have to find and install it manually. Some other WormKit modules may contain this DLL in their zipped package.
How to use it
You need to have the Load WormKit modules option in the Advanced settings in W:A enabled. Unpack the contents of the wkBindKeys archive into your W:A folder.
Example key bindings are located in the wkBindKeys.ini config file.
Example of the wkBindKeys.ini config file
# This is the wkBindKeys configuration file. # Lines starting with '#' are comment lines. # # The configuration format is: # new_key = target_key # Key used to toggle the key bindings on and off home=toggle # Pressing 'a' will be the same as pressing the enter key a=enter d=space g=`
Usage notes
When the Num Lock key is toggled off the numpad arrow keys act as regular arrow keys, which means you cannot map them to different key bindings. The following bindings only work when the Num Lock key is toggled on:
VK_NUMPAD4=enter VK_NUMPAD6=space
Bugs / Feature Requests
If you find bugs or want to submit feature requests, please file them here. You may need a GitHub account before submitting any issues (registration is free).
List of supported keys
Use the key names from the Symbolic Constant Name column when editing the wkBindKeys.ini config file. wkBindKeys also supports an alternate but simpler syntax for the key names, e.g. left-shift, r-ctrl, etc.
