Skip to content

Clarification needed: How to properly model and add new key types #22

Description

@gabomoto1

Hi, thanks for this great project!

I'm trying to model and add a new key type to the repository, but I find the current instructions a bit unclear or scattered. Specifically:

  • The how_to_model_keys.md file provides a general overview but lacks step-by-step details for beginners.

  • The section about using Inkscape to trace keys, naming paths, and running make could use clarification. For example:

    • Are specific colors or stroke styles required for the paths?
    • Should the scan or photo be of a blank (uncut) key or a cut key?
    • Are there any requirements for the exact image size, DPI, or scale?
    • What is the expected folder structure, and how do the SVG paths get converted into OpenSCAD polygons?
  • It’s also unclear how to define key parameters like plug diameter, cut spacing, and depth—should those go into a .scad file, a Python file, or somewhere else?

  • An end-to-end example—from scanning the key to producing a .scad model ready for key generation—would be extremely helpful.

I'm planning to contribute several key profiles since I find the project particularly useful and believe it could help a lot of people. Clearer documentation would make it much easier to contribute correctly.

Thanks again for your work!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions