streamdeck-client-csharp 4.3.0

.NET Standard 2.0

dotnet add package streamdeck-client-csharp --version 4.3.0

NuGet\Install-Package streamdeck-client-csharp -Version 4.3.0

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="streamdeck-client-csharp" Version="4.3.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add streamdeck-client-csharp --version 4.3.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: streamdeck-client-csharp, 4.3.0"

#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 streamdeck-client-csharp as a Cake Addin
#addin nuget:?package=streamdeck-client-csharp&version=4.3.0

// Install streamdeck-client-csharp as a Cake Tool
#tool nuget:?package=streamdeck-client-csharp&version=4.3.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

streamdeck-client-csharp

A C# client library for the Elgato Stream Deck device.

What is this?

Elgato just released their Official Stream Deck SDK, but it only supported Javascript, C++, and Objective-C. I was frustrated as I prefer C# as my go-to language. So, I wrote this wrapper to ease writing plugins.

Requirements

This library uses the native WebSocket support found in Windows 8 & higher. This means that any application that uses this library must be running Windows 8 or higher.

Current functionality

The library should support all features documented by the SDK:

Connection and Disconnection
Sending messages
Receiving events

Feature roadmap

At this point, we should only need to monitor the Official SDK for new features and implement them.

How do I get started using it?

Download the NuGet package by searching for "streamdeck-client-csharp" or downloading it manually from https://www.nuget.org/packages/streamdeck-client-csharp. If you clone the repository, you will see the TestPlugin C# project. When this is compiled it creates a folder in the output directory com.tyren.testplugin.sdPlugin. If you copy this into your Stream Deck's Plugin Folder, and launch Stream Deck, you should see the C# Test Plugin category show up with some test actions inside.

I found a bug, who do I contact?

Just head over to the https://github.com/TyrenDe/streamdeck-client-csharp/issues page and create a new issue.

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- Newtonsoft.Json (>= 12.0.3)
- System.Drawing.Common (>= 5.0.0)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on streamdeck-client-csharp:

Repository	Stars
mhwlng/streamdeck-elite Elgato Stream Deck plugin for Elite Dangerous	262
SaviorXTanren/mixer-mixitup Streaming bot application for handling chat, events, moderation, and other streamer assistance features	189
mhwlng/streamdeck-starcitizen Elgato Stream Deck button plugin for Star Citizen	152

Version	Downloads	Last updated
4.3.0	4,204	1/13/2021
4.2.0	3,312	6/22/2020
4.1.1	4,898	5/24/2019
4.1.0	1,973	2/26/2019
4.0.1	1,730	2/15/2019
4.0.0	382	2/15/2019
0.1.2-preview	2,110	1/9/2019
0.1.1-preview	376	1/9/2019
0.1.0-preview	364	1/8/2019