Adding ishtob keymap to master (#3235)

* Adding my personal planck keymap

* Adding readme.md to my keymap

keyboards/planck/keymaps/ishtob/config.h

@@ -0,0 +1,60 @@
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "../../config.h"
+
+#define LEADER_TIMEOUT 300
+//#define BACKLIGHT_BREATHING
+#define PREVENT_STUCK_MODIFIERS
+
+//audio clicky
+    #define AUDIO_CLICKY
+  // to enable clicky on startup
+  //#define AUDIO_CLICKY_ON
+	#define AUDIO_CLICKY_FREQ_RANDOMNESS 1.0f
+
+/* ws2812 RGB LED
+#define RGB_DI_PIN B5
+#define RGBLIGHT_ANIMATIONS
+#define RGBLED_NUM 8     // Number of LEDs
+#define RGBLIGHT_HUE_STEP 10
+#define RGBLIGHT_SAT_STEP 17
+*/
+#undef PLANCK_MIT_LAYOUT
+
+#undef DEBOUNCE
+#define DEBOUNCE 0
+
+//rgb-reactive
+#define RGB_MATRIX_KEYPRESSES
+#define EECONFIG_RGB_MATRIX (uint32_t *)16
+
+//skip usb startup check
+//#define NO_USB_STARTUP_CHECK
+
+
+/*
+ * MIDI options
+ */
+
+/* Prevent use of disabled MIDI features in the keymap */
+//#define MIDI_ENABLE_STRICT 1
+
+/* enable basic MIDI features:
+   - MIDI notes can be sent when in Music mode is on
+*/
+#define MIDI_BASIC
+
+/* enable advanced MIDI features:
+   - MIDI notes can be added to the keymap
+   - Octave shift and transpose
+   - Virtual sustain, portamento, and modulation wheel
+   - etc.
+*/
+//#define MIDI_ADVANCED
+
+/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
+//#define MIDI_TONE_KEYCODE_OCTAVES 2
+
+
+#endif

keyboards/planck/keymaps/ishtob/macros_public.h

@@ -0,0 +1,57 @@
+enum macro_keycodes {
+  KC_CITRIX,
+  KC_MPASS,
+  KC_META,
+  KC_RTQ6H,
+  KC_DAYRN,
+  KC_3DRN,
+  KC_AUTODC,
+  KC_EMAIL,
+  KC_EMAIL2
+};
+
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
+{
+    if (!eeconfig_is_enabled()) {
+      eeconfig_init();
+    }
+
+    switch (id) {
+      //my login macros
+      case KC_CITRIX:
+        if (record->event.pressed){
+          return MACRO (I(1), T(1), END);
+        }
+      case KC_MPASS:
+        if (record->event.pressed){
+          return MACRO (I(1), T(1), END);
+        }
+      case KC_META:
+        if (record->event.pressed){
+          return MACRO (I(1), T(1), END);
+        }
+      //my work macros
+      case KC_RTQ6H:
+        if (record->event.pressed){
+          return MACRO (I(1), T(TAB), T(0), T (3), T(0), T(0), T(TAB), T(DOWN), T(TAB), T(0), T (9), T(0), T(0), T(TAB), T(DOWN), T(TAB), T(1), T (5), T(0), T(0), T(TAB), T(DOWN), T(TAB), T(2), T (1), T(0), T(0), T(TAB), D(LALT), T(O), U(LALT), END);
+        }
+      case KC_AUTODC:
+        if (record->event.pressed){
+          return MACRO (I(1), D(LALT), T(V), U(LALT), T(TAB), T(TAB), T(TAB), T(TAB), T(TAB), T(TAB), T(TAB), T(TAB), T(TAB), T(T), T(TAB),T(N), D(LALT), T(S), U(LALT), END);
+        }
+      case KC_DAYRN:
+        if (record->event.pressed){
+          return MACRO (I(1), T(TAB), T(TAB), T(TAB), T(TAB), T(TAB), T(1), D(LALT), T(S), U(LALT), END);
+        }
+      //Ops macros
+      case KC_EMAIL:
+        if (record->event.pressed){
+          return MACRO (I(1), T(1), END);        }        
+      case KC_EMAIL2:
+        if (record->event.pressed){
+          return MACRO (I(1), T(1), END);
+        }  
+    }
+
+    return MACRO_NONE;
+} 

keyboards/planck/keymaps/ishtob/readme.md

@@ -0,0 +1,21 @@
+![Planck Layout Image](https://i.imgur.com/yKewjWW.jpg)
+
+#Ishtob's personal planck layout
+
+THis is the default layout used with my planck light, though the rest of the keymap could also be used for the full sized planck or let's split.
+
+
+Main difference with the default layout:
+
+* Tab take the upper left key, made into a Tap layer to access the symbols from the number row
+
+* Esc moved to lower corner
+
+* Capslock is on the base layer as it is used quite often with my work's software
+
+* Numbers layer on lower is positioned to resemble a numpad with 5 taking the location of J for the homing bump and easier entry
+
+
+# Secret Macros
+
+`macros_public.h` contains a list of macros that can be replaced with passwords or other sensative private macros. `macros_private.h` will be used if it exsists in the folder during compiling and will ignore `macros_public.h` The private macros can be excluded from git commits by adding it to the exclusion list.

keyboards/planck/keymaps/ishtob/rule.mk

@@ -0,0 +1,28 @@
+ifeq ($(strip $(SECRETS)),yes)
+	OPT_DEF += -DSECRETS
+endif
+
+# Build Options
+#   comment out to disable the options.
+#
+BACKLIGHT_ENABLE = no
+BOOTMAGIC_ENABLE = yes	# Virtual DIP switch configuration
+## (Note that for BOOTMAGIC on Teensy LC you have to use a custom .ld script.)
+MOUSEKEY_ENABLE = yes	# Mouse keys
+EXTRAKEY_ENABLE = yes	# Audio control and System control
+CONSOLE_ENABLE = yes	# Console for debug
+COMMAND_ENABLE = yes    # Commands for debug and configuration
+#SLEEP_LED_ENABLE = yes  # Breathing sleep LED during USB suspend
+NKRO_ENABLE = yes	    # USB Nkey Rollover
+CUSTOM_MATRIX = yes # Custom matrix file
+AUDIO_ENABLE = yes
+RGB_MATRIX_ENABLE = yes
+ENCODER_ENABLE = yes
+# SERIAL_LINK_ENABLE = yes
+
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no    # Breathing sleep LED during USB suspend
+
+ifndef QUANTUM_DIR
+	include ../../../../Makefile
+endif