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 キャッシュに公開します。パッケージをリモートにアップロードすることはありません。

    注釈

    このスクリプトは、my_engine_plugin/1.0.0@kanzi-4.1.0-engine-plugins/stable という形式のリファレンスで識別される Conan パッケージを作成します。ユーザーセグメント kanzi-4.1.0-engine-plugins はスクリプト内の KANZI_VERSION 変数から構成され、チャネル stable はスクリプトのデフォルトです。

  2. Kanzi Studio でパッケージマネージャーを開きます。

    • 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> にアップロードします。

    注釈

    このスクリプトは、my_engine_plugin/1.0.0@kanzi-4.1.0-engine-plugins/stable という形式のリファレンスで識別される Conan パッケージを作成します。ユーザーセグメント kanzi-4.1.0-engine-plugins はスクリプト内の KANZI_VERSION 変数から構成され、チャネル stable はスクリプトのデフォルトです。

  2. Kanzi Studio でパッケージマネージャーを開きます。

    • 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 Kanzi Studio プラグインを使用する

Package Manager を使用したアセットパッケージの作成とデプロイ