NotMyself / StreamDeckToolkit

A .NET Standard library, template, and tools for building extensions to the Elgato Stream Deck

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

StreamDeckToolkit

Build status NuGet

Intellicode Model

What Is This?

This is a template to help create plugins for the Elgato Stream Deck, using the Stream Deck SDK with Dotnet Core.

Pre-Requisites

In order to make use of this template, you will need to have the Dotnet Core SDK (version 2.2.100 or above) installed on your development machine.

While not absolutely necessary, it is strongly recommended to have the Stream Deck Software installed, to be able to perform some integration testing of your plugin.

Install Project Template

From File System

Installing the template from your filesystem is useful for local testing of the template itself. If you are actively working on the template making changes, this is the route you need to use.

To install, run the following command from the root of the repository.

dotnet new -i Templates/StreamDeck.PluginTemplate.Csharp

To pick up any changes you have made to the template source, you must uninstall the template and reinstall it.

To uninstall, run the following command from the root of the respository.

Windows: dotnet new -u Templates/StreamDeck.PluginTemplate.Csharp

OSX/Linux: dotnet new -u $PWD/Templates/StreamDeck.PluginTemplate.Csharp

From NuGet

dotnet new -i StreamDeckPluginTemplate
- OR -
Install-Package StreamDeckPluginTemplate [-Version x.y.zzz]

Using the Template

Once the template is installed, open a terminal and create a new project.

dotnet new streamdeck-plugin -n FirstPlugin

Or create a directory in a location of your choice, change to that directory and run the command, which will inherit the directory name as the project name.

dotnet new streamdeck-plugin

About

A .NET Standard library, template, and tools for building extensions to the Elgato Stream Deck

License:MIT License


Languages

Language:CSS 52.9%Language:C# 36.5%Language:PowerShell 4.1%Language:Shell 2.8%Language:JavaScript 2.2%Language:HTML 1.5%