aboutsummaryrefslogtreecommitdiff
path: root/users/jonavin/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'users/jonavin/readme.md')
-rw-r--r--users/jonavin/readme.md106
1 files changed, 67 insertions, 39 deletions
diff --git a/users/jonavin/readme.md b/users/jonavin/readme.md
index c029796b4..9fccb8c73 100644
--- a/users/jonavin/readme.md
+++ b/users/jonavin/readme.md
@@ -14,62 +14,90 @@ You should have received a copy of the GNU General Public License
14along with this program. If not, see <http://www.gnu.org/licenses/>. 14along with this program. If not, see <http://www.gnu.org/licenses/>.
15 15
16LAYERS: 16LAYERS:
17 0 = _BASE 17- 0 = _BASE
18 1 = _FN1 18- 1 = _FN1
19 2 = _LOWER 19- 2 = _LOWER
20 3 = _RAISE 20- 3 = _RAISE
21 21
22KEYCODES: 22KEYCODES:
23 KC_CAD Ctrl-Alt-Del 23- KC_CAD Ctrl-Alt-Del
24 KC_AF4 Alt-F4 24- KC_AF4 Alt-F4
25 KC_TASK Windows Task Manager (Ctrl-Shift-Esc) 25- KC_TASK Windows Task Manager (Ctrl-Shift-Esc)
26 LSFT_CAPSLOCK When LSFT_CAPSLOCK_ENABLE is defined, hold for Shift double tap for CAPSLOCK; otherwise, just Shift 26- LSFT_CAPSLOCK When LSFT_CAPSLOCK_ENABLE is defined, hold for Shift double tap for CAPSLOCK; otherwise, just Shift
27 KC_00 double zero "00" 27- KC_00 double zero "00"
28 KC_WINLCK toggles LGui/Win key lock 28- KC_WINLCK toggles LGui/Win key lock
29 RGB_TOI Increase Timeout idle time threshold 29- RGB_TOI Increase Timeout idle time threshold
30 RGB_TOD Decrease Timeout idle time threshold 30- RGB_TOD Decrease Timeout idle time threshold
31- CT_PGUP Ctrl-PgUp
32- CT_PGDN Ctrl-PgDn
33- CT_HOME Ctrl-HOme
34- CT_END Ctrl-End
35-
36 When EMOTICON_ENABLE = yes
37- EMO_SHRUG `\_("/)_/`
38- EMO_CONFUSE (*_*)
39- EMD_TEARS (T_T)
40- EMO_NERVOUS (~_~;)
41- EMO_JOY (^o^)
42
43
44AVAILABLE ENCODER ACTIONS:
45- void encoder_action_volume(bool clockwise);
46- void encoder_action_mediatrack(bool clockwise);
47- void encoder_action_navword(bool clockwise);
48- void encoder_action_navpage(bool clockwise);
49-
50- uint8_t get_selected_layer(void);
51- void encoder_action_layerchange(bool clockwise);
52-
53- void encoder_action_rgb_speed(bool clockwise);
54- void encoder_action_rgb_hue(bool clockwise);
55- void encoder_action_rgb_saturation(bool clockwise);
56- void encoder_action_rgb_brightness(bool clockwise);
57- void encoder_action_rgb_mode(bool clockwise);
58
31 59
32ENABLE FEATURES your keymap rules.mk 60ENABLE FEATURES your keymap rules.mk
61---------------------------------------
33 62
34STARTUP_NUMLOCK_ON = yes 63STARTUP_NUMLOCK_ON = yes
35 turns on NUMLOCK by default 64- turns on NUMLOCK by default
36 65
37ENCODER_DEFAULTACTIONS_ENABLE = yes 66ENCODER_DEFAULTACTIONS_ENABLE = yes
38 Enabled default encoder funtions 67- Enabled default encoder funtions
39 When enabled, use this in the keymap for an additional encoder processing 68- When enabled, use this in the keymap for an additional encoder processing
40 bool encoder_update_keymap(uint8_t index, bool clockwise) 69- bool encoder_update_keymap(uint8_t index, bool clockwise)
41
42 OPTION: set ENCODER_DEFAULTACTIONS_INDEX to the encoder number if the encoder is not index 0
43 70
71OPTION: set ENCODER_DEFAULTACTIONS_INDEX to the encoder number if the encoder is not index 0
72
44TD_LSFT_CAPSLOCK_ENABLE = yes 73TD_LSFT_CAPSLOCK_ENABLE = yes
45 This will enable double tap on Left Shift to toggle CAPSLOCK 74- This will enable double tap on Left Shift to toggle CAPSLOCK
46 KC_LSFTCAPS to bind to left Shift to enable feature 75- KC_LSFTCAPS to bind to left Shift to enable feature
47 KC_LSFTCAPSWIN does the same thing but will not turn on CAPS when Win Lkey is disabled 76- KC_LSFTCAPSWIN does the same thing but will not turn on CAPS when Win Lkey is disabled
48 77
49IDLE_TIMEOUT_ENABLE = yes 78IDLE_TIMEOUT_ENABLE = yes
50 Enables Timer functionality; for RGB idle timeouts that can be changed dynamically 79- Enables Timer functionality; for RGB idle timeouts that can be changed dynamically
51 When enabled, use this in the keymap for an additional matrix processing 80- When enabled, use this in the keymap for an additional matrix processing: void matrix_scan_keymap(void)
52 void matrix_scan_keymap(void) 81
53 82- Functions:
54 Functions: 83- u16int_t get_timeout_threshold(void) // returns the current timeout threshold
55 u16int_t get_timeout_threshold(void) // returns the current timeout threshold 84- void timeout_update_threshold(bool increase) // change threshold: true = increase, false = decrease
56 void timeout_update_threshold(bool increase) // change threshold: true = increase, false = decrease 85- void timeout_reset_timer(void) // resets timer (put in process_record_user if you override it)
57 void timeout_reset_timer(void) // resets timer (put in process_record_user if you override it) 86- void timeout_tick_timer(void) // registers time ticks (put in maxtrix_scan_user if you override it)
58 void timeout_tick_timer(void) // registers time ticks (put in maxtrix_scan_user if you override it)
59 87
60Other Functions: 88Other Functions:
61 - activate_numlock(bool turn_on) // true = turn on NUM LOCK, false = off 89- activate_numlock(bool turn_on) // true = turn on NUM LOCK, false = off
62 90
63KEYMAP LEVEL ADDITIONAL PROCESSING FUNCTIONS 91KEYMAP LEVEL ADDITIONAL PROCESSING FUNCTIONS
64 bool process_record_keymap(uint16_t keycode, keyrecord_t *record) 92- bool process_record_keymap(uint16_t keycode, keyrecord_t *record)
65 void keyboard_post_init_keymap(void) 93- void keyboard_post_init_keymap(void)
66 94
67LIST OF COMPATIBLE KEYMAPS 95LIST OF COMPATIBLE KEYMAPS
68 - gmmk/pro/ansi 96- gmmk/pro/ansi
69 - keebio/quefrency/rev3 97- keebio/quefrency/rev3
70 - mechwild/mercutio 98- mechwild/mercutio
71 - mechwild/murphpad 99- mechwild/murphpad
72 - mechwild/OBE (*) 100- mechwild/OBE
73 - nopunin10did/kastenwagen (*) 101- nopunin10did/kastenwagen (*)
74 102
75 (*) coming soon 103 (*) coming soon