diff options
Diffstat (limited to 'docs/guide/libraries')
-rw-r--r-- | docs/guide/libraries/apps.md | 27 | ||||
-rw-r--r-- | docs/guide/libraries/battery.md | 2 | ||||
-rw-r--r-- | docs/guide/libraries/bluetooth.md | 2 | ||||
-rw-r--r-- | docs/guide/libraries/cava.md | 91 | ||||
-rw-r--r-- | docs/guide/libraries/hyprland.md | 2 | ||||
-rw-r--r-- | docs/guide/libraries/mpris.md | 2 | ||||
-rw-r--r-- | docs/guide/libraries/network.md | 2 | ||||
-rw-r--r-- | docs/guide/libraries/notifd.md | 2 | ||||
-rw-r--r-- | docs/guide/libraries/powerprofiles.md | 2 | ||||
-rw-r--r-- | docs/guide/libraries/wireplumber.md | 2 |
10 files changed, 118 insertions, 16 deletions
diff --git a/docs/guide/libraries/apps.md b/docs/guide/libraries/apps.md index 7f9ee6e..1871d18 100644 --- a/docs/guide/libraries/apps.md +++ b/docs/guide/libraries/apps.md @@ -14,7 +14,7 @@ sudo pacman -Syu meson vala json-glib gobject-introspection ``` ```sh [<i class="devicon-fedora-plain"></i> Fedora] -sudo dnf install meson gcc valac json-glib-devel gobject-introspection-devel +sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel ``` ```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] @@ -55,8 +55,9 @@ astal-apps --help import Apps from "gi://AstalApps" const apps = new Apps.Apps({ - includeEntry: true, - includeExecutable: true, + nameMultiplier: 2, + entryMultiplier: 0, + executableMultiplier: 2, }) for (const app of apps.fuzzy_query("spotify")) { @@ -68,8 +69,9 @@ for (const app of apps.fuzzy_query("spotify")) { from gi.repository import AstalApps as Apps apps = Apps.Apps( - include_entry=True, - include_executable=True, + name_multiplier=2, + entry_multiplier=0, + executable_multiplier=2, ) for app in apps.fuzzy_query("obsidian"): @@ -81,8 +83,9 @@ for app in apps.fuzzy_query("obsidian"): local Apps = require("lgi").require("AstalApps") local apps = Apps.Apps({ - include_entry = true, - include_executable = true, + name_multiplier = 2, + entry_multiplier = 0, + executable_multiplier = 2, }) for _, app in ipairs(apps:fuzzy_query("lutris")) do @@ -91,7 +94,15 @@ end ``` ```vala [<i class="devicon-vala-plain"></i> Vala] -// Not yet documented, contributions are appreciated +var apps = new AstalApps.Apps() { + name_multiplier = 2, + entry_multiplier = 0, + executable_multiplier = 2, +}; + +foreach (var app in apps.fuzzy_query("firefox")) { + print(app.name); +} ``` ::: diff --git a/docs/guide/libraries/battery.md b/docs/guide/libraries/battery.md index 7f94297..56f955c 100644 --- a/docs/guide/libraries/battery.md +++ b/docs/guide/libraries/battery.md @@ -13,7 +13,7 @@ sudo pacman -Syu meson vala json-glib gobject-introspection ``` ```sh [<i class="devicon-fedora-plain"></i> Fedora] -sudo dnf install meson gcc valac json-glib-devel gobject-introspection-devel +sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel ``` ```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] diff --git a/docs/guide/libraries/bluetooth.md b/docs/guide/libraries/bluetooth.md index 672f66d..03ac9c9 100644 --- a/docs/guide/libraries/bluetooth.md +++ b/docs/guide/libraries/bluetooth.md @@ -13,7 +13,7 @@ sudo pacman -Syu meson vala gobject-introspection ``` ```sh [<i class="devicon-fedora-plain"></i> Fedora] -sudo dnf install meson gcc valac gobject-introspection-devel +sudo dnf install meson vala valadoc gobject-introspection-devel ``` ```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] diff --git a/docs/guide/libraries/cava.md b/docs/guide/libraries/cava.md new file mode 100644 index 0000000..e695e16 --- /dev/null +++ b/docs/guide/libraries/cava.md @@ -0,0 +1,91 @@ +# Cava + +Audio visualizer using [cava](https://github.com/karlstav/cava). + +## Installation + +1. install dependencies + +Note that it requires [libcava](https://github.com/LukashonakV/cava), a fork of cava, which provides cava as a shared library. + +:::code-group + +```sh [<i class="devicon-archlinux-plain"></i> Arch] +sudo pacman -Syu meson vala gobject-introspection +paru -S libcava +``` + +```sh [<i class="devicon-fedora-plain"></i> Fedora] +# Not yet documented +``` + +```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] +# Not yet documented +``` + +::: + +2. clone repo + +```sh +git clone https://github.com/aylur/astal.git +cd astal/lib/cava +``` + +3. install + +```sh +meson setup build +meson install -C build +``` + +:::tip +Most distros recommend manual installs in `/usr/local`, +which is what `meson` defaults to. If you want to install to `/usr` +instead which most package managers do, set the `prefix` option: + +```sh +meson setup --prefix /usr build +``` + +::: + +## Usage + +You can browse the [Cava reference](https://aylur.github.io/libastal/cava). + +### CLI + +There is no CLI for this library, use the one provided by cava. + +```sh +cava +``` + +### Library + +:::code-group + +```js [<i class="devicon-javascript-plain"></i> JavaScript] +import Cava from "gi://AstalCava" + +const cava = Cava.get_default() + +cava.connect("notify::values", () => { + print(cava.get_values()) +}) +``` + +```py [<i class="devicon-python-plain"></i> Python] +# Not yet documented +``` + +```lua [<i class="devicon-lua-plain"></i> Lua] +-- Not yet documented +``` + +```vala [<i class="devicon-vala-plain"></i> Vala] +// Not yet documented +``` + +::: diff --git a/docs/guide/libraries/hyprland.md b/docs/guide/libraries/hyprland.md index 672faad..94a398f 100644 --- a/docs/guide/libraries/hyprland.md +++ b/docs/guide/libraries/hyprland.md @@ -13,7 +13,7 @@ sudo pacman -Syu meson vala json-glib gobject-introspection ``` ```sh [<i class="devicon-fedora-plain"></i> Fedora] -sudo dnf install meson gcc valac json-glib-devel gobject-introspection-devel +sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel ``` ```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] diff --git a/docs/guide/libraries/mpris.md b/docs/guide/libraries/mpris.md index 8f28924..30f3d13 100644 --- a/docs/guide/libraries/mpris.md +++ b/docs/guide/libraries/mpris.md @@ -29,7 +29,7 @@ sudo pacman -Syu meson vala gvfs json-glib gobject-introspection ``` ```sh [<i class="devicon-fedora-plain"></i> Fedora] -sudo dnf install meson gcc valac gvfs json-glib-devel gobject-introspection-devel +sudo dnf install meson vala valadoc gvfs json-glib-devel gobject-introspection-devel ``` ```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] diff --git a/docs/guide/libraries/network.md b/docs/guide/libraries/network.md index e076950..21c7b10 100644 --- a/docs/guide/libraries/network.md +++ b/docs/guide/libraries/network.md @@ -13,7 +13,7 @@ sudo pacman -Syu meson vala libnm gobject-introspection ``` ```sh [<i class="devicon-fedora-plain"></i> Fedora] -sudo dnf install meson gcc valac NetworkManager-libnm-devel gobject-introspection-devel +sudo dnf install meson vala valadoc NetworkManager-libnm-devel gobject-introspection-devel ``` ```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] diff --git a/docs/guide/libraries/notifd.md b/docs/guide/libraries/notifd.md index 094b770..4208700 100644 --- a/docs/guide/libraries/notifd.md +++ b/docs/guide/libraries/notifd.md @@ -17,7 +17,7 @@ sudo pacman -Syu meson vala gdk-pixbuf2 json-glib gobject-introspection ``` ```sh [<i class="devicon-fedora-plain"></i> Fedora] -sudo dnf install meson gcc valac gdk-pixbuf2-devel json-glib-devel gobject-introspection-devel +sudo dnf install meson vala valadoc gdk-pixbuf2-devel json-glib-devel gobject-introspection-devel ``` ```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] diff --git a/docs/guide/libraries/powerprofiles.md b/docs/guide/libraries/powerprofiles.md index 159f3ff..bdafcde 100644 --- a/docs/guide/libraries/powerprofiles.md +++ b/docs/guide/libraries/powerprofiles.md @@ -13,7 +13,7 @@ sudo pacman -Syu meson vala json-glib gobject-introspection ``` ```sh [<i class="devicon-fedora-plain"></i> Fedora] -sudo dnf install meson gcc valac json-glib-devel gobject-introspection-devel +sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel ``` ```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] diff --git a/docs/guide/libraries/wireplumber.md b/docs/guide/libraries/wireplumber.md index 0592628..c06161e 100644 --- a/docs/guide/libraries/wireplumber.md +++ b/docs/guide/libraries/wireplumber.md @@ -13,7 +13,7 @@ sudo pacman -Syu meson vala wireplumber gobject-introspection ``` ```sh [<i class="devicon-fedora-plain"></i> Fedora] -sudo dnf install meson gcc valac wireplumber-devel gobject-introspection-devel +sudo dnf install meson vala valadoc wireplumber-devel gobject-introspection-devel ``` ```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] |