Skip to content

stephenlacy/msi-keyboard-gui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

73 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

msi-keyboard-gui

The First fully featured GUI MSI Keyboard controller for Linux

Windows and Macos now supported!

msi-keyboard

Linux

msi-keyboard

Install

Node.js 6+ is REQUIRED

From prebuilt binaries:

Download the latest from the releases

Linux:


$ tar -xf ./msi-keyboard-gui-linux*.tar.gz
$ sudo ./msi-keyboard-gui-linux-x64/msi-keyboard-gui

Windows:

Extract zip file and run msi-keyboard-gui-win32-x64\msi-keyboard-gui.exe

Linux From development:

  • Install the required libraries for your OS: libusb-dev or libusb-1.0-0-dev
  • Node.js version 6+ is required due to node-hid bindings
$ git clone https://github.com/stevelacy/msi-keyboard-gui
$ cd msi-keyboard-gui
$ npm install
$ sudo npm start

Note: 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

Windows From development:

  • Node.js version 6+ is required due to node-hid bindings
$ git clone https://github.com/stevelacy/msi-keyboard-gui
$ cd msi-keyboard-gui
$ npm install
$ npm run start:windows

Macos From development:

  • Node.js version 6+ is required due to node-hid bindings
$ git clone https://github.com/stevelacy/msi-keyboard-gui
$ cd msi-keyboard-gui
$ npm install
$ sudo npm run start:macos

Usage

  1. Click on a region to select a color
  2. Choose a color
  3. Click "Set Color" to activate the keyboard

Modes

Click on "Set Mode" to choose a mode. The currently supported modes are:

wave breathe normal

By default the normal mode is used to light all three regions of the keyboard.

Device support requested

If this project works on your system please send a commit adding your device description to this list

Contributions welcome!

If you find a bug or issue please check the github issues or open an new one. Feature requests / pull requests are welcome!

License (MIT)

About

The First fully featured GUI MSI Keyboard controller for Linux (And Windows)

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 21