{"id":29418564,"url":"https://github.com/olavvatne/overlay","last_synced_at":"2026-05-18T05:43:46.419Z","repository":{"id":304222606,"uuid":"976058856","full_name":"olavvatne/overlay","owner":"olavvatne","description":"Display configurable overlays on-screen with hotkeys","archived":false,"fork":false,"pushed_at":"2025-07-11T18:06:01.000Z","size":478,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-11T19:33:29.226Z","etag":null,"topics":["app","ergonomic-keyboard","overlay","preact","tauri2"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/olavvatne.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-01T12:15:07.000Z","updated_at":"2025-07-11T18:02:28.000Z","dependencies_parsed_at":"2026-05-04T15:03:53.617Z","dependency_job_id":null,"html_url":"https://github.com/olavvatne/overlay","commit_stats":null,"previous_names":["olavvatne/overlay"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/olavvatne/overlay","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olavvatne%2Foverlay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olavvatne%2Foverlay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olavvatne%2Foverlay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olavvatne%2Foverlay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/olavvatne","download_url":"https://codeload.github.com/olavvatne/overlay/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/olavvatne%2Foverlay/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33166737,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-18T05:43:36.989Z","status":"ssl_error","status_checked_at":"2026-05-18T05:43:19.133Z","response_time":71,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["app","ergonomic-keyboard","overlay","preact","tauri2"],"created_at":"2025-07-12T00:00:52.671Z","updated_at":"2026-05-18T05:43:46.403Z","avatar_url":"https://github.com/olavvatne.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# \u003cimg src=\"https://raw.githubusercontent.com/olavvatne/overlay/refs/heads/main/public/icon-readme.svg\" width=\"32\" height=\"32\"\u003e Overlay\n\nDisplay ergo keyboard layers onscreen. Can be used for other purposes as well, where you want to display svg images overlays onscreen.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/user-attachments/assets/f4439b04-c944-4243-80c1-c54bd476ad53\" height=\"200\" /\u003e\n  \u003cimg src=\"https://github.com/user-attachments/assets/0bd84331-9fe3-4f19-a84e-07a4ff2962d7\" height=\"200\" /\u003e\n  \u003cimg src=\"https://github.com/user-attachments/assets/37eff285-5bb9-4954-b6ee-744ad9d12389\" height=\"200\" /\u003e\n\u003c/p\u003e\n\n## ⚡ Usage\n\n### Generating svg of your keymap\n\nNavigate to your custom qmk setup, and:\n\n```bash\npython -m venv .venv \nsource .venv/bin/activate\npip install keymap-drawer\nqmk c2json ./keyboards/crkbd/rev1/keymaps/seniply/keymap.c | keymap parse --layer-names Base Extend Symbol Number Function  -c 12 -q - \u003e keymap.yaml\nkeymap draw keymap.yaml --select-layers Base \u003e keymap.base.svg\nkeymap draw keymap.yaml --select-layers Extend \u003e keymap.extend.svg\nkeymap draw keymap.yaml --select-layers Symbol \u003e keymap.symbol.svg\nkeymap draw keymap.yaml --select-layers Number \u003e keymap.number.svg\nkeymap draw keymap.yaml --select-layers Function \u003e keymap.function.svg\n```\n\nAlternatively, use web tool [keymap-drawer](https://keymap-drawer.streamlit.app/)\n\n## 🔌 Installation\n\n* Install [Node.js](https://nodejs.org/en/)\n\n```bash\ngit clone git@github.com:olavvatne/overlay.git\nnpm install\n```\n\n## 📦 Commands\n\n* `npm run tauri dev` - Run Overlap application in dev mode\n\n## 🔒 License\n\nThis project is licensed under the MIT License\n\n## 📖 Other\n\n### Register and pass shortcut on layer activation with QMK\n\nBelow is an example from `keymap.c` with layer activation similar to [Seniply keyboard layout](https://stevep99.github.io/seniply/).\nIn the example there is a dedicated toggle overlay key that is activated by `Command+Shift+F14`\nAnd each layer activation sends along a shortcut, `Command+Shift+F15`, `Command+Shift+F16`, ... , `Command+Shift+FXX`.\n\n```c\n\nenum layer_names {\n  _BASE,\n  _EXT,\n  _SYM,\n  _NUM,\n  _FUNC,\n};\n\n#define MO_EXT   MO(_EXT)\n#define MO_SYM   MO(_SYM)\n#define MO_NUM   MO(_NUM)\n#define MO_FUNC   MO(_FUNC)\n\n\nenum custom_keycodes {\n    TOGGLE_OVERLAY = SAFE_RANGE,\n};\n\nconst uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {\n  [_BASE] = LAYOUT_split_3x6_3(\nTOGGLE_OVERLAY,    KC_Q,    KC_W,    KC_F,    KC_P,    KC_B,                     KC_J,    KC_L,    KC_U,    KC_Y,    KC_QUOT, TOGGLE_OVERLAY,\n      XXXXXXX,    KC_A,    KC_R,    KC_S,    KC_T,    KC_G,                     KC_M,    KC_N,    KC_E,    KC_I,    KC_O,  XXXXXXX,\n      XXXXXXX,    GUI_Z ,  ALT_X,   CTL_C,   SFT_D,   KC_V,                     KC_K,    SFT_H,   CTL_COMM,ALT_DOT, GUI_SLSH,MO_FUNC,\n                                           KC_TAB, MO_EXT, KC_LSFT,    KC_SPC, MO_SYM, _______\n  ),\n  [_EXT] = ...\n  [_SYM] = ...\n  [_NUM] = ...\n  [_FUNC] = ...\n};\n\nvoid send_super_shift_code(uint16_t keycode) {\n    register_mods(MOD_BIT(KC_LSFT) | MOD_BIT(KC_LGUI));\n    register_code(keycode);\n    unregister_code(keycode);\n    unregister_mods(MOD_BIT(KC_LSFT) | MOD_BIT(KC_LGUI));\n}\n\n\nlayer_state_t layer_state_set_user(layer_state_t state) {\n    state =  update_tri_layer_state(state, _SYM, _EXT, _NUM);\n\n    int16_t layer = _BASE;\n    switch (get_highest_layer(state)) {\n        case _EXT:\n            layer = _EXT;\n            break;\n        case _SYM:\n            layer = _SYM;\n            break;\n        case _NUM:\n            layer = _NUM;\n            break;\n        case _FUNC:\n            layer = _FUNC;\n            break;\n        default:\n            layer = _BASE;\n            break;\n    }\n    // Communicate layer activation to OS\n    send_super_shift_code(KC_F14 + layer);\n    \n    return state;\n}\n\nbool process_record_user(uint16_t keycode, keyrecord_t* record) {\n    if (record-\u003eevent.pressed) {\n        switch(keycode) {\n            case TOGGLE_OVERLAY:\n            send_super_shift_code(KC_F13);\n            return false;\n        }\n        snprintf(last_key_pressed, sizeof(last_key_pressed), \"0x%04X\", keycode);\n    }\n  return true;\n}\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folavvatne%2Foverlay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Folavvatne%2Foverlay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Folavvatne%2Foverlay/lists"}