aboutsummaryrefslogtreecommitdiff
path: root/README.adoc
blob: 52b8cc88f981296cad67debbbff1c064ceb679ca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
sensei-raw-ctl
==============
:compact-option:

This program makes it possible to change the configuration of your SteelSeries
Sensei Raw mouse from within Linux, *BSD or any other POSIX-compatible system
supported by libusb.

Run `sensei-raw-ctl --help` or `man sensei-raw-ctl` for usage information.

If you don't fancy command line tools, there's also a basic GTK+ frontend
available.  On Ubuntu and its derivatives, you should be able to find it in your
System Settings, though this feature has disappeared completely with newer GNOME
versions.

image::sensei-raw-ctl-gui.png[align="center"]

Supported devices
-----------------
 - SteelSeries Sensei Raw
 - SteelSeries Call of Duty: Black Ops II
 - SteelSeries Guild Wars 2

Packages
--------
Regular releases are sporadic.  git master should be stable enough.
You can get a package with the latest development version using Arch Linux's
https://aur.archlinux.org/packages/sensei-raw-ctl-git[AUR],
or as a https://git.janouch.name/p/nixexprs[Nix derivation].

Installation
------------
Build dependencies: cmake >= 3.0, help2man +
Runtime dependencies: libusb >= 1.0, gtk+ >= 3.0 (optional)

 $ git clone https://git.janouch.name/p/sensei-raw-ctl.git
 $ mkdir sensei-raw-ctl/build
 $ cd sensei-raw-ctl/build
 $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug
 # make install

Note that there's no `make uninstall` and the GUI needs to be installed in the
right location in order to work correctly.

If you don't want the GUI frontend, append `-DBUILD_GUI=NO` to the `cmake`
command.  The GUI also isn't going to be built if you don't have the GTK+ 3
development packages installed, if your distribution has any.

For Debian-based distros, you can do the following instead of the last step:

 $ cpack -G DEB
 # dpkg -i sensei-raw-ctl-*.deb

Contributing and Support
------------------------
Use https://git.janouch.name/p/sensei-raw-ctl to report bugs, request features,
or submit pull requests.  `git send-email` is tolerated.  If you want to discuss
the project, feel free to join me at ircs://irc.janouch.name, channel #dev.

Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9

License
-------
This software is released under the terms of the 0BSD license, the text of which
is included within the package along with the list of authors.