feat: Add global shortcuts

[tuxinal]

i'm using electron's globalShortcuts api here which doesn't have a way to detect tell the difference between keyup and keydown. this means the push to talk/mute/deafen/etc actions don't really work. we'd probably have to switch to something else at some point
currently implementing venbind to use instead of electron's api

resolves #18

[tuxinal]

Okay so electron's globalShortcuts api is not at all a good fit for this. the keyup/keydown events are rather crucial for discord's functionality. and also it "consumes" inputs (i have no idea what the correct term for this is. basically if you set anything as a keybind nothing else can use it, for example if you have the tab key as push to talk tab won't do anything everywhere else).

[Vendicated]

yes. as mentioned in the issue you linked and as discussed on discord, using a native library would be better. however all the current options don't seem to support wayland at all, so we will most likely have to write our own module

[klhrt]

Could you do a quick write-up of how this works? E.g. is vesktop --keybind 2 supposed to execute the keybind of id 2 set inside the app, or is the cli used to attach a bind to a key? It's pretty difficult for me to parse the code to figure out how to use it.

[tuxinal]

when you make a new keybind in discord asigns it an id. currently i have the id for each keybind written next to the keybind in the client.
you can use this id in the cli as: (vesktop) -- --keybind (id) (mind the two sets of dashes)
or if it's ptt you can add a keyup/keydown thing at the end of it.

[klhrt]

this doesn't seem to work on my setup on ubuntu with i3+x11, unless I still don't get how to use it. not sure if it's just not compatible with my setup or i'm just stupid, but if it doesn't work due to a window manager or display server problem it's something to look into.

if i set a toggle mute keybind with an arbitrary key and it gets assigned an id of 3, running vesktop --keybind 3 doesn't toggle mute.

[tuxinal]

an update seems to have borked it
you'll have to wait until i figure out how to fix it

[tuxinal]

@klhrt try this commit

[klhrt]

UnhandledPromiseRejectionWarning: Error: Script failed to execute, this normally means an error was thrown. Check the renderer console for the error.
    at node:electron/js2c/renderer_init:2:16470
    at IpcRendererInternal.<anonymous> (node:electron/js2c/renderer_init:2:10723)
    at IpcRendererInternal.emit (node:events:519:28)
    at Object.onMessage (node:electron/js2c/renderer_init:2:8837)
(node:1605447) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 33)

Whenever I run the keybind command, no response in-app and this error pops up. Not sure if the error is responsible/related though. I also don't know if it was happening in the earlier commit as I wasn't running vesktop from a terminal window.

for reference this is the resulting printout from the terminal where i run the keybind command:

~> vesktop --keybind 2
Checking for beta autoupdate feature for deb/rpm distributions
Found package-type: deb
Checking for update
~>

[Covkie]

@klhrt ATM the command is vesktop -- --keybind id 🥴

[klhrt]

@klhrt ATM the command is vesktop -- --keybind id 🥴

and it works! thanks

[tuxinal]

it would be nice if someone could test this commit on their system. the binary is technically built on nix and idk if that affects anything

[Covkie]

Can confirm X11 works! (Arch here)

[rbutera]

anyone know how hard it would be to get this to work on Hyprland?

[tuxinal]

you'd have to implement xdg-desktop-portal's GlobalShortucts api for hyprland on their portal implementation (which they might have implemented already i'm not sure)
i'm working on the wayland side of things as of right now and it's proving somewhat difficult. no one really has a complete implementation of GlobalShortcuts

[condmaker]

Doesn't appear to be working on Hyprland or wayland in general. I can't even start the instance. Here's the full stack trace if that helps:

thread '<unnamed>' panicked at src/lib.rs:16:44:
called `Result::unwrap()` on an `Err` value: Message("todo")
stack backtrace:
   0:     0x7e1f3eae23d5 - <std::sys_common::backtrace::_print::DisplayBacktrace as core::fmt::Display>::fmt::h3692694645b1bb6a
   1:     0x7e1f3eb0661b - core::fmt::write::h5131d80b4c69b88d
   2:     0x7e1f3eadff8f - std::io::Write::write_fmt::h1fb327a7d8b0eb36
   3:     0x7e1f3eae21ae - std::sys_common::backtrace::print::h998d75b840f75a73
   4:     0x7e1f3eae36f9 - std::panicking::default_hook::{{closure}}::h18ec7fe6a38b9da0
   5:     0x7e1f3eae349a - std::panicking::default_hook::hfb3f22c2e4075a6a
   6:     0x7e1f3eae3b93 - std::panicking::rust_panic_with_hook::h51af00bcb4660c4e
   7:     0x7e1f3eae3a74 - std::panicking::begin_panic_handler::{{closure}}::h39f76aa863fbe8ce
   8:     0x7e1f3eae2899 - std::sys_common::backtrace::__rust_end_short_backtrace::h4d10fc2251b89840
   9:     0x7e1f3eae37a7 - rust_begin_unwind
  10:     0x7e1f3e9cea13 - core::panicking::panic_fmt::h319840fcbcd912ef
  11:     0x7e1f3e9ceea6 - core::result::unwrap_failed::haccb9aaa604e1e21
  12:     0x7e1f3e9dfa8c - std::sys_common::backtrace::__rust_begin_short_backtrace::hfc2e22cd1f52e7a4
  13:     0x7e1f3e9dd1ff - core::ops::function::FnOnce::call_once{{vtable.shim}}::h3001236f03d016af
  14:     0x7e1f3eae5ecb - std::sys::pal::unix::thread::Thread::new::thread_start::h3b8e81128811868f
  15:     0x7e1fd0c4439d - <unknown>
  16:     0x7e1fd0cc949c - <unknown>
  17:                0x0 - <unknown>
[arRPC > ipc] listening at /run/user/1000/discord-ipc-0
[arRPC > websocket] listening on 6463
[arRPC > process] started
thread '<unnamed>' panicked at src/lib.rs:20:44:
called `Result::unwrap()` on an `Err` value: Message("todo")
stack backtrace:
   0:     0x7e1f3eae23d5 - <std::sys_common::backtrace::_print::DisplayBacktrace as core::fmt::Display>::fmt::h3692694645b1bb6a
   1:     0x7e1f3eb0661b - core::fmt::write::h5131d80b4c69b88d
   2:     0x7e1f3eadff8f - std::io::Write::write_fmt::h1fb327a7d8b0eb36
   3:     0x7e1f3eae21ae - std::sys_common::backtrace::print::h998d75b840f75a73
   4:     0x7e1f3eae36f9 - std::panicking::default_hook::{{closure}}::h18ec7fe6a38b9da0
   5:     0x7e1f3eae349a - std::panicking::default_hook::hfb3f22c2e4075a6a
   6:     0x7e1f3eae3b93 - std::panicking::rust_panic_with_hook::h51af00bcb4660c4e
   7:     0x7e1f3eae3a74 - std::panicking::begin_panic_handler::{{closure}}::h39f76aa863fbe8ce
   8:     0x7e1f3eae2899 - std::sys_common::backtrace::__rust_end_short_backtrace::h4d10fc2251b89840
   9:     0x7e1f3eae37a7 - rust_begin_unwind
  10:     0x7e1f3e9cea13 - core::panicking::panic_fmt::h319840fcbcd912ef
  11:     0x7e1f3e9ceea6 - core::result::unwrap_failed::haccb9aaa604e1e21
  12:     0x7e1f3e9d82bc - venbind::js::napi_register_keybind::hee504851f7cfee42
  13:     0x5c87ef3a456c - <unknown>
fatal runtime error: failed to initiate panic, error 5
[1]    79116 IOT instruction (core dumped)  RUST_BACKTRACE=full ./vesktop

[lillithkt]

Doesn't appear to be working on Hyprland or wayland in general. I can't even start the instance. Here's the full stack trace if that helps:
looks like venbind isnt setup for wayland yet, id just wait
https://github.com/tuxinal/venbind/blob/885e0dd7658bb2e25f1ad45f8d6581b0e330febb/src/linux.rs#L30

[tuxinal]

oh none of the wayland support stuff is pushed yet. currently venbind only supports linux x11

[OrHy3]

Over the weekend I started writing a C library (based on libdbus) to ease interactions with XDG GlobalShortcuts. The said library is libgsbus, it's in a very basic release state, but it's complete.
As of now it lacks documentation and a build system, but it's a single source-header files pair, the latter being commented. The project should now be ready.

If anyone is willing to test it around, it'll be greatly appreciated.

[checkraisefold]

As an update for anyone with the PR watched: further work on Venbind has begun to support Windows and Wayland (through xdg-desktop-portal DBus), and is underway.
See tuxinal/venbind#2, tuxinal/venbind#1

[checkraisefold]

An alternative to XDP if at all possible may need to be explored at some point for Venbind considering there is currently 3 different (2 confirmed) bugs blocking global shortcuts in KDE and Hyprland, which afaik are the only two actually usable global shortcuts XDP implementations

hyprwm/xdg-desktop-portal-hyprland#310
https://bugs.kde.org/show_bug.cgi?id=492992

[StayBlue]

Hello! I know this is a draft PR, and it's still a work in progress, but I tried this on Windows by setting a keybind in the settings and doing:

.\Vesktop.exe -- --keybind 2

I also tried doing:

.\Vesktop.exe --keybind 2

And nothing happened when I tried to press the assigned keybind. Also, for whatever reason, trying to set a bind from your mouse in the settings doesn't appear to register.

[tuxinal]

is your keybind push to talk? i've just recently found out that requires some extra context in the code that i haven't yet found a way to provide.

for whatever reason, trying to set a bind from your mouse in the settings doesn't appear to register.

that's a limitation of electron/web in general. discord works around that by doing their keybind recording through their native module.

[StayBlue]

I tried it with the latest commit again.

is your keybind push to talk?

It's the "Toggle Mute" action. When I run:

.\Vesktop.exe -- --keybind 2

It toggles the mute on and off in Discord. However, when I try to use the assigned keybinding I set in the settings, trying to run that command again doesn't do anything.

[tuxinal]

turns out an update caused issues with registering new keybinds. can you try the latest commit?

[Snowy-Fluffy]

Is it possible to do something similar on Linux?

[Snowy-Fluffy]

Is it possible to do something similar on Linux?

Ah, I noticed.

[tuxinal]

With this latest commit i'd say most basic functionalities are ready for use. i'd appreciate if yall did some testing of this fork in case any bugs pop up
all that's left is a little bit better error handling and macos support (which should be fairly easy assuming libuiohook fully supports everything required) and maybe some changes to the cli

[RinLovesYou]

working beautifully here on KDE (wayland)

[StayBlue]

It works with the latest commit. The only thing I'd want on my wish list is a way to have mouse bindings, even if I have to do it manually since Discord's in-client keybinding manager doesn't pick it up because of Electron.

[tuxinal]

can you not manually bind your mouse through the cli with the latest commit?

[baanan]

Hello, is glibc 2.39 the minimum required for venbind? I'm running Pop! OS 22.04 with a glib version of 2.35 (which, as far as I know, is the latest supported version for the distro), and when I try to run the branch, it explains that venbind needs glibc 2.39 to run (full error below). I also tried building venbind myself, and the error persisted.

Full Error

> [email protected] start /home/thate/Documents/utilities/Vesktop
> pnpm build && electron .


> [email protected] build /home/thate/Documents/utilities/Vesktop
> tsx scripts/build/build.mts

APPIMAGE env is not defined, current application is not an AppImage
Vesktop v1.5.5
checkForUpdatesAndNotify called, downloadPromise is null
(node:52635) UnhandledPromiseRejectionWarning: Error: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.39' not found (required by /home/thate/Documents/utilities/Vesktop/static/dist/venbind-linux-x86_64.node)
    at process.func [as dlopen] (node:electron/js2c/node_init:2:2559)
    at Module._extensions..node (node:internal/modules/cjs/loader:1602:18)
    at Object.func [as .node] (node:electron/js2c/node_init:2:2559)
    at Module.load (node:internal/modules/cjs/loader:1295:32)
    at Module._load (node:internal/modules/cjs/loader:1111:12)
    at c._load (node:electron/js2c/node_init:2:16955)
    at Module.require (node:internal/modules/cjs/loader:1318:19)
    at require (node:internal/modules/helpers:179:18)
    at Vr (VCDMain:87:48639)
    at g0 (VCDMain:87:48718)
(Use \`electron --trace-warnings ...` to show where the warning was created)
(node:52635) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag \`--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 2)
^C/home/thate/Documents/utilities/Vesktop/node_modules/electron/dist/electron exited with signal SIGINT

If this can't be changed, then it's completely okay (it's kinda my fault for using a 3-year-old distro too), but I just wanted to let you know in case this is an issue.