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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
:source-highlighter: pygments
== Building
=== Dependencies
* C++17 and C99 compiler
* meson
* cmake
* libegl
* libgl
* nlohmann_json
* lz4
* stb_image
* glm
* notcurses `optional (taro)`
* jansson `optional (taro)`
==== X11
* libx11
* libxext
* libxrandr
==== Wayland
* wayland
* wayland-egl
* wayland-protocols
* wlr-protocols
=== Packages
==== debian12
[source,sh]
----
# Common.
sudo apt install git meson cmake pkg-config libegl-dev nlohmann-json3-dev liblz4-dev libstb-dev libglm-dev libjansson-dev libavcodec-dev libavdevice-dev libunistring-dev libdeflate-dev libtinfo-dev
# Wayland.
sudo apt install libwayland-dev
# X11.
sudo apt install libxext-dev libxrandr-dev
----
==== archlinux
[source,sh]
----
# Common.
sudo pacman -S --needed git meson cmake libegl nlohmann-json lz4 stb glm jansson ffmpeg libdeflate
# Wayland.
sudo pacman -S --needed wayland wayland-protocols wlr-protocols
# X11.
sudo pacman -S --needed libxext libxrandr
----
=== Compiling
[source,sh]
----
$ meson setup build -Dwindow=(x11|wayland) -Dtaro=(enabled|disabled)
$ ninja -C build
----
== Installing
=== Local
[source,sh]
----
$ sudo ninja -C build install
----
=== Nix Flake
[source,nix]
----
inputs = {
mauri = {
url = "git+https://git.akon.city/mauri";
inputs.nixpkgs.follows = "nixpkgs";
};
};
nixosSystem {
system = system;
modules = [
({ ... }: {
nixpkgs.overlays = [
(self: super: { mauri = mauri.packages.${system}.default; })
];
})
];
};
----
== Usage
[source,sh]
----
$ mauri --help
----
[source,plain]
----
Usage: mauri (-p, --package [path_to_scene.pkg]|-d, --directory [path_to_wallpaper]) [OPTIONS]
-a, --assets search path for common assets
-w, --width window width (default: 640)
-h, --height window height (default: 480)
-o, --offset offset of the scene camera (default: 0,0)
-s, --scale scale the window to the scene
-m, --monitor set as the background of this monitor (by name)
-t, --target dump the scene tree into this directory and exit
----
=== Examples
[source,sh]
----
# Set as the background of DP-1.
$ ./mauri -p /mnt/hdd/SteamLibrary/steamapps/workshop/content/431960/1761287874/scene.pkg \
-a /mnt/hdd/SteamLibrary/steamapps/common/wallpaper_engine/assets -w 2560 -h 1440 -m DP-1
# Dump the scene into ./output.
$ ./mauri -p /mnt/hdd/SteamLibrary/steamapps/workshop/content/431960/1582967473/scene.pkg \
-a /mnt/hdd/SteamLibrary/steamapps/common/wallpaper_engine/assets -t ./output
----
== Taro
[source,sh]
----
# Run `tarod` once before anything to generate the necessary files for your setup.
$ tarod
# Open the terminal UI.
$ taro
----
=== Keybinds
[%autowidth]
|================
|←↓↑→/hjkl |Move Selection, Edit Value
|Enter/Space|Confirm Selection
|Tab |Cycle Between Grid and Info/Options
|m |Goto Monitor Selection
|f/b |Next/Previous Page
|n/N |Set Next/Previous Wallpaper in Grid
|r |Remove Current Wallpaper
|================
=== Config
[source,sh]
----
$ cat $HOME/.config/taro/config.json
----
[source,json]
----
{
"directories": {
"assets": "/mnt/hdd/SteamLibrary/steamapps/common/wallpaper_engine/assets",
"wallpapers": [
"/mnt/hdd/SteamLibrary/steamapps/workshop/content/431960"
]
}
}
----
=== Sway Config Example
[source,sh]
----
# Set wallpaper
bindsym Mod4+F1 exec printf '1633608994_p|false,100|' > $HOME/.config/taro/DP-1/selection
# Remove wallpaper
bindsym Mod4+F2 exec printf '||' > $HOME/.config/taro/DP-1/selection
# Run when starting Sway
exec tarod
----
== Known Issues
* Some gifs are incorrectly positioned.
* Some objects are incorrectly scaled and/or positioned.
* Some shaders fail to compile for various reasons.
=== Not Implemented
* Particles
* Mouse Paralax
* Camera Shake
* Animations/Puppet Warp
* Javascript Scripting
* 3d Models
* And much more\...
// vim: set syntax=asciidoc:
|