1# eiga's zmk-config
 2
 3### Table of contents
 4- Branches
 5    - [Corne](#corne)
 6    - [Charybdis](#charybdis)
 7        - [Module documentation](#module-documentation)
 8    - [TOTEM](#totem)
 9- [Dongle Flashing](#dongle-flashing)
10- [ZMK Keymap Editor](#zmk-keymap-editor)
11- [Shops and Useful links](#shops-and-other-useful-links)
12
13## Hello
14
15You probably reached this page by watching one of these [Ergo Split Keyb Videos](https://www.youtube.com/playlist?list=PL1E2ddJCbc13DvCGYXX9jVVX1BqNGKE5D).
16
17This repository hosts zmk-configs as seen in the YouTube videos linked above.
18
19Additionally, 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.
20
21> [!NOTE]  
22> 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.
23
24## Corne
25
26- [Corne](https://github.com/eigatech/zmk-config/tree/corne)
27- [Corne Dongle](https://github.com/eigatech/zmk-config/tree/corne-dongle)
28
29> [!NOTE]  
30> 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.
31
32## Charybdis
33
34- [Charybdis](https://github.com/eigatech/zmk-config/tree/charybdis-3.5)
35- [Charybdis Dongle](https://github.com/eigatech/zmk-config/tree/charybdis-dongle)
36
37### Module documentation
38
39- Charybdis
40    - [ZMK PMW3610 Driver](https://github.com/inorichi/zmk-pmw3610-driver)
41- Charybdis Dongle
42    - [ZMK Split Peripheral Input Relay](https://github.com/badjeff/zmk-split-peripheral-input-relay)
43    - [ZMK Input Behavior Listener](https://github.com/badjeff/zmk-input-behavior-listener)
44    - [ZMK PMW3610 Driver](https://github.com/badjeff/zmk-pmw3610-driver)
45
46> [!NOTE]  
47> Charybdis uses Inorichi's PMW3610 driver, while Charybdis Dongle leverages multiple modules written by badjeff.
48
49## TOTEM
50
51- [TOTEM](https://github.com/eigatech/zmk-config/tree/totem)
52- [TOTEM Dongle](https://github.com/eigatech/zmk-config/tree/totem-dongle)
53
54## Dongle Flashing
55
56Dongle configs use Seeed Xiao Ble microcontrollers housed in a nifty 3D printed [case](https://www.printables.com/model/522586-seeed-xiao-ble-case).
57
581. Turn all controllers off
592. Flash the dongle controller with the **appropriate** `settings_reset` file.
603. Flash the dongle controller with the `dongle` file.
614. Flash the first half with the the `settings_reset` file.
625. Flash the first half with the `left` or `right` files.
636. Repeat steps 4 and 5 for the other half.
64
65> [!WARNING]  
66> When using both Nice!Nano and Seeed XIAO microcontrollers, make sure you are flashing them with the correct files!
67
68## ZMK Keymap Editor
69
70Nick 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.
71
72## Shops and other useful links
73
74Kits, Prebuilts, Parts:
75- [kbd.news](https://kbd.news/vendors) - mechanical keyboard vendors list
76- [42keebs.eu](http://42keebs.eu/) - diy kits, including Corne, switches and other parts
77- [keeb.supply](https://keeb.supply/) - diy kits and prebuilts, including TOTEM, tools and other parts
78- [splitkb.com](https://splitkb.com/) - diy kits, including Corne, switches, tools and other parts
79- [bastardkb.com](https://bastardkb.com/) - diy kits and prebuilts, including Charybdis (wired only w/ qmk)
80- [typeractive.xyz](https://typeractive.xyz/) - diy kits and prebuilts, including Corne w/ nice!views, switches, tools and other parts
81
82Documentation and guides:
83- [ZMK Firmware Documentation](https://zmk.dev/docs)
84- [Eren's Wireless Charybdis Mini Guide](https://github.com/erenatas/charybdis-wireless-3x6)