Skip to content

dend/decksurf-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

DeckSurf SDK Icon

🌊 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.

NuGet Version

About

The DeckSurf SDK is used to manage Stream Deck devices and create plugins for DeckSurf tools. 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:

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 repository.

Documentation

Refer to 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.