Skip to content
This repository has been archived by the owner on Nov 9, 2022. It is now read-only.

Latest commit

 

History

History
64 lines (37 loc) · 3.03 KB

README.md

File metadata and controls

64 lines (37 loc) · 3.03 KB

Keyboardio Model 01 Firmware

A reasonably lightweight Keyboardio Model 01 firmware configuration package. It uses a QWERTY layout and has a number of shortcut keys particular to my system, but it could theoretically be used as a starting point for someone else.

Installation

You can pull in all necessary Kaleidoscope code by invoking make setup. Additionally, make update will do just what it says on the tin.

This functionality is shamelessly stolen from algernon's sketch.

Plugins Used

Special Keys

"Special keys" are keys with modifiers applied to them. For instance: LCTRL(Key_Spacebar). Below is a list of such keys, plus an explanation. All are intended for a (specific) Mac.

KEY_EMDASH

A simple shortcut to produce an em-dash on a Mac.

KEY_LAUNCHBAR

A simple shortcut to invoke LaunchBar via keyboard shortcut (Ctrl+Space, on my system).

KEY_DEL_LINE

A simple shortcut to delete the contents of the line left of the cursor. Also deletes selected files, items, etc. that respond to Cmd+Delete.

KEY_1PASSWORD

A simple shortcut to invoke 1Password Mini (Cmd+\ on my system.).

KEY_VS_TERM

Invokes the built-in terminal for VS Code (custom keyboard shortcut, `Ctrl+Alt+``).

KEY_SCRIV_MIN and KEY_SCRIV_STD

Keyboard shortcuts to custom Scrivener layouts.

TD_BACK and TD_FORWARD

TapDance keys that send left- and right-control when held or browser back and forward (respectively). If TapDance isn't included, then these keys revert to the appropriate control keys.

This functionality was originally implemented in Qukeys, but I kept accidentally triggering them and losing a lot of work.

Notes

  • Some of the plugins are arguably removable, namely NumPad and MouseKeys.
  • Qukeys is currently used for only a single key (tap Alt for Enter, or hold for Alt). A simpler solution may be possible.
  • HostPowerManagement is currently disabled due to a bug in upstream
  • AutoShift is currently in development and is disabled by default.

Special Thanks

Thanks to algernon not only for the Makefile and builder, but also for inspiration for the structure of this repo.