how_to_model_keys.md

How to model a new key

How it Works

1. Get some nice pictures of the side and tip of your key. I recommend a flatbed scanner. You may also consider finding a profile of your key in a PDF from the manufacturer.
2. Using Inkscape, trace the key outline, warding, and engraving. If you got your image from a PDF, your job is much easier, and you only need to clean up the paths.
3. Select a path and press Control-Shift-O. Give it a useful name, such as "outline" or "warding". (I recommend using outline, warding, and engrave)
4. Save the result as a SVG in the resources folder. Run make to generate OpenSCAD polygons from your paths.
5. Look up online the various parameters of your key, such as plug diameter, cut depths and locations. Many are now included by Charely6 in the referenceMaterials folder
6. Use the provided OpenSCAD functions key_code_to_heights, key_blank and key_bitting to generate a 3D model of your key. Use the provided OpenSCAD files as a template. Note you will want to set the offset to the point at the bottom key shoulder, If you don't know which one that is I used the commented out polygons at the bottom of the gen.scad file and randomly changing values and seeing which point moves and noting which one is that spot. The points will go in one direction around the shape so you can work your way around.
   Also if you want to do double sided keys look at X103-KW12.scad there is a comment noting it.
7. To add your key to the database, edit the Makefile to include your .scad file in the SCAD_SRC variable. To add to the Makefile be sure to set name in your module and make variables named outlines_k and wardings_k like the ones in the original .scad files

For this to work, your final file must look like this:

module key_name(...) {
    name = "Human-readable name of your key";
    /*
        Description of your key, including
        how to properly format a bitting,
        possibly with examples
    */

    ...
}

// These defaults are overridden by
// -D on the command line
bitting = "default-bitting";
outline = "default-outline";
warding = "default-warding";
key_name(...);