DeckSurf.SDK 0.0.5

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher. 
dotnet add package DeckSurf.SDK --version 0.0.5                

                    
                

            
NuGet\Install-Package DeckSurf.SDK -Version 0.0.5
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="DeckSurf.SDK" Version="0.0.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add DeckSurf.SDK --version 0.0.5                

                    
                

            
#r "nuget: DeckSurf.SDK, 0.0.5"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install DeckSurf.SDK as a Cake Addin
#addin nuget:?package=DeckSurf.SDK&version=0.0.5

// Install DeckSurf.SDK as a Cake Tool
#tool nuget:?package=DeckSurf.SDK&version=0.0.5

DeckSurf SDK Icon

🌊 DeckSurf SDK for .NET

Unofficial Software Development Kit for your Stream Deck, built in C# for the .NET platform.

[!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 🔃 Testing
Stream Deck Original (2019) 🔃 Testing
Stream Deck MK.2 🔃 Testing
Stream Deck MK.2 (Scissor) 🔃 Testing
Stream Deck Mini 🔃 Testing
Stream Deck Mini (2022) 🔃 Testing
Stream Deck Neo 🔃 Testing

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.

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on DeckSurf.SDK:

Repository Stars
dend/DeckSurf
🌊 Lightweight and open way to manage your Stream Deck device.
Version Downloads Last updated
0.0.5 86 12/27/2024
0.0.4 84 12/26/2024
0.0.3 463 8/4/2021
0.0.2 184 7/22/2021
0.0.1 199 7/22/2021