Giter VIP home page Giter VIP logo

glk-keycap's Introduction

GLK

Galeforce Keycap Profile (GLK) is an MX-spaced, low-profile, semi-spherical, sculpted keycap inspired by the lack of OEM-style keycaps for low-profile switches. This profile aims to replicate the OEM feel, while adding a little spice inspired by other profiles.

GLK is developed in CadQuery and released under the MIT License.

Usage

Working with CadQuery is easiest to start with CQ-Editor, but running an instance of CadQuery Server via Docker provides a more stable and integrated experience.

CQ-Editor

  1. Install dependencies via PIP with
    • pip install --pre cadquery
    • pip install scipy git+https://github.com/gumyr/cq_warehouse.git#egg=cq_warehouse
  2. Download a pre-built CQ-Editor package from jmwright's repository.
  3. Load src/preview.py in CQ-Editor and start rendering.

Note that because CQ-Editor runs an isolated version of Python, the additional dependencies installed via PIP may have version compatibility issues. CQ-Editor is also be prone to memory leaks in my experience. In either case, the best option is to work with Docker.

Docker

  1. Create the image with docker build -t cadquery/cadquery-server-warehouse .
  2. Run the container with docker run -t glk -p 5000:5000 -d -v $(pwd):/data cadquery/cadquery-server-warehouse run
    • You can now remote into the container with VSCode to work locally.
  3. View the CAD models in realtime at http://localhost:5000

Note that CadQuery Server will only automatically run scripts from src folder in this setup. See CadQuery Server's github for details on how you can configure it in step 2.

Working with GLK

The main keycap function in the src/GLK.py will produce a 1U home row key by default. The profile function will produce a dictionary containing all unique keycaps required for a 100% keyboard, and ErgoDox and a GLFCKB at official settings.

some stuff about SLA printing support generation here

some stuff about GLK-S here

Examples

some stuff using the different features here

Save and Export results

src/export.py is setup generate STL and STEP files for a full keycap set via the profile function mentioned above, and will output to the export directory. See the file for some config options.

The export directory includes some examples of keycaps in both STL and STEP format, generated at modest quality settings.

Credits

glk-keycap's People

Contributors

everalert avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.