blob: 64ba3ceee7ca1162966646e2046b152f5640038c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
# River
Library and CLI tool for monitoring the [River Wayland Compositor](https://isaacfreund.com/software/river/).
## Installation
1. install dependencies
:::code-group
```sh [<i class="devicon-archlinux-plain"></i> Arch]
sudo pacman -Syu meson json-glib gobject-introspection
```
```sh [<i class="devicon-fedora-plain"></i> Fedora]
sudo dnf install meson gcc json-glib-devel gobject-introspection-devel
```
```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
sudo apt install meson libjson-glib-dev gobject-introspection
```
:::
2. clone repo
```sh
git clone https://github.com/aylur/astal.git
cd astal/lib/river
```
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 [River reference](https://aylur.github.io/libastal/river).
### CLI
```sh
astal-river --help
```
### Library
:::code-group
```js [<i class="devicon-javascript-plain"></i> JavaScript]
import River from "gi://AstalRiver";
const river = River.get_default();
console.log(river.get_outputs().map((o) => o.name));
```
```py [<i class="devicon-python-plain"></i> Python]
import gi
gi.require_version("AstalRiver", "0.1")
from gi.repository import AstalRiver
river = AstalRiver.get_default()
print("\n".join(o.get_name() for o in river.get_outputs()))
```
```lua [<i class="devicon-lua-plain"></i> Lua]
local lgi = require("lgi")
local AstalRiver = lgi.require("AstalRiver", "0.1")
local river = AstalRiver.River.get_default()
for _, o in ipairs(river.outputs) do
print(o.name)
end
```
```vala [<i class="devicon-vala-plain"></i> Vala]
// Not yet documented
```
:::
|
