streamdeck-client-csharp 4.3.0

Install-Package streamdeck-client-csharp -Version 4.3.0
dotnet add package streamdeck-client-csharp --version 4.3.0
<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, C# scripting and .NET Interactive. 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.

NuGet

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

Copyright (c) 2019 Shane DeSeranno

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.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on streamdeck-client-csharp:

Package Downloads
StreamDeck-Tools

Start developing your Elgato StreamDeck plugin faster! This library encapsulates all the overhead of setting up the framework, so that you can focus on writing the logic of the plugin itself. [Samples for using the library are provided here: https://github.com/BarRaider/streamdeck-tools] Using this library, you only need to derive from the abstract PluginBase class and add one line of code in your program.cs to have a working plugin. More info and working samples here: https://github.com/BarRaider/streamdeck-tools . Feel free to contact me for more information: https://barraider.com

GitHub repositories (4)

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

Repository Stars
BarRaider/streamdeck-tools
The Stream Deck Tools library wraps all the communication with the Stream Deck app, allowing you to focus on actually writing the Plugin's logic
mhwlng/streamdeck-elite
Elgato Stream Deck plugin for Elite Dangerous
BarRaider/streamdeck-supermacro
Create sophisticated macros easily and run them through your Stream Deck
SaviorXTanren/mixer-mixitup
Streaming bot application for handling chat, events, moderation, and other streamer assistance features
Version Downloads Last updated
4.3.0 756 1/13/2021
4.2.0 967 6/22/2020
4.1.1 1,534 5/24/2019
4.1.0 620 2/26/2019
4.0.1 494 2/15/2019
4.0.0 242 2/15/2019
0.1.2-preview 555 1/9/2019
0.1.1-preview 263 1/9/2019
0.1.0-preview 257 1/8/2019

Updated nuget dependencies to latest version + Removed compilaton warnings