qmk-keychron-q3-colemak-dh/users/noroadsleft/readme.md

@noroadsleft's Userspace

This directory holds the code that's the same for every keyboard I use in QMK, which is currently:

• kc60
• kbdfans/kbd75/rev1
• coseyfannitutti/discipline

Macro Features and Custom Keycodes

VRSN

Outputs a string that tells me the Git commit from which my flashed firmware was built. Looks something like:

kc60:noroadsleft # @ 0.6.326-6-gae6d7b-dirty

Git Macros

Some frequently used Git commands.

Keycode	Output	Output with Shift
G_PUSH	git push origin	git push origin
G_FTCH	git fetch upstream	git pull upstream
G_BRCH	master	$(git branch-name)
G_PWD	$( pwd | sed -e 's;^.*/keyboards/;;' -e 's;/;_;g')	$( pwd | sed -e 's;^.*/keyboards/;;' -e 's;/;_;g')

$(git branch-name) is an alias for git rev-parse --abbrev-ref HEAD, which normally returns the name of the current branch.

The G_PWD macro outputs a shell expansion that returns the current working directory in relation to qmk_firmware/keyboards/, and with the slashes replaced with underscores. I do a lot of keyboard refactoring in QMK, and this is a string I use regularly.

Customized Keycodes

I used to have a boolean variable that changed the functionality of these keycodes, but I no longer work in the environment that I wrote the functionality for, so I took it out. The keycodes still exist because all my keymap.c files reference the custom keycodes I defined.

Keycode	Action
M_SALL	Ctrl+A
M_UNDO	Ctrl+Z
M_CUT	Ctrl+X
M_COPY	Ctrl+C
M_PASTE	Ctrl+V

Emulated Non-US Backslash

Sometimes I type in languages from countries that use ISO layout, but my keyboards are all ANSI layout, so I have one key fewer than necessary.

This macro simulates the Non-US Backslash key if I hold Right Alt and tap the key to the right of Left Shift.

Requires defining ANSI_NUBS_ROW and ANSI_NUBS_COL in config.h at the keymap level.¹

Emulated Numeric Keypad

If I hold the Right Alt key, the number row (KC_1 through KC_0) will output numpad keycodes instead of number row keycodes, enabling quicker access to characters like ™ and °.

Emulated Extended Function Keys

Similar to the emulated numpad, if I hold the Right Alt key with the Fn key, the function row (KC_F1 through KC_F12) will output keycodes KC_F13 throught KC_F24.

License

Copyright 2020-2022 James Young (@noroadsleft)

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 the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 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/.

Footnotes

• 1: ^ ANSI_NUBS_ROW and ANSI_NUBS_COL are in the following locations:
  • KC60
  • KBDfans KBD75 rev1
  • CoseyFannitutti Discipline