Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Notes about usage on Linux #162

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Notes about usage on Linux #162

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
58122c9
Notes about usage on Linux
konsumer Jul 28, 2021
6f6d6cc
separate compilation note
konsumer Jul 28, 2021
77573e6
Use blockquote instead of italic Note
konsumer Jul 28, 2021
5c2e7f1
remove wayward underscores
konsumer Jul 28, 2021
16ba099
rules file needs an "s"
konsumer Jul 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 29 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,33 @@ It runs on Windows, Mac, and Linux.

## Usage

_Note: This is a CLI program, but see below for GUI. It's advisable to use the official software if you're on Windows / Mac._
> This is a CLI program, but see below for GUI. It's advisable to use the official software if you're on Windows / Mac.

_Note: On Linux you will need to run it as super user [(issue with hidraw?)](https://github.com/pixeltris/GK6X/issues/3). It can be compiled / ran with mono on Linux / Mac ([see #4](https://github.com/pixeltris/GK6X/issues/4)). On Windows you compile it with Visual Studio._
### Compilation

It can be compiled / ran with mono on Linux / Mac ([see #4](https://github.com/pixeltris/GK6X/issues/4)). On Windows you compile it with Visual Studio.

### Linux

On Linux you will need to run it as super-user (with `sudo`) or udev can be used to give yourself permissions to the raw-hid device. See [(issue with hidraw?)](https://github.com/pixeltris/GK6X/issues/3).

I made a udev rule file that looks like this, in `/etc/udev/rules.d/gk6x.rules`:

```
SUBSYSTEM=="input", GROUP="input", MODE="0666"
SUBSYSTEM=="usb", ATTRS{idVendor}=="1ea7", ATTRS{idProduct}=="0907", MODE:="666", GROUP="plugdev"
KERNEL=="hidraw*", ATTRS{idVendor}=="1ea7", ATTRS{idProduct}=="0907", MODE="0666", GROUP="plugdev"
```

I added myself to `plugdev` (then rebooted):

```sh
sudo adduser $(whoami) plugdev
```

You will need to reboot to make the udev rules & group take effect.

### General

When you open the program it will connect to your keyboard (there's no console output until it finds something to connect to).

Expand All @@ -18,13 +42,13 @@ You can reprogram the base layer and layers 1-3 (and the Fn keys). The 'driver'

![Alt text](https://raw.githubusercontent.com/pixeltris/GK6X/master/Screenshot.png)

## Usage (Web GUI)
### Web GUI

There's some very basic (and mostly untested) support for a web GUI by using the official software's web component. Use the 'gui' command to start the web server (it should automatically open the web page at http://127.0.0.1:6464).

_Note: This repo doesn't contain the web files. Copy and paste the official software's folder into the "Build" folder, or use the pre-bundled version on the [releases](https://github.com/pixeltris/GK6X/releases) page._
> This repo doesn't contain the web files. Copy and paste the official software's folder into the "Build" folder, or use the pre-bundled version on the [releases](https://github.com/pixeltris/GK6X/releases) page.

_Note: The GUI isn't capable of remapping keys on the base layer. Changes to the JavaScript would be required to get this working_
> The GUI isn't capable of remapping keys on the base layer. Changes to the JavaScript would be required to get this working

![Alt text](https://raw.githubusercontent.com/pixeltris/GK6X/master/ScreenshotWeb.png)

Expand Down