{"id":16594537,"url":"https://github.com/stephenlacy/msi-keyboard-gui","last_synced_at":"2025-05-09T01:24:07.831Z","repository":{"id":42214194,"uuid":"59589584","full_name":"stephenlacy/msi-keyboard-gui","owner":"stephenlacy","description":"The First fully featured GUI MSI Keyboard controller for Linux (And Windows)","archived":false,"fork":false,"pushed_at":"2021-07-09T21:53:17.000Z","size":199,"stargazers_count":212,"open_issues_count":8,"forks_count":39,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-31T20:12:11.037Z","etag":null,"topics":["gui","klm","linux","macos","msi-keyboard","steelseries-keyboard","windows"],"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/stephenlacy.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":"2016-05-24T16:23:41.000Z","updated_at":"2024-05-16T19:29:50.000Z","dependencies_parsed_at":"2022-09-05T22:51:36.093Z","dependency_job_id":null,"html_url":"https://github.com/stephenlacy/msi-keyboard-gui","commit_stats":null,"previous_names":["stephenlacy/msi-keyboard-gui"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenlacy%2Fmsi-keyboard-gui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenlacy%2Fmsi-keyboard-gui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenlacy%2Fmsi-keyboard-gui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stephenlacy%2Fmsi-keyboard-gui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stephenlacy","download_url":"https://codeload.github.com/stephenlacy/msi-keyboard-gui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253172409,"owners_count":21865512,"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":["gui","klm","linux","macos","msi-keyboard","steelseries-keyboard","windows"],"created_at":"2024-10-11T23:46:34.360Z","updated_at":"2025-05-09T01:24:07.811Z","avatar_url":"https://github.com/stephenlacy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# msi-keyboard-gui\n\n\u003e The First fully featured GUI MSI Keyboard controller for Linux\n\n**Windows and Macos now supported!**\n\n![msi-keyboard](assets/logo.png)\n\n![Linux](https://img.shields.io/badge/Linux-epic-brightgreen.svg)\n\n![msi-keyboard](assets/2.png)\n\n## Install\n\n#### [Node.js](https://nodejs.org/) 6+ is REQUIRED\n\n#### From prebuilt binaries:\n\nDownload the latest from the [releases](https://github.com/stevelacy/msi-keyboard-gui/releases)\n\n#### Linux:\n```\n\n$ tar -xf ./msi-keyboard-gui-linux*.tar.gz\n$ sudo ./msi-keyboard-gui-linux-x64/msi-keyboard-gui\n\n```\n\n#### Windows:\n\nExtract zip file and run `msi-keyboard-gui-win32-x64\\msi-keyboard-gui.exe`\n\n#### Linux From development:\n\n- Install the required libraries for your OS: `libusb-dev` or `libusb-1.0-0-dev`\n- Node.js version 6+ is required due to `node-hid` bindings\n\n```\n$ git clone https://github.com/stevelacy/msi-keyboard-gui\n$ cd msi-keyboard-gui\n$ npm install\n$ sudo npm start\n\n```\n\nNote: if you get the error `No protocol specified` when using the user `root` on linux add the user `root` to your xauthority xhost config with: `xhost si:localuser:root` and try `sudo npm start`\n\n#### Windows From development:\n- Node.js version 6+ is required due to `node-hid` bindings\n\n```\n$ git clone https://github.com/stevelacy/msi-keyboard-gui\n$ cd msi-keyboard-gui\n$ npm install\n$ npm run start:windows\n```\n\n#### Macos From development:\n- Node.js version 6+ is required due to `node-hid` bindings\n\n```\n$ git clone https://github.com/stevelacy/msi-keyboard-gui\n$ cd msi-keyboard-gui\n$ npm install\n$ sudo npm run start:macos\n```\n\n\n## Usage\n\n1. Click on a region to select a color\n2. Choose a color\n3. Click \"Set Color\" to activate the keyboard\n\n\n## Modes\n\nClick on \"Set Mode\" to choose a mode. The currently supported modes are:\n\n  wave\n  breathe\n  normal\n\nBy default the normal mode is used to light all three regions of the keyboard.\n\n#### Device support requested\n\nIf this project works on your system please send a commit adding your device description to [this list](SUPPORTED.md)\n\n#### Contributions welcome!\nIf you find a bug or issue please check the [github issues](https://github.com/stevelacy/msi-keyboard-gui/issues) or open an new one.\nFeature requests / pull requests are welcome!\n\n## [License](LICENSE) (MIT)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephenlacy%2Fmsi-keyboard-gui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstephenlacy%2Fmsi-keyboard-gui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstephenlacy%2Fmsi-keyboard-gui/lists"}