lig/status-slayer
lig/status-slayer
1
0
Fork 0
Code Issues Pull requests 1 Releases 1 Activity
Status Slayer is a configurable implementation of status command for Sway WM using Swaybar Protocol.
20 commits 2 branches 1 tag 223 KiB
  • Rust 100%
Find a file
Serge Matveenko 7c7eb26eef Expect all interval values to be defined in seconds
2024-12-29 21:06:43 +01:00
src Expect all interval values to be defined in seconds 2024-12-29 21:06:43 +01:00
tests Expect all interval values to be defined in seconds 2024-12-29 21:06:43 +01:00
.gitignore Prepare sway bar protocol stub 2024-12-21 12:45:31 +01:00
Cargo.lock Replace directories lib with dirs which is lighter 2024-12-27 15:26:32 +01:00
Cargo.toml Replace directories lib with dirs which is lighter 2024-12-27 15:26:32 +01:00
LICENSE Add Readme, License and package info 2024-12-26 18:41:34 +01:00
README.md Expect all interval values to be defined in seconds 2024-12-29 21:06:43 +01:00

README.md

Status Slayer

Status Slayer is a configurable implementation of the status command for Sway WM using the Swaybar Protocol. Written in Rust, it provides a fast and highly customizable way to display status information in your Swaybar.

Features

  • Flexible Configuration: Configure commands and intervals using a simple TOML format.
  • Efficient Updates: Sends updates to Swaybar only when a command's output changes, ensuring minimal latency.
  • Custom Intervals: Supports interval-based commands or one-shot execution for static values.

Planned Features

  • Configurable click actions for sections.
  • Color configuration per section.
  • Pango markup support for rich text formatting.
  • Built-in modules (e.g., hostname, date, memory, cpu, network) that eliminate the need for external commands.

Installation

Install using Cargo:

cargo install --locked stlayer

Usage

Add the following to your Sway configuration file (~/.config/sway/config):

status_command stslayer [--config <path to config>]

Replace <path to config> with the path to your configuration file. Default config path is $XDG_CONFIG_HOME/stslayer/config.toml.

Configuration

Status Slayer uses a TOML-based configuration file. Below is an example:

min_interval = 0.1

[[section]]
name = "kernel name"
command = "uname -s"
interval = "oneshot"

[[section]]
name = "date and time"
command = 'date "+%Y-%m-%d %H:%M:%S"'

Configuration Options

  • min_interval: Minimal global status update interval in seconds. Updates won't be sent to Sway more often than that (default: 0.1).
  • name: A label for the section.
  • command: The shell command to execute for the section.
  • interval: The interval in seconds to execute the command (default: 1). Use "oneshot" for commands that run only once.

Minimum value for all intervals is 0.1.

How It Works

  • Each command runs at the defined interval, and the last known output is displayed in the status bar.
  • Status Slayer sends updates to Swaybar immediately whenever a command's output changes.

Contributing

Contributions are welcome! If you find a bug, have a feature request, or want to contribute code, feel free to:

License

This project is licensed under the MIT License. See the LICENSE file for details.

Links