mirror of
https://github.com/ervanalb/keygen.git
synced 2025-12-14 12:25:28 +00:00
46 lines
1.3 KiB
Markdown
46 lines
1.3 KiB
Markdown
# keygen
|
|
Tools for generating physical keys.
|
|
|
|
|
|
|
|
|
|
## How to use it
|
|
```
|
|
usage: keygen.py [-h] [-b BITTING] [-u OUTLINE] [-w WARDING] [-o OUTPUT]
|
|
filename
|
|
|
|
Generates keys.
|
|
|
|
positional arguments:
|
|
filename OpenSCAD source file for the key
|
|
|
|
optional arguments:
|
|
-h, --help show this help message and exit
|
|
-b BITTING, --bitting BITTING
|
|
Key bitting
|
|
-u OUTLINE, --outline OUTLINE
|
|
Key blank outline
|
|
-w WARDING, --warding WARDING
|
|
Key warding
|
|
-o OUTPUT, --output OUTPUT
|
|
Output file (defaults to a.stl)
|
|
|
|
All remaining arguments are passed to OpenSCAD.
|
|
```
|
|
|
|
### Examples
|
|
|
|
```bin/keygen.py scad/kwikset.scad --bitting 25536 -o housekey.stl```
|
|
|
|
```bin/keygen.py scad/schlage_classic.scad -u 6-pin -w L -b 999999 -o all_section_bump_key.stl```
|
|
|
|
```bin/keygen.py scad/schlage_classic.scad -o key.png --render```
|
|
|
|
## Contributing
|
|
|
|
There is a very limited selection of keys right now, to help out, see the guide on [how to model keys](doc/how_to_model_keys.md).
|
|
|
|
## Music
|
|
|
|
There is no keygen music yet, in the meantime, try [here](https://soundcloud.com/dualtrax/sets/orion-keygen-music)
|