StreamDeck-Tools 1.1.6

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

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

BarRaider's Stream Deck Tools

NuGet

Author's website and contact information: https://barraider.github.io

Features

  • Just call the SDWrapper.Run() and the library will take care of all the overhead
  • Built-in integration with NLog. Use Logger.LogMessage() for logging.
  • Just have your plugin inherit PluginBase and implement the basic functionality

How do I use this?

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 sample here for more details: https://github.com/BarRaider/barraider-sdtools
public class MyPlugin : PluginBase
{
	// Create this constructor in your plugin and pass the objects to the PluginBase class
	public MyPlugin(SDConnection connection, JObject settings) : base(connection, settings)
	{
		...
	}
			....
}
  1. In your program.cs, Create a list of all the ActionIds (UUIDs) your plugin supports, and which class implements it. The actionId correlates to the UUID field in the manifest.json file.
    You can have more than one action in the manifest file and therefore we except an array. The second parameter is the type (not instance!) of the class that implements that action. This is the class from step 1 above. Pass the args you received along with the supported ActionIds to the SDWrapper.Run() function, and you're done! Example:
class Program
{
	static void Main(string[] args)
	{
		List<PluginActionId> supportedActionIds = new List<PluginActionId>();
		supportedActionIds.Add(new PluginActionId("com.barraider.myUUID", typeof(MyPlugin)));

		SDWrapper.Run(args, supportedActionIds.ToArray());
	}
}
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 is compatible.  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.

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
mhwlng/streamdeck-elite
Elgato Stream Deck plugin for Elite Dangerous
mhwlng/streamdeck-starcitizen
Elgato Stream Deck button plugin for Star Citizen
BarRaider/streamdeck-voicemeeter
VoiceMeeter integration for Stream Deck
Version Downloads Last updated
6.2.0 530 1/23/2024
6.1.1 1,529 4/26/2023
6.1.0 659 4/25/2023
6.0.0 1,088 2/12/2023
5.9.1-Beta1 597 12/22/2022
5.9.0-Beta1 596 12/8/2022
3.2.0 3,439 1/20/2021
3.1.0 2,025 11/29/2020
3.0.0 1,087 10/1/2020
2.9.0 1,155 6/25/2020
2.8.0 1,083 4/27/2020
2.7.0 1,529 1/2/2020
2.6.0 1,315 9/29/2019
2.5.0 1,127 8/12/2019
2.4.2 1,046 7/15/2019
2.3.0 993 7/9/2019
2.2.0 1,184 5/24/2019
2.0.1 1,201 3/8/2019
2.0.0 1,359 3/4/2019
1.1.6 1,188 2/18/2019
1.1.5 1,122 2/15/2019
1.1.1 1,123 2/9/2019

* Additional helper functions added to Tools class
* Tools class now supports extracting the correct filename from a PI file chooser
* Fixed bug in which Dispose was not always called on the plugin