Skip to content

manabu/keyboard-layout-image-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

keyboard-layout-image-generator

Generate Keyboard Image PDF file from source code keymap.c which is for qmk/qmk_firmware: keyboard controller firmware for Atmel AVR USB family

Currently design for only ErgoDox

Background

These are nice editor and very good looking easy to see my keyboard layouts.

But when I create custom one with:

No image to keymap.

After the change of keymap with source code keymap.c .

No image of keyboard layouts .

This application generate PDF image from keymap.c .

Keyboard

Goal

Goal is no need to maintain double.

Download

How to build

peg keymap_image.peg

How to run

go run keymap_image.go keymap_image.peg.go keymap.c > layout.pdf

Get keymap

If you don't have own image.

curl -o keymap.c https://raw.githubusercontent.com/qmk/qmk_firmware/master/keyboards/ergodox/keymaps/default/keymap.c

How it works

Using PEG for handling keymap.c

Firstly I try to use peg/c.peg at master · pointlander/peg but it can't parse well.

So I create PEG file for very simple and adapt for ErgoDox keymap.c .

TODO

  • Single Binary
  • Long press key
  • Key combinations
  • Color
  • Rotate some keys label
  • More flexible mapping to keys
  • Output JSON for Keyboard Layout Editor
  • If it can , more easy to see stable version and current develop version.

Reference

About

Generate Keyboard Image

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages