Skip to content

Commit

Permalink
readme cleanup.
Browse files Browse the repository at this point in the history
  • Loading branch information
tulth committed Mar 8, 2015
1 parent c787694 commit 9a0cb5e
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,20 @@ A json byte format (--bytes) is also available, which is more portable
between versions of this tool.

For example, to copy the current mouse configuration to a file called mouse_config.json:
```
$ sudo ./g600prog.py MOUSE mouse_config.json
```

Copying a custom_config.json file to the mouse:
```
$ sudo ./g600prog.py custom_config.json MOUSE
```

Leaving off the second argument causes it to print to stdout.
So, to print your current mouse config:
```
$ sudo ./g600prog.py MOUSE
```

## Modes and gshift

Expand All @@ -39,6 +45,7 @@ it will override the second two bytes and they will not be used.


### Mouse Buttons Codes
```
| Byte | Name |
|------+--------------|
| 0x00 | NO_MOUSEBUT |
Expand All @@ -56,8 +63,10 @@ it will override the second two bytes and they will not be used.
| 0x15 | DPI_SHIFT |
| 0x16 | DPI_DEFAULT |
| 0x17 | GSHIFT |
```

### Keyboard Modifier Codes (left-alt, right-shift, etc)
```
| Bit set | Name |
|---------+--------|
| 0 | LCTRL |
Expand All @@ -68,8 +77,10 @@ it will override the second two bytes and they will not be used.
| 5 | RSHIFT |
| 6 | RALT |
| 7 | RGUI |
```

### Keyboard Scan Codes
```
| Byte | Name |
|------+----------------|
| 0x00 | NOKEY |
Expand Down Expand Up @@ -237,13 +248,15 @@ it will override the second two bytes and they will not be used.
| 0xA2 | CLEAR_AGAIN |
| 0xA3 | CRSEL |
| 0xA4 | EXSEL |
```

## Lighting
The lighting section is fairly self explanitory.
Lighting Effect uses the following definiton table:
```
| Byte | Name |
|------+-----------|
| 0x00 | NO_EFFECT |
| 0x01 | PULSE |
| 0x02 | RAINBOW |

```

0 comments on commit 9a0cb5e

Please sign in to comment.