obsproject / obs-websocket

Remote-control of OBS Studio through WebSocket
GNU General Public License v2.0
3.84k stars 704 forks source link

Feature Request: GetHotkeyList readable names #1064

Open Kounex opened 1 year ago

Kounex commented 1 year ago

Feature Request Type

RPC Request

Feature Request Type (Other)

No response

Requested Feature

Currently when requesting GetHotkeyList, we only get the internal reference names for the hotkeys, example output may look like this:

Screenshot 2022-12-01 at 15 01 35

To be able to show these to users and enable them to trigger them as needed, they need to be in "human readable" form. I could start to map them internally but for now it is not clear what changes / settings in OBS might lead to the addition or removal of entries of hotkeys and how the internal name might look like. OBS itself is serving them as human readable in the UI:

Screenshot 2022-12-01 at 15 01 28

For consistency and minimizing errors, returning the readable names OBS itself is using for each hotkey would be highly beneficial to make use of this feature.

Requested Feature Usage Scenario

Listing all available hotkeys as exposed by the API to users and enable them to understand which hotkey is which and trigger them correctly (user knows which hotkey returned by the API is which in OBS). Currently the internal name is not suitable for users and would lead to confusion about what they might actually do. Mapping them on my own would also only add another layer which might be inconsistent.