summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristopher Warner <cwarner@kernelcode.com>2026-01-24 20:38:57 -0500
committerChristopher Warner <cwarner@kernelcode.com>2026-01-24 20:38:57 -0500
commit2b20f2b5b02542a178e137622247e3563143b907 (patch)
tree9c93f328c23aa49947ef89fc57a04e10ff2fe17b /README.md
downloadaerial-screensaver-linux-2b20f2b5b02542a178e137622247e3563143b907.tar.gz
aerial-screensaver-linux-2b20f2b5b02542a178e137622247e3563143b907.tar.bz2
aerial-screensaver-linux-2b20f2b5b02542a178e137622247e3563143b907.tar.xz
aerial-screensaver-linux-2b20f2b5b02542a178e137622247e3563143b907.zip
Initial commit: High-performance screensaver for Framework 16
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fc71976
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Aerial Screensaver for Linux
+
+A high-performance, power-efficient Apple Aerial screensaver implementation for Linux, optimized for the Framework 16 and AMD graphics.
+
+## Features
+- **Power Efficient**: Only runs when connected to AC power.
+- **Low Impact**: Runs with `nice 19` priority and `idle` scheduling.
+- **Hardware Accelerated**: Uses VA-API on the Integrated GPU to keep the Discrete GPU asleep.
+- **Smooth Playback**: Optimized for local 4K HEVC files with frame-dropping logic for 60Hz displays.
+- **Systemd Integration**: Runs as a background user service.
+
+## Requirements
+- `mpv`
+- `python3`
+- `python3-gobject` (for GNOME IdleMonitor access)
+- `systemd`
+
+## Installation
+1. Place your Aerial videos in `~/Videos/Screensavers/Aerial`.
+2. Copy `aerial-screensaver.py` to `~/.local/bin/aerial-screensaver`.
+3. Copy `aerial-screensaver.service` to `~/.config/systemd/user/`.
+4. Enable the service:
+ ```bash
+ systemctl --user daemon-reload
+ systemctl --user enable --now aerial-screensaver
+ ```