Miryoku ZMK Supported Keyboards and ZMK Out-of-Tree Keyboards Directory #81
manna-harbour
announced in
Announcements
Replies: 1 comment 1 reply
This comment has been hidden.
This comment has been hidden.
This comment has been hidden.
This comment has been hidden.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
This is the defacto ZMK out-of-tree keyboards directory. For use outside of Miryoku ZMK, checkmarks and strikethrough can be ignored.
Checked keyboards are supported in Miryoku ZMK. Support for unchecked keyboards will be added upon request. Struck out keyboards are not applicable (numpads and macropads), or have been superseded by another entry. Also see the Miryoku ZMK Supported Keyboards documentation.
In-Tree Keyboards
Onboard Controller Keyboards
BDN9 Rev2 (Board: bdn9_rev2)Composite Keyboards
Pro Micro Interconnect
Boardsource 3x4 Macropad (Shield: boardsource3x4)Eternal Keypad Lefty (Shield: eternal_keypad_lefty)Eternal Keypad (Shield: eternal_keypad)Knob Goblin (Shield: knob_goblin)MurphPad (Shield: murphpad)Romac+ Macropad (Shield: romac_plus)Romac Macropad (Shield: romac)Tidbit Numpad (Shield: tidbit)2% Milk (Shield: two_percent_milk)MakerDiary nRF52840 M.2 Interconnect
Seeed XIAO Interconnect
Out-of-Tree Keyboards
Keyboards in italics require a fork of ZMK, and the repository is given in parenthesis.
Onboard Controller Keyboards
ahokorehttps://github.com/dezlidezlidezli/ahokore-zmk-config/tree/master/config/boards/arm/ahokore Adds support for the Ahokore V2 zmkfirmware/zmk#743adv360https://github.com/PolarityWorks/zmk-config-adv360/tree/main/config/boards/arm/adv360adv360https://github.com/KinesisCorporation/Adv360-Pro-ZMK/tree/V2.0/config/boards/arm/adv360 (https://github.com/refil/zmk/tree/adv360-z3) [ergo split] [can also use adv360pro]adv360profeat(boards) Kinesis Advantage 360 pro zmkfirmware/zmk#1454 [ergo split] [can also use adv360]ble_chiffrehttps://github.com/tominabox1/zmk-config2/tree/master/config/boards/arm/ble_chiffreble_chiffrehttps://github.com/NCKiser/zmk-config/tree/master/config/boards/arm/ble_chiffrebt65https://github.com/PolarityWorks/zmk-config-ckp/tree/bt65-ISO/config/boards/arm/bt65 [65%]chockeahttps://github.com/vattern/zmk-config/tree/master/config/boards/arm/chockeacorne-ish_zenhttps://github.com/LOWPROKB/zmk/tree/Board-Corne-ish-Zen-dedicated-work-queue/app/boards/arm/corne-ish_zen (https://github.com/LOWPROKB/zmk/tree/Board-Corne-ish-Zen-dedicated-work-queue) [ero split] [can also use corneish_zen_v1]corneish_zen_v1feat(boards): Add Corne-ish Zen v1 zmkfirmware/zmk#1593 [ero split] [can also use corne-ish_zen]cyber60_rev_dadding cyber60 PCB support zmkfirmware/zmk#354 [60%]daohttps://github.com/yumagulovrn/dao-zmk-config [ergo split]draculadyhttps://github.com/MangoIV/zmk/tree/draculady/app/boards/arm/draculady [ergo split]ffkb-holyiothttps://github.com/sadekbaroudi/zmk-ffkb-holyiot/tree/master/boards/arm/ffkb-holyiothakeahttps://github.com/vattern/zmk-config/tree/master/config/boards/arm/hakeahannah60_bfeat(board): add Hannah60B to board zmkfirmware/zmk#1448 [60%]klacker_bshttps://github.com/weteor/Klacker_BS-Config/tree/main/boards/arm/klacker_bsle_chiff_blehttps://github.com/MangoIV/le_chiff_ble_config/tree/master/zmk-config/boards/arm/le_chiff_ble [ergo]lpgalaxy_blank_slatehttps://github.com/petejohanson/blank-slate-zmk-module/tree/main/boards/arm/lpgalaxy_blank_slate [ortho]one42https://github.com/cyril279/zmk-config-one42/tree/main/config/boards/arm/one42pawPaw zmkfirmware/zmk#774peachAdd Peach keyboard zmkfirmware/zmk#1081 [65%]polilla_wAdd the Polilla keyboard zmkfirmware/zmk#612 [ergo]preonic_rev3Add support for the Preonic rev3 board to ZMK zmkfirmware/zmk#228scyllahttps://github.com/vattern/zmk-config/tree/master/config/boards/arm/scyllaslicemk_ergodoxhttps://github.com/slicemk/zmk/tree/v20210618/app/boards/arm/slicemk_ergodox [ergo split]technikablehttps://github.com/petejohanson/technikable-zmk-config/tree/main/boards/arm/technikabletipper_tfhttps://github.com/weteor/Tipper_TF-Config/tree/master/boards/arm/tipper_tf (https://github.com/weteor/zmk/tree/Tipper_TF_rev2)tornbluehttps://github.com/rtitmuss/zmk/tree/tornblue_r1/app/boards/arm/tornblue [ergo split]zaphodhttps://github.com/petejohanson/zaphod-config/tree/main/boards/arm/zaphodComposite Keyboards
Pro Micro Interconnect
absolemhttps://github.com/mrzealot/zmk-config/tree/master/ahokorehttps://github.com/dezlidezlidezli/zmk-config/tree/master/config/boards/shields/ahokoreajisaihttps://github.com/dcored13/zmk-master/tree/main/app/boards/shields/ajisai [ergo]arch36https://git.sr.ht/~hwrd/zmk-config/tree/main/item/boards/arch36arch36https://github.com/okke-formsma/zmk-config/tree/arch36/config/boards/shields/arch36atreus_chocAdd atreus_choc shield. zmkfirmware/zmk#751 [ergo]babyvblefeat(shield): add support of BabyvBle shield zmkfirmware/zmk#967 [ergo]barobordhttps://github.com/sadekbaroudi/zmk-barobord/tree/master/config/boards/shields/barobordbastylAdding Bastyl shield zmkfirmware/zmk#604 [also for use with tbk and scylla]bat43https://github.com/dnaq/zmk/tree/bat43-keymap/app/boards/shields/bat43battootahttps://github.com/AlaaSaadAbdo/zmk-config/tree/master/config/boards/shields/battoota [ergo split]beryllinehttps://github.com/jcmkk3/zmk-config/tree/main/config/boards/shields/beryllinebluehandAdd Bluehand Macropad - locally tested zmkfirmware/zmk#970boardsource4x12https://github.com/alinelena/mlego-zmk/tree/main/config/boards/shields/boardsource4x12 [ortho]breezeAdd shield for Afternoon Labs Breeze rev1 zmkfirmware/zmk#735breezefeat(shields): Add Breeze zmkfirmware/zmk#1125breezeadded variations of breeze & default keymap zmkfirmware/zmk#1312btrfldhttps://github.com/SolidHal/zmk/tree/main/app/boards/shields/btrfld [ergo]cafeBabeBase code for the DEFCON Cafe Babe keyboard zmkfirmware/zmk#894choc-cornehttps://github.com/Putitii/zmk-choc_corne/tree/main/config/boards/shields/haploinsufficient [ergo split] [for chocorne36-n!n]chocofihttps://github.com/Shahabaz-Bagwan/zmk-config/tree/master/config/boards/shields/chocofi [ergo split] [can also use corne]chocoflyhttps://github.com/vlkv/chocofly-zmk-config/tree/master/config/boards/shields/chocofly [ergo]choconumfeat(boards): Add Choconum board. zmkfirmware/zmk#940chocvhttps://github.com/brickbots/chocV/tree/main/zmk_config/boards/shields/chocv [also for use with slabv]clueboard_california Initial working Clueboard California Macropad w/ proton-c fixes zmkfirmware/zmk#39dactyl_cchttps://github.com/DarkFox/dactyl-cc-zmk/tree/master/config/boards/shields/dactyl_ccdactyl_manuform_4x5Add dactyl manuform 4x5 shield zmkfirmware/zmk#760 [ergo split]dilemmahttps://github.com/0xcharly/zmk-config/tree/master/config/boards/shields/dilemma [ergo split]draculadhttps://github.com/MangoIV/zmk/tree/draculad/app/boards/shields/draculadduckboardduckboard compatibility zmkfirmware/zmk#634duckfoot3https://github.com/dodubassman/zmk-config-duckfoot-rev3/tree/master/config/boards/shields/duckfoot3 [ergo split]dumboAdded Dumbo keyboard shield zmkfirmware/zmk#747 [ergo split]dumbpadfeat(shields): Add dumbpad zmkfirmware/zmk#1137ergodashhttps://github.com/Eyenseo/zmk/tree/main/app/boards/shields/ergodashergos1_oeErgo S-1 OE zmkfirmware/zmk#1333 [ergo split]ergotravelhttps://github.com/jchenVT/zmk_ergotravel/tree/main/config/boards/shields/ergotravelexkeyliburhttps://github.com/tlietz/zmk-config/tree/main/config/boards/shields/exkeylibur [ergo split]faw36https://github.com/Germain-Gadel/zmk-config-faw36/tree/master/config/boards/shields/faw36 [ergo split]fififeat(shields): Add Fifi Shield Support zmkfirmware/zmk#1008 [ergo split] [can also use corne]ffkbhttps://github.com/sadekbaroudi/zmk-ffkb/tree/master/config/boards/shields/ffkbgatoraid40https://github.com/freya-irl/zmk/tree/main/app/boards/shields/gatoraid40gherkinAdd Gherkin Sheild zmkfirmware/zmk#355gherkinAdd Gherkin shield zmkfirmware/zmk#748helix_4Helix (4 row) zmkfirmware/zmk#585 [ortho] [can also use helix]hhkbhttps://github.com/kanru/hhkb-nicenano-zmk/tree/main/config/boards/shields/hhkb [60%]hillside48https://github.com/mmccoyd/zmk-config/tree/master/config/boards/shields/hillside48 feat(shield): Add Hillside support zmkfirmware/zmk#1047hillside52https://github.com/mmccoyd/zmk-config/tree/main/config/boards/shields/hillside52 [ergo split]horizonhttps://github.com/skarrmann/zmk-config/tree/master/config/boards/shields/horizon feat(shield): add Horizon shield zmkfirmware/zmk#1000humlahttps://github.com/smores56/zmk-config-humla/tree/main/config/boards/shields/humla [ergo]klorhttps://github.com/GEIGEIGEIST/zmk-config-klor/tree/master/config [ergo split]klotzhttps://github.com/GEIGEIGEIST/zmk-config-klotz/tree/master/config [ergo split]launchpadAdd spacecat.design Launchpad to shields zmkfirmware/zmk#703lets_splitfeat(shields): Add let's split shield zmkfirmware/zmk#746 [ortho split]levinsonAdded support for the Keebio Levinson Rev 3 Shield. zmkfirmware/zmk#566lodash33Add lodash33 shield zmkfirmware/zmk#283 [ortho 30%]lunahttps://github.com/mindhatch/zmk-config-luna/tree/master/config/boards/shields/luna [ergo split]mach3Mach3 Shield zmkfirmware/zmk#1168mano42https://github.com/harshitgoel96/zmk/tree/mano_kb/app/boards/shields/mano42mercuryhttps://github.com/jmding8/zmk/tree/mercury_3x5%2B3/app/boards/shields/mercury [split 40%]micro10https://github.com/dcpedit/zmk/tree/dcpedit/app/boards/shields/micro10 [30%]microdox_v2Please add Microdox v2 ZMK support #217 [ergo split]mokulua[New Shield] Mokulua zmkfirmware/zmk#1297 [split 65%]naked48https://github.com/kitchen/zmk-config/tree/kitchen/naked48-shield/config/boards/shields/naked48 [ortho]pinkiesouthttps://github.com/sadekbaroudi/zmk-pinkiesout/tree/master/config/boards/shields/pinkiesoutpockettypehttps://github.com/sfgabe/zmk-config-pockettype/tree/master/config/boards/shields/pockettypepockettypefeat(shields): add pockettype thumb board zmkfirmware/zmk#672pteron36New Sheild Pteron36 zmkfirmware/zmk#1364rae_duxhttps://github.com/andrewjrae/zmk-config/tree/development/config/boards/shields/rae_duxrebound_v4Rebound v4 - New shield support zmkfirmware/zmk#546rev1350https://github.com/cyril279/zmk-config-rev41_1350/tree/main/config/boards/shields/rev1350 [reviung 41 LP] [ergo]reviung34Upstream shield for reviung34 zmkfirmware/zmk#1264 [ergo]reviung34https://github.com/kitchen/zmk-config/tree/main/config/boards/shields/reviung34 [ergo]reviung39Adding Reviung39 shield zmkfirmware/zmk#622reviung39Reviung39 Support zmkfirmware/zmk#695reviung39Add Board Shield for Reviung 39 zmkfirmware/zmk#795revlpfeat(shields): Add revlp shield. zmkfirmware/zmk#1482 [ergo]roadsterAdd Roadster Shield zmkfirmware/zmk#768 [40%]rockonhttps://github.com/sadekbaroudi/zmk-rockon/tree/master/config/boards/shields/rockonrollowhttps://github.com/barbellboards/Rollow-ZMK/tree/barbellboards/rollow/app/boards/shields/rollow [ergo split]scylla_dmmpcbhttps://github.com/meln1k/zmk-config/tree/master/config/boards/shields/scylla_dmmpcbshapeshifter4060Adding Kitsune Keyboards - Shapeshifter4060 board zmkfirmware/zmk#1123 [ergo]skeletyl_v2_elitechttps://github.com/meln1k/zmk-config/tree/master/config/boards/shields/skeletyl_v2_elitec [ergo split] [can also use tbkmini_adapterv2]sofle_rgbhttps://github.com/gregghz/zmk-config/tree/master/config/boards/shields/sofle_rgbsofle_rgb_keyhiveAdd Support for Keyhive Variant of Sofle RGB zmkfirmware/zmk#1233 [ergo split]soyuz[New Shield] Soyuz zmkfirmware/zmk#1073spacepadAdd files for Spacepad macropad zmkfirmware/zmk#785sweet16feat(boards): Add 1up sweet 16 macropad zmkfirmware/zmk#1102swweeephttps://github.com/sadekbaroudi/zmk-swweeep/tree/master/config/boards/shields/swweeep [ergo split]tairahttps://github.com/strayer/taira-keyboard-zmk-config/tree/main/config/boards/shields/taira [ergo split]tbkminihttps://github.com/cwebster2/zmk-config/tree/main/config/boards/shields/tbkmini [also for use with skeletyl]tbkmini_adapterv2https://github.com/karrui/zmk-config-skeletyl-v2/tree/tbkmini-adapterv2/config/boards/shields/tbkmini [also for use with skeletyl]temperhttps://github.com/raeedcho/temper-zmk-config/tree/main/config/boards/shields/temper [ergo split]tightylhttps://github.com/MvEerd/zmk-config/tree/master/config/boards/shields/tightyltwo_percent_milkAdded support for 2% Milk shield. zmkfirmware/zmk#684untitledhttps://github.com/AnthonyAmanse/zmk-config/tree/main/config/boards/shields/untitled [ergo split]ut47Add ut47 / GNAP2 zmkfirmware/zmk#641 [40%]viterbiadd viterbi support zmkfirmware/zmk#687wing36Wing36 zmkfirmware/zmk#1388 [ergo split]yasuihttps://github.com/jazemo19/zmk/tree/main/app/boards/shields/yasui [ortho]yasuihttps://github.com/jazemo19/yasui-v2/tree/main/config/boards/shields/yasui [ortho]Seeed XIAO Interconnect
chipperhttps://github.com/JonMuller/gerbers/tree/main/corne-choc-xiao/zmk_starter/view [ergo split]clog_v2https://github.com/smores56/clog-v2-zmk-config/tree/main/config/boards/shields/clog_v2 [ergo split, seeeduino_xiao_ble only]kleinhttps://github.com/snsten/Klein-zmk/tree/main/config/boards/shields/klein [ergo split]kpukboardRequest adding ZMK support for kpukboard #219 [ergo split]revxlphttps://github.com/petejohanson/revxlp-config/tree/main/config/boards/shields/revxlp (https://github.com/petejohanson/zmk/tree/drivers/gpio-595-shift-register) [ergo]rommanahttps://github.com/AlaaSaadAbdo/zmk-config/tree/master/config/boards/shields/rommana [ergo split]totemhttps://github.com/GEIGEIGEIST/zmk-config-totem/tree/master/config/boards/shields/totem [ergo split]zaphod_litehttps://github.com/petejohanson/zaphod-config/tree/zaphod-lite/boards/shields/zaphod_liteOther
adafruit_feather_nrf52840feat(board): Add Adafruit Feather NRF52840 board zmkfirmware/zmk#1465bluemicro833feat(boards): Add BlueMicro833 V1 board definition zmkfirmware/zmk#972bluemacro840_v1feat(boards): add Bluemacro840 board zmkfirmware/zmk#708microdox_modhttps://github.com/abondis/zmk-config/tree/main/config/boards/shields/microdox_modnucleo_wb55cg_dongle,zephirumAdd support for Nucleo WB55CG board & Zephirum shield zmkfirmware/zmk#938sparkfun_nrf52840_minihttps://github.com/abondis/zmk-config/tree/main/config/boards/arm/sparkfun_nrf52840_miniUnmaintained Out-of-Tree Keyboards
ZMK change from Zephyr 3.0 to Zephyr 3.2
Keyboards that worked with ZMK based on Zephyr 3.0 but have not been updated with the changes required for Zephyr 3.2 can still be built with ZMK based on Zephyr 3.0, but later additions and changes in ZMK will not be available. Use https://github.com/manna-harbour/zmk/tree/zephyr-3.0 as the ZMK fork when building locally, or
manna-harbour/zmk/zephyr-3.0with thebranchesoption when building with the Miryoku ZMK build workflows.For use with the mouse keys PR, merge https://github.com/manna-harbour/zmk/tree/zephyr-3.0 and https://github.com/urob/zmk/tree/mouse-3.2 as the ZMK fork when building locally, or use
manna-harbour/zmk/zephyr-3.0 urob/zmk/mouse-3.2with thebranchesoption when building with the Miryoku ZMK build workflows.ZMK change from Zephyr 2.5 to Zephyr 3.0
Keyboards that worked with ZMK based on Zephyr 2.5 but have not been updated with the changes required for Zephyr 3.0 can still be built with ZMK based on Zephyr 2.5, but later additions and changes in ZMK will not be available. Use https://github.com/manna-harbour/zmk/tree/zephyr-2.5 as the ZMK fork when building locally, or
manna-harbour/zmk/zephyr-2.5with thebranchesoption when building with the Miryoku ZMK build workflows. For the mousekeys PR, use https://github.com/manna-harbour/zmk/tree/zephyr-2.5+krikun98-mouse-pr /manna-harbour/zmk/zephyr-2.5+krikun98-mouse-pr.Updating Unmaintained Out-of-Tree Keyboards
To update an out-of-tree keyboard definition:
Beta Was this translation helpful? Give feedback.
All reactions