summaryrefslogtreecommitdiff
path: root/keyboards/mechwild/obe/keymaps/jonavin/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/mechwild/obe/keymaps/jonavin/readme.md')
-rw-r--r--keyboards/mechwild/obe/keymaps/jonavin/readme.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/keyboards/mechwild/obe/keymaps/jonavin/readme.md b/keyboards/mechwild/obe/keymaps/jonavin/readme.md
new file mode 100644
index 0000000000..d60958a4e9
--- /dev/null
+++ b/keyboards/mechwild/obe/keymaps/jonavin/readme.md
@@ -0,0 +1,46 @@
+# Jonavin's MechWild Orange Boy Ergo keymap
+
+--> This keymap makes user of user/jonavin userspace
+
+Features
+ - Split spacebars, Split Backspace
+ - RGB Winlock indicator (requires LED stripto be installed)
+ - RGB Layer indicators: FN/MO1 - Purple; LOWER/MO2 - Yellow; RAISE/MO3/NumPad - Green
+ - quick demo https://youtu.be/gR1awbsouLk
+
+- Add PrtScr, Scroll Lock, Break, NumLock to Fn layer
+- Implement Win key lock using Fn+Win
+- Layer 2 (LOWER) when right B is held -- for emoticons
+- Layer 2 RGB functions
+- Layer 3 (RAISE) mod on Caps Lock with double-tap to switch to this layer, double tap to switch back
+ - provides arrows on WASD and additional nav keys + right hand numpad with 00; an be used for Alt Code entry
+ - left spacebar Backspace
+- add double tap of Left Shift to toggle Caps Lock
+
+
+rules.mk OPTIONS - Active features from userspace
+--------------------------------------------------
+
+STARTUP_NUMLOCK_ON = yes
+- turns on NUMLOCK by default
+
+ENCODER_DEFAULTACTIONS_ENABLE = yes
+- Enables default encoder funtions
+ - holding Left shift, change layers
+ - holding right shift, Navigate page up/down
+ - holding Left Ctrl, navigate prev/next word
+ - holding Left Alt, change media prev/next track
+ - default is change volume
+
+TD_LSFT_CAPSLOCK_ENABLE = yes
+ - This will enable double tap on Left Shift to toggle CAPSLOCK when using KC_LSFTCAPS
+
+IDLE_TIMEOUT_ENABLE = yes
+ - Enables Timer functionality; for RGB idle timeouts that can be changed dynamically
+
+EMOTICON_ENABLE
+ - adds EMO_ keycodes for text emojis
+
+## All layers diagram
+![image](https://user-images.githubusercontent.com/71780717/135770721-ab263532-f645-4903-99cb-749549944e15.png)
+