Hyprland and Gum | G-Hyprland | Live Wallpapers

[Ankur]

Hello, Garudians!!!
Well, a while ago I got to know about a software named gum from SGS

GitHub - charmbracelet/gum: A tool for glamorous shell scripts 🎀

Well, I looked on it a little bit then it was decided that we will work on integrating it with hyprland after some months (yeah some months, because I have tests )

I tried a little bit of integrating it with hyprland (that day was a noisier day than usual, you can’t survive the place where I live without earphones in your ears for the whole day, so I decided to dive a little bit into gum) , I integrated with some of the stuffs like blurring and corners initially because sometimes I wanted to have a blurred theme, then sometimes I wanted to have simple corners sometimes rounded corners.

Well, this Sunday was also something like that (currently I can hear two drill machines at the same time being operated just 5 meters away from my home ), so I worked further on it and completed whatever I wanted in it ,

Here is a sample link :

How to implement in your system

It is damn simple, just copy all the stuffs in .config/hypr/from

etc/skel/.config/hypr · main · AnkurAlpha / Garuda Hyprland Settings · GitLab

Just don’t forget to back up your older things
Recommendation : make another user and login into it and then do this process

How does it look like ?

well, the basic file system is like this

.rw-r--r-- 1.7k ankur 24 Dec 17:04  hyprland.conf
.rwxr-xr-x  270 ankur 24 Dec 17:16  hyprstart

brain:
drwxr-xr-x   - ankur 23 Dec 16:44  config
drwxr-xr-x   - ankur 24 Dec 15:33  scripts
.rwxr-xr-x 19k ankur 24 Dec 18:37  brain.sh

scripts:
.rw-r--r-- 705 ankur  6 Jul 01:46  lock.sh
.rwxr-xr-x 212 ankur 21 Nov 20:36  screenshot_display.sh
.rwxr-xr-x 235 ankur 21 Nov 20:36  screenshot_window.sh
.rw-r--r-- 411 ankur  6 Jul 01:46  sleep.sh

settings:
.rw-r--r-- 547 ankur 25 Dec 12:56  backgroud.conf
.rw-r--r-- 664 ankur 24 Dec 18:18  blur_system.conf
.rw-r--r-- 380 ankur 24 Dec 18:17  corners.conf
.rw-r--r--  58 ankur 24 Dec 13:03  eye_protection.conf
.rw-r--r-- 13k ankur 24 Dec 17:00  manual_settings.conf
.rw-r--r-- 346 ankur 25 Dec 12:33  monitor.conf
.rw-r--r-- 446 ankur 23 Dec 20:05  status_bar.conf
.rw-r--r-- 499 ankur 23 Dec 20:08  window_gaps.conf

In the ‘settings’ folder are the current settings which are applied in hyprland
(please don’t play with these files !!)
Then there is brain folder which is the place from everything is executed.
*you can add your own custom.conf things in those folders which are named like waybar, backgrounds, and that config option will be available in for that section next time when you run the script (you can see the waybar_themes folder in which there is an example custom theme *

How to run the script ?

Once you have the things to .config/hypr/
then you can use Mod+s to run the script

Well, most of the options are self-explanatory
but maybe there is need of explaining background option

In that option you will get three sub options
first one (wallpaper path) is for changing whether you want garuda wallpapers or use your own custom wall papers, by default it is garuda wallpapers, but if you choose custom so it will make a directory named something like custom_wallpapers where you will be able to put all your wallpapers

second option (add wallpaper) is the option through which you can add your wallpapers to that newly made folder if you are uncomfortable to do it manually

you have two options,

• one is for photos
• other is for animated (live wallpapers)

you can add photos or animated wallpapers through it
you can only add .gif wallpapers in animated wallpapers folder, if you do it manually
If you have a non gif thing which can be in something like mp4 format then use the script, it will take care of that thing, please avoid things with .webp extensions

third option (wallpaper type) is for selection of which type of wallpaper you want

these are :

• session static (same wallpaper for whole log in session , if you have multiple wallpapers in the target folder then it would select anyone randomly, although you can change it with Mod+shif+c
• slideshow which is used in gaurda hyprland by default ( Mod+shift+c again for changing wallpapers)
• animated you can use live wallpaper through it and if you have multiple animated gifs in target folder then it will choose one from it randomly, and Mod+shift+c is again for changing to another animated wallpaper

There might be some of the things might not some of the things which would not work so it again advised to have a back-up first

Feedback needed

Yeah, I have made this script casually, not with very much focus in technically less than 1.5 days , and just recently learned the basics of bash scripting and this can be said just very first that I have made, so there can be some problem in it, so please report it here in this thread

Things to do before using script

Make sure you have not removed wppaperd from config files ,
if removed, then make it again
things to install

• gum (the heart of the script)

sudo pacman -S gum 

• swww (for animated wallpapers)

sudo pacman -S swww

• wpaperd (if you have removed it, but you want slideshow feature)

sudo pacman -S wpaperd

Cons

yeah, there is one problem, the main script is too big for some peoples (advanced users who want to play with it), and will need a little bit of time to understand

Final words

Well, this is what I can tell about this script
If I would decode each and everything of this script then it will be too much long to type, please explore and feel free to report any bug you find, this script will might have more features like in future like :

• changing hyprland login wallpaper
• or something else

But currently we need feedbacks only

Thanks !!!

Summary

Ignore any spelling mistakes if thee are any

[TilliDie]

Is there a reason why it can only use gif,s as a format for animated wallpapers? when scaling a gif they only use 256 color space which will cause a very degraded image , It can be mitigated but will result in a very large file size.

[Ankur]

the software that is being used is swww for showing background wallpapers
and it uses only gif
if I try with any other thing then it will throw an error

 ╭─ankur@ankur in ~ 
 ╰─λ swww img custom_wallpapers/animated/experimental.mp4 
Error: "failed to decode image: The image format could not be determined"

when the user will select any video file from the script then with the help of ffmpeg it is converted into gif .

This is a sample of how it is being converted :

The reason to use swww is that is not consuming something like too much of processing power and it is also being used for static wallpapers

BTW<, I would recommend to use smaller videos so that it doesn’t takes too long to load the live wallpaper

[SGS]

under construction

[SomniusX]

waybar on the bottom… nah… i even moved the task bar to the top on windows machines…

[IUSELINUX]

Personal choice bro! (Even I did the same until 11 came )

[Ankur]

@SomniusX

waybar on the bottom… nah…

I also like waybar on top but I have seen main Maintainer (SGS) use to of bottom waybar , so there are different options for waybar in G-Hyprland
BTW, by default it is on top

[SomniusX]

@Ankur

there are different options for waybar in G-Hyprland

I should set-up g-hyprland soon… noted.!

[Ankur]

BTW, we really need some testers,not for telling that what features should be added, that was already decided by me , but for checking if there are any bugs in the provided features or not

[SomniusX]

Count me in
Guide me mastah!

[SomniusX]

I’ve placed your config files and i’m testing things out.

For starters, you can add an emoji picker “emote”, i have instructions here

Hyprland wofi-emoji inserts "0" on Telegram-Desktop

Well it works… emote works as expected… emote from aur sudo pacman -Syu emote I just re-worked my hyprland.conf and added the line #emote emoji picker #installed thru aur bind = $mainMod, E, exec, emote instead of wofi-emoji After that you need to run emote once on a terminal or after re-login and when you hit super+e (in my case) it displays the emoji picker : [image] (for some reason i can’t screenshot it, so here is a picture) And yes after you select the emoji of your choice, it is …

and not to use wofi-emoji cause the project is archived and the script in order to work it inserts a leading “0” then searches for it and replaces it…

anyway, emote works as expected…

About other things, i’m trying to play an animated gif without success, maybe cause it’s over 200mb ?

Also about screenshot, you use grimblast, that wasn’t installed, maybe g-hyprland checks for things that aren’t installed on a default system, just like it checks for gum ?

Edit :

On another note
Maybe implement a back up of previous user dot files and folders that are in the default installations or the ones that are replaced by yours, then option to restore them thru g-hyprland.

I’ll try to give out an example after I get home from work.

Also, script for gum to have a choice between default screenshot tool and grimeshot, with maybe options to directly use clip board or save, or then both.

If I’m successful, I’ll try forking it so you can merge it if it’s accepted, into master

[Ankur]

@SomniusX

About other things, i’m trying to play an animated gif without success, maybe cause it’s over 200mb ?

The problem is actually with swww-daemon which wasn’t loaded when swww img <img-path> command was executed

go to : .config/hypr/settings/background.conf and change the line

exec-once = ~/.config/hypr/brain/scripts/static_wall_garuda.sh

to

exec-once = sleep 1 && ~/.config/hypr/brain/scripts/static_wall_garuda.sh

I hope this will fix it , as swww-daemon takes some millisecond to load

@SomniusX

Also, script for gum to have a choice between default screenshot tool and grimeshot, with maybe options to directly use clip board or save, or then both.

I actually use grim blast but forgot that the default one is not grimblast
totally a copy paste mistake by me

but hmm , it wasn’t changed in the cheat,
what should be kept by default ? @SGS

• grimblas
• grim and slurp

@SomniusX

For starters, you can add an emoji picker “emote”, i have instructions here

Hmm… I will need to take a look at it

@SomniusX

Maybe implement a back up of previous user dot files and folders that are in the default installations or the ones that are replaced by yours, then option to restore them thru g-hyprland.

I was assuming that the user will be using G-Hyprland script since right after installation
But it would be nice though , specially for things like waybar

@SomniusX

If I’m successful, I’ll try forking it so you can merge it if it’s accepted, into master

It would be decided by SGS, I am co-maintainer , not the main one

fix(garuda-hyprland-settings): fix swww not showing animated wallpaper on...

[Ankur]

@SomniusX

About other things, i’m trying to play an animated gif without success, maybe cause it’s over 200mb ?

At that moment, I thought that this is just swww-daemon slow loading glitch , but now when I my ownself is using new animated wallpapers which are of more than of 150 then I am facing the same issue with it , yes slow daemon loading is also an Issue but the issue with animated wallpaper loading at startup is that bigger once fail to load at startup

There is a simple workaround that I got , first load an image then after that loading big animated wallpapers works without glitching :

exec-once = swww-daemon
bind = $mainMod SHIFT,C, exec, ~/.config/hypr/brain/scripts/animated_wallpaper.sh
exec-once = sleep 2 && ~/.config/hypr/brain/scripts/static_wall_garuda.sh
exec-once = sleep 4 && ~/.config/hypr/brain/scripts/animated_wallpaper.sh

Well, this was small workaround for me atleast ,
BTW, it looks awful when there is no backround for some 10 seconds when you are at startup and the no backround is loaded because the onw which is being loaded is of 200 MB and would take 10 sec to load

Well, already made an MR for this isse

feat(garuda-hyprland-settings): load an image before animated wallpaper to...

But before merging it I would like to know if it is good idea or not to load an image before the animated wallpaper or is it a bad idea
SGS ?