Using Package Manager to create and deploy an Engine plugin¶

Creating an Engine plugin project¶

To create an Engine plugin in Kanzi Studio using the Package Manager:

In the New Project window, create your project using the Application with Kanzi Engine plugin template.
In Kanzi Studio, select File > Open in File Explorer, then navigate to the <MyProject>\Application folder, which contains the following files that assist in building and deploying the plugin:
- README.md is a quick reference on how to build, package, and deploy the plugin.
- build.bat builds the plugin.
- create_and_deploy_plugin.bat is a convenience script that runs the Conan command to create the plugin package and deploy it to a specified Conan repository.
Build the plugin in Package Manager mode:
- Right-click an empty area in the <MyProject>\Application folder and select Open in Terminal.
- Run the build script:
```
build.bat kpm
```
This compiles the plugin application and produces the Package Manager build output that the packaging step uses to create the Conan package. This script does not create a package, and running it is not required in order to create one. Run this build script if you need to verify compilation, before packaging.

Note

On non-Windows platforms, use the build.sh script instead.

To create a plugin package that you can test locally:

Run the deploy script:
```
create_and_deploy_plugin.bat
```
Builds the plugin and publishes the package to your local Conan cache. It does not upload the package to any remote.

Note

This script creates a Conan package identified by a reference of the form my_engine_plugin/1.0.0@kanzi-4.1.0-engine-plugins/stable. The kanzi-4.1.0-engine-plugins user segment is built from the KANZI_VERSION variable in the script; the stable channel is the script default.
Open the Package Manager in Kanzi Studio:
- Select the Local tab.
- Refresh the local packages list by pressing the refresh icon.
- Your new plugin appears under the local packages.

Note

On non-Windows platforms, use the create_and_deploy_plugin.sh script instead.

To create a plugin package and publish it to a remote repository:

Run the deploy script with a profile and the remote name:
```
create_and_deploy_plugin.bat win64_vs2022_release <remote>
```
Builds the plugin, publishes the package to your local Conan cache, and uploads it to the remote <remote>.

Note

This script creates a Conan package identified by a reference of the form my_engine_plugin/1.0.0@kanzi-4.1.0-engine-plugins/stable. The kanzi-4.1.0-engine-plugins user segment is built from the KANZI_VERSION variable in the script; the stable channel is the script default.
Open the Package Manager in Kanzi Studio:
- Select the Remote tab.
- From the Repository dropdown list, select the repository to where you deployed the plugin.
- Refresh the repository list by pressing the refresh icon.
- Your new plugin appears under the repository packages.

Note

On non-Windows platforms, use the create_and_deploy_plugin.sh script instead.