Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zefr0x/ianny
Desktop utility that helps preventing repetitive strain injuries by keeping track of usage patterns and periodically informing the user to take breaks.
https://github.com/zefr0x/ianny
break desktop eye rsi strain wayland
Last synced: 6 days ago
JSON representation
Desktop utility that helps preventing repetitive strain injuries by keeping track of usage patterns and periodically informing the user to take breaks.
- Host: GitHub
- URL: https://github.com/zefr0x/ianny
- Owner: zefr0x
- License: gpl-3.0
- Created: 2023-06-03T22:40:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-18T13:50:24.000Z (6 months ago)
- Last Synced: 2024-05-18T14:45:43.133Z (6 months ago)
- Topics: break, desktop, eye, rsi, strain, wayland
- Language: Rust
- Homepage:
- Size: 101 KB
- Stars: 72
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hyprland - Ianny
README
Ianny | عَيْنِي
[](https://github.com/zefr0x/ianny/actions/workflows/release.yml)
Simple, light-weight, easy to use, and effective [Linux](https://en.wikipedia.org/wiki/Linux) [Wayland]() desktop utility that helps with preventing [repetitive strain injuries](https://en.wikipedia.org/wiki/Repetitive_strain_injury) by keeping track of usage patterns and periodically informing the user to take breaks.
---
[
Install
](#installation)
[
Contribute
](CONTRIBUTING.md)
[
Packaging
](PACKAGING.md)
---
## Features
- ⚙ Simple config to tweak its behavior.
- 🚀 Auto start it with your desktop environment.
- 🚫 [X11](https://en.wikipedia.org/wiki/X_Window_System) is not supported.
- 🚫 Microsoft Windows is definitely not supported.
## Requirements
- [Wayland Compositor]() that optionally implements [`ext_idle_notifier_v1`](https://wayland.app/protocols/ext-idle-notify-v1)
- [Notification Daemon](https://wiki.archlinux.org/title/Desktop_notifications#Notification_servers) that implements [`org.freedesktop.Notifications`](https://specifications.freedesktop.org/notification-spec/notification-spec-latest.html)
- [libdbus-1.so](https://www.freedesktop.org/wiki/Software/dbus/) installed in your system
- [Linux libc](https://en.wikipedia.org/wiki/C_standard_library) via either [glibc](https://www.gnu.org/software/libc/) or [musl libc](https://musl.libc.org/)
## Installation
[](https://repology.org/project/ianny/versions)
### Arch Linux
All packages are available on AUR, you can:
- build locally from latest stable release: [ianny](https://aur.archlinux.org/packages/ianny)
- build locally from latest Git commit: [ianny-git](https://aur.archlinux.org/packages/ianny-git)
- use the binary built by GitHub: [ianny-bin](https://aur.archlinux.org/packages/ianny-bin)
### Download Binary From GitHub
For every new release a GitHub workflow will build a binary in GitHub servers and will upload it as a release asset in GitHub releases.
You can find the latest GitHub release [here](https://github.com/zefr0x/ianny/releases/latest) or the releases page [here](https://github.com/zefr0x/ianny/releases).
## Build
> [!Note]
> You need to have [`cargo`](https://doc.rust-lang.org/cargo/), [`meson`](https://mesonbuild.com/) and [`libdbus-1-dev`](https://www.freedesktop.org/wiki/Software/dbus/) installed in your system.
```shell
git clone https://github.com/zefr0x/ianny.git
cd ianny
# Checkout to a release tag e.g. v1.0.1
git checkout vx.x.x
meson setup builddir -Dbuildtype=release
meson compile -C builddir
```
You will find the binary in `./builddir/src/ianny`
> [!NOTE]
> For cross compilation you will need to set the `rustc_target` meson option, and create [`.cargo/config.toml`](https://doc.rust-lang.org/cargo/reference/config.html) file to set a `linker` to be used for your target.
To install:
```shell
meson install -C builddir
```
# Usage
You just need to execute the binary eather directly or by enabling it to auto start with your desktop environment's settings, since it provides a `.desktop` file for auto-start.
# Config
The defaults might not fit your needs, so you can change them via a config file.
The config file is `$XDG_CONFIG_HOME/io.github.zefr0x.ianny/config.toml` or by default `~/.config/io.github.zefr0x.ianny/config.toml`. Just create it and specify the options you need with the [toml format](https://toml.io/):
```toml
[timer]
# Timer will stop and reset when you are idle for this amount of seconds.
idle_timeout = 240
# Active duration that activates a break.
short_break_timeout = 1200
long_break_timeout = 3840
# Breaks duration.
short_break_duration = 120
long_break_duration = 240
[notification]
show_progress_bar = true
# Minimum delay of updating the progress bar (lower than 1s may return an error).
minimum_update_delay = 1
```
> [!Note]
> Time specified in seconds
## Q&A
Q: What does `Ianny` mean?
- It is an Arabic word `عَيْنِي` that could be translated to `My Eye` in english.
## Inspired by
- [KDE's RSIBreak](https://userbase.kde.org/RSIBreak)