mkbd65 case
===========

_The case for mkbd65 is still a work in progress!_


Generate CAD files
------------------

1. Install dependencies
   ```shell
   pip3 install --user -r requirements.txt
   ```
2. Generate files for your phone for example the Oneplus 8T
   ```shell
   ./mkbd65.py --layout=ansi --3mf oneplus_8t.ini
   ```

Build instructions
------------------

### 3D printing

Most of the case can be 3D printed using a home 3D printer, any online 3D printing service or at your local hack/make space. You can find your local hack/make space [here](https://wiki.hackerspaces.org/List_of_Hacker_Spaces).

Print out these files with a sturdy filament like PLA:

- `lower_case`

Print out the `key_mat` with a flexible filament like [FilaFlexible40](https://fila-tech.store/product/filaflexible40).

Config files
------------

Properties for different phones are saved in INI files. Currently the only file included is `oneplus_8t.ini` for the
Oneplus 8T phone. You can add your one phone by providing the INI file with measurements and a file describing it's camera bump.

In the config file you can define the phones size but also other aspects like the used font for the key mat. Here is a list of
the possile options:

| Group   | Option    | Type   | Default                | Description                   |
| ------- | --------- | ------ | ---------------------- | ----------------------------- |
| keymap  | thickness | Number | 0.5                    | Thickness of the keymap in mm |
| key_mat | thickness | Number | 1                      | Thickness of the key in mm    |
|         | font      | String | DejaVu Sans:style=Bold | Font used for labels          |

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                     |
| mkbd65_lower_case.scad | PLA      | 3D printable                           |
| mkbd65_internals.scad  | PLA      | 3D printable                           |
| mkbd65.scad            | -        | Combination of the above files         |

---

![CC BY-SA 4.0](https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-sa.svg)
<p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="https://gitlab.com/mkbd65/case">mkbd65 case</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://mkbd65.xengi.de">XenGi</a> is licensed under <a href="http://creativecommons.org/licenses/by-sa/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC BY-SA 4.0</a></p>