Michael Richters ca0f80d607 | 3 years ago | |
---|---|---|
.. | ||
src | 3 years ago | |
README.md | 4 years ago | |
library.properties | 4 years ago |
README.md
TopsyTurvy
TopsyTurvy
is a plugin that inverts the behaviour of the Shift
key for some
selected keys. That is, if configured so, it will input !
when pressing the
1
key without Shift
, but with the modifier pressed, it will input the
original 1
symbol.
Using the plugin
To use the plugin, one needs to include the header, mark keys to apply plugin effects to, and use the plugin:
#include <Kaleidoscope.h>
#include <Kaleidoscope-TopsyTurvy.h>
// In the keymap:
TOPSY(1), TOPSY(2), TOPSY(3)
KALEIDOSCOPE_INIT_PLUGINS(TopsyTurvy);
void setup () {
Kaleidoscope.setup ();
}
Keymap markup
There is only one macro that the plugin provides, which one can use in keymap definitions:
TOPSY(key)
Mark the specified
key
(without theKey_
prefix!) for TopsyTurvy, and swap the effect ofShift
when the key is used. One can have any number of topsy-turvy keys on a keymap.The keys must be plain old keys, modifiers or anything other augmentation cannot be applied.
The plugin provides a number of macros one can use in keymap definitions:
Plugin methods
The plugin provides the TopsyTurvy
object, without any public methods or properties.
Further reading
Starting from the example is the recommended way of getting started with the plugin.