TUF Manager allows control of the keyboard and fans of ASUS TUF laptops using the faustus driver module.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tuf-manager/README.md

85 lines
2.2 KiB

2 years ago
# TUF Manager
## License
2 years ago
2 years ago
[3-Clause BSD License](LICENSE)
2 years ago
## Screenshots
2 years ago
<img src="screenshot/tuf-gui.png" />
2 years ago
2 years ago
<img src="screenshot/tuf-cli.png" />
2 years ago
2 years ago
## Build requirements
2 years ago
2 years ago
To build TUF Manager the following is needed:
- vala
- valadoc
- glib
- gtk3
- gio-unix
- gobject
2 years ago
- dbus
- polkit
- polkit-gobject
- gmodule-export
- libnotify
- libappindicator3
2 years ago
2 years ago
## Other requirements
2 years ago
This software will only work if using the [hackbnw/faustus](https://github.com/hackbnw/faustus) driver module.
2 years ago
2 years ago
## Build options
- valadocs
Build TUF Manager's vala documentation.
2 years ago
2 years ago
- valadocs-deps
Build external valadocs that TUF Manager utilizes and calls.
2 years ago
2 years ago
- build-cli
Build the cli interface.
- build-gui
Build the gui interface.
2 years ago
- build-tray
Build the tray icon
2 years ago
- always-authenticated
Authentication is not required to use the TUF Server that runs in the background as a daemon, if this is set to false polkit is used for authentication. Setting this to false is more secure, but also makes things like auto restore of settings on login impossible to do without a password.
## Usage
2 years ago
There are 3 programs and 1 daemon supplied by TUF Manager.
2 years ago
- tuf-cli
This allows controlling the TUF laptop functions via command line interface.
2 years ago
- tuf-gui
This supplies a graphical interface to control the TUF laptop.
2 years ago
- tuf-server
This is the daemon that runs in the background and handles all requests from both tuf-cli and tuf-gui.
- tuf-tray
This is the tray icon to control the TUF Manager program. It should automatically start in any desktop environment that supports xdg.
2 years ago
## Notes
The restore settings option saves the changes made on a per user basis. This means that for example if a different user logs in and the tray icon is running, it will restore their settings. So for example user A can have a blue keyboard and user B can have a green keyboard. Or even change keyboard colors based on the distro that is booted. For example when in linux mint a green keyboard and when in fedora a blue keyboard.
The other important use of the restore settings options is the fan mode. Normally fan mode does not survive a reboot. It is always set to "balanced" when booted. However now when the user logs in it restores the previous fan mode that was saved.