You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In order to not give myself too much of a headache, I'm compiling this below list of features that I will likely never be adding to XIVDeck for one reason or another. Where possible, I will provide justification for my decision.
Execute Arbitrary Combat Actions (Including Blue Magic)
Simply put, it's far too difficult to (reasonably) include this feature safely into XIVDeck. Every button needs to have safety checks and boundary parameters in place to ensure that they can never be executed in an illegal context (and therefore, send data to Square's servers). Combat actions aren't simple to check, and any sort of user experience around this would be extremely complicated. The best workaround I can offer is to configure one or more hidden hotbars that are dedicated to XIVDeck.
PvP Quick Chat
Support for PvP Quick Chat will not be added as a native action as support for it is highly contextual. It is recommended that users who want this feature use Hotbar Buttons.
Extended Macros, Action Chains, or "Smart" Buttons
One of the driving principles of this plugin is that anything that can be on a hotbar slot can also be on a Stream Deck. A secondary (and related) driving principle is that one button on the Stream Deck will trigger one action in-game. Things that contextually decide what to do or allow multiple things to happen at once go against this principle.
macOS or Linux Support (Including Wine)
The Stream Deck Plugin is written to fully use the official Stream Deck APIs as provided by Elgato's software. Unfortunately, this software currently only exists on Windows and macOS. While I do make efforts to support running the plugin on Wine, this is not guaranteed and may break at any time.
"Multiboxing" Support
XIVDeck does not (and will not) support running multiple copies of the game at once. The required complexity of supporting such a configuration goes far beyond what either my code or Elgato's own plugin APIs can reasonably do or provide.
Support for Cross-Computer Stream Decks
For security reasons, both the Stream Deck software and FFXIV need to be running on the same computer. The XIVDeck communication protocol is not encrypted and does not have any meaningful security features, and the overhead of such features is unacceptable for this use case. Users wishing to use cross-computer Stream Decks should look into SSH tunneling or any similar technology that allows them to mirror a port to localhost on their target computer.
I will also not be adding first-party support for non-Stream Deck hardware. However, I have absolutely no problems with other users reusing the API I expose (or suggesting improvements to genericize my API) for alternate products. I only ask that you limit your plugin to the same "one button -> one action" mapping that currently exists.
More things may be added later, depending on what I discover while writing this plugin. I might also decide to go against one of these points every now and then, depending on what it is (e.g. a roleplaying search info toggle button).
The text was updated successfully, but these errors were encountered:
Repository owner
locked and limited conversation to collaborators
Mar 6, 2022
In order to not give myself too much of a headache, I'm compiling this below list of features that I will likely never be adding to XIVDeck for one reason or another. Where possible, I will provide justification for my decision.
Simply put, it's far too difficult to (reasonably) include this feature safely into XIVDeck. Every button needs to have safety checks and boundary parameters in place to ensure that they can never be executed in an illegal context (and therefore, send data to Square's servers). Combat actions aren't simple to check, and any sort of user experience around this would be extremely complicated. The best workaround I can offer is to configure one or more hidden hotbars that are dedicated to XIVDeck.
Support for PvP Quick Chat will not be added as a native action as support for it is highly contextual. It is recommended that users who want this feature use Hotbar Buttons.
One of the driving principles of this plugin is that anything that can be on a hotbar slot can also be on a Stream Deck. A secondary (and related) driving principle is that one button on the Stream Deck will trigger one action in-game. Things that contextually decide what to do or allow multiple things to happen at once go against this principle.
The Stream Deck Plugin is written to fully use the official Stream Deck APIs as provided by Elgato's software. Unfortunately, this software currently only exists on Windows and macOS. While I do make efforts to support running the plugin on Wine, this is not guaranteed and may break at any time.
XIVDeck does not (and will not) support running multiple copies of the game at once. The required complexity of supporting such a configuration goes far beyond what either my code or Elgato's own plugin APIs can reasonably do or provide.
For security reasons, both the Stream Deck software and FFXIV need to be running on the same computer. The XIVDeck communication protocol is not encrypted and does not have any meaningful security features, and the overhead of such features is unacceptable for this use case. Users wishing to use cross-computer Stream Decks should look into SSH tunneling or any similar technology that allows them to mirror a port to
localhost
on their target computer.I will also not be adding first-party support for non-Stream Deck hardware. However, I have absolutely no problems with other users reusing the API I expose (or suggesting improvements to genericize my API) for alternate products. I only ask that you limit your plugin to the same "one button -> one action" mapping that currently exists.
More things may be added later, depending on what I discover while writing this plugin. I might also decide to go against one of these points every now and then, depending on what it is (e.g. a roleplaying search info toggle button).
The text was updated successfully, but these errors were encountered: