Releases: KazWolfe/XIVDeck
XIVDeck 0.1.13 - HOTFIX
This release contains a hotfix for a bug reported to me regarding XIVDeck's API server. There are no feature changes for this update.
Testing Notes
The usual "please find and report bugs to me" thing applies.
If you like this plugin, please consider starring the repository on GitHub. It's much appreciated, I promise! You can also help translate XIVDeck!
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 shorterror. 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.13.
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: v0.1.12...v0.1.13
CI Run: https://github.com/KazWolfe/XIVDeck/actions/runs/2304791394
XIVDeck 0.1.12
So, this is now a full release of XIVDeck. Welcome, everyone! The Stream Deck plugin download is below, everything should just work. If not, open an Issue and we'll get it sorted.
- The Stream Deck Plugin will now attempt to resolve action names (and cache them) when an action is locked/unavailable, or the game isn't running.
There are a few internal changes to the game plugin as well, but nothing that should realistically matter.
Testing Notes
This release is all about the Stream Deck Plugin. The "Execute Action" and "Switch Class" buttons should now handle more gracefully in edge cases. If the character you're playing on doesn't have an action unlocked (or you're not logged in), the dropdown should still show the correct action, but it should be unselectable. If the game is completely closed, the dropdown should show the action name (if cached) or Unknown (if not). To cache an action name, simply update the button.
Otherwise, usual "please find and report bugs to me" things apply. If you like this plugin, please consider starring the repository on GitHub. It's much appreciated, I promise!
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 shorterror. 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.12.
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: v0.1.11...v0.1.12
CI Run: https://github.com/KazWolfe/XIVDeck/actions/runs/2285152584
XIVDeck 0.1.11
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
/miconsupport 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 shorterror. 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: v0.1.10...v0.1.11
XIVDeck 0.1.10
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
/miconicons for your macro icons. That's not at all confusing.
"Stable release soon," he says.
Testing Notes
- If you really want
/miconicons 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 shorterror. 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: v0.1.9...v0.1.10
XIVDeck 0.1.9
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 shorterror. 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: v0.1.8...v0.1.9
XIVDeck 0.1.8
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 shorterror. 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: v0.1.7...v0.1.8
XIVDeck 0.1.7
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 shorterror. 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: v0.1.6...v0.1.7
XIVDeck 0.1.6
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 shorterror. 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: v0.1.5...v0.1.6
XIVDeck 0.1.5
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:tm:), 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: v0.1.4...v0.1.5
XIVDeck 0.1.4
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: v0.1.3...v0.1.4