An open API service indexing awesome lists of open source software.

https://github.com/yassine20011/kvitals

A lightweight KDE Plasma 6 panel widget that displays live system vitals directly in your top bar.
https://github.com/yassine20011/kvitals

desktop-widget kde kde-desktop kde-plasma-6 kde-widget plasmoid pulse system-monitoring vitals

Last synced: 3 months ago
JSON representation

A lightweight KDE Plasma 6 panel widget that displays live system vitals directly in your top bar.

Awesome Lists containing this project

README

          

# KVitals

A lightweight KDE Plasma 6 panel widget that displays live system vitals directly in your top bar.

```
CPU: 26% | RAM: 8.8/39.0G | TEMP: 96Β°C | πŸ”‹BAT: 78% | PWR: +20W | NET: ↓82.2K ↑58.9K
```

## Screenshots


Demo



General Settings
Metrics Settings
Icons Settings

## Features

- **Live monitoring** β€” CPU usage, RAM, CPU temperature, GPU metrics (when available), battery status, power draw, network speed
- **Display modes** β€” Text, Icons, or Icons + Text for the panel view
- **Custom icons** β€” Pick any icon from your installed theme for each metric
- **Font customization** β€” Choose any system font and size
- **Configurable** β€” Toggle each metric, adjust refresh rate, organized in 3 settings tabs
- **Minimal footprint** β€” Native KDE KSysGuard sensors + QML, no heavy dependencies or excessive subprocesses
- **Click to expand** β€” Detailed popup view with all stats

## Requirements

- KDE Plasma 6.0+

## Installation

### KDE Store (Recommended)

Install directly from the KDE Store:

πŸ‘‰ **[Get KVitals on the KDE Store](https://www.pling.com/p/2347917/)**

Or from within KDE Plasma:
1. Right-click on the panel β†’ **Add Widgets...**
2. Click **Get New Widgets...** β†’ **Download New Plasma Widgets...**
3. Search for **"KVitals"**
4. Click **Install**

---

### Quick Install (curl)

```bash
curl -fsSL https://github.com/yassine20011/kvitals/releases/latest/download/install-remote.sh | bash
```

### Quick Install (wget)

```bash
wget -qO- https://github.com/yassine20011/kvitals/releases/latest/download/install-remote.sh | bash
```

### Manual Install

```bash
git clone https://github.com/yassine20011/kvitals.git
cd kvitals
bash install.sh
```

Then restart Plasma and add the widget:

```bash
plasmashell --replace &
```

1. Right-click on the panel β†’ **Add Widgets...**
2. Search for **KVitals**
3. Drag it onto your panel

## Configuration

Right-click the widget β†’ **Configure KVitals...** to access settings in three tabs:

- **General** β€” Display mode, icon size, font, update interval
- **Metrics** β€” Toggle CPU, RAM, Temperature, Battery, Power, Network
- **Icons** β€” Customize icons for each metric from your theme

See the [full configuration reference](docs/configuration.md) for details.

## Uninstall

```bash
rm -rf ~/.local/share/plasma/plasmoids/org.kde.plasma.kvitals
```

Then restart Plasma: `plasmashell --replace &`

## Project Structure

```
kvitals/
β”œβ”€β”€ metadata.json # Plasmoid metadata
β”œβ”€β”€ install.sh # Local install script
β”œβ”€β”€ install-remote.sh # Remote install (curl/wget)
β”œβ”€β”€ CHANGELOG.md # Version history
β”œβ”€β”€ docs/ # Documentation
β”‚ β”œβ”€β”€ installation.md
β”‚ β”œβ”€β”€ configuration.md
β”‚ β”œβ”€β”€ architecture.md
β”‚ β”œβ”€β”€ contributing.md
β”‚ └── troubleshooting.md
└── contents/
β”œβ”€β”€ config/
β”‚ β”œβ”€β”€ config.qml # Tab registration
β”‚ └── main.xml # Config schema
└── ui/
β”œβ”€β”€ main.qml # Widget UI
β”œβ”€β”€ configGeneral.qml # General settings tab
β”œβ”€β”€ configMetrics.qml # Metrics settings tab
└── configIcons.qml # Icons settings tab
```

## Documentation

- [Installation](docs/installation.md)
- [Configuration](docs/configuration.md)
- [Architecture](docs/architecture.md)
- [Contributing](docs/contributing.md)
- [Troubleshooting](docs/troubleshooting.md)

## License

By contributing, you agree that your contributions will be licensed under the [GPL-3.0 License](LICENSE).