安装 Kanzi Studio 插件

Kanzi Studio 插件扩展了 Kanzi Studio 的功能,并在 Kanzi Studio 中运行。

例如,您可以扩展 Kanzi Studio 的功能以:

  • 在 Kanzi Studio 中自动化那些手动执行需要大量时间或容易出错的任务。

  • 从 Kanzi Studio 导入和导出内容,例如 Kanzi Studio 不支持的格式的本地化表。

  • 创建抽象细节并加快工作流程的编辑器,例如支持在 Kanzi Studio 上进行项目工作的可视化工具。

要安装 Kanzi Studio 插件:

  1. 将 Kanzi Studio 插件 DLL 文件复制到 %ProgramData%\Rightware\<KanziVersion>\plugins 目录。

    如果 plugins 目录在 %ProgramData%\Rightware\<KanziVersion> 中不存在,请创建它。

    小技巧

    在文件资源管理器中,从您的 Kanzi Studio 插件 DLL 文件创建一个快捷方式,并将该快捷方式移动到 %ProgramData%\Rightware\<KanziVersion>\plugins 目录。

    当您构建插件时,您可以在 Output 窗口中看到 Visual Studio 存储插件 DLL 文件的位置。

    小技巧

    要安装带有依赖 DLL 的插件:

    1. 在 plugins 目录中为插件创建一个子目录,并将所有插件文件放在其中。例如:

      plugins/
         MyPlugin/
            MyPlugin.manifest.json
            MyPlugin.dll
            SomeDependency.dll
      
    2. 在该子目录中创建一个声明入口点的清单文件,文件名任意,但须以 .manifest.json 结尾:

      {
         "entryPoint": "MyPlugin.dll"
      }
      

    Kanzi Studio 仅加载所声明的入口点 DLL,并按需从同一目录解析依赖项。

  2. 打开 Kanzi Studio。

    Kanzi Studio 加载 plugins 目录中的插件,并将它们添加到主菜单或从节点和资源调用的上下文菜单中。

    小技巧

    当您从互联网下载 Kanzi Studio 插件时,Windows 可能会阻止对插件文件的访问,从而阻止 Kanzi Studio 加载该插件。

    如果插件未在 Kanzi Studio 中加载:

    1. 打开 Kanzi Studio 日志文件。

      %USERPROFILE%/AppData/Local/Temp/KanziStudioLogs/KanziStudio.log
      
    2. 如果日志包含此错误消息:

      Plugin loading failed for: <PathToPlugin>. Error "Unable to load one or more of the requested types."

      在插件目录中打开 Windows PowerShell,并执行此命令:

      Get-ChildItem . -Recurse | Unblock-File
      

      这样可解锁目录中的所有文件。

    3. 重启 Kanzi Studio。

热重载插件

Kanzi Studio 在运行时监视 plugins 目录中的更改:

  • 当您添加插件 DLL 或带有清单文件的插件子目录时,Kanzi Studio 会自动加载该插件。

  • 当您更新现有插件 DLL 时,Kanzi Studio 会使用新版本重新加载它。

  • 当您移除插件时,Kanzi Studio 会自动卸载它,关闭所有打开的插件窗口,并移除相关的菜单项。

无需重新启动 Kanzi Studio 即可使这些更改生效。

另请参阅

创建 Kanzi Studio 命令插件

创建 Kanzi Studio 窗口插件

创建 Kanzi Engine 插件

Kanzi Studio 插件