使用 Package Manager 创建和部署 Engine 插件

创建 Engine 插件工程

要使用 Package Manager 在 Kanzi Studio 中创建 Engine 插件:

  1. 在 New Project 窗口中,使用 Application with Kanzi Engine plugin 模板创建工程。

    ../../_images/kanzi-studio-kpm-engine-plugin-template.png
  2. 在 Kanzi Studio 中选择 File > Open in File Explorer,然后导航至 <MyProject>\Application 文件夹,该文件夹包含以下用于构建和部署插件的文件:

    • README.md 是关于如何构建、打包和部署插件的快速参考。

    • build.bat 用于构建插件。

    • create_and_deploy_plugin.bat 是一个便捷脚本,用于运行 Conan 命令来创建插件包并将其部署到指定的 Conan 仓库。

    ../../_images/application-folder-engine-plugin.png
  3. 以 Package Manager 模式构建插件:

    • 在 <MyProject>\Application 文件夹的空白区域中点击右键,然后选择 Open in Terminal。

    ../../_images/application-folder-engine-plugin-open-terminal.png
    • 运行构建脚本:

      build.bat kpm
      

    此操作会编译插件应用程序,并生成打包步骤用于创建 Conan 包的 Package Manager 构建输出。此脚本不会创建包,创建包也无需运行此脚本。如果需要在打包之前验证编译,请运行此构建脚本。

备注

在非 Windows 平台上,请改用 build.sh 脚本。

将插件创建为本地 Conan 包

要创建可在本地测试的插件包:

  1. 运行部署脚本:

    create_and_deploy_plugin.bat
    

    构建插件并将包发布到本地 Conan 缓存。该脚本不会将包上传到任何远程仓库。

    备注

    此脚本创建一个 Conan 包,其参考形式为 my_engine_plugin/1.0.0@kanzi-4.1.0-engine-plugins/stable。用户段 kanzi-4.1.0-engine-plugins 由脚本中的 KANZI_VERSION 变量构成;通道 stable 是脚本的默认值。

  2. 在 Kanzi Studio 中打开 Package Manager:

    • 选择 Local 选项卡。

    • 点击刷新图标以刷新本地包列表。

    ../../_images/package-manager-repository-refresh-local.png
    • 新的插件会显示在本地包下。

    ../../_images/package-manager-my-engine-plugin-local.png

备注

在非 Windows 平台上,请改用 create_and_deploy_plugin.sh 脚本。

创建插件并将其部署到远程仓库

要创建插件包并将其发布到远程仓库:

  1. 使用配置文件和远程仓库名称运行部署脚本:

    create_and_deploy_plugin.bat win64_vs2022_release <remote>
    

    构建插件,将包发布到本地 Conan 缓存,并将其上传到远程仓库 <remote>。

    备注

    此脚本创建一个 Conan 包,其参考形式为 my_engine_plugin/1.0.0@kanzi-4.1.0-engine-plugins/stable。用户段 kanzi-4.1.0-engine-plugins 由脚本中的 KANZI_VERSION 变量构成;通道 stable 是脚本的默认值。

  2. 在 Kanzi Studio 中打开 Package Manager:

    • 选择 Remote 选项卡。

    • 在 Repository 下拉列表中,选择您部署插件的目标仓库。

    ../../_images/package-manager-repository-dropdown.png
    • 点击刷新图标以刷新仓库列表。

    ../../_images/package-manager-repository-refresh.png
    • 新的插件会显示在该仓库的包下。

    ../../_images/package-manager-my-engine-plugin-remote.png

备注

在非 Windows 平台上,请改用 create_and_deploy_plugin.sh 脚本。

另请参阅

Package Manager

使用 Package Manager Kanzi Studio 插件

使用 Package Manager 创建和部署资产包