Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ai03-2725/another-keyboard-builder
An exact mechanical keyboard plate creator
https://github.com/ai03-2725/another-keyboard-builder
Last synced: about 2 months ago
JSON representation
An exact mechanical keyboard plate creator
- Host: GitHub
- URL: https://github.com/ai03-2725/another-keyboard-builder
- Owner: ai03-2725
- License: agpl-3.0
- Archived: true
- Created: 2018-10-21T21:48:14.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-01-17T14:29:15.000Z (over 2 years ago)
- Last Synced: 2024-07-18T16:34:40.730Z (2 months ago)
- Language: Python
- Homepage:
- Size: 300 KB
- Stars: 88
- Watchers: 5
- Forks: 16
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Another Keyboard Builder
An exact mechanical keyboard plate creator that doesn't result in 13.99999mm cutouts
---
# This project is obsolete
This server-side plategen has been succeeded by a client-side revision.
The successor can be viewed [here](https://github.com/ai03-2725/yet-another-keyboard-builder).
This project will be archived for the time being.
---
## Why?
- Alternate generators don't have either the features or exactness that designers need.
- This plate generator is designed to save keyboard designers significant amounts of time, while also providing top-notch accuracy required for designs costing hundreds of dollars.
## Features
- Filleting. Fillet all corners during generation so Fusion 360 doesn't have to crash 50 times later attempting it.
- Exactness. No more 13.99999mm or 14.00001mm cutouts; this generator will always produce exact, accurate dimensions.
- A variety of cutout options based on actual production-use dimensions.
## Usage
There are two methods of use: As a CLI tool, or as a web app.
#### Plategen as a standalone tool:
```
plategen.py [-h] [-ct CUTOUT_TYPE] [-cr CUTOUT_RADIUS] [-st STAB_TYPE]
[-sr STAB_RADIUS] [-at ACOUSTICS_TYPE]
[-ar ACOUSTICS_RADIUS] [-uw UNIT_WIDTH] [-uh UNIT_HEIGHT]
[--debug-log]
```
Run `python plategen.py -h` to see detailed information on each argument.
An example of generating based on raw data in a file:
```
cat kle-raw | python plategen.py > plate.dxf
```
To use the CLI tool, requirements from requirements.txt must be installed.
#### Hosting:
Simply run web.py with requirements from requirements-web.txt installed.
## Additional Options
In addition to feeding in typical Keyboard-Layout-Editor data, custom fields may be added to fine-tune the outcomes:
- `_rs:` Rotate the stabilizer cutout independently from the key. (Idea from [SwillKB Builder](https://github.com/swill/kad))
For example, for bottom row flipped spacebars, a 6.25U spacebar may have the data field `{w:6.25,_rs:180}`.
- `_rc:` Similar, but for rotating the switch cutout independently of the key.
## Requirements:
- Python 3.7
- Everything in requirements.txt (or requirements-web.txt if hosting web service)
## Todo
- More stabilizer cutout options.
- More switch cutout options.
- Fix certain rotated switches dying. However, this is mostly due to awful KLE syntax, so I don't plan to repair it soon.