Keymap: Add userspace for @kageurufu (#4752)

* Add userspace for @kageurufu

* Remove custom keycodes for layer keys

Add some common defaults for my rules.mk

keyboards/zen/keymaps/kageurufu/keymap.c

@@ -0,0 +1,62 @@
+#include QMK_KEYBOARD_H
+#include "kageurufu.h"
+#ifdef PROTOCOL_LUFA
+#include "lufa.h"
+#include "split_util.h"
+#endif
+
+extern keymap_config_t keymap_config;
+extern uint8_t is_master;
+
+
+#define EXPAND_LAYOUT(...) LAYOUT(__VA_ARGS__)
+#define _BASE_LAYOUT( \
+  _00, _01, _02, _03, _04,  _05, _06, _07, _08, _09, \
+  _10, _11, _12, _13, _14,  _15, _16, _17, _18, _19, \
+  _20, _21, _22, _23, _24,  _25, _26, _27, _28, _29 \
+) \
+EXPAND_LAYOUT( \
+      KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,                       KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_BSPC, \
+      KC_TAB,  _00,     _01,     _02,     _03,     _04,                       _05,     _06,     _07,     _08,     _09,     KC_BSLS, \
+      FN_ESC,  _10,     _11,     _12,     _13,     _14,                       _15,     _16,     _17,     _18,     _19,     KC_QUOT, \
+      KC_LSPO, _20,     _21,     _22,     _23,     _24,                       _25,     _26,     _27,     _28,     _29,     KC_RSPC, \
+      KC_LCTL, KC_LGUI, KC_LGUI, KC_LALT, FN,      KC_SPC, KC_BSPC,  KC_ENT,  KC_SPC,  KC_MINS, KC_EQL,  KC_DOWN, KC_PGUP, KC_PGDN \
+)
+#define BASE_LAYOUT(...) _BASE_LAYOUT(__VA_ARGS__)
+
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [_QWERTY] = BASE_LAYOUT( \
+      _________________QWERTY_L1_________________, _________________QWERTY_R1_________________, \
+      _________________QWERTY_L2_________________, _________________QWERTY_R2_________________, \
+      _________________QWERTY_L3_________________, _________________QWERTY_R3_________________ \
+  ),
+
+  [_COLEMAK] = BASE_LAYOUT( \
+      _________________COLEMAK_L1________________, _________________COLEMAK_R1________________, \
+      _________________COLEMAK_L2________________, _________________COLEMAK_R2________________, \
+      _________________COLEMAK_L3________________, _________________COLEMAK_R3________________ \
+  ),
+
+  [_COLEMAK_DH] = BASE_LAYOUT( \
+      ______________COLEMAK_MOD_DH_L1____________, ______________COLEMAK_MOD_DH_R1____________, \
+      ______________COLEMAK_MOD_DH_L2____________, ______________COLEMAK_MOD_DH_R2____________, \
+      ______________COLEMAK_MOD_DH_L3____________, ______________COLEMAK_MOD_DH_R3____________ \
+  ),
+
+  [_FN] = EXPAND_LAYOUT( \
+      ________________FUNCTION_L1________________,                   ________________FUNCTION_R1________________, \
+      ________________FUNCTION_L2________________,                   ________________FUNCTION_R2________________, \
+      ________________FUNCTION_L3________________,                   ________________FUNCTION_R3________________, \
+      ________________FUNCTION_L4________________,                   ________________FUNCTION_R4________________, \
+      ________________FUNCTION_L5________________, _______, KC_DEL,  ________________FUNCTION_R5________________ \
+      ),
+
+  [_ADJ] =  EXPAND_LAYOUT( \
+      _________________ADJUST_L1_________________,                   _________________ADJUST_R1_________________, \
+      _________________ADJUST_L2_________________,                   _________________ADJUST_R2_________________, \
+      _________________ADJUST_L3_________________,                   _________________ADJUST_R3_________________, \
+      _________________ADJUST_L4_________________,                   _________________ADJUST_R4_________________, \
+      _________________ADJUST_L5_________________, _______, _______, _________________ADJUST_R5_________________ \
+      )
+};

users/kageurufu/config.h

@@ -0,0 +1,4 @@
+#pragma once
+
+#define NO_ACTION_MACRO
+#define NO_ACTION_FUNCTION

users/kageurufu/custom_rgb.c

@@ -0,0 +1,18 @@
+#include "custom_rgb.h"
+
+#if defined(RGBLIGHT_ENABLE)
+  extern rgblight_config_t rgblight_config;
+  rgblight_config_t _pushed_rgblight_config;
+  #define push_rgb_config() { if (_pushed_rgblight_config.raw == 0) { _pushed_rgblight_config.raw = rgblight_config.raw; } }
+  #define pop_rgb_config() { if (_pushed_rgblight_config.raw == 0) { rgblight_config.raw = _pushed_rgblight_config.raw; _pushed_rgblight_config.raw = 0; } }
+#elif defined(RGB_MATRIX_ENABLE)
+  extern rgb_config_t rgb_matrix_config;
+  rgb_config_t _pushed_rgb_matrix_config;
+  #define push_rgb_config() _pushed_rgb_matrix_config.raw = rgb_matrix_config.raw
+  #define pop_rgb_config() rgb_matrix_config.raw = _pushed_rgb_matrix_config.raw
+#endif
+
+
+bool process_record_rgb(uint16_t keycode, keyrecord_t *record) {
+  return true;
+}

users/kageurufu/custom_rgb.h

@@ -0,0 +1,3 @@
+#pragma once
+
+#include "kageurufu.h"

users/kageurufu/kageurufu.c

@@ -0,0 +1,12 @@
+#include "kageurufu.h"
+#include "quantum.h"
+#include "process_records.h"
+
+#ifdef RGBLIGHT_ENABLE
+  //Following line allows macro to read current RGB settings
+  extern rgblight_config_t rgblight_config;
+  rgblight_config_t backup_rgblight_config;
+
+  __attribute__((weak))
+  uint8_t RGBLIGHT_MODS[] = {0};
+#endif

users/kageurufu/kageurufu.h

@@ -0,0 +1,5 @@
+#pragma once
+
+#include "quantum.h"
+#include "process_records.h"
+#include "layouts.h"

users/kageurufu/layouts.h

@@ -0,0 +1,58 @@
+#pragma once
+
+
+#define _________________NUMROW_L1_________________        KC_1,    KC_2,    KC_3,    KC_4,    KC_5
+#define _________________NUMROW_R1_________________        KC_6,    KC_7,    KC_8,    KC_9,    KC_0
+
+
+#define _________________QWERTY_L1_________________        KC_Q,    KC_W,    KC_E,    KC_R,    KC_T
+#define _________________QWERTY_L2_________________        KC_A,    KC_S,    KC_D,    KC_F,    KC_G
+#define _________________QWERTY_L3_________________        KC_Z,    KC_X,    KC_C,    KC_V,    KC_B
+
+#define _________________QWERTY_R1_________________        KC_Y,    KC_U,    KC_I,    KC_O,    KC_P
+#define _________________QWERTY_R2_________________        KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN
+#define _________________QWERTY_R3_________________        KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLASH
+
+
+#define _________________COLEMAK_L1________________       KC_Q,    KC_W,    KC_F,    KC_P,    KC_G
+#define _________________COLEMAK_L2________________       KC_A,    KC_R,    KC_S,    KC_T,    KC_D
+#define _________________COLEMAK_L3________________       KC_Z,    KC_X,    KC_C,    KC_V,    KC_B
+
+#define _________________COLEMAK_R1________________       KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN
+#define _________________COLEMAK_R2________________       KC_H,    KC_N,    KC_E,    KC_I,    KC_O
+#define _________________COLEMAK_R3________________       KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLASH
+
+
+#define ______________COLEMAK_MOD_DH_L1____________       KC_Q,    KC_W,    KC_F,    KC_P,    KC_B
+#define ______________COLEMAK_MOD_DH_L2____________       KC_A,    KC_R,    KC_S,    KC_T,    KC_G
+#define ______________COLEMAK_MOD_DH_L3____________       KC_Z,    KC_X,    KC_C,    KC_D,    KC_V
+
+#define ______________COLEMAK_MOD_DH_R1____________       KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN
+#define ______________COLEMAK_MOD_DH_R2____________       KC_M,    KC_N,    KC_E,    KC_I,    KC_O
+#define ______________COLEMAK_MOD_DH_R3____________       KC_K,    KC_H,    KC_COMM, KC_DOT,  KC_SLASH
+
+
+#define ________________FUNCTION_L1________________     KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6
+#define ________________FUNCTION_L2________________     _______, KC_PGDN, KC_UP,   KC_PGUP, _______, KC_LBRC
+#define ________________FUNCTION_L3________________     ADJ,     KC_LEFT, KC_DOWN, KC_RGHT, _______, _______
+#define ________________FUNCTION_L4________________     _______, _______, _______, _______, _______, _______
+#define ________________FUNCTION_L5________________     _______, _______, _______, _______, ADJ,     _______
+
+#define ________________FUNCTION_R1________________     KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12
+#define ________________FUNCTION_R2________________     KC_RBRC, KC_7,    KC_UP,   KC_9,    KC_0,    KC_HOME
+#define ________________FUNCTION_R3________________     _______, KC_LEFT, KC_DOWN, KC_RGHT, KC_RBRC, KC_END
+#define ________________FUNCTION_R4________________     _______, _______, _______, KC_PGDN, KC_PGUP, _______
+#define ________________FUNCTION_R5________________     ADJ,     KC_MPLY, KC_MNXT, KC_MUTE, KC_VOLD, KC_VOLU
+
+
+#define _________________ADJUST_L1_________________     KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6
+#define _________________ADJUST_L2_________________     _______, RGB_SAD, RGB_VAI, RGB_SAI, RESET,   _______
+#define _________________ADJUST_L3_________________     _______, RGB_HUD, RGB_VAD, RGB_HUI, RGBRST,  _______
+#define _________________ADJUST_L4_________________     _______, _______, _______, _______, _______, _______
+#define _________________ADJUST_L5_________________     _______, _______, _______, _______, _______, _______
+
+#define _________________ADJUST_R1_________________     KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12
+#define _________________ADJUST_R2_________________     _______, _______, _______, _______, _______, KC_DEL
+#define _________________ADJUST_R3_________________     _______, QWERTY,  COLEMAK, CMAK_DH, _______, _______
+#define _________________ADJUST_R4_________________     _______, _______, RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI
+#define _________________ADJUST_R5_________________     _______, _______, RGB_RMOD,RGB_HUD, RGB_SAD, RGB_VAD

users/kageurufu/process_records.c

@@ -0,0 +1,44 @@
+#include "kageurufu.h"
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+    case QWERTY:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_QWERTY);
+      }
+      return false;
+      break;
+    case COLEMAK:
+      if(record->event.pressed) {
+        set_single_persistent_default_layer(_COLEMAK);
+      }
+      return false;
+      break;
+    case RGBRST:
+      #ifdef RGBLIGHT_ENABLE
+        if (record->event.pressed) {
+          eeconfig_update_rgblight_default();
+          rgblight_enable();
+        }
+      #endif
+      break;
+  }
+
+
+  return process_record_keymap(keycode, record) &&
+#if defined(RGBLIGHT_ENABLE) || defined(RGB_MATRIX_ENABLE)
+    process_record_rgb(keycode, record) &&
+#endif // RGBLIGHT_ENABLE;
+    true;
+}
+
+__attribute__ ((weak))
+bool process_record_keymap(uint16_t keycode, keyrecord_t *record) {
+  return true;
+}
+
+
+__attribute__ ((weak))
+bool process_record_rgb(uint16_t keycode, keyrecord_t *record) {
+  return true;
+}

users/kageurufu/process_records.h

@@ -0,0 +1,27 @@
+#pragma once
+#include "kageurufu.h"
+
+#define FN_ESC  LT(_FN, KC_ESC)
+#define FN      MO(_FN)
+#define ADJ     MO(_ADJ)
+
+enum layer_number {
+    _QWERTY = 0,
+    _COLEMAK,
+    _COLEMAK_DH,
+    _FN,
+    _ADJ,
+    ADDITIONAL_LAYER
+};
+
+enum custom_keycodes {
+  QWERTY = SAFE_RANGE,
+  COLEMAK,
+  CMAK_DH,
+  RGBRST,
+  KAGEURUFU_SAFE_RANGE
+};
+
+
+bool process_record_keymap(uint16_t keycode, keyrecord_t *record);
+bool process_record_rgb(uint16_t keycode, keyrecord_t *record);

keyboards/sol/keymaps/kageurufu/config.h → users/kageurufu/readme.md

@@ -1,8 +1,4 @@
-/*
-This is the c configuration file for the keymap
-
-Copyright 2012 Jun Wako <[email protected]>
-Copyright 2015 Jack Humbert
+Copyright 2018- Franklyn Tackitt [email protected] @kageurufu
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -16,10 +12,3 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
-
-#pragma once
-
-
-// place overrides here
-

users/kageurufu/rules.mk

@@ -0,0 +1,15 @@
+SRC += kageurufu.c \
+       process_records.c \
+       custom_rgb.c
+
+# Link time optimization, should save on firmware size
+EXTRAFLAGS += -flto
+
+
+# Some usual defaults
+MOUSEKEY_ENABLE = no
+EXTRAKEY_ENABLE = yes
+COMMAND_ENABLE = yes
+CONSOLE_ENABLE = yes
+RGBLIGHT_ENABLE = yes
+RGBLIGHT_ANIMATIONS = yes