https://github.com/dend/decksurf-sdk
🌱 SDK to manage your Stream Deck from .NET code
https://github.com/dend/decksurf-sdk
csharp dotnet hid library reverse-engineering sdk streamdeck streamdeck-sdk
Last synced: 12 months ago
JSON representation
🌱 SDK to manage your Stream Deck from .NET code
- Host: GitHub
- URL: https://github.com/dend/decksurf-sdk
- Owner: dend
- License: mit
- Created: 2021-07-22T19:44:48.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-18T02:18:25.000Z (about 1 year ago)
- Last Synced: 2025-03-25T00:40:45.450Z (about 1 year ago)
- Topics: csharp, dotnet, hid, library, reverse-engineering, sdk, streamdeck, streamdeck-sdk
- Language: C#
- Homepage: https://docs.deck.surf
- Size: 784 KB
- Stars: 14
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 🌊 DeckSurf SDK for .NET
_**Unofficial Software Development Kit for your Stream Deck, built in C# for the .NET platform.**_
>[!WARNING]
>This SDK is under active development and is currently in its **alpha stage**. That means that there _may be_ breaking changes between releases until it hits `1.0.0`.
>[!NOTE]
>For the DeckSurf tooling (_CLI and plugins_), refer to the [DeckSurf repository](https://github.com/dend/DeckSurf).
[](https://www.nuget.org/packages/DeckSurf.SDK)
## About
The DeckSurf SDK is used to manage Stream Deck devices and create plugins for [DeckSurf tools](https://github.com/dend/DeckSurf). It is completely independent of the Elgato software and/or libraries and can be used as a standalone library.
## Installation
You can use the SDK by installing it [from NuGet](https://www.nuget.org/packages/DeckSurf.SDK):
```powershell
dotnet add package DeckSurf.SDK
```
## Supported devices
| Device | Level of support |
|:----------------------------|:--------|
| Stream Deck XL | ✅ Full |
| Stream Deck XL (2022) | ✅ Full |
| Stream Deck Plus | ✅ Full |
| Stream Deck Original | ✅ Full |
| Stream Deck Original (2019) | ✅ Full |
| Stream Deck MK.2 | ✅ Full |
| Stream Deck MK.2 (Scissor) | ✅ Full |
| Stream Deck Mini | ✅ Full |
| Stream Deck Mini (2022) | ✅ Full |
| Stream Deck Neo | ✅ Full |
Device IDs mapped from the [`streamdeck-kit-ipad`](https://github.com/elgatosf/streamdeck-kit-ipad/blob/c53ef3eb17b8746f80af7224bafa770883e127c6/Sources/StreamDeckKit/Device/StreamDeckProductId.swift#L45) repository.
## Documentation
Refer to [`https://docs.deck.surf`](https://docs.deck.surf/) for tutorials and SDK documentation.
## Platform compatibility
The SDK in its current implementation has a number of dependencies on Windows APIs, therefore will only work on Windows. In future releases, I am thinking of a way to rip out native components and separate them in their own package, allowing the SDK to be fully cross-platform.