balsoft/simple-osd-daemons

Fork 0

A collection of simple yet configurable OSD daemons that use Freedesktop notifications to display various information about your system

Go to file

Alexander Bantyev 625e2355b9 Fix warnings in battery		2020-09-16 22:02:56 +03:00
assets	Add an example screenshot	2020-09-15 21:19:27 +03:00
battery	Fix warnings in battery	2020-09-16 22:02:56 +03:00
bluetooth	Licensing	2020-09-14 01:35:24 +03:00
brightness	Fix brightness	2020-09-14 13:41:02 +03:00
common	Explicitly ignore results to remove warnings	2020-09-16 21:55:18 +03:00
pulseaudio	Get rid of unneeded unsafe	2020-09-16 16:16:45 +03:00
.gitignore	Implement some daemons	2020-09-14 01:18:33 +03:00
Cargo.lock	Implement some daemons	2020-09-14 01:18:33 +03:00
Cargo.nix	Implement some daemons	2020-09-14 01:18:33 +03:00
Cargo.toml	Implement some daemons	2020-09-14 01:18:33 +03:00
default.nix	Implement some daemons	2020-09-14 01:18:33 +03:00
flake.lock	Implement some daemons	2020-09-14 01:18:33 +03:00
flake.nix	Licensing	2020-09-14 01:35:24 +03:00
LICENSE	Licensing	2020-09-14 01:35:24 +03:00
README.md	Add an example screenshot	2020-09-15 21:19:27 +03:00
shell.nix	Implement some daemons	2020-09-14 01:18:33 +03:00

README.md

Simple OSD daemons

A collection of simple yet configurable OSD daemons that use Freedesktop notifications to display various information about your system.

Example screenshot

Taken with mako as a notification daemon and IBM Plex font.

Installation

Nix

These commands will allow you to try the daemons without installing anything globally; Likely, you want to somehow install this on your system after this. How you do it depends on your setup and preferences.

nix shell git+https://code.balsoft.ru/balsoft/simple-osd-daemons to get all daemons. Add #$DAEMON to only get $DAEMON. If you don't use nix 3 yet, try nix-shell https://code.balsoft.ru/balsoft/simple-osd-daemons/archive/master.tar.gz -A defaultPackage.x86_64-linux

Cargo

cargo build

You can also build individual daemons with cargo build --bin simple-osd-$DAEMON .

Usage

Run the daemons you need. At this moment, none of them accept any arguments.

Configuration

simple-osd-daemons follows XDG Basedir specification: configuration will be written to $XDG_CONFIG_HOME/simple-osd/, typically ~/.config/simple-osd/. Each daemon has a separate configuration file in INI format, and there is also a common configuration file. On startup, the daemons will create their configuration files and populate them with default values if they don't exist.

FIXME

Generate Cargo.nix on the fly
Bluetooth daemon doesn't actually work, since blurz doesn't allow to get the list of connected devices
Need to figure out icons

License

This is free and unencumbered software released into the public domain.

If you want to read more, see LICENSE

Contributing

If you have any issues or suggestions, shoot an email at issues@balsoft.ru with [simple-osd] in subj, or open an issue on GitHub

If you have some concrete changes and would like to share them, submit them with git send-email or git request-pull to patches@balsoft.ru with simple-osd in subj or open a pull request. Please note that your work will become public domain too if you do this.