Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,30 @@ The installer handles dependency install, user/group creation, DKMS module regis
- Keyboard tab exposes RGB colour + brightness controls.
- Backend status: `systemctl status victus-backend.service` (logs via `journalctl -u victus-backend`).

## GNOME Shell Extension

A GNOME Shell extension is available for quick access to fan and keyboard controls from the top panel.

### Features
- πŸŒ€ **Fan Mode Control**: Switch between AUTO, Better Auto, MANUAL, and MAX
- πŸ“Š **Manual Fan Speed**: Per-fan sliders with 8 RPM steps (visible in MANUAL mode)
- ⌨️ **Keyboard RGB**: 10 color presets and brightness slider
- 🌑️ **Live Status**: Real-time CPU temperature and fan RPM display

### Installation
```bash
cd gnome-extension
chmod +x install.sh
./install.sh
gnome-extensions enable victus-control@victus
```

### Requirements
- GNOME Shell 45 or later
- `victus-backend.service` must be running

See [gnome-extension/README.md](gnome-extension/README.md) for detailed documentation.

## Developing
```bash
meson setup build --prefix=/usr
Expand Down
64 changes: 64 additions & 0 deletions gnome-extension/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Victus Control GNOME Shell Extension

A GNOME Shell extension for controlling HP Victus laptop fans and keyboard RGB lighting directly from the top panel.

## Features

- **Fan Mode Control**: Switch between AUTO, Better Auto, MANUAL, and MAX modes
- **Manual Fan Speed**: Per-fan speed control with 8 RPM steps (when in MANUAL mode)
- **Keyboard RGB**: Color presets and brightness control
- **Live Status**: Real-time CPU temperature and fan RPM display

## Requirements

- **victus-control backend**: This extension requires the `victus-backend.service` to be running
- **GNOME Shell**: Version 45 or later
- **HP Victus Laptop**: The patched hp-wmi driver must be installed

## Installation

1. Ensure victus-control is installed and the backend service is running:
```bash
sudo systemctl status victus-backend.service
```

2. Install the extension:
```bash
cd gnome-extension
./install.sh
```

3. Enable the extension:
```bash
gnome-extensions enable victus-control@victus
```

Or use the GNOME Extensions app.

## Usage

Click on the fan icon (πŸŒ€) in the top panel to access:

- **Fan Mode**: Select operating mode from the dropdown
- **Fan Speed Sliders**: Adjust individual fan speeds (visible in MANUAL mode only)
- **Keyboard RGB**: Choose color presets and adjust brightness
- **Status**: View current CPU temperature and fan RPM

## Development

To test changes without restarting GNOME Shell:
1. Save your changes
2. Disable and re-enable the extension:
```bash
gnome-extensions disable victus-control@victus
gnome-extensions enable victus-control@victus
```

View extension logs:
```bash
journalctl -f -o cat /usr/bin/gnome-shell | grep -i victus
Copy link

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The suggested log command pipes journalctl into grep, but without grep --line-buffered the output may be delayed due to buffering when following (-f). Consider adding --line-buffered (or using SYSTEMD_LOG_LEVEL=debug gnome-shell workflows) so logs appear in real time.

Suggested change
journalctl -f -o cat /usr/bin/gnome-shell | grep -i victus
journalctl -f -o cat /usr/bin/gnome-shell | grep --line-buffered -i victus

Copilot uses AI. Check for mistakes.
```

## License

GPLv3 - See the main [LICENSE](../LICENSE) file.
Loading