https://github.com/p3r7/norns-kbd-layout-generator

norns kaymap generator script
https://github.com/p3r7/norns-kbd-layout-generator

keyboard keyboard-layout keycode monome monome-norns norns

Last synced: about 1 year ago
JSON representation

norns kaymap generator script

• Host: GitHub
• URL: https://github.com/p3r7/norns-kbd-layout-generator
• Owner: p3r7
• License: mit
• Created: 2021-08-25T11:08:40.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-10-16T14:07:39.000Z (over 4 years ago)
• Last Synced: 2025-04-02T02:41:01.910Z (about 1 year ago)
• Topics: keyboard, keyboard-layout, keycode, monome, monome-norns, norns
• Language: Python
• Homepage:
• Size: 18.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# norns-kbd-layout-generator

convert layout files from [QMK project](https://github.com/qmk/qmk_firmware) to monome norns own format.

this is what got used to generate files in [norns/lua/core/keymap/](https://github.com/monome/norns/tree/main/lua/core/keymap).

### usage

retrieve any of the layout files (`keymap_*.h`) from https://github.com/qmk/qmk_firmware/tree/master/quantum/keymap_extras/ locally.

run the script, e.g.:

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_french.h --dest fr.lua

drop the resulting file in the `/home/we/norns/lua/core/keymap/`.

import it in `/home/we/norns/lua/core/keyboard.lua`:

```lua

keyboard.keymap = {}

keyboard.keymap.us = require 'core/keymap/us'

keyboard.keymap.fr = require 'core/keymap/fr' -- new entry

```

### full dump

this is what got used to generate current set of keymaps.

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_belgian.h --dest be.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_croatian.h --dest hr.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_czech.h --dest cz.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_danish.h --dest dk.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_estonian.h --dest ee.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_finnish.h --dest fi.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_french.h --dest fr.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_german.h --dest de.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_greek.h --dest gr.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_hungarian.h --dest hu.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_icelandic.h --dest is.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_irish.h --dest ie.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_italian.h --dest it.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_jp.h --dest jp.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_korean.h --dest kp.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_latvian.h --dest lv.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_norwegian.h --dest no.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_polish.h --dest pl.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_portuguese.h --dest pt.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_romanian.h --dest ro.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_russian.h --dest ru.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_serbian.h --dest rs.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_slovak.h --dest sk.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_slovenian.h --dest si.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_spanish.h --dest es.lua

    python3 ./main.py --src ~/Code/qmk_firmware/quantum/keymap_extras/keymap_swedish.h --dest se.lua

### limitations

the char corresponding to each key is a comment in QMK keymap files. they could have a bad value whithout QMK users noticing.

assumes only `Shift` and `AltGr` as charset modifiers. if other ones exists, it wuld be trivial to add them.