Keyboard: Move Bathroom Epiphany boards into its own directory (#3936)

* make bpiphany directory with simple readme file

* move unloved_bastard to bpiphany directory

* move frosty_flake to bpiphany directory

* move pegasushoof to bpiphany directory

* move tiger_lily to bpiphany directory

* add a little more info to readme

* move kitten_paw to bpiphany directory

* update make instructions

* update intro text

* add missing routines to matrix.c of unloved_bastard

* add missing routines

3 files changed, 0 insertions, 291 deletions

diff --git a/keyboards/kitten_paw/keymaps/ickerwx/config.h b/keyboards/kitten_paw/keymaps/ickerwx/config.h
deleted file mode 100644
index 142aba8909..0000000000
--- a/keyboards/kitten_paw/keymaps/ickerwx/config.h
+++ /dev/null
@@ -1,31 +0,0 @@
-#ifndef CONFIG_USER_H
-#define CONFIG_USER_H
-
-#include "../../config.h"
-
-#undef MOUSEKEY_MOVE_MAX
-#define MOUSEKEY_MOVE_MAX       127
-#undef MOUSEKEY_WHEEL_MAX
-#define MOUSEKEY_WHEEL_MAX      110
-#undef MOUSEKEY_MOVE_DELTA
-#define MOUSEKEY_MOVE_DELTA     5
-#undef MOUSEKEY_WHEEL_DELTA
-#define MOUSEKEY_WHEEL_DELTA    1
-#undef MOUSEKEY_DELAY
-#define MOUSEKEY_DELAY 50
-#undef MOUSEKEY_INTERVAL
-#define MOUSEKEY_INTERVAL 20
-#undef MOUSEKEY_MAX_SPEED
-#define MOUSEKEY_MAX_SPEED 4
-#undef MOUSEKEY_TIME_TO_MAX
-#define MOUSEKEY_TIME_TO_MAX 30
-#undef MOUSEKEY_WHEEL_MAX_SPEED
-#define MOUSEKEY_WHEEL_MAX_SPEED 3
-#undef MOUSEKEY_WHEEL_TIME_TO_MAX
-#define MOUSEKEY_WHEEL_TIME_TO_MAX 255
-#undef ONESHOT_TIMEOUT
-#define ONESHOT_TIMEOUT 500
-#undef TAPPING_TOGGLE
-#define TAPPING_TOGGLE 2
-
-#endif
diff --git a/keyboards/kitten_paw/keymaps/ickerwx/keymap.c b/keyboards/kitten_paw/keymaps/ickerwx/keymap.c
deleted file mode 100644
index 856cef9cc2..0000000000
--- a/keyboards/kitten_paw/keymaps/ickerwx/keymap.c
+++ /dev/null
@@ -1,242 +0,0 @@
-#include QMK_KEYBOARD_H
-#include "mousekey.h"
-
-#define _______ KC_TRNS
-#define XXXXXXX KC_NO
-#define  C(kc) LCTL(KC_##kc)
-#define RA(kc) RALT(KC_##kc)
-#define KC_SLCT KC_SELECT
-#define MEDAPP LT(MEDIA, KC_APP)
-#undef S
-#define S(kc) LSFT(KC_##kc)
-
-uint8_t current_layer_global = 255;
-
-enum layers {
-    DEFAULT,
-    PROG1,
-    PROG2,
-    MEDIA,
-    MOUSE1,
-    MOUSE2,
-    MISC,
-};
-
-enum function_id {
-    LSHFT_PAREN,
-    RSHFT_PAREN,
-    LCTRL_BRACKET,
-    RCTRL_BRACKET,
-    LALT_CURLY,
-    RALT_CURLY,
-    CTRL_CLICK
-};
-
-enum macro_id {
-    GRV,
-    CFLEX
-};
-
-const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-  [DEFAULT] = LAYOUT(\
-          KC_ESC,  KC_F1,  KC_F2,  KC_F3,  KC_F4,  KC_F5,  KC_F6,  KC_F7,  KC_F8,  KC_F9, KC_F10, KC_F11, KC_F12,           KC_PSCR,KC_SLCK,KC_PAUS,                                   \
-          KC_GRV,   KC_1,   KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,   KC_9,   KC_0,KC_MINS, KC_EQL,KC_BSPC,    KC_INS,KC_HOME,KC_PGUP,  KC_NLCK,KC_PSLS,KC_PAST,KC_PMNS, \
-          KC_TAB,   KC_Q,   KC_W,   KC_E,   KC_R,   KC_T,   KC_Y,   KC_U,   KC_I,   KC_O,   KC_P,KC_LBRC,KC_RBRC,KC_BSLS,    KC_DEL, KC_END,KC_PGDN,    KC_P7,  KC_P8,  KC_P9,KC_PPLS, \
-            F(0),   KC_A,   KC_S,   KC_D,   KC_F,   KC_G,   KC_H,   KC_J,   KC_K,   KC_L,KC_SCLN,KC_QUOT,         KC_ENT,                               KC_P4,  KC_P5,  KC_P6,         \
-            F(8),KC_NUBS,   KC_Z,   KC_X,   KC_C,   KC_V,   KC_B,   KC_N,   KC_M,KC_COMM, KC_DOT,KC_SLSH,           F(9),             KC_UP,            KC_P1,  KC_P2,  KC_P3,KC_PENT, \
-            F(1),KC_LGUI,   F(3),              LT(MISC,  KC_SPC),                           F(4),   F(5), MEDAPP,   F(2),   KC_LEFT,KC_DOWN,KC_RGHT,    KC_P0,KC_PDOT),
-  /* Layer 1: Programming Layer 1, emulating US l ayout */
-  [PROG1] = LAYOUT(\
-          KC_ESC,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,           _______,_______,_______,                                   \
-          M(GRV),_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,KC_SLSH,   S(0),_______,   _______,_______,_______,  _______,_______,_______,_______, \
-         _______,_______,_______,_______,_______,_______,   KC_Z,_______,_______,_______,_______,  RA(8),  RA(9),RA(MINS),  _______,_______,_______,  _______,_______,_______,_______, \
-         _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,S(COMM),S(BSLS),        _______,                             _______,_______,_______,         \
-       MO(PROG2),_______,   KC_Y,_______,_______,_______,_______,_______,_______,_______,_______,   S(7),      MO(PROG2),           _______,          _______,_______,_______,_______, \
-         _______,_______,_______,                        _______,                        _______,_______,_______,_______,   _______,_______,_______,  _______,_______),
-    /* Layer 2: programming layer 2
-       all keys that are not FN keys are sent as LSFT+key on this layer
-    */
-  [PROG2] = LAYOUT(\
-         _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,           _______,_______,_______,                                   \
-        RA(RBRC),_______,  RA(Q),KC_BSLS,_______,_______,M(CFLEX),  S(6),S(RBRC),   S(8),   S(9),S(SLSH),KC_RBRC,_______,   _______,_______,_______,  _______,_______,_______,_______, \
-         _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,  RA(7),  RA(0),RA(NUBS),  _______,_______,_______,  _______,_______,_______,_______, \
-         _______,_______,_______,_______,_______,_______,_______,_______,_______,_______, S(DOT),   S(2),        _______,                             _______,_______,_______,         \
-         _______,S(NUBS),_______,_______,_______,_______,_______,_______,_______,KC_NUBS,S(NUBS),S(MINS),        _______,           _______,          _______,_______,_______,_______, \
-         _______,_______,_______,                        _______,                        _______,_______,_______,_______,   _______,_______,_______,  _______,_______),
-    /* Layer 3: media layer */
-  [MEDIA] = LAYOUT(\
-          KC_PWR,KC_SLEP,KC_WAKE,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,           XXXXXXX,XXXXXXX,XXXXXXX,                                   \
-         XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,   KC_MPRV,KC_MPLY,KC_MNXT,  XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX, \
-         XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,   KC_VOLD,KC_MUTE,KC_VOLU,  XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX, \
-         XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,        XXXXXXX,                             XXXXXXX,XXXXXXX,XXXXXXX,         \
-         XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,        XXXXXXX,           KC_EJCT,          XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX, \
-         XXXXXXX,XXXXXXX,XXXXXXX,                        XXXXXXX,                        XXXXXXX,XXXXXXX,_______,XXXXXXX,   KC_MRWD,KC_MSTP,KC_MFFD,  XXXXXXX,XXXXXXX),
-    /* Layer 4: Mouse layer */
-  [MOUSE1] = LAYOUT(\
-            F(6),_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,           _______,_______,_______,                                   \
-         _______,KC_ACL0,KC_ACL1,KC_ACL2,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,   _______,_______,_______,  _______,_______,_______,_______, \
-         _______,KC_BTN4,KC_WH_D,KC_MS_U,KC_WH_U,_______,   C(Z),_______,_______,_______,_______,_______,_______,_______,   _______,_______,_______,  _______,_______,_______,_______, \
-         _______,KC_BTN5,KC_MS_L,KC_MS_D,KC_MS_R,   F(7),KC_WH_L,KC_WH_D,KC_WH_U,KC_WH_R,_______,_______,        _______,                             _______,_______,_______,         \
-      MO(MOUSE2),_______,   C(Y),   C(X),   C(C),   C(V),_______,KC_BTN2,KC_BTN3,C(PGUP),C(PGDN),_______,        KC_RSFT,           _______,          _______,_______,_______,_______, \
-         KC_LCTL,_______,KC_LALT,                        KC_BTN1,                        KC_RALT,KC_RGUI, KC_APP,KC_RCTL,   _______,_______,_______,  _______,_______),
-    /* Layer 5: Mouse layer 2*/
-  [MOUSE2] = LAYOUT(\
-         _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,           _______,_______,_______,                                   \
-         _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,   _______,_______,_______,  _______,_______,_______,_______, \
-         _______,_______,KC_BTN2,KC_WH_U,KC_BTN3,_______,_______,_______,_______,_______,_______,_______,_______,_______,   _______,_______,_______,  _______,_______,_______,_______, \
-         _______,_______,KC_WH_L,KC_WH_D,KC_WH_R,_______,KC_MS_L,KC_MS_D,KC_MS_U,KC_MS_R,_______,_______,        _______,                             _______,_______,_______,         \
-         _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,        _______,           _______,          _______,_______,_______,_______, \
-         _______,_______,_______,                        _______,                        _______,_______,_______,_______,   _______,_______,_______,  _______,_______),
-    /* Layer 6: Misc layer */
-  [MISC] = LAYOUT(\
-         _______, KC_F13, KC_F14, KC_F15, KC_F16, KC_F17, KC_F18, KC_F19, KC_F20, KC_F21, KC_F22, KC_F23, KC_F24,           _______,_______,_______,                                   \
-         _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,   _______,_______,_______,  _______,_______,_______,_______, \
-         _______,KC_SLCT,   C(W),  KC_UP,_______,_______,_______,_______,KC_BSPC, KC_DEL,_______,_______,_______,_______,   _______,_______,_______,  _______,_______,_______,_______, \
-         _______,_______,KC_LEFT,KC_DOWN,KC_RGHT,_______,KC_HOME,KC_PGDN,KC_PGUP,_______,_______,_______,        _______,                             _______,_______,_______,         \
-         KC_LSFT,_______,   C(Y),   C(X),   C(C),   C(V), KC_SPC, KC_END,_______,C(PGUP),C(PGDN),_______,        _______,           _______,          _______,_______,_______,_______, \
-         _______,_______,_______,               LT(MISC, KC_SPC),                        _______,_______,_______,_______,   _______,_______,_______,  _______,_______),
-};
-
-const uint16_t PROGMEM fn_actions[] = {
-    [0] = ACTION_LAYER_TAP_TOGGLE(MOUSE1),      // tap-toggle mouse layer (4)
-    [1] = ACTION_FUNCTION_TAP(LCTRL_BRACKET),   // tap to print [
-    [2] = ACTION_FUNCTION_TAP(RCTRL_BRACKET),   // tap to print ]
-    [3] = ACTION_FUNCTION_TAP(LALT_CURLY),      // tap to print {
-    [4] = ACTION_FUNCTION_TAP(RALT_CURLY),      // tap to print }
-    [5] = ACTION_LAYER_TAP_TOGGLE(PROG1),       // tap-toggle programming layer 1
-    [6] = ACTION_LAYER_SET_CLEAR(DEFAULT),
-    [7] = ACTION_FUNCTION_TAP(CTRL_CLICK),
-    [8] = ACTION_FUNCTION_TAP(LSHFT_PAREN),     // tap to print (
-    [9] = ACTION_FUNCTION_TAP(RSHFT_PAREN),     // tap to print )
-};
-
-const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
-{
-  // MACRODOWN only works in this function
-      switch(id) {
-        case GRV: // macro to print accent grave
-            return (record->event.pressed ?
-                    MACRO( D(LSFT), T(EQL), U(RALT), T(SPC), END) :
-                    MACRO_NONE );
-        case CFLEX: // print accent circonflex
-            return (record->event.pressed ?
-                    MACRO( T(GRV), T(SPC), END ) :
-                    MACRO_NONE );
-      }
-    return MACRO_NONE;
-};
-
-
-void matrix_init_user(void) {
-
-}
-
-void matrix_scan_user(void) {
-    uint8_t layer;
-    layer = biton32(layer_state);
-
-    if (current_layer_global != layer) {
-        current_layer_global = layer;
-
-        // unset CAPSLOCK and SCROLL LOCK LEDs
-        led_set_kb(host_keyboard_leds() & ~(1<<USB_LED_CAPS_LOCK));
-        led_set_kb(host_keyboard_leds() & ~(1<<USB_LED_SCROLL_LOCK));
-        // set SCROLL LOCK LED when the mouse layer is active, CAPS LOCK when PROG layer is active
-        if (layer == MOUSE1 || layer == MOUSE2) {
-          led_set_kb(host_keyboard_leds() | (1<<USB_LED_SCROLL_LOCK));
-        } else if (layer == PROG1 || layer == PROG2) {
-          led_set_kb(host_keyboard_leds() | (1<<USB_LED_CAPS_LOCK));
-        }
-    }
-}
-
-void led_set_user(uint8_t usb_led) {
-
-}
-
-void tap_helper(keyrecord_t *record, uint16_t orig_mod, uint16_t macro_mod, uint16_t macro_kc ) {
-  if (record->event.pressed) {
-      if (record->tap.count > 0 && !record->tap.interrupted) {
-          if (record->tap.interrupted) {
-              register_mods(MOD_BIT(orig_mod));
-          }
-      } else {
-          register_mods(MOD_BIT(orig_mod));
-      }
-  } else {
-      if (record->tap.count > 0 && !(record->tap.interrupted)) {
-          add_weak_mods(MOD_BIT(macro_mod));
-          send_keyboard_report();
-          register_code(macro_kc);
-          unregister_code(macro_kc);
-          del_weak_mods(MOD_BIT(macro_mod));
-          send_keyboard_report();
-          record->tap.count = 0;  // ad hoc: cancel tap
-      } else {
-          unregister_mods(MOD_BIT(orig_mod));
-      }
-  }
-}
-
-/* if LCTRL is tabbed, print (, or ) if RCTRL is tabbed, same for LALT/RALT and [/] */
-void action_function(keyrecord_t *record, uint8_t id, uint8_t opt) {
-    // The code is copied from keymap_hasu.c in the tmk keyboards hhkb folder
-    switch (id) {
-        case LCTRL_BRACKET:
-            tap_helper(record, KC_LCTL, KC_RALT, KC_8);
-            break;
-        case RCTRL_BRACKET:
-            tap_helper(record, KC_RCTL, KC_RALT, KC_9);
-            break;
-        case LALT_CURLY:
-            tap_helper(record, KC_LALT, KC_RALT, KC_7);
-            break;
-        case RALT_CURLY:
-            tap_helper(record, KC_RALT, KC_RALT, KC_0);
-            break;
-        case LSHFT_PAREN:
-            tap_helper(record, KC_LSFT, KC_LSFT, KC_8);
-            break;
-        case RSHFT_PAREN:
-            tap_helper(record, KC_RSFT, KC_LSFT, KC_9);
-            break;
-        case CTRL_CLICK:
-            if (record->event.pressed) {
-                mousekey_clear();
-                register_mods(MOD_BIT(KC_LCTL));
-                send_keyboard_report();
-                wait_ms(5);
-                mousekey_on(KC_BTN1);
-                mousekey_send();
-                wait_ms(10);
-                mousekey_off(KC_BTN1);
-                mousekey_send();
-                wait_ms(5);
-                unregister_mods(MOD_BIT(KC_LCTL));
-                send_keyboard_report();
-            }
-            break;
-    }
-}
-
-bool process_record_user(uint16_t keycode, keyrecord_t *record) {
-    uint8_t layer;
-    layer = biton32(layer_state);
-    if (layer == PROG2) {
-         if (keycode >= KC_A && keycode <= KC_EXSEL && \
-             !(  // do not send LSFT + these keycodes, they are needed for emulating the US layout
-                 keycode == KC_NONUS_BSLASH ||
-                 keycode == KC_RBRC ||
-                 keycode == KC_BSLS ||
-                 keycode == KC_GRV
-            )) {
-              // LSFT is the modifier for this layer, so we set LSFT for every key to get the expected behavior
-              if (record->event.pressed) {
-                  register_mods(MOD_LSFT);
-              } else {
-                  unregister_mods(MOD_LSFT);
-              }
-         }
-    }
-    return true;
-}
diff --git a/keyboards/kitten_paw/keymaps/ickerwx/readme.md b/keyboards/kitten_paw/keymaps/ickerwx/readme.md
deleted file mode 100644
index 0d23be4eac..0000000000
--- a/keyboards/kitten_paw/keymaps/ickerwx/readme.md
+++ /dev/null
@@ -1,18 +0,0 @@
-# My personal keymap for the Kitten Paw controller
-
-This keymap only works correctly when you have your OS configured with a German keymap. Use the keymap however you like. It's most likely a living thing that will never be quite finished.
-
-## Description of the layers
-Layer 0 (DEFAULT) works just like you would expect a keyboard to work, mostly, except:
-Caps Lock switches to the mouse layer, RGUI and APP are switches to the programming layer and media layer.
-Mouse and programming layer switches can be held or double-tapped to lock.
-Holding space switches to the MISC layer where I currently accumulate useful shortcuts.
-Tapping left and right Shift, Ctrl and Alt will send (), [] and {} respectively.
-
-Layers 1 and 2 (PROG1 and PROG2) emulate the US layout while still using a German OS keymap setting. I was annoyed of having to change the OS settings every time I wanted to use the US layout for coding, so I made these layers to behave just like the US layout even though the OS still uses German. The shift keys were a bit tricky, I had to use them as MO(PROG2) switches, so to get the actual expected behavior I enable LSFT for almost every keypress on PROG2 in ```process_record_user```. Since the shift keys are MO() function keys, they do not print () at the moment, which sucks. I'm working on it.
-
-Layer 3 (MEDIA) just has a couple of media keys on it, mainly around the cursor keys and nav key cluster.
-
-Layers 4 and 5 (MOUSE1 and MOUSE2) are mouse layers. Move the cursor using ESDF, scroll using HJKL, Space for left click, N and M for right and middle click. There's more, look at the keymap.
-
-Layer 6 is a layer I don't have a good name for, so I call it MISC. You'll find cursor keys at ESDF, other navigation keys around the HJKL cluster and F12 to F24 on the F-keys. For now.
\ No newline at end of file