{"id":19074958,"url":"https://github.com/varbhat/qmk_userspace","last_synced_at":"2025-07-10T13:33:34.219Z","repository":{"id":243381604,"uuid":"812275299","full_name":"varbhat/qmk_userspace","owner":"varbhat","description":"🔱 ⌨️ 🖲️ My QMK userspace overlay currently used for my crkbd/corne and madromys/adept","archived":false,"fork":false,"pushed_at":"2024-06-29T12:57:56.000Z","size":16,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-30T01:37:59.941Z","etag":null,"topics":["adept","corne","crkbd","dvorak-layout","keyboard","keymap","keymap-drawer","layers","madromys","mechanical-keyboard","oled","oled-display","oled-ssd1306","ploopy","ploopy-adept","qmk","qmk-config","qmk-firmware","qmk-userspace","trackball"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/varbhat.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}},"created_at":"2024-06-08T12:36:15.000Z","updated_at":"2024-11-29T18:02:08.000Z","dependencies_parsed_at":"2024-06-29T13:41:46.983Z","dependency_job_id":"17c276b2-ad8d-4fab-9aef-8c7dac3d334e","html_url":"https://github.com/varbhat/qmk_userspace","commit_stats":null,"previous_names":["varbhat/qmk_userspace"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/varbhat/qmk_userspace","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varbhat%2Fqmk_userspace","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varbhat%2Fqmk_userspace/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varbhat%2Fqmk_userspace/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varbhat%2Fqmk_userspace/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/varbhat","download_url":"https://codeload.github.com/varbhat/qmk_userspace/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/varbhat%2Fqmk_userspace/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264585372,"owners_count":23632646,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["adept","corne","crkbd","dvorak-layout","keyboard","keymap","keymap-drawer","layers","madromys","mechanical-keyboard","oled","oled-display","oled-ssd1306","ploopy","ploopy-adept","qmk","qmk-config","qmk-firmware","qmk-userspace","trackball"],"created_at":"2024-11-09T01:52:53.714Z","updated_at":"2025-07-10T13:33:33.952Z","avatar_url":"https://github.com/varbhat.png","language":"C","readme":"# *qmk_userspace* ⌨️ 🖲️\n## 🔱 My [QMK](https://qmk.fm) [Userspace](https://github.com/qmk/qmk_userspace) currently used for my [crkbd/corne](https://github.com/foostan/crkbd/tree/v3-final) and [adept/madromys](https://github.com/ploopyco/adept-trackball).\n\n![QMK](https://img.shields.io/badge/qmk-%23000000.svg?logo=qmk)\n![GitHub License](https://img.shields.io/github/license/varbhat/qmk_userspace)\n\n## Features\n- [Github Actions](https://github.com/features/actions) to build Firmware for my `corne` keyboard and `adept` trackball.\n- Visualization of Keymaps using [Keymap-drawer](https://github.com/caksoylar/keymap-drawer). Note that the layer names are not present in the visualization. Look into [keymap.c](keyboards/crkbd/keymaps/vbt/keymap.c) for the correct information.\n\n\u003cdetails open\u003e\n\u003csummary\u003eLayout Visualization using \u003ca href=\"https://github.com/caksoylar/keymap-drawer\"\u003ekeymap-drawer\u003c/a\u003e (Appearance of Layout is Dark themed)\u003c/summary\u003e\n\n![crkbd_rev1_vbt_dark.png](https://github.com/varbhat/qmk_userspace/releases/latest/download/crkbd_rev1_vbt_dark.png?raw=true)\n\n![ploopyco_madromys_rev1_001_vbt_dark.png](https://github.com/varbhat/qmk_userspace/releases/latest/download/ploopyco_madromys_rev1_001_vbt_dark.png?raw=true)\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eLayout Visualization using \u003ca href=\"https://github.com/caksoylar/keymap-drawer\"\u003ekeymap-drawer\u003c/a\u003e (Appearance of Layout is Light themed)\u003c/summary\u003e\n\n![crkbd_rev1_vbt_light.png](https://github.com/varbhat/qmk_userspace/releases/latest/download/crkbd_rev1_vbt_light.png?raw=true)\n\n\n![ploopyco_madromys_rev1_001_vbt_light.png](https://github.com/varbhat/qmk_userspace/releases/latest/download/ploopyco_madromys_rev1_001_vbt_light.png?raw=true)\n\n\u003c/details\u003e\n\n## Setup the QMK Workspace\n- This Repository is a `QMK Userspace` Repository. Instructions listed [here](https://github.com/qmk/qmk_userspace) can be followed to setup `QMK Userspace`. Or follow the following:\n    - Install `qmk` using `pipx` or your package manager.\n    - Setup `qmk` using `qmk setup`\n    - Clone this repository\n    - In the cloned repository, execute `qmk config user.overlay_dir=\"$(realpath .)\"`\n\n\n## Features of my `corne` keymap\n- `DVORAK` Layout (Alternating between the Hands is one of the main benefit of Dvorak)\n- 5 Layers: `DVORAK`,`QWERTY`, `NUM`, `SYM`, `NAV`\n- `VBUS` Detection using `GPIO19` for (My MCU is [Splinky](https://github.com/Bastardkb/Splinky). Using `VBUS` detection instead of USB Data channel detection, the keyboard can work without replugging and can be used to enter the BIOS)\n- Vertically Aligned OLED Display/Indicator. It displays Layer Names, Modifier Status(Super,Ctrl,Alt,Shift), Lock Status(CAPS Lock, Num Lock, Scr Lock) and `corne` logo. Distracting/Animating elements such as `WPM` indicators, pets(luna/bongocat/etc.), Keyloggers are disabled and not supported.\n- Utilizes Combos and One Shot Keys.\n- No `via` or `vial` support. I don't want any security loopholes. Let this Repository be the source of truth and everytime you make the changes, you reflash the keyboard with the new firmware.\n- `NUM` and `SYM` layer keys on the right thumb cluster will toggle to respective layers on double tap and will momentarily switch otherwise. It's achieved using `TAPPING_TOGGLE` feature of QMK (`TT`) set to 2.\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003ca href=\"https://docs.qmk.fm/features/combo\"\u003eCombo\u003c/a\u003e\u003c/summary\u003e\n \n`Escape` + `Backspace` =\u003e `DEL`\n\n`Space` + `Enter` =\u003e Move to Base `Dvorak` Layer. Turns off all other layers\n\n\u003c/details\u003e\n      \n\n## Usage for `corne`\n`.uf2` firmware for the `corne` is required. You can compile the `.uf2` firmware locally or can obtain the precompiled `.uf2` firmware (Compiled using Github Actions). Then, it needs to be flashed to the `corne`.\n\n#### Github Actions\n- Go to [Github Releases](https://github.com/varbhat/qmk_userspace/releases) and download the latest [.uf2](https://github.com/microsoft/uf2) file, or get here: [crkbd_rev1_vbt_promicro_rp2040.uf2](https://github.com/varbhat/qmk_userspace/releases/latest/download/crkbd_rev1_vbt_promicro_rp2040.uf2)\n\n#### Local\n- Setup the QMK Workspace.\n- Compile the Firmware using `qmk compile --clean -kb crkbd -km vbt`\n \n### Flashing the `corne`\n- Disconnect TRRS/TRS cable between the `corne` splits.\n- For both of `corne` splits, do:\n   - Connect your `corne` split to the computer using `USB`.\n   - Press spst switch (also called as reset switch) of the split two times consequently so that your [RP2040](https://www.raspberrypi.com/documentation/microcontrollers/rp2040.html) based MCU will go to `Bootloader` Mode.\n   - You must see `Raspberry PI Boot Device` in the output of `lsusb`. It's also detected as Mass Storage Device.\n   - Drag and Drop (`cp` or `copy`) the `.uf2` file to the `RP2040` Mass Storage Device.\n   - After the firmware is copied, you will see that the MCU exits `Bootloader` mode and Mass Storage Device is no longer present. It means that the firmware is flashed!\n\n## Features of my `adept` keymap\n- `via` is disabled.\n- Has 2 layers (which are mirrored copies of one another) which facilitates Ambidexterity.\n- Combo to switch between `RIGHT_HAND` and `LEFT_HAND` layer (Press btn4 and btn5 together).\n- Look into [keymap.c](keyboards/ploopyco/madromys/keymaps/vbt/keymap.c) for the more information.\n\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003ca href=\"https://docs.qmk.fm/features/combo\"\u003eCombo\u003c/a\u003e\u003c/summary\u003e\n \n\n`BTN4` + `BTN5` =\u003e Toggle `LEFT_HAND` layer on and off.\n\n\u003c/details\u003e\n      \n\n## Usage for `adept`\n`.uf2` firmware for the `adept` is required. You can compile the `.uf2` firmware locally or can obtain the precompiled `.uf2` firmware (Compiled using Github Actions). Then, it needs to be flashed to the `adept`.\n\n#### Github Actions\n- Go to [Github Releases](https://github.com/varbhat/qmk_userspace/releases) and download the latest [.uf2](https://github.com/microsoft/uf2) file, or get here: [ploopyco_madromys_rev1_001_vbt.uf2](https://github.com/varbhat/qmk_userspace/releases/latest/download/ploopyco_madromys_rev1_001_vbt.uf2)\n\n#### Local\n- Setup the QMK Userspace.\n- Compile the Firmware using `qmk compile --clean -kb ploopyco/madromys -km vbt`\n \n### Flashing the `adept`\n- Follow the official instructions: [Adept Trackball Wiki](https://github.com/ploopyco/adept-trackball/wiki/Appendix-D%3A-QMK-Firmware-Programming#putting-the-ploopy-device-into-bootloader-mode)\n\n## License\n[GPL-v2](LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvarbhat%2Fqmk_userspace","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvarbhat%2Fqmk_userspace","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvarbhat%2Fqmk_userspace/lists"}