fdeec29636
* Standardize the Unicode EEPROM code * Remove unicode init from process_record_* functions * Add unicode init to where it belongs: matrix_init_quantum * Move Unicode proccessing to unicode common * Add audio feedback to input mode keys to drive konstantin up a wall * Tap_code cleanup * Update keycodes * Update unicode documentation * Update unicode keycodes for consistency/easier merge * Add Audio Feedback section * Remove Functions from feature page And link to the file instead. Link to specific lines later on. * Fix spacing Co-Authored-By: drashna <drashna@live.com> * Because I missed it! Co-Authored-By: drashna <drashna@live.com> * Fix spacing Co-Authored-By: drashna <drashna@live.com> * SPAAAAAAAAAACing Co-Authored-By: drashna <drashna@live.com> * Add BSD for future compatibility * Thought I fixed that! Co-Authored-By: drashna <drashna@live.com> * non-breaking Co-Authored-By: drashna <drashna@live.com> * Considered that Co-Authored-By: drashna <drashna@live.com> * Yuuup Co-Authored-By: drashna <drashna@live.com> * consistency Co-Authored-By: drashna <drashna@live.com> * white spaces .... copied from elsewhere Co-Authored-By: drashna <drashna@live.com> * white spaces Co-Authored-By: drashna <drashna@live.com> * white spaces Co-Authored-By: drashna <drashna@live.com> * Update keycode defines * Fix Linux Song * Update all of the songs * Cleanup * Move and update check to ensure only one unicode method is enabled * Update quantum/quantum_keycodes.h * Update documentation * Wordsmithing and cleanup * Format unicode_common (#13) * case alignment * process_record_unicode_common → process_unicode_common * Move song arrays into function where they're used, align preprocessor directives * Swap the order of UC_WIN and UC_BSD * Update Unicode docs * Reorder Unicode mode stuff to match the order of input mode constants * Fix capitalization in doc subtitle * Readd BSD and OSX_RALT songs * Reword BSD note in docs * Readd BSD keycode description * Reword explanation of input on different platforms * Steal vomindoraan's input mode documentation Co-Authored-By: vomindoraan (vomindoraan@gmail.com) * Willingly give Drashna the rest of my Unicode doc improvements * Wordsmithing Co-Authored-By: drashna <drashna@live.com> * remove merge artifacts * Unicode common cleanup (#17) * Standardize the Unicode EEPROM code * Remove unicode init from process_record_* functions * Add unicode init to where it belongs: matrix_init_quantum * Move Unicode proccessing to unicode common * Add audio feedback to input mode keys to drive konstantin up a wall * Tap_code cleanup * Update keycodes * Update unicode documentation * Update unicode keycodes for consistency/easier merge * Add Audio Feedback section * Remove Functions from feature page And link to the file instead. Link to specific lines later on. * Fix white spaces Co-Authored-By: drashna <drashna@live.com> * Fix spacing Co-Authored-By: drashna <drashna@live.com> * Because I missed it! Co-Authored-By: drashna <drashna@live.com> * Fix spacing Co-Authored-By: drashna <drashna@live.com> * SPAAAAAAAAAACing Co-Authored-By: drashna <drashna@live.com> * white spaces Co-Authored-By: drashna <drashna@live.com> * Add BSD for future compatibility * Thought I fixed that! Co-Authored-By: drashna <drashna@live.com> * non-breaking Co-Authored-By: drashna <drashna@live.com> * Considered that Co-Authored-By: drashna <drashna@live.com> * Yuuup Co-Authored-By: drashna <drashna@live.com> * consistency Co-Authored-By: drashna <drashna@live.com> * white spaces .... copied from elsewhere Co-Authored-By: drashna <drashna@live.com> * white spaces Co-Authored-By: drashna <drashna@live.com> * white spaces Co-Authored-By: drashna <drashna@live.com> * Update keycode defines * Fix Linux Song * Update all of the songs * Cleanup * Move and update check to ensure only one unicode method is enabled * Update quantum/quantum_keycodes.h * Update documentation * Wordsmithing and cleanup * Format unicode_common (#13) * case alignment * process_record_unicode_common → process_unicode_common * Move song arrays into function where they're used, align preprocessor directives * Swap the order of UC_WIN and UC_BSD * Update Unicode docs * Reorder Unicode mode stuff to match the order of input mode constants * Fix capitalization in doc subtitle * Readd BSD and OSX_RALT songs * Reword BSD note in docs * Readd BSD keycode description * Reword explanation of input on different platforms * Steal vomindoraan's input mode documentation Co-Authored-By: vomindoraan (vomindoraan@gmail.com) * Willingly give Drashna the rest of my Unicode doc improvements * Wordsmithing Co-Authored-By: drashna <drashna@live.com> * Rearrange process_unicode_common functions * Make Unicode input mode constants (UC_*) an enum * Simplify unicode_input_start/finish code * Make the key used for WinCompose configurable * Remove UC_OSX_RALT in favor of setting the key with UNICODE_OSX_KEY * Update Unicode input mode doc * Add descriptions and rearrange definitions in process_unicode_common.h * Add registry command to Unicode docs + misc updates * Reword an explanation in Unicode docs * Add TODO comment * Remove trailing whitespace * Improve Cycling documentation * Add Unicode Input method Cycling support (#19) * Standardize the Unicode EEPROM code * Remove unicode init from process_record_* functions * Add unicode init to where it belongs: matrix_init_quantum * Move Unicode proccessing to unicode common * Add audio feedback to input mode keys to drive konstantin up a wall * Tap_code cleanup * Update keycodes * Update unicode documentation * Update unicode keycodes for consistency/easier merge * Add Audio Feedback section * Remove Functions from feature page And link to the file instead. Link to specific lines later on. * Fix white spaces Co-Authored-By: drashna <drashna@live.com> * Fix spacing Co-Authored-By: drashna <drashna@live.com> * Because I missed it! Co-Authored-By: drashna <drashna@live.com> * Fix spacing Co-Authored-By: drashna <drashna@live.com> * SPAAAAAAAAAACing Co-Authored-By: drashna <drashna@live.com> * white spaces Co-Authored-By: drashna <drashna@live.com> * Add BSD for future compatibility * Thought I fixed that! Co-Authored-By: drashna <drashna@live.com> * non-breaking Co-Authored-By: drashna <drashna@live.com> * Considered that Co-Authored-By: drashna <drashna@live.com> * Yuuup Co-Authored-By: drashna <drashna@live.com> * consistency Co-Authored-By: drashna <drashna@live.com> * white spaces .... copied from elsewhere Co-Authored-By: drashna <drashna@live.com> * white spaces Co-Authored-By: drashna <drashna@live.com> * white spaces Co-Authored-By: drashna <drashna@live.com> * Update keycode defines * Fix Linux Song * Update all of the songs * Cleanup * Move and update check to ensure only one unicode method is enabled * Update quantum/quantum_keycodes.h * Update documentation * Wordsmithing and cleanup * Format unicode_common (#13) * case alignment * process_record_unicode_common → process_unicode_common * Move song arrays into function where they're used, align preprocessor directives * Swap the order of UC_WIN and UC_BSD * Update Unicode docs * Reorder Unicode mode stuff to match the order of input mode constants * Fix capitalization in doc subtitle * Readd BSD and OSX_RALT songs * Reword BSD note in docs * Readd BSD keycode description * Reword explanation of input on different platforms * Steal vomindoraan's input mode documentation Co-Authored-By: vomindoraan (vomindoraan@gmail.com) * Willingly give Drashna the rest of my Unicode doc improvements * Wordsmithing Co-Authored-By: drashna <drashna@live.com> * Rearrange process_unicode_common functions * Make Unicode input mode constants (UC_*) an enum * Simplify unicode_input_start/finish code * Make the key used for WinCompose configurable * Remove UC_OSX_RALT in favor of setting the key with UNICODE_OSX_KEY * Update Unicode input mode doc * Add descriptions and rearrange definitions in process_unicode_common.h * Add registry command to Unicode docs + misc updates * Reword an explanation in Unicode docs * Add TODO comment * Add cycle_unicode_input_mode and UNICODE_SELECTED_MODES macro * Add an option for making cycle changes persistent * Add debug prints to functions that change input_mode * Use cycle_unicode_input_mode in whitefox/konstantin * Add persist_unicode_input_mode function * Add offset to cycle to allow stepping in reverse * Add keycodes: UNICODE_MODE_FORWARD, UNICODE_MODE_REVERSE Aliases: UC_MOD, UC_RMOD (respectively) * REVERT ME: Undo changes to whitefox/konstantin to avoid conflicts * Fix wrong constant name * Revert "REVERT ME: Undo changes to whitefox/konstantin to avoid conflicts" This reverts commit 42676bf251fc8e3823f5e614dad6e510ba47a2f3. * Change dprintf text * Give selected modes priority over EEPROM when !UNICODE_CYCLE_PERSIST * Remove trailing whitespace * Cleanup of RALT code and unicode compilation stuff * Remove else for unicode handling |
||
---|---|---|
.. | ||
1upkeyboards | ||
6ball | ||
9key | ||
30wer | ||
40percentclub | ||
412_64 | ||
acr60 | ||
al1 | ||
alf | ||
alpha | ||
alps64 | ||
alu84 | ||
amj40 | ||
amj60 | ||
amj96 | ||
amjpad | ||
at101_blackheart | ||
atom47 | ||
atomic | ||
atreus | ||
atreus62 | ||
baguette | ||
bantam44 | ||
bface | ||
bfake | ||
bfo9000 | ||
bigseries | ||
bigswitch | ||
blockey | ||
bmini | ||
bminiex | ||
bpiphany | ||
canoe | ||
catch22 | ||
chibios_test | ||
chimera_ergo | ||
chimera_ls | ||
chimera_ortho | ||
chocopad | ||
christmas_tree | ||
ckeys | ||
clueboard | ||
cod67 | ||
comet46 | ||
contra | ||
converter | ||
cospad | ||
crawlpad | ||
crkbd | ||
cu24 | ||
cu75 | ||
cyclops | ||
daisy | ||
dc01 | ||
deltasplit75 | ||
dichotomy | ||
dilly | ||
diverge3 | ||
divergetm2 | ||
dk60 | ||
do60 | ||
duck | ||
dz60 | ||
e6v2 | ||
eco | ||
ep | ||
ergo42 | ||
ergodash | ||
ergodone | ||
ergodox_ez | ||
ergodox_infinity | ||
ergoinu | ||
ergotravel | ||
espectro | ||
evil80 | ||
facew | ||
fc660c | ||
fc980c | ||
felix | ||
fleuron | ||
fortitude60 | ||
four_banger | ||
fourier | ||
fractal | ||
gh60 | ||
gh80_3000 | ||
gonnerd | ||
gskt00 | ||
h87a | ||
hadron | ||
handwired | ||
helix | ||
hhkb | ||
hid_liber | ||
hs60 | ||
idobo | ||
infinity60 | ||
iris | ||
jc65 | ||
jd40 | ||
jd45 | ||
jj40 | ||
jj50 | ||
jm60 | ||
k_type | ||
katana60 | ||
kbd4x | ||
kbd6x | ||
kbd8x | ||
kbd19x | ||
kbd66 | ||
kbd67 | ||
kbd75 | ||
kc60 | ||
kc60se | ||
kinesis | ||
kira75 | ||
kmac | ||
kmini | ||
knops | ||
kona_classic | ||
laplace | ||
launchpad | ||
lets_split | ||
lets_split_eh | ||
levinson | ||
lfkeyboards | ||
lily58 | ||
m10a | ||
massdrop | ||
maxipad | ||
mechmini | ||
mehkee96 | ||
meira | ||
melody96 | ||
meme | ||
miniaxe | ||
minidox | ||
mint60 | ||
mitosis | ||
miuni32 | ||
model01 | ||
mt40 | ||
mxss | ||
namecard2x4 | ||
newgame40 | ||
niu_mini | ||
novelpad | ||
noxary | ||
nyquist | ||
ok60 | ||
omnikey_blackheart | ||
orange75 | ||
org60 | ||
orthodox | ||
paladin64 | ||
panc60 | ||
pearl | ||
phantom | ||
planck | ||
playkbtw | ||
preonic | ||
primekb | ||
proton_c | ||
ps2avrGB | ||
puck | ||
quefrency | ||
qwertyydox | ||
rama | ||
redox | ||
redox_w | ||
rorschach | ||
s7_elephant | ||
s60_x | ||
s65_plus | ||
s65_x | ||
satan | ||
scrabblepad | ||
singa | ||
sixkeyboard | ||
sixshooter | ||
sol | ||
speedo | ||
staryu | ||
subatomic | ||
sx60 | ||
tada68 | ||
tanuki | ||
telophase | ||
tetris | ||
the_ruler | ||
thevankeyboards | ||
tkc1800 | ||
toad | ||
tokyo60 | ||
tragicforce68 | ||
treasure/type9 | ||
uk78 | ||
v60_type_r | ||
vinta | ||
vision_division | ||
vitamins_included | ||
viterbi | ||
wavelet | ||
whitefox | ||
wilba_tech | ||
xd60 | ||
xd75 | ||
xd87 | ||
xmmx | ||
yd68 | ||
ymd75 | ||
ymd96 | ||
ymdk_np21 | ||
z150_blackheart | ||
zeal60 | ||
zeal65 | ||
zen | ||
zinc | ||
zlant | ||
readme.md |
readme.md
Included Keyboards
QMK runs on a diverse range of keyboards. Some of these keyboards are officially supported and see constant community contributions, while others are part of the repository for historical reasons.
Official QMK Keyboards
These keyboards are manufactured by the maintainers of QMK.
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.
ErgoDox EZ - Erez Zukerman
Made in Taiwan using advanced robotic manufacturing, the ErgoDox EZ is a fully-assembled, premium ergonomic keyboard. Its split design allows you to place both halves shoulder width, and its custom-made wrist rests and tilt/tent kit make for incredibly comfortable typing. Available on ergodox-ez.com.
- ErgoDox EZ — Our one and only product. Yes, it's that awesome. Comes with either printed or blank keycaps, and 7 different keyswitch types.
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.
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.
- 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
- 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.
- XD75 — 15x5 ortholinear keyboard by XIUDI.
- YMDK NP21 — ps2avrGB based number pad (numpad) sold by YMDK on Aliexpress.