From 5db4a40195eee1c8c45ba318d0c5ce307db08bd3 Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Sun, 13 Sep 2026 12:11:00 +0200 Subject: [PATCH 01/36] Loosen the offline Node pin so mise up tracks new releases Offline installs unpack the bundled tarball and pin Node to its exact version, since latest can't be resolved without network. But nothing ever loosened that pin, so Node stayed frozen at the ISO's version and mup skipped it forever, while online installs tracked latest. Rewrite the pin to latest right after registering the bundled version: mise resolves latest to the installed version while offline (verified with no network and an empty cache), and the first mise up with network picks up new releases just like an online install. Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_017LseZ1jcLaFBnndRnW4yb5 --- install/user/mise-work.sh | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/install/user/mise-work.sh b/install/user/mise-work.sh index f77d5561..7490979f 100644 --- a/install/user/mise-work.sh +++ b/install/user/mise-work.sh @@ -37,6 +37,11 @@ if [[ -n $NODE_PACKAGE_DIR ]]; then mkdir -p "$NODE_INSTALL_DIR" tar -xzf "$NODE_TARBALL" --strip-components=1 -C "$NODE_INSTALL_DIR" mise use -g node@"$NODE_VERSION" + + # That pinned the exact bundled version, which would exempt Node from + # mise up forever. Loosen it to latest, like an online install gets: + # mise resolves latest to the installed version while offline. + mise config set tools.node latest --file "$HOME/.config/mise/config.toml" fi else mise use -g node@latest From 181ad4b4d399feb7f797fa941150d3c65866a496 Mon Sep 17 00:00:00 2001 From: nunomaduro Date: Wed, 16 Sep 2026 16:56:47 +0100 Subject: [PATCH 02/36] feat: improves php and laravel installation --- bin/omarchy-install-dev-env | 36 +++++------------------------- bin/omarchy-remove-dev-env | 7 +++++- default/omarchy/omarchy-menu.jsonc | 8 +++---- 3 files changed, 15 insertions(+), 36 deletions(-) diff --git a/bin/omarchy-install-dev-env b/bin/omarchy-install-dev-env index 263fd755..5dcd819a 100755 --- a/bin/omarchy-install-dev-env +++ b/bin/omarchy-install-dev-env @@ -12,37 +12,11 @@ if [[ -z $1 ]]; then fi install_php() { - omarchy-pkg-add php composer php-sqlite xdebug + mise tool-alias set php github:nunomaduro/static-php-builds + mise use --global php@latest - # Install Path for Composer - if [[ :$PATH: != *:$HOME/.config/composer/vendor/bin:* ]]; then - echo 'export PATH="$HOME/.config/composer/vendor/bin:$PATH"' >>"$HOME/.bashrc" - source "$HOME/.bashrc" - echo "Added Composer global bin directory to PATH." - else - echo "Composer global bin directory already in PATH." - fi - - # Enable some extensions - local php_ini_path="/etc/php/php.ini" - local extensions_to_enable=( - "bcmath" - "intl" - "iconv" - "openssl" - "pdo_sqlite" - "pdo_mysql" - ) - - # Enable Xdebug - sudo sed -i \ - -e 's/^;zend_extension=xdebug.so/zend_extension=xdebug.so/' \ - -e 's/^;xdebug.mode=debug/xdebug.mode=debug/' \ - /etc/php/conf.d/xdebug.ini - - for ext in "${extensions_to_enable[@]}"; do - sudo sed -i "s/^;extension=${ext}/extension=${ext}/" "$php_ini_path" - done + # Composer's global binaries go to ~/.local/bin, which is already on PATH + mise x php -- composer global config bin-dir "$HOME/.local/bin" } install_node() { @@ -84,7 +58,7 @@ laravel) echo -e "Installing PHP and Laravel...\n" install_php install_node - composer global require laravel/installer + mise x php -- composer global require laravel/installer echo -e "\nYou can now run: laravel new myproject" ;; symfony) diff --git a/bin/omarchy-remove-dev-env b/bin/omarchy-remove-dev-env index a24e7f9e..b586ed09 100755 --- a/bin/omarchy-remove-dev-env +++ b/bin/omarchy-remove-dev-env @@ -10,6 +10,11 @@ if [[ -z $1 ]]; then fi remove_php() { + mise uninstall php --all + mise rm -g php + mise tool-alias unset php + + # PHP from before it moved to mise omarchy-pkg-drop php composer php-sqlite xdebug } @@ -46,7 +51,7 @@ php) ;; laravel) echo -e "Removing Laravel...\n" - composer global remove laravel/installer 2>/dev/null || true + mise x php -- composer global remove laravel/installer 2>/dev/null || true ;; symfony) echo -e "Removing Symfony CLI...\n" diff --git a/default/omarchy/omarchy-menu.jsonc b/default/omarchy/omarchy-menu.jsonc index 7583d8d8..2ee24576 100644 --- a/default/omarchy/omarchy-menu.jsonc +++ b/default/omarchy/omarchy-menu.jsonc @@ -277,8 +277,8 @@ "install.development.javascript.node": {"icon":"","label":"Node.js","disabled":"[[ -d $HOME/.local/share/mise/installs/node ]]","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-install-dev-env node'"}, "install.development.javascript.bun": {"icon":"","label":"Bun","disabled":"[[ -d $HOME/.local/share/mise/installs/bun ]]","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-install-dev-env bun'"}, "install.development.javascript.deno": {"icon":"","label":"Deno","disabled":"[[ -d $HOME/.local/share/mise/installs/deno ]]","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-install-dev-env deno'"}, - "install.development.php.php": {"icon":"","label":"PHP","disabled":"omarchy-pkg-present php","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-install-dev-env php'"}, - "install.development.php.laravel": {"icon":"","label":"Laravel","disabled":"[[ -x $HOME/.config/composer/vendor/bin/laravel ]]","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-install-dev-env laravel'"}, + "install.development.php.php": {"icon":"","label":"PHP","disabled":"[[ -d $HOME/.local/share/mise/installs/php ]]","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-install-dev-env php'"}, + "install.development.php.laravel": {"icon":"","label":"Laravel","disabled":"[[ -x $HOME/.local/bin/laravel ]]","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-install-dev-env laravel'"}, "install.development.php.symfony": {"icon":"","label":"Symfony","disabled":"omarchy-pkg-present symfony-cli","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-install-dev-env symfony'"}, "install.development.elixir.elixir": {"icon":"","label":"Elixir","disabled":"[[ -d $HOME/.local/share/mise/installs/elixir ]]","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-install-dev-env elixir'"}, "install.development.elixir.phoenix": {"icon":"","label":"Phoenix","disabled":"compgen -G \"$HOME/.mix/archives/phx_new*\"","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-install-dev-env phoenix'"}, @@ -343,8 +343,8 @@ "remove.development.javascript.node": {"icon":"","label":"Node.js","when":"[[ -d $HOME/.local/share/mise/installs/node ]]","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-remove-dev-env node'"}, "remove.development.javascript.bun": {"icon":"","label":"Bun","when":"[[ -d $HOME/.local/share/mise/installs/bun ]]","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-remove-dev-env bun'"}, "remove.development.javascript.deno": {"icon":"","label":"Deno","when":"[[ -d $HOME/.local/share/mise/installs/deno ]]","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-remove-dev-env deno'"}, - "remove.development.php.php": {"icon":"","label":"PHP","when":"omarchy-pkg-present php","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-remove-dev-env php'"}, - "remove.development.php.laravel": {"icon":"","label":"Laravel","when":"[[ -x $HOME/.config/composer/vendor/bin/laravel ]]","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-remove-dev-env laravel'"}, + "remove.development.php.php": {"icon":"","label":"PHP","when":"[[ -d $HOME/.local/share/mise/installs/php ]] || omarchy-pkg-present php","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-remove-dev-env php'"}, + "remove.development.php.laravel": {"icon":"","label":"Laravel","when":"[[ -x $HOME/.local/bin/laravel || -x $HOME/.config/composer/vendor/bin/laravel ]]","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-remove-dev-env laravel'"}, "remove.development.php.symfony": {"icon":"","label":"Symfony","when":"omarchy-pkg-present symfony-cli","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-remove-dev-env symfony'"}, "remove.development.elixir.elixir": {"icon":"","label":"Elixir","when":"[[ -d $HOME/.local/share/mise/installs/elixir ]]","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-remove-dev-env elixir'"}, "remove.development.elixir.phoenix": {"icon":"","label":"Phoenix","when":"[[ -d $HOME/.local/share/mise/installs/elixir ]]","action":"omarchy-launch-floating-terminal-with-presentation 'omarchy-remove-dev-env phoenix'"}, From 456af5cc8899b1a67219f9bd7489746441f78daf Mon Sep 17 00:00:00 2001 From: nunomaduro Date: Wed, 16 Sep 2026 17:44:30 +0100 Subject: [PATCH 03/36] chore: removes useless comment --- bin/omarchy-install-dev-env | 1 - 1 file changed, 1 deletion(-) diff --git a/bin/omarchy-install-dev-env b/bin/omarchy-install-dev-env index 5dcd819a..03577198 100755 --- a/bin/omarchy-install-dev-env +++ b/bin/omarchy-install-dev-env @@ -15,7 +15,6 @@ install_php() { mise tool-alias set php github:nunomaduro/static-php-builds mise use --global php@latest - # Composer's global binaries go to ~/.local/bin, which is already on PATH mise x php -- composer global config bin-dir "$HOME/.local/bin" } From 486e1cab9b98c9064522741d7bc878f6c93c9497 Mon Sep 17 00:00:00 2001 From: nunomaduro Date: Wed, 16 Sep 2026 20:35:34 +0100 Subject: [PATCH 04/36] fix: removes the laravel binary even when php is already gone Co-Authored-By: Claude Fable 5.1 --- bin/omarchy-remove-dev-env | 3 +++ 1 file changed, 3 insertions(+) diff --git a/bin/omarchy-remove-dev-env b/bin/omarchy-remove-dev-env index b586ed09..46bc8459 100755 --- a/bin/omarchy-remove-dev-env +++ b/bin/omarchy-remove-dev-env @@ -52,6 +52,9 @@ php) laravel) echo -e "Removing Laravel...\n" mise x php -- composer global remove laravel/installer 2>/dev/null || true + + # Composer cannot run once PHP is gone, so drop the installer binary directly (new and old bin-dir) + rm -f "$HOME/.local/bin/laravel" "$HOME/.config/composer/vendor/bin/laravel" ;; symfony) echo -e "Removing Symfony CLI...\n" From 85da80dd7c280e99ef333bb2804fe4a7a6c91c7e Mon Sep 17 00:00:00 2001 From: nunomaduro Date: Wed, 16 Sep 2026 20:46:40 +0100 Subject: [PATCH 05/36] chore: removes comment --- bin/omarchy-remove-dev-env | 1 - 1 file changed, 1 deletion(-) diff --git a/bin/omarchy-remove-dev-env b/bin/omarchy-remove-dev-env index 46bc8459..1be245b7 100755 --- a/bin/omarchy-remove-dev-env +++ b/bin/omarchy-remove-dev-env @@ -53,7 +53,6 @@ laravel) echo -e "Removing Laravel...\n" mise x php -- composer global remove laravel/installer 2>/dev/null || true - # Composer cannot run once PHP is gone, so drop the installer binary directly (new and old bin-dir) rm -f "$HOME/.local/bin/laravel" "$HOME/.config/composer/vendor/bin/laravel" ;; symfony) From 531c3e890ff0b3c062fa046c8115f72a9122bf09 Mon Sep 17 00:00:00 2001 From: Spencer Bull Date: Wed, 16 Sep 2026 13:09:54 -0500 Subject: [PATCH 06/36] Install Elsewhen, the world clock plugin, by default Elsewhen (omacom.elsewhen) arrives as the elsewhen package under /usr/share/omarchy/plugins, the packaged root the shell scans between its bundled plugins and the user's. It opens the right section of the default bar, just before the tray, and a migration installs the package, writes the widget into a customized shell.json in the same spot, and retires a pristine pre-package clone of the upstream repo that the package now shadows. --- config/omarchy/shell.json | 3 + default/agents/skills/omarchy/plugins.md | 5 + docs/file-layout.md | 3 + docs/omarchy-shell.md | 13 + install/omarchy-base.packages | 1 + migrations/1789581661.sh | 85 ++++++ shell/README.md | 14 + shell/plugins/README.md | 6 +- test/shell.d/config-test.sh | 5 +- .../elsewhen-default-migration-test.sh | 285 ++++++++++++++++++ 10 files changed, 417 insertions(+), 3 deletions(-) create mode 100644 migrations/1789581661.sh create mode 100644 test/shell.d/elsewhen-default-migration-test.sh diff --git a/config/omarchy/shell.json b/config/omarchy/shell.json index e6202da8..64cc4075 100644 --- a/config/omarchy/shell.json +++ b/config/omarchy/shell.json @@ -38,6 +38,9 @@ } ], "right": [ + { + "id": "omacom.elsewhen" + }, { "id": "omarchy.tray" }, diff --git a/default/agents/skills/omarchy/plugins.md b/default/agents/skills/omarchy/plugins.md index 6e3ab069..bf1033b3 100644 --- a/default/agents/skills/omarchy/plugins.md +++ b/default/agents/skills/omarchy/plugins.md @@ -9,9 +9,14 @@ inside a single long-running Quickshell process (`omarchy-shell`). ``` ~/.config/omarchy/shell.json # User overrides: bar, plugins, idle ~/.config/omarchy/plugins// # User-owned shell plugins +/usr/share/omarchy/plugins// # Packaged plugins (pacman), e.g. omacom.elsewhen $OMARCHY_PATH/config/omarchy/shell.json # Canonical defaults ``` +Packaged plugins such as Elsewhen (`elsewhen` package) update with `omarchy update` and are removed with pacman; +`omarchy plugin update` and `omarchy plugin remove` refuse them and name the +package. + The shell hot-reloads `shell.json` on save — no restart needed for layout changes. `idle.screensaver` and `idle.lock` are seconds since user idle began. diff --git a/docs/file-layout.md b/docs/file-layout.md index f261085f..8bbcd5b2 100644 --- a/docs/file-layout.md +++ b/docs/file-layout.md @@ -78,6 +78,9 @@ install/** ──► omarchy /usr/share/omarchy migrations/** ──► omarchy /usr/share/omarchy/migrations/ themes/** ──► omarchy /usr/share/omarchy/themes/ shell/** ──► omarchy /usr/share/omarchy/shell/ + (packaged plugins from their own + packages, e.g. elsewhen, land beside it + in /usr/share/omarchy/plugins//) version ──► omarchy /usr/share/omarchy/version + /etc/skel/.local/state/omarchy/migrations/* diff --git a/docs/omarchy-shell.md b/docs/omarchy-shell.md index d62ff743..18a61896 100644 --- a/docs/omarchy-shell.md +++ b/docs/omarchy-shell.md @@ -88,6 +88,19 @@ bar from the CLI — `use | reset | defaults | position | transparent | put | move | set`, with placement flags such as `--section` and `--index`. The lower-level IPC methods remain available through `omarchy-shell shell ...`. +## Packaged plugins + +A default plugin can ship as its own Arch package instead of in the Omarchy +checkout: Elsewhen (`omacom.elsewhen`) is the `elsewhen` package. pacman installs them at +`/usr/share/omarchy/plugins//`, a root the shell scans between +`$OMARCHY_PATH/shell/plugins` and `~/.config/omarchy/plugins`. A packaged +`omarchy.*` id is trusted like a bundled plugin and loads by default; any other +packaged id behaves like an installed plugin. Precedence is bundled, then +packaged, then user, so a checkout under `omarchy dev link` overrides the +package. Packaged plugins update through `omarchy update` and leave through +pacman; `omarchy plugin update` and `omarchy plugin remove` refuse them and +name the package, and Setup › Plugins › Remove does not list them. + ## IPC The shell exposes a `shell` target (the host also registers diff --git a/install/omarchy-base.packages b/install/omarchy-base.packages index 76e74110..0a8e27cc 100644 --- a/install/omarchy-base.packages +++ b/install/omarchy-base.packages @@ -26,6 +26,7 @@ docker-compose dosfstools dotnet-runtime dua-cli +elsewhen evince exfatprogs expac diff --git a/migrations/1789581661.sh b/migrations/1789581661.sh new file mode 100644 index 00000000..fd5d30be --- /dev/null +++ b/migrations/1789581661.sh @@ -0,0 +1,85 @@ +echo "Install Elsewhen, the world clock plugin" + +# Elsewhen ships as the elsewhen package rather than in this checkout; pacman +# puts it under /usr/share/omarchy/plugins, where the shell looks next to its +# bundled plugins. A package the mirror does not carry yet fails the migration +# on purpose: nothing before this line has changed anything, and the runner +# retries it on the next update or login rather than quietly leaving the +# machine without the plugin. +omarchy-pkg-add elsewhen + +# A shell that already knows the packaged root (dev-linked, or restarted +# since) picks the plugin up here; the one an update runs under predates it +# and is replaced by omarchy-update-restart right after the migrations. +omarchy-shell -q shell rescanPlugins || true + +# Before the package, the README had users run +# `omarchy plugin add https://github.com/omacom/elsewhen.git`, which left a +# git clone under ~/.config/omarchy/plugins. The packaged copy now shadows +# it: the shell logs a rejection on every scan, and `omarchy plugin update` +# keeps pulling a checkout nothing loads. A pristine clone of the upstream +# repo is retired the way `omarchy plugin remove` retires one (the repo +# remains upstream). Anything else -- a symlink, a plain directory, local +# changes, a fork, a checkout git cannot read -- is the user's and stays. This +# runs only once the package is in place, so the plugin never leaves a +# machine; its id stays in shell.json either way, which is what keeps it +# enabled. The shell an update runs under predates the packaged root, and it +# watches this directory: dropping the checkout empties the widget's slot in +# that shell until omarchy-update-restart replaces it a few steps later with +# one that finds the package. A one-time gap of a few minutes, during the +# update itself. +upstream_checkout() { + local dir="$1" origin status + [[ -d $dir && ! -L $dir && -d $dir/.git ]] || return 1 + origin=$(git -C "$dir" remote get-url origin 2>/dev/null) || return 1 + origin=${origin,,} + origin=${origin%/} + origin=${origin%.git} + [[ $origin =~ ^([a-z+]+://)?([^/@]+@)?github\.com[/:]omacom/elsewhen$ ]] || return 1 + status=$(git -C "$dir" status --porcelain 2>/dev/null) || return 1 + [[ -z $status ]] +} + +checkout="$HOME/.config/omarchy/plugins/omacom.elsewhen" +if [[ -e $checkout || -L $checkout ]]; then + if upstream_checkout "$checkout"; then + rm -rf "$checkout" + echo "Retired the omacom.elsewhen checkout at $checkout in favour of the elsewhen package." + else + echo "The elsewhen package takes precedence over $checkout, which is left as it is." + fi +fi + +# The widget opens the right section of the default bar, just before the +# tray, which a machine without a shell.json takes on as soon as the shell +# restarts. A customized bar gets the entry written into its file rather than +# placed over IPC: the shell this runs under cannot see a widget its scan +# never reached and would refuse it, whereas the file it hot-reloads carries +# the entry through to the restart. A bar that already carries the widget +# keeps it where the user put it. +source omarchy-shell-config + +[[ -s $CONFIG_FILE ]] || exit 0 +# A file the shell cannot read is left for its owner to repair. +jq empty "$CONFIG_FILE" 2>/dev/null || exit 0 + +entry_id='def entry_id: if type == "object" then (.id // "" | tostring) else tostring end;' + +if jq -e "$entry_id"' + any((.bar.layout // {} | .left, .center, .right | arrays)[]; entry_id == "omacom.elsewhen") +' "$CONFIG_FILE" >/dev/null; then + exit 0 +fi + +commit "$NORMALIZE | $entry_id"' + def ids: map(entry_id); + def insert_at($section; $index): + .bar.layout[$section] = .bar.layout[$section][:$index] + [{id: "omacom.elsewhen"}] + .bar.layout[$section][$index:]; + . as $config + | (["left", "center", "right"] | map(select($config.bar.layout[.] | ids | index("omarchy.tray") != null)) | first) as $section + | if $section != null then + insert_at($section; .bar.layout[$section] | ids | index("omarchy.tray")) + else + insert_at("right"; 0) + end +' diff --git a/shell/README.md b/shell/README.md index ca07b520..23a25ca6 100644 --- a/shell/README.md +++ b/shell/README.md @@ -140,6 +140,19 @@ You can still drop a plugin in without git: `barWidget.defaultSection`, or in the center when it is omitted, and can be moved with `omarchy bar move`; a full bar replaces the one in use. +### Packaged plugins + +Some default plugins ship as their own Arch package rather than in this +checkout: Elsewhen (`omacom.elsewhen`) is the `elsewhen` package. pacman installs such a plugin, +root-owned, at `/usr/share/omarchy/plugins//`, and +the shell scans that root between its bundled plugins and the user's. A +packaged `omarchy.*` id is trusted exactly like a bundled one; a packaged +plugin under any other id is treated like a user plugin. They update with +`omarchy update` and are removed with pacman, so `omarchy plugin update` and +`omarchy plugin remove` refuse them and name the package instead. A bundled +copy in `$OMARCHY_PATH/shell/plugins` wins over the packaged one, which is how +a packaged plugin is developed under `omarchy dev link`. + The lower-level IPC equivalents remain available via `omarchy-shell shell rescanPlugins`, `omarchy-shell shell enablePlugin '{}'`, and `omarchy-shell shell listPlugins`. The `omarchy plugin` commands wrap those calls. `omarchy bar move` and @@ -224,6 +237,7 @@ customization from the shipped defaults lives in it. |-----------------------------------|----------------|--------------------------------------------------------| | `~/.config/omarchy/shell.json` | the shell | full layout + per-entry settings + enabled plugin list | | `~/.config/omarchy/plugins//` | user | drop-in third-party plugin source files | +| `/usr/share/omarchy/plugins//` | pacman | packaged plugins (e.g. `elsewhen`), updated by `omarchy update` | The `config/omarchy/shell.json` default config describes the fresh-install state. When the user has no `shell.json`, the shell uses diff --git a/shell/plugins/README.md b/shell/plugins/README.md index 66cb74e1..1a2d26fb 100644 --- a/shell/plugins/README.md +++ b/shell/plugins/README.md @@ -9,7 +9,10 @@ First-party non-bar plugins are enabled unless listed in `disabledPlugins[]`; at startup; other panels, overlays, and menus are loaded on demand. User-installed plugins live alongside these conceptually but on disk under -`~/.config/omarchy/plugins//` rather than in this directory. +`~/.config/omarchy/plugins//` rather than in this directory. A few +default plugins arrive as their own package instead: pacman installs them at +`/usr/share/omarchy/plugins//`, where an `omarchy.*` id is trusted +like the plugins here, and a copy in this directory shadows the packaged one. | Plugin | id | kinds | entry point | |---------------|---------------------------|-------------------------|---------------------------------------| @@ -28,6 +31,7 @@ User-installed plugins live alongside these conceptually but on disk under | Power | `omarchy.power` | `bar-widget` | `panels/power/Panel.qml` | | Tailscale | `omarchy.tailscale` | `bar-widget` | `panels/tailscale/Panel.qml` | | Agents | `omarchy.agents` | `bar-widget` | `agents/Panel.qml` | +| Elsewhen | `omacom.elsewhen` | `bar-widget` | packaged: `elsewhen` installs `/usr/share/omarchy/plugins/omacom.elsewhen/` | | Weather | `omarchy.weather` | `bar-widget` | `panels/weather/BarWidget.qml` | | Media | `omarchy.media` | `service`, `bar-widget` | `services/media/Service.qml`, `services/media/BarWidget.qml` | | Battery | `omarchy.battery` | `service` | `services/battery/Service.qml` | diff --git a/test/shell.d/config-test.sh b/test/shell.d/config-test.sh index 355ca26b..d9086d44 100755 --- a/test/shell.d/config-test.sh +++ b/test/shell.d/config-test.sh @@ -41,11 +41,12 @@ pass "default clock date format has no leading zero" jq -e ' def ids: map(.id // .); (.bar.layout.right | ids) as $ids | + ($ids | index("omacom.elsewhen")) as $elsewhen | ($ids | index("omarchy.tray")) as $tray | ($ids | index("omarchy.agents")) as $agents | - $tray != null and $agents == $tray + 1 + $elsewhen == 0 and $tray == 1 and $agents == $tray + 1 ' "$ROOT/config/omarchy/shell.json" >/dev/null -pass "default right layout keeps agents next to the tray" +pass "default right layout opens with elsewhen and the tray, then agents" ROOT="$ROOT" python3 <<'PY' import json diff --git a/test/shell.d/elsewhen-default-migration-test.sh b/test/shell.d/elsewhen-default-migration-test.sh new file mode 100644 index 00000000..438ba1d3 --- /dev/null +++ b/test/shell.d/elsewhen-default-migration-test.sh @@ -0,0 +1,285 @@ +#!/bin/bash + +set -euo pipefail + +source "$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)/base-test.sh" + +require_command jq +require_command git + +migration="$ROOT/migrations/1789581661.sh" +test_dir=$(mktemp -d) +trap 'rm -rf "$test_dir"' EXIT + +mkdir -p "$test_dir/bin" +export INSTALLED_PACKAGES="$test_dir/installed" CALL_LOG="$test_dir/calls" SHELL_CALLS="$test_dir/shell-calls" +# The checkout cases use the real git; keep the developer's config (signing, +# hooks, safe.directory) out of what it sees. +export GIT_CONFIG_GLOBAL=/dev/null GIT_CONFIG_NOSYSTEM=1 +export GIT_AUTHOR_NAME=test GIT_AUTHOR_EMAIL=test@example.com +export GIT_COMMITTER_NAME=test GIT_COMMITTER_EMAIL=test@example.com + +# Keep the real package helpers, but contain every pacman transaction here. +cat >"$test_dir/bin/pacman" <<'SH' +#!/bin/bash +case "$1" in + -Q) grep -Fxq -- "$2" "$INSTALLED_PACKAGES" ;; + -S) + [[ ${FAIL_INSTALL:-0} == 0 ]] || exit 1 + shift 3 # -S --noconfirm --needed + printf '%s\n' "$@" >>"$INSTALLED_PACKAGES" + printf '%s\n' "$@" >>"$CALL_LOG" + ;; + *) exit 1 ;; +esac +SH +cat >"$test_dir/bin/sudo" <<'SH' +#!/bin/bash +[[ $1 == "pacman" ]] || exit 1 +"$@" +SH +# The migration runs under a shell that predates the packaged root, or under +# none at all, so it must only ever ask the shell for best-effort refreshes. +cat >"$test_dir/bin/omarchy-shell" <<'SH' +#!/bin/bash +printf '%s\n' "$*" >>"$SHELL_CALLS" +[[ $1 != "-q" ]] || exit 0 +exit "${SHELL_STATUS:-0}" +SH +chmod +x "$test_dir/bin/"* + +home="$test_dir/home" +config="$home/.config/omarchy/shell.json" +checkout="$home/.config/omarchy/plugins/omacom.elsewhen" +output="$test_dir/output" +mkdir -p "$home/.config/omarchy" + +run_migration() { + : >"$CALL_LOG" + : >"$SHELL_CALLS" + HOME="$home" OMARCHY_PATH="$ROOT" PATH="$test_dir/bin:$ROOT/bin:$PATH" \ + bash -euo pipefail "$migration" >"$output" +} + +ids() { + jq -c ".bar.layout.$1 | map(if type == \"object\" then .id else . end)" "$config" +} + +# ------------------------------------------------------------ package install +: >"$INSTALLED_PACKAGES" +cat >"$config" <<'JSON' +{ + "version": 1, + "bar": { + "layout": { + "left": [{ "id": "omarchy.menu" }], + "center": [{ "id": "omarchy.clock", "format": "HH:mm" }], + "right": [ + { "id": "omarchy.tray" }, + { "id": "omarchy.agents", "syncMode": "On" }, + { "id": "omarchy.power" } + ] + } + }, + "plugins": [] +} +JSON + +run_migration +grep -Fxq elsewhen "$CALL_LOG" || fail "migration installs the elsewhen package" "$(cat "$CALL_LOG")" +pass "migration installs the elsewhen package" + +[[ $(ids right) == '["omacom.elsewhen","omarchy.tray","omarchy.agents","omarchy.power"]' ]] || + fail "migration puts the widget just before the tray" "$(cat "$config")" +pass "migration puts the widget just before the tray" + +[[ $(jq -c '.bar.layout.right[2]' "$config") == '{"id":"omarchy.agents","syncMode":"On"}' ]] || + fail "migration keeps the settings of its neighbours" "$(cat "$config")" +[[ $(jq -c '.bar.layout.center[0]' "$config") == '{"format":"HH:mm","id":"omarchy.clock"}' ]] || + fail "migration leaves other sections alone" "$(cat "$config")" +pass "migration leaves the rest of the layout alone" + +grep -q 'shell rescanPlugins' "$SHELL_CALLS" && grep -q 'shell reloadConfig' "$SHELL_CALLS" || + fail "migration asks the running shell to rescan and reload" "$(cat "$SHELL_CALLS")" +pass "migration asks the running shell to rescan and reload" + +before=$(sha256sum "$config") +run_migration +[[ $before == $(sha256sum "$config") ]] || fail "migration is idempotent" "$(cat "$config")" +[[ ! -s $CALL_LOG ]] || fail "migration does not reinstall a present package" "$(cat "$CALL_LOG")" +pass "migration is idempotent" + +# ------------------------------------------------------------- placements +cat >"$config" <<'JSON' +{ + "version": 1, + "bar": { "layout": { "left": [], "center": ["omarchy.clock", "omarchy.tray"], "right": ["omarchy.power"] } } +} +JSON +run_migration +[[ $(ids center) == '["omarchy.clock","omacom.elsewhen","omarchy.tray"]' && $(ids right) == '["omarchy.power"]' ]] || + fail "migration follows the tray into another section and reads string entries" "$(cat "$config")" +pass "migration follows the tray into another section and reads string entries" + +cat >"$config" <<'JSON' +{ "version": 1, "bar": { "layout": { "right": [{ "id": "omarchy.agents" }, { "id": "omarchy.power" }] } } } +JSON +run_migration +[[ $(ids right) == '["omacom.elsewhen","omarchy.agents","omarchy.power"]' ]] || + fail "migration prepends to the right section when the tray is off the bar" "$(cat "$config")" +pass "migration prepends to the right section when the tray is off the bar" + +cat >"$config" <<'JSON' +{ + "version": 1, + "bar": { "layout": { "left": [{ "id": "omacom.elsewhen" }], "center": [], "right": [{ "id": "omarchy.tray" }, { "id": "omarchy.agents" }] } } +} +JSON +before=$(sha256sum "$config") +run_migration +[[ $before == $(sha256sum "$config") ]] || + fail "migration leaves a widget the user already placed where it is" "$(cat "$config")" +pass "migration leaves a widget the user already placed where it is" + +# ------------------------------------------------------------- edge cases +rm -f "$config" +run_migration +[[ ! -e $config ]] || fail "migration writes no shell.json where the defaults apply" "$(cat "$config")" +pass "migration writes no shell.json where the defaults apply" + +printf '{ not json' >"$config" +run_migration +[[ $(cat "$config") == '{ not json' ]] || fail "migration leaves an unparsable config untouched" "$(cat "$config")" +pass "migration leaves an unparsable config untouched" + +cat >"$config" <<'JSON' +{ "version": 1, "bar": { "layout": { "right": [{ "id": "omarchy.tray" }, { "id": "omarchy.agents" }] } } } +JSON +SHELL_STATUS=1 run_migration +[[ $(ids right) == '["omacom.elsewhen","omarchy.tray","omarchy.agents"]' ]] || + fail "migration places the widget with no shell running" "$(cat "$config")" +pass "migration places the widget with no shell running" + +# A package the mirror does not carry yet leaves the migration pending rather +# than half-done: the layout must not name a widget nothing can install. +: >"$INSTALLED_PACKAGES" +cat >"$config" <<'JSON' +{ "version": 1, "bar": { "layout": { "right": [{ "id": "omarchy.tray" }, { "id": "omarchy.agents" }] } } } +JSON +before=$(sha256sum "$config") +if FAIL_INSTALL=1 run_migration 2>/dev/null; then + fail "a failed package installation must leave the migration pending" +fi +[[ $before == $(sha256sum "$config") ]] || + fail "a failed package installation leaves the layout untouched" "$(cat "$config")" +pass "a failed package installation is propagated and changes nothing" + +# ------------------------------------------------- pre-package checkouts +# Users who followed the README before the package existed hold a git clone +# under ~/.config/omarchy/plugins, which the packaged copy now shadows. Only a +# clone of the upstream repo with nothing local in it is retired; everything +# else is the user's and stays, and shell.json gets the widget either way. + +# A clone made by `omarchy plugin add`: one commit, the given origin, nothing +# local. Built with init rather than clone so the origin can be any URL form. +make_checkout() { + local origin="$1" + rm -rf "$checkout" + mkdir -p "$checkout" + git -C "$checkout" init -q + git -C "$checkout" remote add origin "$origin" + printf '{ "id": "omacom.elsewhen" }\n' >"$checkout/manifest.json" + printf 'import QtQuick\nItem {}\n' >"$checkout/Panel.qml" + git -C "$checkout" add -A + git -C "$checkout" commit -q -m "Elsewhen" +} + +reset_layout() { + cat >"$config" <<'JSON' +{ "version": 1, "bar": { "layout": { "right": [{ "id": "omarchy.tray" }, { "id": "omarchy.power" }] } } } +JSON +} + +assert_widget_placed() { + [[ $(ids right) == '["omacom.elsewhen","omarchy.tray","omarchy.power"]' ]] || + fail "$1 still gets the widget" "$(cat "$config")" +} + +assert_retired() { + local description="$1" + [[ ! -e $checkout && ! -L $checkout ]] || fail "$description is retired" "$(ls -la "$checkout")" + grep -q 'Retired the omacom.elsewhen checkout' "$output" || fail "$description is reported as retired" "$(cat "$output")" + assert_widget_placed "$description" + pass "$description is retired" +} + +assert_kept() { + local description="$1" + [[ -e $checkout || -L $checkout ]] || fail "$description is kept" + grep -q 'takes precedence over' "$output" || fail "$description is reported as shadowed" "$(cat "$output")" + assert_widget_placed "$description" + pass "$description is kept" +} + +for origin in \ + https://github.com/omacom/elsewhen.git \ + https://github.com/omacom/elsewhen \ + git@github.com:omacom/elsewhen.git \ + ssh://git@github.com/omacom/elsewhen.git \ + https://GitHub.com/Omacom/Elsewhen/; do + make_checkout "$origin" + reset_layout + run_migration + assert_retired "a pristine clone with origin $origin" +done + +make_checkout https://github.com/omacom/elsewhen.git +printf 'import QtQuick\nItem { id: mine }\n' >"$checkout/Panel.qml" +reset_layout +run_migration +assert_kept "a clone with a modified tracked file" +[[ $(cat "$checkout/Panel.qml") == $'import QtQuick\nItem { id: mine }' ]] || + fail "a kept clone keeps its local change" "$(cat "$checkout/Panel.qml")" +pass "a kept clone keeps its local change" + +make_checkout https://github.com/omacom/elsewhen.git +printf 'notes\n' >"$checkout/NOTES.md" +reset_layout +run_migration +assert_kept "a clone with an untracked file" + +make_checkout https://github.com/someone/elsewhen-fork.git +reset_layout +run_migration +assert_kept "a clone of another repository" + +make_checkout https://github.com/omacom/elsewhen.git +git -C "$checkout" remote remove origin +reset_layout +run_migration +assert_kept "a clone without an origin remote" + +rm -rf "$checkout" +mkdir -p "$checkout" +printf '{ "id": "omacom.elsewhen" }\n' >"$checkout/manifest.json" +reset_layout +run_migration +assert_kept "a plain directory without .git" + +rm -rf "$checkout" +make_checkout https://github.com/omacom/elsewhen.git +mv "$checkout" "$test_dir/elsewhen-src" +ln -s "$test_dir/elsewhen-src" "$checkout" +reset_layout +run_migration +assert_kept "a symlinked checkout" +[[ -L $checkout && -f $test_dir/elsewhen-src/manifest.json ]] || + fail "a symlinked checkout stays a symlink with its target intact" "$(ls -la "$checkout" "$test_dir/elsewhen-src")" +pass "a symlinked checkout stays a symlink with its target intact" + +rm -f "$checkout" +reset_layout +run_migration +grep -q 'omacom.elsewhen checkout\|takes precedence' "$output" && fail "no checkout means no checkout report" "$(cat "$output")" +assert_widget_placed "a machine without a checkout" +pass "a machine without a checkout is left alone" From 49286d0e66b22d6b91e21c0f8c8fe8bd1a6ce064 Mon Sep 17 00:00:00 2001 From: Spencer Bull Date: Thu, 17 Sep 2026 21:07:08 -0500 Subject: [PATCH 07/36] Place Elsewhen immediately before the center clock --- config/omarchy/shell.json | 6 +-- default/agents/skills/omarchy/plugins.md | 4 +- docs/omarchy-shell.md | 11 +----- migrations/1789581661.sh | 10 ++--- shell/README.md | 11 +----- test/shell.d/config-test.sh | 14 +++++-- .../elsewhen-default-migration-test.sh | 37 ++++++++++++------- 7 files changed, 45 insertions(+), 48 deletions(-) diff --git a/config/omarchy/shell.json b/config/omarchy/shell.json index 64cc4075..b8aa5de4 100644 --- a/config/omarchy/shell.json +++ b/config/omarchy/shell.json @@ -21,6 +21,9 @@ { "id": "omarchy.indicators" }, + { + "id": "omacom.elsewhen" + }, { "id": "omarchy.clock", "format": "dddd HH:mm", @@ -38,9 +41,6 @@ } ], "right": [ - { - "id": "omacom.elsewhen" - }, { "id": "omarchy.tray" }, diff --git a/default/agents/skills/omarchy/plugins.md b/default/agents/skills/omarchy/plugins.md index bf1033b3..1c58c83a 100644 --- a/default/agents/skills/omarchy/plugins.md +++ b/default/agents/skills/omarchy/plugins.md @@ -13,9 +13,7 @@ inside a single long-running Quickshell process (`omarchy-shell`). $OMARCHY_PATH/config/omarchy/shell.json # Canonical defaults ``` -Packaged plugins such as Elsewhen (`elsewhen` package) update with `omarchy update` and are removed with pacman; -`omarchy plugin update` and `omarchy plugin remove` refuse them and name the -package. +Packaged plugins such as Elsewhen (`elsewhen` package) update with `omarchy update` and are removed with pacman; `omarchy plugin update` and `omarchy plugin remove` refuse them and name the package. The shell hot-reloads `shell.json` on save — no restart needed for layout changes. `idle.screensaver` and `idle.lock` are seconds since user idle began. diff --git a/docs/omarchy-shell.md b/docs/omarchy-shell.md index 18a61896..dd8cc18a 100644 --- a/docs/omarchy-shell.md +++ b/docs/omarchy-shell.md @@ -90,16 +90,7 @@ The lower-level IPC methods remain available through `omarchy-shell shell ...`. ## Packaged plugins -A default plugin can ship as its own Arch package instead of in the Omarchy -checkout: Elsewhen (`omacom.elsewhen`) is the `elsewhen` package. pacman installs them at -`/usr/share/omarchy/plugins//`, a root the shell scans between -`$OMARCHY_PATH/shell/plugins` and `~/.config/omarchy/plugins`. A packaged -`omarchy.*` id is trusted like a bundled plugin and loads by default; any other -packaged id behaves like an installed plugin. Precedence is bundled, then -packaged, then user, so a checkout under `omarchy dev link` overrides the -package. Packaged plugins update through `omarchy update` and leave through -pacman; `omarchy plugin update` and `omarchy plugin remove` refuse them and -name the package, and Setup › Plugins › Remove does not list them. +A default plugin can ship as its own Arch package instead of in the Omarchy checkout: Elsewhen (`omacom.elsewhen`) is the `elsewhen` package. pacman installs it at `/usr/share/omarchy/plugins//`, a root the shell scans between `$OMARCHY_PATH/shell/plugins` and `~/.config/omarchy/plugins`. A packaged `omarchy.*` id is trusted like a bundled plugin and loads by default; any other packaged id behaves like an installed plugin. Precedence is bundled, then packaged, then user, so a checkout under `omarchy dev link` overrides the package. Packaged plugins update through `omarchy update` and leave through pacman; `omarchy plugin update` and `omarchy plugin remove` refuse them and name the package, and Setup › Plugins › Remove does not list them. ## IPC diff --git a/migrations/1789581661.sh b/migrations/1789581661.sh index fd5d30be..163deb9c 100644 --- a/migrations/1789581661.sh +++ b/migrations/1789581661.sh @@ -50,8 +50,8 @@ if [[ -e $checkout || -L $checkout ]]; then fi fi -# The widget opens the right section of the default bar, just before the -# tray, which a machine without a shell.json takes on as soon as the shell +# The widget sits just before the clock in the center of the default bar, +# which a machine without a shell.json takes on as soon as the shell # restarts. A customized bar gets the entry written into its file rather than # placed over IPC: the shell this runs under cannot see a widget its scan # never reached and would refuse it, whereas the file it hot-reloads carries @@ -76,10 +76,10 @@ commit "$NORMALIZE | $entry_id"' def insert_at($section; $index): .bar.layout[$section] = .bar.layout[$section][:$index] + [{id: "omacom.elsewhen"}] + .bar.layout[$section][$index:]; . as $config - | (["left", "center", "right"] | map(select($config.bar.layout[.] | ids | index("omarchy.tray") != null)) | first) as $section + | (["left", "center", "right"] | map(select($config.bar.layout[.] | ids | index("omarchy.clock") != null)) | first) as $section | if $section != null then - insert_at($section; .bar.layout[$section] | ids | index("omarchy.tray")) + insert_at($section; .bar.layout[$section] | ids | index("omarchy.clock")) else - insert_at("right"; 0) + insert_at("center"; 0) end ' diff --git a/shell/README.md b/shell/README.md index 23a25ca6..53425139 100644 --- a/shell/README.md +++ b/shell/README.md @@ -142,16 +142,7 @@ You can still drop a plugin in without git: ### Packaged plugins -Some default plugins ship as their own Arch package rather than in this -checkout: Elsewhen (`omacom.elsewhen`) is the `elsewhen` package. pacman installs such a plugin, -root-owned, at `/usr/share/omarchy/plugins//`, and -the shell scans that root between its bundled plugins and the user's. A -packaged `omarchy.*` id is trusted exactly like a bundled one; a packaged -plugin under any other id is treated like a user plugin. They update with -`omarchy update` and are removed with pacman, so `omarchy plugin update` and -`omarchy plugin remove` refuse them and name the package instead. A bundled -copy in `$OMARCHY_PATH/shell/plugins` wins over the packaged one, which is how -a packaged plugin is developed under `omarchy dev link`. +Some default plugins ship as their own Arch package rather than in this checkout: Elsewhen (`omacom.elsewhen`) is the `elsewhen` package. pacman installs such a plugin, root-owned, at `/usr/share/omarchy/plugins//`, and the shell scans that root between its bundled plugins and the user's. A packaged `omarchy.*` id is trusted exactly like a bundled one; a packaged plugin under any other id is treated like a user plugin. They update with `omarchy update` and are removed with pacman, so `omarchy plugin update` and `omarchy plugin remove` refuse them and name the package instead. A bundled copy in `$OMARCHY_PATH/shell/plugins` wins over the packaged one, which is how a packaged plugin is developed under `omarchy dev link`. The lower-level IPC equivalents remain available via `omarchy-shell shell rescanPlugins`, `omarchy-shell shell enablePlugin '{}'`, and `omarchy-shell shell listPlugins`. diff --git a/test/shell.d/config-test.sh b/test/shell.d/config-test.sh index d9086d44..1cd47e33 100755 --- a/test/shell.d/config-test.sh +++ b/test/shell.d/config-test.sh @@ -33,6 +33,15 @@ jq -e ' ' "$ROOT/config/omarchy/shell.json" >/dev/null pass "default center anchor exists in center layout" +jq -e ' + def ids: map(.id // .); + (.bar.layout.center | ids) as $ids | + ($ids | index("omacom.elsewhen")) as $elsewhen | + ($ids | index("omarchy.clock")) as $clock | + $elsewhen != null and $clock == $elsewhen + 1 +' "$ROOT/config/omarchy/shell.json" >/dev/null +pass "default center layout puts elsewhen immediately before the clock" + jq -e ' any(.bar.layout.center[]; (.id // .) == "omarchy.clock" and (.formatAlt // "") == "d MMMM \u0027W\u0027ww yyyy") ' "$ROOT/config/omarchy/shell.json" >/dev/null @@ -41,12 +50,11 @@ pass "default clock date format has no leading zero" jq -e ' def ids: map(.id // .); (.bar.layout.right | ids) as $ids | - ($ids | index("omacom.elsewhen")) as $elsewhen | ($ids | index("omarchy.tray")) as $tray | ($ids | index("omarchy.agents")) as $agents | - $elsewhen == 0 and $tray == 1 and $agents == $tray + 1 + $tray == 0 and $agents == $tray + 1 ' "$ROOT/config/omarchy/shell.json" >/dev/null -pass "default right layout opens with elsewhen and the tray, then agents" +pass "default right layout opens with the tray, then agents" ROOT="$ROOT" python3 <<'PY' import json diff --git a/test/shell.d/elsewhen-default-migration-test.sh b/test/shell.d/elsewhen-default-migration-test.sh index 438ba1d3..89585f22 100644 --- a/test/shell.d/elsewhen-default-migration-test.sh +++ b/test/shell.d/elsewhen-default-migration-test.sh @@ -89,14 +89,14 @@ run_migration grep -Fxq elsewhen "$CALL_LOG" || fail "migration installs the elsewhen package" "$(cat "$CALL_LOG")" pass "migration installs the elsewhen package" -[[ $(ids right) == '["omacom.elsewhen","omarchy.tray","omarchy.agents","omarchy.power"]' ]] || - fail "migration puts the widget just before the tray" "$(cat "$config")" -pass "migration puts the widget just before the tray" +[[ $(ids center) == '["omacom.elsewhen","omarchy.clock"]' && $(ids right) == '["omarchy.tray","omarchy.agents","omarchy.power"]' ]] || + fail "migration puts the widget just before the center clock" "$(cat "$config")" +pass "migration puts the widget just before the center clock" -[[ $(jq -c '.bar.layout.right[2]' "$config") == '{"id":"omarchy.agents","syncMode":"On"}' ]] || +[[ $(jq -c '.bar.layout.right[1]' "$config") == '{"id":"omarchy.agents","syncMode":"On"}' ]] || fail "migration keeps the settings of its neighbours" "$(cat "$config")" -[[ $(jq -c '.bar.layout.center[0]' "$config") == '{"format":"HH:mm","id":"omarchy.clock"}' ]] || - fail "migration leaves other sections alone" "$(cat "$config")" +[[ $(jq -c '.bar.layout.center[1]' "$config") == '{"format":"HH:mm","id":"omarchy.clock"}' ]] || + fail "migration keeps the clock settings" "$(cat "$config")" pass "migration leaves the rest of the layout alone" grep -q 'shell rescanPlugins' "$SHELL_CALLS" && grep -q 'shell reloadConfig' "$SHELL_CALLS" || @@ -117,17 +117,17 @@ cat >"$config" <<'JSON' } JSON run_migration -[[ $(ids center) == '["omarchy.clock","omacom.elsewhen","omarchy.tray"]' && $(ids right) == '["omarchy.power"]' ]] || - fail "migration follows the tray into another section and reads string entries" "$(cat "$config")" -pass "migration follows the tray into another section and reads string entries" +[[ $(ids center) == '["omacom.elsewhen","omarchy.clock","omarchy.tray"]' && $(ids right) == '["omarchy.power"]' ]] || + fail "migration reads string clock entries" "$(cat "$config")" +pass "migration reads string clock entries" cat >"$config" <<'JSON' { "version": 1, "bar": { "layout": { "right": [{ "id": "omarchy.agents" }, { "id": "omarchy.power" }] } } } JSON run_migration -[[ $(ids right) == '["omacom.elsewhen","omarchy.agents","omarchy.power"]' ]] || - fail "migration prepends to the right section when the tray is off the bar" "$(cat "$config")" -pass "migration prepends to the right section when the tray is off the bar" +[[ $(ids center) == '["omacom.elsewhen"]' && $(ids right) == '["omarchy.agents","omarchy.power"]' ]] || + fail "migration prepends to the center section when the clock is off the bar" "$(cat "$config")" +pass "migration prepends to the center section when the clock is off the bar" cat >"$config" <<'JSON' { @@ -141,6 +141,15 @@ run_migration fail "migration leaves a widget the user already placed where it is" "$(cat "$config")" pass "migration leaves a widget the user already placed where it is" +# A customized clock keeps its section and settings; insert only its neighbour. +for section in left right; do + jq -n --arg section "$section" '{version: 1, bar: {layout: {center: ["omarchy.weather"], ($section): ["omarchy.menu", {id: "omarchy.clock", format: "HH:mm"}]}}}' >"$config" + run_migration + [[ $(ids "$section") == '["omarchy.menu","omacom.elsewhen","omarchy.clock"]' && $(ids center) == '["omarchy.weather"]' ]] || + fail "migration follows a clock customized into $section" "$(cat "$config")" + pass "migration follows a clock customized into $section" +done + # ------------------------------------------------------------- edge cases rm -f "$config" run_migration @@ -156,7 +165,7 @@ cat >"$config" <<'JSON' { "version": 1, "bar": { "layout": { "right": [{ "id": "omarchy.tray" }, { "id": "omarchy.agents" }] } } } JSON SHELL_STATUS=1 run_migration -[[ $(ids right) == '["omacom.elsewhen","omarchy.tray","omarchy.agents"]' ]] || +[[ $(ids center) == '["omacom.elsewhen"]' && $(ids right) == '["omarchy.tray","omarchy.agents"]' ]] || fail "migration places the widget with no shell running" "$(cat "$config")" pass "migration places the widget with no shell running" @@ -201,7 +210,7 @@ JSON } assert_widget_placed() { - [[ $(ids right) == '["omacom.elsewhen","omarchy.tray","omarchy.power"]' ]] || + [[ $(ids center) == '["omacom.elsewhen"]' && $(ids right) == '["omarchy.tray","omarchy.power"]' ]] || fail "$1 still gets the widget" "$(cat "$config")" } From e8a8236a22e9d05f4fccded51639d522a88903ca Mon Sep 17 00:00:00 2001 From: Spencer Bull Date: Thu, 17 Sep 2026 22:07:54 -0500 Subject: [PATCH 08/36] Preserve local Elsewhen work and fallback bar layouts Retire only checkouts whose refs and reflogs are reachable from recorded origin history, and preserve ignored files. Leave configs without an explicit supported bar layout untouched so migration does not replace the shell fallback with an almost empty bar. Co-Authored-By: Codex XHigh --- migrations/1789581661.sh | 13 ++-- .../elsewhen-default-migration-test.sh | 69 +++++++++++++++++++ 2 files changed, 77 insertions(+), 5 deletions(-) diff --git a/migrations/1789581661.sh b/migrations/1789581661.sh index 163deb9c..f581d4d0 100644 --- a/migrations/1789581661.sh +++ b/migrations/1789581661.sh @@ -29,15 +29,18 @@ omarchy-shell -q shell rescanPlugins || true # one that finds the package. A one-time gap of a few minutes, during the # update itself. upstream_checkout() { - local dir="$1" origin status + local dir="$1" origin status unpublished [[ -d $dir && ! -L $dir && -d $dir/.git ]] || return 1 origin=$(git -C "$dir" remote get-url origin 2>/dev/null) || return 1 origin=${origin,,} origin=${origin%/} origin=${origin%.git} [[ $origin =~ ^([a-z+]+://)?([^/@]+@)?github\.com[/:]omacom/elsewhen$ ]] || return 1 - status=$(git -C "$dir" status --porcelain 2>/dev/null) || return 1 - [[ -z $status ]] + status=$(git -C "$dir" status --porcelain --untracked-files=all --ignored 2>/dev/null) || return 1 + [[ -z $status ]] || return 1 + # Local branches, stashes, and reflogs may hold work absent from a clean tree. + unpublished=$(git -C "$dir" rev-list HEAD --all --reflog --not --remotes=origin 2>/dev/null) || return 1 + [[ -z $unpublished ]] } checkout="$HOME/.config/omarchy/plugins/omacom.elsewhen" @@ -60,8 +63,8 @@ fi source omarchy-shell-config [[ -s $CONFIG_FILE ]] || exit 0 -# A file the shell cannot read is left for its owner to repair. -jq empty "$CONFIG_FILE" 2>/dev/null || exit 0 +# Preserve configs whose bar comes from the shell fallback instead of an explicit layout. +jq -e 'type == "object" and .version == 1 and (.bar | type == "object") and (.bar.layout | type == "object")' "$CONFIG_FILE" >/dev/null 2>&1 || exit 0 entry_id='def entry_id: if type == "object" then (.id // "" | tostring) else tostring end;' diff --git a/test/shell.d/elsewhen-default-migration-test.sh b/test/shell.d/elsewhen-default-migration-test.sh index 89585f22..525094e5 100644 --- a/test/shell.d/elsewhen-default-migration-test.sh +++ b/test/shell.d/elsewhen-default-migration-test.sh @@ -156,6 +156,18 @@ run_migration [[ ! -e $config ]] || fail "migration writes no shell.json where the defaults apply" "$(cat "$config")" pass "migration writes no shell.json where the defaults apply" +for partial in \ + '{"version":1,"idle":{"lock":600}}' \ + '{"version":1,"bar":null,"idle":{"lock":600}}' \ + '{"version":1,"bar":{"position":"bottom"}}' \ + '{"bar":{"layout":{"center":["omarchy.clock"]}}}'; do + printf '%s\n' "$partial" >"$config" + before=$(sha256sum "$config") + run_migration + [[ $before == $(sha256sum "$config") ]] || fail "migration preserves fallback configuration" "$(cat "$config")" + pass "migration preserves fallback configuration: $partial" +done + printf '{ not json' >"$config" run_migration [[ $(cat "$config") == '{ not json' ]] || fail "migration leaves an unparsable config untouched" "$(cat "$config")" @@ -201,6 +213,7 @@ make_checkout() { printf 'import QtQuick\nItem {}\n' >"$checkout/Panel.qml" git -C "$checkout" add -A git -C "$checkout" commit -q -m "Elsewhen" + git -C "$checkout" update-ref refs/remotes/origin/main HEAD } reset_layout() { @@ -257,6 +270,62 @@ reset_layout run_migration assert_kept "a clone with an untracked file" +make_checkout https://github.com/omacom/elsewhen.git +printf 'import QtQuick\nItem { id: mine }\n' >"$checkout/Panel.qml" +git -C "$checkout" add Panel.qml +git -C "$checkout" commit -q -m "Local customization" +local_commit=$(git -C "$checkout" rev-parse HEAD) +reset_layout +run_migration +assert_kept "a clean clone with an unpublished commit" +[[ $(git -C "$checkout" rev-parse HEAD) == "$local_commit" ]] || fail "local commit survives" + +make_checkout https://github.com/omacom/elsewhen.git +git -C "$checkout" checkout -qb local-work +printf 'local branch\n' >"$checkout/Panel.qml" +git -C "$checkout" commit -qam "Unpublished branch" +git -C "$checkout" checkout -q --detach refs/remotes/origin/main +reset_layout +run_migration +assert_kept "an unpublished commit on another branch" + +make_checkout https://github.com/omacom/elsewhen.git +printf 'stashed work\n' >"$checkout/Panel.qml" +git -C "$checkout" stash push -q +reset_layout +run_migration +assert_kept "a clean clone with stashed work" + +make_checkout https://github.com/omacom/elsewhen.git +git -C "$checkout" config status.showUntrackedFiles no +printf 'private-notes\n' >"$checkout/.git/info/exclude" +printf 'ignored work\n' >"$checkout/private-notes" +reset_layout +run_migration +assert_kept "a clone with an ignored file" +[[ $(cat "$checkout/private-notes") == "ignored work" ]] || fail "ignored file survives" + +make_checkout https://github.com/omacom/elsewhen.git +printf 'recoverable work\n' >"$checkout/Panel.qml" +git -C "$checkout" commit -qam "Recoverable local commit" +git -C "$checkout" reset -q --hard refs/remotes/origin/main +reset_layout +run_migration +assert_kept "a local commit retained only by the reflog" + +make_checkout https://github.com/omacom/elsewhen.git +git -C "$checkout" update-ref -d refs/remotes/origin/main +reset_layout +run_migration +assert_kept "a clone without recorded upstream history" + +make_checkout https://github.com/omacom/elsewhen.git +git -C "$checkout" config status.showUntrackedFiles no +printf 'untracked work\n' >"$checkout/NOTES.md" +reset_layout +run_migration +assert_kept "untracked files hidden by the user Git configuration" + make_checkout https://github.com/someone/elsewhen-fork.git reset_layout run_migration From 5f34ce4581f7cd65b9555d821a61f58e6314821a Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Fri, 18 Sep 2026 14:10:14 +0200 Subject: [PATCH 09/36] Detach 1Password from installer terminal --- bin/omarchy-install-service-1password | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bin/omarchy-install-service-1password b/bin/omarchy-install-service-1password index f59cab92..fc7238a6 100755 --- a/bin/omarchy-install-service-1password +++ b/bin/omarchy-install-service-1password @@ -28,7 +28,7 @@ echo "Installing 1Password extension for Chromium..." install_chromium_extension echo "Opening 1Password..." -uwsm-app -- 1password >/dev/null 2>&1 & +setsid uwsm-app -- 1password >/dev/null 2>&1 & echo "" echo "1Password has been installed. Restart Chromium to load the browser extension." From d174d4aa279ea7393d4fad4a80fed147866106b9 Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Fri, 18 Sep 2026 15:34:01 +0200 Subject: [PATCH 10/36] Add omarchy up alias --- bin/omarchy-update | 1 + 1 file changed, 1 insertion(+) diff --git a/bin/omarchy-update b/bin/omarchy-update index e71e8086..1738ebff 100755 --- a/bin/omarchy-update +++ b/bin/omarchy-update @@ -1,6 +1,7 @@ #!/bin/bash # omarchy:summary=Update Omarchy and system packages +# omarchy:alias=omarchy up # omarchy:args=[-y] # omarchy:examples=omarchy update | omarchy update -y # omarchy:requires-sudo=true From d01ef2d5d0ab5048ad8e2c662bdbf1e7d65479bd Mon Sep 17 00:00:00 2001 From: Bjarne Oeverli <1419214+bjarneo@users.noreply.github.com> Date: Fri, 18 Sep 2026 18:23:21 +0200 Subject: [PATCH 11/36] Let OWE own video backgrounds while it runs The background plugin now watches for the OWE daemon socket. While OWE is running, the desktop yields video playback to it and the shell keeps stills. The lock screen keeps its own playback. This lets Omarchy cooperate with OWE without OWE editing shell.json, so the engine can ship as a package. Add a package-list note that owe-wallpaper-engine must be added once it is packaged. --- install/omarchy-base.packages | 2 ++ manual/39-backgrounds.md | 2 +- shell/Ui/BackgroundMedia.qml | 6 +++++- shell/plugins/background/Background.qml | 25 ++++++++++++++++++++++++- test/shell.d/video-background-test.sh | 9 +++++++++ 5 files changed, 41 insertions(+), 3 deletions(-) diff --git a/install/omarchy-base.packages b/install/omarchy-base.packages index 76e74110..b38c68b8 100644 --- a/install/omarchy-base.packages +++ b/install/omarchy-base.packages @@ -107,6 +107,8 @@ python-poetry-core ttfx qemu-user-static-binfmt qrencode +# TODO: add owe-wallpaper-engine here once it is packaged. The shell yields +# video backgrounds to it while its daemon runs. qt6-imageformats qt6-multimedia qt6-multimedia-ffmpeg diff --git a/manual/39-backgrounds.md b/manual/39-backgrounds.md index f2cd51eb..f0291653 100644 --- a/manual/39-backgrounds.md +++ b/manual/39-backgrounds.md @@ -4,6 +4,6 @@ Every theme ships with its own set of backgrounds, and you can add extras of you You can do this most easily by going to _Install > Style > Background_ in the Omarchy Menu. That'll bring up the folder where the backgrounds for that theme is stored. Hit `Super + Shift + F` to start another file manager, find your background, copy it over. Now it'll be included in the choices of backgrounds you can select between using `Super + Ctrl + Space`. -Backgrounds can be videos as well as stills. Drop an `mp4`, `m4v`, `mov`, `webm`, `mkv`, or `avi` file in the same folder and it appears alongside the images, playing on a loop. Only your first monitor's wallpaper plays a video's sound track, through the default audio output at the system volume, and the lock screen stays silent. Playback stops on its own whenever nothing can see it — while a fullscreen window covers that monitor, while the screensaver is up, and once a locked screen has gone dark — but a video wallpaper still costs far more power than a still one, and each monitor decodes its own copy. +Backgrounds can be videos as well as stills. Drop an `mp4`, `m4v`, `mov`, `webm`, `mkv`, or `avi` file in the same folder and it appears alongside the images, playing on a loop. Only your first monitor's wallpaper plays a video's sound track, through the default audio output at the system volume, and the lock screen stays silent. Playback stops on its own whenever nothing can see it — while a fullscreen window covers that monitor, while the screensaver is up, and once a locked screen has gone dark — but a video wallpaper still costs far more power than a still one, and each monitor decodes its own copy. When the OWE wallpaper engine is running, it takes over video backgrounds and the shell keeps only stills. You can find a huge collection of cool curated backgrounds on https://github.com/dharmx/walls. diff --git a/shell/Ui/BackgroundMedia.qml b/shell/Ui/BackgroundMedia.qml index b281ae22..f3ab7743 100644 --- a/shell/Ui/BackgroundMedia.qml +++ b/shell/Ui/BackgroundMedia.qml @@ -8,6 +8,10 @@ Item { property int version: 0 property bool playbackEnabled: true property bool audioEnabled: false + // The desktop yields video playback to OWE while it runs, so two engines + // never decode the same file. The lock screen leaves this off and keeps its + // own playback. + property bool deferVideo: false // Bumped when the file behind an unchanged path may have been replaced. // Images cache-bust through version; a video is rebuilt, since FFmpeg // would read a query as part of the filename. @@ -37,7 +41,7 @@ Item { Loader { id: videoLoader anchors.fill: parent - active: root.path !== "" && root.video && !root.reloading + active: root.path !== "" && root.video && !root.reloading && !root.deferVideo source: "BackgroundVideo.qml" } diff --git a/shell/plugins/background/Background.qml b/shell/plugins/background/Background.qml index dea93a4c..f8929fa9 100644 --- a/shell/plugins/background/Background.qml +++ b/shell/plugins/background/Background.qml @@ -32,6 +32,25 @@ Item { // services so playback can stop whenever nothing can see the wallpaper. property var shell: null + // When the OWE wallpaper engine is running, it owns video backgrounds. This + // plugin keeps stills, which OWE hands back to it, and the lock screen keeps + // its own playback. + property bool oweActive: false + + Process { + id: oweStatusProc + command: ["bash", "-c", "test -S \"${XDG_RUNTIME_DIR:-/run/user/$(id -u)}/owe/owed.sock\""] + onExited: root.oweActive = (exitCode === 0) + } + + Timer { + id: oweStatusTimer + interval: 5000 + repeat: true + running: true + onTriggered: if (!oweStatusProc.running) oweStatusProc.running = true + } + // Stop a video wallpaper's decoding whenever it is covered. Qt's FFmpeg // engine drives its own clock, so an unseen player keeps decoding until it // is told not to — a locked laptop would otherwise decode until it died. @@ -204,7 +223,10 @@ Item { } } - Component.onCompleted: refreshBackground() + Component.onCompleted: { + oweStatusProc.running = true + refreshBackground() + } Variants { model: Quickshell.screens @@ -264,6 +286,7 @@ Item { anchors.fill: parent path: root.displayedBackground reloads: root.displayedReloads + deferVideo: root.oweActive playbackEnabled: !root.sessionObscured && !root.powerSaverActive && !panel.fullscreenHere audioEnabled: panel.firstScreen onReadyChanged: { diff --git a/test/shell.d/video-background-test.sh b/test/shell.d/video-background-test.sh index 7ebad86b..d3591b4f 100755 --- a/test/shell.d/video-background-test.sh +++ b/test/shell.d/video-background-test.sh @@ -87,6 +87,15 @@ assert( 'video switches bypass the image-only reveal stack and use the durable background path' ) assert(backgroundQml.includes('BackgroundMedia {') && lockQml.includes('BackgroundMedia {'), 'desktop and lock screen share video-capable media rendering') +assert( + backgroundQml.includes('property bool oweActive: false') && + backgroundQml.includes('/owe/owed.sock') && + /deferVideo: root\.oweActive/.test(backgroundQml) && + /property bool deferVideo: false/.test(mediaQml) && + /active: root\.path !== "" && root\.video && !root\.reloading && !root\.deferVideo/.test(mediaQml) && + !lockQml.includes('deferVideo'), + 'the desktop yields video backgrounds to OWE while it is running, and the lock keeps its own playback' +) assert( lockQml.includes('source: wallpaper.video ? null : wallpaper') && lockQml.includes('visible: !wallpaper.video') && From 02bb92bc74acd2d0b5ff01708f4043e4eec87c92 Mon Sep 17 00:00:00 2001 From: Bjarne Oeverli <1419214+bjarneo@users.noreply.github.com> Date: Fri, 18 Sep 2026 18:36:07 +0200 Subject: [PATCH 12/36] Mark the desktop video path as the no-OWE fallback --- shell/plugins/background/Background.qml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/shell/plugins/background/Background.qml b/shell/plugins/background/Background.qml index f8929fa9..21616940 100644 --- a/shell/plugins/background/Background.qml +++ b/shell/plugins/background/Background.qml @@ -34,7 +34,8 @@ Item { // When the OWE wallpaper engine is running, it owns video backgrounds. This // plugin keeps stills, which OWE hands back to it, and the lock screen keeps - // its own playback. + // its own playback. The desktop video path and its pause policy stay as the + // fallback for systems without OWE. property bool oweActive: false Process { From dbebc458db93bcffd4f453a2fa6af1bc12df4d4d Mon Sep 17 00:00:00 2001 From: Bjarne Oeverli <1419214+bjarneo@users.noreply.github.com> Date: Fri, 18 Sep 2026 18:46:17 +0200 Subject: [PATCH 13/36] Replace the desktop video path with OWE The desktop background no longer plays videos. OWE owns video backgrounds, and the shell layer stays empty behind one. The shell keeps stills, which OWE hands back to it. Remove the desktop video pause plumbing that only existed to stop an unseen player: the lock, idle, and battery service lookups, the per-output fullscreen check, the first-screen audio opt-in, and the audio output in BackgroundVideo. The lock screen keeps its own silent playback. Update the background tests, the manual, and the package note. --- install/omarchy-base.packages | 4 +- manual/39-backgrounds.md | 2 +- shell/Ui/BackgroundMedia.qml | 19 +++------ shell/Ui/BackgroundVideo.qml | 23 +++------- shell/plugins/background/Background.qml | 57 ++----------------------- test/shell.d/video-background-test.sh | 51 +++++++++------------- 6 files changed, 37 insertions(+), 119 deletions(-) diff --git a/install/omarchy-base.packages b/install/omarchy-base.packages index b38c68b8..634b72aa 100644 --- a/install/omarchy-base.packages +++ b/install/omarchy-base.packages @@ -107,8 +107,8 @@ python-poetry-core ttfx qemu-user-static-binfmt qrencode -# TODO: add owe-wallpaper-engine here once it is packaged. The shell yields -# video backgrounds to it while its daemon runs. +# TODO: add owe-wallpaper-engine here once it is packaged. The shell keeps +# stills and the lock screen, and OWE owns desktop video backgrounds. qt6-imageformats qt6-multimedia qt6-multimedia-ffmpeg diff --git a/manual/39-backgrounds.md b/manual/39-backgrounds.md index f0291653..7670ea61 100644 --- a/manual/39-backgrounds.md +++ b/manual/39-backgrounds.md @@ -4,6 +4,6 @@ Every theme ships with its own set of backgrounds, and you can add extras of you You can do this most easily by going to _Install > Style > Background_ in the Omarchy Menu. That'll bring up the folder where the backgrounds for that theme is stored. Hit `Super + Shift + F` to start another file manager, find your background, copy it over. Now it'll be included in the choices of backgrounds you can select between using `Super + Ctrl + Space`. -Backgrounds can be videos as well as stills. Drop an `mp4`, `m4v`, `mov`, `webm`, `mkv`, or `avi` file in the same folder and it appears alongside the images, playing on a loop. Only your first monitor's wallpaper plays a video's sound track, through the default audio output at the system volume, and the lock screen stays silent. Playback stops on its own whenever nothing can see it — while a fullscreen window covers that monitor, while the screensaver is up, and once a locked screen has gone dark — but a video wallpaper still costs far more power than a still one, and each monitor decodes its own copy. When the OWE wallpaper engine is running, it takes over video backgrounds and the shell keeps only stills. +Backgrounds can be videos as well as stills. Drop an `mp4`, `m4v`, `mov`, `webm`, `mkv`, or `avi` file in the same folder and it appears alongside the images. Videos are played by the OWE wallpaper engine. It decodes once for every monitor and keeps playback silent, and it stops playback whenever nothing can see it. The lock screen keeps its own silent playback. A video wallpaper still costs far more power than a still one. You can find a huge collection of cool curated backgrounds on https://github.com/dharmx/walls. diff --git a/shell/Ui/BackgroundMedia.qml b/shell/Ui/BackgroundMedia.qml index f3ab7743..fa6b3345 100644 --- a/shell/Ui/BackgroundMedia.qml +++ b/shell/Ui/BackgroundMedia.qml @@ -7,11 +7,9 @@ Item { property string path: "" property int version: 0 property bool playbackEnabled: true - property bool audioEnabled: false - // The desktop yields video playback to OWE while it runs, so two engines - // never decode the same file. The lock screen leaves this off and keeps its - // own playback. - property bool deferVideo: false + // The desktop turns this off because OWE owns video backgrounds. The lock + // screen leaves it on and keeps its own playback. + property bool videoEnabled: true // Bumped when the file behind an unchanged path may have been replaced. // Images cache-bust through version; a video is rebuilt, since FFmpeg // would read a query as part of the filename. @@ -27,7 +25,7 @@ Item { // Both test the path directly: going through `video` lets a URL evaluate // against the stale flag and leak the wrong file for one pass. readonly property url imageUrl: path && !Util.isVideoPath(path) ? Util.fileUrl(path) + (version ? "?v=" + version : "") : "" - readonly property url videoUrl: path && Util.isVideoPath(path) ? Util.fileUrl(path) : "" + readonly property url videoUrl: path && Util.isVideoPath(path) && videoEnabled ? Util.fileUrl(path) : "" Loader { id: imageLoader @@ -41,7 +39,7 @@ Item { Loader { id: videoLoader anchors.fill: parent - active: root.path !== "" && root.video && !root.reloading && !root.deferVideo + active: root.path !== "" && root.video && !root.reloading && root.videoEnabled source: "BackgroundVideo.qml" } @@ -68,13 +66,6 @@ Item { when: videoLoader.item !== null } - Binding { - target: videoLoader.item - property: "audioEnabled" - value: root.audioEnabled - when: videoLoader.item !== null - } - Component { id: imageComponent diff --git a/shell/Ui/BackgroundVideo.qml b/shell/Ui/BackgroundVideo.qml index 519e8bd9..0d0d34e1 100644 --- a/shell/Ui/BackgroundVideo.qml +++ b/shell/Ui/BackgroundVideo.qml @@ -1,15 +1,15 @@ import QtQuick import QtMultimedia -// Deliberately a bare MediaPlayer and VideoOutput rather than the Video -// convenience type: Video always builds an AudioOutput, and a muted sink still -// decodes the audio stream and opens an audio client on every output. +// The lock screen is the only user. Playback is always silent, so this is a +// bare MediaPlayer and VideoOutput rather than the Video convenience type: +// Video always builds an AudioOutput, and a muted sink still decodes the audio +// stream and opens an audio client. Item { id: root property url mediaSource: "" property bool playbackEnabled: true - property bool audioEnabled: false property int mediaGeneration: 0 property bool priming: false property int primingGeneration: -1 @@ -74,23 +74,12 @@ Item { fillMode: VideoOutput.PreserveAspectCrop } - // Sound is opted into per output: with a player per monitor, every output - // playing the track would layer copies of it. The sink is only built once - // the media reports a sound track, so a silent file never opens an audio - // client or its threads. Priming a paused player must not be heard. - Loader { - id: audioLoader - active: root.audioEnabled && player.hasAudio - sourceComponent: AudioOutput { - muted: root.priming || !root.playbackEnabled - } - } - + // No audio output is built, so the lock never decodes an audio stream or + // opens an audio client. MediaPlayer { id: player source: root.mediaSource videoOutput: output - audioOutput: audioLoader.item loops: MediaPlayer.Infinite autoPlay: root.playbackEnabled onMediaStatusChanged: { diff --git a/shell/plugins/background/Background.qml b/shell/plugins/background/Background.qml index 21616940..c51181ed 100644 --- a/shell/plugins/background/Background.qml +++ b/shell/plugins/background/Background.qml @@ -1,5 +1,4 @@ import Quickshell -import Quickshell.Hyprland import Quickshell.Io import Quickshell.Wayland import QtQuick @@ -28,43 +27,6 @@ Item { property string pendingShellRaw: "" property real revealProgress: 1 - // Injected by the first-party service loader; used to reach the lock and idle - // services so playback can stop whenever nothing can see the wallpaper. - property var shell: null - - // When the OWE wallpaper engine is running, it owns video backgrounds. This - // plugin keeps stills, which OWE hands back to it, and the lock screen keeps - // its own playback. The desktop video path and its pause policy stay as the - // fallback for systems without OWE. - property bool oweActive: false - - Process { - id: oweStatusProc - command: ["bash", "-c", "test -S \"${XDG_RUNTIME_DIR:-/run/user/$(id -u)}/owe/owed.sock\""] - onExited: root.oweActive = (exitCode === 0) - } - - Timer { - id: oweStatusTimer - interval: 5000 - repeat: true - running: true - onTriggered: if (!oweStatusProc.running) oweStatusProc.running = true - } - - // Stop a video wallpaper's decoding whenever it is covered. Qt's FFmpeg - // engine drives its own clock, so an unseen player keeps decoding until it - // is told not to — a locked laptop would otherwise decode until it died. - readonly property var lockService: shell && shell.services ? shell.firstPartyServiceFor("omarchy.lock") : null - readonly property var idleService: shell && shell.services ? shell.firstPartyServiceFor("omarchy.idle") : null - readonly property var batteryService: shell && shell.services ? shell.firstPartyServiceFor("omarchy.battery") : null - readonly property bool lockActive: lockService ? lockService.locked : false - readonly property bool screensaverActive: idleService ? idleService.screensaverWindowCount > 0 : false - readonly property bool powerSaverActive: batteryService ? batteryService.powerSaverOnBattery : false - // A lock or a screensaver covers every output, so it is decided once here. - // Fullscreen is decided per output below, because it only covers its own. - readonly property bool sessionObscured: lockActive || screensaverActive - function isVideo(path) { return Util.isVideoPath(path) } @@ -252,19 +214,6 @@ Item { // by pausing playback rather than by parking the layer. updatesEnabled: true - // Pausing every wallpaper for one fullscreen window would freeze the one - // still on show next to it, which costs a viewer more than it saves. The - // workspace on show here knows whether a fullscreen window covers it, - // wherever focus happens to be. - readonly property var hyprlandMonitor: Hyprland.monitorFor(modelData) - readonly property var visibleWorkspace: hyprlandMonitor ? hyprlandMonitor.activeWorkspace : null - readonly property bool fullscreenHere: visibleWorkspace ? visibleWorkspace.hasFullscreen : false - - // A sound track plays from one output only, or every monitor would - // layer its own copy of it. - readonly property bool firstScreen: Quickshell.screens.length > 0 - && String(Quickshell.screens[0].name || "") === String(modelData.name || "") - property bool maskReady: false function maybeStartReveal() { @@ -282,14 +231,14 @@ Item { WlrLayershell.keyboardFocus: WlrKeyboardFocus.None exclusionMode: ExclusionMode.Ignore + // OWE owns video backgrounds. This layer draws stills, and stays empty + // behind a video so OWE's own layer shows through. BackgroundMedia { id: base anchors.fill: parent path: root.displayedBackground reloads: root.displayedReloads - deferVideo: root.oweActive - playbackEnabled: !root.sessionObscured && !root.powerSaverActive && !panel.fullscreenHere - audioEnabled: panel.firstScreen + videoEnabled: false onReadyChanged: { if (ready && root.finishingTransition) { root.incomingBackground = "" diff --git a/test/shell.d/video-background-test.sh b/test/shell.d/video-background-test.sh index d3591b4f..f9eab0db 100755 --- a/test/shell.d/video-background-test.sh +++ b/test/shell.d/video-background-test.sh @@ -33,7 +33,7 @@ assert( videoQml.includes('autoPlay: root.playbackEnabled') && videoQml.includes('fillMode: VideoOutput.PreserveAspectCrop') && /imageUrl: path && !Util\.isVideoPath\(path\) \? Util\.fileUrl\(path\) \+ \(version \? "\?v=" \+ version : ""\) : ""/.test(mediaQml) && - /videoUrl: path && Util\.isVideoPath\(path\) \? Util\.fileUrl\(path\) : ""/.test(mediaQml), + /videoUrl: path && Util\.isVideoPath\(path\) && videoEnabled \? Util\.fileUrl\(path\) : ""/.test(mediaQml), 'background media plays aspect-cropped videos on a loop, and hands each loader only its own kind of file' ) assert( @@ -62,16 +62,12 @@ assert( ) assert( !/^\s*Video\s*\{/m.test(videoQml) && - /property bool audioEnabled: false/.test(videoQml) && - /property bool audioEnabled: false/.test(mediaQml) && - /active: root\.audioEnabled && player\.hasAudio/.test(videoQml) && - /audioOutput: audioLoader\.item/.test(videoQml) && - /muted: root\.priming \|\| !root\.playbackEnabled/.test(videoQml) && - /property: "audioEnabled"\s*\n\s*value: root\.audioEnabled/.test(mediaQml) && - /firstScreen: Quickshell\.screens\.length > 0\s*\n\s*&& String\(Quickshell\.screens\[0\]\.name/.test(backgroundQml) && - backgroundQml.includes('audioEnabled: panel.firstScreen') && + !videoQml.includes('AudioOutput {') && + !videoQml.includes('audioOutput:') && + !mediaQml.includes('audioEnabled') && + !backgroundQml.includes('audioEnabled') && !lockQml.includes('audioEnabled'), - 'a sound track plays from the first monitor only, a silent file builds no audio output, and the lock stays quiet' + 'playback is silent everywhere, so no audio output or audio client is built' ) assert( /property: "mediaSource"[\s\S]*?when: videoLoader\.item !== null && Util\.isVideoPath\(root\.path\)\s*\n\s*restoreMode: Binding\.RestoreNone/.test(mediaQml) && @@ -88,13 +84,20 @@ assert( ) assert(backgroundQml.includes('BackgroundMedia {') && lockQml.includes('BackgroundMedia {'), 'desktop and lock screen share video-capable media rendering') assert( - backgroundQml.includes('property bool oweActive: false') && - backgroundQml.includes('/owe/owed.sock') && - /deferVideo: root\.oweActive/.test(backgroundQml) && - /property bool deferVideo: false/.test(mediaQml) && - /active: root\.path !== "" && root\.video && !root\.reloading && !root\.deferVideo/.test(mediaQml) && - !lockQml.includes('deferVideo'), - 'the desktop yields video backgrounds to OWE while it is running, and the lock keeps its own playback' + backgroundQml.includes('videoEnabled: false') && + /property bool videoEnabled: true/.test(mediaQml) && + /active: root\.path !== "" && root\.video && !root\.reloading && root\.videoEnabled/.test(mediaQml) && + !lockQml.includes('videoEnabled'), + 'the desktop hands video backgrounds to OWE, and the lock keeps its own playback' +) +assert( + !backgroundQml.includes('playbackEnabled') && + !backgroundQml.includes('sessionObscured') && + !backgroundQml.includes('fullscreenHere') && + !backgroundQml.includes('Hyprland.monitorFor') && + !backgroundQml.includes('omarchy.lock') && + !backgroundQml.includes('omarchy.battery'), + 'the desktop no longer carries the shell video pause policy' ) assert( lockQml.includes('source: wallpaper.video ? null : wallpaper') && @@ -102,20 +105,6 @@ assert( lockQml.includes('visible: wallpaper.video'), 'lock screen bypasses its image effect for video output' ) -assert( - /sessionObscured:\s*lockActive \|\| screensaverActive/.test(backgroundQml) && - backgroundQml.includes('playbackEnabled: !root.sessionObscured && !root.powerSaverActive && !panel.fullscreenHere') && - backgroundQml.includes('omarchy.lock') && - backgroundQml.includes('omarchy.idle') && - backgroundQml.includes('omarchy.battery'), - 'desktop playback stops while covered or on battery power-saver' -) -assert( - backgroundQml.includes('Hyprland.monitorFor(modelData)') && - /fullscreenHere: visibleWorkspace \? visibleWorkspace\.hasFullscreen : false/.test(backgroundQml) && - !backgroundQml.includes('ToplevelManager.activeToplevel'), - 'a fullscreen window pauses only the output it covers, wherever focus is' -) assert( /if \(displayedBackground === finalPath\) displayedReloads \+= 1/.test(backgroundQml) && backgroundQml.includes('reloads: root.displayedReloads') && From 831626daea4acaaf745d336937da30d411cde635 Mon Sep 17 00:00:00 2001 From: Bjarne Oeverli <1419214+bjarneo@users.noreply.github.com> Date: Fri, 18 Sep 2026 21:02:01 +0200 Subject: [PATCH 14/36] Note that OWE plays the desktop video audio --- manual/39-backgrounds.md | 2 +- test/shell.d/video-background-test.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/manual/39-backgrounds.md b/manual/39-backgrounds.md index 7670ea61..6629ef27 100644 --- a/manual/39-backgrounds.md +++ b/manual/39-backgrounds.md @@ -4,6 +4,6 @@ Every theme ships with its own set of backgrounds, and you can add extras of you You can do this most easily by going to _Install > Style > Background_ in the Omarchy Menu. That'll bring up the folder where the backgrounds for that theme is stored. Hit `Super + Shift + F` to start another file manager, find your background, copy it over. Now it'll be included in the choices of backgrounds you can select between using `Super + Ctrl + Space`. -Backgrounds can be videos as well as stills. Drop an `mp4`, `m4v`, `mov`, `webm`, `mkv`, or `avi` file in the same folder and it appears alongside the images. Videos are played by the OWE wallpaper engine. It decodes once for every monitor and keeps playback silent, and it stops playback whenever nothing can see it. The lock screen keeps its own silent playback. A video wallpaper still costs far more power than a still one. +Backgrounds can be videos as well as stills. Drop an `mp4`, `m4v`, `mov`, `webm`, `mkv`, or `avi` file in the same folder and it appears alongside the images. Videos are played by the OWE wallpaper engine. It decodes once for every monitor and plays the video's sound through the default audio output, and it stops playback whenever nothing can see it. The lock screen keeps its own silent playback. A video wallpaper still costs far more power than a still one. You can find a huge collection of cool curated backgrounds on https://github.com/dharmx/walls. diff --git a/test/shell.d/video-background-test.sh b/test/shell.d/video-background-test.sh index f9eab0db..12653721 100755 --- a/test/shell.d/video-background-test.sh +++ b/test/shell.d/video-background-test.sh @@ -67,7 +67,7 @@ assert( !mediaQml.includes('audioEnabled') && !backgroundQml.includes('audioEnabled') && !lockQml.includes('audioEnabled'), - 'playback is silent everywhere, so no audio output or audio client is built' + 'the shell builds no audio output: OWE plays the desktop video audio and the lock stays silent' ) assert( /property: "mediaSource"[\s\S]*?when: videoLoader\.item !== null && Util\.isVideoPath\(root\.path\)\s*\n\s*restoreMode: Binding\.RestoreNone/.test(mediaQml) && From 2e3142a105cfce2f4c06036c84c6bf96a056d92f Mon Sep 17 00:00:00 2001 From: Bjarne Oeverli <1419214+bjarneo@users.noreply.github.com> Date: Fri, 18 Sep 2026 21:28:04 +0200 Subject: [PATCH 15/36] Point the owe package note at the omarchy-pkgs pull request --- install/omarchy-base.packages | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/install/omarchy-base.packages b/install/omarchy-base.packages index 634b72aa..0ec925d0 100644 --- a/install/omarchy-base.packages +++ b/install/omarchy-base.packages @@ -107,8 +107,9 @@ python-poetry-core ttfx qemu-user-static-binfmt qrencode -# TODO: add owe-wallpaper-engine here once it is packaged. The shell keeps -# stills and the lock screen, and OWE owns desktop video backgrounds. +# TODO: add owe here once omarchy-pkgs#519 lands. The shell keeps stills and +# the lock screen, and OWE owns desktop video backgrounds. Version 0.1.1 or +# newer plays the video's audio. qt6-imageformats qt6-multimedia qt6-multimedia-ffmpeg From eff410f91e4c54b932db03670883706ca9e5c498 Mon Sep 17 00:00:00 2001 From: Bjarne Oeverli <1419214+bjarneo@users.noreply.github.com> Date: Fri, 18 Sep 2026 22:49:47 +0200 Subject: [PATCH 16/36] Draw the lock screen video from the OWE lock feed The shell drops its own player: BackgroundMedia is image-only, and the lock loads Owe.LockFeedSurface through a Loader, so a system without the module shows no lock video instead of losing the whole lock screen. The feed pauses per output when the panel blanks or power saver turns on. The lock view keeps its still effect path and darkens the feed for legibility. QtMultimedia and the shell video pause policy are gone, and the base package list requires owe and owe-lockfeed instead. --- install/omarchy-base.packages | 8 +- shell/Ui/BackgroundMedia.qml | 56 ++---------- shell/Ui/BackgroundVideo.qml | 111 ------------------------ shell/Ui/qmldir | 1 - shell/plugins/background/Background.qml | 7 -- shell/plugins/lock/LockFeedSurface.qml | 11 +++ shell/plugins/lock/LockView.qml | 35 ++++++-- test/shell.d/video-background-test.sh | 111 ++++++++++-------------- 8 files changed, 92 insertions(+), 248 deletions(-) delete mode 100644 shell/Ui/BackgroundVideo.qml create mode 100644 shell/plugins/lock/LockFeedSurface.qml diff --git a/install/omarchy-base.packages b/install/omarchy-base.packages index 0ec925d0..c292828f 100644 --- a/install/omarchy-base.packages +++ b/install/omarchy-base.packages @@ -107,12 +107,10 @@ python-poetry-core ttfx qemu-user-static-binfmt qrencode -# TODO: add owe here once omarchy-pkgs#519 lands. The shell keeps stills and -# the lock screen, and OWE owns desktop video backgrounds. Version 0.1.1 or -# newer plays the video's audio. +# OWE owns desktop video backgrounds and feeds the lock screen its frames. +owe +owe-lockfeed qt6-imageformats -qt6-multimedia -qt6-multimedia-ffmpeg quickshell ripgrep ruby diff --git a/shell/Ui/BackgroundMedia.qml b/shell/Ui/BackgroundMedia.qml index fa6b3345..aabde8d1 100644 --- a/shell/Ui/BackgroundMedia.qml +++ b/shell/Ui/BackgroundMedia.qml @@ -1,31 +1,19 @@ import QtQuick import qs.Commons +// The shell draws stills only. OWE owns video backgrounds on the desktop, and +// it feeds the lock screen through its own socket. Item { id: root property string path: "" property int version: 0 - property bool playbackEnabled: true - // The desktop turns this off because OWE owns video backgrounds. The lock - // screen leaves it on and keeps its own playback. - property bool videoEnabled: true - // Bumped when the file behind an unchanged path may have been replaced. - // Images cache-bust through version; a video is rebuilt, since FFmpeg - // would read a query as part of the filename. - property int reloads: 0 - property bool reloading: false - readonly property var current: video ? videoLoader.item : imageLoader.item + readonly property var current: imageLoader.item readonly property bool ready: current ? current.ready : false readonly property bool video: Util.isVideoPath(path) - // Cache-bust images selected in a running lock session. FFmpeg treats the - // query as part of a local filename, so videos must keep their plain URL. - // Each URL is empty for the other kind, so a switch never hands the still - // loader a video, or the player a still, in the moment before it unloads. - // Both test the path directly: going through `video` lets a URL evaluate - // against the stale flag and leak the wrong file for one pass. - readonly property url imageUrl: path && !Util.isVideoPath(path) ? Util.fileUrl(path) + (version ? "?v=" + version : "") : "" - readonly property url videoUrl: path && Util.isVideoPath(path) && videoEnabled ? Util.fileUrl(path) : "" + // Cache-bust images selected in a running lock session, so a theme switch + // that replaces the file behind an unchanged path shows the new pixels. + readonly property url imageUrl: path && !video ? Util.fileUrl(path) + (version ? "?v=" + version : "") : "" Loader { id: imageLoader @@ -34,38 +22,6 @@ Item { sourceComponent: imageComponent } - // Loaded by URL rather than from a Component here, so QtMultimedia and its - // audio dependency closure never map into a session that only shows images. - Loader { - id: videoLoader - anchors.fill: parent - active: root.path !== "" && root.video && !root.reloading && root.videoEnabled - source: "BackgroundVideo.qml" - } - - onReloadsChanged: { - if (!video) return - reloading = true - Qt.callLater(function() { root.reloading = false }) - } - - // A player on its way out keeps its source: pushing an empty one starts a - // load of nothing that its destructor then cancels, which FFmpeg logs. - Binding { - target: videoLoader.item - property: "mediaSource" - value: root.videoUrl - when: videoLoader.item !== null && Util.isVideoPath(root.path) - restoreMode: Binding.RestoreNone - } - - Binding { - target: videoLoader.item - property: "playbackEnabled" - value: root.playbackEnabled - when: videoLoader.item !== null - } - Component { id: imageComponent diff --git a/shell/Ui/BackgroundVideo.qml b/shell/Ui/BackgroundVideo.qml deleted file mode 100644 index 0d0d34e1..00000000 --- a/shell/Ui/BackgroundVideo.qml +++ /dev/null @@ -1,111 +0,0 @@ -import QtQuick -import QtMultimedia - -// The lock screen is the only user. Playback is always silent, so this is a -// bare MediaPlayer and VideoOutput rather than the Video convenience type: -// Video always builds an AudioOutput, and a muted sink still decodes the audio -// stream and opens an audio client. -Item { - id: root - - property url mediaSource: "" - property bool playbackEnabled: true - property int mediaGeneration: 0 - property bool priming: false - property int primingGeneration: -1 - property bool frameReceived: false - readonly property bool ready: player.hasVideo - - onMediaSourceChanged: { - mediaGeneration += 1 - priming = false - primingGeneration = -1 - frameReceived = false - primePauseTimer.stop() - framePauseTimer.stop() - output.clearOutput() - } - - onPlaybackEnabledChanged: { - priming = false - frameReceived = false - primePauseTimer.stop() - framePauseTimer.stop() - if (playbackEnabled) player.play() - else player.pause() - } - - function pauseAfterPrimedFrame() { - if (!priming - || root.playbackEnabled - || primingGeneration !== root.mediaGeneration) return - - priming = false - primePauseTimer.stop() - framePauseTimer.stop() - player.pause() - } - - // A paused MediaPlayer can load a source without presenting its first frame. - // Prime it until VideoOutput receives a frame, with a timeout so a stalled - // decoder cannot keep running indefinitely on battery. - Timer { - id: primePauseTimer - interval: 1000 - repeat: false - - onTriggered: root.pauseAfterPrimedFrame() - } - - // Receiving a frame means the decoder has produced it, but the scene graph - // may not have committed it yet. Give VideoOutput a render cycle before - // pausing so the first frame is not lost on a source switch. - Timer { - id: framePauseTimer - interval: 50 - repeat: false - - onTriggered: root.pauseAfterPrimedFrame() - } - - VideoOutput { - id: output - anchors.fill: parent - fillMode: VideoOutput.PreserveAspectCrop - } - - // No audio output is built, so the lock never decodes an audio stream or - // opens an audio client. - MediaPlayer { - id: player - source: root.mediaSource - videoOutput: output - loops: MediaPlayer.Infinite - autoPlay: root.playbackEnabled - onMediaStatusChanged: { - if (mediaStatus !== MediaPlayer.LoadedMedia) return - - if (!root.playbackEnabled) { - root.priming = true - root.primingGeneration = root.mediaGeneration - root.frameReceived = false - primePauseTimer.restart() - } - player.play() - } - } - - Connections { - target: output.videoSink - function onVideoFrameChanged() { - if (player.mediaStatus !== MediaPlayer.BufferedMedia) return - if (!root.priming - || root.playbackEnabled - || root.primingGeneration !== root.mediaGeneration - || root.frameReceived) return - - root.frameReceived = true - framePauseTimer.restart() - } - } -} diff --git a/shell/Ui/qmldir b/shell/Ui/qmldir index 092caf6c..464e25b7 100644 --- a/shell/Ui/qmldir +++ b/shell/Ui/qmldir @@ -4,7 +4,6 @@ BarIndicator 1.0 BarIndicator.qml BarIconButton 1.0 BarIconButton.qml BarWidget 1.0 BarWidget.qml BackgroundMedia 1.0 BackgroundMedia.qml -BackgroundVideo 1.0 BackgroundVideo.qml BorderOverlay 1.0 BorderOverlay.qml BorderSurface 1.0 BorderSurface.qml Button 1.0 Button.qml diff --git a/shell/plugins/background/Background.qml b/shell/plugins/background/Background.qml index c51181ed..8c113e4b 100644 --- a/shell/plugins/background/Background.qml +++ b/shell/plugins/background/Background.qml @@ -16,7 +16,6 @@ Item { property string currentBackground: "" property string displayedBackground: "" - property int displayedReloads: 0 property string incomingBackground: "" property string oldBackground: "" property bool finishingTransition: false @@ -60,9 +59,6 @@ Item { if (instant || !displayedBackground || isVideo(path) || isVideo(displayedBackground)) { oldBackground = "" incomingBackground = "" - // A theme switch can replace the file behind an unchanged path, which - // an unchanged property would never pick up. - if (displayedBackground === finalPath) displayedReloads += 1 displayedBackground = finalPath revealProgress = 1 return @@ -187,7 +183,6 @@ Item { } Component.onCompleted: { - oweStatusProc.running = true refreshBackground() } @@ -237,8 +232,6 @@ Item { id: base anchors.fill: parent path: root.displayedBackground - reloads: root.displayedReloads - videoEnabled: false onReadyChanged: { if (ready && root.finishingTransition) { root.incomingBackground = "" diff --git a/shell/plugins/lock/LockFeedSurface.qml b/shell/plugins/lock/LockFeedSurface.qml new file mode 100644 index 00000000..38bd4612 --- /dev/null +++ b/shell/plugins/lock/LockFeedSurface.qml @@ -0,0 +1,11 @@ +import QtQuick +import Owe.LockFeed + +// Loaded through a Loader from LockView, so a system without the module shows +// no lock video instead of losing the whole lock screen. +LockFeed { + id: root + + property bool feedEnabled: true + active: root.feedEnabled +} diff --git a/shell/plugins/lock/LockView.qml b/shell/plugins/lock/LockView.qml index e7a430ac..9366b289 100644 --- a/shell/plugins/lock/LockView.qml +++ b/shell/plugins/lock/LockView.qml @@ -43,6 +43,9 @@ Item { ? Border.surfaceSpec("lock", "border-error", Color.lock.borderError, root.outlineThickness, "border-alpha") : Border.surfaceSpec("lock", "border-active", Color.lock.borderActive, root.outlineThickness, "border-alpha") + readonly property bool video: Util.isVideoPath(root.backgroundPath) + readonly property bool feedActive: root.video && root.loadBackground && !root.displaysBlank && !root.powerSaverActive + signal submitPassword(string password) signal passwordTextEdited(string password) signal clearFailureRequested() @@ -89,15 +92,33 @@ Item { BackgroundMedia { id: wallpaper anchors.fill: parent - path: root.loadBackground ? root.backgroundPath : "" + path: root.video ? "" : root.backgroundPath version: root.backgroundVersion - playbackEnabled: root.loadBackground && !root.displaysBlank && !root.powerSaverActive + visible: !root.video + } + + // OWE decodes the video once and feeds these frames to every lock surface. + // The feed pauses when this output blanks or on battery power saver. + Loader { + id: feedLoader + anchors.fill: parent + active: root.video + source: "LockFeedSurface.qml" + visible: status === Loader.Ready + + Binding { + target: feedLoader.item + property: "feedEnabled" + value: root.feedActive + when: feedLoader.item !== null + restoreMode: Binding.RestoreNone + } } MultiEffect { anchors.fill: wallpaper - source: wallpaper.video ? null : wallpaper - visible: !wallpaper.video + source: root.video ? null : wallpaper + visible: !root.video autoPaddingEnabled: false blurEnabled: root.loadBackground && wallpaper.ready blur: 1.0 @@ -106,11 +127,11 @@ Item { contrast: -0.08 } - // Qt's video output cannot be sampled by MultiEffect on every renderer. + // The feed item cannot be sampled by MultiEffect on every renderer. // Keep video wallpapers visible and darken them slightly for legibility. Rectangle { - anchors.fill: wallpaper - visible: wallpaper.video + anchors.fill: feedLoader + visible: root.video color: "#22000000" } diff --git a/test/shell.d/video-background-test.sh b/test/shell.d/video-background-test.sh index 12653721..31ac754d 100755 --- a/test/shell.d/video-background-test.sh +++ b/test/shell.d/video-background-test.sh @@ -9,15 +9,13 @@ const fs = require('fs') const utilQml = fs.readFileSync(path.join(root, 'shell/Commons/Util.qml'), 'utf8') const mediaQml = fs.readFileSync(path.join(root, 'shell/Ui/BackgroundMedia.qml'), 'utf8') -const videoQml = fs.readFileSync(path.join(root, 'shell/Ui/BackgroundVideo.qml'), 'utf8') const backgroundQml = fs.readFileSync(path.join(root, 'shell/plugins/background/Background.qml'), 'utf8') const lockQml = fs.readFileSync(path.join(root, 'shell/plugins/lock/LockView.qml'), 'utf8') +const lockFeedQml = fs.readFileSync(path.join(root, 'shell/plugins/lock/LockFeedSurface.qml'), 'utf8') const themeSwitcher = fs.readFileSync(path.join(root, 'bin/omarchy-theme-switcher'), 'utf8') const quattroUpgrade = fs.readFileSync(path.join(root, 'bin/omarchy-upgrade-to-quattro'), 'utf8') -const multimediaMigration = fs.readFileSync(path.join(root, 'migrations/1786609204.sh'), 'utf8') const barTextColor = fs.readFileSync(path.join(root, 'bin/omarchy-bar-text-color'), 'utf8') const menuImages = fs.readFileSync(path.join(root, 'bin/omarchy-menu-images'), 'utf8') -const lockView = fs.readFileSync(path.join(root, 'shell/plugins/lock/LockView.qml'), 'utf8') const lockService = fs.readFileSync(path.join(root, 'shell/plugins/lock/Service.qml'), 'utf8') const batteryService = fs.readFileSync(path.join(root, 'shell/plugins/services/battery/Service.qml'), 'utf8') const themeSet = fs.readFileSync(path.join(root, 'bin/omarchy-theme-set'), 'utf8') @@ -29,50 +27,45 @@ assert( 'shared media helper identifies video paths without truncating valid local names' ) assert( - videoQml.includes('loops: MediaPlayer.Infinite') && - videoQml.includes('autoPlay: root.playbackEnabled') && - videoQml.includes('fillMode: VideoOutput.PreserveAspectCrop') && - /imageUrl: path && !Util\.isVideoPath\(path\) \? Util\.fileUrl\(path\) \+ \(version \? "\?v=" \+ version : ""\) : ""/.test(mediaQml) && - /videoUrl: path && Util\.isVideoPath\(path\) && videoEnabled \? Util\.fileUrl\(path\) : ""/.test(mediaQml), - 'background media plays aspect-cropped videos on a loop, and hands each loader only its own kind of file' + !fs.existsSync(path.join(root, 'shell/Ui/BackgroundVideo.qml')), + 'the shell keeps no video player of its own' ) assert( - videoQml.includes('MediaPlayer.LoadedMedia') && - videoQml.includes('primePauseTimer') && - videoQml.includes('mediaGeneration') && - videoQml.includes('videoSink') && - videoQml.includes('onVideoFrameChanged') && - videoQml.includes('MediaPlayer.BufferedMedia') && - videoQml.includes('mediaStatus !== MediaPlayer.BufferedMedia') && - videoQml.includes('interval: 1000') && - videoQml.includes('interval: 50') && - videoQml.includes('frameReceived') && - videoQml.includes('output.clearOutput()') && - !videoQml.includes('KeepLastFrame') && - /onPlaybackEnabledChanged:[\s\S]*?if \(playbackEnabled\) player\.play\(\)[\s\S]*?else player\.pause\(\)/.test(videoQml) && - videoQml.includes('primingGeneration') && - videoQml.includes('player.play()') && - videoQml.includes('player.pause()'), - 'paused video sources are primed to display their first frame' + /imageUrl: path && !video \? Util\.fileUrl\(path\) \+ \(version \? "\?v=" \+ version : ""\) : ""/.test(mediaQml) && + /active: root\.path !== "" && !root\.video/.test(mediaQml) && + !mediaQml.includes('videoUrl') && + !mediaQml.includes('videoLoader') && + !mediaQml.includes('videoEnabled'), + 'background media is image-only: it loads stills and leaves videos to OWE' ) assert( !/^\s*import QtMultimedia/m.test(mediaQml) && - mediaQml.includes('source: "BackgroundVideo.qml"'), - 'the still-image path never imports QtMultimedia, so image-only sessions do not map it' + !/^\s*import QtMultimedia/m.test(backgroundQml) && + !/^\s*import QtMultimedia/m.test(lockQml) && + !backgroundQml.includes('MediaPlayer') && + !lockQml.includes('MediaPlayer'), + 'no shell surface builds a Qt Multimedia pipeline' ) assert( - !/^\s*Video\s*\{/m.test(videoQml) && - !videoQml.includes('AudioOutput {') && - !videoQml.includes('audioOutput:') && - !mediaQml.includes('audioEnabled') && - !backgroundQml.includes('audioEnabled') && - !lockQml.includes('audioEnabled'), - 'the shell builds no audio output: OWE plays the desktop video audio and the lock stays silent' + /^import Owe\.LockFeed$/m.test(lockFeedQml) && + lockFeedQml.includes('LockFeed {') && + lockFeedQml.includes('active: root.feedEnabled') && + lockQml.includes('source: "LockFeedSurface.qml"') && + lockQml.includes('active: root.video') && + /feedActive: root\.video && root\.loadBackground && !root\.displaysBlank && !root\.powerSaverActive/.test(lockQml) && + /property: "feedEnabled"[\s\S]*?value: root\.feedActive/.test(lockQml), + 'the lock screen shows video through the OWE lock feed, loaded so a missing module costs only the video' ) assert( - /property: "mediaSource"[\s\S]*?when: videoLoader\.item !== null && Util\.isVideoPath\(root\.path\)\s*\n\s*restoreMode: Binding\.RestoreNone/.test(mediaQml) && - !videoQml.includes('Component.onDestruction'), - 'a player on its way out keeps its source, so nothing is left loading for its destructor to cancel' + !/^import Owe\./m.test(lockQml), + 'the lock view itself carries no foreign import, so the lock still loads without the feed module' +) +assert( + lockQml.includes('path: root.video ? "" : root.backgroundPath') && + lockQml.includes('visible: !root.video') && + lockQml.includes('visible: root.video') && + !lockQml.includes('wallpaper.video'), + 'the lock screen keeps its image effect for stills and shows the feed for videos' ) assert( !mediaQml.includes('mipmap'), @@ -82,13 +75,12 @@ assert( /instant \|\| !displayedBackground \|\| isVideo\(path\) \|\| isVideo\(displayedBackground\)[\s\S]*displayedBackground = finalPath/.test(backgroundQml), 'video switches bypass the image-only reveal stack and use the durable background path' ) -assert(backgroundQml.includes('BackgroundMedia {') && lockQml.includes('BackgroundMedia {'), 'desktop and lock screen share video-capable media rendering') +assert(backgroundQml.includes('BackgroundMedia {') && lockQml.includes('BackgroundMedia {'), 'desktop and lock screen share still rendering') assert( - backgroundQml.includes('videoEnabled: false') && - /property bool videoEnabled: true/.test(mediaQml) && - /active: root\.path !== "" && root\.video && !root\.reloading && root\.videoEnabled/.test(mediaQml) && - !lockQml.includes('videoEnabled'), - 'the desktop hands video backgrounds to OWE, and the lock keeps its own playback' + !backgroundQml.includes('videoEnabled') && + !backgroundQml.includes('displayedReloads') && + !mediaQml.includes('displayedReloads'), + 'the desktop hands video backgrounds to OWE with no player switch to carry' ) assert( !backgroundQml.includes('playbackEnabled') && @@ -99,19 +91,6 @@ assert( !backgroundQml.includes('omarchy.battery'), 'the desktop no longer carries the shell video pause policy' ) -assert( - lockQml.includes('source: wallpaper.video ? null : wallpaper') && - lockQml.includes('visible: !wallpaper.video') && - lockQml.includes('visible: wallpaper.video'), - 'lock screen bypasses its image effect for video output' -) -assert( - /if \(displayedBackground === finalPath\) displayedReloads \+= 1/.test(backgroundQml) && - backgroundQml.includes('reloads: root.displayedReloads') && - /active: root\.path !== "" && root\.video && !root\.reloading/.test(mediaQml) && - /onReloadsChanged: \{[\s\S]*?reloading = true/.test(mediaQml), - 'a theme switch that keeps the video path still reopens the replaced file' -) assert( barTextColor.includes('magick "$background_path[0]"'), 'bar colour sampling reads one frame instead of decoding a whole video' @@ -161,13 +140,12 @@ assert( 'a locked video wallpaper follows what each panel actually did, not only what the lock asked for' ) assert( - lockView.includes('playbackEnabled: root.loadBackground && !root.displaysBlank') && - lockView.includes('&& !root.powerSaverActive') && + /feedActive: root\.video && root\.loadBackground && !root\.displaysBlank && !root\.powerSaverActive/.test(lockQml) && /displaysBlank: root\.screenBlank\(/.test(lockService) && /powerSaverActive: root\.powerSaverActive/.test(lockService) && /function runBlank\(\) \{\s*\n\s*root\.displaysBlank = true/.test(lockService) && /function runWake\(\) \{\s*\n\s*root\.displaysBlank = false/.test(lockService), - 'the lock screen stops playback once displays go dark or power-saver is active' + 'the lock feed stops once displays go dark or power-saver is active' ) assert( batteryService.includes('property string activePowerProfile') && @@ -184,10 +162,6 @@ assert( 'theme switcher previews video-only themes, named preview files included' ) assert(quattroUpgrade.includes("-iname '*.mp4'"), 'Quattro upgrade can seed a video-only theme background') -assert( - multimediaMigration.includes('omarchy-pkg-add qt6-multimedia qt6-multimedia-ffmpeg'), - 'existing Quattro installations receive video playback dependencies' -) JS test_tmp=$(mktemp -d) @@ -301,8 +275,11 @@ timeout_rows=$(PATH="$test_tmp/bin:$PATH" XDG_CACHE_HOME="$timeout_cache" \ timeout_marker=$(find "$timeout_cache/omarchy/image-selector" -maxdepth 1 -type f -name '*.failed' -print -quit) [[ -z $timeout_marker ]] || fail "a timed out video is left to retry rather than remembered as failed" -grep -qx 'qt6-multimedia' "$ROOT/install/omarchy-base.packages" || fail "Qt Multimedia runtime is a base package" -grep -qx 'qt6-multimedia-ffmpeg' "$ROOT/install/omarchy-base.packages" || fail "Qt Multimedia FFmpeg backend is a base package" +grep -qx 'owe' "$ROOT/install/omarchy-base.packages" || fail "OWE is a base package" +grep -qx 'owe-lockfeed' "$ROOT/install/omarchy-base.packages" || fail "the OWE lock feed module is a base package" +if grep -qx 'qt6-multimedia' "$ROOT/install/omarchy-base.packages"; then + fail "Qt Multimedia is no longer needed by the shell" +fi pass "menu image generator creates thumbnails consumed by the picker" pass "direct picker generates and reuses still thumbnails" @@ -310,7 +287,7 @@ pass "direct picker omits videos whose thumbnails cannot be generated" pass "a rejected video is remembered so it costs nothing on the next open" pass "a timed out video is left to retry" pass "a locked video wallpaper follows the panels' real DPMS state" -pass "Qt Multimedia playback dependencies are declared" +pass "OWE and its lock feed module are declared" source <(awk ' /^(is_video_path|snapshot_background_path|background_transition_uses_snapshots|choose_theme_background|choose_staged_theme_background|set_theme_background)\(\) \{/ { copying=1 } From b0bf4876b10619743e5b93b577e19a37cbbe45cc Mon Sep 17 00:00:00 2001 From: Bjarne Oeverli <1419214+bjarneo@users.noreply.github.com> Date: Fri, 18 Sep 2026 22:55:27 +0200 Subject: [PATCH 17/36] Describe the lock feed in the background manual --- manual/39-backgrounds.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manual/39-backgrounds.md b/manual/39-backgrounds.md index 6629ef27..f57d23d2 100644 --- a/manual/39-backgrounds.md +++ b/manual/39-backgrounds.md @@ -4,6 +4,6 @@ Every theme ships with its own set of backgrounds, and you can add extras of you You can do this most easily by going to _Install > Style > Background_ in the Omarchy Menu. That'll bring up the folder where the backgrounds for that theme is stored. Hit `Super + Shift + F` to start another file manager, find your background, copy it over. Now it'll be included in the choices of backgrounds you can select between using `Super + Ctrl + Space`. -Backgrounds can be videos as well as stills. Drop an `mp4`, `m4v`, `mov`, `webm`, `mkv`, or `avi` file in the same folder and it appears alongside the images. Videos are played by the OWE wallpaper engine. It decodes once for every monitor and plays the video's sound through the default audio output, and it stops playback whenever nothing can see it. The lock screen keeps its own silent playback. A video wallpaper still costs far more power than a still one. +Backgrounds can be videos as well as stills. Drop an `mp4`, `m4v`, `mov`, `webm`, `mkv`, or `avi` file in the same folder and it appears alongside the images. Videos are played by the OWE wallpaper engine. It decodes the video once for all monitors and plays its sound through the default audio output, and it stops playback whenever nothing can see it. The lock screen draws the same decode, muted, through OWE. A video wallpaper still costs far more power than a still one. You can find a huge collection of cool curated backgrounds on https://github.com/dharmx/walls. From 9e3ff71f4805a4deb20605c5178a78dce7c578b9 Mon Sep 17 00:00:00 2001 From: Spencer Bull Date: Sat, 19 Sep 2026 00:00:15 -0500 Subject: [PATCH 18/36] Simplify Elsewhen installation and bar migration Link the package into the existing plugin directory and let bar put handle enablement, clock-relative placement, and the missing-clock fallback. Preserve user checkouts and existing placements, and seed the same link for new users. This removes the Atreyu packaged-discovery prerequisite and the checkout cleanup and JSON rewrite machinery. --- config/omarchy/plugins/omacom.elsewhen | 1 + default/agents/skills/omarchy/plugins.md | 3 - docs/file-layout.md | 3 - docs/omarchy-shell.md | 4 +- migrations/1789581661.sh | 89 +--- shell/README.md | 5 - shell/plugins/README.md | 6 +- test/shell.d/config-test.sh | 4 +- .../elsewhen-default-migration-test.sh | 382 +++--------------- 9 files changed, 61 insertions(+), 436 deletions(-) create mode 120000 config/omarchy/plugins/omacom.elsewhen diff --git a/config/omarchy/plugins/omacom.elsewhen b/config/omarchy/plugins/omacom.elsewhen new file mode 120000 index 00000000..19840c51 --- /dev/null +++ b/config/omarchy/plugins/omacom.elsewhen @@ -0,0 +1 @@ +/usr/share/omarchy/plugins/omacom.elsewhen \ No newline at end of file diff --git a/default/agents/skills/omarchy/plugins.md b/default/agents/skills/omarchy/plugins.md index 1c58c83a..6e3ab069 100644 --- a/default/agents/skills/omarchy/plugins.md +++ b/default/agents/skills/omarchy/plugins.md @@ -9,12 +9,9 @@ inside a single long-running Quickshell process (`omarchy-shell`). ``` ~/.config/omarchy/shell.json # User overrides: bar, plugins, idle ~/.config/omarchy/plugins// # User-owned shell plugins -/usr/share/omarchy/plugins// # Packaged plugins (pacman), e.g. omacom.elsewhen $OMARCHY_PATH/config/omarchy/shell.json # Canonical defaults ``` -Packaged plugins such as Elsewhen (`elsewhen` package) update with `omarchy update` and are removed with pacman; `omarchy plugin update` and `omarchy plugin remove` refuse them and name the package. - The shell hot-reloads `shell.json` on save — no restart needed for layout changes. `idle.screensaver` and `idle.lock` are seconds since user idle began. diff --git a/docs/file-layout.md b/docs/file-layout.md index 8bbcd5b2..f261085f 100644 --- a/docs/file-layout.md +++ b/docs/file-layout.md @@ -78,9 +78,6 @@ install/** ──► omarchy /usr/share/omarchy migrations/** ──► omarchy /usr/share/omarchy/migrations/ themes/** ──► omarchy /usr/share/omarchy/themes/ shell/** ──► omarchy /usr/share/omarchy/shell/ - (packaged plugins from their own - packages, e.g. elsewhen, land beside it - in /usr/share/omarchy/plugins//) version ──► omarchy /usr/share/omarchy/version + /etc/skel/.local/state/omarchy/migrations/* diff --git a/docs/omarchy-shell.md b/docs/omarchy-shell.md index dd8cc18a..6e999682 100644 --- a/docs/omarchy-shell.md +++ b/docs/omarchy-shell.md @@ -88,9 +88,9 @@ bar from the CLI — `use | reset | defaults | position | transparent | put | move | set`, with placement flags such as `--section` and `--index`. The lower-level IPC methods remain available through `omarchy-shell shell ...`. -## Packaged plugins +## Elsewhen -A default plugin can ship as its own Arch package instead of in the Omarchy checkout: Elsewhen (`omacom.elsewhen`) is the `elsewhen` package. pacman installs it at `/usr/share/omarchy/plugins//`, a root the shell scans between `$OMARCHY_PATH/shell/plugins` and `~/.config/omarchy/plugins`. A packaged `omarchy.*` id is trusted like a bundled plugin and loads by default; any other packaged id behaves like an installed plugin. Precedence is bundled, then packaged, then user, so a checkout under `omarchy dev link` overrides the package. Packaged plugins update through `omarchy update` and leave through pacman; `omarchy plugin update` and `omarchy plugin remove` refuse them and name the package, and Setup › Plugins › Remove does not list them. +Elsewhen (`omacom.elsewhen`) ships in the `elsewhen` package at `/usr/share/omarchy/plugins/omacom.elsewhen`. A symlink in `~/.config/omarchy/plugins/` makes it available to the shell. New installs place it immediately before the clock; the migration uses `omarchy bar put omacom.elsewhen --before omarchy.clock`, which preserves an existing placement and uses Elsewhen's normal right-side placement if the clock is absent. Existing plugin directories and symlinks are left intact. ## IPC diff --git a/migrations/1789581661.sh b/migrations/1789581661.sh index f581d4d0..10f18e66 100644 --- a/migrations/1789581661.sh +++ b/migrations/1789581661.sh @@ -1,88 +1,13 @@ echo "Install Elsewhen, the world clock plugin" -# Elsewhen ships as the elsewhen package rather than in this checkout; pacman -# puts it under /usr/share/omarchy/plugins, where the shell looks next to its -# bundled plugins. A package the mirror does not carry yet fails the migration -# on purpose: nothing before this line has changed anything, and the runner -# retries it on the next update or login rather than quietly leaving the -# machine without the plugin. omarchy-pkg-add elsewhen -# A shell that already knows the packaged root (dev-linked, or restarted -# since) picks the plugin up here; the one an update runs under predates it -# and is replaced by omarchy-update-restart right after the migrations. -omarchy-shell -q shell rescanPlugins || true - -# Before the package, the README had users run -# `omarchy plugin add https://github.com/omacom/elsewhen.git`, which left a -# git clone under ~/.config/omarchy/plugins. The packaged copy now shadows -# it: the shell logs a rejection on every scan, and `omarchy plugin update` -# keeps pulling a checkout nothing loads. A pristine clone of the upstream -# repo is retired the way `omarchy plugin remove` retires one (the repo -# remains upstream). Anything else -- a symlink, a plain directory, local -# changes, a fork, a checkout git cannot read -- is the user's and stays. This -# runs only once the package is in place, so the plugin never leaves a -# machine; its id stays in shell.json either way, which is what keeps it -# enabled. The shell an update runs under predates the packaged root, and it -# watches this directory: dropping the checkout empties the widget's slot in -# that shell until omarchy-update-restart replaces it a few steps later with -# one that finds the package. A one-time gap of a few minutes, during the -# update itself. -upstream_checkout() { - local dir="$1" origin status unpublished - [[ -d $dir && ! -L $dir && -d $dir/.git ]] || return 1 - origin=$(git -C "$dir" remote get-url origin 2>/dev/null) || return 1 - origin=${origin,,} - origin=${origin%/} - origin=${origin%.git} - [[ $origin =~ ^([a-z+]+://)?([^/@]+@)?github\.com[/:]omacom/elsewhen$ ]] || return 1 - status=$(git -C "$dir" status --porcelain --untracked-files=all --ignored 2>/dev/null) || return 1 - [[ -z $status ]] || return 1 - # Local branches, stashes, and reflogs may hold work absent from a clean tree. - unpublished=$(git -C "$dir" rev-list HEAD --all --reflog --not --remotes=origin 2>/dev/null) || return 1 - [[ -z $unpublished ]] -} - -checkout="$HOME/.config/omarchy/plugins/omacom.elsewhen" -if [[ -e $checkout || -L $checkout ]]; then - if upstream_checkout "$checkout"; then - rm -rf "$checkout" - echo "Retired the omacom.elsewhen checkout at $checkout in favour of the elsewhen package." - else - echo "The elsewhen package takes precedence over $checkout, which is left as it is." - fi +plugin="$HOME/.config/omarchy/plugins/omacom.elsewhen" +mkdir -p "$(dirname "$plugin")" +if [[ ! -e $plugin && ! -L $plugin ]]; then + ln -s /usr/share/omarchy/plugins/omacom.elsewhen "$plugin" fi -# The widget sits just before the clock in the center of the default bar, -# which a machine without a shell.json takes on as soon as the shell -# restarts. A customized bar gets the entry written into its file rather than -# placed over IPC: the shell this runs under cannot see a widget its scan -# never reached and would refuse it, whereas the file it hot-reloads carries -# the entry through to the restart. A bar that already carries the widget -# keeps it where the user put it. -source omarchy-shell-config - -[[ -s $CONFIG_FILE ]] || exit 0 -# Preserve configs whose bar comes from the shell fallback instead of an explicit layout. -jq -e 'type == "object" and .version == 1 and (.bar | type == "object") and (.bar.layout | type == "object")' "$CONFIG_FILE" >/dev/null 2>&1 || exit 0 - -entry_id='def entry_id: if type == "object" then (.id // "" | tostring) else tostring end;' - -if jq -e "$entry_id"' - any((.bar.layout // {} | .left, .center, .right | arrays)[]; entry_id == "omacom.elsewhen") -' "$CONFIG_FILE" >/dev/null; then - exit 0 -fi - -commit "$NORMALIZE | $entry_id"' - def ids: map(entry_id); - def insert_at($section; $index): - .bar.layout[$section] = .bar.layout[$section][:$index] + [{id: "omacom.elsewhen"}] + .bar.layout[$section][$index:]; - . as $config - | (["left", "center", "right"] | map(select($config.bar.layout[.] | ids | index("omarchy.clock") != null)) | first) as $section - | if $section != null then - insert_at($section; .bar.layout[$section] | ids | index("omarchy.clock")) - else - insert_at("center"; 0) - end -' +omarchy-shell shell rescanPlugins +omarchy-bar put omacom.elsewhen --before omarchy.clock +omarchy-restart-shell diff --git a/shell/README.md b/shell/README.md index 53425139..ca07b520 100644 --- a/shell/README.md +++ b/shell/README.md @@ -140,10 +140,6 @@ You can still drop a plugin in without git: `barWidget.defaultSection`, or in the center when it is omitted, and can be moved with `omarchy bar move`; a full bar replaces the one in use. -### Packaged plugins - -Some default plugins ship as their own Arch package rather than in this checkout: Elsewhen (`omacom.elsewhen`) is the `elsewhen` package. pacman installs such a plugin, root-owned, at `/usr/share/omarchy/plugins//`, and the shell scans that root between its bundled plugins and the user's. A packaged `omarchy.*` id is trusted exactly like a bundled one; a packaged plugin under any other id is treated like a user plugin. They update with `omarchy update` and are removed with pacman, so `omarchy plugin update` and `omarchy plugin remove` refuse them and name the package instead. A bundled copy in `$OMARCHY_PATH/shell/plugins` wins over the packaged one, which is how a packaged plugin is developed under `omarchy dev link`. - The lower-level IPC equivalents remain available via `omarchy-shell shell rescanPlugins`, `omarchy-shell shell enablePlugin '{}'`, and `omarchy-shell shell listPlugins`. The `omarchy plugin` commands wrap those calls. `omarchy bar move` and @@ -228,7 +224,6 @@ customization from the shipped defaults lives in it. |-----------------------------------|----------------|--------------------------------------------------------| | `~/.config/omarchy/shell.json` | the shell | full layout + per-entry settings + enabled plugin list | | `~/.config/omarchy/plugins//` | user | drop-in third-party plugin source files | -| `/usr/share/omarchy/plugins//` | pacman | packaged plugins (e.g. `elsewhen`), updated by `omarchy update` | The `config/omarchy/shell.json` default config describes the fresh-install state. When the user has no `shell.json`, the shell uses diff --git a/shell/plugins/README.md b/shell/plugins/README.md index 1a2d26fb..66cb74e1 100644 --- a/shell/plugins/README.md +++ b/shell/plugins/README.md @@ -9,10 +9,7 @@ First-party non-bar plugins are enabled unless listed in `disabledPlugins[]`; at startup; other panels, overlays, and menus are loaded on demand. User-installed plugins live alongside these conceptually but on disk under -`~/.config/omarchy/plugins//` rather than in this directory. A few -default plugins arrive as their own package instead: pacman installs them at -`/usr/share/omarchy/plugins//`, where an `omarchy.*` id is trusted -like the plugins here, and a copy in this directory shadows the packaged one. +`~/.config/omarchy/plugins//` rather than in this directory. | Plugin | id | kinds | entry point | |---------------|---------------------------|-------------------------|---------------------------------------| @@ -31,7 +28,6 @@ like the plugins here, and a copy in this directory shadows the packaged one. | Power | `omarchy.power` | `bar-widget` | `panels/power/Panel.qml` | | Tailscale | `omarchy.tailscale` | `bar-widget` | `panels/tailscale/Panel.qml` | | Agents | `omarchy.agents` | `bar-widget` | `agents/Panel.qml` | -| Elsewhen | `omacom.elsewhen` | `bar-widget` | packaged: `elsewhen` installs `/usr/share/omarchy/plugins/omacom.elsewhen/` | | Weather | `omarchy.weather` | `bar-widget` | `panels/weather/BarWidget.qml` | | Media | `omarchy.media` | `service`, `bar-widget` | `services/media/Service.qml`, `services/media/BarWidget.qml` | | Battery | `omarchy.battery` | `service` | `services/battery/Service.qml` | diff --git a/test/shell.d/config-test.sh b/test/shell.d/config-test.sh index 1cd47e33..82a51e6f 100755 --- a/test/shell.d/config-test.sh +++ b/test/shell.d/config-test.sh @@ -52,9 +52,9 @@ jq -e ' (.bar.layout.right | ids) as $ids | ($ids | index("omarchy.tray")) as $tray | ($ids | index("omarchy.agents")) as $agents | - $tray == 0 and $agents == $tray + 1 + $tray != null and $agents == $tray + 1 ' "$ROOT/config/omarchy/shell.json" >/dev/null -pass "default right layout opens with the tray, then agents" +pass "default right layout keeps agents next to the tray" ROOT="$ROOT" python3 <<'PY' import json diff --git a/test/shell.d/elsewhen-default-migration-test.sh b/test/shell.d/elsewhen-default-migration-test.sh index 525094e5..bda62fd6 100644 --- a/test/shell.d/elsewhen-default-migration-test.sh +++ b/test/shell.d/elsewhen-default-migration-test.sh @@ -3,361 +3,75 @@ set -euo pipefail source "$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)/base-test.sh" - require_command jq -require_command git -migration="$ROOT/migrations/1789581661.sh" test_dir=$(mktemp -d) trap 'rm -rf "$test_dir"' EXIT +mkdir -p "$test_dir/bin" "$test_dir/home" +export CALL_LOG="$test_dir/calls" -mkdir -p "$test_dir/bin" -export INSTALLED_PACKAGES="$test_dir/installed" CALL_LOG="$test_dir/calls" SHELL_CALLS="$test_dir/shell-calls" -# The checkout cases use the real git; keep the developer's config (signing, -# hooks, safe.directory) out of what it sees. -export GIT_CONFIG_GLOBAL=/dev/null GIT_CONFIG_NOSYSTEM=1 -export GIT_AUTHOR_NAME=test GIT_AUTHOR_EMAIL=test@example.com -export GIT_COMMITTER_NAME=test GIT_COMMITTER_EMAIL=test@example.com - -# Keep the real package helpers, but contain every pacman transaction here. -cat >"$test_dir/bin/pacman" <<'SH' +cat >"$test_dir/bin/omarchy-pkg-add" <<'SH' #!/bin/bash -case "$1" in - -Q) grep -Fxq -- "$2" "$INSTALLED_PACKAGES" ;; - -S) - [[ ${FAIL_INSTALL:-0} == 0 ]] || exit 1 - shift 3 # -S --noconfirm --needed - printf '%s\n' "$@" >>"$INSTALLED_PACKAGES" - printf '%s\n' "$@" >>"$CALL_LOG" - ;; - *) exit 1 ;; -esac +printf 'package %s\n' "$*" >>"$CALL_LOG" +exit "${PACKAGE_STATUS:-0}" SH -cat >"$test_dir/bin/sudo" <<'SH' -#!/bin/bash -[[ $1 == "pacman" ]] || exit 1 -"$@" -SH -# The migration runs under a shell that predates the packaged root, or under -# none at all, so it must only ever ask the shell for best-effort refreshes. cat >"$test_dir/bin/omarchy-shell" <<'SH' #!/bin/bash -printf '%s\n' "$*" >>"$SHELL_CALLS" -[[ $1 != "-q" ]] || exit 0 -exit "${SHELL_STATUS:-0}" +printf '%s\n' "$*" >>"$CALL_LOG" +[[ $2 != "rescanPlugins" ]] || exit "${SCAN_STATUS:-0}" +printf '%s\n' "${TEST_PUT_RESULT:-ok}" +SH +cat >"$test_dir/bin/omarchy-restart-shell" <<'SH' +#!/bin/bash +printf 'restart\n' >>"$CALL_LOG" SH chmod +x "$test_dir/bin/"* -home="$test_dir/home" -config="$home/.config/omarchy/shell.json" -checkout="$home/.config/omarchy/plugins/omacom.elsewhen" -output="$test_dir/output" -mkdir -p "$home/.config/omarchy" - +plugin="$test_dir/home/.config/omarchy/plugins/omacom.elsewhen" run_migration() { : >"$CALL_LOG" - : >"$SHELL_CALLS" - HOME="$home" OMARCHY_PATH="$ROOT" PATH="$test_dir/bin:$ROOT/bin:$PATH" \ - bash -euo pipefail "$migration" >"$output" + HOME="$test_dir/home" OMARCHY_PATH="$ROOT" PATH="$test_dir/bin:$ROOT/bin:$PATH" \ + bash -euo pipefail "$ROOT/migrations/1789581661.sh" >"$test_dir/output" 2>&1 } -ids() { - jq -c ".bar.layout.$1 | map(if type == \"object\" then .id else . end)" "$config" -} - -# ------------------------------------------------------------ package install -: >"$INSTALLED_PACKAGES" -cat >"$config" <<'JSON' -{ - "version": 1, - "bar": { - "layout": { - "left": [{ "id": "omarchy.menu" }], - "center": [{ "id": "omarchy.clock", "format": "HH:mm" }], - "right": [ - { "id": "omarchy.tray" }, - { "id": "omarchy.agents", "syncMode": "On" }, - { "id": "omarchy.power" } - ] - } - }, - "plugins": [] -} -JSON - -run_migration -grep -Fxq elsewhen "$CALL_LOG" || fail "migration installs the elsewhen package" "$(cat "$CALL_LOG")" -pass "migration installs the elsewhen package" - -[[ $(ids center) == '["omacom.elsewhen","omarchy.clock"]' && $(ids right) == '["omarchy.tray","omarchy.agents","omarchy.power"]' ]] || - fail "migration puts the widget just before the center clock" "$(cat "$config")" -pass "migration puts the widget just before the center clock" - -[[ $(jq -c '.bar.layout.right[1]' "$config") == '{"id":"omarchy.agents","syncMode":"On"}' ]] || - fail "migration keeps the settings of its neighbours" "$(cat "$config")" -[[ $(jq -c '.bar.layout.center[1]' "$config") == '{"format":"HH:mm","id":"omarchy.clock"}' ]] || - fail "migration keeps the clock settings" "$(cat "$config")" -pass "migration leaves the rest of the layout alone" - -grep -q 'shell rescanPlugins' "$SHELL_CALLS" && grep -q 'shell reloadConfig' "$SHELL_CALLS" || - fail "migration asks the running shell to rescan and reload" "$(cat "$SHELL_CALLS")" -pass "migration asks the running shell to rescan and reload" - -before=$(sha256sum "$config") -run_migration -[[ $before == $(sha256sum "$config") ]] || fail "migration is idempotent" "$(cat "$config")" -[[ ! -s $CALL_LOG ]] || fail "migration does not reinstall a present package" "$(cat "$CALL_LOG")" -pass "migration is idempotent" - -# ------------------------------------------------------------- placements -cat >"$config" <<'JSON' -{ - "version": 1, - "bar": { "layout": { "left": [], "center": ["omarchy.clock", "omarchy.tray"], "right": ["omarchy.power"] } } -} -JSON -run_migration -[[ $(ids center) == '["omacom.elsewhen","omarchy.clock","omarchy.tray"]' && $(ids right) == '["omarchy.power"]' ]] || - fail "migration reads string clock entries" "$(cat "$config")" -pass "migration reads string clock entries" - -cat >"$config" <<'JSON' -{ "version": 1, "bar": { "layout": { "right": [{ "id": "omarchy.agents" }, { "id": "omarchy.power" }] } } } -JSON -run_migration -[[ $(ids center) == '["omacom.elsewhen"]' && $(ids right) == '["omarchy.agents","omarchy.power"]' ]] || - fail "migration prepends to the center section when the clock is off the bar" "$(cat "$config")" -pass "migration prepends to the center section when the clock is off the bar" - -cat >"$config" <<'JSON' -{ - "version": 1, - "bar": { "layout": { "left": [{ "id": "omacom.elsewhen" }], "center": [], "right": [{ "id": "omarchy.tray" }, { "id": "omarchy.agents" }] } } -} -JSON -before=$(sha256sum "$config") -run_migration -[[ $before == $(sha256sum "$config") ]] || - fail "migration leaves a widget the user already placed where it is" "$(cat "$config")" -pass "migration leaves a widget the user already placed where it is" - -# A customized clock keeps its section and settings; insert only its neighbour. -for section in left right; do - jq -n --arg section "$section" '{version: 1, bar: {layout: {center: ["omarchy.weather"], ($section): ["omarchy.menu", {id: "omarchy.clock", format: "HH:mm"}]}}}' >"$config" - run_migration - [[ $(ids "$section") == '["omarchy.menu","omacom.elsewhen","omarchy.clock"]' && $(ids center) == '["omarchy.weather"]' ]] || - fail "migration follows a clock customized into $section" "$(cat "$config")" - pass "migration follows a clock customized into $section" -done - -# ------------------------------------------------------------- edge cases -rm -f "$config" -run_migration -[[ ! -e $config ]] || fail "migration writes no shell.json where the defaults apply" "$(cat "$config")" -pass "migration writes no shell.json where the defaults apply" - -for partial in \ - '{"version":1,"idle":{"lock":600}}' \ - '{"version":1,"bar":null,"idle":{"lock":600}}' \ - '{"version":1,"bar":{"position":"bottom"}}' \ - '{"bar":{"layout":{"center":["omarchy.clock"]}}}'; do - printf '%s\n' "$partial" >"$config" - before=$(sha256sum "$config") - run_migration - [[ $before == $(sha256sum "$config") ]] || fail "migration preserves fallback configuration" "$(cat "$config")" - pass "migration preserves fallback configuration: $partial" -done - -printf '{ not json' >"$config" -run_migration -[[ $(cat "$config") == '{ not json' ]] || fail "migration leaves an unparsable config untouched" "$(cat "$config")" -pass "migration leaves an unparsable config untouched" - -cat >"$config" <<'JSON' -{ "version": 1, "bar": { "layout": { "right": [{ "id": "omarchy.tray" }, { "id": "omarchy.agents" }] } } } -JSON -SHELL_STATUS=1 run_migration -[[ $(ids center) == '["omacom.elsewhen"]' && $(ids right) == '["omarchy.tray","omarchy.agents"]' ]] || - fail "migration places the widget with no shell running" "$(cat "$config")" -pass "migration places the widget with no shell running" - -# A package the mirror does not carry yet leaves the migration pending rather -# than half-done: the layout must not name a widget nothing can install. -: >"$INSTALLED_PACKAGES" -cat >"$config" <<'JSON' -{ "version": 1, "bar": { "layout": { "right": [{ "id": "omarchy.tray" }, { "id": "omarchy.agents" }] } } } -JSON -before=$(sha256sum "$config") -if FAIL_INSTALL=1 run_migration 2>/dev/null; then - fail "a failed package installation must leave the migration pending" +if PACKAGE_STATUS=1 run_migration; then + fail "package failure stops the migration" fi -[[ $before == $(sha256sum "$config") ]] || - fail "a failed package installation leaves the layout untouched" "$(cat "$config")" -pass "a failed package installation is propagated and changes nothing" +[[ ! -e $plugin && ! -L $plugin && $(cat "$CALL_LOG") == "package elsewhen" ]] || + fail "package failure leaves the plugin and shell untouched" +pass "package failure stops before linking or changing the shell" -# ------------------------------------------------- pre-package checkouts -# Users who followed the README before the package existed hold a git clone -# under ~/.config/omarchy/plugins, which the packaged copy now shadows. Only a -# clone of the upstream repo with nothing local in it is retired; everything -# else is the user's and stays, and shell.json gets the widget either way. +run_migration +[[ $(readlink "$plugin") == /usr/share/omarchy/plugins/omacom.elsewhen ]] || fail "package link is installed" +[[ $(readlink "$ROOT/config/omarchy/plugins/omacom.elsewhen") == "$(readlink "$plugin")" ]] || fail "fresh installs use the same package link" +pass "migration and fresh installs link to the package" -# A clone made by `omarchy plugin add`: one commit, the given origin, nothing -# local. Built with init rather than clone so the origin can be any URL form. -make_checkout() { - local origin="$1" - rm -rf "$checkout" - mkdir -p "$checkout" - git -C "$checkout" init -q - git -C "$checkout" remote add origin "$origin" - printf '{ "id": "omacom.elsewhen" }\n' >"$checkout/manifest.json" - printf 'import QtQuick\nItem {}\n' >"$checkout/Panel.qml" - git -C "$checkout" add -A - git -C "$checkout" commit -q -m "Elsewhen" - git -C "$checkout" update-ref refs/remotes/origin/main HEAD -} +expected=$'package elsewhen\nshell rescanPlugins\nshell putBarWidget omacom.elsewhen {"before":"omarchy.clock"}\nrestart' +[[ $(cat "$CALL_LOG") == "$expected" ]] || fail "install, scan, placement and restart run in order" "$(cat "$CALL_LOG")" +pass "real bar helper enables and places before the clock, then restarts" -reset_layout() { - cat >"$config" <<'JSON' -{ "version": 1, "bar": { "layout": { "right": [{ "id": "omarchy.tray" }, { "id": "omarchy.power" }] } } } -JSON -} +run_migration +[[ $(cat "$CALL_LOG") == "$expected" ]] || fail "migration can be rerun" +pass "migration can be rerun with its package link present" -assert_widget_placed() { - [[ $(ids center) == '["omacom.elsewhen"]' && $(ids right) == '["omarchy.tray","omarchy.power"]' ]] || - fail "$1 still gets the widget" "$(cat "$config")" -} +rm "$plugin" +mkdir "$plugin" +printf 'local work\n' >"$plugin/notes" +run_migration +[[ ! -L $plugin && $(cat "$plugin/notes") == "local work" ]] || fail "existing checkout is preserved" +pass "existing checkout and local files are preserved" -assert_retired() { - local description="$1" - [[ ! -e $checkout && ! -L $checkout ]] || fail "$description is retired" "$(ls -la "$checkout")" - grep -q 'Retired the omacom.elsewhen checkout' "$output" || fail "$description is reported as retired" "$(cat "$output")" - assert_widget_placed "$description" - pass "$description is retired" -} +rm "$plugin/notes" +rmdir "$plugin" +ln -s "$test_dir/custom-plugin" "$plugin" +run_migration +[[ $(readlink "$plugin") == "$test_dir/custom-plugin" ]] || fail "existing symlink is preserved" +pass "existing symlink is preserved, including a missing target" -assert_kept() { - local description="$1" - [[ -e $checkout || -L $checkout ]] || fail "$description is kept" - grep -q 'takes precedence over' "$output" || fail "$description is reported as shadowed" "$(cat "$output")" - assert_widget_placed "$description" - pass "$description is kept" -} - -for origin in \ - https://github.com/omacom/elsewhen.git \ - https://github.com/omacom/elsewhen \ - git@github.com:omacom/elsewhen.git \ - ssh://git@github.com/omacom/elsewhen.git \ - https://GitHub.com/Omacom/Elsewhen/; do - make_checkout "$origin" - reset_layout - run_migration - assert_retired "a pristine clone with origin $origin" +for failure in 'SCAN_STATUS=1' 'TEST_PUT_RESULT=unknown'; do + if env "$failure" HOME="$test_dir/home" OMARCHY_PATH="$ROOT" PATH="$test_dir/bin:$ROOT/bin:$PATH" \ + bash -euo pipefail "$ROOT/migrations/1789581661.sh" >"$test_dir/output" 2>&1; then + fail "$failure must leave the migration pending" + fi + pass "$failure leaves the migration pending" done - -make_checkout https://github.com/omacom/elsewhen.git -printf 'import QtQuick\nItem { id: mine }\n' >"$checkout/Panel.qml" -reset_layout -run_migration -assert_kept "a clone with a modified tracked file" -[[ $(cat "$checkout/Panel.qml") == $'import QtQuick\nItem { id: mine }' ]] || - fail "a kept clone keeps its local change" "$(cat "$checkout/Panel.qml")" -pass "a kept clone keeps its local change" - -make_checkout https://github.com/omacom/elsewhen.git -printf 'notes\n' >"$checkout/NOTES.md" -reset_layout -run_migration -assert_kept "a clone with an untracked file" - -make_checkout https://github.com/omacom/elsewhen.git -printf 'import QtQuick\nItem { id: mine }\n' >"$checkout/Panel.qml" -git -C "$checkout" add Panel.qml -git -C "$checkout" commit -q -m "Local customization" -local_commit=$(git -C "$checkout" rev-parse HEAD) -reset_layout -run_migration -assert_kept "a clean clone with an unpublished commit" -[[ $(git -C "$checkout" rev-parse HEAD) == "$local_commit" ]] || fail "local commit survives" - -make_checkout https://github.com/omacom/elsewhen.git -git -C "$checkout" checkout -qb local-work -printf 'local branch\n' >"$checkout/Panel.qml" -git -C "$checkout" commit -qam "Unpublished branch" -git -C "$checkout" checkout -q --detach refs/remotes/origin/main -reset_layout -run_migration -assert_kept "an unpublished commit on another branch" - -make_checkout https://github.com/omacom/elsewhen.git -printf 'stashed work\n' >"$checkout/Panel.qml" -git -C "$checkout" stash push -q -reset_layout -run_migration -assert_kept "a clean clone with stashed work" - -make_checkout https://github.com/omacom/elsewhen.git -git -C "$checkout" config status.showUntrackedFiles no -printf 'private-notes\n' >"$checkout/.git/info/exclude" -printf 'ignored work\n' >"$checkout/private-notes" -reset_layout -run_migration -assert_kept "a clone with an ignored file" -[[ $(cat "$checkout/private-notes") == "ignored work" ]] || fail "ignored file survives" - -make_checkout https://github.com/omacom/elsewhen.git -printf 'recoverable work\n' >"$checkout/Panel.qml" -git -C "$checkout" commit -qam "Recoverable local commit" -git -C "$checkout" reset -q --hard refs/remotes/origin/main -reset_layout -run_migration -assert_kept "a local commit retained only by the reflog" - -make_checkout https://github.com/omacom/elsewhen.git -git -C "$checkout" update-ref -d refs/remotes/origin/main -reset_layout -run_migration -assert_kept "a clone without recorded upstream history" - -make_checkout https://github.com/omacom/elsewhen.git -git -C "$checkout" config status.showUntrackedFiles no -printf 'untracked work\n' >"$checkout/NOTES.md" -reset_layout -run_migration -assert_kept "untracked files hidden by the user Git configuration" - -make_checkout https://github.com/someone/elsewhen-fork.git -reset_layout -run_migration -assert_kept "a clone of another repository" - -make_checkout https://github.com/omacom/elsewhen.git -git -C "$checkout" remote remove origin -reset_layout -run_migration -assert_kept "a clone without an origin remote" - -rm -rf "$checkout" -mkdir -p "$checkout" -printf '{ "id": "omacom.elsewhen" }\n' >"$checkout/manifest.json" -reset_layout -run_migration -assert_kept "a plain directory without .git" - -rm -rf "$checkout" -make_checkout https://github.com/omacom/elsewhen.git -mv "$checkout" "$test_dir/elsewhen-src" -ln -s "$test_dir/elsewhen-src" "$checkout" -reset_layout -run_migration -assert_kept "a symlinked checkout" -[[ -L $checkout && -f $test_dir/elsewhen-src/manifest.json ]] || - fail "a symlinked checkout stays a symlink with its target intact" "$(ls -la "$checkout" "$test_dir/elsewhen-src")" -pass "a symlinked checkout stays a symlink with its target intact" - -rm -f "$checkout" -reset_layout -run_migration -grep -q 'omacom.elsewhen checkout\|takes precedence' "$output" && fail "no checkout means no checkout report" "$(cat "$output")" -assert_widget_placed "a machine without a checkout" -pass "a machine without a checkout is left alone" From 16cc7d7a9dcf40320016dae37da8b97889d7cb58 Mon Sep 17 00:00:00 2001 From: Spencer Bull Date: Sat, 19 Sep 2026 00:06:29 -0500 Subject: [PATCH 19/36] Leave the shell restart to the update flow Restarting immediately after the plugin rescan races Quickshell IPC handler creation and can crash the exiting shell. The normal update flow already restarts after migrations. Let this migration finish through live enablement and placement without adding timing workarounds. --- docs/omarchy-shell.md | 2 +- migrations/1789581661.sh | 1 - test/shell.d/elsewhen-default-migration-test.sh | 9 +++++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/omarchy-shell.md b/docs/omarchy-shell.md index 6e999682..d62661a7 100644 --- a/docs/omarchy-shell.md +++ b/docs/omarchy-shell.md @@ -90,7 +90,7 @@ The lower-level IPC methods remain available through `omarchy-shell shell ...`. ## Elsewhen -Elsewhen (`omacom.elsewhen`) ships in the `elsewhen` package at `/usr/share/omarchy/plugins/omacom.elsewhen`. A symlink in `~/.config/omarchy/plugins/` makes it available to the shell. New installs place it immediately before the clock; the migration uses `omarchy bar put omacom.elsewhen --before omarchy.clock`, which preserves an existing placement and uses Elsewhen's normal right-side placement if the clock is absent. Existing plugin directories and symlinks are left intact. +Elsewhen (`omacom.elsewhen`) ships in the `elsewhen` package at `/usr/share/omarchy/plugins/omacom.elsewhen`. A symlink in `~/.config/omarchy/plugins/` makes it available to the shell. New installs place it immediately before the clock; the migration uses `omarchy bar put omacom.elsewhen --before omarchy.clock`, which preserves an existing placement and uses Elsewhen's normal right-side placement if the clock is absent. Existing plugin directories and symlinks are left intact. The normal update flow restarts the shell after migrations; the migration does not interrupt plugin loading with an immediate restart. ## IPC diff --git a/migrations/1789581661.sh b/migrations/1789581661.sh index 10f18e66..5c022e1c 100644 --- a/migrations/1789581661.sh +++ b/migrations/1789581661.sh @@ -10,4 +10,3 @@ fi omarchy-shell shell rescanPlugins omarchy-bar put omacom.elsewhen --before omarchy.clock -omarchy-restart-shell diff --git a/test/shell.d/elsewhen-default-migration-test.sh b/test/shell.d/elsewhen-default-migration-test.sh index bda62fd6..c0a2de8f 100644 --- a/test/shell.d/elsewhen-default-migration-test.sh +++ b/test/shell.d/elsewhen-default-migration-test.sh @@ -23,7 +23,8 @@ printf '%s\n' "${TEST_PUT_RESULT:-ok}" SH cat >"$test_dir/bin/omarchy-restart-shell" <<'SH' #!/bin/bash -printf 'restart\n' >>"$CALL_LOG" +echo 'migration must leave the restart to omarchy update' >&2 +exit 1 SH chmod +x "$test_dir/bin/"* @@ -46,9 +47,9 @@ run_migration [[ $(readlink "$ROOT/config/omarchy/plugins/omacom.elsewhen") == "$(readlink "$plugin")" ]] || fail "fresh installs use the same package link" pass "migration and fresh installs link to the package" -expected=$'package elsewhen\nshell rescanPlugins\nshell putBarWidget omacom.elsewhen {"before":"omarchy.clock"}\nrestart' -[[ $(cat "$CALL_LOG") == "$expected" ]] || fail "install, scan, placement and restart run in order" "$(cat "$CALL_LOG")" -pass "real bar helper enables and places before the clock, then restarts" +expected=$'package elsewhen\nshell rescanPlugins\nshell putBarWidget omacom.elsewhen {"before":"omarchy.clock"}' +[[ $(cat "$CALL_LOG") == "$expected" ]] || fail "install, scan and placement run in order" "$(cat "$CALL_LOG")" +pass "real bar helper enables and places before the clock without restarting during reload" run_migration [[ $(cat "$CALL_LOG") == "$expected" ]] || fail "migration can be rerun" From e38c1d1289252d2adb96372eeac48d02e489c5b7 Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Sat, 19 Sep 2026 21:53:09 +0200 Subject: [PATCH 20/36] Ignore claude --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index 8de9215b..1de1faa6 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,5 @@ # Python bytecode (orchestrator) __pycache__/ *.pyc + +.claude/ From e265934bb16c76cb47144d4625d19626b1ab36f6 Mon Sep 17 00:00:00 2001 From: Ryan Hughes Date: Mon, 31 Aug 2026 15:43:14 -0400 Subject: [PATCH 21/36] Use Omasnap for screenshots --- agents/skills/visual-verification.md | 5 +- bin/omarchy-capture-screenshot | 81 +++--------------- bin/omarchy-clipboard-open | 2 +- config/imv/config | 4 +- default/agents/skills/omarchy/capture.md | 6 +- default/hypr/apps/screenshot-selection.lua | 5 +- default/hypr/apps/system.lua | 2 - default/uwsm/default | 4 +- docs/file-layout.md | 1 - install/omarchy-base.packages | 2 +- manual/12-screenshots-recording.md | 21 +++-- manual/14-omarchy-cli.md | 2 +- manual/46-faq.md | 6 +- migrations/1788129995.sh | 13 +++ shell/Commons/Util.qml | 2 +- test/shell.d/clipboard-test.sh | 12 +-- test/shell.d/omasnap-test.sh | 99 ++++++++++++++++++++++ test/shell.d/screenshot-sanity-test.sh | 20 ++--- 18 files changed, 169 insertions(+), 118 deletions(-) create mode 100644 migrations/1788129995.sh create mode 100644 test/shell.d/omasnap-test.sh diff --git a/agents/skills/visual-verification.md b/agents/skills/visual-verification.md index 56dc8e78..7df6caa1 100644 --- a/agents/skills/visual-verification.md +++ b/agents/skills/visual-verification.md @@ -15,10 +15,7 @@ Take a full-screen screenshot without opening the editor: omarchy capture screenshot fullscreen save ``` -The command prints the saved path and writes to the configured Pictures -directory. Use `omarchy screenshot` for the interactive smart-region flow. -Capture reference and candidate states as separate images when changing a -layer-shell surface or layout, then compare both. +The command writes to Omasnap's configured screenshot directory. Use `omarchy screenshot` for the interactive editor flow. Capture reference and candidate states as separate images when changing a layer-shell surface or layout, then compare both. Record a short full-screen video for animation, transition, timing, capture, or screen-recording changes: diff --git a/bin/omarchy-capture-screenshot b/bin/omarchy-capture-screenshot index 6f7b91bf..ec383fcd 100755 --- a/bin/omarchy-capture-screenshot +++ b/bin/omarchy-capture-screenshot @@ -2,81 +2,22 @@ # omarchy:summary=Take a screenshot # omarchy:group=capture -# omarchy:args=[smart|region|windows|fullscreen] [slurp|copy|save] [--editor=] +# omarchy:args=[smart|region|windows|fullscreen|scroll] [copy|save] # omarchy:examples=omarchy screenshot | omarchy capture screenshot region # omarchy:aliases=omarchy screenshot -[[ -f ~/.config/user-dirs.dirs ]] && source ~/.config/user-dirs.dirs -OUTPUT_DIR="${OMARCHY_SCREENSHOT_DIR:-${XDG_PICTURES_DIR:-$HOME/Pictures}}" - -if [[ ! -d $OUTPUT_DIR ]]; then - mkdir -p "$OUTPUT_DIR" - omarchy-notification-send "Created screenshot directory: $OUTPUT_DIR" -t 2000 +if [[ -n ${OMARCHY_SCREENSHOT_DIR:-} && -z ${OMASNAP_SCREENSHOT_DIR:-} ]]; then + export OMASNAP_SCREENSHOT_DIR="$OMARCHY_SCREENSHOT_DIR" fi -pkill slurp && exit 0 - -SCREENSHOT_EDITOR="${OMARCHY_SCREENSHOT_EDITOR:-tensaku-edit}" - -# Parse --editor flag from any position -ARGS=() +omasnap_args=() for arg in "$@"; do - if [[ $arg == --editor=* ]]; then - SCREENSHOT_EDITOR="${arg#--editor=}" - else - ARGS+=("$arg") - fi + case "$arg" in + copy) omasnap_args+=(--copy) ;; + save) omasnap_args+=(--save) ;; + slurp) ;; + *) omasnap_args+=("$arg") ;; + esac done -set -- "${ARGS[@]}" -MODE="${1:-smart}" -PROCESSING="${2:-slurp}" - -# The picker leaves the screen freeze running (PID on its first output line) -# so grim captures the frozen overlay rather than live content shifting -# during teardown. -# -# Software-composited cursors (Hyprland's fallback on GPUs without working -# hardware cursors) are baked into the frames grim captures, so force -# hardware cursors until after grim runs and restore the setting on exit. -NO_HW_CURSORS=$(hyprctl getoption cursor:no_hardware_cursors -j | jq '.int') - -set_no_hw_cursors() { - hyprctl eval "hl.config({ cursor = { no_hardware_cursors = $1 } })" &>/dev/null || - hyprctl keyword cursor:no_hardware_cursors "$1" &>/dev/null -} - -cleanup() { - [[ -n $FREEZE_PID ]] && kill $FREEZE_PID 2>/dev/null - set_no_hw_cursors "$NO_HW_CURSORS" -} -trap cleanup EXIT - -set_no_hw_cursors 0 -{ read -r FREEZE_PID; read -r SELECTION; } < <(omarchy-capture-region "$MODE" --keep-freeze) - -[[ -z $SELECTION ]] && exit 0 - -FILENAME="screenshot-$(date +'%Y-%m-%d_%H-%M-%S').png" -FILEPATH="$OUTPUT_DIR/$FILENAME" - -case "$PROCESSING" in - slurp) - grim -g "$SELECTION" "$FILEPATH" || exit 1 - echo "$FILEPATH" - wl-copy --type image/png <"$FILEPATH" - - # Best-effort: the screenshot is already saved and on the clipboard, so a - # notification outage must not report the capture itself as failed. - omarchy-notification-send "Screenshot saved to clipboard and file" "Edit with Super + Alt + , (or click this)" \ - --image "$FILEPATH" \ - --exec "$SCREENSHOT_EDITOR" "$FILEPATH" || true - ;; - copy) - grim -g "$SELECTION" - | wl-copy --type image/png - ;; - save) - grim -g "$SELECTION" "$FILEPATH" || exit 1 - echo "$FILEPATH" - ;; -esac +exec omasnap "${omasnap_args[@]}" diff --git a/bin/omarchy-clipboard-open b/bin/omarchy-clipboard-open index 98f26bb2..827fe263 100755 --- a/bin/omarchy-clipboard-open +++ b/bin/omarchy-clipboard-open @@ -30,7 +30,7 @@ open_image() { local path="$1" [[ -r $path ]] || exit 1 - exec tensaku-edit "$path" + exec omasnap "$path" } open_text() { diff --git a/config/imv/config b/config/imv/config index f96aa6a3..5de2530e 100644 --- a/config/imv/config +++ b/config/imv/config @@ -12,5 +12,5 @@ # Rotate the currently open image by 90 degrees = exec mogrify -rotate 90 "$imv_current_file" -# Edit the current image in Tensaku and quit the viewer - = exec tensaku-edit "$imv_current_file" & ; quit +# Edit the current image in Omasnap and quit the viewer + = exec omasnap "$imv_current_file" & ; quit diff --git a/default/agents/skills/omarchy/capture.md b/default/agents/skills/omarchy/capture.md index 621bc298..4390fe75 100644 --- a/default/agents/skills/omarchy/capture.md +++ b/default/agents/skills/omarchy/capture.md @@ -10,12 +10,10 @@ omarchy screenshot # Interactive smart-region flow omarchy capture screenshot region # Select a region omarchy capture screenshot windows # Pick a window omarchy capture screenshot fullscreen save # Full screen, straight to disk (no editor) +omarchy capture screenshot scroll # Capture and stitch a scrolling region ``` -The first argument picks the mode (`smart|region|windows|fullscreen`), the -second what happens with it (`slurp|copy|save`). `save` skips the annotation -editor and prints the saved path. Screenshots land in the configured Pictures -directory (override with `OMARCHY_SCREENSHOT_DIR`). +The first argument picks the Omasnap mode (`smart|region|windows|fullscreen|scroll`). With no second argument, the selection opens in Omasnap's annotation editor; `copy` or `save` skips the editor and sends the screenshot straight to that destination. Screenshots land in `~/Pictures/Screenshots` by default (override with `OMASNAP_SCREENSHOT_DIR`; the legacy `OMARCHY_SCREENSHOT_DIR` is also honored by the Omarchy command). ## Screen Recording diff --git a/default/hypr/apps/screenshot-selection.lua b/default/hypr/apps/screenshot-selection.lua index f4e3b2fd..4c93f703 100644 --- a/default/hypr/apps/screenshot-selection.lua +++ b/default/hypr/apps/screenshot-selection.lua @@ -1,2 +1,5 @@ --- Remove the 1px border around the slurp region selection used by screenshots. +-- Remove the 1px border around the slurp region selection used by recordings, OCR, and QR capture. hl.layer_rule({ match = { namespace = "selection" }, no_anim = true, animation = "none" }) + +-- Keep the Omasnap overlay immediate and out of screen shares. +hl.layer_rule({ match = { namespace = "^omasnap$" }, no_anim = true, animation = "none", no_screen_share = true }) diff --git a/default/hypr/apps/system.lua b/default/hypr/apps/system.lua index 789e3e03..3235e7b9 100644 --- a/default/hypr/apps/system.lua +++ b/default/hypr/apps/system.lua @@ -27,8 +27,6 @@ o.window("org.omarchy.about", { float = true }) o.window("org.omarchy.about", { center = true }) o.window("org.omarchy.about", { size = { 920, 480 } }) -o.window("dev.tensaku.Tensaku", { float = true }) -o.window("dev.tensaku.Tensaku", { center = true }) o.window("omacalc", { float = true }) -- Fullscreen screensaver. diff --git a/default/uwsm/default b/default/uwsm/default index d2ad7cc3..ba98b166 100644 --- a/default/uwsm/default +++ b/default/uwsm/default @@ -10,8 +10,8 @@ export TERMINAL=xdg-terminal-exec # Used by terminal programs to open files with the selected Omarchy default editor export EDITOR="omarchy-launch-editor --inline" -# Use a custom directory for screenshots (remember to make the directory!) -# export OMARCHY_SCREENSHOT_DIR="$HOME/Pictures/Screenshots" +# Use a custom directory for screenshots +# export OMASNAP_SCREENSHOT_DIR="$HOME/Pictures/Screenshots" # Use a custom directory for screenrecordings (remember to make the directory!) # export OMARCHY_SCREENRECORD_DIR="$HOME/Videos/Screencasts" diff --git a/docs/file-layout.md b/docs/file-layout.md index f261085f..73c48c4f 100644 --- a/docs/file-layout.md +++ b/docs/file-layout.md @@ -116,7 +116,6 @@ default/** ──► omarchy-settings /usr/share/omarchy ├─ hypr/toggles/*.lua (flags, │ single-window-aspect-ratio, window-no-gaps) /etc/skel/.local/state/omarchy/toggles/hypr/ ├─ nautilus-python/extensions/*.py /etc/skel/.local/share/nautilus-python/extensions/ - ├─ tensaku/state.toml /etc/skel/.local/state/tensaku/state.toml ├─ uwsm/env.d/10-omarchy /usr/share/uwsm/env.d/ ├─ environment.d/*.conf /usr/lib/environment.d/ ├─ fontconfig/conf.avail/50-omarchy.conf /usr/share/fontconfig/conf.avail/ diff --git a/install/omarchy-base.packages b/install/omarchy-base.packages index 0a8e27cc..b3df3e20 100644 --- a/install/omarchy-base.packages +++ b/install/omarchy-base.packages @@ -96,6 +96,7 @@ omacalc omacut omawrite omarchy-nvim +omasnap pacman-contrib pamixer pinta @@ -114,7 +115,6 @@ qt6-multimedia-ffmpeg quickshell ripgrep ruby -tensaku sddm slurp socat diff --git a/manual/12-screenshots-recording.md b/manual/12-screenshots-recording.md index 9c476231..b3447b57 100644 --- a/manual/12-screenshots-recording.md +++ b/manual/12-screenshots-recording.md @@ -13,13 +13,13 @@ Everything you can grab off the screen hangs off the Print Screen key. One key o ## Screenshots -Hit `Print Screen` and the screen freezes so nothing shifts under you while you aim. Drag a box for a freeform region, or just click once and the shot snaps to whatever rectangle you clicked in — a window if you landed on one, the whole monitor if you landed on the bar or in a gap. Changed your mind? Hit `Print Screen` again to dismiss the picker. +Hit `Print Screen` and Omasnap captures the focused monitor before its overlay appears, so nothing shifts under you while you aim. Drag a freeform region, or use the tabs across the top to switch between Region, Scrolling Region, Window, and Fullscreen capture. Changed your mind? Hit `Print Screen` again to dismiss Omasnap. -The result goes two places at once: a PNG in your pictures directory, and the clipboard, so you can paste it straight into a chat window with `Super + V`. A notification pops up with a thumbnail. Click it (or hit `Super + Alt + ,` to invoke the last notification) and the shot opens in Tensaku, the annotation editor, where you can draw arrows and boxes on it before you send it. +After you select an area, Omasnap opens its annotation editor. It can draw arrows, lines, shapes, highlights, numbered markers, text, and secure redactions; crop or cut out part of the image; OCR its text; and add a backdrop. Press `Enter` to copy and save the finished PNG, `Ctrl + C` to copy it without saving, `Ctrl + S` to save it without copying, or `P` to pin it above your windows. -Files land in `~/Pictures` by default, named `screenshot-2026-08-13_14-22-05.png`. If you'd rather keep them in their own folder, set `OMARCHY_SCREENSHOT_DIR` — see [the FAQ](46-faq.md) for where to put session environment variables. Omarchy creates the directory for you if it isn't there. You can swap the editor too with `OMARCHY_SCREENSHOT_EDITOR`. +Files land in `~/Pictures/Screenshots` by default, with a name such as `screenshot-2026-08-13_14-22-05-firefox.png`. Set `OMASNAP_SCREENSHOT_DIR` to use another directory — see [the FAQ](46-faq.md) for where to put session environment variables. Omasnap creates the directory when it saves the first shot. -From the terminal, `omarchy screenshot` takes the same shot, and you can be explicit about it: `omarchy capture screenshot region` for freeform only, `windows` to snap to window and monitor rectangles, or `fullscreen` to skip the picker entirely and grab the focused monitor. A second argument of `copy` puts the shot only on the clipboard, and `save` only on disk. +From the terminal, `omarchy screenshot` opens the same overlay, and you can choose its starting mode: `omarchy capture screenshot region`, `windows`, `fullscreen`, or `scroll`. A second argument of `copy` or `save` bypasses the annotation editor and sends the shot straight to that destination. ### Driving the picker from the keyboard @@ -27,16 +27,19 @@ While the selection is up, you don't have to use the mouse at all: | Key | Function | | --- | -------- | +| `Space` | Step through Region, Scrolling Region, and Window modes | +| `S` | Toggle scrolling-region mode | +| `Super + Arrow keys` | Move among windows in Window mode | | `Return` | Capture the highlighted window | -| `Ctrl + Return` | Capture the whole screen | -| `Tab` / `Ctrl + Tab` | Highlight the next / previous window | -| Arrow keys | Highlight the window in that direction | +| `Ctrl + A` | Capture the full focused monitor | +| `R` | Restore the last region drawn in this session | +| `Esc` | Dismiss Omasnap | -The arrows and Tab move the cursor to the window they pick, so the highlight follows along and you can see what you're about to capture. These bindings only exist while a selection is on screen, so they can't collide with anything in your own config. +These bindings only exist while Omasnap is open, so they can't collide with anything in your own config. ## Screen recording -`Alt + Print Screen` opens _Trigger > Capture > Screenrecord_, which asks what you want on the soundtrack: no audio, desktop audio, desktop plus microphone, or desktop plus microphone plus webcam. That last one only shows up if you actually have a camera plugged in. Pick one and you get the same picker as a screenshot: drag a region, or click a window or monitor. +`Alt + Print Screen` opens _Trigger > Capture > Screenrecord_, which asks what you want on the soundtrack: no audio, desktop audio, desktop plus microphone, or desktop plus microphone plus webcam. That last one only shows up if you actually have a camera plugged in. Pick one and Omarchy's recording picker lets you drag a region or click a window or monitor. Recording runs on gpu-screen-recorder, which encodes on the GPU at 60fps and falls back to the CPU if it has to. The result is an MP4 in `~/Videos`, named `screenrecording-2026-08-13_14-22-05.mp4`. Set `OMARCHY_SCREENRECORD_DIR` to change that — but note that unlike the screenshot directory, this one has to exist already, or the recording refuses to start. diff --git a/manual/14-omarchy-cli.md b/manual/14-omarchy-cli.md index fa5d0a05..76f386e8 100644 --- a/manual/14-omarchy-cli.md +++ b/manual/14-omarchy-cli.md @@ -50,7 +50,7 @@ Capture commands — Screenshots and screen recording: omarchy capture qr Decode a QR code from a screenshot region omarchy capture screenrecording [--fullscreen] [--with-desktop-audio] [--with-microphone-audio] [--with-webcam] [--webcam-device=] [--webcam-size=] [--resolution=] [--stop-recording] Start or stop screen recording omarchy capture screenrecording with webcam Pick a webcam and start a screen recording with it - omarchy capture screenshot [smart|region|windows|fullscreen] [slurp|copy|save] [--editor=] Take a screenshot + omarchy capture screenshot [smart|region|windows|fullscreen|scroll] [copy|save] Take a screenshot omarchy capture text Extract text from a screenshot region with OCR omarchy capture webcam resize Resize the active webcam recording overlay ``` diff --git a/manual/46-faq.md b/manual/46-faq.md index 21b11db9..8985439b 100644 --- a/manual/46-faq.md +++ b/manual/46-faq.md @@ -54,15 +54,15 @@ Automatic discovery, where printers on the network appear without being added, i ### How do I change where screenshots or screenrecordings are saved? -If you want screenshots to be saved to `~/Pictures/Screenshots` instead of just `~/Pictures`, you can add this to a file under `~/.config/uwsm/env.d/` (like `~/.config/uwsm/env.d/capture`): +Omasnap saves screenshots to `~/Pictures/Screenshots` by default. To use another directory, add this to a file under `~/.config/uwsm/env.d/` (like `~/.config/uwsm/env.d/capture`): ``` -export OMARCHY_SCREENSHOT_DIR="$HOME/Pictures/Screenshots" +export OMASNAP_SCREENSHOT_DIR="$HOME/Pictures/Captures" ``` You can do the same for screenrecordings using `OMARCHY_SCREENRECORD_DIR`. -Just remember to create the directory you want to save to and restart Omarchy for this to take effect. +Omasnap creates its screenshot directory automatically. Create the screenrecording directory yourself, then restart Omarchy for either environment change to take effect. ### How do I get the speakers + webcam working on my Apple Studio Display? diff --git a/migrations/1788129995.sh b/migrations/1788129995.sh new file mode 100644 index 00000000..041a3ef8 --- /dev/null +++ b/migrations/1788129995.sh @@ -0,0 +1,13 @@ +echo "Replace Tensaku with Omasnap" + +omarchy-pkg-add omasnap + +imv_config="$HOME/.config/imv/config" +if [[ -f $imv_config ]]; then + sed -i --follow-symlinks \ + -e 's/^# Edit the current image in Tensaku and quit the viewer$/# Edit the current image in Omasnap and quit the viewer/' \ + -e 's|^ = exec tensaku-edit "$imv_current_file" & ; quit$| = exec omasnap "$imv_current_file" \& ; quit|' \ + "$imv_config" +fi + +omarchy-pkg-drop tensaku diff --git a/shell/Commons/Util.qml b/shell/Commons/Util.qml index 14af44fe..cacc98d2 100644 --- a/shell/Commons/Util.qml +++ b/shell/Commons/Util.qml @@ -61,7 +61,7 @@ QtObject { // Run an argv vector without a shell interpreting it: the constant `exec "$@"` // means the args only ever land in positional parameters, which bash expands // without re-tokenizing — so untrusted data ($(id), a filename) stays literal. - // The login shell (-l) keeps the PATH/session env GUI targets (tensaku, mpv, + // The login shell (-l) keeps the PATH/session env GUI targets (omasnap, mpv, // xdg-open) need. Prefer this over execDetached for anything built from input. function execArgv(argv) { Quickshell.execDetached(["bash", "-lc", 'exec "$@"', "bash"].concat(argv)) diff --git a/test/shell.d/clipboard-test.sh b/test/shell.d/clipboard-test.sh index 962d529e..5580a694 100644 --- a/test/shell.d/clipboard-test.sh +++ b/test/shell.d/clipboard-test.sh @@ -277,12 +277,12 @@ printf '%s\n' "$1" >"$EDITOR_PATH_OUT" cat "$1" >"$EDITOR_TEXT_OUT" SH -cat >"$TMPDIR/bin/tensaku-edit" <<'SH' +cat >"$TMPDIR/bin/omasnap" <<'SH' #!/bin/bash -printf '%s\n' "$*" >"$TENSAKU_OUT" +printf '%s\n' "$*" >"$OMASNAP_OUT" SH -chmod +x "$TMPDIR/bin/wl-copy" "$TMPDIR/bin/wl-paste" "$TMPDIR/bin/wtype" "$TMPDIR/bin/omarchy-launch-browser" "$TMPDIR/bin/omarchy-launch-editor" "$TMPDIR/bin/tensaku-edit" +chmod +x "$TMPDIR/bin/wl-copy" "$TMPDIR/bin/wl-paste" "$TMPDIR/bin/wtype" "$TMPDIR/bin/omarchy-launch-browser" "$TMPDIR/bin/omarchy-launch-editor" "$TMPDIR/bin/omasnap" capture_output=$(XDG_RUNTIME_DIR="$TMPDIR" XDG_STATE_HOME="$TMPDIR/state" PATH="$TMPDIR/bin:$PATH" "$ROOT/shell/plugins/clipboard/capture.sh") [[ $capture_output == '{"type":"text","text":"terminal copy"}' ]] || fail "clipboard capture records normal text events" @@ -513,8 +513,8 @@ pass "clipboard open helper opens text entries in editor" [[ $(<"$TMPDIR/editor-path") == "$TMPDIR"/state/omarchy/clipboard-open/clipboard.*.txt ]] || fail "clipboard open helper writes text entries to a temporary file" pass "clipboard open helper writes text entries to a temporary file" -TENSAKU_OUT="$TMPDIR/tensaku" HOME="$TMPDIR/home" PATH="$TMPDIR/bin:$PATH" \ +OMASNAP_OUT="$TMPDIR/omasnap" HOME="$TMPDIR/home" PATH="$TMPDIR/bin:$PATH" \ "$ROOT/bin/omarchy-clipboard-open" --history-index 2 -[[ $(<"$TMPDIR/tensaku") == "$TMPDIR/image.png" ]] || fail "clipboard open helper opens image entries in Tensaku" -pass "clipboard open helper opens image entries in Tensaku" +[[ $(<"$TMPDIR/omasnap") == "$TMPDIR/image.png" ]] || fail "clipboard open helper opens image entries in Omasnap" +pass "clipboard open helper opens image entries in Omasnap" diff --git a/test/shell.d/omasnap-test.sh b/test/shell.d/omasnap-test.sh new file mode 100644 index 00000000..342e5f8f --- /dev/null +++ b/test/shell.d/omasnap-test.sh @@ -0,0 +1,99 @@ +#!/bin/bash + +set -euo pipefail + +source "$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)/base-test.sh" + +packages="$ROOT/install/omarchy-base.packages" +migration="$ROOT/migrations/1788129995.sh" + +grep -qxF omasnap "$packages" || fail "fresh installs include Omasnap" +! grep -qxF tensaku "$packages" || fail "fresh installs no longer include Tensaku" +pass "fresh installs use Omasnap as the screenshot editor" + +grep -Fq 'namespace = "^omasnap$"' "$ROOT/default/hypr/apps/screenshot-selection.lua" || + fail "Omasnap has a layer rule" +grep -Fq 'no_screen_share = true' "$ROOT/default/hypr/apps/screenshot-selection.lua" || + fail "the Omasnap overlay is excluded from screen sharing" +! grep -Fq 'dev.tensaku.Tensaku' "$ROOT/default/hypr/apps/system.lua" || + fail "the removed Tensaku window rules are gone" +pass "Hyprland applies Omasnap's overlay policy without stale Tensaku rules" + +test_tmp=$(mktemp -d) +trap 'rm -rf "$test_tmp"' EXIT + +stub_bin="$test_tmp/bin" +mkdir -p "$stub_bin" + +cat >"$stub_bin/omasnap" <<'SH' +#!/bin/bash +printf '%s\t%s\n' "${OMASNAP_SCREENSHOT_DIR:-}" "$*" >>"$OMASNAP_TEST_LOG" +SH +chmod +x "$stub_bin/omasnap" + +capture_log="$test_tmp/capture.log" +OMASNAP_TEST_LOG="$capture_log" PATH="$stub_bin:$PATH" \ + "$ROOT/bin/omarchy-capture-screenshot" +[[ $(<"$capture_log") == $'\t' ]] || fail "the default screenshot opens Omasnap without extra arguments" + +: >"$capture_log" +OMASNAP_TEST_LOG="$capture_log" OMARCHY_SCREENSHOT_DIR="$test_tmp/legacy-output" PATH="$stub_bin:$PATH" \ + "$ROOT/bin/omarchy-capture-screenshot" windows copy +[[ $(<"$capture_log") == "$test_tmp/legacy-output"$'\twindows --copy' ]] || + fail "the screenshot command maps the legacy directory and copy argument to Omasnap" + +: >"$capture_log" +OMASNAP_TEST_LOG="$capture_log" OMARCHY_SCREENSHOT_DIR="$test_tmp/legacy-output" OMASNAP_SCREENSHOT_DIR="$test_tmp/native-output" PATH="$stub_bin:$PATH" \ + "$ROOT/bin/omarchy-capture-screenshot" fullscreen save +[[ $(<"$capture_log") == "$test_tmp/native-output"$'\tfullscreen --save' ]] || + fail "the native Omasnap directory wins while legacy save syntax still works" + +: >"$capture_log" +OMASNAP_TEST_LOG="$capture_log" PATH="$stub_bin:$PATH" \ + "$ROOT/bin/omarchy-capture-screenshot" region slurp +[[ $(<"$capture_log") == $'\tregion' ]] || fail "the former default slurp argument remains a harmless compatibility no-op" + +: >"$capture_log" +OMASNAP_TEST_LOG="$capture_log" PATH="$stub_bin:$PATH" \ + "$ROOT/bin/omarchy-capture-screenshot" scroll --save +[[ $(<"$capture_log") == $'\tscroll --save' ]] || fail "native Omasnap modes and flags pass through unchanged" + +pass "the Omarchy screenshot route delegates compatible arguments to Omasnap" + +cat >"$stub_bin/omarchy-pkg-add" <<'SH' +#!/bin/bash +printf 'add\t%s\n' "$*" >>"$OMASNAP_MIGRATION_LOG" +SH +cat >"$stub_bin/omarchy-pkg-drop" <<'SH' +#!/bin/bash +printf 'drop\t%s\n' "$*" >>"$OMASNAP_MIGRATION_LOG" +SH +chmod +x "$stub_bin/omarchy-pkg-add" "$stub_bin/omarchy-pkg-drop" + +migration_home="$test_tmp/home" +mkdir -p "$migration_home/.config/imv" "$migration_home/dotfiles" +cat >"$migration_home/dotfiles/imv.config" <<'EOF' +[binds] + +# Edit the current image in Tensaku and quit the viewer + = exec tensaku-edit "$imv_current_file" & ; quit + = exec custom-editor "$imv_current_file" & ; quit +EOF +ln -s "$migration_home/dotfiles/imv.config" "$migration_home/.config/imv/config" + +migration_log="$test_tmp/migration.log" +OMASNAP_MIGRATION_LOG="$migration_log" HOME="$migration_home" PATH="$stub_bin:$PATH" \ + bash -euo pipefail "$migration" >/dev/null + +[[ $(sed -n '1p' "$migration_log") == $'add\tomasnap' ]] || fail "the migration installs Omasnap first" +[[ $(sed -n '2p' "$migration_log") == $'drop\ttensaku' ]] || fail "the migration removes Tensaku after Omasnap is ready" +grep -Fq '# Edit the current image in Omasnap and quit the viewer' "$migration_home/.config/imv/config" || + fail "the migration updates the stock imv editor comment" +grep -Fq ' = exec omasnap "$imv_current_file" & ; quit' "$migration_home/.config/imv/config" || + fail "the migration sends the stock imv edit binding to Omasnap" +grep -Fq ' = exec custom-editor "$imv_current_file" & ; quit' "$migration_home/.config/imv/config" || + fail "the migration preserves custom imv bindings" +[[ -L $migration_home/.config/imv/config ]] || fail "the migration preserves a dotfile-managed imv symlink" +[[ $(stat -c '%a' "$migration") == 644 ]] || fail "the Omasnap migration has mode 0644" + +pass "the migration swaps packages and safely updates only the stock imv binding" diff --git a/test/shell.d/screenshot-sanity-test.sh b/test/shell.d/screenshot-sanity-test.sh index 636642ed..756ffc65 100755 --- a/test/shell.d/screenshot-sanity-test.sh +++ b/test/shell.d/screenshot-sanity-test.sh @@ -25,13 +25,13 @@ if ! command -v quickshell >/dev/null 2>&1; then exit 0 fi -if pgrep -x slurp >/dev/null 2>&1; then - pass "slurp is already running; skipping screenshot sanity test" +if pgrep -x omasnap >/dev/null 2>&1; then + pass "omasnap is already running; skipping screenshot sanity test" exit 0 fi require_command hyprctl -require_command grim +require_command omasnap require_command jq require_command python3 @@ -118,13 +118,13 @@ jq -e ' fail_with_log "screenshot test shell rendered visible bar widgets" } -screenshot=$( - OMARCHY_PATH="$test_root" \ - OMARCHY_SCREENSHOT_DIR="$screenshot_dir" \ - HOME="$test_home" \ - PATH="$stub_bin:$ROOT/bin:$PATH" \ - "$ROOT/bin/omarchy" capture screenshot fullscreen save 2>"$screenshot_err" | tail -n 1 -) +OMARCHY_PATH="$test_root" \ +OMASNAP_SCREENSHOT_DIR="$screenshot_dir" \ +HOME="$test_home" \ +PATH="$stub_bin:$ROOT/bin:$PATH" \ + "$ROOT/bin/omarchy" capture screenshot fullscreen save >/dev/null 2>"$screenshot_err" + +screenshot=$(find "$screenshot_dir" -maxdepth 1 -type f -name '*.png' -print -quit) [[ -n $screenshot && -f $screenshot ]] || fail_with_log "fullscreen screenshot was captured" From 45748a2812f42e32f915b053caf4074e150e2048 Mon Sep 17 00:00:00 2001 From: Ryan Hughes Date: Sun, 20 Sep 2026 14:25:34 -0400 Subject: [PATCH 22/36] Remove obsolete Elsewhen plugin symlink --- config/omarchy/plugins/omacom.elsewhen | 1 - docs/omarchy-shell.md | 2 +- migrations/1789581661.sh | 6 ------ test/shell.d/elsewhen-default-migration-test.sh | 14 +++++++------- 4 files changed, 8 insertions(+), 15 deletions(-) delete mode 120000 config/omarchy/plugins/omacom.elsewhen diff --git a/config/omarchy/plugins/omacom.elsewhen b/config/omarchy/plugins/omacom.elsewhen deleted file mode 120000 index 19840c51..00000000 --- a/config/omarchy/plugins/omacom.elsewhen +++ /dev/null @@ -1 +0,0 @@ -/usr/share/omarchy/plugins/omacom.elsewhen \ No newline at end of file diff --git a/docs/omarchy-shell.md b/docs/omarchy-shell.md index d62661a7..b0da00e4 100644 --- a/docs/omarchy-shell.md +++ b/docs/omarchy-shell.md @@ -90,7 +90,7 @@ The lower-level IPC methods remain available through `omarchy-shell shell ...`. ## Elsewhen -Elsewhen (`omacom.elsewhen`) ships in the `elsewhen` package at `/usr/share/omarchy/plugins/omacom.elsewhen`. A symlink in `~/.config/omarchy/plugins/` makes it available to the shell. New installs place it immediately before the clock; the migration uses `omarchy bar put omacom.elsewhen --before omarchy.clock`, which preserves an existing placement and uses Elsewhen's normal right-side placement if the clock is absent. Existing plugin directories and symlinks are left intact. The normal update flow restarts the shell after migrations; the migration does not interrupt plugin loading with an immediate restart. +Elsewhen (`omacom.elsewhen`) ships in the `elsewhen` package at `/usr/share/omarchy/shell/plugins/omacom.elsewhen`, where the shell discovers it automatically. New installs place it immediately before the clock; the migration uses `omarchy bar put omacom.elsewhen --before omarchy.clock`, which preserves an existing placement and uses Elsewhen's normal right-side placement if the clock is absent. Existing plugin directories and symlinks are left intact. The normal update flow restarts the shell after migrations; the migration does not interrupt plugin loading with an immediate restart. ## IPC diff --git a/migrations/1789581661.sh b/migrations/1789581661.sh index 5c022e1c..7a848550 100644 --- a/migrations/1789581661.sh +++ b/migrations/1789581661.sh @@ -2,11 +2,5 @@ echo "Install Elsewhen, the world clock plugin" omarchy-pkg-add elsewhen -plugin="$HOME/.config/omarchy/plugins/omacom.elsewhen" -mkdir -p "$(dirname "$plugin")" -if [[ ! -e $plugin && ! -L $plugin ]]; then - ln -s /usr/share/omarchy/plugins/omacom.elsewhen "$plugin" -fi - omarchy-shell shell rescanPlugins omarchy-bar put omacom.elsewhen --before omarchy.clock diff --git a/test/shell.d/elsewhen-default-migration-test.sh b/test/shell.d/elsewhen-default-migration-test.sh index c0a2de8f..585f65ba 100644 --- a/test/shell.d/elsewhen-default-migration-test.sh +++ b/test/shell.d/elsewhen-default-migration-test.sh @@ -40,12 +40,12 @@ if PACKAGE_STATUS=1 run_migration; then fi [[ ! -e $plugin && ! -L $plugin && $(cat "$CALL_LOG") == "package elsewhen" ]] || fail "package failure leaves the plugin and shell untouched" -pass "package failure stops before linking or changing the shell" +pass "package failure stops before changing the shell" run_migration -[[ $(readlink "$plugin") == /usr/share/omarchy/plugins/omacom.elsewhen ]] || fail "package link is installed" -[[ $(readlink "$ROOT/config/omarchy/plugins/omacom.elsewhen") == "$(readlink "$plugin")" ]] || fail "fresh installs use the same package link" -pass "migration and fresh installs link to the package" +[[ ! -e $plugin && ! -L $plugin ]] || fail "migration does not create a user plugin link" +[[ ! -e $ROOT/config/omarchy/plugins/omacom.elsewhen && ! -L $ROOT/config/omarchy/plugins/omacom.elsewhen ]] || fail "fresh installs do not ship a user plugin link" +pass "migration and fresh installs rely on the packaged plugin directory" expected=$'package elsewhen\nshell rescanPlugins\nshell putBarWidget omacom.elsewhen {"before":"omarchy.clock"}' [[ $(cat "$CALL_LOG") == "$expected" ]] || fail "install, scan and placement run in order" "$(cat "$CALL_LOG")" @@ -53,10 +53,10 @@ pass "real bar helper enables and places before the clock without restarting dur run_migration [[ $(cat "$CALL_LOG") == "$expected" ]] || fail "migration can be rerun" -pass "migration can be rerun with its package link present" +[[ ! -e $plugin && ! -L $plugin ]] || fail "rerunning the migration does not create a user plugin link" +pass "migration can be rerun without a user plugin link" -rm "$plugin" -mkdir "$plugin" +mkdir -p "$plugin" printf 'local work\n' >"$plugin/notes" run_migration [[ ! -L $plugin && $(cat "$plugin/notes") == "local work" ]] || fail "existing checkout is preserved" From b423f4993d68b0db70ae778f8cd4b3f516e3c500 Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Sun, 20 Sep 2026 20:36:19 -0500 Subject: [PATCH 23/36] Complete OWE service setup and lock feed fallback --- install/omarchy-base.packages | 6 +- install/user/first-run/enable-user-units.sh | 3 + manual/39-backgrounds.md | 2 + migrations/1786609204.sh | 4 +- migrations/1789764927.sh | 17 ++++ shell/plugins/background/Background.qml | 7 +- shell/plugins/lock/LockFeedSurface.qml | 4 - shell/plugins/lock/LockView.qml | 37 ++++----- shell/plugins/lock/Service.qml | 29 +++++++ shell/plugins/lock/poster.sh | 24 ++++++ test/shell.d/fixtures/owe-lock/shell.qml | 69 ++++++++++++++++ test/shell.d/owe-integration-test.sh | 90 +++++++++++++++++++++ test/shell.d/owe-lock-test.sh | 30 +++++++ test/shell.d/video-background-test.sh | 10 +-- 14 files changed, 289 insertions(+), 43 deletions(-) create mode 100644 migrations/1789764927.sh create mode 100755 shell/plugins/lock/poster.sh create mode 100644 test/shell.d/fixtures/owe-lock/shell.qml create mode 100644 test/shell.d/owe-integration-test.sh create mode 100644 test/shell.d/owe-lock-test.sh diff --git a/install/omarchy-base.packages b/install/omarchy-base.packages index c292828f..e4dd69a2 100644 --- a/install/omarchy-base.packages +++ b/install/omarchy-base.packages @@ -95,6 +95,9 @@ omacalc omacut omawrite omarchy-nvim +# OWE owns desktop video backgrounds and feeds the lock screen its frames. +owe +owe-lockfeed pacman-contrib pamixer pinta @@ -107,9 +110,6 @@ python-poetry-core ttfx qemu-user-static-binfmt qrencode -# OWE owns desktop video backgrounds and feeds the lock screen its frames. -owe -owe-lockfeed qt6-imageformats quickshell ripgrep diff --git a/install/user/first-run/enable-user-units.sh b/install/user/first-run/enable-user-units.sh index 9865fc20..e08885c9 100755 --- a/install/user/first-run/enable-user-units.sh +++ b/install/user/first-run/enable-user-units.sh @@ -14,8 +14,11 @@ set -euo pipefail systemctl --user daemon-reload systemctl --user enable --now \ bt-agent.service \ + owed.service \ omarchy-recover-internal-monitor.service \ omarchy-sleep-lock.service \ omarchy-migrate-notify.service \ omarchy-fcitx5.service \ omarchy-crash-watch.service + +omarchy-hook-install theme-set /usr/share/owe/10-owe-sync diff --git a/manual/39-backgrounds.md b/manual/39-backgrounds.md index f57d23d2..3bc1f77b 100644 --- a/manual/39-backgrounds.md +++ b/manual/39-backgrounds.md @@ -7,3 +7,5 @@ You can do this most easily by going to _Install > Style > Background_ in the Om Backgrounds can be videos as well as stills. Drop an `mp4`, `m4v`, `mov`, `webm`, `mkv`, or `avi` file in the same folder and it appears alongside the images. Videos are played by the OWE wallpaper engine. It decodes the video once for all monitors and plays its sound through the default audio output, and it stops playback whenever nothing can see it. The lock screen draws the same decode, muted, through OWE. A video wallpaper still costs far more power than a still one. You can find a huge collection of cool curated backgrounds on https://github.com/dharmx/walls. + +Video backgrounds keep a cached still on the lock screen while playback is paused or unavailable. Animated GIFs play on the desktop and show a still frame on the lock screen. diff --git a/migrations/1786609204.sh b/migrations/1786609204.sh index b7833092..ce1442ca 100644 --- a/migrations/1786609204.sh +++ b/migrations/1786609204.sh @@ -1,3 +1 @@ -echo "Install native video wallpaper playback dependencies" - -omarchy-pkg-add qt6-multimedia qt6-multimedia-ffmpeg +echo "Native video dependencies are superseded by the OWE migration" diff --git a/migrations/1789764927.sh b/migrations/1789764927.sh new file mode 100644 index 00000000..e2d1541e --- /dev/null +++ b/migrations/1789764927.sh @@ -0,0 +1,17 @@ +echo "Enable OWE desktop video backgrounds and lock feed" + +omarchy-pkg-add owe owe-lockfeed +omarchy-hook-install theme-set /usr/share/owe/10-owe-sync + +systemctl --user daemon-reload >/dev/null 2>&1 || true +if ! systemctl --user enable owed.service; then + wants_dir="$HOME/.config/systemd/user/graphical-session.target.wants" + mkdir -p "$wants_dir" + ln -sfn /usr/lib/systemd/user/owed.service "$wants_dir/owed.service" +fi + +# A TTY update enables the next graphical login without starting a renderer +# against a missing Wayland session. A failed live start leaves this pending. +if [[ ${OMARCHY_UPGRADE_TO_QUATTRO_LIVE:-0} != 1 ]] && systemctl --user is-active --quiet graphical-session.target; then + systemctl --user start owed.service +fi diff --git a/shell/plugins/background/Background.qml b/shell/plugins/background/Background.qml index 8c113e4b..b3dd7dab 100644 --- a/shell/plugins/background/Background.qml +++ b/shell/plugins/background/Background.qml @@ -182,9 +182,7 @@ Item { } } - Component.onCompleted: { - refreshBackground() - } + Component.onCompleted: refreshBackground() Variants { model: Quickshell.screens @@ -205,8 +203,7 @@ Item { // Keep render updates enabled. The background layer has been observed to // lose its committed buffer while parked with updatesEnabled=false, // leaving a black desktop until omarchy-shell is restarted. A still - // wallpaper costs nothing to keep enabled, and a video one is throttled - // by pausing playback rather than by parking the layer. + // wallpaper costs nothing to keep enabled. OWE manages video layers. updatesEnabled: true property bool maskReady: false diff --git a/shell/plugins/lock/LockFeedSurface.qml b/shell/plugins/lock/LockFeedSurface.qml index 38bd4612..ecd1f7d4 100644 --- a/shell/plugins/lock/LockFeedSurface.qml +++ b/shell/plugins/lock/LockFeedSurface.qml @@ -4,8 +4,4 @@ import Owe.LockFeed // Loaded through a Loader from LockView, so a system without the module shows // no lock video instead of losing the whole lock screen. LockFeed { - id: root - - property bool feedEnabled: true - active: root.feedEnabled } diff --git a/shell/plugins/lock/LockView.qml b/shell/plugins/lock/LockView.qml index 9366b289..7084fb0f 100644 --- a/shell/plugins/lock/LockView.qml +++ b/shell/plugins/lock/LockView.qml @@ -7,6 +7,7 @@ Item { id: root property string backgroundPath: "" + property string videoPosterPath: "" property int backgroundVersion: 0 property bool fingerprintConfigured: false property bool authenticatingPassword: false @@ -91,34 +92,15 @@ Item { BackgroundMedia { id: wallpaper + objectName: "lockWallpaper" anchors.fill: parent - path: root.video ? "" : root.backgroundPath + path: root.loadBackground ? (root.video ? root.videoPosterPath : root.backgroundPath) : "" version: root.backgroundVersion - visible: !root.video - } - - // OWE decodes the video once and feeds these frames to every lock surface. - // The feed pauses when this output blanks or on battery power saver. - Loader { - id: feedLoader - anchors.fill: parent - active: root.video - source: "LockFeedSurface.qml" - visible: status === Loader.Ready - - Binding { - target: feedLoader.item - property: "feedEnabled" - value: root.feedActive - when: feedLoader.item !== null - restoreMode: Binding.RestoreNone - } } MultiEffect { anchors.fill: wallpaper - source: root.video ? null : wallpaper - visible: !root.video + source: wallpaper autoPaddingEnabled: false blurEnabled: root.loadBackground && wallpaper.ready blur: 1.0 @@ -127,6 +109,17 @@ Item { contrast: -0.08 } + // The cached poster stays behind the feed when policy pauses playback, + // the module is unavailable, or a new connection has not received a frame. + Loader { + id: feedLoader + objectName: "lockFeedLoader" + anchors.fill: parent + active: root.feedActive + source: "LockFeedSurface.qml" + visible: status === Loader.Ready + } + // The feed item cannot be sampled by MultiEffect on every renderer. // Keep video wallpapers visible and darken them slightly for legibility. Rectangle { diff --git a/shell/plugins/lock/Service.qml b/shell/plugins/lock/Service.qml index 94d43b68..6e1f703e 100644 --- a/shell/plugins/lock/Service.qml +++ b/shell/plugins/lock/Service.qml @@ -28,6 +28,7 @@ Item { property string failureMessage: "" property int failedAttempts: 0 property string backgroundPath: "" + property string videoPosterPath: "" property int backgroundVersion: 0 property string lastEvent: "init" property string lastEventAt: "" @@ -113,6 +114,16 @@ Item { if (!readlinkProc.running) readlinkProc.running = true } + function refreshPoster() { + if (!root.videoBackground) { + root.videoPosterPath = "" + return + } + if (posterProc.running) return + posterProc.sourcePath = root.backgroundPath + posterProc.running = true + } + function refreshFingerprintStatus() { if (!fingerprintCheckProc.running) fingerprintCheckProc.running = true } @@ -307,6 +318,7 @@ Item { id: lockView anchors.fill: parent backgroundPath: root.backgroundPath + videoPosterPath: root.videoPosterPath backgroundVersion: root.backgroundVersion fingerprintConfigured: root.fingerprintConfigured authenticatingPassword: root.authenticatingPassword @@ -339,6 +351,7 @@ Item { LockView { anchors.fill: parent backgroundPath: root.backgroundPath + videoPosterPath: root.videoPosterPath backgroundVersion: root.backgroundVersion fingerprintConfigured: root.fingerprintConfigured authenticatingPassword: false @@ -409,9 +422,25 @@ Item { onStreamFinished: { var next = String(text || "").trim() if (next !== root.backgroundPath) { + root.videoPosterPath = "" root.backgroundPath = next root.backgroundVersion += 1 } + root.refreshPoster() + } + } + } + + Process { + id: posterProc + property string sourcePath: "" + command: ["bash", Quickshell.env("OMARCHY_PATH") + "/shell/plugins/lock/poster.sh", sourcePath] + stdout: StdioCollector { id: posterOutput; waitForEnd: true } + onExited: function(exitCode) { + if (sourcePath !== root.backgroundPath) { + root.refreshPoster() + } else { + root.videoPosterPath = exitCode === 0 ? String(posterOutput.text || "").trim() : "" } } } diff --git a/shell/plugins/lock/poster.sh b/shell/plugins/lock/poster.sh new file mode 100755 index 00000000..836d01f0 --- /dev/null +++ b/shell/plugins/lock/poster.sh @@ -0,0 +1,24 @@ +#!/bin/bash + +# One cached frame shared by all lock outputs, including when OWE is paused. +set -euo pipefail + +source_path=$1 +cache_dir="${XDG_CACHE_HOME:-$HOME/.cache}/omarchy/lock-poster" +signature=$(stat -Lc '%s:%y:%z' "$source_path") +key=$(printf '%s\n%s' "$source_path" "$signature" | sha256sum | cut -d ' ' -f 1) +poster="$cache_dir/poster-$key.jpg" +mkdir -p "$cache_dir" +exec {lock_fd}>"$cache_dir/.lock" +flock -w 10 "$lock_fd" + +if [[ ! -s $poster ]]; then + temporary=$(mktemp "$cache_dir/.poster-XXXXXX.jpg") + trap 'rm -f "$temporary"' EXIT + timeout -k 1 5 ffmpegthumbnailer -i "$source_path" -o "$temporary" -s 1920 -q 8 {lock_fd}>&- + [[ -s $temporary ]] + mv -f "$temporary" "$poster" + find "$cache_dir" -maxdepth 1 -type f -name 'poster-*.jpg' ! -name "poster-$key.jpg" -delete +fi + +printf '%s\n' "$poster" diff --git a/test/shell.d/fixtures/owe-lock/shell.qml b/test/shell.d/fixtures/owe-lock/shell.qml new file mode 100644 index 00000000..dc9f88fa --- /dev/null +++ b/test/shell.d/fixtures/owe-lock/shell.qml @@ -0,0 +1,69 @@ +import QtQuick +import Quickshell + +ShellRoot { + id: root + property var view + property var wallpaper + property var feed + property int step: 0 + + Item { id: host; width: 1000; height: 700 } + + function findItem(item, name) { + if (item.objectName === name) return item + for (var i = 0; i < item.children.length; i++) { + var found = findItem(item.children[i], name) + if (found) return found + } + return null + } + + function check(condition, message) { + if (!condition) throw new Error(message) + } + + Timer { + interval: 150 + repeat: true + running: true + onTriggered: { + try { + if (root.step === 0) { + var component = Qt.createComponent("file://" + Quickshell.env("OMARCHY_PATH") + "/shell/plugins/lock/LockView.qml") + check(component.status === Component.Ready, component.errorString()) + root.view = component.createObject(host, {width: 1000, height: 700, backgroundPath: "/still.png", loadBackground: false}) + check(root.view !== null, component.errorString()) + root.wallpaper = findItem(root.view, "lockWallpaper") + root.feed = findItem(root.view, "lockFeedLoader") + check(root.wallpaper.path === "", "hidden still must not decode") + root.view.backgroundPath = "/video.mp4" + root.view.videoPosterPath = "/poster.jpg" + } else if (root.step === 1) { + check(!root.feed.active && root.feed.item === null, "hidden video must not load a feed client") + root.view.loadBackground = true + root.view.powerSaverActive = true + } else if (root.step === 2) { + check(root.wallpaper.path === "/poster.jpg", "power saver keeps the video poster") + check(!root.feed.active, "power saver must not connect to the feed") + root.view.powerSaverActive = false + } else if (root.step === 3) { + check(root.feed.active, "visible video enables the isolated feed loader") + check(root.wallpaper.path === "/poster.jpg", "poster stays beneath the feed before its first frame") + root.view.displaysBlank = true + } else if (root.step === 4) { + check(!root.feed.active && root.feed.item === null, "blanking releases the feed client") + root.view.loadBackground = false + } else { + check(root.wallpaper.path === "", "unlock releases the poster image") + console.log("OWE_LOCK_TEST_PASS") + Qt.quit() + } + root.step++ + } catch (error) { + console.error("OWE_LOCK_TEST_FAIL: " + error) + Qt.quit() + } + } + } +} diff --git a/test/shell.d/owe-integration-test.sh b/test/shell.d/owe-integration-test.sh new file mode 100644 index 00000000..cde79db2 --- /dev/null +++ b/test/shell.d/owe-integration-test.sh @@ -0,0 +1,90 @@ +#!/bin/bash +set -euo pipefail +source "$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)/base-test.sh" + +work=$(mktemp -d) +trap 'rm -rf "$work"' EXIT +mkdir -p "$work/bin" "$work/home" +export TEST_CALLS="$work/calls" +for command in omarchy-pkg-add omarchy-hook-install systemctl; do + cat >"$work/bin/$command" <<'SH' +#!/bin/bash +printf '%s %s\n' "${0##*/}" "$*" >>"$TEST_CALLS" +case "$*" in + '--user enable owed.service') [[ ${TEST_TTY:-0} == 0 ]] ;; + '--user is-active --quiet graphical-session.target') [[ ${TEST_TTY:-0} == 0 ]] ;; + '--user start owed.service') [[ ${TEST_START_FAIL:-0} == 0 ]] ;; + *) exit 0 ;; +esac +SH + chmod +x "$work/bin/$command" +done + +migration="$ROOT/migrations/1789764927.sh" +run_migration() { + HOME="$work/home" PATH="$work/bin:$PATH" bash -euo pipefail "$migration" +} +run_migration +run_migration +grep -Fx 'omarchy-pkg-add owe owe-lockfeed' "$TEST_CALLS" >/dev/null +grep -Fx 'omarchy-hook-install theme-set /usr/share/owe/10-owe-sync' "$TEST_CALLS" >/dev/null +grep -Fx 'systemctl --user start owed.service' "$TEST_CALLS" >/dev/null +pass "migration installs OWE, its theme refresh hook, and starts the graphical session service" + +: >"$TEST_CALLS" +TEST_TTY=1 run_migration +TEST_TTY=1 run_migration +[[ $(readlink "$work/home/.config/systemd/user/graphical-session.target.wants/owed.service") == /usr/lib/systemd/user/owed.service ]] +if grep -F 'systemctl --user start' "$TEST_CALLS" >/dev/null; then + fail "TTY migration must not start the renderer" +fi +pass "TTY migrations enable the next login without starting a renderer" + +: >"$TEST_CALLS" +OMARCHY_UPGRADE_TO_QUATTRO_LIVE=1 run_migration +if grep -F 'systemctl --user start' "$TEST_CALLS" >/dev/null; then + fail "Quattro upgrade must defer OWE until the new graphical session" +fi +pass "Quattro upgrade enables OWE without starting it in the old shell" + +if TEST_START_FAIL=1 run_migration; then + fail "a failed live service start leaves the migration pending" +fi +pass "a failed live service start fails the migration" + +: >"$TEST_CALLS" +HOME="$work/home" PATH="$work/bin:$PATH" bash "$ROOT/install/user/first-run/enable-user-units.sh" +grep -E '^systemctl --user enable --now .*owed.service' "$TEST_CALLS" >/dev/null +grep -Fx 'omarchy-hook-install theme-set /usr/share/owe/10-owe-sync' "$TEST_CALLS" >/dev/null +pass "fresh installs enable OWE and install the theme refresh hook" + +cat >"$work/bin/ffmpegthumbnailer" <<'SH' +#!/bin/bash +printf 'thumbnail\n' >>"$TEST_CALLS" +while (( $# )); do + case "$1" in + -o) output=$2; shift 2 ;; + *) shift ;; + esac +done +[[ ${TEST_POSTER_FAIL:-0} == 0 ]] || exit 1 +printf 'poster\n' >"$output" +SH +chmod +x "$work/bin/ffmpegthumbnailer" +source_path="$work/video with 'quotes'.mp4" +printf 'source\n' >"$source_path" +poster() { + PATH="$work/bin:$PATH" XDG_CACHE_HOME="$work/cache" bash "$ROOT/shell/plugins/lock/poster.sh" "$source_path" +} +: >"$TEST_CALLS" +first=$(poster) +[[ -s $first && $(poster) == "$first" ]] +[[ $(wc -l <"$TEST_CALLS") == 1 ]] +printf 'changed source\n' >>"$source_path" +second=$(poster) +[[ -s $second && $second != "$first" && ! -e $first ]] +pass "lock posters are cached, refreshed after source changes, and old frames are evicted" +printf 'broken source\n' >>"$source_path" +if TEST_POSTER_FAIL=1 poster; then fail "failed poster generation must fail"; fi +[[ -z $(find "$work/cache" -name '.poster-*.jpg' -print -quit) ]] +pass "failed poster generation never publishes a partial image" diff --git a/test/shell.d/owe-lock-test.sh b/test/shell.d/owe-lock-test.sh new file mode 100644 index 00000000..4f3831c7 --- /dev/null +++ b/test/shell.d/owe-lock-test.sh @@ -0,0 +1,30 @@ +#!/bin/bash +set -euo pipefail +source "$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)/base-test.sh" + +if ! command -v quickshell >/dev/null 2>&1; then + pass "quickshell unavailable; skipping lock feed QML lifecycle" + exit 0 +fi +work=$(mktemp -d) +trap 'rm -rf "$work"' EXIT +mkdir -p "$work/config" "$work/runtime" "$work/home" +chmod 700 "$work/runtime" +cp "$SHELL_TEST_DIR/fixtures/owe-lock/shell.qml" "$work/config/shell.qml" +ln -s "$ROOT/shell/Ui" "$work/config/Ui" +ln -s "$ROOT/shell/Commons" "$work/config/Commons" + +# Offscreen rendering exercises the real QML bindings without taking a lock +# or connecting to the user's compositor. +HOME="$work/home" XDG_RUNTIME_DIR="$work/runtime" \ + OMARCHY_PATH="$ROOT" QT_QPA_PLATFORM=offscreen QT_QPA_PLATFORMTHEME= \ + QT_STYLE_OVERRIDE= QT_QUICK_BACKEND=software \ + timeout 15 quickshell -p "$work/config" --no-color >"$work/log" 2>&1 || { + cat "$work/log" >&2 + fail "lock feed QML lifecycle runs" + } +if ! grep -q 'OWE_LOCK_TEST_PASS' "$work/log" || grep -q 'OWE_LOCK_TEST_FAIL' "$work/log"; then + cat "$work/log" >&2 + fail "lock feed respects visibility and keeps its poster fallback" +fi +pass "lock feed respects visibility, power saver and blanking; hidden views release images" diff --git a/test/shell.d/video-background-test.sh b/test/shell.d/video-background-test.sh index 31ac754d..761c97a9 100755 --- a/test/shell.d/video-background-test.sh +++ b/test/shell.d/video-background-test.sh @@ -49,11 +49,9 @@ assert( assert( /^import Owe\.LockFeed$/m.test(lockFeedQml) && lockFeedQml.includes('LockFeed {') && - lockFeedQml.includes('active: root.feedEnabled') && lockQml.includes('source: "LockFeedSurface.qml"') && - lockQml.includes('active: root.video') && - /feedActive: root\.video && root\.loadBackground && !root\.displaysBlank && !root\.powerSaverActive/.test(lockQml) && - /property: "feedEnabled"[\s\S]*?value: root\.feedActive/.test(lockQml), + lockQml.includes('active: root.feedActive') && + /feedActive: root\.video && root\.loadBackground && !root\.displaysBlank && !root\.powerSaverActive/.test(lockQml), 'the lock screen shows video through the OWE lock feed, loaded so a missing module costs only the video' ) assert( @@ -61,8 +59,8 @@ assert( 'the lock view itself carries no foreign import, so the lock still loads without the feed module' ) assert( - lockQml.includes('path: root.video ? "" : root.backgroundPath') && - lockQml.includes('visible: !root.video') && + lockQml.includes('path: root.loadBackground ? (root.video ? root.videoPosterPath : root.backgroundPath) : ""') && + lockQml.indexOf('id: feedLoader') > lockQml.indexOf('MultiEffect {') && lockQml.includes('visible: root.video') && !lockQml.includes('wallpaper.video'), 'the lock screen keeps its image effect for stills and shows the feed for videos' From 0d5232ed7bed85b6c099b452602ebb5de192d43a Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Mon, 21 Sep 2026 03:38:10 +0200 Subject: [PATCH 24/36] Fix Elsewhen migration for dev checkouts --- migrations/1789581661.sh | 8 +++++++ .../elsewhen-default-migration-test.sh | 21 ++++++++++++++----- 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/migrations/1789581661.sh b/migrations/1789581661.sh index 7a848550..ad0dfd5e 100644 --- a/migrations/1789581661.sh +++ b/migrations/1789581661.sh @@ -2,5 +2,13 @@ echo "Install Elsewhen, the world clock plugin" omarchy-pkg-add elsewhen +# Dev checkouts do not contain plugins installed by system packages. +packaged_plugin="/usr/share/omarchy/shell/plugins/omacom.elsewhen" +user_plugin="$HOME/.config/omarchy/plugins/omacom.elsewhen" +if [[ ! $OMARCHY_PATH -ef /usr/share/omarchy && -d $packaged_plugin && ! -e $user_plugin && ! -L $user_plugin ]]; then + mkdir -p "${user_plugin%/*}" + ln -s "$packaged_plugin" "$user_plugin" +fi + omarchy-shell shell rescanPlugins omarchy-bar put omacom.elsewhen --before omarchy.clock diff --git a/test/shell.d/elsewhen-default-migration-test.sh b/test/shell.d/elsewhen-default-migration-test.sh index 585f65ba..0c2565f4 100644 --- a/test/shell.d/elsewhen-default-migration-test.sh +++ b/test/shell.d/elsewhen-default-migration-test.sh @@ -28,11 +28,14 @@ exit 1 SH chmod +x "$test_dir/bin/"* +mkdir -p "$test_dir/packaged/shell/plugins/omacom.elsewhen" +sed "s|/usr/share/omarchy|$test_dir/packaged|g" "$ROOT/migrations/1789581661.sh" >"$test_dir/migration.sh" + plugin="$test_dir/home/.config/omarchy/plugins/omacom.elsewhen" run_migration() { : >"$CALL_LOG" - HOME="$test_dir/home" OMARCHY_PATH="$ROOT" PATH="$test_dir/bin:$ROOT/bin:$PATH" \ - bash -euo pipefail "$ROOT/migrations/1789581661.sh" >"$test_dir/output" 2>&1 + HOME="$test_dir/home" OMARCHY_PATH="${1:-$test_dir/packaged}" PATH="$test_dir/bin:$ROOT/bin:$PATH" \ + bash -euo pipefail "$test_dir/migration.sh" >"$test_dir/output" 2>&1 } if PACKAGE_STATUS=1 run_migration; then @@ -56,22 +59,30 @@ run_migration [[ ! -e $plugin && ! -L $plugin ]] || fail "rerunning the migration does not create a user plugin link" pass "migration can be rerun without a user plugin link" +run_migration "$ROOT" +[[ $(readlink "$plugin") == "$test_dir/packaged/shell/plugins/omacom.elsewhen" ]] || fail "dev checkout links the packaged plugin" +pass "dev checkout discovers Elsewhen through a user plugin link" +run_migration "$ROOT" +[[ $(readlink "$plugin") == "$test_dir/packaged/shell/plugins/omacom.elsewhen" ]] || fail "dev link survives a rerun" +pass "dev link is idempotent" +rm "$plugin" + mkdir -p "$plugin" printf 'local work\n' >"$plugin/notes" -run_migration +run_migration "$ROOT" [[ ! -L $plugin && $(cat "$plugin/notes") == "local work" ]] || fail "existing checkout is preserved" pass "existing checkout and local files are preserved" rm "$plugin/notes" rmdir "$plugin" ln -s "$test_dir/custom-plugin" "$plugin" -run_migration +run_migration "$ROOT" [[ $(readlink "$plugin") == "$test_dir/custom-plugin" ]] || fail "existing symlink is preserved" pass "existing symlink is preserved, including a missing target" for failure in 'SCAN_STATUS=1' 'TEST_PUT_RESULT=unknown'; do if env "$failure" HOME="$test_dir/home" OMARCHY_PATH="$ROOT" PATH="$test_dir/bin:$ROOT/bin:$PATH" \ - bash -euo pipefail "$ROOT/migrations/1789581661.sh" >"$test_dir/output" 2>&1; then + bash -euo pipefail "$test_dir/migration.sh" >"$test_dir/output" 2>&1; then fail "$failure must leave the migration pending" fi pass "$failure leaves the migration pending" From c0ba99670d5cc3a52832e079053e59182c9b6acd Mon Sep 17 00:00:00 2001 From: Ryan Hughes Date: Mon, 21 Sep 2026 02:14:54 -0400 Subject: [PATCH 25/36] Clean up legacy screenshot tools in Omasnap migration --- migrations/1788129995.sh | 9 ++++-- test/shell.d/omasnap-test.sh | 63 +++++++++++++++++++++++++++++++++--- 2 files changed, 66 insertions(+), 6 deletions(-) diff --git a/migrations/1788129995.sh b/migrations/1788129995.sh index 041a3ef8..965e01db 100644 --- a/migrations/1788129995.sh +++ b/migrations/1788129995.sh @@ -1,13 +1,18 @@ -echo "Replace Tensaku with Omasnap" +echo "Replace Satty and Tensaku with Omasnap" omarchy-pkg-add omasnap +# The old source installer left a NoDisplay entry that overrides the packaged launcher. +rm -f "$HOME/.local/share/applications/omasnap.desktop" + imv_config="$HOME/.config/imv/config" if [[ -f $imv_config ]]; then sed -i --follow-symlinks \ -e 's/^# Edit the current image in Tensaku and quit the viewer$/# Edit the current image in Omasnap and quit the viewer/' \ + -e 's/^# Edit the current image in Satty and quit the viewer$/# Edit the current image in Omasnap and quit the viewer/' \ -e 's|^ = exec tensaku-edit "$imv_current_file" & ; quit$| = exec omasnap "$imv_current_file" \& ; quit|' \ + -e 's|^ = exec satty --filename "$imv_current_file" & ; quit$| = exec omasnap "$imv_current_file" \& ; quit|' \ "$imv_config" fi -omarchy-pkg-drop tensaku +omarchy-pkg-drop satty tensaku diff --git a/test/shell.d/omasnap-test.sh b/test/shell.d/omasnap-test.sh index 342e5f8f..abf3293c 100644 --- a/test/shell.d/omasnap-test.sh +++ b/test/shell.d/omasnap-test.sh @@ -9,7 +9,8 @@ migration="$ROOT/migrations/1788129995.sh" grep -qxF omasnap "$packages" || fail "fresh installs include Omasnap" ! grep -qxF tensaku "$packages" || fail "fresh installs no longer include Tensaku" -pass "fresh installs use Omasnap as the screenshot editor" +! grep -qxF satty "$packages" || fail "fresh installs no longer include Satty" +pass "fresh installs use Omasnap as the screenshot tool" grep -Fq 'namespace = "^omasnap$"' "$ROOT/default/hypr/apps/screenshot-selection.lua" || fail "Omasnap has a layer rule" @@ -63,6 +64,7 @@ pass "the Omarchy screenshot route delegates compatible arguments to Omasnap" cat >"$stub_bin/omarchy-pkg-add" <<'SH' #!/bin/bash printf 'add\t%s\n' "$*" >>"$OMASNAP_MIGRATION_LOG" +exit "${OMASNAP_PACKAGE_STATUS:-0}" SH cat >"$stub_bin/omarchy-pkg-drop" <<'SH' #!/bin/bash @@ -82,11 +84,16 @@ EOF ln -s "$migration_home/dotfiles/imv.config" "$migration_home/.config/imv/config" migration_log="$test_tmp/migration.log" -OMASNAP_MIGRATION_LOG="$migration_log" HOME="$migration_home" PATH="$stub_bin:$PATH" \ - bash -euo pipefail "$migration" >/dev/null +run_migration() { + : >"$migration_log" + OMASNAP_MIGRATION_LOG="$migration_log" HOME="$migration_home" PATH="$stub_bin:$PATH" \ + bash -euo pipefail "$migration" >/dev/null +} + +run_migration [[ $(sed -n '1p' "$migration_log") == $'add\tomasnap' ]] || fail "the migration installs Omasnap first" -[[ $(sed -n '2p' "$migration_log") == $'drop\ttensaku' ]] || fail "the migration removes Tensaku after Omasnap is ready" +[[ $(sed -n '2p' "$migration_log") == $'drop\tsatty tensaku' ]] || fail "the migration removes Satty and Tensaku after Omasnap is ready" grep -Fq '# Edit the current image in Omasnap and quit the viewer' "$migration_home/.config/imv/config" || fail "the migration updates the stock imv editor comment" grep -Fq ' = exec omasnap "$imv_current_file" & ; quit' "$migration_home/.config/imv/config" || @@ -97,3 +104,51 @@ grep -Fq ' = exec custom-editor "$imv_current_file" & ; quit' "$migratio [[ $(stat -c '%a' "$migration") == 644 ]] || fail "the Omasnap migration has mode 0644" pass "the migration swaps packages and safely updates only the stock imv binding" + +cat >"$migration_home/dotfiles/imv.config" <<'EOF' +[binds] + +# Edit the current image in Satty and quit the viewer + = exec satty --filename "$imv_current_file" & ; quit + = exec custom-editor "$imv_current_file" & ; quit +EOF +cp "$migration_home/dotfiles/imv.config" "$test_tmp/imv-before" +legacy_desktop="$migration_home/.local/share/applications/omasnap.desktop" +mkdir -p "$(dirname "$legacy_desktop")" +cat >"$legacy_desktop" <<'EOF' +[Desktop Entry] +Type=Application +Name=Omasnap +Exec=omasnap +NoDisplay=true +EOF +if OMASNAP_PACKAGE_STATUS=1 run_migration; then + fail "Omasnap install failure stops the migration" +fi +[[ $(<"$migration_log") == $'add\tomasnap' ]] || fail "install failure leaves old screenshot packages installed" +cmp -s "$test_tmp/imv-before" "$migration_home/dotfiles/imv.config" || fail "install failure leaves the imv binding untouched" +[[ -f $legacy_desktop ]] || fail "install failure preserves the existing launcher entry" +pass "Omasnap install failure preserves the previous screenshot setup" + +run_migration +[[ ! -e $legacy_desktop && ! -L $legacy_desktop ]] || fail "the migration removes the old user-local Omasnap desktop entry" +pass "the migration removes the desktop entry that hides the packaged launcher" +grep -Fq '# Edit the current image in Omasnap and quit the viewer' "$migration_home/.config/imv/config" || + fail "the migration updates the stock Satty comment" +grep -Fq ' = exec omasnap "$imv_current_file" & ; quit' "$migration_home/.config/imv/config" || + fail "the migration replaces the stock Satty binding before removing Satty" +grep -Fq ' = exec custom-editor "$imv_current_file" & ; quit' "$migration_home/.config/imv/config" || + fail "the Satty migration preserves custom bindings" +[[ -L $migration_home/.config/imv/config ]] || fail "the Satty migration preserves the imv symlink" +pass "the migration upgrades the stock Satty binding to Omasnap" + +cp "$migration_home/dotfiles/imv.config" "$test_tmp/imv-migrated" +run_migration +cmp -s "$test_tmp/imv-migrated" "$migration_home/dotfiles/imv.config" || fail "rerunning the migration preserves the updated imv config" +pass "the migration can be rerun" + +printf ' = exec custom-editor "$imv_current_file" & ; quit\n' >"$migration_home/dotfiles/imv.config" +cp "$migration_home/dotfiles/imv.config" "$test_tmp/imv-custom" +run_migration +cmp -s "$test_tmp/imv-custom" "$migration_home/dotfiles/imv.config" || fail "the migration preserves a custom edit shortcut" +pass "custom imv edit shortcuts remain unchanged" From 95120838d3c75f152879ee9d8eaa024bf3cf5404 Mon Sep 17 00:00:00 2001 From: Ryan Hughes Date: Mon, 21 Sep 2026 02:14:55 -0400 Subject: [PATCH 26/36] Document Omasnap's default capture flow --- agents/skills/visual-verification.md | 2 +- default/agents/skills/omarchy/capture.md | 5 +++-- manual/12-screenshots-recording.md | 11 ++++++----- manual/46-faq.md | 2 +- 4 files changed, 11 insertions(+), 9 deletions(-) diff --git a/agents/skills/visual-verification.md b/agents/skills/visual-verification.md index 7df6caa1..a8ed63d7 100644 --- a/agents/skills/visual-verification.md +++ b/agents/skills/visual-verification.md @@ -15,7 +15,7 @@ Take a full-screen screenshot without opening the editor: omarchy capture screenshot fullscreen save ``` -The command writes to Omasnap's configured screenshot directory. Use `omarchy screenshot` for the interactive editor flow. Capture reference and candidate states as separate images when changing a layer-shell surface or layout, then compare both. +The command writes to Omasnap's configured screenshot directory. Use `omarchy screenshot` for the interactive capture flow, which copies the capture and shows a timed preview. Use `omarchy screenshot --editor=overlay` to test annotation before output. Capture reference and candidate states as separate images when changing a layer-shell surface or layout, then compare both. Record a short full-screen video for animation, transition, timing, capture, or screen-recording changes: diff --git a/default/agents/skills/omarchy/capture.md b/default/agents/skills/omarchy/capture.md index 4390fe75..a898db86 100644 --- a/default/agents/skills/omarchy/capture.md +++ b/default/agents/skills/omarchy/capture.md @@ -10,10 +10,11 @@ omarchy screenshot # Interactive smart-region flow omarchy capture screenshot region # Select a region omarchy capture screenshot windows # Pick a window omarchy capture screenshot fullscreen save # Full screen, straight to disk (no editor) -omarchy capture screenshot scroll # Capture and stitch a scrolling region +omarchy capture screenshot scroll # Capture and stitch a scrolling region +omarchy screenshot --editor=overlay # Opt into annotation before output ``` -The first argument picks the Omasnap mode (`smart|region|windows|fullscreen|scroll`). With no second argument, the selection opens in Omasnap's annotation editor; `copy` or `save` skips the editor and sends the screenshot straight to that destination. Screenshots land in `~/Pictures/Screenshots` by default (override with `OMASNAP_SCREENSHOT_DIR`; the legacy `OMARCHY_SCREENSHOT_DIR` is also honored by the Omarchy command). +The first argument picks the Omasnap mode (`smart|region|windows|fullscreen|scroll`). By default, a capture copies to the clipboard and shows a preview for 10 seconds. Use the preview's Edit action to annotate, or pass `--editor=overlay` or `--editor=window` to edit before output. A second argument of `copy` or `save` skips the preview and sends the screenshot straight to that destination. Saved screenshots land in `~/Pictures/Screenshots` by default (override with `OMASNAP_SCREENSHOT_DIR`; the legacy `OMARCHY_SCREENSHOT_DIR` is also honored by the Omarchy command). ## Screen Recording diff --git a/manual/12-screenshots-recording.md b/manual/12-screenshots-recording.md index b3447b57..41d6052d 100644 --- a/manual/12-screenshots-recording.md +++ b/manual/12-screenshots-recording.md @@ -13,13 +13,15 @@ Everything you can grab off the screen hangs off the Print Screen key. One key o ## Screenshots -Hit `Print Screen` and Omasnap captures the focused monitor before its overlay appears, so nothing shifts under you while you aim. Drag a freeform region, or use the tabs across the top to switch between Region, Scrolling Region, Window, and Fullscreen capture. Changed your mind? Hit `Print Screen` again to dismiss Omasnap. +Hit `Print Screen` and Omasnap captures the focused monitor before its overlay appears, so nothing shifts under you while you aim. Drag a freeform region, click a window to capture it, or click open space to capture the whole monitor. Press `S` before drawing to capture a scrolling region. Changed your mind? Hit `Print Screen` again to dismiss Omasnap. -After you select an area, Omasnap opens its annotation editor. It can draw arrows, lines, shapes, highlights, numbered markers, text, and secure redactions; crop or cut out part of the image; OCR its text; and add a backdrop. Press `Enter` to copy and save the finished PNG, `Ctrl + C` to copy it without saving, `Ctrl + S` to save it without copying, or `P` to pin it above your windows. +After you select an area, Omasnap copies the capture to the clipboard and shows a preview for 10 seconds. Use the preview's pin button or `Ctrl + P` to keep it on screen, or choose Edit to annotate it. -Files land in `~/Pictures/Screenshots` by default, with a name such as `screenshot-2026-08-13_14-22-05-firefox.png`. Set `OMASNAP_SCREENSHOT_DIR` to use another directory — see [the FAQ](46-faq.md) for where to put session environment variables. Omasnap creates the directory when it saves the first shot. +The annotation editor can draw arrows, lines, shapes, highlights, numbered markers, text, and secure redactions; crop or cut out part of the image; OCR its text; and add a backdrop. In the editor, press `Enter` to copy and save the finished PNG, `Ctrl + C` to copy it without saving, or `Ctrl + S` to save it without copying. -From the terminal, `omarchy screenshot` opens the same overlay, and you can choose its starting mode: `omarchy capture screenshot region`, `windows`, `fullscreen`, or `scroll`. A second argument of `copy` or `save` bypasses the annotation editor and sends the shot straight to that destination. +Saved screenshots land in `~/Pictures/Screenshots` by default, with a name such as `screenshot-2026-08-13_14-22-05-firefox.png`. Set `OMASNAP_SCREENSHOT_DIR` to use another directory — see [the FAQ](46-faq.md) for where to put session environment variables. Omasnap creates the directory when it saves the first shot. + +From the terminal, `omarchy screenshot` opens the same overlay, and you can choose its starting mode: `omarchy capture screenshot region`, `windows`, `fullscreen`, or `scroll`. A second argument of `copy` or `save` skips the preview and sends the shot straight to that destination. To edit before output, use `omarchy screenshot --editor=overlay` for a fullscreen editor or `omarchy screenshot --editor=window` for a separate window. ### Driving the picker from the keyboard @@ -27,7 +29,6 @@ While the selection is up, you don't have to use the mouse at all: | Key | Function | | --- | -------- | -| `Space` | Step through Region, Scrolling Region, and Window modes | | `S` | Toggle scrolling-region mode | | `Super + Arrow keys` | Move among windows in Window mode | | `Return` | Capture the highlighted window | diff --git a/manual/46-faq.md b/manual/46-faq.md index 8985439b..5def15d6 100644 --- a/manual/46-faq.md +++ b/manual/46-faq.md @@ -54,7 +54,7 @@ Automatic discovery, where printers on the network appear without being added, i ### How do I change where screenshots or screenrecordings are saved? -Omasnap saves screenshots to `~/Pictures/Screenshots` by default. To use another directory, add this to a file under `~/.config/uwsm/env.d/` (like `~/.config/uwsm/env.d/capture`): +Saved screenshots go to `~/Pictures/Screenshots` by default. To use another directory, add this to a file under `~/.config/uwsm/env.d/` (like `~/.config/uwsm/env.d/capture`): ``` export OMASNAP_SCREENSHOT_DIR="$HOME/Pictures/Captures" From b094787f1ad258bce3e4848109023a2a321bcb1f Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Mon, 21 Sep 2026 10:09:24 +0200 Subject: [PATCH 27/36] Point shell documentation to the canonical reference --- manual/32-shell-plugins.md | 2 +- shell/README.md | 305 +------------------------------------ 2 files changed, 7 insertions(+), 300 deletions(-) diff --git a/manual/32-shell-plugins.md b/manual/32-shell-plugins.md index 38ae4001..fc83a16f 100644 --- a/manual/32-shell-plugins.md +++ b/manual/32-shell-plugins.md @@ -95,7 +95,7 @@ omarchy plugin validate ./my-plugin That runs the same checks the shell does at load time: the schema version, the required fields, an id that isn't reserved, entry points that are safe relative paths and actually exist, an entry point for every kind you claimed, and no symlinks anywhere inside the folder. -For the full picture, the source is the documentation: `shell/README.md` in the Omarchy repo covers the manifest schema, the shell's IPC contract, and the exact shape of `shell.json`, and `shell/plugins/README.md` lists every first-party plugin with its id, kinds, and entry points. +For plugin development, see the [shell reference](https://github.com/omacom/omarchy/blob/quattro/docs/omarchy-shell.md) and [first-party plugin catalog](https://github.com/omacom/omarchy/blob/quattro/shell/plugins/README.md). ## Sharing yours with the world diff --git a/shell/README.md b/shell/README.md index ca07b520..5d464a0d 100644 --- a/shell/README.md +++ b/shell/README.md @@ -1,302 +1,9 @@ # Omarchy shell -`omarchy-shell` is a single long-running [Quickshell](https://quickshell.org/) -instance that hosts the Omarchy desktop. Hyprland autostart launches one shell -per graphical session; everything else — the bar, background switcher, panels, -and overlays — runs **inside** the shell as a plugin. +The Omarchy desktop runs in one long-lived Quickshell process. Its bar, panels, overlays, menus, and services are plugins hosted by `shell.qml`. -Hosting everything inside one shell means: - -- shared services and singletons live once, not once per process -- summoning a panel is an IPC call into a process that is already running, - not a fresh `quickshell -p ...` cold start -- third-party plugins can be loaded from disk without changing any source - code in Omarchy itself - -The runtime layout: - -``` -shell/ - shell.qml entry point (ShellRoot) - services/ - PluginRegistry.qml discovers, validates plugins, looks up enabled state in shell.json - BarWidgetRegistry.qml unified registry for bar widgets (1p + 3p) - plugins/ - bar/ first-party plugins (see plugins/README.md) - image-picker/ - menu/ - notifications/ - panels/ - audio/ - bluetooth/ - monitor/ - network/ - power/ - weather/ - agents/ - services/ - battery/ - idle/ - osd/ - polkit/ -``` - -The plugin discovery path is documented in [plugins/README.md](plugins/README.md). - -## Plugin manifest - -Every plugin ships a `manifest.json` describing what it is and how the -shell should load it. Minimal example: - -```json -{ - "schemaVersion": 1, - "id": "my.org.cool-clock", - "name": "Cool clock", - "version": "1.0.0", - "author": "You", - "description": "A clock that does cool things", - "kinds": ["bar-widget"], - "entryPoints": { "barWidget": "Widget.qml" }, - "barWidget": { - "displayName": "Cool clock", - "category": "Time", - "allowMultiple": false, - "defaultSection": "left", - "defaults": { "format": "HH:mm" }, - "schema": [ - { "key": "format", "type": "string", "label": "Format" } - ] - } -} -``` - -Supported `kinds`: - -| Kind | What it is | -|--------------|--------------------------------------------------------------| -| `bar-widget` | A component that the active bar can drop into a section | -| `panel` | A persistent or summoned floating window (e.g. OSD) | -| `overlay` | A fullscreen overlay (e.g. background switcher) | -| `menu` | A summoned menu surface | -| `service` | A headless singleton, no UI | -| `bar` | A full bar option that can replace the built-in `omarchy.bar` | - -Only one `bar` plugin is active at a time. Missing or invalid selections fall -back to the built-in `omarchy.bar`, so users always have a safe path home. -Panels, overlays, and menus are loaded when summoned. Plugins that need -to outlive a single summon can set `keepLoaded: true` (e.g. the image -picker keeps its overlay window mounted between summons). The same flag -keeps a service mounted across plugin hot-reload, so tearing down a -changed bar widget cannot destroy `omarchy.lock` while Hyprland still -holds the session lock. The kept instance is not replaced, so code -changes to a `keepLoaded` service itself only take effect on a shell -restart. First-party services are loaded at startup. - -Entry points may declare `omarchyPath`, `shell`, `manifest`, `pluginRegistry`, and `barWidgetRegistry` properties for host injection. Built-in plugins receive the trusted host objects. Third-party plugins receive capability-scoped facades: ordinary plugins can look up and control only their own service and lifecycle, built-in clones retain narrow source-specific configuration and UI compatibility, menu plugins receive an application-library facade, and plugins can read detached scalar bar state. A full-bar plugin additionally receives detached bar configuration and widget-catalog snapshots, narrow proxies for the non-authentication services used by built-in bar widgets, and lifecycle control over configured non-authentication UI plugins. Authentication capabilities are stamped from trusted first-party manifests, authentication services are retained outside the host's public service map and QML object tree, and changing a third-party registry or configuration snapshot cannot mutate host state. Facades do not isolate visual widgets from the parent hierarchy of the shared QML scene, so sensitive state must remain outside that reachable graph. - -Widgets rendered by a third-party replacement bar receive a service-less entry facade with target-scoped lifecycle and settings operations. Their live service objects are available only when the trusted built-in bar hosts them; otherwise the replacement bar could request and retain any configured widget's service. - -The full schema lives in `services/PluginRegistry.qml`. - -## Installing a third-party plugin - -A plugin is a **git repo** with a `manifest.json` at its root. Adding one -clones it straight into `~/.config/omarchy/plugins//` (named by the -manifest id); updating is a fast-forward pull of that checkout. - -```bash -omarchy plugin add https://github.com/acme/omarchy-weather.git -omarchy plugin update acme.weather # fetches, shows a diff, fast-forwards -omarchy plugin update # updates every git-managed plugin -omarchy plugin remove acme.weather -``` - -> ⚠️ **Plugins run as unsandboxed code inside `omarchy-shell`.** Adding warns you before cloning, plugins land disabled so you can review the code before enabling, and updates show a diff of the changes before touching anything. The scoped QML interfaces remove direct authentication-service and generic replacement-bar service lookups, but visual plugins still share and can traverse the ordinary host scene. Only add repos whose code you are willing to run. - -Each command is **interactive** when run bare in a terminal (gum pickers, -confirmation, a diff to review) and fully **non-interactive** when given -arguments. Pass `--yes` to skip every prompt — this is the path for scripts and -AI agents: - -```bash -omarchy plugin add https://github.com/acme/omarchy-weather.git --enable --yes -omarchy plugin update --yes -``` - -The installer never runs plugin code, install hooks, or sudo — it only clones -files, validates the manifest, and toggles enabled state over shell IPC. Since -an installed plugin is a plain git checkout, anything beyond add/update -(pinning a ref, switching branches) is ordinary git in the plugin directory. - -### Installing by hand - -You can still drop a plugin in without git: - -1. Put it in `~/.config/omarchy/plugins//` with a `manifest.json` - plus the QML referenced from its `entryPoints`. -2. `omarchy-shell shell rescanPlugins`. -3. `omarchy plugin enable `. Bar widgets start in - `barWidget.defaultSection`, or in the center when it is omitted, and can be - moved with `omarchy bar move`; a full bar replaces the one in use. - -The lower-level IPC equivalents remain available via `omarchy-shell shell rescanPlugins`, -`omarchy-shell shell enablePlugin '{}'`, and `omarchy-shell shell listPlugins`. -The `omarchy plugin` commands wrap those calls. `omarchy bar move` and -`omarchy bar set` edit the persisted widget layout in `shell.json`. - -To hack on a built-in plugin safely, clone it into user config instead of -editing the built-in source. The complete plugin directory is copied, including -every declared kind and local dependency. A built-in id such as -`omarchy.clock` becomes `.clock` (e.g. `dhh.clock`), with `My Clock` -as its display name. The username prefix keeps shared clones from colliding -with each other or with other plugin authors. - -```bash -omarchy plugin clone omarchy.clock -``` - -Cloning switches from the built-in to the new personal plugin, preserving an -existing bar widget's position and settings. Setup > Plugins > Clone provides -the interactive picker, then opens the new `.*` directory in `$EDITOR`. -Existing shortcuts and shell IPC calls made to the built-in id are routed to -the enabled clone, so cloning does not require changing its callers. Removing -an active clone switches back to its built-in source. -Saving a file anywhere under `~/.config/omarchy/plugins/` reloads plugin code -automatically; `omarchy-shell shell rescanPlugins` remains available to force a reload. - -First-party plugins under `shell/plugins/` are discovered the same way and load -by default. Disabling a non-widget records it in `disabledPlugins[]`; disabling -a widget removes it from the bar layout while leaving its component available -to add again. A full bar has no off state and is replaced by enabling another. - -## IPC contract - -The shell exposes a single `shell` IPC target plus whatever extra targets -individual plugins register (e.g. the bar's `bar` target for refresh -hooks, the image picker's `image-selector` target). `omarchy-menu` uses the -shell target to summon the first-party `omarchy.menu` plugin instead of -running a separate Quickshell instance. - -| Method | Returns | Effect | -|------------------------------------------|---------|-------------------------------------------------------| -| `ping` | `ok` | health check | -| `summon ` | `ok` / `unknown` | load + open a panel/overlay plugin | -| `hide ` | — | close a previously-summoned plugin | -| `toggle ` | — | summon if closed, hide if open | -| `call ` | string | call a method on an already-loaded plugin | -| `rescanPlugins` | — | re-walk plugin dirs and hot-reload plugin code | -| `reloadConfig` | `ok` | reload `~/.config/omarchy/shell.json` | -| `setPluginEnabled ` | `ok` / `unknown` | flip the persisted enabled bit (see note) | -| `listPlugins` | JSON | every discovered plugin, sorted by name | - -Direct invocation: - -``` -quickshell ipc -p $OMARCHY_PATH/shell call shell ping -``` - -Hyprland autostart launches the shell directly with `quickshell -p -$OMARCHY_PATH/shell`. Use `omarchy-restart-shell` to stop every running -instance of that config and launch one fresh shell process. - -A convenience wrapper, [`omarchy-shell`](../bin/omarchy-shell), forwards IPC -calls to the running shell. It does not start the shell. - -``` -omarchy-shell shell ping -omarchy-shell shell toggle omarchy.menu '{"menu":"root"}' -omarchy-shell shell listPlugins -omarchy-shell shell rescanPlugins -``` - -**Note on `setPluginEnabled`:** the `enabled` argument is a string. Only the -literal `"true"` enables the plugin; every other value (including `"True"`, -`"1"`, `"yes"`, or omitted) disables it. This keeps the IPC surface -type-stable across QML's `string`-only IPC arguments. - -## Persisted state - -There is one user config file. Everything that distinguishes your -customization from the shipped defaults lives in it. - -| Path | Owner | Purpose | -|-----------------------------------|----------------|--------------------------------------------------------| -| `~/.config/omarchy/shell.json` | the shell | full layout + per-entry settings + enabled plugin list | -| `~/.config/omarchy/plugins//` | user | drop-in third-party plugin source files | - -The `config/omarchy/shell.json` default config describes the -fresh-install state. When the user has no `shell.json`, the shell uses -the defaults verbatim. Once the user customizes anything, `shell.json` -becomes the authoritative file — we do **not** deep-merge defaults back in. - -### shell.json shape - -```json -{ - "version": 1, - "idle": { - "screensaver": 150, - "lock": 300 - }, - "bar": { - "id": "omarchy.bar", - "position": "top", - "transparent": false, - "centerAnchor": "omarchy.clock", - "layout": { - "left": [ { "id": "omarchy.menu" }, { "id": "omarchy.workspaces" } ], - "center": [ { "id": "omarchy.clock", "format": "HH:mm" } ], - "right": [ - { "id": "omarchy.audio" } - ] - } - }, - "plugins": [] -} -``` - -### Storage rules - -1. **The active bar option is `bar.id`.** Omit it or set it to `omarchy.bar` - to use the built-in bar. Set it to another plugin id whose manifest declares - `kind: "bar"` to replace the full bar. -2. **Every plugin instance is one entry.** Either in `bar.layout.
` - for bar widgets, or in `plugins[]` for panels, overlays, services, - menus, and anything else non-bar. -3. **Settings are inline on the entry.** No `config:` sub-object, no - separate per-plugin settings file, no merge layers. The fields on each - entry are the values the plugin sees. -4. **Built-in widget ids are namespaced.** Use ids such as `omarchy.clock`, - `omarchy.audio`, and `omarchy.network`. The migration rewrites older ids - like `Clock` and `AudioPanel` forward. -5. **Third-party enabled ⇔ present.** A third-party plugin is enabled iff - its id appears somewhere in shell.json. For full bar options, that means - `bar.id`; for bar widgets, plugin enable/disable adds/removes layout entries; - other plugin kinds are enabled the same way. First-party non-bar plugins - are enabled unless listed in `disabledPlugins[]`. -6. **Multiple instances** are allowed when a manifest sets - `allowMultiple: true`. Each instance is independent — e.g. two clock - widgets in different timezones are just two `{"id":"omarchy.clock", "timezone": ...}` - entries with their own values. -7. **Idle timings are top-level.** `idle.screensaver` and `idle.lock` - are seconds since user idle began, so the default lock fires at 300s - even if the 150s screensaver starts first. -8. **`version: 1` is required** at the top level. The shell will fall back - to defaults rather than load an unknown version. - -## Implementation history - -Built up in phases on this branch: - -- Phase 1 — `omarchy-shell phase 1: host the existing bar in a single shell` -- Phase 2 — `omarchy-shell phase 2: plugin registry and bar widget registry` -- Phase 3 — `omarchy-shell phase 3: fold bar-settings into the shell as a panel plugin` -- Phase 4 — `omarchy-shell phase 4: absorb background-switcher as a plugin` -- Phase 5 — `omarchy-shell phase 5: docs, cleanup, and migration crumbs` -- Phase 6 — `omarchy-shell phase 6: reviewer cleanup (path traversal, collision, races)` -- Phase 7 — `omarchy-shell phase 7: replace socket with IpcHandler, rename to image-picker` -- Phase 8a — `omarchy-shell phase 8a: unified shell.json with inline plugin settings` - -Shared services and Pipewire/UPower/Hyprland consolidation are explicitly -out of scope here and deferred to a follow-up after a review pass. +- [Shell reference](../docs/omarchy-shell.md) — plugin manifests, IPC, configuration, and shared UI contracts. +- [Plugin user guide](../manual/32-shell-plugins.md) — install, configure, and clone plugins. +- [First-party plugins](plugins/README.md) — bundled plugin IDs, kinds, and entry points. +- [Shell development guide](../agents/skills/shell-dev.md) — conventions for changing the desktop. +- [Theming reference](../docs/theming.md) — theme tokens, templates, and generated configuration. From 1aa1423eac60471b5d385b4c17dcb595add27572 Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Mon, 21 Sep 2026 10:10:02 +0200 Subject: [PATCH 28/36] Retire the shipped Copy URL migration test --- .../copy-url-shortcut-migration-test.sh | 238 ------------------ 1 file changed, 238 deletions(-) delete mode 100644 test/shell.d/copy-url-shortcut-migration-test.sh diff --git a/test/shell.d/copy-url-shortcut-migration-test.sh b/test/shell.d/copy-url-shortcut-migration-test.sh deleted file mode 100644 index 934a57ee..00000000 --- a/test/shell.d/copy-url-shortcut-migration-test.sh +++ /dev/null @@ -1,238 +0,0 @@ -#!/bin/bash - -set -euo pipefail - -source "$(dirname "${BASH_SOURCE[0]}")/base-test.sh" - -require_command jq -require_command python3 - -migration="$ROOT/migrations/1786643346.sh" -test_dir=$(mktemp -d) -trap 'rm -rf "$test_dir"' EXIT - -home="$test_dir/home" -profile_root="$home/.config/chromium" -preferences="$profile_root/Default/Preferences" -mkdir -p "$(dirname "$preferences")" - -# Any id Chromium once derived from the extension's keyless load path; the -# repair keys off the registered command name, not the id. -ghost_id="ikkebdkaanlebnifjnbeiaklodhbjcci" -pinned_id="bgpiichlckmfanooecilcjemknkcpngb" - -write_stale_preferences() { - jq -n --arg ghost "$ghost_id" --arg pinned "$pinned_id" '{extensions: {commands: {"linux:Alt+Shift+L": {command_name: "copy-url", extension: $ghost, global: false}}, settings: {($ghost): {commands: {"copy-url": {suggested_key: "Alt+Shift+L", was_assigned: true}}}, ($pinned): {commands: {"copy-url": {suggested_key: "Alt+Shift+L"}}}}}}' >"$preferences" -} - -stub_bin="$test_dir/bin" -mkdir -p "$stub_bin" - -cat >"$stub_bin/python3" <<'STUB' -#!/bin/bash -exit 127 -STUB -chmod +x "$stub_bin/python3" - -# Test stubs must delegate to the system interpreter, not a user shim that can -# route python3 back through the stubs and recurse. -REAL_PYTHON=$(PATH="$stub_bin:$PATH" command -p -v python3) -[[ $REAL_PYTHON != "$stub_bin/python3" ]] || fail "real Python resolution bypasses user shims" -export REAL_PYTHON -rm -f "$stub_bin/python3" - -run_migration() { - HOME="$home" PATH="$stub_bin:$PATH" bash -euo pipefail "$migration" >/dev/null 2>&1 -} - -# A running Chromium-family browser marks its profile root with a SingletonLock -# symlink to -, a target that never exists on disk. That lock — -# not the mere presence of a browser process — is what the migration waits on. -open_browser() { - mkdir -p "$profile_root" - ln -sfn "test-host-1234" "$profile_root/SingletonLock" -} -close_browser() { - rm -f "$profile_root/SingletonLock" -} - -# The affected profile being open prompts for the windows to be closed; -# declining (or having no terminal to ask in) defers the repair so a -# rewrite-on-exit cannot revert it. -printf '#!/bin/bash\nexit 1\n' >"$stub_bin/gum" -chmod +x "$stub_bin/gum" -write_stale_preferences -open_browser - -before_hash=$(sha256sum "$preferences" | cut -d' ' -f1) - -run_migration && fail "migration defers while the affected profile is open" -[[ $(sha256sum "$preferences" | cut -d' ' -f1) == "$before_hash" ]] || - fail "migration leaves preferences alone while the affected profile is open" -pass "migration defers the repair while the affected profile is open" - -# gum paints its prompt on stderr, so that stream has to stay attached: -# suppressing it leaves gum reading keys behind an unpainted screen, which -# reads as a hung update. -cat >"$stub_bin/gum" <<'STUB' -#!/bin/bash -echo "gum-prompt-painted" >&2 -exit 1 -STUB -prompt_stderr="$test_dir/prompt-stderr" -HOME="$home" PATH="$stub_bin:$PATH" bash -euo pipefail "$migration" >/dev/null 2>"$prompt_stderr" && - fail "migration defers when the browser prompt is declined" -grep -q "gum-prompt-painted" "$prompt_stderr" || fail "migration keeps the browser prompt visible" -pass "migration keeps the browser prompt visible" - -# A browser holding a different profile root cannot revert this repair, so it -# must not hold the update: the repair goes through without ever reaching the -# prompt, which the still-declining gum stub would otherwise fail. -close_browser -mkdir -p "$home/.config/google-chrome" -ln -sfn "test-host-1234" "$home/.config/google-chrome/SingletonLock" -write_stale_preferences -run_migration || fail "migration repairs while a different profile root is open" -jq -e --arg pinned "$pinned_id" '.extensions.commands["linux:Alt+Shift+L"].extension == $pinned' "$preferences" >/dev/null || - fail "migration repairs the shortcut while a different profile root is open" -pass "migration ignores a browser on a different profile root" -rm -f "$home/.config/google-chrome/SingletonLock" "$preferences.omarchy-copy-url-repair.bak" - -# Closing the affected profile and confirming the prompt lets the repair -# proceed. -write_stale_preferences -open_browser -cat >"$stub_bin/gum" <<'STUB' -#!/bin/bash -"$CLOSE_BROWSER" -touch "${GUM_CALLED:?}" -exit 0 -STUB -cat >"$stub_bin/close-browser" <<'STUB' -#!/bin/bash -rm -f "$HOME/.config/chromium/SingletonLock" -STUB -chmod +x "$stub_bin/gum" "$stub_bin/close-browser" -GUM_CALLED="$test_dir/gum-called" CLOSE_BROWSER="$stub_bin/close-browser" \ - HOME="$home" PATH="$stub_bin:$PATH" bash -euo pipefail "$migration" >/dev/null 2>&1 || - fail "migration proceeds once the profile is closed and the prompt confirmed" -[[ -e $test_dir/gum-called ]] || fail "migration asks before repairing under a running browser" -jq -e --arg pinned "$pinned_id" '.extensions.commands["linux:Alt+Shift+L"].extension == $pinned' "$preferences" >/dev/null || - fail "migration repairs after the browser prompt is confirmed" -pass "migration asks to close the browser and repairs on confirmation" -rm -f "$preferences.omarchy-copy-url-repair.bak" - -# With the affected profile closed the ghost registration moves to the pinned id. -printf '#!/bin/bash\nexit 1\n' >"$stub_bin/gum" -close_browser -write_stale_preferences -run_migration || fail "migration repairs the shortcut when no browser is running" - -jq -e --arg ghost "$ghost_id" --arg pinned "$pinned_id" ' - .extensions.commands["linux:Alt+Shift+L"].extension == $pinned and - (.extensions.settings | has($ghost) | not) and - .extensions.settings[$pinned].commands["copy-url"].was_assigned == true -' "$preferences" >/dev/null || fail "migration rebinds the Copy URL shortcut to the pinned extension id" -[[ -f $preferences.omarchy-copy-url-repair.bak ]] || - fail "migration backs up preferences before the repair" -pass "migration rebinds the Copy URL shortcut to the pinned extension id" - -# A repaired profile has no ghost registration left, so nothing is pending — -# even while that same profile is open. -rm "$preferences.omarchy-copy-url-repair.bak" -repaired_hash=$(sha256sum "$preferences" | cut -d' ' -f1) -open_browser -run_migration || fail "migration reruns cleanly after the repair" -[[ $(sha256sum "$preferences" | cut -d' ' -f1) == "$repaired_hash" && ! -e $preferences.omarchy-copy-url-repair.bak ]] || - fail "migration is idempotent after the repair" -pass "migration is idempotent after the repair" -close_browser - -# A remapped shortcut keeps the user's chosen key while moving to the pinned id. -jq -n --arg ghost "$ghost_id" '{extensions: {commands: {"linux:Ctrl+Alt+P": {command_name: "copy-url", extension: $ghost, global: false}}, settings: {}}}' >"$preferences" -run_migration || fail "migration repairs remapped shortcuts" -jq -e --arg pinned "$pinned_id" '.extensions.commands["linux:Ctrl+Alt+P"].extension == $pinned' "$preferences" >/dev/null || - fail "migration keeps the remapped key while rebinding to the pinned id" -pass "migration keeps remapped shortcut keys" - -# When the pinned extension already holds a copy-url binding (the user fixed -# it by hand), the ghost is dropped rather than doubled into a second binding. -jq -n --arg ghost "$ghost_id" --arg pinned "$pinned_id" '{extensions: {commands: {"linux:Ctrl+Alt+P": {command_name: "copy-url", extension: $pinned, global: false}, "linux:Alt+Shift+L": {command_name: "copy-url", extension: $ghost, global: false}}, settings: {}}}' >"$preferences" -run_migration || fail "migration cleans ghosts alongside a manual repair" -jq -e --arg pinned "$pinned_id" ' - (.extensions.commands | has("linux:Alt+Shift+L") | not) and - .extensions.commands["linux:Ctrl+Alt+P"].extension == $pinned -' "$preferences" >/dev/null || fail "migration drops the ghost instead of double-binding the pinned extension" -pass "migration never double-binds the pinned extension" - -# A browser starting mid-repair may write stale Preferences back on exit, so -# the migration must stay pending for a later browser-free run to verify. A -# stub hands the repair call through and opens the profile right after it. -write_stale_preferences -close_browser -rm -f "$preferences.omarchy-copy-url-repair.bak" -cat >"$stub_bin/python3" <<'STUB' -#!/bin/bash -# Called as `python3 -c