Dometyl

Guides

In addition to the example configs found in the dometyl repo, there are guides available that go into a bit more detail:

• basic walkthrough

API

Dometyl -- top level library interface

Top-level parts

• Case -- keyboard case generation (sub-part builders as input)
• Bottom -- bottom plate generation given a Case.t
• Tent -- tenting base generation given a Case.t

Keywell

• Plate -- key plate generation (body columns + thumb cluster)
• Curvature -- describing distributions of key along columns
• Column -- a group of Key.t
• Columns -- collections of Column.t
• Bridge -- bridging gaps between Key.ts and Column.ts

Keyholes

• Key -- a generic keyhole
• Mx -- specialized mx keyhole with optional hotswap sockets
• Choc -- specialized choc keyhole with optional hotswap sockets
• Niz -- specialized niz rubber dome keyholes
• Sensor -- sensor cutouts (for niz keyholes in particular)

Walls

• Walls -- generation of collections of walls for Plate.t
• Wall -- individual walls from Key.t side faces to ground
• Connect -- connecting up walls to form the outer perimeter of the Case.t
• Eyelet -- heatset insert, magnet, and bumpon placement

MCU mounting and port placement

• Ports -- MCU holders and cutting TRS jack and USB cutouts
• BastardShield -- BK elite-C shield specific mounting solutions

Visualization aids

• Caps -- import and prep of keycap models for visualizing spacing
• Hand -- customizable hand model to help with keywell design

Utilities and miscelaneous types

• IMap -- maps with integer keys
• Util -- various basic utility functions
• Syntax -- let binding operators for Option.t (and compose)
• Idx -- index type allowing specification of first/last element
• Points -- coordinates for (roughly) rectangular faces