logiledus/README.md

61 lines
2 KiB
Markdown
Raw Normal View History

2019-10-13 02:11:02 +03:00
# LogiLed
![License](https://img.shields.io/badge/License-GPLv3-blue.svg) [![Releases](https://img.shields.io/github/downloads/developersu/LogiLed/total.svg)]() [![LatestVer](https://img.shields.io/github/release/developersu/LogiLed.svg)]()
[Support author](#support-this-app)
LogiLed is a Logitech G513 Carbon GUI driver for adjusting backlight and effects.
#### License
[GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.html)
#### Used libraries & resources
* [OpenJFX](https://wiki.openjdk.java.net/display/OpenJFX/Main)
* [usb4java](https://mvnrepository.com/artifact/org.usb4java/usb4java)
* Few icons taken from: [materialdesignicons.com](http://materialdesignicons.com/)
* Special thanks to pioneers and superstars who created, contributed and maintaining [g810-led](https://github.com/MatMoul/g810-led) project!
### System requirements
JRE/JDK 8u60 or higher.
### Usage in Linux
1. Install JRE/JDK 8u60 or higher (openJDK is good. Oracle's one is also good). JavaFX not needed (it's embedded).
2019-10-15 04:31:19 +03:00
2. `root # java -jar /path/to/application.jar`
2019-10-13 02:11:02 +03:00
3. Optional. Add user to 'udev' rules to use NS not-from-root-account
```
2019-10-15 04:31:19 +03:00
root # vim /etc/udev/rules.d/99-G513.rules
2019-10-13 02:11:02 +03:00
SUBSYSTEM=="usb", ATTRS{idVendor}=="046D", ATTRS{idProduct}=="c33c", GROUP="plugdev"
root # udevadm control --reload-rules && udevadm trigger
```
### Building
`$ mvn package`
## Support this app
If you like this app, just give a star.
Want to support development? Make a donation* (see below):
[Yandex.Money](https://money.yandex.ru/to/410014301951665)
[PayPal](https://paypal.me/developersu)
*Legal information:
* [EN] Please note! This is non-commercial application. Any received money considered as a gift.
2019-10-17 08:24:32 +03:00
* [RU] Пожалуйста обратите внимание! Это некоммерческое приложение. Перечисляя средства вы совершаете дарение.
#### TODO
2019-10-17 09:39:26 +03:00
* [x] Tray support
* [ ] Configuration files support
* [ ] Settings
* [ ] Headless mode (CLI)
* [ ] Dark theme