Name	Name	Last commit message	Last commit date
Latest commit History 25 Commits
.github/workflows	.github/workflows
.idea	.idea
Installer	Installer
VictusService	VictusService
Victushub-gui	Victushub-gui
gradle/wrapper	gradle/wrapper
.gitignore	.gitignore
LICENSE	LICENSE
Readme.md	Readme.md
build.gradle.kts	build.gradle.kts
gradlew	gradlew
gradlew.bat	gradlew.bat
settings.gradle	settings.gradle

VICTUSHUB

Empowering Control. Elevating Performance.

license last-commit repo-top-language repo-language-count

Table of Contents
Overview
Features
Project Structure
- Project Index
Getting Started
Roadmap
Contributing
License
Acknowledgments

Overview

Introducing VictusHub, a comprehensive tool for fan control, keyboard color and backlight management, and EC fan monitoring.

Why VictusHub?

This project empowers developers to streamline system management and optimize performance. The core features include:

🔋 Fan Control: Easily manage fan speeds .
🎨 Keyboard Color/Backlight Management: Customize keyboard backlighting and color settings for optimal performance.
💻 EC Fan Monitoring: Monitor EC fans in real-time, ensuring optimal system performance.

Features

Component	Details
⚙️	Architecture	Uses Gradle as its build tool Written in Kotlin and Java
🔩	Code Quality	Uses controlsfx, dlsc, formsfx, ikonli, junit, jupiter, kordamp, org libraries Has a settings.gradle file for Gradle settings
📄	Documentation	No documentation provided in the codebase
🔌	Integrations	Uses GitHub Actions for CI/CD Has a build.yml file for GitHub Actions workflow
🧩	Modularity	Separates GUI and service components in different modules (VictusHub-gui and VictusService)

Project Structure

└── VictusHub/
 ├── .github
 │ └── workflows
 ├── Installer
 │ ├── icon.png
 │ ├── setup.sh
 │ └── uninstaller.sh
 ├── VictusService
 │ ├── .gitignore
 │ ├── .idea
 │ ├── build.gradle
 │ ├── gradle
 │ ├── gradlew
 │ ├── gradlew.bat
 │ ├── settings.gradle
 │ └── src
 ├── Victushub-gui
 │ ├── .gitignore
 │ ├── .idea
 │ ├── Installer
 │ ├── LICENSE
 │ ├── build.gradle.kts
 │ ├── gradle
 │ ├── gradlew
 │ ├── gradlew.bat
 │ ├── images
 │ ├── qodana.yaml
 │ ├── settings.gradle.kts
 │ └── src
 ├── build
 │ └── reports
 ├── build.gradle.kts
 ├── gradle
 │ └── wrapper
 ├── gradlew
 ├── gradlew.bat
 └── settings.gradle

Project Index

VICTUSHUB/

__root__

⦿ __root__

File Name Summary

settings.gradle - VictusHub is a comprehensive tool that enables fan control, keyboard color and backlight management, and ec fan monitoring
- The provided settings.gradle file serves as the foundation of this project, integrating Victushub-gui and VictusService modules to create a seamless user experience
- By leveraging these components, users can efficiently manage their systems fans, lighting, and cooling systems.

gradlew.bat Https://github.com/Vilez0/hp-wmi-fan-and-backlight-control and this app for fan control and keyboard color and backlight control tool and have service for checking ec fans

build.gradle.kts - Assembles the Victus project by copying native builds from Victushub-gui and VictusService into an Installer directory
- This task depends on the successful compilation of both projects, ensuring a complete and functional installation package is generated.

File Name	Summary
settings.gradle	- VictusHub is a comprehensive tool that enables fan control, keyboard color and backlight management, and ec fan monitoring - The provided settings.gradle file serves as the foundation of this project, integrating Victushub-gui and VictusService modules to create a seamless user experience - By leveraging these components, users can efficiently manage their systems fans, lighting, and cooling systems.
gradlew.bat	Https://github.com/Vilez0/hp-wmi-fan-and-backlight-control and this app for fan control and keyboard color and backlight control tool and have service for checking ec fans
build.gradle.kts	- Assembles the Victus project by copying native builds from Victushub-gui and VictusService into an Installer directory - This task depends on the successful compilation of both projects, ensuring a complete and functional installation package is generated.

Victushub-gui

⦿ Victushub-gui

File Name Summary

settings.gradle.kts - Configures the VictusHub-gui project by defining its name and plugin management settings
- This file establishes the foundation for the projects structure and dependencies, enabling the development of a GUI-based application for fan control, keyboard color and backlight control, and ec fans monitoring.

qodana.yaml Https://github.com/Vilez0/hp-wmi-fan-and-backlight-control

gradlew.bat Https://github.com/Vilez0/hp-wmi-fan-and-backlight-control

build.gradle.kts Https://github.com/Vilez0/hp-wmi-fan-and-backlight-controlThe Victushub-gui codebase provides a comprehensive fan control and keyboard color and backlight control tool, offering services for checking EC fans.

LICENSE - Empowers users to control fan speed, keyboard color, and backlight settings with ease
- This GUI application provides a user-friendly interface to manage system fans, adjust keyboard illumination, and monitor system performance
- With its intuitive design, users can effortlessly customize their computing experience.

Installer

⦿ Victushub-gui.Installer

File Name Summary

uninstaller.sh - Uninstalling VictusHub restores the applications original state by moving its binary back to a safe location, removing sudoers fragments, desktop entries, and icons, and refreshing the desktop cache if necessary
- This script provides a comprehensive solution for fully uninstalling and restoring VictusHub
- Special thanks to Vilez0 for the GUI inspiration.

setup.sh - Https://github.com/Vilez0/hp-wmi-fan-and-backlight-control Summary:Installs and sets up VictusHub, a fan control and keyboard color and backlight control tool with service for checking EC fans
- The installer moves the binary to /usr/local/bin, sets up passwordless sudo, creates a desktop entry with icon, and updates the desktop database.

src

⦿ Victushub-gui.src

main

⦿ Victushub-gui.src.main

java

⦿ Victushub-gui.src.main.java

File Name Summary

module-info.java - Victushub-gui module-info.java defines the architecture of Victushub-gui, a comprehensive tool for fan control and keyboard color/backlight management
- It enables seamless integration with JavaFX, controlsfx, formsfx, ikonli-javafx, logging, and slf4j libraries
- This configuration allows for efficient communication between modules, ensuring a robust and scalable application.

com

⦿ Victushub-gui.src.main.java.com

range

⦿ Victushub-gui.src.main.java.com.range

victusHub

⦿ Victushub-gui.src.main.java.com.range.victusHub

File Name Summary

VictusHub.java - Launches the Victus Hub graphical user interface (GUI) application, providing a centralized hub for controlling and monitoring various system components
- The GUI enables users to manage fan speeds, keyboard backlighting, and other features, offering a convenient and intuitive way to customize their computing experience.

Launcher.java Https://github.com/Vilez0/hp-wmi-fan-and-backlight-control

fan

⦿ Victushub-gui.src.main.java.com.range.victusHub.fan

File Name Summary

FanCounter.java - Detects the number of fans connected to an HP laptop.This file provides a simple way to count the number of fans installed on an HP laptop by scanning the systems hardware monitoring directory and counting the number of fan input files found
- The result is returned as an integer value, allowing for easy integration into larger applications or scripts.

FanAndKeyboardController.java - Control fan speeds and keyboard backlight on HP laptops using this GUI application
- The app detects available fans, displays their current RPM values, and allows users to adjust fan speeds
- Additionally, it controls the keyboard backlights brightness and color
- The application stores its settings in a configuration file for persistence.Special thanks to Vilez0 for the GUI inspiration
- His original app can be found here: https://github.com/Vilez0/hp-wmi-fan-and-backlight-control

resources

⦿ Victushub-gui.src.main.resources

com.range.victusHub

⦿ Victushub-gui.src.main.resources.com.range.victusHub

File Name Summary

style.css Https://github.com/Vilez0/hp-wmi-fan-and-backlight-controlSummary:Configure and control fan speeds, keyboard color, and backlight settings with this intuitive graphical user interface (GUI) tool.

hello-view.fxml - Https://github.com/Vilez0/hp-wmi-fan-and-backlight-control Summary:Configure and control fan speed, keyboard backlight, and color using this intuitive graphical user interface (GUI)
- The Victus Hub application provides a centralized platform to manage system settings, offering real-time status updates and customizable controls for optimal performance.

File Name	Summary
settings.gradle.kts	- Configures the VictusHub-gui project by defining its name and plugin management settings - This file establishes the foundation for the projects structure and dependencies, enabling the development of a GUI-based application for fan control, keyboard color and backlight control, and ec fans monitoring.
qodana.yaml	Https://github.com/Vilez0/hp-wmi-fan-and-backlight-control
gradlew.bat	Https://github.com/Vilez0/hp-wmi-fan-and-backlight-control
build.gradle.kts	Https://github.com/Vilez0/hp-wmi-fan-and-backlight-controlThe Victushub-gui codebase provides a comprehensive fan control and keyboard color and backlight control tool, offering services for checking EC fans.
LICENSE	- Empowers users to control fan speed, keyboard color, and backlight settings with ease - This GUI application provides a user-friendly interface to manage system fans, adjust keyboard illumination, and monitor system performance - With its intuitive design, users can effortlessly customize their computing experience.

File Name	Summary
uninstaller.sh	- Uninstalling VictusHub restores the applications original state by moving its binary back to a safe location, removing sudoers fragments, desktop entries, and icons, and refreshing the desktop cache if necessary - This script provides a comprehensive solution for fully uninstalling and restoring VictusHub - Special thanks to Vilez0 for the GUI inspiration.
setup.sh	- Https://github.com/Vilez0/hp-wmi-fan-and-backlight-control Summary:Installs and sets up VictusHub, a fan control and keyboard color and backlight control tool with service for checking EC fans - The installer moves the binary to /usr/local/bin, sets up passwordless sudo, creates a desktop entry with icon, and updates the desktop database.

File Name	Summary
module-info.java	- Victushub-gui module-info.java defines the architecture of Victushub-gui, a comprehensive tool for fan control and keyboard color/backlight management - It enables seamless integration with JavaFX, controlsfx, formsfx, ikonli-javafx, logging, and slf4j libraries - This configuration allows for efficient communication between modules, ensuring a robust and scalable application.

File Name	Summary
VictusHub.java	- Launches the Victus Hub graphical user interface (GUI) application, providing a centralized hub for controlling and monitoring various system components - The GUI enables users to manage fan speeds, keyboard backlighting, and other features, offering a convenient and intuitive way to customize their computing experience.
Launcher.java	Https://github.com/Vilez0/hp-wmi-fan-and-backlight-control

File Name	Summary
FanCounter.java	- Detects the number of fans connected to an HP laptop.This file provides a simple way to count the number of fans installed on an HP laptop by scanning the systems hardware monitoring directory and counting the number of fan input files found - The result is returned as an integer value, allowing for easy integration into larger applications or scripts.
FanAndKeyboardController.java	- Control fan speeds and keyboard backlight on HP laptops using this GUI application - The app detects available fans, displays their current RPM values, and allows users to adjust fan speeds - Additionally, it controls the keyboard backlights brightness and color - The application stores its settings in a configuration file for persistence.Special thanks to Vilez0 for the GUI inspiration - His original app can be found here: https://github.com/Vilez0/hp-wmi-fan-and-backlight-control

File Name	Summary
style.css	Https://github.com/Vilez0/hp-wmi-fan-and-backlight-controlSummary:Configure and control fan speeds, keyboard color, and backlight settings with this intuitive graphical user interface (GUI) tool.
hello-view.fxml	- Https://github.com/Vilez0/hp-wmi-fan-and-backlight-control Summary:Configure and control fan speed, keyboard backlight, and color using this intuitive graphical user interface (GUI) - The Victus Hub application provides a centralized platform to manage system settings, offering real-time status updates and customizable controls for optimal performance.

VictusService

⦿ VictusService

File Name Summary

settings.gradle - Control fan speed and keyboard color/backlight settings with ease using this VictusService application
- This tool provides a convenient interface to manage fans and lighting on compatible devices, streamlining the process of monitoring and adjusting system components
- With its intuitive design, users can quickly access and customize their devices performance and visual settings.

gradlew.bat Https://github.com/Vilez0/hp-wmi-fan-and-backlight-control

build.gradle - Provides a comprehensive fan control and keyboard color/backlight management tool, offering real-time monitoring of EC fans
- The service enables users to adjust fan speeds and customize keyboard lighting settings, streamlining system performance optimization and enhancing overall user experience.

src

⦿ VictusService.src

main

⦿ VictusService.src.main

java

⦿ VictusService.src.main.java

com

⦿ VictusService.src.main.java.com

range

⦿ VictusService.src.main.java.com.range

File Name Summary

Main.java - Https://github.com/Vilez0/hp-wmi-fan-and-backlight-controlSummary:Configures and controls HP laptop fans, keyboard backlight, and color using a configuration file
- The program reads settings from the file, adjusts fan speeds, sets keyboard light intensity, and changes color based on user-defined values.

CommandRunner.java - Enables asynchronous command execution, allowing users to run shell commands without blocking the main thread
- This feature is particularly useful for controlling system fans and backlights, providing a convenient way to manage system settings.

File Name	Summary
settings.gradle	- Control fan speed and keyboard color/backlight settings with ease using this VictusService application - This tool provides a convenient interface to manage fans and lighting on compatible devices, streamlining the process of monitoring and adjusting system components - With its intuitive design, users can quickly access and customize their devices performance and visual settings.
gradlew.bat	Https://github.com/Vilez0/hp-wmi-fan-and-backlight-control
build.gradle	- Provides a comprehensive fan control and keyboard color/backlight management tool, offering real-time monitoring of EC fans - The service enables users to adjust fan speeds and customize keyboard lighting settings, streamlining system performance optimization and enhancing overall user experience.

File Name	Summary
Main.java	- Https://github.com/Vilez0/hp-wmi-fan-and-backlight-controlSummary:Configures and controls HP laptop fans, keyboard backlight, and color using a configuration file - The program reads settings from the file, adjusts fan speeds, sets keyboard light intensity, and changes color based on user-defined values.
CommandRunner.java	- Enables asynchronous command execution, allowing users to run shell commands without blocking the main thread - This feature is particularly useful for controlling system fans and backlights, providing a convenient way to manage system settings.

Installer

⦿ Installer

File Name Summary

uninstaller.sh - Restores and uninstalls VictusHub by moving GUI and Service binaries back to their original location, cleaning up sudoers and desktop entries, and removing icons
- This script ensures a seamless uninstallation process, returning the applications files to their original directory while also refreshing the desktop cache for optimal performance.

setup.sh - Installs and configures VictusHub, a GUI application and service, on various Linux init systems
- The installer moves binaries, sets up passwordless sudo, creates a desktop entry, and installs the service under systemd, openrc, sysvinit, runit, or dinit.Special thanks to Vilez0 for the GUI inspiration
- His original app can be found here: https://github.com/Vilez0/hp-wmi-fan-and-backlight-control

File Name	Summary
uninstaller.sh	- Restores and uninstalls VictusHub by moving GUI and Service binaries back to their original location, cleaning up sudoers and desktop entries, and removing icons - This script ensures a seamless uninstallation process, returning the applications files to their original directory while also refreshing the desktop cache for optimal performance.
setup.sh	- Installs and configures VictusHub, a GUI application and service, on various Linux init systems - The installer moves binaries, sets up passwordless sudo, creates a desktop entry, and installs the service under systemd, openrc, sysvinit, runit, or dinit.Special thanks to Vilez0 for the GUI inspiration - His original app can be found here: https://github.com/Vilez0/hp-wmi-fan-and-backlight-control

.github

⦿ .github

workflows

⦿ .github.workflows

File Name Summary

build.yml - Https://github.com/Vilez0/hp-wmi-fan-and-backlight-controlSummary:Automates the build and release process of VictusHub, a fan control and keyboard color and backlight control tool with ec fans service
- The workflow builds the jar file using Gradle, installs native dependencies, and creates a zip installer folder
- It also releases the asset to GitHub with a custom name and description.

File Name	Summary
build.yml	- Https://github.com/Vilez0/hp-wmi-fan-and-backlight-controlSummary:Automates the build and release process of VictusHub, a fan control and keyboard color and backlight control tool with ec fans service - The workflow builds the jar file using Gradle, installs native dependencies, and creates a zip installer folder - It also releases the asset to GitHub with a custom name and description.

build

⦿ build

reports

⦿ build.reports

problems

⦿ build.reports.problems

File Name Summary

problems-report.html - Summary: This code provides a GUI-based tool for controlling fans and keyboard backlighting, as well as checking fan speeds
- It offers a user-friendly interface to manage these features, making it easy to adjust settings and monitor performance.Additional Context:* The project structure is not provided in this context. The file path is build/reports/problems/problems-report.html. The file content appears to be an HTML report, but its relevance to the code file is unclear.

File Name	Summary
problems-report.html	- Summary: This code provides a GUI-based tool for controlling fans and keyboard backlighting, as well as checking fan speeds - It offers a user-friendly interface to manage these features, making it easy to adjust settings and monitor performance.Additional Context:* The project structure is not provided in this context. The file path is `build/reports/problems/problems-report.html`. The file content appears to be an HTML report, but its relevance to the code file is unclear.

Getting Started

Prerequisites

This project requires the following dependencies:

Programming Language: Java
Package Manager: Gradle

Installation

Build VictusHub from the source and intsall dependencies:

Clone the repository:

❯ git clone https://github.com/range79/VictusHub/

Navigate to the project directory:
```
❯ cd VictusHub
```
Install the dependencies:
```
❯ gradle victusBuild
```

Usage

Run the project with:

Using gradle:

gradle run

Testing

Victushub uses the {test_framework} test framework. Run the test suite with:

Using gradle:

gradle test

Contributing

💬 Join the Discussions : Share your insights, provide feedback, or ask questions.
🐛 Report Issues : Submit bugs found or log feature requests for the VictusHub project.
💡 Submit Pull Requests : Review open PRs, and submit your own PRs.

Contributing Guidelines

Fork the Repository: Start by forking the project repository to your github account.
Clone Locally: Clone the forked repository to your local machine using a git client.
```
git clone https://github.com/range79/VictusHub/
```
Create a New Branch: Always work on a new branch, giving it a descriptive name.
```
git checkout -b new-feature-x
```
Make Your Changes: Develop and test your changes locally.
Commit Your Changes: Commit with a clear message describing your updates.
```
git commit -m 'Implemented new feature x.'
```
Push to github: Push the changes to your forked repository.
```
git push origin new-feature-x
```
Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

License

Victushub is protected under the MIT License. For more details, refer to the LICENSE file.

Acknowledgments

Credit contributors, inspiration, references, etc.

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

License

Uh oh!

range79/VictusHub

Folders and files

Latest commit

History

Repository files navigation

VICTUSHUB

Table of Contents

Overview

Features

Project Structure

Project Index

Getting Started

Prerequisites

Installation

Usage

Testing

Contributing

License

Acknowledgments

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 3

Packages

Languages

License

range79/VictusHub

Folders and files

Latest commit

History

Repository files navigation

VICTUSHUB

Table of Contents

Overview

Features

Project Structure

Project Index

Getting Started

Prerequisites

Installation

Usage

Testing

Contributing

License

Acknowledgments

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 3

Packages 0

Languages

Packages