vikingowl
4a7693d50b
- Remove runtimes section (runtimes are in the core repo) - Add external dependency column to plugin table - Fix build examples (no deleted plugins) - Add AUR install instructions - Streamline development section
68 lines
2.1 KiB
Markdown
68 lines
2.1 KiB
Markdown
# owlry-plugins
|
|
|
|
Official plugins for [owlry](https://somegit.dev/Owlibou/owlry).
|
|
|
|
> **Note:** Calculator, converter, and system actions are built into `owlry-core` (>= 1.2.0) and do not require separate packages.
|
|
|
|
## Plugins
|
|
|
|
| Plugin | Description | Dependencies |
|
|
|--------|-------------|-------------|
|
|
| bookmarks | Browser bookmark search (Firefox, Chrome, Brave, Edge) | — |
|
|
| clipboard | Clipboard history | `cliphist`, `wl-clipboard` |
|
|
| emoji | Emoji picker (400+) | `wl-clipboard`, `noto-fonts-emoji` |
|
|
| filesearch | File search (`/ filename`) | `fd` or `mlocate` |
|
|
| media | MPRIS media player widget | `playerctl` |
|
|
| pomodoro | Pomodoro timer widget | — |
|
|
| scripts | User script launcher | — |
|
|
| ssh | SSH host quick-connect | `openssh` |
|
|
| systemd | systemd user service control | `systemd` |
|
|
| weather | Weather widget | — |
|
|
| websearch | Web search with configurable engines | — |
|
|
|
|
## Installation
|
|
|
|
### Arch Linux (AUR)
|
|
|
|
```bash
|
|
# Install individual plugins
|
|
yay -S owlry-plugin-bookmarks owlry-plugin-clipboard owlry-plugin-weather
|
|
|
|
# Or install several at once
|
|
yay -S owlry-plugin-{bookmarks,clipboard,emoji,ssh,websearch}
|
|
```
|
|
|
|
### Build from Source
|
|
|
|
Requires Rust 1.90+ and `owlry-core` installed.
|
|
|
|
```bash
|
|
git clone https://somegit.dev/Owlibou/owlry-plugins.git
|
|
cd owlry-plugins
|
|
|
|
just build # Debug build (all plugins)
|
|
just release # Release build (optimized)
|
|
just plugin bookmarks # Build a single plugin
|
|
|
|
just install-local # Install all plugins to /usr/lib/owlry/plugins/
|
|
```
|
|
|
|
Plugins are compiled as `.so` files and installed to `/usr/lib/owlry/plugins/`.
|
|
|
|
## Development
|
|
|
|
Each plugin is a `cdylib` crate implementing the `owlry-plugin-api` ABI-stable interface from the [core repo](https://somegit.dev/Owlibou/owlry).
|
|
|
|
```bash
|
|
just check # cargo check + clippy
|
|
just test # Run tests
|
|
just fmt # Format code
|
|
just show-versions # List all plugin versions
|
|
```
|
|
|
|
See [docs/PLUGIN_DEVELOPMENT.md](docs/PLUGIN_DEVELOPMENT.md) for the plugin authoring guide.
|
|
|
|
## License
|
|
|
|
GPL-3.0-or-later
|