Kzm file format

Kzm is the Kanzi Studio project file format that replaces the kzproj file format. When you use the kzm file format, instead of a single project file, Kanzi Studio stores your project in multiple kzm files. Each kzm file contains data for one project item. For example, each material type, material, animation, render pass, and so on has its own kzm file.

The goal of the kzm file format is to improve teamwork and collaboration on Kanzi Studio projects by:

  • Decreasing the amount of conflicts and making them easier to resolve

  • Simplifying sharing of project items between projects

Note

Your feedback is very important to us.

Submit your feedback on the kzm file format here.

Migrating from the kzproj to kzm file format

To migrate from the kzproj to the kzm file format, in a Kanzi Studio project, select Project > Change to Kzm format.

../../_images/change-to-kzm.png

Note

By default, Kanzi Studio saves new projects in the kzm file format.

Reusing project items

Kzm files simplify reuse of Kanzi Studio project items. To use a project item in another project, copy the kzm file of that project item into the correct directory of another project. When a project item has child items or refers to other items, copy all child and referred items too.

For example:

  • To copy a Render Pass Prefab:

    1. In File Explorer, in the project directory open the Render Pass Prefabs directory of the first project.

    2. Copy Example Render Pass directory and Example Render Pass.kzm render pass prefab file.

    3. Paste the directory and kzm file to the Render Pass Prefabs directory of the second project.

      ../../_images/copy-renderpass-kzm.png
  • To copy a Material:

    1. In File Explorer, copy FirstProject/Materials/ExampleMaterial.kzm to the SecondProject/Materials/ directory.

      ../../_images/copy-material-kzm.png
    2. Copy the material type FirstProject/Material Types/ExampleMaterialType.kzm to the SecondProject/Material Types/ directory.

      ../../_images/copy-material-type-kzm.png
    3. Copy the shaders and the corresponding kzm files from the FirstProject/Shaders/ directory to the SecondProject/Shaders/ directory.

      ../../_images/copy-shader-kzm.png