Skip to content

Updated the README.md #19

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

Closed
masakk1 wants to merge 1 commit into from
Closed

Updated the README.md #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
78 changes: 59 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
gloriousctl
===========
# gloriousctl

A utility to adjust the settings of Model O/D mice on Linux/BSD, but it probably
works for other Sinowealth-made mice as well.

[libratbag](https://github.com/libratbag), which has a GUI
for configuration, has a driver based on further development of this code.
## Man page

[libratbag](https://github.com/libratbag), which has a GUI for configuration,
has a driver based on further development of this code.

Usage:
gloriousctl --help
Expand Down Expand Up @@ -39,22 +40,61 @@ for configuration, has a driver based on further development of this code.
- Glorious Model D (VID 258a PID 0033)
- Glorious Model O/O- (VID 258a PID 0036) (untested)

Build requirements
------------------
# Building

## Requirements

The requirements are: a C compiler and libhidapi-hidraw. The libusb-based HIDAPI
backend should technically work, but it requires exclusive control over the USB
device, which is impractical for a mouse.

Here are some examples for different distros:

### Debian/Ubuntu (apt)

```bash
sudo apt install libhidapi-dev
```

### Fedora (dnf)

```bash
sudo dnf install hidapi-devel
```

### Arch (pacman)

```bash
sudo pacman -S hidapi
```

## Compiling

After installing the requirements you can clone the repo and run `make` to
compile gloriousctl and use it.

```basg
git clone https://github.com/enkore/gloriousctl
cd gloriousctl
make
```

Now make sure you are in the `gloriousctl`, then run:

```bash
./gloriousctl
```

C compiler and libhidapi-hidraw. The libusb-based HIDAPI backend
should technically work, but it requires exclusive control over the
USB device, which is impractical for a mouse.
That'll give you a list of available settings, or you can check the
[man page](#man-page) instead.

Caveats
-------
# Caveats

Possibly works with minor alterations with the wealth of sinowealth mice,
since they all seem to use the exact same Windows utility to
configure them (except a config file telling it which VID/PID
to look for and what options exist).
Possibly works with minor alterations with the wealth of sinowealth mice, since
they all seem to use the exact same Windows utility to configure them (except a
config file telling it which VID/PID to look for and what options exist).

Since this is not the official OEM/ODM (sinowealth would be an
interesting case study...) software, and this appears to modify the
EEPROM/flash of the controller in your mouse, there is a chance that
using this in some way could brick your mouse.
Since this is not the official OEM/ODM (sinowealth would be an interesting case
study...) software, and this appears to modify the EEPROM/flash of the
controller in your mouse, there is a chance that using this in some way could
brick your mouse.