Hotkey script results in garbled text on remote Windows server

[xinxianwu]

I wrote the following script. I expect that when I press Ctrl+Shift+W while remotely connected to a Windows server, it will input "Welcome1". However, I am getting a string of garbled text instead. I am not sure how to fix this.

hs.hotkey.bind({"ctrl", "shift"}, "w", function()
    hs.eventtap.keyStrokes("Welcome1")
end)

[Rhys-T]

Are you using Microsoft Remote Desktop to connect to the server? It looks like it's known to have issues with the key events generated by Hammerspoon: #1056, #2281. According to #2881 (comment), changing Remote Desktop's 'Keyboard Mode' setting from 'Scancode' to 'Unicode' can work around the problem. If I understand correctly, this basically makes Remote Desktop send which character is being typed, rather than which key.

hs.eventtap.keyStrokes seems to set the character for the key events it sends (using CGEventKeyboardSetUnicodeString), but not the keycode, which means that the keycode stays at the default of 0 (the A key). So it looks to Remote Desktop like you keep pressing A, but in a different keyboard layout each time, mapping that 'key' to each character of the string you're trying to type. In Scancode mode, MSRD is ignoring that mapping and letting the Windows server decide what character to insert based on the keycode¹… which isn't set correctly. If you switch it to Unicode mode, it should use the string set by HS instead. (But it will also start using your local Mac's keyboard layout rather than the one selected on the Windows server, if that's different.)

You can also send each key individually using hs.eventtap.keyStroke or hs.eventtap.event.newKeyEventSequence, which should set the keycodes properly, but you'd need to figure out the correct combination of key + modifiers for each character yourself - Hammerspoon won't do it for you when using those functions.

Footnotes

1. Normally that would be a like in the issues I mentioned above. My guess is that since you still have Control (and Shift) pressed from the hotkey at that point, it's ending up as a Control-A character - a.k.a. Start of Heading, or ␁. ↩

[xinxianwu]

I logged into the Windows server through Royal TSX and tried changing key presses to Unicode, but the garbled characters issue still hasn't been resolved.

[cmsj]

I'd be interested to know if hs.eventtap.keyStroke() works. Perhaps we need a variant of keyStrokes() which just sends key sequences (although then we have the interesting challenge of trying to transform a unicode input string into keycodes!)

[latenitefilms]

We need to merge in @asmagill's hs.text - that's what I use in CommandPost for unicode handling.

[github-actions]

This issue needs more information. Please see our request above.