ctrl-kbd-annabunches/readme.md

49 lines
No EOL
2.3 KiB
Markdown

This is my custom keymap for the [Drop CTRL](https://drop.com/buy/drop-ctrl-mechanical-keyboard) keyboard.
### About this keymap
> Important Note: This keymap is for the Drop CTRL v1. It would probably also work with the v2, but I make no guarantees.
My keymap defaults to Dvorak in firmware; that means it will type like a Dvorak keyboard on a computer whose system settings are set to Qwerty. (or any other keymap, probably) It can be switched to Qwerty by pressing `Fn+Esc`, and has a bunch of other fun features including custom RGB light maps for various games I enjoy or have enjoyed. Other fun features:
* Caps lock defaults to `KC_MENU`, which is useful as a compose key (set `xkb_options compose:menu`). Caps lock is still accessible by pressing `Fn+Caps Lock`.
* `Fn+Win` will disable the Windows and Caps Lock / Compose keys. These keys can still be accessed in this "protected" mode by triple-tapping the key. This allows you to disable those keys while playing games (to avoid accidentally breaking the game input in a stressful moment) but still lets you get to those buttons if you really need them.
* Several emoji sequences and custom lighting maps are defined.
This code is a bit of a mess, but I'm sticking it out in the public anyway in classic open source fashion, in case anyone finds it useful.
## Using this code
### Prerequisites
In addition to basic dev tools, make sure `qmk` and `mdloader` are installed. On Arch Linux you can install `qmk` via:
```
sudo pacman -S qmk
```
`mdloader` is available from the [AUR](https://aur.archlinux.org/packages/mdloader-bin).
### Preparing the code
Clone the [QMK firmware](https://github.com/qmk/qmk_firmware) repository, checkout to v0.26.11 (Drop CTRL support is missing from newer versions) and then clone this repository in the appropriate location:
```
git clone https://github.com/qmk/qmk_firmware.git
git checkout 0.26.11
git clone https://git.annabunches.net/anna/ctrl-kbd-annabunches.git keyboards/massdrop/ctrl/keymaps/annabunches
```
### Build and Flash
Modify the keymap as you like, then run (from the QMK project's root directory):
```
make drop/ctrl:annabunches
```
This should produce a `.bin` file in the `qmk_firmware` directory. You can flash that to the keyboard via:
```
make drop/ctrl:annabunches:flash
```