Kaleidoscope/README.md

Kaleidoscope-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, create a list, and configure the provided TopsyTurvy object to use the dictionary:

#include <Kaleidoscope.h>
#include <Kaleidoscope-TopsyTurvy.h>

static const Key topsy_turvy_list[] PROGMEM = {
  Key_1, Key_2, Key_3, Key_4, Key_5,
  Key_6, Key_7, Key_8, Key_9, Key_0,
  Key_NoKey
};

void setup () {
  USE_PLUGINS (&TopsyTurvy);

  Kaleidoscope.setup ();

  TopsyTurvy.key_list = topsy_turvy_list;
}

The list of keys must be terminated with a Key_NoKey, and must reside in PROGMEM.

Plugin methods

The plugin provides the TopsyTurvy object, with the following property:

.key_list

Set this property to the list of Keys TopsyTurvy should invert the Shift behaviour for.

Further reading

Starting from the example is the recommended way of getting started with the plugin.