StreamDeck-Tools 1.1.5

Start developing your Elgato StreamDeck plugin faster!
This library holds all the basic logic of setting up the framework, so that you can focus on writing the logic of the plugin itself.
Using this library, you only need to derive from the abstract plugin base class and addd three lines in your program.cs to have a working plugin. More information here: https://github.com/BarRaider/barraider-sdtools

There is a newer version of this package available.
See the version list below for details.
Install-Package StreamDeck-Tools -Version 1.1.5
dotnet add package StreamDeck-Tools --version 1.1.5
<PackageReference Include="StreamDeck-Tools" Version="1.1.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add StreamDeck-Tools --version 1.1.5
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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());
	}
}

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());
	}
}

Release Notes

* ContextId can now be obtained from the SDConnection object
* Logging now automaticaly archives old logs to a "logs" folder
* Updated dependencies to release versions

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
3.1.0 115 11/29/2020
3.0.0 159 10/1/2020
2.9.0 254 6/25/2020
2.8.0 243 4/27/2020
2.7.0 537 1/2/2020
2.6.0 343 9/29/2019
2.5.0 252 8/12/2019
2.4.2 197 7/15/2019
2.3.0 174 7/9/2019
2.2.0 243 5/24/2019
2.0.1 281 3/8/2019
2.0.0 305 3/4/2019
1.1.6 206 2/18/2019
1.1.5 217 2/15/2019
1.1.1 199 2/9/2019
Show less