qmk / keyboard_awesome

A collection of awesome keyboard resources

Keyboard Awesome

A curated collection of awesome keyboard resources.

Contributing

Please see entry_guidelines.md for guidelines on submitting changes to this list.

Community

Forums, realtime chat, social media, and other ways to participate in the keyboard community.

Chat

• #mechboards IRC - #mechboards on Freenode
• Mechkeys Discord
• QMK Discord

Forums

• GeekHack
• KeebTalk

Reddit

• /r/CatsOnKeyboards
• /r/Clueboard
• /r/MechanicalHeadPens
• /r/MechanicalKeyboards
• /r/MechanicalKeyboardsUK
• /r/OLKB - Official QMK Subreddit

Stores

Places to buy keyboards, parts, and other paraphernalia.

Custom Keyboard Stores

To be listed here a store must sell a fully programmable keyboard (kit or assembled) and accept and fulfill orders on an ongoing basis.

• 1Up Keyboards
• Atreus
• Clueboard
• Keebio
• Keyboardio
• MechanicalKeyboards.com
• MechKeyAlpha
• Kono
• LFKeyboards
• Massdrop
• OLKB
• Profet Keyboards
• Zeal PC

Keycaps

To be listed here a store must accept and fulfill orders on an ongoing basis.

• Candy Keys
• Caps Unlocked
• Kono
• Massdrop
• Max Keyboard
• MyKeyboard.eu
• Originative
• Pimp My Keyboard
• Tai-Hao
• UK Keycaps
• WASD Keyboards

Custom Keyboard Parts

To be listed here a store must accept and fulfill orders on an ongoing basis.

• Clueboard
• Doyu Studios
• Keebio
• MechanicalKeyboards.com
• MechKeyAlpha
• NovelKeys
• SpaceCat
• SwitchMOD
• SwitchTop
• Zeal PC

Custom Cables

To be listed here a store must accept and fulfill orders on an ongoing basis.

• Zap Cables

Design Resources

3D Design Tools

• Cherry Keycaps - 3D models for legened and unlegended Cherry profile caps
• KeyV2 - 3D Parametric Mechanical Keycap Library
• MX Switches - 3D models for Cherry MX switches
• XDA Keycaps - 3D models for unlegended XDA caps
• Kailh Sockets - 3D models for Kailh MX and Choc hotswap sockets

Handwiring and Custom Matrix Information

• How To Make a Keyboard - The Matrix
• Keyboard Matrix Help

Keyboard/Keycap Design Tools

• Keyboard Layout Editor - Design keyboard layouts and keycap sets

Keyboard Plate Generators

• ai03's Plate Generator - A keyboard plate generator that values accuracy over path optimization
• pykeeb - Python wrappers for OpenSCAD for parametrically generating 3d-printable MX or ALPS keyboard plates.
• swillkb - The original plate and case builder
• skullY's Plate Builder - CLI version of swill's original plate builder with enhancements

PCB Design Tools

• ai03's PCB Design Guide - Step by step guide for designing a PCB in KiCAD
• Datasheets - Keyboard datasheets maintained by Keyboardio

EAGLE Part Libraries and Tools

• clueboard_eagle - Clueboard's EAGLE part libraries
• EAGLE Proton C - EAGLE footprint for the Proton C
• Kalerator - Turns KLE layouts into EAGLE PCB's

KiCAD Part Libraries and Tools

• Choc and MX Switches
• Cole Markham's Keyboard Parts
• kbpcb - Turns KLE layouts into KiCAD PCB's
• Keebio Keyboard Parts
• MX Alps Hybrid
• Proton C footprint
• USB-C Footprints
• WS2812B Footprints

Open Source Hardware

To be listed here a project must offer files that can be easily edited, EG KiCAD or EAGLE files.

Row Staggered Keyboards

• Fourier - Split 40% (laser cut case and pcb)
• GH60 - Standard 60% PCB
• HacKeyboard - Standard TKL (laser cut case and pcb)
• Plain60 - Standard 60% PCB
• SB-147 - 147 key 3D printed keyboard (case only)
• Tanuki - 40% (laser cut case and pcb)
• TG4X - 40% (laser cut case and pcb)
• Ultimate Hacking Keyboard - Split 60% (pcb only)
• Voyager - PCB's for a variety of keyboard sizes
• XMMX - Standard TKL (pcb only)

Ortholinear Keyboards

• Alpha - 28 key semi-ortholinear
• Contra - 12x4 (fr4 case and pcb)
• Ergo42 - 7x4 split
• Helix - 6x4 kailh choc split with OLED (laser cut case and pcb)
• Let's Split - 6x4 split (pcb only)
• minisplit - 6x4 split
• OLKB Parts - OLKB designs for planck (12x4), preonic (12x5), and other ortholinear boards. (3D printed and laser cut plates/cases only)
• Plaid - 12x4 all-throughhole kit (pcb only)
• PlanckTHK - 12x4 all-throughhole kit (pcb only)
• For Science - 5x4 split with thumb cluster (pcb only)
• For Split - 6x4 split (pcb only)

Columnar Staggered Keyboards

• Atreis - 6x4 + thumb cluster (laser cut case only)
• Atreus - 5x4 + thumb cluster (laser cut case and pcb)
• Atreus64 - 6x4 + thumb cluster (laser cut case and pcb)
• Corne - 6x3 + thumb cluster (laser cut case and pcb)
• Dactyl - 6x5 + thumb cluster and curve (3D printed case)
• Dactyl-ManuForm - 6x5 + thumb cluster and curve (3D printed case)
• [DMOTE] - Dactyl-ManuForm Opposable Thumb Edition - 6x5 + thumb cluster and curve (3D printed case)
• ErgoDash - 7x5 + thumb cluster (laser cut case and pcb)
• ErgoDash Mini - 7x4 + thumb cluster (laser cut case and pcb)
• ErgoDox - The original custom split ergo - 7x4 + thumb cluster (laser cut case and pcb)
• ErgoDox Case - ErgoDox case modified to print on consumer 3D printers (3D printed case)
• ErgoMac - 7x5 + thumb cluster (pcb only)
• ErgoTravel - 6x4 + thumb cluster (multiple cases and pcb)
• ErgoInu - 7x5 + thumb cluster (laser cut case and pcb)
• Iris Ice - 6x4 + thumb cluster (3D printed and laser cut case only)
• MiniDox Case - 5x3 + thumb cluster (laser cut case only)
• MiniDox PCB - 5x3 + thumb cluster (pcb only)
• Orbit - 7x5 + thumb cluster (pcb only)
• Pteron - 6x4 + thumb cluster (laser cut case only)
• SCAD Redox Case - 7x5 + thumb cluster (case only)
• Redox - 7x5 + thumb cluster (3D printed case and pcb)
• Lily58 - 6x4 + thumb cluster

Numpads

• lfk17 - Open source 17-key numpad. (pcb only)

Macropads

• Game cart macropad - 4x4 numpad-style macropad with a retro gaming look (3D printed case only)
• Geekpad - 3x3 macropad (3D printed case and pcb)
• Kboard - 3x5 macropad (laser cut case and pcb)

Firmware

• Bluetosis
• Kaleidoscope
• TMK

QMK

• Main Site: https://qmk.fm/
• Configurator: https://config.qmk.fm/
• Documentation: https://docs.qmk.fm/
• QMK Toolbox: https://github.com/qmk/qmk_toolbox/releases
• Firmware Source: https://github.com/qmk/qmk_firmware