]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/planck/keymaps/ishtob/keymap.c
f4ca435f0dd6584e76f9c747aca1a38b9da08457
[qmk_firmware.git] / keyboards / planck / keymaps / ishtob / keymap.c
1 // This is the canonical layout file for the Quantum project. If you want to add another keyboard,
2 // this is the style you want to emulate.
3
4 #include "planck.h"
5 #include "action_layer.h"
6 // #include "dynamic_macro.h"
7 #ifdef AUDIO_ENABLE
8   #include "audio.h"
9 #endif
10 #include "eeconfig.h"
11
12 //Macro definition
13 #if (__has_include("macros_private.h") && !defined(SECRETS))
14 #include "macros_private.h"
15 #else
16 #include "macros_public.h"
17 #endif
18
19 extern keymap_config_t keymap_config;
20
21 // Each layer gets a name for readability, which is then used in the keymap matrix below.
22 // The underscores don't mean anything - you can have a layer called STUFF or any other name.
23 // Layer names don't all need to be of the same length, obviously, and you can also skip them
24 // entirely and just use numbers.
25 #define _QWERTY 0
26 #define _COLEMAK 1
27 #define _DVORAK 2
28 #define _LOWER 3
29 #define _RAISE 4
30 #define _PLOVER 5
31 #define _FNLAYER 6
32 #define _NUMLAY 7
33 #define _MOUSECURSOR 8
34 #define _ADJUST 16
35
36 enum planck_keycodes {
37   QWERTY = SAFE_RANGE,
38   COLEMAK,
39   DVORAK,
40   PLOVER,
41   LOWER,
42   RAISE,
43   BACKLIT,
44   EXT_PLV,
45   DFU,
46 };
47
48 // Fillers to make layering more clear
49 #define _______ KC_TRNS
50 #define XXXXXXX KC_NO
51 // Custom macros
52 #define CTL_ESC     CTL_T(KC_ESC)               // Tap for Esc, hold for Ctrl
53 #define CTL_TTAB    CTL_T(KC_TAB)               // Tap for Esc, hold for Ctrl
54 #define CTL_ENT     CTL_T(KC_ENT)               // Tap for Enter, hold for Ctrl
55 #define SFT_ENT     SFT_T(KC_ENT)               // Tap for Enter, hold for Shift
56 // Requires KC_TRNS/_______ for the trigger key in the destination layer
57 #define LT_FN(kc)   LT(_FNLAYER, kc)            // L-ayer T-ap Function Layer
58 #define LT_MC(kc)   LT(_MOUSECURSOR, kc)        // L-ayer T-ap M-ouse C-ursor
59 #define LT_RAI(kc)  LT(_RAISE, kc)              // L-ayer T-ap to Raise
60 #define TG_NUMLAY   TG(_NUMLAY)                 //Toggle for layer _NUMLAY
61 #define P_CITRIX    M(KC_CITRIX)                // My login macros
62 #define P_MPASS     M(KC_MPASS)
63 #define P_META      M(KC_META)
64 #define O_DAYRN     M(KC_DAYRN)                 // My work macros
65 #define O_AUTODC    M(KC_AUTODC)
66 #define O_RTQ6H     M(KC_RTQ6H)
67 #define M_EMAIL     M(KC_EMAIL)                 // My personal email
68 #define M_EMAIL2    M(KC_EMAIL2)                // My work email
69
70 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
71 /* Qwerty
72  ,-----------------------------------------------------------------------------------.
73  * |Tab/FN|   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
74  * |------+------+------+------+------+-------------+------+------+------+------+------|
75  * | LCtl |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |Ctl/Et|
76  * |------+------+------+------+------+------|------+------+------+------+------+------|
77  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |  ,   |   .  |   /  |  -   |
78  * |------+------+------+------+------+------+------+------+------+------+------+------|
79  * | Esc  | Caps | Alt  | GUI  |Lower |    Space    |Raise |NumLay| RAlt | Men  | Del  |
80  * `-----------------------------------------------------------------------------------'
81  */
82 [_QWERTY] = LAYOUT_planck_grid(
83   LT_FN(KC_TAB), KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC,
84   KC_LCTL,       KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    LT_MC(KC_SCLN), CTL_ENT,
85   KC_LSFT,       KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, LT_RAI(KC_MINS),
86   KC_ESC,        KC_CAPS, KC_LGUI, KC_LALT, LOWER,   KC_SPC,  KC_SPC,  RAISE, KC_RALT, TG_NUMLAY, KC_APP,  KC_DEL
87 ),
88  
89 /* Colemak
90  * ,-----------------------------------------------------------------------------------.
91  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
92  * |------+------+------+------+------+-------------+------+------+------+------+------|
93  * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |Ctl/Et|
94  * |------+------+------+------+------+------|------+------+------+------+------+------|
95  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |  -   |
96  * |------+------+------+------+------+------+------+------+------+------+------+------|
97  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
98  * `-----------------------------------------------------------------------------------'
99  */
100 [_COLEMAK] = LAYOUT_planck_grid(
101   LT_FN(KC_TAB),    KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC,
102   KC_LCTL,   KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    LT_MC(KC_O),    KC_ENT,
103   KC_LSFT,   KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, LT_RAI(KC_MINS),
104   KC_ESC,    KC_CAPS, KC_LGUI, KC_LALT, LOWER,   KC_SPC,  KC_SPC,  RAISE, KC_RALT, TG_NUMLAY, KC_APP,  KC_DEL
105 ),
106  
107 /* Dvorak
108  * ,-----------------------------------------------------------------------------------.
109  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
110  * |------+------+------+------+------+-------------+------+------+------+------+------|
111  * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |Ctl/Et|
112  * |------+------+------+------+------+------|------+------+------+------+------+------|
113  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
114  * |------+------+------+------+------+------+------+------+------+------+------+------|
115  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
116  * `-----------------------------------------------------------------------------------'
117  */
118 [_DVORAK] = LAYOUT_planck_grid(
119   LT_FN(KC_TAB),  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC,
120   KC_LCTL, KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    LT_MC(KC_S),    KC_ENT,
121   KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z, LT_RAI(KC_MINS),
122   KC_ESC,  KC_CAPS, KC_LGUI, KC_LALT, LOWER,   KC_SPC,  KC_SPC,  RAISE, KC_RALT, TG_NUMLAY, KC_APP,  KC_DEL
123 ),
124  
125 /* Lower
126  * ,-----------------------------------------------------------------------------------.
127  * |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  |   ~  |  \   |
128  * |------+------+------+------+------+-------------+------+------+------+------+------|
129  * |      |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
130  * |------+------+------+------+------+------|------+------+------+------+------+------|
131  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |   [  |   ]  |      |
132  * |------+------+------+------+------+------+------+------+------+------+------+------|
133  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
134  * `-----------------------------------------------------------------------------------'
135  */
136 [_LOWER] = LAYOUT_planck_grid(
137   KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_GRV,  KC_BSLS,
138   _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_EQL,  KC_LBRC, KC_RBRC, KC_PIPE,
139   _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,S(KC_NUHS),S(KC_NUBS),KC_LCBR, KC_RCBR, _______,
140   _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
141 ),
142  
143 /* Raise
144  * ,-----------------------------------------------------------------------------------.
145  * |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  |   *  |  \   |
146  * |------+------+------+------+------+-------------+------+------+------+------+------|
147  * |      |   A  |  Up  |   D  |      | Vol+ |   4  |   5  |   6  |   +  |   :  |  '   |
148  * |------+------+------+------+------+------|------+------+------+------+------+------|
149  * |      |  Lt  |  Dn  |  Rt  | Mute | Vol- |   1  |   2  |   3  |  Up  |   /  |      |
150  * |------+------+------+------+------+------+------+------+------+------+------+------|
151  * |      |      |      |      |      |      |   0  |      | Left | Down | Right| NumLk|
152  * `-----------------------------------------------------------------------------------'
153  */
154 [_RAISE] = LAYOUT_planck_grid(
155   KC_1,    KC_2,    KC_3,    KC_4,     KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_PLUS,  KC_BSLS,
156   _______, KC_A,    KC_UP,   KC_D,    KC_PSCR,  KC_VOLU, KC_4,    KC_5,    KC_6,    KC_PAST, KC_COLN, KC_QUOT,
157   _______, KC_LEFT, KC_DOWN, KC_RIGHT,KC__MUTE, KC_VOLD, KC_1,    KC_2,    KC_3,    KC_UP, KC_SLSH,   _______,
158   _______, _______, _______, _______, _______, KC_SPC,  KC_0,   _______,  KC_LEFT, KC_DOWN, KC_RIGHT,   KC_NLCK
159 ),
160  
161 /* Plover layer (http://opensteno.org)
162  * ,-----------------------------------------------------------------------------------.
163  * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
164  * |------+------+------+------+------+-------------+------+------+------+------+------|
165  * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
166  * |------+------+------+------+------+------|------+------+------+------+------+------|
167  * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
168  * |------+------+------+------+------+------+------+------+------+------+------+------|
169  * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
170  * `-----------------------------------------------------------------------------------'
171  */
172  
173 [_PLOVER] = LAYOUT_planck_grid(
174   KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   ,
175   XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC,
176   XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
177   EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX
178 ),
179  
180 /* FN layer on Esc key
181  * ,-----------------------------------------------------------------------------------.
182  * |      |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  |   +  |
183  * |------+------+------+------+------+-------------+------+------+------+------+------|
184  * |      |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   =  |   [  |   ]  |  '   |
185  * |------+------+------+------+------+------|------+------+------+------+------+------|
186  * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |   {  |   }  |Enter |
187  * |------+------+------+------+------+------+------+------+------+------+------+------|
188  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
189  * `-----------------------------------------------------------------------------------'
190  */
191 [_FNLAYER] = LAYOUT_planck_grid(
192   _______, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_PLUS,
193   _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_EQL,  KC_LBRC, KC_RBRC, KC_QUOT,
194   _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,S(KC_NUHS),S(KC_NUBS),KC_LCBR, KC_RCBR, _______,
195   _______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
196 ),
197  
198 /* Num Layer
199  * ,-----------------------------------------------------------------------------------.
200  * |      |   Q  |  Up  |   4  |      |      |   7  |   8  |   9  |   -  |   +  | Bksp |
201  * |------+------+------+------+------+-------------+------+------+------+------+------|
202  * |      |  Lt  |  Dn  |  Rt  |      |      |   4  |   5  |   6  |   *  |   :  |  ENT |
203  * |------+------+------+------+------+------|------+------+------+------+------+------|
204  * |      |   Z  |   X  |   C  |   V  |      |   1  |   2  |   3  |   .  |   /  |      |
205  * |------+------+------+------+------+------+------+------+------+------+------+------|
206  * |      |      |      |      |      |      |   0  |   .  | Exit | Vol- | Vol+ | Play |
207  * `-----------------------------------------------------------------------------------'
208  */
209 [_NUMLAY] = LAYOUT_planck_grid(
210   _______, KC_Q,    KC_UP,   KC_H,     XXXXXXX, XXXXXXX,  KC_P7,   KC_P8,  KC_P9,   KC_MINS,   KC_PLUS,  KC_BSPC,
211   _______, KC_LEFT, KC_DOWN, KC_RIGHT, XXXXXXX, XXXXXXX,  KC_P4,  KC_P5,  KC_P6,   KC_PAST, KC_COLN,  KC_ENT,
212   _______, KC_Z,    KC_X,    KC_C,     KC_V,    XXXXXXX,  KC_P1,  KC_P2,  KC_P3,   KC_PDOT, KC_PSLS,  _______,
213   _______, _______, _______, _______, _______, _______,   KC_P0,  KC_PDOT, _______, _______, KC_NLCK, KC_MPLY
214 ),
215  
216 /* Mouse Layer (semi-col)
217  * ,-----------------------------------------------------------------------------------.
218  * | ACCL0| ACCL1| ACCL2|Email |Email2| Home | Wh_Up| WHL_L| M_Up | WHL_R|PASS| Meta |
219  * |------+------+------+------+------+-------------+------+------+------+------+------|
220  * |      |      |      |      |RT Q6H| End  | Wh_Dn| M_Lft| M_Dn | M_Rt |      | DayRn|
221  * |------+------+------+------+------+------|------+------+------+------+------+------|
222  * |      |      |      |      |      |      | BTN2 | BTN3 | BTN4 | BTN5 |      |      |
223  * |------+------+------+------+------+------+------+------+------+------+------+------|
224  * |      |      |      |      |      |     BTN1    |      |      |      | Citx |      |
225  * `-----------------------------------------------------------------------------------'
226  */
227  
228 [_MOUSECURSOR] = LAYOUT_planck_grid(
229   KC_ACL0, KC_ACL1, KC_ACL2, M_EMAIL,M_EMAIL2, KC_HOME, KC_PGUP, KC_WH_L, KC_MS_U, KC_WH_R, P_MPASS, P_META,
230   _______, XXXXXXX, XXXXXXX, XXXXXXX, O_RTQ6H, KC_END , KC_PGDN, KC_MS_L, KC_MS_D, KC_MS_R, _______, O_DAYRN,
231   _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, KC_BTN2, KC_BTN3, KC_BTN4, KC_BTN5, _______, _______,
232   _______, _______, _______, _______, _______, KC_BTN1, KC_BTN1, _______, _______, _______, P_CITRIX, O_AUTODC
233 ),
234  
235 /* Adjust (Lower + Raise)
236  * ,-----------------------------------------------------------------------------------.
237  * | Reset|RGB TG|RGB ST|RGBH -|RGBH +|RGBS -|RGBS +|RGBV -|RGBV +|      |      |  Del |
238  * |------+------+------+------+------+-------------+------+------+------+------+------|
239  * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Plover|      |
240  * |------+------+------+------+------+------|------+------+------+------+------+------|
241  * |      |Voice-|Voice+|Mus on|Musoff|      |      |      |      | BL + |BL ST |BL TG |
242  * |------+------+------+------+------+------+------+------+------+------+------+------|
243  * |      |      |      |      |      |             |      |      |      |      |      |
244  * `-----------------------------------------------------------------------------------'
245  */
246 [_ADJUST] = LAYOUT_planck_grid(
247   DFU, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, KC_DEL,
248   _______, MAGIC_TOGGLE_NKRO, _______, AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  PLOVER,  _______,
249   _______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, BL_DEC, BL_INC, BL_STEP, BL_TOGG,
250   _______, _______, _______, _______, _______, _______, _______, _______, CK_RST, CK_DOWN, CK_UP, CK_TOGG
251 )
252  
253
254 };
255
256 const uint16_t PROGMEM fn_actions[] = {
257   ACTION_SWAP_HANDS_TAP_KEY(KC_SPC),
258 };
259
260 #ifdef AUDIO_ENABLE
261
262 float tone_startup[][2]    = SONG(STARTUP_SOUND);
263 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
264 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
265 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
266 float tone_plover[][2]     = SONG(PLOVER_SOUND);
267 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
268 float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
269
270 float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
271 #endif
272
273
274 void persistant_default_layer_set(uint16_t default_layer) {
275   eeconfig_update_default_layer(default_layer);
276   default_layer_set(default_layer);
277 }
278
279 //  Helper Functions
280 void tap(uint16_t keycode){ register_code(keycode); unregister_code(keycode); };
281
282
283 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
284   switch (keycode) {
285     case QWERTY:
286       if (record->event.pressed) {
287         #ifdef AUDIO_ENABLE
288           PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
289         #endif
290         persistant_default_layer_set(1UL<<_QWERTY);
291       }
292       return false;
293       break;
294     case COLEMAK:
295       if (record->event.pressed) {
296         #ifdef AUDIO_ENABLE
297           PLAY_NOTE_ARRAY(tone_colemak, false, 0);
298         #endif
299         persistant_default_layer_set(1UL<<_COLEMAK);
300       }
301       return false;
302       break;
303     case DVORAK:
304       if (record->event.pressed) {
305         #ifdef AUDIO_ENABLE
306           PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
307         #endif
308         persistant_default_layer_set(1UL<<_DVORAK);
309       }
310       return false;
311       break;
312     case LOWER:
313       if (record->event.pressed) {
314         layer_on(_LOWER);
315         update_tri_layer(_LOWER, _RAISE, _ADJUST);
316       } else {
317         layer_off(_LOWER);
318         update_tri_layer(_LOWER, _RAISE, _ADJUST);
319       }
320       return false;
321       break;
322     case RAISE:
323       if (record->event.pressed) {
324         layer_on(_RAISE);
325         update_tri_layer(_LOWER, _RAISE, _ADJUST);
326       } else {
327         layer_off(_RAISE);
328         update_tri_layer(_LOWER, _RAISE, _ADJUST);
329       }
330       return false;
331       break;
332     case BACKLIT:
333       if (record->event.pressed) {
334         register_code(KC_RSFT);
335         #ifdef BACKLIGHT_ENABLE
336           backlight_step();
337         #endif
338       } else {
339         unregister_code(KC_RSFT);
340       }
341       return false;
342       break;
343     case PLOVER:
344       if (record->event.pressed) {
345         #ifdef AUDIO_ENABLE
346           stop_all_notes();
347           PLAY_NOTE_ARRAY(tone_plover, false, 0);
348         #endif
349         layer_off(_RAISE);
350         layer_off(_LOWER);
351         layer_off(_ADJUST);
352         layer_on(_PLOVER);
353         if (!eeconfig_is_enabled()) {
354             eeconfig_init();
355         }
356         keymap_config.raw = eeconfig_read_keymap();
357         keymap_config.nkro = 1;
358         eeconfig_update_keymap(keymap_config.raw);
359       }
360       return false;
361       break;
362     case EXT_PLV:
363       if (record->event.pressed) {
364         #ifdef AUDIO_ENABLE
365           PLAY_NOTE_ARRAY(tone_plover_gb, false, 0);
366         #endif
367         layer_off(_PLOVER);
368       }
369       return false;
370       break;
371     case DFU:
372       if (record->event.pressed) {
373         clear_keyboard();
374       #if defined(MIDI_ENABLE) && defined(MIDI_BASIC)
375         process_midi_all_notes_off();
376       #endif
377       #if defined(AUDIO_ENABLE) && !defined(NO_MUSIC_MODE)
378        music_all_notes_off();
379         uint16_t timer_start = timer_read();
380         PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
381         shutdown_user();
382       while(timer_elapsed(timer_start) < 250)
383         wait_ms(1);
384         stop_all_notes();
385       #else
386         wait_ms(250);
387       #endif
388       // this is also done later in bootloader.c - not sure if it's neccesary here
389       #ifdef BOOTLOADER_CATERINA
390         *(uint16_t *)0x0800 = 0x7777; // these two are a-star-specific
391       #endif
392         bootloader_jump();
393       }
394       return false;
395       break;      
396   }
397   return true;
398 }
399
400 void matrix_init_user(void) {
401     #ifdef AUDIO_ENABLE
402         startup_user();
403     #endif
404 }
405
406 #ifdef AUDIO_ENABLE
407
408 void startup_user()
409 {
410     rgblight_mode(RGB_MATRIX_CYCLE_ALL);
411     wait_ms(20); // gets rid of tick
412     PLAY_NOTE_ARRAY(tone_startup, false, 0);
413 }
414
415 void shutdown_user()
416 {
417     PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
418     wait_ms(150);
419     stop_all_notes();
420 }
421
422 void music_on_user(void)
423 {
424     music_scale_user();
425 }
426
427 void music_scale_user(void)
428 {
429     PLAY_NOTE_ARRAY(music_scale, false, 0);
430 }
431
432 #endif
433
434