StreamDeckToolkit 项目教程

StreamDeckToolkit 项目教程

StreamDeckToolkitA .NET Standard library, template, and tools for building extensions to the Elgato Stream Deck项目地址:https://gitcode.com/gh_mirrors/st/StreamDeckToolkit

1. 项目的目录结构及介绍

StreamDeckToolkit 项目的目录结构如下：

StreamDeckToolkit/
├── docs/
├── scripts/
├── src/
│   ├── StreamDeckToolkit/
│   └── StreamDeckPluginTemplate.CSharp/
├── test/
├── .editorconfig
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── RESOURCES.md
└── StreamDeckToolkit.code-workspace

目录介绍

• docs/: 包含项目的文档文件。
• scripts/: 包含项目的脚本文件。
• src/: 包含项目的源代码文件。
  • StreamDeckToolkit/: 包含 StreamDeckToolkit 的核心库代码。
  • StreamDeckPluginTemplate.CSharp/: 包含 C# 插件模板代码。
• test/: 包含项目的测试文件。
• .editorconfig: 编辑器配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• RESOURCES.md: 项目资源文件。
• StreamDeckToolkit.code-workspace: Visual Studio Code 工作区配置文件。

2. 项目的启动文件介绍

项目的启动文件主要位于 src/StreamDeckPluginTemplate.CSharp/ 目录下。主要的启动文件是 Program.cs 和 Main.cs。

Program.cs

Program.cs 文件包含了程序的入口点，负责初始化和启动插件。

using System;
using System.Threading.Tasks;
using StreamDeckToolkit;

namespace StreamDeckPluginTemplate.CSharp
{
    class Program
    {
        static async Task Main(string[] args)
        {
            var host = StreamDeckHostBuilder.CreateDefaultBuilder(args)
                .ConfigureStreamDeckApp<MyStreamDeckApp>()
                .Build();

            await host.RunAsync();
        }
    }
}

Main.cs

Main.cs 文件定义了插件的主要逻辑和行为。

using StreamDeckToolkit;

namespace StreamDeckPluginTemplate.CSharp
{
    public class MyStreamDeckApp : StreamDeckApp
    {
        public override void RegisterActions()
        {
            RegisterAction<MyStreamDeckAction>();
        }
    }
}

3. 项目的配置文件介绍

项目的配置文件主要包含在 src/StreamDeckPluginTemplate.CSharp/ 目录下，主要的配置文件是 manifest.json。

manifest.json

manifest.json 文件是 Stream Deck 插件的配置文件，包含了插件的基本信息和动作定义。

{
  "Actions": [
    {
      "Name": "My Stream Deck Action",
      "UUID": "com.example.myaction",
      "Icon": "Images/action",
      "States": [
        {
          "Image": "Images/default",
          "TitleAlignment": "bottom",
          "FontSize": "12"
        }
      ],
      "SupportedInMultiActions": true,
      "Tooltip": "This is my custom action."
    }
  ],
  "Author": "Your Name",
  "Description": "A custom Stream Deck plugin.",
  "Name": "My Stream Deck Plugin",
  "Icon": "Images/plugin",
  "URL": "https://example.com",
  "Version": "1.0",
  "CodePath": "MyStreamDeckPlugin.exe",
  "SDKVersion": 2,
  "Software": {
    "MinimumVersion": "4.1"
  },
  "OS": [
    {
      "Platform": "windows",
      "MinimumVersion": "10"
    }
  ]
}

配置文件介绍

• Actions: 定义插件的动作列表。
• Author: 插件的作者。
• Description: 插件的描述。
• Name: 插件的名称。
• **Icon

StreamDeckToolkitA .NET Standard library, template, and tools for building extensions to the Elgato Stream Deck项目地址:https://gitcode.com/gh_mirrors/st/StreamDeckToolkit