1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
# eiga's zmk-config
### Table of contents
- Branches
- [Corne](#corne)
- [Charybdis](#charybdis)
- [Module documentation](#module-documentation)
- [TOTEM](#totem)
- [Dongle Flashing](#dongle-flashing)
- [ZMK Keymap Editor](#zmk-keymap-editor)
- [Shops and Useful links](#shops-and-other-useful-links)
## Hello
You probably reached this page by watching one of these [Ergo Split Keyb Videos](https://www.youtube.com/playlist?list=PL1E2ddJCbc13DvCGYXX9jVVX1BqNGKE5D).
This repository hosts zmk-configs as seen in the YouTube videos linked above.
Additionally, this repository contains alternative configurations meant to be used with an extra controller acting as a dongle. Pease refer to the [Dongle Flashing](https://github.com/eigatech/zmk-config#dongle-flashing) chapter for instructions.
> [!NOTE]
> These configurations are meant to be used with builds that are identical to the ones featured in the videos, otherwise they should be used as reference only.
## Corne
- [Corne](https://github.com/eigatech/zmk-config/tree/corne)
- [Corne Dongle](https://github.com/eigatech/zmk-config/tree/corne-dongle)
> [!NOTE]
> Shield is configured for an earlier revision of Pete Johanson's [Corne Ultralight PCB](https://github.com/petejohanson/crkbd/tree/board/corne-ultralight), with nice!view support.
## Charybdis
- [Charybdis](https://github.com/eigatech/zmk-config/tree/charybdis-3.5)
- [Charybdis Dongle](https://github.com/eigatech/zmk-config/tree/charybdis-dongle)
### Module documentation
- Charybdis
- [ZMK PMW3610 Driver](https://github.com/inorichi/zmk-pmw3610-driver)
- Charybdis Dongle
- [ZMK Split Peripheral Input Relay](https://github.com/badjeff/zmk-split-peripheral-input-relay)
- [ZMK Input Behavior Listener](https://github.com/badjeff/zmk-input-behavior-listener)
- [ZMK PMW3610 Driver](https://github.com/badjeff/zmk-pmw3610-driver)
> [!NOTE]
> Charybdis uses Inorichi's PMW3610 driver, while Charybdis Dongle leverages multiple modules written by badjeff.
## TOTEM
- [TOTEM](https://github.com/eigatech/zmk-config/tree/totem)
- [TOTEM Dongle](https://github.com/eigatech/zmk-config/tree/totem-dongle)
## Dongle Flashing
Dongle configs use Seeed Xiao Ble microcontrollers housed in a nifty 3D printed [case](https://www.printables.com/model/522586-seeed-xiao-ble-case).
1. Turn all controllers off
2. Flash the dongle controller with the **appropriate** `settings_reset` file.
3. Flash the dongle controller with the `dongle` file.
4. Flash the first half with the the `settings_reset` file.
5. Flash the first half with the `left` or `right` files.
6. Repeat steps 4 and 5 for the other half.
> [!WARNING]
> When using both Nice!Nano and Seeed XIAO microcontrollers, make sure you are flashing them with the correct files!
## ZMK Keymap Editor
Nick Coutsos' [Keymap Editor](https://nickcoutsos.github.io/keymap-editor/) is a user-friendly, browser-based WYSIWYG app designed to make editing your keymap file easier. It supports conditional layers, behaviors, combo and macro editing, rotary encoders, and more.
## Shops and other useful links
Kits, Prebuilts, Parts:
- [kbd.news](https://kbd.news/vendors) - mechanical keyboard vendors list
- [42keebs.eu](http://42keebs.eu/) - diy kits, including Corne, switches and other parts
- [keeb.supply](https://keeb.supply/) - diy kits and prebuilts, including TOTEM, tools and other parts
- [splitkb.com](https://splitkb.com/) - diy kits, including Corne, switches, tools and other parts
- [bastardkb.com](https://bastardkb.com/) - diy kits and prebuilts, including Charybdis (wired only w/ qmk)
- [typeractive.xyz](https://typeractive.xyz/) - diy kits and prebuilts, including Corne w/ nice!views, switches, tools and other parts
Documentation and guides:
- [ZMK Firmware Documentation](https://zmk.dev/docs)
- [Eren's Wireless Charybdis Mini Guide](https://github.com/erenatas/charybdis-wireless-3x6)
|