XIVDeck

Sometimes, devs gotta do what devs gotta do. Mostly, clean up things and make my tools not hate me.

• A number of internal changes were made to make development and debugging easier for the future.
• Lay down some framework for additional Penumbra support.
• Move Penumbra support out of "experimental" as nobody's reported any bugs with it.
• Hopefully fix /micon's experimental support causing CTDs and other nasties (thanks Kizer!)
• Finally get rid of the useless .0 at the end of internal version numbers.

Testing Notes

• If you're feeling adventurous, try turning on /micon support again and watch for any crashes.
  • The UX is still weird around this, and there's no way to tell if something is truly a macro or not, but that won't go away for a long time.
  • If this feature is still broken, I'm just going to remove it for full release.
• Otherwise, just normal regression testing! Everything should work and decently well.
• Please pay special attention for game lag when doing things like updating hotbars, gearsets, or macro buttons.
  • If you want to load test the plugin, create a bunch of hotbar buttons and trigger updates. There should be no notable speed penalty.
• The XIVDeck Game Plugin Settings window should not have a Debug button. Things in there can do weird things, so please no touchy if it is there.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

Known Issues

The following known issues currently exist in this release:

• Certain TexTools mods will cause XIVDeck to be unable to load icons with a Destination is too short error. If this happens, please repair all game files and consider using Penumbra for mod loading instead. This problem is being resolved with the help of Lumina developers.

Installing the Plugin

Both the Stream Deck Plugin and the Game Plugin have been updated to version 0.1.11.

To install the Stream Deck Plugin, simply download the XIVDeck.streamDeckPlugin file and open it. The Elgato Stream Deck software will take care of the rest.

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.1.10...v0.1.11

I bet you were expecting 0.2.0. Sorry, version numbers aren't decimals.

• Fix a bug that caused XIVDeck to fail to initialize more often than not (except on my computer)
• Add experimental support for using /micon icons for your macro icons. That's not at all confusing.

"Stable release soon," he says.

Testing Notes

• If you really want /micon icons for your macro buttons, you can set these up here. Feel free to toggle the checkbox and see how they work (and how confused you get trying to tell macros apart from other things).
• Please continue trying to break everything. I want to make sure this thing is perfect before releasing it to mainline.
  • If you know how to use /xllog, this plugin should not throw any errors anymore. It may throw warnings in some cases, but not errors.

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue. If you're getting a bug you can't seem to consistently reproduce, please ping me on the Dalamud Support Discord.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

Known Issues

The following known issues currently exist in this release:

• Certain TexTools mods will cause XIVDeck to be unable to load icons with a Destination is too short error. If this happens, please repair all game files and consider using Penumbra for mod loading instead. This problem is being resolved with the help of Lumina developers.

Installing the Plugin

Both the Stream Deck Plugin and the Game Plugin have been updated to version 0.1.10.

To install the Stream Deck Plugin, simply download the XIVDeck.streamDeckPlugin file and open it. The Elgato Stream Deck software will take care of the rest.

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.1.9...v0.1.10

Swish-swish-aroo! We have another minor update for you!

• [Stream Deck Plugin] XIVDeck will now create new buttons with a default font size of 12 instead of 16.
• [Game Plugin] Missing plugins will no longer throw an exception when initializing their IPC.
• [Game Plugin] Remove dependency on XivCommon, clearing a warning from plugin initialization logs.
• [Game Plugin] Hopefully mitigate the Lumina concurrent load bug.
• [Game Plugin] Mitigate a rare bug with registering chat links.

Testing Notes

• Please continue trying to break everything. I want to make sure this thing is perfect before releasing it to mainline.
  • If you know how to use /xllog, this plugin should not throw any errors anymore. It may throw warnings in some cases, but not errors.

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue. If you're getting a bug you can't seem to consistently reproduce, please ping me on the Dalamud Support Discord.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

Known Issues

The following known issues currently exist in this release:

• Certain TexTools mods will cause XIVDeck to be unable to load icons with a Destination is too short error. If this happens, please repair all game files and consider using Penumbra for mod loading instead. This problem is being resolved with the help of Lumina developers.

Installing the Plugin

Both the Stream Deck Plugin and the Game Plugin have been updated to version 0.1.9.

To install the Stream Deck Plugin, simply download the XIVDeck.streamDeckPlugin file and open it. The Elgato Stream Deck software will take care of the rest.

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.1.8...v0.1.9

Hotfix, seven hours later.

• Fix a bug where XIVDeck would totally refuse to load if Penumbra wasn't installed.
• Add a Tippy IPC for the lulz.

Testing Notes

• Please continue trying to break everything. I want to make sure this thing is perfect before releasing it to mainline.
  • If you know how to use /xllog, this plugin should not throw any errors anymore. It may throw warnings in some cases, but not errors.
• For Penumbra users (especially those using Material UI), go play with the toggle. Material UI icons should start loading after clicking Apply in Settings.
  • Note that this may break a lot, so the toggle is there. If you have issues, reach out to me through the normal channels.
  • For non-Penumbra users, you should be able to enable that checkbox with no ill affects at all.

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue. If you're getting a bug you can't seem to consistently reproduce, please ping me on the Dalamud Support Discord.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

Known Issues

The following known issues currently exist in this release:

• A warning from XIVCommon is printed to the Plugin Log due to a missing/broken signature. This message is purely cosmetic and has no impact on functionality. It will be fixed when a new version of XIVCommon is released.
• Due to XIVDeck's webserver and use of threading for the Stream Deck API, certain events through the "Execute Action" button will break. A game restart normally fixes this problem, but a more permanent solution is being worked on with Lumina developers.
• Certain TexTools mods will cause XIVDeck to be unable to load icons with a Destination is too short error. If this happens, please repair all game files and consider using Penumbra for mod loading instead. This problem is being resolved with the help of Lumina developers.

Installing the Plugin

Both the Stream Deck Plugin and the Game Plugin have been updated to version 0.1.8.

To install the Stream Deck Plugin, simply download the XIVDeck.streamDeckPlugin folder and open it. The Elgato Stream Deck software will take care of the rest.

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.1.7...v0.1.8

I heard you like Penumbra, so I put some Penumbra into your XIVDeck.

• Add experimental support for loading in Penumbra icons to the Stream Deck (if available). To enable this feature, you will need to manually toggle a checkbox in the XIVDeck Settings window in-game (go to the Plugin Installer and click the gear on XIVDeck's entry).
• Fix a bug with login messages not clearing themselves after being sent.
• Make the debug text in the Stream Deck Plugin a bit more readable.
• Some small cleanup tasks that needed to be done.

Testing Notes

• Please continue trying to break everything. I want to make sure this thing is perfect before releasing it to mainline.
  • If you know how to use /xllog, this plugin should not throw any errors anymore. It may throw warnings in some cases, but not errors.
• For Penumbra users (especially those using Material UI), go play with the toggle. Material UI icons should start loading after clicking Apply in Settings.
  • Note that this may break a lot, so the toggle is there. If you have issues, reach out to me through the normal channels.
  • For non-Penumbra users, you should be able to enable that checkbox with no ill affects at all.

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue. If you're getting a bug you can't seem to consistently reproduce, please ping me on the Dalamud Support Discord.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

Known Issues

The following known issues currently exist in this release:

• A warning from XIVCommon is printed to the Plugin Log due to a missing/broken signature. This message is purely cosmetic and has no impact on functionality. It will be fixed when a new version of XIVCommon is released.
• Due to XIVDeck's webserver and use of threading for the Stream Deck API, certain events through the "Execute Action" button will break. A game restart normally fixes this problem, but a more permanent solution is being worked on with Lumina developers.
• Certain TexTools mods will cause XIVDeck to be unable to load icons with a Destination is too short error. If this happens, please repair all game files and consider using Penumbra for mod loading instead. This problem is being resolved with the help of Lumina developers.

Installing the Plugin

Both the Stream Deck Plugin and the Game Plugin have been updated to version 0.1.7.

To install the Stream Deck Plugin, simply download the XIVDeck.streamDeckPlugin folder and open it. The Elgato Stream Deck software will take care of the rest.

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.1.6...v0.1.7

When you want to have fewer errors in your plugin, just hide them!

• Add "debouncing" to certain error messages so that they won't spam chat logs.
• Tweak how delayed messages work, so that hopefully plugin updates don't do weird things with update nags.

Testing Notes

• Please continue trying to break everything. I want to make sure this thing is perfect before releasing it to mainline.
  • If you know how to use /xllog, this plugin should not throw any errors anymore. It may throw warnings in some cases, but not errors.

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue. If you're getting a bug you can't seem to consistently reproduce, please ping me on the Dalamud Support Discord.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

Known Issues

The following known issues currently exist in this release:

• A warning from XIVCommon is printed to the Plugin Log due to a missing/broken signature. This message is purely cosmetic and has no impact on functionality. It will be fixed when a new version of XIVCommon is released.
• Due to XIVDeck's webserver and use of threading for the Stream Deck API, certain events through the "Execute Action" button will break. A game restart normally fixes this problem, but a more permanent solution is being worked on with Lumina developers.
• Certain TexTools mods will cause XIVDeck to be unable to load icons with a Destination is too short error. If this happens, please repair all game files and consider using Penumbra for mod loading instead. This problem is being resolved with the help of Lumina developers.

Installing the Plugin

Both the Stream Deck Plugin and the Game Plugin have been updated to version 0.1.6. No material changes have been made to the Stream Deck Plugin, but it will nag you to update anyways.

To install the Stream Deck Plugin, simply download the XIVDeck.streamDeckPlugin folder and open it. The Elgato Stream Deck software will take care of the rest.

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.1.5...v0.1.6

I said this plugin would go mainline soon. I hope I live to see the day.

• Possibly fix a problem reported in Issue #10 by changing plugin initialization logic.

I know I've said a few times now that we're very close to a main release. Assuming nobody reports any further bugs (and XIVCommon updates in the Nearish Future™️), I'll just promote this version this weekend.

Testing Notes

• Please continue trying to break everything. I want to make sure this thing is perfect before releasing it to mainline.
  • If you know how to use /xllog, this plugin should not throw any errors anymore. It may throw warnings in some cases, but not errors.

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue. If you're getting a bug you can't seem to consistently reproduce, please ping me on the Dalamud Support Discord.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

Known Issues

Currently, a warning from an underlying library (XIVCommon) is printed to the Plugin Log due to a missing/broken signature. This will be resolved once the library is fixed. This does not seem to have any impact on plugin features.

Installing the Plugin

Both the Stream Deck Plugin and the Game Plugin have been updated to version 0.1.5. No material changes have been made to the Stream Deck Plugin, but it will nag you to update anyways.

To install the Stream Deck Plugin, simply download the XIVDeck.streamDeckPlugin folder and open it. The Elgato Stream Deck software will take care of the rest.

For the Dalamud plugin, please use the Dalamud Testing Repository. I can no longer support manual plugin installs; sorry! If you've done a manual install before, please remove it to prevent any problems from forming.

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.1.4...v0.1.5

Thanks for breaking everything, Square. You are keeping me “employed”!

• A bunch of tiny internal changes to reflect modifications to ClientStructs
• Tweaks to Stream Deck Plugin error handling to throw errors faster if something is wrong.
• Bump everything to support Patch 6.1

Assuming this version doesn’t have any more bugs, we’re very close to a main release. I’m waiting for a library bug to dismiss a warning, and then we’ll be ready to go.

Testing Notes

This is mostly a version bump, so everything is more or less the same. However, that doesn’t mean there aren’t things to test!

• This is the first version after fixing the update system, so hopefully users will be notified about updates properly. You should get a link to install Version 0.1.4 upon first launch after this plugin is updated, and nothing after that.
• Keep an eye out for corruption of Action names. We've had a few reports of this so far, all related to third-party plugins. If you notice this, please ping me on the Dalamud Support Discord and bring a list of all installed plugins with you.

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue. If you're getting a bug you can't seem to consistently reproduce, please ping me on the Dalamud Support Discord.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

Known Issues

Currently, a warning from an underlying library (XIVCommon) is printed to the Plugin Log due to a missing/broken signature. This will be resolved once the library is fixed. There does not appear to be any performance impact for this update.

Installing the Plugin

Both the Stream Deck Plugin and the Game Plugin have been updated to version 0.1.4. An update to the Stream Deck Plugin is not required, but is recommended.

To install the Stream Deck Plugin, simply download the XIVDeck.streamDeckPlugin folder and open it. The Elgato Stream Deck software will take care of the rest.

For the Dalamud plugin, please use the Dalamud Testing Repository. I can no longer support manual plugin installs; sorry! If you've done a manual install before, please remove it to prevent any problems from forming.

Note: This build did not pass CI for the FFXIV Plugin as (at the time of writing) Dalamud has not been released for FFXIV v6.1. The version being pushed to the testing repo will be a local build, however the Stream Deck Plugin will still be built and available below.

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.1.3...v0.1.4

Phenomenal game control power, itty bitty bug fix.

• Fix the nag message displaying when things are actually up to date.
• Add some extra debug helper things to pad my commit message

Testing Notes

Same testing notes as last time:

• Keep an eye out for corruption of Action names. We've had a few reports of this so far, all related to third-party plugins. If you notice this, please ping me on the Dalamud Support Discord and bring a list of all installed plugins with you.
• The update prompt should pop up for virtually everyone updating this plugin at least once. Please make sure it does, and that the link actually works. The update prompt should not come up when opening the Property Inspector, but may open if you switch profiles on your Stream Deck.
• I've received another CTD on class switching. If you get one, please poke me so that I can grab some more diagnostic info.

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue. If you're getting a bug you can't seem to consistently reproduce, please ping me on the Dalamud Support Discord.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

Installing the Plugin

Both the Stream Deck Plugin and the Game Plugin have been updated to version 0.1.3. An update to the Stream Deck Plugin is not required, but is recommended.

To install the Stream Deck Plugin, simply download the XIVDeck.streamDeckPlugin folder and open it. The Elgato Stream Deck software will take care of the rest.

For the Dalamud plugin, please use the Dalamud Testing Repository. I can no longer support manual plugin installs; sorry! If you've done a manual install before, please remove it to prevent any problems from forming.

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.1.2...v0.1.3

It's polish time! Couple new features here, but a lot more internal changes than anything.

• Add support for Collections (Aether Compass, Field Record, Portable Archive) to the Execute Action button.
• Add a version update chat message when the Stream Deck Plugin version does not match the Game Plugin's version.
• Fix a bug with the Execute Action property inspector.
• Fix a bug that caused excessive HTTP calls to be made on initialization.
• Internal changes to use the autowire pattern more and more (it's "cleaner").

I'm hoping to target an official full release after 6.1 drops, so please keep those reports coming!!

Testing Notes

As usual, just standard regression checks and "make sure everything works". I'd like to specifically request the following things be tested, though:

• Keep an eye out for corruption of Action names. We've had a few reports of this so far, all related to third-party plugins. If you notice this, please ping me on the Dalamud Support Discord and bring a list of all installed plugins with you.
• The update prompt should pop up for virtually everyone updating this plugin at least once. Please make sure it does, and that the link actually works. The update prompt should not come up when opening the Property Inspector, but may open if you switch profiles on your Stream Deck.

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue. If you're getting a bug you can't seem to consistently reproduce, please ping me on the Dalamud Support Discord.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

Installing the Plugin

Both the Stream Deck Plugin and the Game Plugin have been updated to version 0.1.2. An update to the Stream Deck Plugin is not required, but is recommended.

To install the Stream Deck Plugin, simply download the XIVDeck.streamDeckPlugin folder and open it. The Elgato Stream Deck software will take care of the rest.

For the Dalamud plugin, please use the Dalamud Testing Repository. I can no longer support manual plugin installs; sorry! If you've done a manual install before, please remove it to prevent any problems from forming.

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.1.1...v0.1.2

Let's just pretend like v0.1.0 never happened. Cool? Cool.

• Fix a bug in the Property Inspector's Class frame that prevented it from loading on new buttons.
• Update the Macro update signature to something a bit more useful and stable (maybe).
• Add back the /xivdeck route so pre-0.1.0 users will get a nice in-game error popup.

You will need to install the new version of the Stream Deck Plugin.

Testing Notes

Today's test request: regression checks!

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue. If you're getting a bug you can't seem to consistently reproduce, please ping me on the Dalamud Support Discord.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP. I think I've fixed them all, but one or two may have squeaked through. I'm also particularly curious about performance-related issues, as I'm sure there are a few.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

New Known Issues

• ???

Installing the Plugin

Both the Stream Deck Plugin and the Game Plugin have been updated to version 0.1.1. You will need to update the Stream Deck Plugin.

To install the Stream Deck Plugin, simply download the XIVDeck.streamDeckPlugin folder and open it. The Elgato Stream Deck software will take care of the rest.

For the Dalamud plugin, you can either enable the testing repository to grab XIVDeck or you can manually install the plugin by following these steps:

1. Download the XIVDeck.FFXIVPlugin.zip file to your computer.
2. Delete the folder %APPDATA%\XIVLauncher\devPlugins\XIVDeckPlugin\ if it exists.
3. Extract the contents of that ZIP file to %APPDATA%\XIVLauncher\devPlugins\XIVDeck.FFXIVPlugin\

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.1.0...v0.1.1

⚠️ Note, time travelers! This version has been fully superseded by version 0.1.1. This version should be considered broken (even for archival purposes) and should not be used.

Typescript: check. New API: check. Hotel: Trivago. It's time for the first major bump of v0!

• Completely rewrite the Stream Deck Plugin. It now uses TypeScript, is much cleaner, and should overall just behave way better.
• Switch from a WebSocket-driven API to an HTTP API. This makes certain things much easier, and simplifies a lot of code.
• Update the UI system to be more modern, including adding nag messages for certain things.
• Various small performance improvements, and a lot of code cleanup.

You will need to manually install the new version of the Stream Deck Plugin. Old versions (prior to this release) will no longer be able to even connect due to breaking API changes.

Testing Notes

Today's test request: regression checks!

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue. If you're getting a bug you can't seem to consistently reproduce, please ping me on the Dalamud Support Discord.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP. I think I've fixed them all, but one or two may have squeaked through. I'm also particularly curious about performance-related issues, as I'm sure there are a few.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

New Known Issues

• ???

Installing the Plugin

Both the Stream Deck Plugin and the Game Plugin have been updated to version 0.1.0. You will need to update the Stream Deck Plugin.

To install the Stream Deck Plugin, simply download the XIVDeck.streamDeckPlugin folder and open it. The Elgato Stream Deck software will take care of the rest.

For the Dalamud plugin, you can either enable the testing repository to grab XIVDeck or you can manually install the plugin by following these steps:

1. Download the XIVDeck.FFXIVPlugin.zip file to your computer.
2. Delete the folder %APPDATA%\XIVLauncher\devPlugins\XIVDeckPlugin\ if it exists.
3. Extract the contents of that ZIP file to %APPDATA%\XIVLauncher\devPlugins\XIVDeck.FFXIVPlugin\

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.0.5...v0.1.0

Time for ✨ new features ✨!

• Add support for Extra Commands, Fashion Accessories, and Performance Instruments.
  • GPOSE BUTTON GPOSE BUTTON GPOSE BUTTON
• Better sorting of classes in the Change Class button.
  • The order is now Tank > Healer > DPS, as it should be.
• The Execute Action button now supports categories for annoying lists, like Main Commands.
• The Execute Action button will now hide categories that have no unlocked sub-actions (or can't be used).
• Some internal changes to make things prettier.

Testing Notes

This patch comes with some specific testing notes:

• Please continue testing compatibility with other plugins. No reports have come up yet, but I'm not totally confident in everything just yet.
• If you have Performance unlocked, please make sure it shows up in the Actions button. If not, please make sure it doesn't.

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue. If you're getting a bug you can't seem to consistently reproduce, please ping me on the Dalamud Support Discord.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP. I think I've fixed them all, but one or two may have squeaked through. I'm also particularly curious about performance-related issues, as I'm sure there are a few.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

New Known Issues

• Main command categorization only loads on editing an existing button. I will fix this in the TypeScript rewrite.

Installing the Plugin

Both the Stream Deck Plugin and the Game Plugin have been updated to version 0.0.5. Prior versions of the Stream Deck Plugin will still work, but it is recommended you upgrade both.

To install the Stream Deck Plugin, simply download the XIVDeck.streamDeckPlugin folder and open it. The Elgato Stream Deck software will take care of the rest.

For the Dalamud plugin, you can either enable the testing repository to grab XIVDeck or you can manually install the plugin by following these steps:

1. Download the XIVDeck.FFXIVPlugin.zip file to your computer.
2. Delete the folder %APPDATA%\XIVLauncher\devPlugins\XIVDeckPlugin\ if it exists.
3. Extract the contents of that ZIP file to %APPDATA%\XIVLauncher\devPlugins\XIVDeck.FFXIVPlugin\

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.0.4...v0.0.5

You get a fix! You get a fix! Everyone gets a fix! Version 0.0.4 is out with some fixes to a couple of potentially nasty problems. Hopefully. We'll see.

• [Game Plugin] Icons will now properly load for hidden hotbar slots.
  • Note that this change may have some unintended side effects, especially with other plugins that work with hotbars.
• [Game Plugin] (Hopefully) Fix a CTD when triggering macros with high IDs.
• [Stream Deck Plugin] Fix a display issue where Shared Mode was being improperly selected on the Macro configuration screen.

Testing Notes

This patch comes with some specific testing notes:

• Please test this plugin with other plugins, especially ones that alter the hotbar (like XIVCombo). If you have any issues or hotbar oddities, please report them to me. This plugin is now updating game memory which I don't exactly like, but should be safe.
• The Macro feature requires some more intensive testing, especially in the following cases:
  • Trigger macros immediately after game load
  • Trigger macros with a high ID (especially 90-100)
  • Trigger shared macros
  • Any combination of the above

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP. I think I've fixed them all, but one or two may have squeaked through. I'm also particularly curious about performance-related issues, as I'm sure there are a few.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

Known Issues

The following known issues currently exist in this release of XIVDeck:

• Game icons will sometimes be "sticky" and the wrong icon can show up when moving icons around in the Stream Deck app.
• Users can set a max hotbar slot number higher than appropriate.
  • The game will refuse to execute this hotbar slot, but validation on the Stream Deck side is broken.
• The port field on the Stream Deck app does not work.
  • Please ensure you keep your game port set to 37984 for now.
• The class load order in the Stream Deck app is wrong.
• Certain actions (particularly FieldMarker) are using their technical names instead of "human-friendly" ones.
• Placeholder Stream Deck icons are low-resolution

Installing the Plugin

Both the Stream Deck Plugin and the Game Plugin have been updated to version 0.0.4. Prior versions of the Stream Deck Plugin will still work, but it is recommended you upgrade both.

To install the Stream Deck Plugin, simply download the XIVDeck.streamDeckPlugin folder and open it. The Elgato Stream Deck software will take care of the rest.

For the Dalamud plugin, you can either enable the testing repository to grab XIVDeck or you can manually install the plugin by following these steps:

1. Download the XIVDeck.FFXIVPlugin.zip file to your computer.
2. Delete the folder %APPDATA%\XIVLauncher\devPlugins\XIVDeckPlugin\ if it exists.
3. Extract the contents of that ZIP file to %APPDATA%\XIVLauncher\devPlugins\XIVDeck.FFXIVPlugin\

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.0.3...v0.0.4

Another maintenance/bugfix release for you, this time hopefully fixing the vast majority of known in-game bugs. Some UI components may be a bit rough, but everything within the game itself should fundamentally work. Notably, this patch fixes the following issues:

• [Game Plugin] Under certain conditions (specifically PVP and XIVCombo), the game plugin would not detect a hotbar update.
• [Game Plugin] Icons would not load properly when switching to/from PVP mode.
• [Stream Deck Plugin] The icon cache for class icons was not properly respected and would be overwritten.

There's a new strategy for detecting hotbar changes in this patch, which should make things a bit better as well in terms of performance.

I am still forcing myself to learn TypeScript to rewrite the Stream Deck side of this plugin.

Testing Notes

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP. I think I've fixed them all, but one or two may have squeaked through. I'm also particularly curious about performance-related issues, as I'm sure there are a few.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

Known Issues

The following known issues currently exist in this release of XIVDeck:

• Game icons will sometimes be "sticky" and the wrong icon can show up when moving icons around in the Stream Deck app.
• Users can set a max hotbar slot number higher than appropriate.
  • The game will refuse to execute this hotbar slot, but validation on the Stream Deck side is broken.
• The port field on the Stream Deck app does not work.
  • Please ensure you keep your game port set to 37984 for now.
• The class load order in the Stream Deck app is wrong.
• Certain actions (particularly FieldMarker) are using their technical names instead of "human-friendly" ones.
• Placeholder Stream Deck icons are low-resolution

Installing the Plugin

Both the Stream Deck Plugin and the Game Plugin have been updated to version 0.0.3. Prior versions of the Stream Deck Plugin will still work, but it is recommended you upgrade both.

To install the Stream Deck Plugin, simply download the XIVDeck.streamDeckPlugin folder and open it. The Elgato Stream Deck software will take care of the rest.

For the Dalamud plugin, you can either enable the testing repository to grab XIVDeck or you can manually install the plugin by following these steps:

1. Download the XIVDeck.FFXIVPlugin.zip file to your computer.
2. Delete the folder %APPDATA%\XIVLauncher\devPlugins\XIVDeckPlugin\ if it exists.
3. Extract the contents of that ZIP file to %APPDATA%\XIVLauncher\devPlugins\XIVDeck.FFXIVPlugin\

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.0.2...v0.0.3

This is a minor maintenance change to clean up a few things and perform a much-needed refactor. Apparently, having four internal names for a single plugin is a bad idea and leads to a lot of confusion. Who would have thought?!

Testing Notes

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP. I think I've fixed them all, but one or two may have squeaked through. I'm also particularly curious about performance-related issues, as I'm sure there are a few.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

Known Issues

All Known Issues from version 0.0.1 are still in effect, except for "Certain emotes/mounts/minions may not work after starting the game."

Installing the Plugin

No changes have been made to the Stream Deck plugin, so users still on 0.0.1 should have no issues using that version. If you don't have the Stream Deck plugin, simply download XIVDeck.streamDeckPlugin from this release and double-click it. The Elgato Stream Deck software will take care of the rest.

For the Dalamud plugin, you can either enable the testing repository to grab XIVDeck or you can manually install the plugin by following these steps:

1. Download the XIVDeck.FFXIVPlugin.zip file to your computer.
2. Delete the folder %APPDATA%\XIVLauncher\devPlugins\XIVDeckPlugin\ if it exists.
3. Extract the contents of that ZIP file to %APPDATA%\XIVLauncher\devPlugins\XIVDeck.FFXIVPlugin\

Full Changelog: https://github.com/KazWolfe/XIVDeck/compare/v0.0.1...v0.0.2

It's finally time! XIVDeck 0.0.1 appears to be ready for people to see and to cause very frustrating game crashes. Anyways, let's get started. If you don't know what this plugin is or what it does, I'd highly suggest checking out the README for this project.

⚠️ WARNING

This plugin is still pre-release and is going to have a lot of bugs, some of which are going to be very problematic. Please read through the Testing Notes and Known Issues section very carefully, as they contain very important information that may prevent your account from getting flagged and possibly banned. This plugin will theoretically allow you to call actions and do things the game is not supposed to normally do. I have made a number of efforts to protect against this happening accidentally, but there will be bugs.

I am not responsible if your account gets banned as a result of using this plugin because the plugin sent invalid data.

Testing Notes

If you notice any problems with XIVDeck, please feel free to reach out to me on Discord. I'm available on the Dalamud Support Discord and will generally have my DMs open for any problem reports. Alternatively, feel free to open a GitHub Issue.

If you experience any crash to desktop while this plugin is installed, please reach out to me ASAP. I think I've fixed them all, but one or two may have squeaked through. I'm also particularly curious about performance-related issues, as I'm sure there are a few.

This is a pre-release build and configurations may change at any time. It may be necessary during the course of this plugin to fully uninstall and reinstall components of the plugin. If this is the case, I will make a note in future release documents.

Known Issues

The following things are already known and I will get around to fixing them Eventually™️.

• When switching to/from PVP mode, hotbar icons may go blank and not populate correctly.
  • Workaround: Do anything that would update a hotbar and changes will synchronize.
• Under certain conditions, not all icons will load properly.
  • Workaround: Switch to a different folder or Stream Deck profile and back while the game is running.
• Certain emotes/mounts/minions may not work after starting the game.
  • This has been fixed as of commit 53782b3 and will be included in the next version.
  • Workaround: Disable and re-enable the XIVDeck FFXIV Plugin to restore functionality to these keys.
• Game icons will sometimes be "sticky" and the wrong icon can show up when moving icons around in the Stream Deck app.
• Users can set a max hotbar slot number higher than appropriate.
  • The game will refuse to execute this hotbar slot, but validation on the Stream Deck side is broken.
• The port field on the Stream Deck app does not work. Please ensure you keep your game port set to 37984 for now.
• The class load order in the Stream Deck app is wrong.
• Certain actions (particularly FieldMarker) are using their technical names instead of "human-friendly" ones.
• Certain Stream Deck icons are really low res and sad.
• The JavaScript code is, like, really bad. I promise I'll rewrite this in TypeScript soon.

Installing the Plugin

For the Stream Deck plugin, just download and double-click the .streamDeckPlugin file attached to this release.

For the Dalamud plugin, you can manually install the plugin by extracting the XIVDesk-FFXIVPlugin.zip file to your %APPDATA%\XIVLauncher\devPlugins\ folder.