mechanical-keyboard

DIY mechanical keyboard and where to find them

2,854

175

2,854

View on GitHub View on NPM

Top Related Projects

kmk_firmware

1,376

Clackety Keyboards Powered by Python

Quick Overview

The help-14/mechanical-keyboard repository is a collection of resources and information related to mechanical keyboards. It covers various aspects of mechanical keyboards, including their history, components, and customization options.

Pros

Comprehensive coverage of mechanical keyboard topics
Includes a wide range of resources, from beginner guides to advanced customization tutorials
Active community and regular updates to the repository
Provides a centralized location for mechanical keyboard enthusiasts to access information

Cons

The repository may be overwhelming for newcomers due to the sheer amount of information
Some of the content may be outdated or specific to older mechanical keyboard models
Limited hands-on guidance for actual keyboard building or modification

Code Examples

This repository does not contain a code library. It is primarily a collection of informational resources and guides related to mechanical keyboards.

Getting Started

As this is not a code library, there are no specific "getting started" instructions. However, the repository provides the following resources to help users get started with mechanical keyboards:

Beginner's Guide: This section covers the basics of mechanical keyboards, including an introduction to key switches, keycaps, and other components.
Keyboard Customization: The repository offers tutorials and guides on customizing mechanical keyboards, such as changing keycaps, adding artisan keycaps, and modifying the keyboard case.
Keyboard Building: For users interested in building their own mechanical keyboards, the repository includes step-by-step guides and recommendations for parts and tools.
Community Resources: The repository links to various mechanical keyboard communities, forums, and social media groups where users can engage with other enthusiasts and get support.

To get started, users can browse the repository's table of contents and navigate to the sections that are most relevant to their interests and skill level.

Competitor Comparisons

kmk_firmware

1,376

Clackety Keyboards Powered by Python

Pros of KMKfw/kmk_firmware

Actively maintained and regularly updated, with a strong community of contributors
Supports a wide range of keyboard hardware, including custom and split keyboards
Provides a flexible and extensible framework for building custom keyboard firmware

Cons of KMKfw/kmk_firmware

Steeper learning curve compared to help-14/mechanical-keyboard, especially for beginners
Requires more technical knowledge and setup to get started
May have fewer pre-built configurations and profiles compared to help-14/mechanical-keyboard

Code Comparison

help-14/mechanical-keyboard

from kmk.kmk_keyboard import KMKKeyboard
from kmk.keys import KC

keyboard = KMKKeyboard()

keyboard.keymap = [
    [KC.A, KC.B, KC.C],
    [KC.D, KC.E, KC.F],
    [KC.G, KC.H, KC.I],
]

KMKfw/kmk_firmware

from kmk.boards.splitkb_aurora_sweep import Aurora_Sweep
from kmk.keys import KC

keyboard = Aurora_Sweep()

keyboard.keymap = [
    [KC.A, KC.B, KC.C],
    [KC.D, KC.E, KC.F],
    [KC.G, KC.H, KC.I],
]

The main difference in the code is the use of a specific keyboard model (Aurora_Sweep) in the KMKfw/kmk_firmware example, whereas the help-14/mechanical-keyboard example uses a more generic KMKKeyboard instance. This reflects the broader support for different keyboard hardware in the KMKfw/kmk_firmware project.

zmk

2,615

ZMK Firmware Repository

Pros of zmk

zmk is a firmware for wireless and split keyboards, providing a modern and feature-rich alternative to traditional keyboard firmware.
zmk has a strong focus on power efficiency, making it well-suited for battery-powered keyboards.
zmk provides a flexible and customizable configuration system, allowing users to tailor the firmware to their specific needs.

Cons of zmk

zmk may have a steeper learning curve compared to help-14/mechanical-keyboard, as it requires familiarity with its configuration system.
zmk's support for certain hardware features may be more limited compared to help-14/mechanical-keyboard, depending on the specific requirements of the user.

Code Comparison

help-14/mechanical-keyboard:

void matrix_scan_user(void) {
    uint8_t layer = get_highest_layer(layer_state);

    switch (layer) {
        case _QWERTY:
            set_led_by_layer(_QWERTY);
            break;
        case _LOWER:
            set_led_by_layer(_LOWER);
            break;
        case _RAISE:
            set_led_by_layer(_RAISE);
            break;
        case _ADJUST:
            set_led_by_layer(_ADJUST);
            break;
        default:
            break;
    }
}

zmk:

keymap:
  # ...
  layers:
    qwerty:
      # ...
    lower:
      # ...
    raise:
      # ...
    adjust:
      # ...
  behaviors:
    # ...
  macros:
    # ...

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

Mechanical Keyboard and where to find them

This list will help you quickly find your favorite layout and you can start DIY your own custom keyboard.

Quick links

Keyboard:

Normal Keyboards
Ergonomics Keyboards
Ortholinear Keyboards
Numpad/Macropad
Others Keyboards

Components:

Controller
Case
Plate
Keycaps

Links:

Firmware
Tools
Tutorials

Normal Keyboards

Image	Name	Description
	SB-147	A 147-key 3d printed keyboard, along with custom profile keycaps.
	GH80-3000	GH80-3000 is intended to be a replacement PCB of the Cherry Corp.
	SaikouType	Fullsize Custom PCB Filco Compatible.
	Boston	Compact battleship with a complement of 18 programmable keys, in a footprint 2u narrower than a full-size, and only about 1.5u wider than a 96%.
	Bevi	Inspired by Vortex Vibe and Wyvern, so here is Vibe Southpaw.
	Voyager97	A compact fullsize keyboard.
	Entropy	A 96% Southpaw keyboard, with split space and encoder support.
	HacKeyboard	Using SMK Alps Mount switches and Alps compatible keycaps. Features: internal keylogger, macro recording, internal USB Hub 2.0, internal flash drive, customizable LED colors, customizable LED effects.
	XMMX TKL	Tenkeyless PCB designed to work with MX compatible switches as well as ALPS SKCL/SKCM and their clones. Fit the Cooler Master Quickfire Rapid (not the Rapid-i) and the Filco Majestouch 2 TKL cases and some other commercial TKL cases.
	Mysterium	TKL keyboard that can be entirely assembled using only through hole components, including usb type c.
	Env-KB	A custom mechanical keyboard inspired by the CFTKB Mysterium.
	Yurei	Tenkeyless PCB inspired by Phantom, for customizing Filco Majestouch 2.
	System76 Launch	System76 Launch Configurable Keyboard with open source mechanical and electrical design, open source firmware and associated software, and a large number of user configuration opportunities.
	00Key	Custom 75% Keyboard with through hole components.
	Toad	70% with space between F-row and number row.
	Toad V2	Toad with support for MX and Alps switch.
	WhiteFox
	Flounder	Low-profile Kailh switches keyboard
	68Keys.io
	SiCK-68	3D printed keyboard.
	Lagom	65% keyboard assembled with only through hole components, supports pro micro, rotary encoders and an OLED screen.
	Discipline	65% keyboard assembled with only through hole components, including usb type-c.
	Bakeneko 65	A simple 65% keyboard
	Pheromone	63-key keyboard supports slide potentiometer, rotary encoder and oled screen.
	Voyager60	A simple MX/Alps 60% board that just works.
	Ultimate Hacking Keyboard	Split 60% keyboard with trackball, trackpoint, and touchpad modules.
	GH60	The most popular 60% keyboard pcb.
	Tartan	60% keyboard made by through hole components only.
	Grabert
	Infinity 60%
	Plain60-C	This universal 60% PCB is designed to support as little layouts as possible without limiting usability for most users.
	TMK Alps 64	Poker X compatible 60% size PCB supports various Alps switch keyboard layouts like AEK, Omnikey, Dell, V60MTS and Infinity.
	TCKB	60% keyboard using STM32.
	Lot60-BLE	60% BLE keyboard using nRF51822 as the main controller, CH554 as the USB chip.
	Bakeneko 60	A simple 60% keyboard
	hand-wired python keyboard	An open source hand-wired, USB + BLE keyboard powered by python.
	Makerdiary M60	A hot-swappable, USB + BLE keyboard.
	Regack's 59%	A reduced size keyboard, but not quite 60%.
	QOL56	56-key mechanical keyboard for Oyayubi-shift Japanese input.
	Drunk Planck	The PCB fits in the Planck formed bottom, and in theory it should fit into the Planck milled bottom
	iso50
	Treadstone48
	UT47.2
	CPM43
	Litl	40% keyboard assembled with only through hole components, supports pro micro, rotary encoders and an OLED screen.
	Regack's 40%
	SteamVan	MiniVan-compatible PCB based on an STM32MCU.
	CW40	RGB underglow 40% keyboard.
	Tanuki	40% keyboard that uses a split spacebar design to comfortably switch between layers.
	Tg4x
	_33 Keyboard
	Stonehenge30
	pain27	Completely and utterly unusable qwerty keyboard with all the letters of the english alphabet, a spacebar, and nothing else.
	Alpha	A 28-key semi-ortholinear mechanical keyboard.
	ANHEDRAL	Symmetrical SemiErgo layout keyboard.
	Unix60	A 60% hhkb-layout keyboard designed by mkdl FR4Boards
	Southpaw75	A southpaw-style layout designed by Kelvin Hall of FR4Boards
	Re Keyboard collection	Split keyboards with rotary encoder.
	HelloWord-Smart Keyboard
	onebytwo
	RGB TKL	[THIS HAVE NOT BEEN TESTED YET] TKL keyboard with RGB on each button.
	TS65	[THIS HAVE NOT BEEN TESTED YET] The Split 65% Keyboard.
	BLU60	[THIS HAVE NOT BEEN TESTED YET] Bluetooth 60% keyboard.
	Shoc
	Nyan Keys 60	FPGA based with a per key input core - 60% - USB 2.0 HighSpeed - 8000hz Polling HID - ~260ÂµS latency end to end - NKRO - NyanOS - Board Files - Fimware & Schematics
	Soroka	DIY-Friendly 40% keyboard. Supports all cyrillic symbols in base layer. Compatible with most base-kit keycap sets. No 40s addons needed.

Ergonomics Keyboards

Image	Name	Description
	Arisu	The layout is inspired by Lyn's EM7 and TGR Alice with some modification. Case PCB
	Basketweave	Through-hole Alice-style keyboard with arrow keys and a rotary encoder.
	fAuxLICE	An 3D printable Alice-like mechanical keyboard.
	ð¬ððððððð	75% Alice-like keyboard based on the Arisu
	Adelheid Plus	A fork of Adelheid with USB-C, rotary encoder,...
	Kusuguru	An 3D printable Alice-like JIS-layout TKL mechanical keyboard.
	BMEK	Ergonomic keyboard in the spirit of Lyn's EM7 and TGR Alice. Notable differences are the more HHKB-like layout and the and the more symmetric looks due to the space bars and left key cluster arrangement.
	Sesame	Alice like ergo keyboard using only THT parts
	Cozykeys Bloomer	An 87-key ergonomic mechanical keyboard.
	Atreus	Designed primarily to match the shape of human hands and to be as portable as possible. The case measures 26x12cm and lacks even a number row, relying heavily upon the `fn` key.
	Atreus62	This version utilizes a Pro Micro for its controller and has a 62 key layout.
	Atreis	Unsplitting the Iris keyboard.
	Fortitude 60	A 60% (12x5) split keyboard with staggerd column layout.
	Darknight	DIY 60% Split Keyboard.
	Manta 60	60% split keyboard.
	ErgoDox	Ergodox is a keyboard project designed with ergonomics in mind, it uses 76-80 Cherry MX style mechanical switches laid out in a columnar stagger (rather than the more conventional row stagger) layout with components that can easily be sourced. The keyboard is completely programmable and can be flashed with several different firmware options.
	Lily58	Lily58 is 6Ã4+4keys column-staggered split keyboard.
	Infinity ErgoDox	Left handed Right handed
	ErgoDash
	Torn	The split keyboard kit made by through hole components only.
	ErgoDash Mini
	Sofle Keyboard	Sofle is 6Ã4+5 keys column-staggered split keyboard with encoder support.
	ErgoTravel	A split ergo 4x6 keyboard with 2 or 3 thumb keys and extra inner macro keys.
	Redox	Open-source, ergonomic split mechanical keyboard.
	Oddball	Split mechanical keyboard with an integrated trackball.
	Unsplitted ergo Keyberon
	REVIUNG	The REVIUNG41 is 41-key column staggered keyboard.
	CHOCTOPUS44	44-key column staggered keyboard with a rotary encoder.
	Le-Chiffre	44-key column staggered keyboard with a rotary encoder.
	Dactyl Keyboard	Parameterized, split-hand, concave, columnar, ergonomic keyboard.
	Dactyl-ManuForm	The main change is that the thumb cluster was adapted from the ManuForm keyboard (geekhack).
	Dactyl ManuForm Tight
	DMOTE
	Mitosis	Wireless Split Ergonomic Keyboard.
	Apoptosis
	Interphase	A mitosis clone with more keys!!
	5plit
	Chimera	Split wireless QMK powered keyboards
	Chew	A crunched 34 key choc-spaced keyboard with a RP2040 zero controller and a lot of splay. Available on split and mono flavors.
	Comet46	A split wireless 40% column-staggered keyboard.
	Djinn	64-key split keyboard -- dual 4x7 with a 4-key thumb cluster. It also has a 5-way tactile switch under the thumb.
	Ergoinu	64-key split keyboard -- dual 4x7 with a 4-key thumb cluster. It also has a 5-way tactile switch under the thumb.
	Corne	Corne keyboard, a split keyboard with 3x6 column staggered keys and 3 thumb keys, rgb, based on Helix.
	MiniDox	Pcb Case
	Kyria
	Orbit	A split ergonomic keyboard pcb with usb type c.
	Lil Chonky Bois	MX hotswap, wireless version.
	elephant42
	pteron	An ergonomic keyboard heavily inspired by the Atreus, Iris and Atreis keyboards.
	Charybdis	An ergonomic keyboard with integrated trackball.
	KLOR	36-42 keys column-staggered split keyboard
	Taira	A wireless low-profile split mechanical keyboard with 66 keys inspired by the ErgoDash and Corne Chocolate
	Miryoku ZMK	ergonomic, minimal, orthogonal, and universal keyboard layout
	Fercus	Wireless split keyboard with 6x7 low profile optical switches
	Cantor	42 key diodeless split keyboard
	Piantor	42-key or 36-key wired, diodeless, non-flippable, low profile choc v1, aggressive column staggered, programmable ergonomic mechnical split keyboard powered by Rasyberry Pi Pico or other compatible RP2040 boards
	Sweep	Sweep is a version of the more fabulous Ferris by Pierre Chevalier that uses a daughter board like a promicro, elite-c, bit-c, nice!nano etc. instead of using onboard components.
	Ferris	34-key split keyboard that tries to be about as cute as its namesake.
	Microdox
	cos(y) Kong	30 or 36 key 3row keyboards with col stagger
	Grumpy	28 key (3-row) angled unibody keyboard with col stagger
	Tipper-TF	34 keys Unibody BLE keyboard w/ splay and raised outer columns
	Dilemma	The Dilemma is a vertical stagger low-profile keyboard with mods
	KLOR	36-42 keys column-staggered split keyboard
	KLOTZ	34 keys column-staggered split keyboard
	TOTEM	38 keys column-staggered split keyboard
	COCKPIT KEYBOARD	A hot swap system column staggered mechanical keyboard, running QMK Firmware on Pro Micro controllers.
	SKYWATCH	35% ergonomic ortholinear keyboard, powered by RP2040, along with OLED and hotswap sockets support

Ortholinear Keyboards

Image	Name	Description
	Punk75	Ortholinear keyboard with 75 keys and all components through hole.
	Planck	A thumb-chorded 47-key keyboard
	Planck Through Hole Kit
	Plaid	The 4x12 ortholinear keyboard kit made by through hole components only.
	Alpsie	An alps-only blocked 4x12 (44 key) ortho with piezo support.
	Contra	Extremely low cost ortholinear keyboard.
	Cheap_Boi
	Low Profile Ortho	DIY low-profile ortholinear, with custom PCB, Kailh Choc Browns, and vintage Plum keycaps.
	Gherkin	3x10 keyboard.
	Koda	4x12 keyboard using pro micro and kailh choc.
	Keebee
	Ergo42	7x4 ortho linear split keyboard.
	Helix	A compact split ortholinear keyboard with screen.
	Let's Split	Split ortholinear keyboard with rgb underglow. PCB Case
	Rhymestone
	SharkPCB
	keyberon-grid
	Split Infinitive	The goal of this project is to build a Let's Split keyboard clone with a number of alternative features.
	Minisplit	6Ã4 +1keys Split Keyboard.
	For Science	For Science is a 46 key ortholinear split keyboard PCB with a 3 key thumb cluster.
	Zen Keyboard	PCB Build Guide
	Nack	The nack has 52-keys for ISO friendliness plus all the bells & whistles QMK has to offer.
	PouetPouet	60 keys with visible SMD components and a Rust firmware.
	mlego/m65 v1	65 keys nothing fancy qmk firmware stmf103
	Lumberjack	Split 5x12 ortholinear keyboard PCB using through-hole components only.
	Ukiha	Small key pitch 5x12 ortholinear keyboard.
	QOL56
	7c8 framework	5x12 ortholinear keyboard.
	Dorsch 48k	A low-profile 40% mechanical keyboard with a Planck layout, programmed with CircuitPython.
	Dorsch 40k
	prkl30
	mlego/m48	48 keys 4x12, encoder and led strip (optionally) qmk firmware stm32f401
	mlego/m60	60 keys 5x12, encoder and led strip (optionally) qmk firmware stm32f401
	mlego/m60_split	60 keys 5x12, split, encoders and led strips (optionally) qmk firmware stm32f401
	mlego/m65 v4	65 keys 5x13, encoder and led strip (optionally) qmk firmware stm32f401
	mlego/m65 rev 5	65 keys 5x13, oled, encoder and led strip (optionally) qmk firmware rp2040
	scottokeebs	All keyboards made by joe-scotto
	mlego/m65 rev 7/8	65 keys 5x13, encoder and led strip (optionally) qmk/zmk firmware xiao rp2040/xiao ble (2x74HC595)
	mlego/m65 rev 9	65 keys 5x13-14, oled, encoder clickable and led strip (optionally) qmk firmware xiao rp2040 (2x74HC595 1X74HC165)
	tipro 8x16	128 keys 8x16, tipro cash register converted qmk firmware stm32f401 blackpill
	tipro 8x12	96 keys 8x12, tipro cash register converted qmk firmware stm32f401 blackpill
	tipro ansi ortho combo	ansi ortho combo, tipro cash register converted qmk firmware stm32f401 blackpill
	ortho ansi combo	ortho-ansi combo, tipro cash register converted qmk firmware stm32f401 blackpill
	ChonkyKong	48 key orthogonal keyboard with offset bottom row
	Kong	48 key orthogonal keyboard with offset bottom row
	SPC_EVDR	38 key otholinear keyboard with offset spacebar(s)
	LÃ¼tt un LÃ¼tt	3x5+2 key split orthogonal BLE keyboard
	BrkOut	38 key orthogonal keyboard with split alphas and offset space
	DigDug	45 keys orthogonal keyboard with 'exploded' key groups
	Froggr	48 key orthogonal keyboard with offset bottom row
	Klacker_BS	a 3x5+2 split keyboard hidden in a row staggered unibody design w/ numpad
	3W6	a small compact 3x5+3 split ortho keyboard
	YAKAMOZ	Yakamoz is a 50-key ortholinear keyboard, powered by a Raspberry Pi Pico. It consists of 1U keys with an OLED display, buzzer, trackball (optional) and RGB leds. It also supports hotswap, which means you can easily change Change with Cherry MX compatible switches

Numpad/Macropad

Image	Name	Description
	F12b	12key, 1 encoder, usb type b connector and using atmega32a that can be entirely assembled using only through hole components. support Cherry solder and Hotswappable and also support kailh choc v2 for low profile style.
	SAMPad	This is a custom numeric pad that is designed to be usable on the right side of the keyboard or on the left (With a mirrored layout if required). There is a gap in the top row and the second row of 1.25U. The top row can be broken off by simply scoring the two brifges and snapping. The bottom 5 rows can then be used in conjunction with a 60%/65% keyboard.
	yampad	Hot-swappable, RGB-backlighted, OLED featured, mechanical numpad.
	Discipad	17-key numpad assembled with only through hole components, including usb type-c.
	Soyuz	A single-PCB numpad kit.
	QazPad	It's a separate 10 key with some extra keys to allow it to stand alone for number crunching or gaming.
	Dumbpad	Simple 4x4 numpad with a rotary encoder.
	Kbord	kbord is a programmable keypad with 15 mechanical keys, each of which can be set to execute a script when pressed.
	Lysergic25
	Logomorph Macro Keyboard
	Zesty25
	Medusa
	LFK17	5x4 numpad.
	Hub16
	Staryu	An Open-source 5-key Keypad.
	Croaky4
	Env-MCRO	Pi Pico powered Macro board.
	Voyager4	A tiny, fully featured 4-key macropad PCB.
	Cookpad	A six keys macro pad made by Cookpad.
	I-S-hOle	A small board with space for 4 ISO enter keys with PCB mount Cherry stabilizers. Powered by a Pro Micro.
	Cherry MX Keypad	1x4 keypad with led.
	2% Milk keyboard
	mlego/m20	20 keys 5x4, oled, encoder and led strip (optionally) qmk firmware rp2040

Others Keyboards

Image	Name	Description
	Penkesu Computer	A Homebrew Retro-style Handheld PC
	SIK Keyboard	An ergonomic, compact, mechanical keyboard
	Some other collection of mechkey kicad pcb
	SU120
	Amoeba Single-Switch PCB	Make handwiring keyboard easier.
	Cherry-Mx-LED-Bitboard
	Usb Adapter	For customize keyboard connector and pcb.
	Unified Daughterboard Project
	mlego/m8	8 keys 4x2, eink, encoder clickable(optional) and led strip (optionally), qmk firmware xiao rp2040 (2x74HC595 1X74HC589) test board
	mlego/m4	4 keys 2x2, encoder clickable(optional) and led strip (optionally), qmk firmware xiao rp2040 test board, matrix, shift registers
	5x5 ortho grid	5x5 ortho grid to make hand wire easy multi footprint(MX, alps, choco v1/v2)

Controller

Image	Name	Description
	KeyPlus	ATXmega controller that have awesome support for wireless, can use with Logitech receiver, with usb type c. Support keyplus firmware.
	Goldfish	Arduino pro micro clone with usb type c. Support TMK, QMK.
	BLE Micro Pro	It is a breakout board of BL654 (nrf 52840 module) which is conscious of compatibility with Pro Micro, and it can correspond to both USB / Bluetooth Low Energy. Support BlueMicro, QMK firmware.
	nrfmicro	Arduino Pro Micro-sized breakout board for E73-2G4M08S1C (nRF52840) modules.
	Adafruit Feather 32u4 Bluefruit LE	Support QMK with bluetooth out of the box.
	Adafruit Feather Bluefruit nRF52	Support BlueMicro firmware.
	USB to USB keyboard converter	With this you can change keymap and use functions TMK firmware offers on your USB keyboard.
	Teensy Soarer	Convert old keyboard socket to usb.
	Beamspring USB controller

Case

Image	Name	Description
	TEK-80 TKL	Compatibility: Phantom, Universal TKL Plate, Filco TKL, Winkeyless, Gon
	TKL acrylic case	Compatibility: Phantom, Universal TKL Plate, QFR, Filco TKL
	Classic 87	Compatibility: Unknown
	XD87 mica case	Compatibility: XD87 PCB
	60% acrylic case by MOZ	Compatibility: GH60, Poker, Poker 2, Pure, Pure Pro
	Infinity 60% case	Compatibility: Standard 60% case, hhkb
	Whitefox case	Compatibility: Whitefox
	Lubrigante	Compatibility: TGR Alice and compatible pcb
	Yutsky's TGR Alice	Compatibility: TGR Alice and compatible pcb
	Arisu custom case	Compatibility: Arisu
	Infinity ergodox case	Compatibility: Infinity ergodo
	Redox case	3d printed case for Redox keyboard.
	Travel Numpad	A 4x4 custom numpad.
	RNG3nius's Krotepad

Plate

Image	Name	Description
	60% Alps Plates	Compatibility: Infinity, HHKB, Tai-Hao, ...
	Plates Collection	Collection of various plates ...

Keycaps

Image	Name	Description
	Keeb Finder	Find the keycap color combination you were always looking for!
	SA profile 1	3D model of SA profile keycaps
	SA profile 2	Another 3D model of SA profile keycaps
	Cherry profile 1	3D model of Cherry profile keycaps
	Cherry profile 2	Another 3D model of Cherry profile keycaps
	DSA profile	3D model of DSA keycaps
	XDA profile	3D model of XDA keycaps
	Kailh low profile	3D model of kailh low profile keycaps
	Pseudo Make Me Key Cap Profile	Parametric Key Caps

Firmware

Atmega family:

EasyAVR - EasyAVR is a keyboard firmware and keymapper GUI for custom keyboards based on USB AVRs. It is powerful but also really easy to use.
TMK - A very popular firmware that support Atmega32u4 powered keyboard.
QMK - Base on TMK but support a lot of controller, support RGB, easy to use.
The VIA - QMK based firmware for the view app.
Keyplus - An easy to use, wired and wireless modular keyboard firmware, for both ATXmega family and atmega32u4.
Kaleidoscope - Flexible firmware for Arduino-powered keyboards.
Pipit keyboard - Firmware and config tools for chording keyboards.
rusty-c - QMK in Rust.
QMK-VIA-Hex - Precompile via firmware for qmk supported keyboard.

Raspberry Pi Pico:

KMK - Clackety Keyboards Powered by Python.
PicoMK - Configurable firmware for RP2040 powered mechanical keyboard.
Prk firmware - A keyboard firmware platform in PicoRuby.
PYKB - A highly extensible firmware written in Python, based on CircuitPython, with RGB, USB and Bluetooth. similar to TMK/QMK.

STM32 family:

ZMK - Modern, open source keyboard firmware.
Keyberon - Keyboard firmware written in Rust.

Nordic family:

BlueMicro - A Keyboard Firmware for nRF52832 Boards with a pinout compatible with the Arduino Pro Micro.
Bluetosis - Bluetooth firmware for the Mitosis keyboard.
Lotlab/nrf52-keyboard - TMK based keyboard firmware for nRF52 series, now support both nRF52810 and nRF52832.
Lotlab/nrf51822-keyboard - This is a firmware based on nrf51822 Bluetooth keyboard, which uses nRF SDK 10.0 as the underlying hardware driver, and uses TMK keyboard library as the upper part of the keyboard function.

Esp32 family:

T-vK/ESP32-BLE-Keyboard - This library allows you to make the ESP32 act as a Bluetooth Keyboard and control what it does.
MK32 - BLE keyboard firmware for ESP32 microcontrollers,designed to be relativley easily customizable.
Key To Key - Rust libary for building keyboard firmwares.

Others:

Anne Key - Firmware for Anne Pro Keyboard written in Rust.
Polymer firmware - Polymer keyboard firmware.

Tools

Keyboard Layout Editor - This is a web application that enables the editing of keyboard-layouts, i.e., the position and appearance of each physical key.
Keyboard Layout 3D Viewer - Render 3D keyboard from KLE json.
Keycap Renders - Render 3D keycap set.
Plate & Case Builder - Keyboard top plate CAD files generator, for keyboard-layout-editor generated layouts.
ai03 Plate Generator - An advanced plate generator which doesn't result in 13.99999mm cutouts. Also fillets the cutouts so you don't have to waste hours later.
Keyboard Layouter Plugin - Keyboard Layouter is a plugin for KiCad(pcbnew). This plugin places switch footprints in the location specified by JSON of Keyboard Layout Editor.
mrkeebs Pcb Generator - Quickly create PCB from KLE json.
Kalerator - PCB generator for keyboard-layout-editor generated layouts.
Keyboard Firmware Builder - Online QMK Firmware Builder. (2+ years behind QMK firmware master).
QMK Configurator - An open source configurator for QMK Firmware.
TMK Firmware Builder - Online TMK Firmware Builder.
Parametric Mechanical Keycap Library - Keycap and keyset construction library for mechanical keyboards, written in openSCAD.
KiCad Parts by Ai03 - KiCad Library of custom MX-Alps footprints.
KiCad Parts by Daprice - KiCad footprint library for kailh choc and MX-style mechanical switches.
KiCad Parts by Keebio - Various KiCad footprints for mechanical keyboard parts.
KiCad Parts by TMK - KiCad modules for keyboard design.
KiCad Parts marbastlib - KiCad symbols and footprints for mechanical keyboard design, can be added as a plugin.
KiCad Parts by Acheron - KiCad symbols and footprints for mechanical keyboard design.
Keyswitch Datasheets
QMK Proton C symbol/footprint for KiCad, Eagle
ESP32 KiCad Footprints
Kicad kbplacer - KiCad plugin for automatic keyboard's key placement and routing

Tutorials

PCB Designer Guide by ai03
Keyboard PCB Guide by ruiqimao
A modern handwiring guide
Hand wiring a let's split (pro micro)
How to integrate a trackpoint in a mechanical keyboard (TMK, Teensy)
lets-split-guide - This guide covers building a Let's Split v2.
the 1-Key-Keyboard project - One key keyboard using Attiny85.
4-key-keyboard - Four key keyboard using Attiny85.
zmk design guide by eblaster - While it targets zmk keyboards the lessons apply wider than zmk

Contributing

Contributions welcome!

Top Related Projects

kmk_firmware

1,376

Clackety Keyboards Powered by Python

zmk

2,615

ZMK Firmware Repository

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot