{"id":22877391,"url":"https://github.com/geekyeggo/sharpdeck","last_synced_at":"2025-06-23T18:38:30.959Z","repository":{"id":119170223,"uuid":"166083994","full_name":"GeekyEggo/SharpDeck","owner":"GeekyEggo","description":"A .NET wrapper for the official Elgato Stream Deck SDK.","archived":false,"fork":false,"pushed_at":"2024-05-02T16:20:50.000Z","size":5196,"stargazers_count":27,"open_issues_count":10,"forks_count":9,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-10T14:16:45.555Z","etag":null,"topics":["dotnetstandard","elgato","streamdeck","streamdeck-sdk"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GeekyEggo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["GeekyEggo"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2019-01-16T17:43:36.000Z","updated_at":"2025-06-02T09:12:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"d3132573-5294-4e6d-8389-a2c34c0ba77f","html_url":"https://github.com/GeekyEggo/SharpDeck","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/GeekyEggo/SharpDeck","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeekyEggo%2FSharpDeck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeekyEggo%2FSharpDeck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeekyEggo%2FSharpDeck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeekyEggo%2FSharpDeck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GeekyEggo","download_url":"https://codeload.github.com/GeekyEggo/SharpDeck/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeekyEggo%2FSharpDeck/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261534946,"owners_count":23173498,"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":["dotnetstandard","elgato","streamdeck","streamdeck-sdk"],"created_at":"2024-12-13T15:37:13.357Z","updated_at":"2025-06-23T18:38:30.935Z","avatar_url":"https://github.com/GeekyEggo.png","language":"C#","readme":"[![SharpDeck verion on NuGet.org](https://img.shields.io/nuget/v/SharpDeck.svg)](https://www.nuget.org/packages/SharpDeck/)\n[![Build status](https://github.com/GeekyEggo/SharpDeck/workflows/build/badge.svg)](https://github.com/GeekyEggo/SharpDeck/actions?query=workflow%3Abuild)\n\n# SharpDeck\n\nA comprehensive .NET wrapper for creating Stream Deck plugins, using the official Stream Deck SDK documentation. SharpDeck takes the hassle out of communicating with the Stream Deck SDK, and handles action caching and event delegation.\n\n## 📦 Examples\n\n* [Counter](/examples/Counter) - Single action counter plugin.\n* [Shared Counter](/examples/SharedCounter) - Multiple action plugin with a shared counter and reset.\n\n## ✏️ Creating a plugin\n\nSharpDeck enables console applications to easily communicate with Stream Deck; run `dotnet new console` to create a .NET console application, and follow these five steps to create your first Stream Deck plugin.\n\n### 🔗 1. Program.cs\n\n```csharp\npublic static void Main(string[] args)\n{\n#if DEBUG\n    System.Diagnostics.Debugger.Launch(); \n#endif\n\n    // Connect to Stream Deck.\n    SharpDeck.StreamDeckPlugin.Run();\n}\n```\n\n### ⚡ 2. Create an action\n```csharp\nusing SharpDeck;\nusing SharpDeck.Events.Received; \n\n[StreamDeckAction(\"com.geekyeggo.exampleplugin.firstaction\")]\npublic class MyFirstAction : StreamDeckAction\n{\n    // Methods can be overriden to intercept events received from the Stream Deck.\n    protected override Task OnKeyDown(ActionEventArgs\u003cKeyPayload\u003e args) =\u003e ...;\n    protected override Task OnKeyUp(ActionEventArgs\u003cKeyPayload\u003e args) =\u003e ...;\n}\n```\n\n### 📄 3. Create a manifest.json file\n\n\u003e For more information about creating a manifest file, please refer to the [SDK documentation](https://developer.elgato.com/documentation/stream-deck/sdk/manifest/).\n\n### ⚙️ 4. Configure .csproj\n\n```xml\n\u003c!-- Install the plugin after each build - change authorName and pluginName accordingly. --\u003e\n\u003cPropertyGroup Condition=\"'$(Configuration)|$(Platform)'=='Debug|AnyCPU'\"\u003e\n    \u003cOutputPath\u003e$(APPDATA)\\Elgato\\StreamDeck\\Plugins\\com.{{authorName}}.{{pluginName}}.sdPlugin\\\u003c/OutputPath\u003e\n    \u003cAppendTargetFrameworkToOutputPath\u003efalse\u003c/AppendTargetFrameworkToOutputPath\u003e\n\u003c/PropertyGroup\u003e\n\n\u003cItemGroup\u003e\n    \u003c!-- The manifest file is required by Stream Deck and provides important information. --\u003e\n    \u003cNone Update=\"manifest.json\"\u003e\n        \u003cCopyToOutputDirectory\u003eAlways\u003c/CopyToOutputDirectory\u003e\n    \u003c/None\u003e\n\u003c/ItemGroup\u003e\n\n\u003c!-- Kill the Stream Deck process before each build; this allows the copy to occur. --\u003e\n\u003cTarget Name=\"PreBuild\" BeforeTargets=\"PreBuildEvent\" Condition=\"'$(Configuration)|$(Platform)'=='Debug|AnyCPU'\"\u003e\n    \u003cExec Command=\"taskkill -f -t -im StreamDeck.exe -fi \u0026quot;status eq running\u0026quot;\" /\u003e\n\u003c/Target\u003e\n```\n\n### 🚧 5. Debug profile\n\n\u003e Located at **Properties/launchSettings.json**; this debug profile will automatically launch StreamDeck.exe when debugging starts.\n```json\n{\n  \"profiles\": {\n    \"DebugWin\": {\n      \"commandName\": \"Executable\",\n      \"executablePath\": \"c:\\\\windows\\\\system32\\\\cmd.exe\",\n      \"commandLineArgs\": \"/S /C \\\"start \\\"title\\\" /B \\\"%ProgramW6432%\\\\Elgato\\\\StreamDeck\\\\StreamDeck exe\\\" \\\"\"\n    }\n  }\n}\n```\n\n## 🏃 Running\n\nWhen debugging starts (default F5):\n1. The plugin will be built and installed.\n1. Stream Deck will then launch.\n1. You will be prompted to attach your plugin to a process; this allows for debugging.\n\nWhen your plugin is ready, consider [packaging](https://developer.elgato.com/documentation/stream-deck/sdk/packaging/) and [distributing](https://developer.elgato.com/documentation/stream-deck/sdk/distribution/) it on the Stream Deck store.\n\n## 📃 License\n\n[The MIT License (MIT)](LICENSE.md)\nStream Deck is a trademark or registered trademark of Elgato Systems.\n","funding_links":["https://github.com/sponsors/GeekyEggo"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeekyeggo%2Fsharpdeck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeekyeggo%2Fsharpdeck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeekyeggo%2Fsharpdeck/lists"}