Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stephenlacy/msi-keyboard-gui

The First fully featured GUI MSI Keyboard controller for Linux (And Windows)
https://github.com/stephenlacy/msi-keyboard-gui

gui klm linux macos msi-keyboard steelseries-keyboard windows

Last synced: about 1 month ago
JSON representation

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

Awesome Lists containing this project

README

        

# msi-keyboard-gui

> The First fully featured GUI MSI Keyboard controller for Linux

**Windows and Macos now supported!**

![msi-keyboard](assets/logo.png)

![Linux](https://img.shields.io/badge/Linux-epic-brightgreen.svg)

![msi-keyboard](assets/2.png)

## Install

#### [Node.js](https://nodejs.org/) 6+ is REQUIRED

#### From prebuilt binaries:

Download the latest from the [releases](https://github.com/stevelacy/msi-keyboard-gui/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](SUPPORTED.md)

#### Contributions welcome!
If you find a bug or issue please check the [github issues](https://github.com/stevelacy/msi-keyboard-gui/issues) or open an new one.
Feature requests / pull requests are welcome!

## [License](LICENSE) (MIT)