Asset packages

Note

Asset packages are a prerelease Kanzi feature. Some functionality and workflow can change in the future releases of Kanzi. Your feedback is very important to us and it helps us improve Kanzi. To send your questions, findings, and comments use the Kanzi Support Portal at support.rightware.com.

Kanzi Studio asset packages are collections of ready-made content that you can import to your Kanzi Studio projects. With asset packages you can create an asset library with content, such as UI components, materials, brushes, styles, and textures.

Use asset packages to make this content readily available for use in different Kanzi Studio projects or to share the content within your company for all your Kanzi applications. For example, the Factory Content asset packages that come with Kanzi Studio contain such content. See Factory Content assets.

Adding asset sources

Any directory that contains Kanzi Studio asset packages is an asset source. See Creating an asset package.

To add an asset source to Kanzi Studio, in the Asset Packages window click + Add Asset Source, and in the Select Asset Directory dialog select the directory that you want to add.

After you add an asset source, you see in the Asset Packages window all the items included in the asset packages that are stored in the directory that you added as an asset source.

When you add an asset source to Kanzi Studio, you make that asset source available to all your Kanzi Studio projects.

../../_images/add-asset-source.png

Using asset packages

To use asset packages:

  1. In the Asset Packages window select an asset source.

    ../../_images/myassetsource1.png
  2. To import an item from the Asset Packages to your Kanzi Studio project, either:

    • From the Asset Packages window drag an item to a node in the Node Tree, to the Prefabs, to the Preview, or to a Page node in the Pages window.

    • In the Asset Packages right-click the item and select Import Asset Package.

    For example, drag an item to the Node Tree and drop it on a node. Kanzi Studio adds that item to the Prefabs, and instantiates it as a prefab in the node where you dropped that item.

    ../../_images/drag-night-vision-to-node-tree.png ../../_images/night-vision-in-node-tree-and-prefabs.png

Creating an asset package

To share content with other Kanzi Studio users, you can create your own asset packages. You create an asset package by marking a Kanzi Studio project as an asset package, and by marking in that project all the items that you want to include in that asset package. When a Kanzi Studio user adds as an asset source a directory, which contains an asset package project, they see in the Asset Packages window all the items in that asset package.

To create an asset package:

  1. In Kanzi Studio in the project from which you want to create an asset package, in the Prefabs and Library select each item that you want to include in that asset package, and in the Properties add and set:

    • Resources > Export in Asset Package to enabled

    • (Optional) Resources > Custom Asset Thumbnail to the bitmap image that you want to use as a thumbnail for your asset in the Asset Packages window

      If you do not set a custom thumbnail, Kanzi Studio generates the thumbnail automatically.

      To enable Kanzi Studio to generate thumbnails, make sure that the Preview is running and that Kanzi Studio renders thumbnails. To enable thumbnail rendering select Edit > User Preferences and in the Advanced tab enable Render thumbnails.

    For example, create from a Viewport 2D node a prefab and mark that prefab to be exported in the asset package.

    ../../_images/night-vision-prefab.png ../../_images/export-in-asset-package.png
  2. In the Kanzi Studio main menu select Project > Properties, and in the Properties in the Profile category enable the Is Asset Package property.

    ../../_images/is-asset-package.png
  3. Save the Kanzi Studio project. The project is now a Kanzi Studio asset package.

    When a Kanzi Studio user adds as an asset source a directory, which contains an asset package project, they see in the Asset Packages window all the items in that asset package. See Adding asset sources.