✨ feat(compositor/hyprland): runtime config injection

[retrozinndev]

This makes colorshell inject it's own Hyprland config into the running instance without modifying the user's config files, it also fixes the Nix issue with colorshell's Hyprland config(#34).
Other than Hyprland, it also packs other config files like hyprlock into the gresource, then unpacks it into memory for later use on XDG_RUNTIME_DIR/colorshell/config.

Why isn't this merged yet?

I'm waiting for the Hyprland package to get the 0.54 update in the Arch repos.

Extra new features

• colorshell now implements it's own grim+slurp abstraction; together with that, you can now take an active/focused client screenshot with ALT + PrintScrn or colorshell screenshot active.
• screen recording now also records the desktop's audio output. (you can disable by setting screen_recording:include_audio to false in the config)

Breaking Changes

Bindings like SUPER + K(terminal) and SUPER + E(file manager) have been removed from the shell configuration, as it's more of a personal choice; the user should configure it beforehand(or just use the default Hyprland configuration).

The input method editor(IME) is now fcitx5, which is less buggy¹, faster and more integrated than the previous one, ibus.

(internal) The socket path has moved from XDG_RUNTIME_DIR/colorshell.sock to XDG_RUNTIME_DIR/colorshell/.sock for organization purposes.

Non-breaking changes

colorshell is now independent of the hyprshot program and now implements its own grim and slurp abstraction, using the Compositor API².

Footnotes

1. ibus had some annoying text entry issues; it would entirely clear the focused text entry if the window was opened with the entry focused + also other text entry-related issues. ↩

2. The Compositor API is an interface that makes it easier to implement support for different Wayland compositors, it's currently being worked on, and also, a small part of it is already being used internally. ↩

[HerXayah]

I have been looking into the config injection part for a bit now (an hour).
I've been wondering.
How I understand gresources is bundling files within the final compiled thing.
Meaning whatever is in the configs that were bundled, is in the app.
How do you get around to having the thing even load the user configs, when what you load kinda has to be in the final compilation apart from recompiling the whole thing for every change, since it reads from the conf included first.

[retrozinndev]

I have been looking into the config injection part for a bit now (an hour). I've been wondering. How I understand gresources is bundling files within the final compiled thing. Meaning whatever is in the configs that were bundled, is in the app. How do you get around to having the thing even load the user configs, when what you load kinda has to be in the final compilation apart from recompiling the whole thing for every change, since it reads from the conf included first.

Here's how it works:
colorshell first reads the config files from its gresource at initialization, then it writes all the hyprland config files to XDG_RUNTIME_DIR(which is a tmpfs directory/it's stored in memory instead of disk), and finally, loads them on hyprland with hyprctl keyword source; which is the equivalent of sourcing another config file from hyprland.conf .

[HerXayah]

I have been looking into the config injection part for a bit now (an hour). I've been wondering. How I understand gresources is bundling files within the final compiled thing. Meaning whatever is in the configs that were bundled, is in the app. How do you get around to having the thing even load the user configs, when what you load kinda has to be in the final compilation apart from recompiling the whole thing for every change, since it reads from the conf included first.

Here's how it works: colorshell first reads the config files from its gresource at initialization, then it writes all the hyprland config files to XDG_RUNTIME_DIR(which is a tmpfs directory/it's stored in memory instead of disk), and finally, loads them on hyprland with hyprctl keyword source; which is the equivalent of sourcing another config file from hyprland.conf .

sigh I feared that kinda 😭

Thanks for the response though ^-^

What I mean is, that how I use your colorshell personally is this:
https://github.com/HerXayah/mielladots/blob/main/install.sh

I never touch your .config files at all, instead supplying my own via stow symlinking it.
At least in my head, this would kinda bork stuff, unless I'm just mis-thinking in my head how the whole thing works.

[retrozinndev]

Also, forgot to mention, it also checks if the .last-updated file exists in XDG_RUNTIME_DIR/colorshell/config/hyprland/.last-updated, then, if it exists, it checks if there's a difference between the gresource's .last-updated and the written one under XDG_RUNTIME_DIR(i don't think we need a precise date checking thing, since it's just some config files), if there is a difference, colorshell overrides the "old" config files with the ones in the gresource.

This XDG_RUNTIME_DIR is completely temporary, since it's stored in RAM as a tmpfs, so we need to write the config files in every first-run after the user is logged in; if the user restarts colorshell in the same session, colorshell won't write the configs in memory again, just so it doesn't waste your RAMs lifetime without actually needing it.

[retrozinndev]

sigh I feared that kinda 😭

Thanks for the response though ^-^

I'm sorry if I overcomplicated it... haha

You're welcome 😁

What I mean is, that how I use your colorshell personally is this:
https://github.com/HerXayah/mielladots/blob/main/install.sh

I never touch your .config files at all, instead supplying my own via stow symlinking it.
At least in my head, this would kinda bork stuff, unless I'm just mis-thinking in my head how the whole thing works.

Ahh, I see. I don't think it'll break your system that much, it'll take some tinkering tho.
I removed some configs that seemed personal from the shell, like the terminal and file manager binds(as I mentioned in the main PR comment) + (this is the only actual breaking thing) window management binds.

I removed them because Hyprland's default config already provides all of it, and I'm trying to make colorshell the more customizable/less restricting it can be(also less intrusive, allowing the creation of a package to be able to install it), so hence the changes...

I recommend merging some of the ~/.config/hypr/shell/ files with your ~/.config/hypr/user/ ones(or, if you don't use this directory, merge it with your personal configs), then moving the user configs to the common ~/.config/hypr/ dir(just for a better looking structure, since ~/.config/hypr/shell is now-unused)
Just remove from the merged config bindings like SUPER + L, SUPER + N, and other colorshell-specific ones, those are configured in colorshell's own Hyprland config.

I'll try doing a migration thing in the update script, so you won't have to do all that manually.

[HerXayah]

Also, forgot to mention, it also checks if the .last-updated file exists in XDG_RUNTIME_DIR/colorshell/config/hyprland/.last-updated, then, if it exists, it checks if there's a difference between the gresource's .last-updated and the written one under XDG_RUNTIME_DIR(i don't think we need a precise date checking thing, since it's just some config files), if there is a difference, colorshell overrides the "old" config files with the ones in the gresource.

This XDG_RUNTIME_DIR is completely temporary, since it's stored in RAM as a tmpfs, so we need to write the config files in every first-run after the user is logged in; if the user restarts colorshell in the same session, colorshell won't write the configs in memory again, just so it doesn't waste your RAMs lifetime without actually needing it.

sigh I feared that kinda 😭
Thanks for the response though ^-^

I'm sorry if I overcomplicated it... haha You're welcome 😁

What I mean is, that how I use your colorshell personally is this:
https://github.com/HerXayah/mielladots/blob/main/install.sh
I never touch your .config files at all, instead supplying my own via stow symlinking it.
At least in my head, this would kinda bork stuff, unless I'm just mis-thinking in my head how the whole thing works.

Ahh, I see. I don't think it'll break your system that much, it'll take some tinkering tho. I removed some configs that seemed personal from the shell, like the terminal and file manager binds(as I mentioned in the main PR comment) + (this is the only actual breaking thing) window management binds.

I removed them because Hyprland's default config already provides all of it, and I'm trying to make colorshell the more customizable/less restricting it can be, so rence the changes...

I recommend merging some of the ~/.config/shell/ files with your ~/.config/user/ ones, them moving the user configs to the common ~/.config/hypr/ dir(just for a better looking structure, since ~/.config/hypr/shell is now-unused) Just remove from the merged config bindings like SUPER + L, SUPER + N, and other colorshell-specific ones, those are configured in colorshell's own Hyprland config.

I'll try doing a migration thing in the update script, so you won't have to do all that manually.

I am chaos! MUHAHAH!
haha... I hacked that together in 2 hours today out of boredom and after failing at AGS.

Okay, so you moved the internal ones into it.
Would keybind management be inside the shell itself going forward or via the config file?
Since you load them once, that would mean changing keybinds must be somewhere inside the app, as you read the actual files etc.

[retrozinndev]

I am chaos! MUHAHAH!
haha... I hacked that together in 2 hours today out of boredom and after failing at AGS.

That's crazy lmao, a lot of stuff for 2 hours 😆
But I really recommend learning how to use AGS and the Astal libraries, you'll surely learn a lot of valuable stuff!

Okay, so you moved the internal ones into it.

Yep.

Would keybind management be inside the shell itself going forward or via the config file?

It's now stored in one of the config files that are sourced/imported at runtime.

Since you load them once, that would mean changing keybinds must be somewhere inside the app, as you read the actual files etc.

Nahh, you can configure hyprland just how you would normally in a clean install, that's why I'm doing this, makes things a lot cleaner.

You should just add an exec-once = ~/.local/bin/colorshell and boom, colorshell works out of the box

[HerXayah]

I am chaos! MUHAHAH!
haha... I hacked that together in 2 hours today out of boredom and after failing at AGS.

That's crazy lmao, a lot of stuff for 2 hours 😆 But I really recommend learning how to use AGS and the Astal libraries, you'll surely learn a lot of valuable stuff!

Okay, so you moved the internal ones into it.

Yep.

Would keybind management be inside the shell itself going forward or via the config file?

It's now stored in one of the config files that are sourced/imported at runtime.

Since you load them once, that would mean changing keybinds must be somewhere inside the app, as you read the actual files etc.

Nahh, you can configure hyprland just how you would normally in a clean install, that's why I'm doing this, makes things a lot cleaner.

Nah. Nah nah nah!
The Documentation is very horrible in my opinion on Astral Libs.
Have fun getting Cava to work. It wont.... URK. PAIN!
The file is in the UI folder in my repo in the Bar.tsx xD
its painful

Also check. Okay, good, then ill wait patiently and excitedly

[retrozinndev]

Nah. Nah nah nah!
The Documentation is very horrible in my opinion on Astral Libs.

I don't think so... The usage of the libraries are pretty straightforward, a lot of them have built-in documentation for each functions and classes.

Have fun getting Cava to work. It wont.... URK. PAIN!

I tried adding a cava display into the media widget... I couldn't lmao

The thing is that I don't know much about Cairo(GTK's renderer), I should learn it a little bit more so I can actually try to do this properly.

The file is in the UI folder in my repo in the Bar.tsx xD
its painful

Also check. Okay, good, then ill wait patiently and excitedly

Oh you did the implementation?! That's crazy work!! I'll surely take a look at it as soon as I can