Compiling ZMK firmware | About Split Keyboards - Resources

Halcyon config template

We've set up a ZMK Halcyon config on our Github page.

Using a ZMK config makes it easy to compile firmware and keep up with upstream changes. This config repository is already set up to point to the ZMK Halcyon module repository.

The process of setting up the ZMK config is documented in the README in the repository linked below.

Go to the zmk-halcyon-config repo

If you only want to change your keymap, we recommend using the keymap editor created by nickcoutsos. Here you can link your zmk-halcyon-config and make changes that are otherwise not possible in ZMK-studio and easily compile them back in to flashable files.

Go to the keymap editor page

Compiling QMK firmware

How to make and compile custom QMK firmware.

Using non Halcyon VIK module

How to use VIK module which has not been designed for Halcyon keyboards.

Questions? Help us improve!

Do you have questions after reading the documentation? Do you have feedback about this page, or about the documentation in general? Please send us an email. You can use the buttons below which will open your mail client or app with a template, or send your mail to support@splitkb.com.

I have a question I'd like to share feedback