From 10447f5abcb28f3df1544f1732f82d538130b3c9 Mon Sep 17 00:00:00 2001 From: kotontrion Date: Thu, 10 Oct 2024 11:26:17 +0200 Subject: cava: add doce --- docs/guide/libraries/cava.md | 91 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 docs/guide/libraries/cava.md (limited to 'docs/guide/libraries') diff --git a/docs/guide/libraries/cava.md b/docs/guide/libraries/cava.md new file mode 100644 index 0000000..bbd5f4f --- /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 [ Arch] +sudo pacman -Syu meson vala gobject-introspection +paru -S libcava +``` + +```sh [ Fedora] +# Not yet documented +``` + +```sh [ 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 [ JavaScript] +import Wp from "gi://AstalCava" + +const cava = Cava.get_default() + +cava.connect("notify::values", () => { + print(cava.get_values()) +}) +``` + +```py [ Python] +# Not yet documented +``` + +```lua [ Lua] +-- Not yet documented +``` + +```vala [ Vala] +// Not yet documented +``` + +::: -- cgit v1.2.3 From 025d39abbcfa66b21dae48d63fee1c3d68822f0a Mon Sep 17 00:00:00 2001 From: Aylur Date: Mon, 14 Oct 2024 13:23:59 +0200 Subject: cava: initial nix build --- docs/guide/libraries/cava.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guide/libraries') diff --git a/docs/guide/libraries/cava.md b/docs/guide/libraries/cava.md index bbd5f4f..e695e16 100644 --- a/docs/guide/libraries/cava.md +++ b/docs/guide/libraries/cava.md @@ -67,7 +67,7 @@ cava :::code-group ```js [ JavaScript] -import Wp from "gi://AstalCava" +import Cava from "gi://AstalCava" const cava = Cava.get_default() -- cgit v1.2.3 From 5636812a387ffb89e79e02fe2a675ed42f8151f4 Mon Sep 17 00:00:00 2001 From: kingmaj0r <49806509+kingmaj0r@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:39:33 +0700 Subject: Update hyprland.md --- docs/guide/libraries/hyprland.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guide/libraries') diff --git a/docs/guide/libraries/hyprland.md b/docs/guide/libraries/hyprland.md index 672faad..488b89c 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 [ Fedora] -sudo dnf install meson gcc valac json-glib-devel gobject-introspection-devel +sudo dnf install meson gcc vala valadoc json-glib-devel gobject-introspection-devel ``` ```sh [ Ubuntu] -- cgit v1.2.3 From ca0d72b942d56b9e569c4bbce55fe0d541c445d0 Mon Sep 17 00:00:00 2001 From: kingmaj0r <49806509+kingmaj0r@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:40:51 +0700 Subject: Update apps.md --- docs/guide/libraries/apps.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guide/libraries') diff --git a/docs/guide/libraries/apps.md b/docs/guide/libraries/apps.md index 7f9ee6e..a1ad365 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 [ Fedora] -sudo dnf install meson gcc valac json-glib-devel gobject-introspection-devel +sudo dnf install meson gcc vala valadoc json-glib-devel gobject-introspection-devel ``` ```sh [ Ubuntu] -- cgit v1.2.3 From 3fd4673394d0c16b728c266b95015e5f8b0f180c Mon Sep 17 00:00:00 2001 From: kingmaj0r <49806509+kingmaj0r@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:43:38 +0700 Subject: Update wireplumber.md --- docs/guide/libraries/wireplumber.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guide/libraries') diff --git a/docs/guide/libraries/wireplumber.md b/docs/guide/libraries/wireplumber.md index 0592628..202b59c 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 [ Fedora] -sudo dnf install meson gcc valac wireplumber-devel gobject-introspection-devel +sudo dnf install meson gcc vala valadoc wireplumber-devel gobject-introspection-devel ``` ```sh [ Ubuntu] -- cgit v1.2.3 From 99f69cd5e43619d12d907f829910a24db69eb35e Mon Sep 17 00:00:00 2001 From: kingmaj0r <49806509+kingmaj0r@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:43:51 +0700 Subject: Update battery.md --- docs/guide/libraries/battery.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guide/libraries') diff --git a/docs/guide/libraries/battery.md b/docs/guide/libraries/battery.md index 7f94297..ddd1292 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 [ Fedora] -sudo dnf install meson gcc valac json-glib-devel gobject-introspection-devel +sudo dnf install meson gcc vala valadoc json-glib-devel gobject-introspection-devel ``` ```sh [ Ubuntu] -- cgit v1.2.3 From cdf3f178ebe4527a096cad5fb59722ed9b78a250 Mon Sep 17 00:00:00 2001 From: kingmaj0r <49806509+kingmaj0r@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:43:56 +0700 Subject: Update bluetooth.md --- docs/guide/libraries/bluetooth.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guide/libraries') diff --git a/docs/guide/libraries/bluetooth.md b/docs/guide/libraries/bluetooth.md index 672f66d..3fd9d42 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 [ Fedora] -sudo dnf install meson gcc valac gobject-introspection-devel +sudo dnf install meson gcc vala valadoc gobject-introspection-devel ``` ```sh [ Ubuntu] -- cgit v1.2.3 From 306f78b3ac1bb37906d7ff5f9f550f34089cec5f Mon Sep 17 00:00:00 2001 From: kingmaj0r <49806509+kingmaj0r@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:44:10 +0700 Subject: Update mpris.md --- docs/guide/libraries/mpris.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guide/libraries') diff --git a/docs/guide/libraries/mpris.md b/docs/guide/libraries/mpris.md index 8f28924..635c862 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 [ Fedora] -sudo dnf install meson gcc valac gvfs json-glib-devel gobject-introspection-devel +sudo dnf install meson gcc vala valadoc gvfs json-glib-devel gobject-introspection-devel ``` ```sh [ Ubuntu] -- cgit v1.2.3 From 3d53f80ef3b912c74ad63cf435f0c5c2b5232147 Mon Sep 17 00:00:00 2001 From: kingmaj0r <49806509+kingmaj0r@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:44:15 +0700 Subject: Update network.md --- docs/guide/libraries/network.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guide/libraries') diff --git a/docs/guide/libraries/network.md b/docs/guide/libraries/network.md index e076950..a7d9fc3 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 [ Fedora] -sudo dnf install meson gcc valac NetworkManager-libnm-devel gobject-introspection-devel +sudo dnf install meson gcc vala valadoc NetworkManager-libnm-devel gobject-introspection-devel ``` ```sh [ Ubuntu] -- cgit v1.2.3 From c9f1246222996c4ce2fbe58c18671865e61cc2ed Mon Sep 17 00:00:00 2001 From: kingmaj0r <49806509+kingmaj0r@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:44:21 +0700 Subject: Update notifd.md --- docs/guide/libraries/notifd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guide/libraries') diff --git a/docs/guide/libraries/notifd.md b/docs/guide/libraries/notifd.md index 094b770..9f73124 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 [ Fedora] -sudo dnf install meson gcc valac gdk-pixbuf2-devel json-glib-devel gobject-introspection-devel +sudo dnf install meson gcc vala valadoc gdk-pixbuf2-devel json-glib-devel gobject-introspection-devel ``` ```sh [ Ubuntu] -- cgit v1.2.3 From 070c156e5c3be825c858a827645a359b04243213 Mon Sep 17 00:00:00 2001 From: kingmaj0r <49806509+kingmaj0r@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:44:29 +0700 Subject: Update powerprofiles.md --- docs/guide/libraries/powerprofiles.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guide/libraries') diff --git a/docs/guide/libraries/powerprofiles.md b/docs/guide/libraries/powerprofiles.md index 159f3ff..40b11cf 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 [ Fedora] -sudo dnf install meson gcc valac json-glib-devel gobject-introspection-devel +sudo dnf install meson gcc vala valadoc json-glib-devel gobject-introspection-devel ``` ```sh [ Ubuntu] -- cgit v1.2.3 From 646cff6061e29d6b58f50e7acbf28384424ae2c9 Mon Sep 17 00:00:00 2001 From: KingMaj0r Date: Fri, 1 Nov 2024 20:42:55 +0700 Subject: Removed 'gcc' from dependencies for Fedora. --- docs/guide/libraries/apps.md | 2 +- docs/guide/libraries/battery.md | 2 +- docs/guide/libraries/bluetooth.md | 2 +- docs/guide/libraries/hyprland.md | 2 +- docs/guide/libraries/mpris.md | 2 +- docs/guide/libraries/network.md | 2 +- docs/guide/libraries/notifd.md | 2 +- docs/guide/libraries/powerprofiles.md | 2 +- docs/guide/libraries/wireplumber.md | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) (limited to 'docs/guide/libraries') diff --git a/docs/guide/libraries/apps.md b/docs/guide/libraries/apps.md index a1ad365..7349951 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 [ Fedora] -sudo dnf install meson gcc vala valadoc json-glib-devel gobject-introspection-devel +sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel ``` ```sh [ Ubuntu] diff --git a/docs/guide/libraries/battery.md b/docs/guide/libraries/battery.md index ddd1292..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 [ Fedora] -sudo dnf install meson gcc vala valadoc json-glib-devel gobject-introspection-devel +sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel ``` ```sh [ Ubuntu] diff --git a/docs/guide/libraries/bluetooth.md b/docs/guide/libraries/bluetooth.md index 3fd9d42..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 [ Fedora] -sudo dnf install meson gcc vala valadoc gobject-introspection-devel +sudo dnf install meson vala valadoc gobject-introspection-devel ``` ```sh [ Ubuntu] diff --git a/docs/guide/libraries/hyprland.md b/docs/guide/libraries/hyprland.md index 488b89c..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 [ Fedora] -sudo dnf install meson gcc vala valadoc json-glib-devel gobject-introspection-devel +sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel ``` ```sh [ Ubuntu] diff --git a/docs/guide/libraries/mpris.md b/docs/guide/libraries/mpris.md index 635c862..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 [ Fedora] -sudo dnf install meson gcc vala valadoc gvfs json-glib-devel gobject-introspection-devel +sudo dnf install meson vala valadoc gvfs json-glib-devel gobject-introspection-devel ``` ```sh [ Ubuntu] diff --git a/docs/guide/libraries/network.md b/docs/guide/libraries/network.md index a7d9fc3..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 [ Fedora] -sudo dnf install meson gcc vala valadoc NetworkManager-libnm-devel gobject-introspection-devel +sudo dnf install meson vala valadoc NetworkManager-libnm-devel gobject-introspection-devel ``` ```sh [ Ubuntu] diff --git a/docs/guide/libraries/notifd.md b/docs/guide/libraries/notifd.md index 9f73124..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 [ Fedora] -sudo dnf install meson gcc vala valadoc 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 [ Ubuntu] diff --git a/docs/guide/libraries/powerprofiles.md b/docs/guide/libraries/powerprofiles.md index 40b11cf..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 [ Fedora] -sudo dnf install meson gcc vala valadoc json-glib-devel gobject-introspection-devel +sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel ``` ```sh [ Ubuntu] diff --git a/docs/guide/libraries/wireplumber.md b/docs/guide/libraries/wireplumber.md index 202b59c..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 [ Fedora] -sudo dnf install meson gcc vala valadoc wireplumber-devel gobject-introspection-devel +sudo dnf install meson vala valadoc wireplumber-devel gobject-introspection-devel ``` ```sh [ Ubuntu] -- cgit v1.2.3 From df4c505097b0394d1a75565c2a5e8b47837c3050 Mon Sep 17 00:00:00 2001 From: Aylur Date: Fri, 1 Nov 2024 14:01:05 +0000 Subject: apps: remove redundant properties there is no need for the enable properties since setting the multiplier to a non zero or zero value is the same thing --- docs/guide/libraries/apps.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) (limited to 'docs/guide/libraries') diff --git a/docs/guide/libraries/apps.md b/docs/guide/libraries/apps.md index 7f9ee6e..d778e87 100644 --- a/docs/guide/libraries/apps.md +++ b/docs/guide/libraries/apps.md @@ -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 [ 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); +} ``` ::: -- cgit v1.2.3