This commit is contained in:
Ricardo (XenGi) Band 2023-05-24 23:53:03 +02:00
commit bbad6e3bad
No known key found for this signature in database
30 changed files with 580 additions and 13 deletions

View file

@ -1,8 +1,50 @@
mkbd65 case
===========
_The case for mkbd65 is still a work in progress!_
_The case and key set for mkbd65 is still a work in progress!_
This is the case for mkbd65. It is build using [OpenSCAD][openscad] to be able to generate multiple cases fitting
different phones from a single file.
Follow the guide at https://mkbd65.xengi.de to build a case for your phone.
## Generate a case
_TBA_
## Generate a key set
To generate the key set you can either use a predefined layout or generate your own. There are two predefined layouts
for English US International and German. You can generate the 3D files for them with the following commands:
```shell
make keys:en-us-intl
make keys:de
```
This will generate the neccessary 3MF and STL files that you can use for your 3D printers slicer software. I recommend a
flexible filament like Filaflex 95A for the best typing experience.
### Custom layout
If you want to build your own custom layout follow the instruction in the file `custom_keyset.scad`. It will explain how
to write the openscad code for a key set and generate the 3MF and STL files. You can use any of the keys from a 5x14
matrix and also combine them however you like. Remember that you have to duplicate the keys in the config of the QMK
software for every non 1x1 key too. Because electrically every switch is still a single unique key and gets detected as
such.
So if you want to create a 3x1 space bar at position (0, 5) you can create a key cap by using `key(x=0, y=5, w=3)`. In
the QMK config you have to create 3 distinct space bar keys next to each other.
In theory the maximum width of a key is 3. You can use more then that but the key will get sliced at different points to
avoid accidental duble presses of the switches underneath.
---
[openscad]: https://openscad.org
---
**old docs**
Generate CAD files
------------------
@ -50,7 +92,7 @@ OpenSCAD files
The generator script will create multiple files.
| File | Material | Description |
| ---------------------- | -------- | -------------------------------------- |
|------------------------| -------- | -------------------------------------- |
| mkbd65_key_mat.scad | TPU | 3D printable |
| mkbd65_pcb.scad | - | Just a spacer for the 3D model fitting |
| mkbd65_top_plate.scad | Acrylic | Laser cut on a CNC |