Zach's Mugspideyclick logo

GitHub

GitLab

Linkedin

Instagram

Youtube

SoundCloud

Email

QMK Tips

I have a couple keyboards powered by QMK. They are really cool, and I was getting along fine flashing them with the help of the QMK Configurator. But a problem came along when I wanted to use mouseKeys, which requires a change to the rules.mk file. Unfortunately, I don't see a way to do that from the configurator, so it's time I figure out how to compile my own QMK firmware!

Prerequisits

Compiling

Loosely follows this guide--but with a few tweaks for my specific situation

Open up a QMK MSYS terminal and start with the following:

qmk setup
qmk config user.keymap=spideyclick
qmk new-keymap -kb keebio/iris/rev4

At this point, you're going to want to make a few changes:

  • rules.mk: Enable mouse keys and reduce file size
EXTRAFLAGS += -flto     # Keeps file size low
MOUSEKEY_ENABLE = yes   # Gotta have those mouse keys!
  • config.h: Reduce file size by removing macros and actions.

    • This might bite me later if I decide I need these eventually.

#define NO_ACTION_MACRO
#define NO_ACTION_FUNCTION

With those changes complete, go for a compile:

qmk json2c -o /c/Users/spideyclick/qmk_firmware/keyboards/keebio/iris/keymaps/spideyclick/keymap.c /your/path/to/my-keymap.json
qmk compile

If all goes well, it should give you a .hex file in ~/qmk_firmware/.build/. You can load that in QMK ToolBox to flash your keyboard.