StreamDeck-Tools 3.1.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: https://barraider.com
** Samples of plugins using this framework: Samples

Version 3.1 is out!

• Updated Logger class to include process name and thread id
• Updated StreamDeck-Tools Template for Visual Studio

Version 3.0 is out!

• Updated file handling in Tools.AutoPopulateSettings and Tools.FilenameFromPayload methods
• Removed obsolete MD5 functions, use SHA512 functions instead
• Tools.CenterText function now has optional out textFitsImage value to verify the text does not exceed the image width
• New Tools.FormatBytes function converts bytes to human-readable value
• New Tools.FormatNumber() function converts 54265 to 54.27k
• New Graphics.GetFontSizeWhereTextFitsImage function helps locate the best size for a text to fit an image on 1 line
• New ExtensionMethods for Graphics object: DrawAndMeasureString / GetTextCenter
• Updated dependency packages to latest versions
• Bug fix where FileNameProperty attribute

Features

• 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)

[PluginActionId("plugin.uuid.from.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.
	}
}

2. 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.
   Example:

class Program
{
	static void Main(string[] args)
	{
		SDWrapper.Run(args);
	}
}

3. 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.