[KEYBIND CHEATSHEET] needs updating to handle Hyprland Lua configs

[ajgringo619]

This affects Hyprland 0.55 and newer.

[spiros132]

@blackbartblues

[blackbartblues]

Will be done

[blackbartblues]

#865

Done

[GlutenBoy]

I see that this was already fixed, but how does it work? The docs hasn't been updated for it. Thx

[blackbartblues]

I've updated readme.md

[GlutenBoy]

Sorry maybe I'm not looking at the right file, but I don't see the update? Is it possibly still in a PR, although I tried looking for it. Sorry I don't want to be a pain in ... :)

https://github.com/noctalia-dev/noctalia-plugins/blob/main/keybind-cheatsheet/README.md

Thx

[blackbartblues]

This is in PR. We have to wait till @spiros132 merge this giant PR. It has a lot of features implemented in this one PR so I hope he will do it fast.

[blackbartblues]

https://github.com/blackbartblues/noctalia-plugins/blob/944d21c8213c39c51a4fb81f0692f8f4018f6392/keybind-cheatsheet/README.md

[blackbartblues]

Everything is inside of PR #725

[blackbartblues]

I am rewriting README to clearly indicate how new system works.

[ajgringo619]

I got the new version this morning - thanks! Everything is working for me, except the categories (all binds are listed under "Other") and the settings GUI (returns an empty window). Here's a sample of my current keybinds:

---------------------
---- MY PROGRAMS ----
---------------------

-- set programs that you use
local fileManager = "dolphin"
local menu = "fuzzel"
local terminal = "kitty"

---------------------
---- KEYBINDINGS ----
---------------------

local mainMod = "SUPER" -- Sets "Windows" key as main modifier

-- stylua: ignore start
-- 1. MAIN KEYBINDS
-- Hyprland
local closeWindowBind = hl.bind(
    mainMod .. " + Q",
    hl.dsp.window.close(),
    { description = "Close Window" }
)
hl.bind(
    mainMod .. " + SHIFT + R",
    hl.dsp.exec_cmd("hyprctl reload"),
    { description = "Reload Hyprland" }
)
hl.bind(
    mainMod .. " + F",
    hl.dsp.window.float({ action = "toggle" }),
    { description = "Toggle floating" }
)
hl.bind(
    mainMod .. " + SHIFT + F",
    hl.dsp.window.fullscreen({ action = "toggle" }),
    { description = "Toggle fullscreen" }
)

The syntax in your README.md throws errors: unexpected symbol near '...'

[blackbartblues]

Try to delete -- Hyprland. I've found a bug with settings. So I will update that.

-- 1. APPLICATIONS
hl.bind("SUPER + Q", hl.dsp.exec_cmd([[gtk-launch "$(xdg-settings get default-web-browser | sed 's/\.desktop$//')"]]), { description = "Browser (default)" })
hl.bind("SUPER + RETURN", hl.dsp.exec_cmd("kitty"), { description = "Terminal" })

hl.bind("SUPER + W", hl.dsp.window.close(), { description = "Close Window" })
hl.bind("SUPER + E", hl.dsp.exec_cmd("kitty -e yazi"), { description = "Yazi" })
hl.bind("SUPER + SHIFT + E", hl.dsp.exit(), { description = "Exit Hyprland" })
hl.bind("SUPER + SHIFT + P", hl.dsp.exec_cmd("systemctl hibernate"), { description = "Hibernate" })
hl.bind("SUPER + F1", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call plugin:keybind-cheatsheet toggle"), { description = "Keybinds List" })
hl.bind("SUPER + SPACE", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call launcher toggle"), { description = "Launcher" })
hl.bind("CTRL + Print", hl.dsp.exec_cmd([[grimblast save area ~/Pictures/Screenshot_$(date +%Y%m%d_%H%M%S).png | sed "s|$HOME|~|" | tr -d '\n' | wl-copy]]), { description = "Screenshot Area - path starting with ~ to Clipboard" })
hl.bind("Print", hl.dsp.exec_cmd("grimblast copy area"), { description = "Screenshot Area to Clipboard" })
hl.bind("ALT + Print", hl.dsp.exec_cmd([[grim -g "$(slurp)" - | swappy -f -]]), { description = "Screenshot with edit" })
hl.bind("SUPER + H", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call plugin:plugin-manager toggle"), { description = "Plugin Manager" })
hl.bind("SUPER + A", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call plugin:AnimeReloaded togglePanel"), { description = "Anime Reloaded" })

-- 2. NOCTALIA (QUICKSHELL) INTEGRATION
hl.bind("SUPER + J", hl.dsp.dpms("toggle"), { description = "Monitor toggle" })
hl.bind("SUPER + C", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call launcher calculator"), { release = true, description = "Calculator" })
hl.bind("SUPER + B", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call calendar toggle"), { description = "Calendar" })
hl.bind("SUPER + P", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call sessionMenu toggle"), { release = true, description = "Power Menu" })
hl.bind("SUPER + Z", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call wallpaper random"), { description = "Change Wallpaper" })
hl.bind("SUPER + N", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call notificationCenter toggle"), { description = "Notifications" })
hl.bind("SUPER + Escape", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call lockScreen lock"), { description = "Lock Screen" })
hl.bind("SUPER + Print", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call plugin:screen-recorder toggle"), { description = "Record Screen" })
hl.bind("SUPER + CTRL + P", hl.dsp.exec_cmd("systemctl hibernate"), { description = "Hibernate" })
hl.bind("SUPER + S", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call plugin:hyprland-steam-overlay toggle"), { description = "Steam Overlay" })
hl.bind("SUPER + D", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call plugin:hyprland-discord-overlay toggle"), { description = "Discord Overlay" })

-- 3. WINDOW MANAGEMENT
hl.bind("SUPER + F", hl.dsp.window.fullscreen({ mode = "maximized", action = "toggle" }), { description = "Fullscreen (with bar)" })
hl.bind("SUPER + SHIFT + D", hl.dsp.window.fullscreen({ mode = "fullscreen", action = "toggle" }), { description = "Fullscreen (pure)" })
hl.bind("SUPER + SHIFT + T", hl.dsp.window.float({ action = "toggle" }), { description = "Floating Mode" })
hl.bind("SUPER + G", hl.dsp.group.toggle(), { description = "Group Windows" })
hl.bind("SUPER + R", hl.dsp.layout("togglesplit"), { description = "Rotate Split" })
hl.bind("SUPER + bracketleft", hl.dsp.layout("preselect l"), { description = "Preselect Left" })
hl.bind("SUPER + bracketright", hl.dsp.layout("preselect r"), { description = "Preselect Right" })

-- 4. MULTIMEDIA AND BRIGHTNESS
hl.bind("XF86AudioRaiseVolume", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call volume increase"), { locked = true, repeating = true, description = "Volume Up" })
hl.bind("XF86AudioLowerVolume", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call volume decrease"), { locked = true, repeating = true, description = "Volume Down" })
hl.bind("XF86AudioMute", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call volume muteOutput"), { locked = true, description = "Mute" })

hl.bind("XF86AudioPlay", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call media playPause"), { locked = true, description = "Play / Pause" })
hl.bind("XF86AudioNext", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call media next"), { locked = true, description = "Next Track" })
hl.bind("XF86AudioPrev", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call media previous"), { locked = true, description = "Previous Track" })

hl.bind("XF86MonBrightnessUp", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call brightness increase"), { locked = true, repeating = true, description = "Brightness +" })
hl.bind("XF86MonBrightnessDown", hl.dsp.exec_cmd("qs -c ~/dev/repo/noctalia ipc call brightness decrease"), { locked = true, repeating = true, description = "Brightness -" })

-- 5. NAVIGATION (FOCUS)
hl.bind("SUPER + left", hl.dsp.focus({ direction = "left" }), { description = "Focus Left" })
hl.bind("SUPER + right", hl.dsp.focus({ direction = "right" }), { description = "Focus Right" })
hl.bind("SUPER + up", hl.dsp.focus({ direction = "up" }), { description = "Focus Up" })
hl.bind("SUPER + down", hl.dsp.focus({ direction = "down" }), { description = "Focus Down" })

This is my keybind.lua

[ajgringo619]

I tried your config, same problems. Maybe it's my hyprland.lua file:

---- switching to Lua

---------------------------
----- SOURCED CONFIGS -----
---------------------------

require("modules.environment")
require("modules.keybinds")
require("modules.look-feel")
require("modules.outputs")
require("modules.programs")
require("modules.windows")

-----------------------
----- PERMISSIONS -----
-----------------------

-- See https://wiki.hypr.land/Configuring/Advanced-and-Cool/Permissions/
-- Please note permission changes here require a Hyprland restart and are not applied on-the-fly
-- for security reasons

hl.config({
    ecosystem = {
        enforce_permissions = true,
    },
})

hl.permission("/usr/(bin|local/bin)/hyprshot", "screencopy", "allow")
hl.permission("/usr/(lib|libexec|lib64)/xdg-desktop-portal-hyprland", "screencopy", "allow")
hl.permission("/usr/(bin|local/bin)/hyprpm", "plugin", "allow")

----------------
----  MISC  ----
----------------

-- See https://wiki.hypr.land/Configuring/Layouts/Dwindle-Layout/ for more
hl.config({
    dwindle = {
        preserve_split = true, -- You probably want this
    },
})

-- See https://wiki.hypr.land/Configuring/Layouts/Master-Layout/ for more
hl.config({
    master = {
        new_status = "master",
    },
})

hl.config({
    misc = {
        force_default_wallpaper = 0, -- Set to 0 or 1 to disable the anime mascot wallpapers
        disable_hyprland_logo = true, -- If true disables the random hyprland logo / anime girl background. :(
        focus_on_activate = true,
    },
})

---------------
---- INPUT ----
---------------

hl.config({
    input = {
        kb_layout = "us",
        kb_variant = "",
        kb_model = "",
        kb_options = "",
        kb_rules = "",

        follow_mouse = 1,

        sensitivity = 0, -- -1.0 - 1.0, 0 means no modification.

        touchpad = {
            natural_scroll = false,
        },
    },
})

[blackbartblues]

I'm gonna look into it.

[blackbartblues]

Found problem it was trivial. Making PR hopefully @spiros132 will have time to review it.

[ajgringo619]

Really appreciate this.

[blackbartblues]

Done and done, merged. I think if you reload noctalia it will find update already.

[ajgringo619]

Working - thanks again!

[GlutenBoy]

Thank you, I just updated my hyprland.lua config file and it works like a charm, thank you for your good work!

Note that my config file doesn't use require() like ajgringo619

[Nitrotox]

I am using ~/.config/hypr/keybind.lua for all my keybinds which is working just fine for hyprland as I am including the keybind.lua in the hyperland.lua file:

for _, mod in ipairs({"monitors", "inputs", "keybind", "windowrules", "animations", "themes.theme"}) do
package.loaded[mod] = nil
end

require("monitors")
require("startup")
require("inputs")
require("keybind")
require("windowrules")
require("animations")
require("themes.theme")

in the plugin I see an option to change the path of the hylprland.lua file but simply changing the filename to keybind.lua and setting the parser to auto or lua is not working. Any ideas? Thoughts?`

[blackbartblues]

Try to change it to hyprland.lua save and refresh. I need to change settings description. It should automatically find keybind.lua via hyprland.lua file.