bendobos / loupexivdeck

A LoupeDeck plugin for XIVDeck by @KazWolfe.

⚠️ This project is not maintained anymore.

It will not work with current versions of the LoupeDeck Software, FFXIV or XIVDeck.

If someone would like to continue development on this repo, feel free to contact me.

LoupeXIVDeck

A LoupeDeck plugin for XIVDeck by @KazWolfe.

⚠️ This project currently is "unofficial" and the LoupeDeck pretends to be a Stream Deck in order to interface with the game.

Keep in mind that this means that this plugin could break anytime something changes inside XIVDeck.

Features

LoupeXIVDeck supports the same commands as the Stream Deck plugin by @KazWolfe, with some additional adjustments using LoupeDeck's rotary encoders.

• Text Command: Run any slash command in-game.
• Execute Hotbar Slot: Execute any hotbar slot.
• Execute Action: Execute a supported action (see XIVDeck documentation for more information on what an "action" is).
• Run In-Game Macro: Trigger any macro by ID.
• Switch class: Switch to a specific class directly.
• Rotary Encoder | Adjust Audio Channel Volume: Adjust the volume of any audio channel that is available in the game-settings.

TODO / Known Issues

• Add proper error and exception handling. For example, the plugin might currently crash if IDs for actions are given that are out of bounds.
• Changing the WebSocket port is currently not supported, so make sure you use the XIVDeck default port.
• Add some pictures and examples to this repo.

Using the Plugin

1. Install the XIVDeck Game Plugin as explained on the XIVDeck Github page.
2. Download the latest release of this plugin.
3. In your LoupeDeck software, go to: Click User Profile -> Plugins and Assets -> Install Plugin and wait until the plugin is installed.
4. You are ready to go! Add commands from LoupeXIVDeck anywhere you need them.

loupexivdeck's Issues

Not working on 5.6.1

It is not successfully installing when trying to install. My assumption is that this repository hasn't been updated for a year, and is out of date with the current loupedeck software. Is it still being maintained? Or would there be another reason that this is just failing to install?

Add a Dynamic Folder with All Mounts/Minions

It would be cool to have a pre-made page that has buttons for all usable mounts and minions.
Maybe split into 2 different folders for people with lots of minions and mounts.

Docs for Dynamic Folders: https://github.com/Loupedeck/LoupedeckPluginSdk4/wiki/Implementing-Dynamic-Folders

Plugin to Loupedeck marketplcae

Would it be possible to upload the plugin to Loupedeck Marketplace? Instructions here: https://github.com/Loupedeck/PluginSdk/wiki/Distributing-the-plugin and the form to submit plugins is here: https://marketplace.loupedeck.com/contribute

Unable to install on Loupedeck software 5.3.1

Plugin installation fails, going through the logs seems to imply a missing DLL:

2022-12-03T14-08-14-0911 |   1 | TRACE | Extracting plugin package metadata from C:\Users\USERNAME\AppData\Local\Temp\5gk0aceb.ftc
2022-12-03T14-08-14-1972 |   1 | WARN  | Plugin file not found: 'C:\Users\USERNAME\AppData\Local\Loupedeck\Plugins\LoupeXIVDeck\bin\win\LoupeXIVDeck.dll'
2022-12-03T14-08-14-1982 |   1 | TRACE | Package 'plugin4' 'LoupeXIVDeck' 'LoupeXIVDeck' '0.3.0' 'C:\Users\USERNAME\AppData\Local\Loupedeck\Plugins\LoupeXIVDeck\bin\win\LoupeXIVDeck.dll' 'C:\Users\USERNAME\AppData\Local\Loupedeck\Plugins\LoupeXIVDeck'
2022-12-03T14-08-14-1982 |   1 | TRACE | Plugin 'LoupeXIVDeck'
2022-12-03T14-08-14-2077 |   1 | TRACE | Loupedeck is running True
2022-12-03T14-08-14-2077 |   1 | TRACE | Sending service stop message
2022-12-03T14-08-14-2117 |   1 | TRACE | Message sent
2022-12-03T14-08-14-2117 |   1 | TRACE | Waiting Loupedeck to stop
2022-12-03T14-08-14-2183 |   1 | TRACE | Loupedeck is running True
2022-12-03T14-08-14-2203 |   8 | VERB  | WS: Begin closing the connection.
2022-12-03T14-08-14-2213 |   8 | VERB  | WS: Was clean?: True
  sent: True
  received: True
2022-12-03T14-08-14-2223 |   8 | VERB  | WS: End closing the connection.
2022-12-03T14-08-14-2233 |   8 | TRACE | WSC: Disconnected: code 1001 clean 'True' reason ''
2022-12-03T14-08-14-2243 |   8 | TRACE | WSC: Disconnecting 'ws://localhost:59415/version1'
2022-12-03T14-08-14-2248 |   8 | TRACE | WS: The connection has already been closed.
2022-12-03T14-08-14-2248 |   8 | TRACE | WSC: Disconnected
2022-12-03T14-08-14-4767 |   1 | TRACE | Loupedeck is running True
2022-12-03T14-08-14-7413 |   1 | TRACE | Loupedeck is running True
2022-12-03T14-08-15-0022 |   6 | TRACE | Event 'PluginInstallationProgress'
2022-12-03T14-08-15-0067 |   1 | TRACE | Loupedeck is running False
2022-12-03T14-08-15-0077 |   1 | TRACE | Service is stopped
2022-12-03T14-08-15-0087 |   1 | TRACE | Uninstalling plugin 'LoupeXIVDeck'
2022-12-03T14-08-15-0087 |   1 | TRACE | Plugin directory does not exist
2022-12-03T14-08-15-0402 |   1 | TRACE | Plugin.Install('C:\Users\USERNAME\AppData\Local\Loupedeck\Plugins\LoupeXIVDeck\bin\win\LoupeXIVDeck.dll')
2022-12-03T14-08-15-0412 |   1 | TRACE | Loading assembly 'C:\Users\USERNAME\AppData\Local\Loupedeck\Plugins\LoupeXIVDeck\bin\win\LoupeXIVDeck.dll'
2022-12-03T14-08-15-0432 |   1 | ERROR | Exception caught: Error calling Install method
2022-12-03T14-08-15-0432 |   1 | ERROR |     (FileNotFoundException) Could not load file or assembly 'file:///C:\Users\USERNAME\AppData\Local\Loupedeck\Plugins\LoupeXIVDeck\bin\win\LoupeXIVDeck.dll' or one of its dependencies. The system cannot find the file specified.
2022-12-03T14-08-15-0432 |   1 | ERROR | Exception details:
2022-12-03T14-08-15-0442 |   1 | ERROR |     (FileNotFoundException) Could not load file or assembly 'file:///C:\Users\USERNAME\AppData\Local\Loupedeck\Plugins\LoupeXIVDeck\bin\win\LoupeXIVDeck.dll' or one of its dependencies. The system cannot find the file specified.
2022-12-03T14-08-15-0442 |   1 | ERROR |     Call stack:
2022-12-03T14-08-15-0453 |   1 | ERROR |         System.Reflection.RuntimeAssembly._nLoad(System.Reflection.AssemblyName fileName, System.String codeBase, System.Security.Policy.Evidence assemblySecurity, System.Reflection.RuntimeAssembly locationHint, System.Threading.StackCrawlMark& stackMark, IntPtr pPrivHostBinder, Boolean throwOnFileNotFound, Boolean forIntrospection, Boolean suppressSecurityChecks)
2022-12-03T14-08-15-0463 |   1 | ERROR |         System.Reflection.RuntimeAssembly.InternalLoadAssemblyName(System.Reflection.AssemblyName assemblyRef, System.Security.Policy.Evidence assemblySecurity, System.Reflection.RuntimeAssembly reqAssembly, System.Threading.StackCrawlMark& stackMark, IntPtr pPrivHostBinder, Boolean throwOnFileNotFound, Boolean forIntrospection, Boolean suppressSecurityChecks)
2022-12-03T14-08-15-0463 |   1 | ERROR |         System.Reflection.RuntimeAssembly.InternalLoadFrom(System.String assemblyFile, System.Security.Policy.Evidence securityEvidence, Byte[] hashValue, System.Configuration.Assemblies.AssemblyHashAlgorithm hashAlgorithm, Boolean forIntrospection, Boolean suppressSecurityChecks, System.Threading.StackCrawlMark& stackMark)
2022-12-03T14-08-15-0463 |   1 | ERROR |         System.Reflection.Assembly.LoadFrom(System.String assemblyFile)
2022-12-03T14-08-15-0463 |   1 | ERROR |         Loupedeck.PluginInstaller.PluginInstaller.LoadAssembly(System.String assemblyFilePath)
2022-12-03T14-08-15-0473 |   1 | ERROR |         Loupedeck.PluginInstaller.PluginInstaller.LoadAndInvokeMethod(System.String pluginFilePath, System.Func`3[System.Object,System.Object,System.Object] function)
2022-12-03T14-08-15-0473 |   1 | ERROR |         Loupedeck.PluginInstaller.PluginInstaller.LoadAndInvokePluginMethod(System.String pluginFilePath, System.String methodName, System.Object[] parameters)
2022-12-03T14-08-15-0473 |   1 | ERROR |         Loupedeck.PluginInstaller.PluginInstaller.InvokeInstallOrUninstall(System.String pluginFilePath, System.String methodName)
2022-12-03T14-08-15-0473 |   1 | ERROR |         Loupedeck.PluginInstaller.PluginPackageInstaller.CallInstallMethod()
2022-12-03T14-08-15-0483 |   1 | ERROR |         ----------
2022-12-03T14-08-15-0483 |   1 | ERROR |         Loupedeck.Tracer.Error(System.String message, System.Exception ex)
2022-12-03T14-08-15-0483 |   1 | ERROR |         Loupedeck.PluginInstaller.PluginPackageInstaller.CallInstallMethod()
2022-12-03T14-08-15-0493 |   1 | ERROR |         Loupedeck.LoupedeckServiceTool.LoupedeckServiceTool.InstallPlugin(System.String pluginPackageFilePath)
2022-12-03T14-08-15-0493 |   1 | ERROR |         Loupedeck.LoupedeckServiceTool.Application.Execute(System.String[] args)
2022-12-03T14-08-15-0493 |   1 | ERROR |         Loupedeck.LoupedeckServiceTool.Program.Main(System.String[] args)
2022-12-03T14-08-15-0503 |   1 | TRACE | Deleting directory 'C:\Users\USERNAME\AppData\Local\Loupedeck\Plugins\LoupeXIVDeck'
2022-12-03T14-08-15-0558 |   1 | TRACE | Directory deleted

I unpacked the plugin to manually install it, and it looks like the metadata needs to be altered slightly: pluginFileName: LoupeXIVDeck.dll should be pluginFileName: LoupeXIVDeckPlugin.dll — adding the missing "Plugin" to my local version of the metadata YAML file has correctly installed the plugin and it's now pinging for the XIVDeck plugin and hooking into the game as expected.

Unhandled Exceptions when an Invalid Hotbar Slot ID is Given

• Handle HTTP exceptions properly
• Show a warning in the Loupedeck UI

Improve Release Build

Do what @XeroxDev does: https://github.com/XeroxDev/Loupedeck-plugin-YTMDesktop/blob/main/YTMDesktopPlugin/YTMDesktopPlugin.csproj

Add a Dynamic Folder with All Emotes

It would be cool to have a pre-made page that has buttons for all usable emotes.

Docs for Dynamic Folders: https://github.com/Loupedeck/LoupedeckPluginSdk4/wiki/Implementing-Dynamic-Folders

Add Examples and Screenshots/Photos to README.MD

Show some examples in the Readme.