{"id":16188291,"url":"https://github.com/konsumer/node-gk6x","last_synced_at":"2025-03-19T03:30:40.223Z","repository":{"id":57113484,"uuid":"390153145","full_name":"konsumer/node-gk6x","owner":"konsumer","description":"This adds support for GK6X keyboards in nodejs.","archived":false,"fork":false,"pushed_at":"2021-07-29T19:37:20.000Z","size":1217,"stargazers_count":16,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-28T14:49:55.328Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/konsumer.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}},"created_at":"2021-07-27T23:14:20.000Z","updated_at":"2024-10-19T19:49:56.000Z","dependencies_parsed_at":"2022-08-22T04:30:46.499Z","dependency_job_id":null,"html_url":"https://github.com/konsumer/node-gk6x","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/konsumer%2Fnode-gk6x","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/konsumer%2Fnode-gk6x/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/konsumer%2Fnode-gk6x/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/konsumer%2Fnode-gk6x/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/konsumer","download_url":"https://codeload.github.com/konsumer/node-gk6x/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243965752,"owners_count":20375917,"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":[],"created_at":"2024-10-10T07:25:49.804Z","updated_at":"2025-03-19T03:30:39.719Z","avatar_url":"https://github.com/konsumer.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# node GK6X\n\nThis adds support for GK6X keyboards in nodejs.\n\n--- \n\nThis will allow you program a ton of custom configs, in Mac, Windows, and Linux.\n\n## supported devices\n\nOn linux, you can see if your keyboard is supported by typing this:\n\n```sh\nlsusb\n```\n\nyou should see a line that looks like this:\n\n```\nBus 001 Device 016: ID 1ea7:0907 SHARKOON Technologies GmbH Keyboard\n```\n\nI'm not quite sure how to do this on other OS's (someone that uses them should let me know!) Basically a ton of programmable keyboards by epomaker (and clones) should work.\n\n## usage\n\n### permissions\n\nOn Linux, you will need to run with `sudo` or [add udev rules](https://github.com/node-hid/node-hid#udev-device-permissions) to give you access to raw HID devices.\n\nI made one that looks like this, in /etc/udev/rules.d/gk6x.rules:\n\n```\nSUBSYSTEM==\"input\", GROUP=\"input\", MODE=\"0666\"\nSUBSYSTEM==\"usb\", ATTRS{idVendor}==\"1ea7\", ATTRS{idProduct}==\"0907\", MODE:=\"666\", GROUP=\"plugdev\"\nKERNEL==\"hidraw*\", ATTRS{idVendor}==\"1ea7\", ATTRS{idProduct}==\"0907\", MODE=\"0666\", GROUP=\"plugdev\"\n```\n\nI added myself to `plugdev` (then rebooted):\n\n```sh\nsudo adduser $(whoami) plugdev\n```\n\n### CLI\n\nYou can install it globally with `npm i -g @gk6x/cli`, and it will install `gk6x` in your path. You can also use it without installing `npx @gk6x/cli`.\n\n```\ngk6x \u003ccommand\u003e\n\nCommands:\n  gk6x config \u003cfile\u003e            Use le or pixeltris config format (easier to u\n                                  se) to setup your keyboard\n  gk6x convert \u003cfileA\u003e \u003cfileB\u003e  Convert to/from pixeltris and official le\n  gk6x apple                    Force your keyboard to pretend it's an officia\n                                  l apple keyboard\n  gk6x normal                   Remove the weird apple setup\n\nOptions:\n  --help     Show help                                                 [boolean]\n  --version  Show version number                                       [boolean]\n```\n\nBe careful with `apple` it messes with the keyboard ID to make it seem like an official apple keyboard. You can set it back with `normal`, but you might need `sudo` on mac/linux.\n\n\n### library\n\nYou can also use this as a library in your own node-based project like this:\n\n```sh\nnpm i @gk6x/core\n```\n\nIt's probably only useful for people who want to write their own GUI or CLI utility.\n\n\n## todo\n\n- test on different OS's ([keyboard HID is known to be weird on mac/win](https://github.com/node-hid/node-hid#devices-node-hid-cannot-read))\n- make TUI for setting up keyboard in terminal\n- support for updating firmware (this seems to be missing form official software, too)\n- builds of cli (via pkg)\n- builds of gui (via [neutralino](https://neutralino.js.org/) or electron)\n\n## thanks\n\nThis is all due to [the awesome work of @pixeltris](https://github.com/pixeltris/GK6X) in C#. They, in-turn, used [@wgwoods work in python](https://github.com/wgwoods/gk64-python).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkonsumer%2Fnode-gk6x","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkonsumer%2Fnode-gk6x","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkonsumer%2Fnode-gk6x/lists"}