diff --git a/README.md b/README.md index 76d4e01c..ac41c29a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-ShapeShifter +# Kaleidoscope-ShapeShifter ![status][st:stable] @@ -22,9 +22,10 @@ To use the plugin, one needs to include the header, create a dictionary, and configure the provided `ShapeShifter` object to use the dictionary: ```c++ -#include +#include +#include -static const Akela::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { +static const KaleidoscopePlugins::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { {Key_1, Key_4}, {Key_4, Key_1}, {Key_NoKey, Key_NoKey}, @@ -33,8 +34,8 @@ static const Akela::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = void setup () { ShapeShifter.configure (shapeShiftDictionary); - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&ShapeShifter, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&ShapeShifter, NULL); } ``` @@ -49,9 +50,9 @@ The plugin provides the `ShapeShifter` object, with the following methods: ### `.configure(dictionary)` > Tells `ShapeShifter` to use the specified dictionary. The dictionary is an -> array of `Akela::ShapeShifter::dictionary_t` elements, which is just a very -> verbose way of saying that its a pair of keys. The first one is the one to -> replace, and the other is to replace it with. +> array of `KaleidoscopePlugins::ShapeShifter::dictionary_t` elements, which is +> just a very verbose way of saying that its a pair of keys. The first one is +> the one to replace, and the other is to replace it with. > > Be aware that the replacement key will be pressed with `Shift` held, so do > keep that in mind! @@ -72,4 +73,4 @@ The plugin provides the `ShapeShifter` object, with the following methods: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-ShapeShifter/blob/master/examples/ShapeShifter/ShapeShifter.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-ShapeShifter/blob/master/examples/ShapeShifter/ShapeShifter.ino diff --git a/examples/ShapeShifter/ShapeShifter.ino b/examples/ShapeShifter/ShapeShifter.ino index 58ea39e9..1c008f92 100644 --- a/examples/ShapeShifter/ShapeShifter.ino +++ b/examples/ShapeShifter/ShapeShifter.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,7 +16,8 @@ * along with this program. If not, see . */ -#include +#include +#include const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED @@ -39,7 +40,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { ), }; -static const Akela::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { +static const KaleidoscopePlugins::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { {Key_1, Key_2}, {Key_2, Key_1}, {Key_NoKey, Key_NoKey}, @@ -48,10 +49,10 @@ static const Akela::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = void setup () { ShapeShifter.configure (shapeShiftDictionary); - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&ShapeShifter, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&ShapeShifter, NULL); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index 6d78fcde..8282b98d 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-ShapeShifter +name=Kaleidoscope-ShapeShifter version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Change the shifted symbols on any key of your choice. paragraph=Make it possible to send a different keycode when a key is being shifted. category=Communication -url=https://github.com/keyboardio/Akela-ShapeShifter +url=https://github.com/keyboardio/Kaleidoscope-ShapeShifter architectures=avr dot_a_linkage=true diff --git a/src/Akela-ShapeShifter.h b/src/Kaleidoscope-ShapeShifter.h similarity index 85% rename from src/Akela-ShapeShifter.h rename to src/Kaleidoscope-ShapeShifter.h index 9d5b8687..12c0521a 100644 --- a/src/Akela-ShapeShifter.h +++ b/src/Kaleidoscope-ShapeShifter.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,4 +18,4 @@ #pragma once -#include +#include diff --git a/src/Akela/ShapeShifter.cpp b/src/Kaleidoscope/ShapeShifter.cpp similarity index 92% rename from src/Akela/ShapeShifter.cpp rename to src/Kaleidoscope/ShapeShifter.cpp index 7e542d39..53b14a7a 100644 --- a/src/Akela/ShapeShifter.cpp +++ b/src/Kaleidoscope/ShapeShifter.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,9 +16,9 @@ * along with this program. If not, see . */ -#include +#include -namespace Akela { +namespace KaleidoscopePlugins { const ShapeShifter::dictionary_t *ShapeShifter::dictionary = NULL; bool ShapeShifter::modActive; @@ -99,4 +99,4 @@ namespace Akela { }; -Akela::ShapeShifter ShapeShifter; +KaleidoscopePlugins::ShapeShifter ShapeShifter; diff --git a/src/Akela/ShapeShifter.h b/src/Kaleidoscope/ShapeShifter.h similarity index 84% rename from src/Akela/ShapeShifter.h rename to src/Kaleidoscope/ShapeShifter.h index 41280740..70bef330 100644 --- a/src/Akela/ShapeShifter.h +++ b/src/Kaleidoscope/ShapeShifter.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,10 +18,10 @@ #pragma once -#include +#include -namespace Akela { - class ShapeShifter : public KeyboardioPlugin { +namespace KaleidoscopePlugins { + class ShapeShifter : public KaleidoscopePlugin { public: typedef struct { Key original, replacement; @@ -48,4 +48,4 @@ namespace Akela { }; }; -extern Akela::ShapeShifter ShapeShifter; +extern KaleidoscopePlugins::ShapeShifter ShapeShifter;