Skip to content

Commit 767baba

Browse files
committed
Add aether protocol handler registration
1 parent 9c22330 commit 767baba

4 files changed

Lines changed: 55 additions & 0 deletions

File tree

.github/workflows/aur.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ jobs:
6262
6363
cd "${srcdir}/aether-${pkgver}"
6464
install -Dm644 build/linux/aether.desktop "${pkgdir}/usr/share/applications/aether.desktop"
65+
install -Dm644 li.oever.aether.url-handler.desktop "${pkgdir}/usr/share/applications/li.oever.aether.url-handler.desktop"
6566
install -Dm644 icon.png "${pkgdir}/usr/share/pixmaps/aether.png"
6667
install -Dm644 README.md "${pkgdir}/usr/share/doc/aether/README.md"
6768
}

.github/workflows/release.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ jobs:
7171
cp "build/bin/aether-linux-${ARCH}" "${PKG_DIR}/usr/bin/aether"
7272
chmod 755 "${PKG_DIR}/usr/bin/aether"
7373
cp build/linux/aether.desktop "${PKG_DIR}/usr/share/applications/"
74+
cp li.oever.aether.url-handler.desktop "${PKG_DIR}/usr/share/applications/"
7475
cp icon.png "${PKG_DIR}/usr/share/pixmaps/aether.png"
7576
7677
cat > "${PKG_DIR}/DEBIAN/control" <<'CTRL'

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ wails build
123123
| [Custom Apps](docs/custom-apps.md) | Per-app template system |
124124
| [File System](docs/filesystem.md) | Where Aether stores files |
125125
| [Remote Control](docs/remote-control.md) | IPC commands and AI integration |
126+
| [Protocol Handler](docs/protocol-handler.md) | Register `aether://` links |
126127
| [Quickshell Widgets](docs/quickshell.md) | QML widgets for Hyprland-style bars |
127128
| [Standalone](docs/standalone.md) | Using Aether without Omarchy |
128129
| [Troubleshooting](docs/troubleshooting.md) | Common issues |

docs/protocol-handler.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Register the aether:// protocol
2+
3+
Use `aether://` links to open a theme, palette, or wallpaper in Aether directly from a browser.
4+
5+
## Quick start
6+
7+
Packages that include `li.oever.aether.url-handler.desktop` make the handler available to the desktop environment. Verify it after installing Aether:
8+
9+
```bash
10+
xdg-mime query default x-scheme-handler/aether
11+
```
12+
13+
The expected result is:
14+
15+
```text
16+
li.oever.aether.url-handler.desktop
17+
```
18+
19+
If the command prints nothing, register the handler for the current user:
20+
21+
```bash
22+
mkdir -p ~/.local/share/applications
23+
install -m 644 li.oever.aether.url-handler.desktop ~/.local/share/applications/
24+
update-desktop-database ~/.local/share/applications
25+
xdg-mime default li.oever.aether.url-handler.desktop x-scheme-handler/aether
26+
```
27+
28+
Run those commands from the Aether source checkout. `make install` already performs these steps.
29+
30+
## Package releases
31+
32+
Linux packages must install the handler desktop file at:
33+
34+
```text
35+
/usr/share/applications/li.oever.aether.url-handler.desktop
36+
```
37+
38+
The file declares `MimeType=x-scheme-handler/aether;` and invokes:
39+
40+
```text
41+
aether --handle-url %u
42+
```
43+
44+
After installing a new package, users can set it as their default handler with:
45+
46+
```bash
47+
xdg-mime default li.oever.aether.url-handler.desktop x-scheme-handler/aether
48+
```
49+
50+
## Troubleshooting
51+
52+
If the handler is installed but links still do not open, rerun the desktop database update and default-association command above. Some browsers cache protocol-handler choices, so restart the browser after changing the association. See [Web Handler](web-handler.md) for supported link parameters and security guidance.

0 commit comments

Comments
 (0)