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 ディレクトリにコピーします。

    %ProgramData%\Rightware\<KanziVersion> に plugins ディレクトリが存在しない場合は、作成してください。

    ヒント

    ファイルエクスプローラーで、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 プラグイン