65f8da3034
Fix reddit link Duplicate open parenthesis next to close parenthesis on NSSL Add customisation instructions Add lily58 Add gergo Co-authored-by: Jonathan Dayton <jonathandayton23@gmail.com> Clean up LAYOUT macro formatting Add alternative vi-style navigation layout Add kyria Add minidox Change order of keyboards Add iris Expand TOC Re-order userspace subheadings Add atreus Add customisation section Add split_3x5_3 and split_3x6_3 layouts Add for_science Fix wrong paths in keyboard config.h and keymap.c headings Fix keyboard ordering Fix blank lines around headings Add compatibility with new org-mode version. Remove keyboards/crkbd now covered by layouts/split_3x6_3 Add Halmak Alphabetise alternative alpha arrangements Move build options out of base layer alphas headings Add list of keyboards supporting split_3x5_3 layout Enable Auto Shift and Retro Shift Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) Change kyria thumb key mapping Add planck_mit layout Remove alternative bottom row support from ortho_4x12 Remove minidox - Covered by split_3x5_3 layout Add moonlander Remove KC_ macros Add 60_ansi layout Add ortho_5x15 layout Closes manna-harbour/qmk_firmware#5 Co-authored-by: Rob <rob@debank.tv> Fix typo (manna-harbour/qmk_firmware#7) Author: sonnius <sonnius@users.noreply.github.com> Add redox_w (manna-harbour/qmk_firmware#8) Author: Brian Romanko <hello@bromanko.com> Co-authored-by: Manna Harbour <51143715+manna-harbour@users.noreply.github.com> Add AUTO_SHIFT_NO_SETUP to reduce firmware size Update image paths Add instructions to checkout development branch Add kyria extended thumbs option, change default, add KLE Change clipboard keys - Change order to be mirror of windows bindings - Change default to use CUA bindings for Cut, Copy, and Paste, and Fun Cluster bindings for Undo and Redo - Add alternative bindings - Fun Cluster (original miryoku bindings) - Mac - Windows - Change prefix for local macros from X_ to U_ Disable Retro Shift, enable Auto Shift for non-alphas Revert "Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping)" Add Experimental Features section Update miryoku image link Update cover image link Add dactyl_manuform/4x5 Add cutomisation examples Add https to remote example Fix dactyl_manuform/4x5 subset mapping Add extended thumbs to ortho_4x12 Update Colemak Mod-DH naming Closes manna-harbour/qmk_firmware#13 Add dactyl_manuform/5x6 Resolves manna-harbour/qmk_firmware#14 Co-authored-by: Sebastian Morales <sebastian.moralesd@gmail.com> Add note on FORCE_LAYOUT - Needed to use EXTENDED_THUMBS on planck Add parent directories to keyboard headings and re-order Add keyboardio/atreus Resolves manna-harbour/qmk_firmware#15 Add torn Resolves manna-harbour/qmk_firmware#16 Author: Brian Romanko <hello@bromanko.com> Co-authored-by: Manna Harbour <51143715+manna-harbour@users.noreply.github.com> Change map to zip - Adds support for python3, still compatible with python2. Resolves manna-harbour/qmk_firmware#10 Resolves manna-harbour/qmk_firmware#19 Co-authored-by: Ori <ori@oribarbut.com> Add python-version Add sofle Add ergotravel Add ortho_5x12 Add ortho_4x10 Add :main no header argument to C code blocks resolves manna-harbour/qmk_firmware#11 resolves manna-harbour/qmk_firmware#12 Co-authored-by: RubioJr9 <u0893472@utah.edu> Add flipped layers and inverted-T nav alternative layouts - Separate tap_table into alphas_table and thumbs_table - Add mode argument to table-layout-half - Remove layer_name - Rename layers - Add mods and clipboard to MBO and mirror - Add MIRYOKU_LAYERS=FLIP - Add MIRYOKU_NAV=INVERTEDT Add layer diagrams Update contact section Update links for Bilateral Combinations and Retro Shift Add description and no reverse angle option to 60_ansi layout Update list of keyboards supporting community layouts - and example build command lines Change moonlander thumb keys Update list of keyboards supporting split_3x5_3 Add license to tangled C source files |
||
---|---|---|
.. | ||
0_sixty | ||
0xcb | ||
1upkeyboards | ||
2key2crawl | ||
4by3 | ||
4pplet | ||
6ball | ||
7c8/framework | ||
7skb | ||
7splus | ||
8pack | ||
9key | ||
10bleoledhub | ||
30wer | ||
40percentclub | ||
45_ats | ||
abacus | ||
absinthe | ||
abstract/ellipse | ||
acekeyboard/titan60 | ||
acheron | ||
acr60 | ||
adelheid | ||
adkb96 | ||
aeboards | ||
afternoonlabs | ||
ai03 | ||
ajisai74 | ||
akb | ||
akegata_denki/device_one | ||
al1 | ||
aleblazer/zodiark | ||
aleth42 | ||
alf | ||
alfredslab/swift65/solder | ||
allison | ||
allison_numpad | ||
alpha | ||
alpine65 | ||
alps64 | ||
alu84 | ||
amag23 | ||
amj40 | ||
amj60 | ||
amj96 | ||
amjkeyboard/amj66 | ||
amjpad | ||
anavi | ||
angel17 | ||
angel64 | ||
aos/tkl | ||
aplyard/aplx6 | ||
arabica37 | ||
arch_36 | ||
ares | ||
arisu | ||
arrayperipherals | ||
ash1800 | ||
ash_xiix | ||
ashpil/modelm_usbc | ||
at101_bh | ||
at_at/660m | ||
atomic | ||
atreus | ||
atreus62 | ||
atxkb | ||
aves65 | ||
axolstudio | ||
babyv/keymaps/melonbred | ||
baguette | ||
bakeneko60 | ||
bakeneko65 | ||
bakeneko80 | ||
bantam44 | ||
barleycorn | ||
barleycorn_smd | ||
barracuda | ||
basekeys | ||
basketweave | ||
bastardkb | ||
bat43 | ||
bear_face | ||
beatervan | ||
bemeier/bmek | ||
bfake | ||
bigseries | ||
binepad/bn003 | ||
bioi | ||
blackplum | ||
blank_tehnologii/manibus | ||
blockey | ||
bm16a | ||
bm16s | ||
bm40hsrgb | ||
bm43a | ||
bm60poker | ||
bm60rgb | ||
bm60rgb_iso | ||
bm68rgb | ||
boardrun | ||
boardsource | ||
boardwalk | ||
bop | ||
boston | ||
boston_meetup | ||
botanicalkeyboards/fm2u | ||
box75 | ||
bpiphany | ||
bt66tech/bt66tech60 | ||
bthlabs/geekpad | ||
buildakb | ||
business_card | ||
butterstick | ||
c39 | ||
caffeinated/serpent65 | ||
cannonkeys | ||
capsunlocked | ||
carbo65 | ||
cassette42 | ||
catch22 | ||
centromere | ||
charue/sunsetter | ||
chavdai40 | ||
checkerboards | ||
cherrybstudio/cb87 | ||
cheshire/curiosity | ||
chidori | ||
chili | ||
chimera_ergo | ||
chimera_ls | ||
chimera_ortho | ||
chimera_ortho_plus | ||
chlx/merro60 | ||
choc_taro | ||
choco60 | ||
christmas_tree | ||
ck60i | ||
ckeys | ||
claw44 | ||
clawsome | ||
clueboard | ||
cmm_studio/saka68 | ||
coarse/cordillera | ||
cocoa40 | ||
comet46 | ||
contra | ||
converter | ||
cool836a | ||
copenhagen_click/click_pad_v1 | ||
coseyfannitutti | ||
cospad | ||
cozykeys | ||
craftwalk | ||
crawlpad | ||
crazy_keyboard_68 | ||
crbn | ||
crkbd | ||
cu24 | ||
cu75 | ||
cu80 | ||
custommk/genesis | ||
cutie_club | ||
cybergear/macro25 | ||
daisy | ||
daji/seis_cinco | ||
db/db63 | ||
dc01 | ||
dekunukem/duckypad | ||
delikeeb | ||
delilah | ||
deltasplit75 | ||
dichotomy | ||
dinofizz/fnrow/v1 | ||
diverge3 | ||
divergetm2 | ||
dk60 | ||
dm9records | ||
dmqdesign/spin | ||
do60 | ||
donutcables | ||
doodboard | ||
doppelganger | ||
doro67 | ||
dozen0 | ||
dp60 | ||
draculad | ||
draytronics | ||
dubba175 | ||
duck | ||
dumbo | ||
dumbpad | ||
durgod | ||
dz60 | ||
dztech | ||
e88 | ||
ealdin | ||
earth_rover | ||
ebastler | ||
eco | ||
edc40 | ||
eek | ||
efreet | ||
eggman | ||
emajesty/eiri | ||
emptystring/NQG | ||
eniigmakeyboards | ||
ep | ||
epoch80 | ||
ergo42 | ||
ergoarrows | ||
ergodash | ||
ergodone | ||
ergodox_ez | ||
ergodox_infinity | ||
ergodox_stm32 | ||
ergosaurus | ||
ergoslab | ||
ergotaco | ||
ergotravel | ||
ericrlau/numdiscipline | ||
espectro | ||
eve/meteor | ||
evil80 | ||
evolv | ||
evyd13 | ||
exclusive | ||
exent | ||
eyeohdesigns | ||
facew | ||
fallacy | ||
fc660c | ||
fc980c | ||
feels/feels65 | ||
felix | ||
ferris | ||
ffkeebs/siris | ||
fjlabs | ||
flehrad | ||
fleuron | ||
fluorite | ||
flx | ||
flxlb/zplit | ||
flygone60/rev3 | ||
foostan/cornelius | ||
for_science | ||
forever65 | ||
fortitude60 | ||
four_banger | ||
foxlab | ||
fr4 | ||
fractal | ||
freyr | ||
friedrich | ||
ft/mars80 | ||
function96 | ||
funky40 | ||
gami_studio/lex60 | ||
gboards | ||
geekboards | ||
geminate60 | ||
generic_panda/panda65_01 | ||
genone | ||
georgi | ||
gergo | ||
getta25 | ||
ggkeyboards/genesis | ||
gh60 | ||
gh80_3000 | ||
ghs/rar | ||
gingham | ||
gkeyboard/gkb_m16 | ||
gmmk | ||
gon | ||
gowla | ||
gray_studio | ||
grid600 | ||
gskt00 | ||
gvalchca | ||
hadron | ||
halberd | ||
hand88 | ||
handwired | ||
hardlineworks/otd_plus | ||
hecomi | ||
heliar/wm1_hotswap | ||
helix | ||
hhkb | ||
hhkb_lite_2 | ||
hid_liber | ||
hidtech/bastyl | ||
hifumi | ||
hineybush | ||
holyswitch/southpaw75 | ||
honeycomb | ||
hotdox | ||
hp69 | ||
hs60 | ||
hub16 | ||
hub20 | ||
id80 | ||
id87 | ||
idb/idb_60 | ||
idobo | ||
illuminati/is0 | ||
illusion/rosa | ||
ilumkb/primus75 | ||
inett_studio/sqx | ||
infinity60 | ||
iriskeyboards | ||
iron180 | ||
ivy | ||
j80 | ||
jacky_studio | ||
jae/j01 | ||
jagdpietr/drakon | ||
jc65 | ||
jd40 | ||
jd45 | ||
jian | ||
jiran | ||
jisplit89 | ||
jj4x4 | ||
jj40 | ||
jj50 | ||
jkdlab/binary_monkey | ||
jm60 | ||
jnao | ||
jones | ||
just60 | ||
k_type | ||
kabedon | ||
kagamidget | ||
kb_elmo | ||
kbdclack/kaishi65 | ||
kbdfans | ||
kc60 | ||
kc60se | ||
keebio | ||
keebsforall/freebird60 | ||
keebwerk | ||
keebzdotnet | ||
keybage/radpad | ||
keyboardio | ||
keycapsss | ||
keyhive/maypad | ||
keyprez/corgi | ||
keysofkings/twokey | ||
kikoslab/kl90 | ||
kindakeyboards/conone65 | ||
kinesis | ||
kingly_keys | ||
kira75 | ||
kira80 | ||
kiwikeebs | ||
kiwikey | ||
kmac | ||
kmac_pad | ||
kmini | ||
knobgoblin | ||
knops | ||
kona_classic | ||
kopibeng/xt65 | ||
kudox | ||
kudox_game | ||
kv/revt | ||
ky01 | ||
kyria | ||
labyrinth75 | ||
laptreus | ||
latin6rgb | ||
latin17rgb | ||
latin47ble | ||
latin60rgb | ||
latin64ble | ||
latinpad | ||
latinpadble | ||
lattice60 | ||
launchpad | ||
lazydesigners | ||
lck75 | ||
le_chiffre | ||
leafcutterlabs/bigknob | ||
leeku/finger65 | ||
lets_split | ||
lets_split_eh | ||
lfkeyboards | ||
lily58 | ||
linworks/whale75 | ||
littlealby | ||
lizard_trick/tenkey_plusplus | ||
lm_keyboard/lm60n | ||
longnald/corin | ||
lucid | ||
m3n3van | ||
m10a | ||
majistic | ||
makrosu | ||
manta60 | ||
marksard | ||
massdrop | ||
masterworks/classy_tkl | ||
matrix | ||
maxipad | ||
maxr1998 | ||
mb44 | ||
mc_76k | ||
mechkeys/mk60 | ||
mechllama/g35 | ||
mechlovin | ||
mechmini | ||
mechstudio | ||
mechwild | ||
mehkee96 | ||
meira | ||
meishi | ||
meishi2 | ||
melgeek | ||
melody96 | ||
meme | ||
merge | ||
mesa/mesa_tkl | ||
meson | ||
metamechs/timberwolf | ||
mexsistor/ludmila | ||
miller/gm862 | ||
millipad | ||
miniaxe | ||
minidox | ||
minim | ||
minimacro5 | ||
mint60 | ||
mio | ||
misonoworks/karina | ||
misterknife | ||
mitosis | ||
miuni32 | ||
mixi | ||
mode/eighty | ||
molecule | ||
monarch | ||
monstargear/xo87 | ||
montex | ||
montsinger | ||
moon | ||
moonlander | ||
mountainblocks/mb17 | ||
mschwingen/modelm | ||
mt40 | ||
mt64rgb | ||
mt84 | ||
mt980 | ||
murcielago | ||
mxss | ||
mysticworks/wyvern | ||
nack | ||
nafuda | ||
naked48 | ||
naked60 | ||
naked64 | ||
namecard2x4 | ||
navi10 | ||
ncc1701kb | ||
nebula12 | ||
nebula68 | ||
nek_type_a | ||
nemui | ||
neokeys/g67 | ||
neopad | ||
newgame40 | ||
nibiria/stream15 | ||
nightingale_studios/hailey | ||
nightly_boards | ||
nightmare | ||
nimrod | ||
niu_mini | ||
nix_studio/oxalys80 | ||
nk1 | ||
nk65 | ||
nk87 | ||
nknl7en | ||
nknl7jp | ||
nomu30 | ||
nopunin10did | ||
novelpad | ||
noxary | ||
np12 | ||
nullbitsco | ||
numatreus | ||
oddball | ||
oddforge/vea | ||
odelia | ||
ogre | ||
ok60 | ||
omnikey_bh | ||
omnikeyish | ||
opendeck | ||
opus | ||
orange75 | ||
org60 | ||
ortho5by12 | ||
orthodox | ||
otaku_split | ||
pabile | ||
paladin64 | ||
palette1202 | ||
panc40 | ||
panc60 | ||
pandora | ||
pdxkbc | ||
pearl | ||
peej/lumberjack | ||
peiorisboards/ixora | ||
percent | ||
phantom | ||
phase_studio/titan65 | ||
phoenix | ||
pico | ||
picolab/frusta_fundamental | ||
pimentoso/paddino02 | ||
pinky | ||
pisces | ||
pistachio | ||
pistachio_mp | ||
pizzakeyboards/pizza65 | ||
pkb65 | ||
planck | ||
playkbtw | ||
plexus75 | ||
ploopyco | ||
plume/plume65 | ||
plx | ||
pohjolaworks/louhi | ||
polilla | ||
polycarbdiet | ||
pom_keyboards/tnln95 | ||
pos78 | ||
preonic | ||
primekb | ||
program_yoink | ||
projectkb | ||
prototypist/j01 | ||
pteron36 | ||
puck | ||
punk75 | ||
pursuit40 | ||
qaz | ||
quad_h/lb75 | ||
quantrik/kyuu | ||
quark | ||
qvex | ||
qwertyydox | ||
rabbit/rabbit68 | ||
rabbit_capture_plan | ||
rainkeeb | ||
ramonimbao | ||
rart | ||
rect44 | ||
redox | ||
redox_w | ||
redscarf_i | ||
redscarf_iiplus | ||
retro_75 | ||
reversestudio/decadepad | ||
reviung33 | ||
reviung34 | ||
reviung39 | ||
reviung41 | ||
reviung61 | ||
rgbkb | ||
rocketboard_16 | ||
rominronin/katana60 | ||
roseslite | ||
rotr | ||
rpiguy9907/southpaw66 | ||
rubi | ||
runner3680 | ||
ryloo_studio/m0110 | ||
sam | ||
sanctified/dystopia | ||
satt/vision | ||
scarletbandana | ||
scatter42 | ||
sck | ||
scythe | ||
seigaiha | ||
sendyyeah | ||
senselessclay/had60 | ||
sentraq | ||
setta21 | ||
shambles | ||
shiro | ||
shk9 | ||
sidderskb/majbritt | ||
signum/3_0/elitec | ||
silverbullet44 | ||
singa | ||
sirius | ||
sixkeyboard | ||
skeletn87 | ||
skergo | ||
slz40 | ||
smallice | ||
smk60 | ||
snampad | ||
sneakbox | ||
sofle | ||
soup10 | ||
southpole | ||
sowbug | ||
soy20 | ||
space_space | ||
spaceman | ||
spacetime | ||
sparrow62 | ||
specskeys | ||
spiderisland/split78 | ||
splitish | ||
splitkb/zima | ||
splitreus62 | ||
splitty | ||
squiggle | ||
standaside | ||
staryu | ||
steal_this_keyboard | ||
stella | ||
studiokestra | ||
subatomic | ||
suihankey | ||
swiftrax/retropad | ||
switchplate | ||
sx60 | ||
tada68 | ||
taleguers/taleguers75 | ||
tanuki | ||
tau4 | ||
technika | ||
telophase | ||
tempo_turtle/bradpad | ||
tender/macrowo_pad | ||
tenki | ||
terrazzo | ||
tetris | ||
tg4x | ||
tgr | ||
the_royal | ||
the_ruler | ||
the_uni | ||
thedogkeyboard | ||
themadnoodle | ||
thevankeyboards | ||
tkc | ||
tkw | ||
tmo50 | ||
toad | ||
tokyo60 | ||
tokyokeyboard/alix40 | ||
torn | ||
touchpad | ||
tr60w | ||
trashman | ||
treadstone32 | ||
treadstone48 | ||
treasure/type9 | ||
tszaboo/ortho4exent | ||
tunks/ergo33 | ||
tw40 | ||
ua62 | ||
uk78 | ||
underscore33 | ||
ungodly | ||
unikorn | ||
unison | ||
uno | ||
uranuma | ||
ut472 | ||
utd80 | ||
uzu42 | ||
v60_type_r | ||
vagrant_10 | ||
viktus | ||
vinta | ||
vision_division | ||
vitamins_included | ||
vn66 | ||
waldo | ||
wallaby | ||
walletburner | ||
westfoxtrot | ||
whale/sk | ||
wheatfield | ||
whitefox | ||
wilba_tech | ||
wings42 | ||
winkeyless | ||
wolfmarkclub/wm1 | ||
work_louder | ||
wsk | ||
wuque/ikki68 | ||
x16 | ||
xbows | ||
xd60 | ||
xd68 | ||
xd75 | ||
xd84 | ||
xd84pro | ||
xd87 | ||
xd96 | ||
xd002 | ||
xd004 | ||
xelus | ||
xiaomi/mk02 | ||
xmmx | ||
xw60 | ||
yampad | ||
yasui | ||
yatara/drink_me | ||
yd60mq | ||
yd68 | ||
yeehaw | ||
ymd75 | ||
ymd96 | ||
ymdk | ||
ymdk_np21 | ||
yncognito/batpad | ||
yoichiro/lunakey_mini | ||
yosino58 | ||
yugo_m | ||
yurei | ||
yushakobo/quick7 | ||
yynmt/acperience12 | ||
z150_bh | ||
zfrontier/big_switch | ||
zinc | ||
zj68 | ||
zlant | ||
zoo/wampus | ||
ztboards | ||
zvecr | ||
readme.md |
Included Keyboards
QMK runs on a diverse range of keyboards. Some of these keyboards are well maintained and see constant community contributions, while others are part of the repository for historical reasons.
Official QMK Keyboards
Ortholinear Keyboards - Jack Humbert
What makes OLKB keyboards shine is a combo of lean aesthetics, compact size, and killer tactile feel. These are available through olkb.com as well as through Massdrop from time to time, as easy to assemble kits.
- Planck — A 40% DIY powerhouse of customizability and modification capability. It's a lean, mean, typing machine.
- Preonic — Like the Planck, but bigger. 50%.
- Atomic — Imagine the size of the Planck. Now imagine the size of the Preonic. Now imagine bigger. That is the Atomic. A 60% keyboard.
Clueboard - Zach White
Designed and built in Felton, CA, Clueboards keyboard emphasize quality and locally sourced components, available on clueboard.co
- Clueboard — The 66% custom keyboard.
- Cluecard — A small board to help you hack on QMK.
- Cluepad — A mechanical numpad with QMK superpowers.
ErgoDox EZ and Planck EZ - ZSA Technology Labs
ZSA Technology Labs maintains its own fork of QMK which feeds its configurator, for stability and legal purposes. The ZSA boards are:
- ErgoDox EZ — A powerful split mechanical keyboard.
- Planck EZ — A 40% DIY powerhouse of customizability and modification capability. It's a lean, mean, typing machine, which ships fully assembled with a two-year warranty.
Community-supported QMK Keyboards
These keyboards are part of the QMK repository, but their manufacturers are not official maintainers of the repository.
- 9key — A 9-key minipad sold by Bishop Keyboards.
- Alps64 — A 60% keyboard for Alps keyswitches.
- AMJ60 — DIY/Assembled compact 60% keyboard.
- Arrow Pad — A custom creation by IBNobody.
- Atreus — Made by Technomancy.
- Bantam44 — It is a 44-key 40% staggered keyboard.
- DataHand — DataHand keyboard converted to use a Teensy board.
- Ergodox Infinity - Ergonomic Split Keyboard by Input Club.
- GH60 — A 60% Geekhack community-driven project.
- GON NerD — Korean custom 60% PCB
- Happy Hacking Keyboard — The Happy Hacking keyboard can be hacked with a custom controller to run QMK.
- Infinity 60% - — Compact community keyboard by Input Club.
- JD45 — Another Geekhack community project, designed by jdcarpe.
- JJ40 — ps2avrGB based ortholinear sold by KPrepublic
- JJ50 — A compact 50% (5x12) ortholinear keyboard sold by KPrepublic.
- KBD75 — A 75% keyboard made by made by KBDFans.
- KC60 — A programmable Chinese-made keyboard, lost in the mists of time.
- Kinesis Advantage — Contoured ergonomic keyboard by Kinesis Computer Ergonomics.
- KMAC — Korean custom keyboard.
- The Kitten Paw — A replacement controller (2016 revision) for the Filco Majestouch by Bathroom Epiphanies.
- Lets Split - Split ortholinear 40% keyboard.
- Phantom — A tenkeyless kit by Teel, also from Geekhack.
- Retro Refit — Another creation by IBNobody.
- S60-x — DIY compact keyboard designed by VinnyCordeiro for Sentraq.
- Satan — A GH60 variant.
- SixKeyBoard — A 6-key keyboard made by TechKeys.
- TheVan 44 — A 44-key staggered keybard by Evangs.
- WhiteFox — A 65% keyboard designed as a partnership by matt3o, Massdrop and Input Club
- Vision Division — Full Size / Split Linear Keyboard by IBNobody.
- XD004 — 1x4 macro keyboard sold by KPrepublic.
- XD75 — 15x5 ortholinear keyboard by XIUDI.
- YMDK NP21 — ps2avrGB based number pad (numpad) sold by YMDK on Aliexpress.