{"id":17346344,"url":"https://github.com/kazwolfe/xivdeck","last_synced_at":"2026-01-02T19:26:05.277Z","repository":{"id":37241621,"uuid":"459837176","full_name":"KazWolfe/XIVDeck","owner":"KazWolfe","description":"A Stream Deck plugin providing rich integration for Final Fantasy XIV!","archived":false,"fork":false,"pushed_at":"2025-03-25T20:33:06.000Z","size":1848,"stargazers_count":122,"open_issues_count":11,"forks_count":3,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-29T20:08:11.475Z","etag":null,"topics":["dalamud-plugin","ffxiv","streamdeck"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KazWolfe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":".github/support.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-16T03:23:04.000Z","updated_at":"2025-03-29T01:22:09.000Z","dependencies_parsed_at":"2023-11-22T21:24:08.266Z","dependency_job_id":"9e522491-5a32-4478-9563-543a41697804","html_url":"https://github.com/KazWolfe/XIVDeck","commit_stats":{"total_commits":323,"total_committers":3,"mean_commits":"107.66666666666667","dds":"0.015479876160990669","last_synced_commit":"85a6d91d0f1125b5953534e697dc038583c7e38e"},"previous_names":[],"tags_count":59,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KazWolfe%2FXIVDeck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KazWolfe%2FXIVDeck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KazWolfe%2FXIVDeck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KazWolfe%2FXIVDeck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KazWolfe","download_url":"https://codeload.github.com/KazWolfe/XIVDeck/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247399884,"owners_count":20932880,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dalamud-plugin","ffxiv","streamdeck"],"created_at":"2024-10-15T16:45:12.204Z","updated_at":"2026-01-02T19:26:05.219Z","avatar_url":"https://github.com/KazWolfe.png","language":"C#","readme":"![XIVDeck Icon](SDPlugin/assets/images/icon@2x.png)\n\n# XIVDeck\n\n[![Download count](https://img.shields.io/endpoint?url=https://vz32sgcoal.execute-api.us-east-1.amazonaws.com/XIVDeck.FFXIVPlugin)](https://github.com/KazWolfe/XIVDeck)\n[![Crowdin](https://badges.crowdin.net/xivdeck/localized.svg)](https://crowdin.com/project/xivdeck)\n[![Latest Release](https://img.shields.io/github/v/release/KazWolfe/XIVDeck)](https://github.com/KazWolfe/XIVDeck/releases/latest)\n[![Testing Release](https://img.shields.io/github/v/release/KazWolfe/XIVDeck?color=orange\u0026include_prereleases\u0026label=testing)](https://github.com/KazWolfe/XIVDeck/releases)\n\n\nXIVDeck is a project that attempts to bridge the gap between [Final Fantasy XIV][ffxiv] \nand the [Elgato Stream Deck][streamdeck]. XIVDeck uses the Dalamud plugin library to \ncreate an interactive and pleasant human interface experience.\n\n\u003e ⚠️ **Hic Svnt Leones!**\n\u003e \n\u003e This plugin, alongside all of Dalamud, is against the Terms of Service for Final Fantasy XIV.\n\u003e While this plugin has gone to great lengths to ensure that it is as safe as possible and adheres\n\u003e to the spirit of the game, there is still a small risk. Please ensure you're only using official\n\u003e builds and releases of all relevant tools.\n\u003e \n\u003e By using this plugin (and Dalamud itself), you understand that you are risking receiving a\n\u003e ban for client modifications. For more information, please see [Dalamud's FAQ][dalamudfaq-tos].\n\n## Plugin Components\n\nThis plugin has two primary components:\n\n* The [XIVDeck Game Plugin](FFXIVPlugin), which is a Dalamud plugin responsible for interacting\nwith Final Fantasy XIV and hosting a local webserver that allows other systems to communicate \nwith the game.\n* The [XIVDeck Stream Deck Plugin](SDPlugin), which is a JavaScript plugin written using the \nElgato Stream Deck SDK. It exposes a number of actions that will allow the game to deeply \ninteract with the Stream Deck.\n\nFor those using hardware other than the Elgato Stream Deck on Windows, community-made plugins are \navailable:\n\n* [Loupedeck/Razer Stream Controller Plugin](https://github.com/bendobos/LoupeXIVDeck) by bendobos\n* [StreamController Plugin](https://github.com/SilentSwordmaiden/StreamController-XIVDeck-Plugin)\n  for Linux users by SilentSwordmaiden\n\nPlease note that the above plugins are _not_ endorsed and may be missing features or otherwise\nhave problems. Please contact the relevant maintainer if there are issues using non-Stream Deck\nplugins. If you are a maintainer of a plugin using my API, please reach out via Discord!\n\n## Using the Plugin\n\nThe XIVDeck Game Plugin has very few configuration parameters; only really requiring a port\nbe chosen if (for whatever reason) TCP port 37984 is already used on your host.\n\nThe XIVDeck Stream Deck Plugin is a little bit more involved and does expose some extra options\nfor discerning players. Currently, the following command types can be placed on a Stream\nDeck button:\n\n* **Text Command**: This action allows you to send a slash command directly to the game upon \npressing a button on your Stream Deck.\n* **Execute Hotbar Slot**: This action allows you to trigger a specific hotbar slot at any\ntime, regardless of whether the hotbar is visible or not. The current icon present in that\nhotbar slot will display on the Stream Deck.\n* **Execute Action**: This (not at all confusingly named) action allows you to trigger a subset \nof actions that can normally be placed on a hotbar. Currently-supported actions are Collections,\nEmotes, Extra Commands, Gearsets, General Actions, Performance Instruments, Macros, Main Commands,\nMarkers, Minions, Mounts, Fashion Accessories, and Waymarks.\n* **Run In-Game Macro**: This action allows you to trigger any macro by ID number (zero-indexed) on\neither the Individual or Shared tab of the Macro interface. *This feature does not allow you to\ncreate external macros.*\n* **Switch Class**: This action allows you to switch to a specific class directly. It will automatically\ntrigger the first gearset for each class that it finds in your active Gearset list.\n* **Change Volume**: This action allows you to quickly mute or unmute independent audio channels in\ngame at any time. Stream Deck + users can additionally use Dials to adjust volume more precisely.\n\nMore action types may come later, depending on user demand, what can actually go on a hotbar, and what\nDalamud ultimately supports or makes accessible. For actions that either cannot be put on a hotbar \nor are not supported, the **Text Command** action will allow calling a command directly.\n\n### Installing the Plugin\n\nThe XIVDeck plugins are available for download from [this repository's Releases page][releases].\n\nTo install the Stream Deck plugin, simply open the `XIVDeck.streamDeckPlugin` file. The Elgato \nStream Deck software will take care of all installation steps.\n\nTo install the FFXIV plugin, simply add it through the Dalamud Plugin Installer. To opt in to\ntesting versions (when available), right-click XIVDeck's entry in the Plugin Installer and select\n`Receive plugin testing versions`. \n\n### Getting Help\n\nTechnical support for release and testing versions of XIVDeck is available in the\n[XIVLauncher \u0026 Dalamud Discord][goatplace]'s [XIVDeck help thread][support-thread]. \n\nPlease report bugs and submit feature requests through GitHub Issues when possible. I also will\naccept bugs and feature requests on Discord, but may ask you to open an Issue anyways. \n\nI cannot offer support for self-built versions of XIVDeck, nor versions installed from unofficial\nrepositories. Please ensure that you are using the official release(s) of all relevant tools.\n\n### Building the Plugin\n\nIf for some reason you'd rather be on the bleeding edge, you may also manually build the plugins.\n\nThe XIVDeck Game Plugin is more or less self-contained and only needs to go through your IDE's\nnormal build processes. Build the plugin normally and add the output folder as a dev plugin \npath in Dalamud's settings.\n\nThe XIVDeck Stream Deck Plugin can be built by running `yarn build`. Symlink or copy the \nresulting`dist/dev.wolf.xivdeck.sdPlugin` folder to \n`%APPDATA%\\Elgato\\StreamDeck\\Plugins\\dev.wolf.xivdeck.sdPlugin`. Note that after creating this \nlink, you need to *fully restart* the Stream Deck software for the plugin to be detected.\n\n[ffxiv]: https://www.finalfantasyxiv.com\n[streamdeck]: https://www.elgato.com/en/stream-deck\n[releases]: https://github.com/KazWolfe/XIVDeck/releases\n[dalamudfaq-test]: https://goatcorp.github.io/faq/dalamud_troubleshooting.html#q-how-do-i-enable-plugin-test-builds\n[dalamudfaq-tos]: https://goatcorp.github.io/faq/xl_troubleshooting#q-are-xivlauncher-dalamud-and-dalamud-plugins-safe-to-use\n[goatplace]: https://discord.gg/holdshift\n[support-thread]: https://discord.com/channels/581875019861328007/1019648519226806323\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkazwolfe%2Fxivdeck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkazwolfe%2Fxivdeck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkazwolfe%2Fxivdeck/lists"}