StreamDeck-Tools 3.2.0

.NET Standard 2.0 .NET Framework 4.7.2
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package StreamDeck-Tools --version 3.2.0
NuGet\Install-Package StreamDeck-Tools -Version 3.2.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-Tools" Version="3.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add StreamDeck-Tools --version 3.2.0
#r "nuget: StreamDeck-Tools, 3.2.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-Tools as a Cake Addin
#addin nuget:?package=StreamDeck-Tools&version=3.2.0

// Install StreamDeck-Tools as a Cake Tool
#tool nuget:?package=StreamDeck-Tools&version=3.2.0

BarRaider's Stream Deck Tools

C# library that wraps all the communication with the Stream Deck App, allowing you to focus on actually writing the Plugin's logic.


Author's website and contact information:
** Samples of plugins using this framework: Samples

Version 3.2 is out!

  • Created new ISDConnection interface which is now implemented by SDConnection and used by PluginAction.
  • GlobalSettingsManager now has a short delay before calling GetGlobalSettings(), to reduce spamming the Stream Deck SDK.
  • Updated dependencies to latest version


  • Sample plugin now included in this project on Github
  • Simplified working with filenames from the Stream Deck SDK. See "Working with files" section below
  • Built-in integration with NLog. Use Logger.LogMessage() for logging.
  • Just call the SDWrapper.Run() and the library will take care of all the overhead
  • Just have your plugin inherit PluginBase and implement the basic functionality. Use the PluginActionId to specify the UUID from the manifest file. (see samples on github page)
  • Simplified receiving Global Settings updates through the new ReceivedGlobalSettings method
  • Simplified receiving updates from the Property Inspector through the new ReceivedSettings method along with the new Tools.AutoPopulateSettings() method. See the "Auto-populating plugin settings" section below.
  • Introduced a new attribute called PluginActionId to indicate the Action's UUID (See below)
  • Added support to switching plugin profiles.
  • The DeviceId that the plugin is running on is now accessible from the Connection object
  • Added new MD5 functions in the Tools helper class
  • Optimized SetImage to not resubmit an image that was just posted to the device. Can be overridden with new property in Connection.SetImage() function.
  • ExtensionMethods for Brush/Color/Graphics objects
  • Helper functions in the Tools and GraphicTools classes

How do I use this?

A list of plugins already using this library can be found here

This library wraps all the communication with the Stream Deck App, allowing you to focus on actually writing the Plugin's logic. After creating a C# Console application, using this library requires two steps:

  1. Create a class that inherits the PluginBase abstract class.
    Implement your logic, focusing on the methods provided in the base class.
    Follow the samples here for more details
    New: In version 2.x - use the PluginActionId attribute to indicate the action UUID associated with this class (must match the UUID set in the manifest file)
public class MyPlugin : PluginBase
	// Create this constructor in your plugin and pass the objects to the PluginBase class
	public MyPlugin(SDConnection connection, InitialPayload payload) : base(connection, payload)
		// TODO: Use the payload.Settings to see the various settings set in the Property Inspector (in my samples, I create a private class that holds the settings)
		// Other relevant settings in the payload include the actual position of the plugin on the Stream Deck
		// Note: By passing the `connection` object back to the PluginBase (using the `base` in the constructor), you now have access to a property called `Connection` 
		// throughout your plugin.
	// TODO: Implement all the remaining abstract functions from PluginBase (or just leave them empty if you don't need them)
	// An example of how easy it is to populate settings in StreamDeck-Tools v2
	public override void ReceivedSettings(ReceivedSettingsPayload payload)
		Tools.AutoPopulateSettings(settings, payload.Settings); // "settings" is a private class that holds the settings for your plugin's instance.
  1. In your program.cs, just pass the args you received to the SDWrapper.Run() function, and you're done!
    Note: This process is much easier than the one used in 1.x and is based on using the PluginActionId attribute, as shown in Step 1 above.
class Program
	static void Main(string[] args)
  1. There is no step 3 - that's it! The abstract functions from PluginBase that are implemented in MyPlugin hold all the basics needed for a plugin to work. You can always listen to additional events using the Connection property.
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48 net481
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

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-Tools:

Repository Stars
Elgato Stream Deck plugin for Elite Dangerous
Create sophisticated macros easily and run them through your Stream Deck
VoiceMeeter integration for Stream Deck
Version Downloads Last updated
5.9.1-Beta1 68 12/22/2022
5.9.0-Beta1 57 12/8/2022
3.2.0 2,221 1/20/2021
3.1.0 993 11/29/2020
3.0.0 424 10/1/2020
2.9.0 531 6/25/2020
2.8.0 510 4/27/2020
2.7.0 871 1/2/2020
2.6.0 652 9/29/2019
2.5.0 506 8/12/2019
2.4.2 422 7/15/2019
2.3.0 413 7/9/2019
2.2.0 528 5/24/2019
2.0.1 551 3/8/2019
2.0.0 636 3/4/2019
1.1.6 521 2/18/2019
1.1.5 513 2/15/2019
1.1.1 500 2/9/2019

3.2 - 1. Created new ISDConnection interface which is now implemented by SDConnection and used by PluginAction.
2. GlobalSettingsManager now has a short delay before calling GetGlobalSettings, to reduce spamming the Stream Deck SDK.
3. Updated dependencies to latest version